{"packageName":"@nhtio/adk","packageVersion":"1.20260921.0","docsUrl":"https://adk.nht.io","generatedAt":"2026-09-21T11:45:58.181Z","documents":[{"id":"changelog:root","title":"Changelog","kind":"changelog","path":"CHANGELOG.md","uri":"adk://docs/changelog","content":"# Changelog\n\nAll notable changes to `@nhtio/adk` are documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).\n\nThis project does **not** use strict Semantic Versioning. Versions are\n`..` — a hybrid of one SemVer-like signal and\n[CalVer](https://calver.org/): the major version increases only when the **core contract**\nbreaks (the primitives every assembly depends on — the runners, the callback contracts, the\nartifact/retrievable model); the date is the release day; `` counts same-day releases from\nzero. Everything else — including breaking changes to individual batteries — ships under the\nsame major, called out explicitly in the entries below. So within a major, the version tells\nyou *when* you got it, not *what changed*: a `^` range will float across battery-level\nbreaking changes, so pin an exact version if you need stability and read the entry before\nupgrading.\n\n## 2026-09-21\n\n### Fixed\n\n- **`@nhtio/adk/batteries/encoding` — a live `Identity` instance now encodes losslessly** (closes\n issue #38). Constructing an ADK primitive (e.g. `Thought`/`Message`) from a live `Identity`\n instance — as the runtime hands to storage callbacks — and then calling `encode()` threw\n `E_ENCODING_FAILED`. Root cause: `Identity.schema` was a bare `validator.object` fragment, and a\n Joi object schema *clones* whatever it validates; cloning an `Identity` produced a look-alike with\n the right prototype but no private fields (the constructor never ran), so `[ENCODE_METHOD]` threw\n reading them. `Identity.schema` is now an `alternatives(customPassthrough, rawObjectSchema)` that\n returns a live instance unchanged — mirroring `Tokenizable.schema` — so string, `RawIdentity`, and\n live-`Identity` inputs all encode and round-trip identically. The passthrough trusts an\n unforgeable per-instance brand (a module-private `WeakSet` populated in the constructor), not a\n `constructor.name` match, so a hand-rolled look-alike cannot bypass validation. Any non-branded\n value — a plain `RawIdentity`, a hand-rolled look-alike, or a **foreign/cross-realm `Identity`**\n (a second copy of the package in the dependency tree, which Joi clones into a prototype-only husk\n with no private fields) — is rebuilt into a genuine local `Identity` after field validation, so\n every consumer stores real, encodable state and a malformed value is rejected rather than retained\n as a husk. An audit of the whole encodable surface (Tokenizable, Memory, Message, Thought,\n Retrievable, ToolCall, Registry, Media, Tool, ToolRegistry) confirmed `Identity` was the only\n affected schema; the rest already nest live instances through custom passthroughs or store them\n without a validating clone.\n\n### Internal\n\n- **CI — the Node smoke sandbox installs the optional `@toon-format/toon` peer.** The TOON artifact\n battery declares `@toon-format/toon` as an optional peer, but it was missing from the smoke job's\n peer-install list, so the published-package smoke check exercised the TOON converter without its\n parser present and the round-trip spec failed on master. Added it to `smoketester add`.\n- **Tests — the orchestration end-to-end smoke spec imports from `@nhtio/adk`, not `src/`.** The spec\n imported via relative `../../../../src/*` paths, which do not exist in the installed-package smoke\n sandbox; it now imports the public subpaths like every other functional spec.\n\n## 2026-09-13\n\n### Fixed\n\n- **LLM batteries — token accounting opt-out is typed and honoured.** Every adapter's\n `tokenEncoding` option now accepts `TokenEncodingId | null`, matching the runtime schema\n (which already defaulted to `null` to opt out of tiktoken accounting) so the public TypeScript\n surface no longer rejects the documented opt-out. Unregistered encodings fall back to a\n `text.length` heuristic instead of the previous fixed divisor. Bedrock Converse and Gemini\n Generate Content additionally gained parity fixes: null-safe token accounting, corrected\n preflight tool-overhead margins, and validation that mirrors the shared contract.\n\n- **`@nhtio/adk/batteries/media` — repeated `image.annotate()` steps compose instead of\n overwriting.** Fusing an image pipeline now concatenates the shape lists of every `annotate`\n step in chronological order rather than keeping only the last, so\n `.image.annotate(a).image.annotate(b)` marks the frame with `a` then `b`. Animated inputs are\n annotated on every frame (the sharp `animated` option is applied on the source), and SVG\n overlay geometry is validated.\n\n- **`@nhtio/adk/batteries/sandbox` — abort listeners are released on every terminal path.**\n The caller-signal forwarding listener is now removed idempotently on both child `error` and\n `close`, so a failed spawn or a completed run no longer retains its `AbortController` (which\n could kill a recycled PID). The run-abort listener is likewise released when the run settles.\n\n- **`@nhtio/adk/batteries/vector` conformance — decoupled and sequential.** The shared\n conformance suite runs its checks sequentially to avoid backend constraint races, clears its\n timeout timers on every settlement path, and no longer depends on a test framework.\n\n## 2026-09-12\n\n### Added\n\n- **`@nhtio/adk/batteries/skills` — framework-agnostic typed output from skill tools** (closes the\n gap tracked in issue #31). A skill tool is third-party code that should not have to import this\n library to describe what it produced, so the wrapper is now the adaptation boundary for output as\n well as for the gate, errors, and trust. Beyond the existing `string | Uint8Array | Media |\n Media[]`, a tool may return a plain-object descriptor and the host constructs the primitive:\n - `{ bytes, mimeType, filename? }` → a typed `Media`. The host wraps the bytes in a reader via\n `ctx.storeMediaBytes` and infers the `MediaKind` and a conservative modality hazard from the\n MIME type, so a PDF is a PDF and a WAV is a WAV — with no `@nhtio/adk/common` import in the tool.\n - `{ retrievable: { content, source?, kind?, score?, inline? } }` → a `Retrievable` the model can\n cite, search, and hold a handle to. Its text is spooled behind a handle and the record is\n persisted durably through `ctx.storeRetrievable` — id-collision-checked, written to the\n deployer's store, and added to this turn's context. The tool's result is a short acknowledgement\n naming the new retrievable. It is durable work product — not the reclaimable instruction set a\n skill body is, nor the transient stdout a script produces — so it outlives an `unload_skill`.\n Byte cleanup after a rejecting persistence callback is explicitly the consumer's responsibility\n (documented in Tool results and Context channels): core spools through the consumer's own byte\n conduit under a known id, so the consumer is the party positioned to reconcile it; the library\n offers no byte-delete conduit by design, matching core and the built-in retrievables battery.\n\n Output trust is floored from the skill's tier (`first-party` → `third-party-private`; both\n third-party tiers pass through) — a skill can never label its own output first-party. A descriptor\n may declare `SkillDescriptor.toolOutputs[toolName]` (`'text' | 'binary' | 'media' | 'retrievable'`)\n so a runtime shape that disagrees fails `E_SKILL_TOOL_BAD_RESPONSE` loudly rather than being\n silently reinterpreted; when omitted the wrapper sniffs the returned shape. A prebuilt\n `SpooledArtifact` is still refused, since it would bypass the deployer's artifact binding.\n\n### Fixed\n\n- **`gemini_generate_content` — `unsupportedMediaPolicy` schema now matches the other LLM\n batteries and its own type.** The options schema declared `unsupportedMediaPolicy` as a bare\n `string`, so it accepted any string and rejected the valid\n `{ mode: 'fallback-stash'; stashKeys: string[] }` object that the `UnsupportedMediaPolicy` union\n (and `anthropic_messages`, `ollama`, `openai_chat_completions`) permit. It is now the same\n alternatives schema — the `'throw' | 'fallback-stash' | 'synthetic-description'` enum or the\n `{ mode, stashKeys }` object, defaulting to `'throw'` — so a consumer building validation from the\n exported schema treats the option consistently across batteries, and a valid object value no\n longer fails validation on Gemini.\n\n## 2026-09-11\n\n### Fixed\n\n- **`@nhtio/adk/batteries/skills` — hardening from the AI-review panel.** Five defects surfaced\n during review of the skills battery, each fixed with a mutation-proven regression test:\n - A skill script no longer misreports enclosing-turn/dispatch cancellation as\n `E_SKILL_WORKSPACE_FAILED`: an abort (`E_TURN_GATE_ABORTED`, or any error observed while\n `ctx.abortSignal.aborted`) now propagates unchanged from `forgeSkillScriptTool`.\n - `refresh_skills` with no argument now refreshes **and reprojects every loaded skill** rather\n than only re-discovering the catalog — the previous `if (id)` guard left loaded bodies and\n tools stale while reporting success.\n - **Security:** `assertPolicySubset` no longer special-cases a per-call `allowedDomains: ['*']`.\n A wildcard is the widest possible request and must clear the same session-membership check as\n any named domain; it is authorised only when the session policy itself permits `*`. Previously\n a script could reach arbitrary hosts under a session restricted to named domains.\n - The `turnOutput` middleware's placement contract is corrected in its TSDoc and docs: the strip\n runs at the **head** of the turn-output pipeline, before `next()`, so no downstream output\n middleware (a consumer's persistence or observation) ever sees the projection — which is what\n makes \"the body never leaves\" true. The code was already correct; the docs read as the\n opposite. A test now pins the ordering.\n - Removed a dead policy-selection ternary in `forgeSkillScriptTool` whose branches were\n identical.\n\n## 2026-09-10\n\n### Added\n\n- **`@nhtio/adk/batteries/skills` — a plugin lifecycle for agent skills.** Agent skills as the\n industry ships them are discovery plus activation and nothing else: the body loads into\n append-only conversation history and never leaves.\n [anthropics/claude-code#21583](https://github.com/anthropics/claude-code/issues/21583) asked for\n removal and was closed as *not planned*; agentskills.io standardises Discovery → Activation →\n Execution with no fourth stage. Plugin systems settled this decades ago — WordPress pairs\n `register_activation_hook` with `register_deactivation_hook`, VS Code pairs `activate()` with\n `deactivate()`, OSGi's `BundleActivator` is `start()` and `stop()`.\n\n This battery treats a skill as what it structurally is: a plugin. The manifest is metadata, the\n body is plugin-provided operational guidance, tools are exported capabilities, the gate is the\n host permission boundary, {@link SkillSource} is the repository/loader seam, and\n load/unload/refresh are activation, deactivation and upgrade. Deactivation works because ADK\n reassembles context per dispatch instead of appending to a log — a design consequence, not a\n trick.\n\n Five explicit tools — `list_skills`, `list_loaded_skills`, `refresh_skills`, `load_skill`,\n `unload_skill` — so nothing is ambiently loaded and every context change is a tool the model\n invoked. Bodies project as handle-mode retrievables by default (a handle, not the body) or\n inline per skill; either way unload reclaims them, because neither becomes a `Message`.\n\n Three capability tiers, chosen by where the code runs: module tools rewrapped at the boundary\n (gate enforced by the wrapper, not by convention; errors contained; `trusted` forced false;\n the deployer's artifact binding not bypassable), isolated JS in a SES or BYO guest, and scripts\n in a child process under a per-skill SRT policy narrowed to a materialized workspace. Containment\n is **opt-out**, through a typed `unsafe` block that announces every disabled control in a\n construction warning and in what `list_skills` tells the model.\n\n Middleware is supplied for all four pipelines so the consumer controls placement; shape is\n constant and behaviour is config-derived. `SkillSource` is BYO with an `InMemorySkillSource`\n reference implementation and a `runSkillSourceConformance` suite at\n `@nhtio/adk/batteries/skills/conformance`.\n\n **The honest limits, stated as loudly as the features:** unload removes the body from future\n context but does not reclaim bytes already written to the consumer's spool store, does not erase\n an excerpt the model already extracted, and leaves a one-iteration reader residual that core\n closes on its own. No memory, CPU or process limits — a plugin lifecycle, not an operating\n system.\n\n### Fixed\n\n- **Artifact handle renderers advertised only a subclass's own tool methods.** `static toolMethods`\n shadows rather than concatenates, so four renderers reading `ctor?.toolMethods` raw listed a\n markdown handle's eight `md_*` readers and none of the seven base readers — which exist and work.\n The core fallback in `estimateHandleTokens` fed that undercount into token estimation.\n `effectiveToolMethods` now unions the static prototype chain and is used by the core fallback,\n `chat_common`, `openai_chat_completions` and `ollama`;\n `orchestration/artifact_methods.ts`, which had solved this locally, re-exports it.\n\n- **Sandbox guest capabilities could not be cancelled.** `createGuestRunner` invoked every\n capability with `declaration.fn(args, new AbortController().signal)` — a fresh controller nobody\n ever aborts. Capabilities now receive the signal passed to `spawn()`.\n\n## 2026-09-08\n\n### Changed\n\n- **`ClaudeCodeCliAdapter` now honours the same executor contract as every other LLM battery.** It\n was the only one that diverged, and it shipped unused. Two changes bring it in line, both\n established against the live `claude` CLI (2.1.251) rather than inferred from its documentation.\n\n **Fixed single-turn dispatch.** `--max-turns 1` is now unconditional argv rather than an option:\n one dispatch permits one generation and all of its tool calls, then control returns to\n {@link TurnRunner} instead of letting Claude start a second generation. Claude signals that\n boundary with a terminal `result` carrying `subtype: error_max_turns` and `isError: true` — a\n specific, machine-readable \"the cap did its job\", not a crash — so it now routes through the\n success path with its generation stats and `autoAck` intact. Previously every tool-using dispatch\n ended as {@link E_CLAUDE_CODE_CLI_TURN_FAILED} with its already-streamed output discarded. The\n `subtype` field was parsed from Claude's stream-json but silently dropped before reaching the\n adapter; it is now first-class on the wrapper wire event, because without it the normal boundary\n is indistinguishable from a failure. Other error subtypes, notably `--max-budget-usd` exhaustion,\n remain genuine failures.\n\n **`maxTurns` is deprecated and inert.** It stays in the public options surface for compatibility,\n but only `maxTurns: 1` validates — any other value fails with a message explaining that\n single-turn dispatch is the fixed contract — and the value is ignored, since argv always carries\n the cap. There is no capability probe: the installed CLI supports `--max-turns` without listing\n it in `--help`, so a documentation grep is a false negative, and a CLI genuinely lacking the flag\n exits non-zero with `error: unknown option`, already surfaced as\n {@link E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO}.\n\n### Added\n\n- **Pre-flight context-window guard for the Claude Code CLI battery.** `contextWindow` and\n `tokenEncoding` now behave as they do in the five wire batteries: the same six buckets, the same\n spooled-retrievable handle accounting, the same `context-window-usage` debug record, throwing the\n new {@link E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW} **before the wrapper process is spawned**. The\n point is refusing an unsendable payload before spending money and latency; `maxBudgetUsd` caps\n spend *after* dispatch and was never a substitute for it. A non-null `tokenEncoding` without a\n `contextWindow` is rejected at iteration time, matching the sibling batteries.\n\n This battery has no wire `tools` array to tally — tools reach the model through the MCP bridge —\n so the tools bucket counts the serialized bridged declarations plus the\n `mcp__adk_bridge__`-prefixed names as Claude sees them. The rendered `-p` prompt and optional\n `appendSystemPrompt` are measured directly; raw source-bucket figures remain diagnostics for\n shedding decisions and are not double-counted. The estimate is exact for content this adapter\n renders and forwards, but is deliberately an **honest floor** for Claude Code content the adapter\n cannot observe: its Agent SDK preamble, `CWD:`/`Date:`, billing header, built-in tool schemas, and\n MCP declaration envelope. The same reasoning ollama applies only to its server-side chat templates.\n\n## 2026-09-07\n\n### Added\n\n- **Four new spooled-artifact batteries with six bidirectional converters.** {@link SpooledToonArtifact}, {@link SpooledYamlArtifact}, {@link SpooledXmlArtifact}, and {@link SpooledEcmaScriptArtifact} add structured query methods over their formats — `artifact_toon_*`, `artifact_yaml_*`, `artifact_xml_*`, and `artifact_es_*` — enabling the model to navigate structured output by path or AST rather than by line-oriented grep. TOON and YAML/XML converters (`toon_to_json`, `json_to_toon`, `yaml_to_json`, `json_to_yaml`, `xml_to_json`, `json_to_xml`) accept either inline text or an artifact reference, and return a new spooled artifact ready for query on the next iteration. TOON's token-reduction encoding makes `json_to_toon` valuable for shrinking large artifacts before passing them onward. Three optional peer dependencies: `@toon-format/toon@^4.1.1`, `fast-xml-parser@^5.11.1`, `typescript@^5.9.3` (promoted from devDependency); `js-yaml` is already a core dependency. See [Artifact batteries](/assembly/batteries-artifacts).\n\n- **Linux sandbox escape hatches and an opt-in spawn-liveness probe.** `srtEnforcer` now accepts\n Linux-only `bwrapPath` and `socatPath` options for wrapper scripts that need to adjust SRT's\n bubblewrap invocation. Supplied paths must be absolute; on Linux, a nonexistent absolute path\n fails inside SRT's `initialize()`, while on macOS these options are neither validated by SRT nor\n used. `createSandbox({ probeSpawn: true })` performs a real `true` spawn after policy admission,\n drains both streams, and fails closed rather than consulting `allowUnsandboxedFallback` — that\n option provides no unsandboxed runner, so honouring it here would admit a handle whose every call\n still fails. It is opt-in and off by default.\n\n **Error classification is preserved, not flattened.** A typed sandbox exception thrown by the\n probed spawn — `E_SANDBOX_POLICY_CONFLICT`, `E_SANDBOX_REFUSED`, and the rest — propagates with its\n own type, so an operator whose *policy* is wrong is not told to install a missing dependency. Only\n a genuinely untyped failure — the child could not be spawned, or its output could not be read —\n becomes `E_SANDBOX_DEPENDENCY_MISSING`. A child that RAN and exited non-zero throws the neutral\n `E_SANDBOX_FAILED` with its exit code and stderr, because the probe cannot know the cause: issue\n #22's own symptom (`bwrap: loopback: Failed RTM_NEWADDR`) arrives exactly that way and is a kernel\n permission problem, not a missing dependency.\n\n **A failed probe rolls the session back completely.** Clearing the manager's ownership record\n without disposing the backend session would leave the SRT adapter's session claim held, and it\n refuses to construct while that claim stands — so a failed probe would have wedged the process\n permanently, with no handle in existence able to release it. The rollback now disposes the\n enforcer it established, and only when the session was *owned*: an adopted foreign sandbox is\n never reset. Disposal of a secondary handle no longer aborts an unrelated in-flight construction —\n only a disposal that can actually reset the established owner invalidates one.\n\n### Changed\n\n- **Sandbox construction is now serialized for every consumer.** Concurrent `createSandbox()` calls\n queue behind an establishment promise, and `dispose()` participates in the same queue. A slow\n teardown can therefore delay a concurrent construction; the coupling prevents teardown from\n resetting the owner while another construction is being established.\n\n### Fixed\n\n- **#22: sandbox construction can now be configured around a container's netlink failure.** The\n reporter measured `@anthropic-ai/sandbox-runtime` 0.0.73; this repository uses 0.0.70. On a runner\n reporting `bwrap: loopback: Failed RTM_NEWADDR: Operation not permitted`, the new Linux-only binary\n passthrough lets a wrapper adjust bwrap's argv. The `network.disabled` mapping is unchanged. The\n paths are not a general SRT existence check: the nonexistent-path failure is in SRT's Linux\n `initialize()` path, while macOS does not validate or use them.\n- **#23: empty grep flags are now reachable.** Across five production CI traces, 17 of 3,043\n artifact-tool calls were rejected, all with `flags: \"\"`; the reported rejection gave no path from\n the error to a working call. `artifact_grep` now treats `flags: \"\"` like omission, while still\n rejecting unsupported flags. The sibling Markdown `lang: \"\"` case is admitted too, so its existing\n no-language query is reachable.\n- **The environment allow-list now holds at the child process.** On macOS, a real `srtEnforcer`\n end-to-end measurement showed the post-fix result: `HOST_SECRET_E4` absent and `PATH` present. On\n Linux, real bubblewrap 0.10.0 reproduced the environment-relevant portion of the bwrap spawn shape\n (not the enforcer and not its exact argv) on both sides: the pre-fix environment merge leaked\n `HOST_SECRET_E4`, while the post-fix allow-list did not. The fix is platform-independent because it\n changes what ADK hands to `spawn`, and the post-fix result is measured on both platforms; the\n measurements differ in both scope and coverage. The macOS pre-fix leak is supported by the unit\n tests and by `wrapWithSandboxArgv` returning `env: process.env`, not by an OS-layer measurement.\n\n- **BREAKING (orchestration, one release-day of exposure): `runPlanStoreConformance` is no longer re-exported from the battery barrel.** It is reachable only at `@nhtio/adk/batteries/orchestration/conformance`, which is the subpath the documentation and the changelog already used. With `vitest` installed the barrel export DID resolve, so a test file that imported it from `@nhtio/adk/batteries/orchestration` must change its specifier. It is called out as breaking rather than filed quietly under a fix because that is what it is — the mitigating facts are that the export existed only in `1.20260905.1`, and that any consumer without `vitest` could not import the battery at all (see below).\n\n- **Importing the orchestration battery required `vitest` to be installed.** The barrel re-exported `runPlanStoreConformance`, which pulled `conformance.ts` — and its `import { describe, expect, it } from 'vitest'` — into the module graph of every consumer. `vitest` is an **optional** peer dependency, so a package manager does not install it, and any consumer without a test runner got a hard `ERR_MODULE_NOT_FOUND` on `@nhtio/adk/batteries/orchestration` itself. The suite is now subpath-only (`@nhtio/adk/batteries/orchestration/conformance`), matching `batteries/vector`, whose conformance suite is likewise vitest-based and likewise excluded from its barrel. Nothing in this repository referenced it through the barrel — the spec, both documentation pages and the changelog already used the subpath. Found by installing the published `1.20260905.1` tarball as a real consumer; the in-repo test suite aliases `@nhtio/adk` to `./src` and is structurally incapable of catching this class.\n\n\n## 2026-09-05\n\n### Added\n\n- **The orchestration battery — a staging environment for tool calls.** `@nhtio/adk/batteries/orchestration`, deep-import only. A plan is a persisted, content-addressed graph of the steps a model intends to take: it explores, stages the work, and stops, and the whole graph is reviewed and approved before a single side effect runs. **The permission gate IS the `reviewable → executable` lifecycle transition**, so \"approved\" and \"executable\" are one fact rather than two that can drift — there is no separate flag to forget to check, and a full re-gate after an edit needs no enforcement code, because an edit requires an unfreeze and the only route back passes through the gate again. Approval binds a lossless content digest AND the canonicalised authority set of every reachable `call`, so approving one plan can never authorise another. Seven node kinds (`entry`, `call`, `reason`, `transform`, `branch`, `select`, `join`), six edge handles, a BYO `PlanStore` with a conformance suite that has teeth, three predicate cells (`structured` zero-dependency, `jexl` expression-only, `lua` Node-only and sandboxed), and a three-tier tool surface where the split is a threat-model boundary: a conversational agent gets three tools and cannot reach graph mechanics at all. Ships with 591 tests and nine documentation pages. See [Orchestration](/batteries/orchestration/).\n- **`@nhtio/adk/batteries/orchestration/conformance` — `runPlanStoreConformance`**, a vitest suite proving a BYO `PlanStore` actually holds the contract, including the parts that are easy to satisfy incorrectly: an append refused in `reviewable` and in `executable`, the settlement batch committing atomically (asserted by killing between the two appends), the stale-approval interleaving, `claimRun` succeeding exactly once against two concurrent claimants, artifact HANDLES surviving a `frontier_snapshot` round trip, and re-entry admitted after `aborted`/`halted` but refused after `completed`.\n- **`tool_call_id_uniqueness` — a BLOCKING rule that stops tool-call id collisions from corrupting the wire.** Some OpenAI-compatible upstreams number tool-call ids **per response** rather than per conversation; confirmed live against `xai.grok-4.3` on Bedrock Mantle, where five sequential tool-calling turns each returned `call_0`. The OpenAI-family adapters adopt the vendor's id verbatim, so the collision reached ADK primitives intact and produced three distinct harms: the pre-rendered tool-result cache keyed by id collapsed two calls to one entry and sent the first call paired with the **second** call's result (indistinguishable from a cache hit); a reused completed id made the dispatch's `toolCallStreams` map throw on iteration 2; and a durable spool store keyed by id silently overwrote turn 1's bytes. The new `IdentifierUniquenessRule` (a cross-entry set property, not a per-entry predicate) detects the collision group and, under `action: 'mutate'`, repairs it via `renumber-colliding-ids` — renaming **every** member of the group through a new atomic group-replacement capability on the context. It is **blocking** because an advisory finding can never be repaired, and it applies to the **dispatch surface only** (`surface: 'dispatch'`), so it stays inert on the turn middleware where a blocking collision would abort the turn before the dispatch that could repair it ever ran. See [Atomic Behaviors](/batteries/validation/behaviors#_21-tool-call-id-uniqueness).\n- **`toolCallIdFilter` — an opt-in ingress seam to de-collide a provider's id before it reaches storage.** A `(id, ctx) => string` hook, default absent = identity, plus a shipped `deCollideToolCallIds` that returns a fresh `uuidv6()` only on an actual collision. Six batteries expose it (`openai_chat_completions`, `openai_responses`, `anthropic_messages`, `bedrock_converse`, `ollama`, `webllm_chat_completions`); four deliberately do not, because they mint their own ids and have nothing to filter (`gemini_generate_content`, `transformers_js`, `litert_lm` mint `uuidv6()` where their wires supply none; `claude_code_cli` adopts a locally generated MCP `requestId`). `openai_responses` ships a composite-aware `deCollideOpenAIResponsesToolCallIds` that rewrites only the `callId` half of a `` `${call_id}|${itemId}` `` id and preserves a valid `fc_…` item id, because a bare-uuid replacement would drop the reasoning-item replay link. See [The Shared Contract](/batteries/llm/shared-contract).\n- **The pre-rendered tool-result cache is now keyed by `ToolCall` instance, not id, in all ten LLM batteries.** Writer and reader iterate the same live primitives, so no id lookup is needed and the collision becomes impossible by construction. Anthropic's `count_tokens.ts` builds its own id-keyed map and is fixed too, or token counts would disagree with what is sent.\n- **An optional `replaceToolCallGroupCallback` on the storage contract**, giving a storage adapter a transactional seam for the group repair. Atomicity is a property of the callback, not of the repair: when present the group write is genuinely atomic, and when absent the repair still runs as a sequential delete-then-store that is **not** atomic — a storage failure partway through leaves the store partially replaced, so the repair surfaces the failure and attaches the already-deleted ids for reconciliation. The degraded path is the expected production behaviour, since most adapters will not implement the callback, and it requires a consumer's delete to tolerate the same id arriving once per group member. See [Bring your own storage](/assembly/byo-storage).\n\n### Changed\n\n- **BREAKING: `OrderingGuardResult` gains a REQUIRED `repairFailures` field.** The battery barrel is `export * from './types'`, so the type is public and hand-constructing one now fails to compile. Required is deliberate — every result carries a failure collection, `[]` when nothing failed, so a consumer never has to distinguish an absent channel from an empty one — but it is not additive. A consumer who constructs `OrderingGuardResult` by hand must add `repairFailures: []` (or the serialized failures from a failed repair).\n- **BREAKING: the pre-rendered tool-result cache is keyed by `ToolCall` instance, not id.** Anyone overriding `buildChatCompletionsHistory` (or a sibling helper) via the `helpers` option must change their map key type from `string` to `ToolCall`. No compatibility union is retained — deliberately, since a supported id-keyed shape would re-open the exact bug the fix exists to close.\n- **BREAKING: `openai_shape_baseline` now carries a BLOCKING rule, reaching 25 of 38 recipes.** The id contract is part of the OpenAI shape, and the rule self-limits once an upstream fixes its counter. On `enforce`, a colliding history newly rejects where it previously dispatched corrupt results — a consumer on `enforce` whose upstream collides will newly nack. On `mutate`, the collision is repaired instead.\n\n### Fixed\n\n- **Nine defects in the orchestration battery, every one found by writing the tests that were specified and never written.** The work packages shipped code with all gates green — type-check, lint, doc-coverage — and 15 of 21 specified test suites missing. Writing them found: `types.ts` declaring five values with `export declare` that the built module never exported, so the shipped `.d.ts` promised `NodeRef`/`branchKey`/`foldRun` and a consumer following it got a hard ESM link error; the **join barrier not existing at all**, so a join settled and fired on every arrival and the node after a two-route diamond ran TWICE while the run reported `completed`; a `transform` that could not find its own source artifact, because the lookup assumed the entry route where an omitted `branchId` means \"do not filter\"; per-node instead of per-field declassification, so declaring one output field safe laundered every sibling; the structured cell passing a `ReadonlyMap` to a property walk and therefore reading NOTHING, plus a `select` whose loop made every case after the first unreachable; the jexl cell keying its snapshot by a table key its own grammar cannot address, and an unguarded `evalSync` that let a predicate fault halt an approved run; and a store marking a run terminally settled on any outcome, so `resumeRunId` refused exactly the aborted runs it exists to resume. Each fix ships with a spec proven to fail against the restored defect.\n- **The Lua predicate cell shipped in no bundle at all.** It was the one orchestration module missing an `@module` tag, and `getEntries` derives the build's entry map by scanning for those tags — so `pnpm build` emitted no `cells/lua.mjs`, and the deep subpath the battery documents as the only way to reach it resolved to nothing. It also fell outside `doc:coverage`, which scans the same map, which is why the gate stayed green while a whole module went unexamined.\n- **`foldOps` no longer mutates the caller's ops.** The fold wrote through to the op objects it was handed, so a historical prefix fold returned the LATER value and every past revision was silently corrupted.\n\n- **Two colliding tool calls no longer cross-wire their results.** Previously the second call overwrote the first in the id-keyed cache, so the first call reached the model paired with the second's result — wrong data on the wire, undetectable from the call site. Keying by instance closes it by construction.\n- **The isolation battery no longer discards the final chunk of every stream.** The host-side stream sink decoded deltas asynchronously but closed the stream synchronously, so a `stream:end` arriving behind the last `stream:delta` closed the controller while that delta was still awaiting `decodeArgument` — and the enqueue was thrown away against an already-closed controller. Any consumer streaming across a process boundary lost the LAST chunk of every stream; for an LLM token stream, the final token of every response. All three sink callbacks are now chained onto one promise, so a terminal signal cannot overtake a delta that preceded it on the wire. Delta counters still increment synchronously, so the telemetry keeps measuring wire arrival rather than decode completion. This presented as a flaky test for months because CPU contention decides how often the close wins the race; it reproduces deterministically when the spec is run on its own.\n\n## 2026-09-03\n\n### Added\n\n- **Two new LLM batteries that speak a vendor's own wire**, for when you need to reason about what\n the VENDOR received rather than what a translator sent on your behalf — a wire-shape audit, an\n ordering guard, a bug report filed upstream. Both are ordinary {@link DispatchExecutorFn}s and\n wire in one line like every other battery.\n - `@nhtio/adk/batteries/llm/gemini_generate_content` — {@link GeminiGenerateContentAdapter},\n Google's native `:generateContent` over plain `fetch`. `contents[]` with role `model` (never\n `assistant`), no `system` role (top-level `systemInstruction`), heterogeneous `parts[]`, and\n `functionCall`/`functionResponse` parts correlated BY DECLARED TOOL NAME rather than a call id.\n Handles Gemini 3+ thought signatures, and sanitizes tool schemas of the JSON-Schema keywords\n Google's OpenAPI parser rejects. `STASH_KEY` `geminiGenerateContent`.\n See [Gemini generateContent](/batteries/llm/gemini).\n - `@nhtio/adk/batteries/llm/bedrock_converse` — {@link BedrockConverseAdapter}, Bedrock's native\n Converse over plain HTTPS with a bearer `ABSK` key. No AWS SDK and no SigV4 signer, so it stays\n cross-environment. Typed content blocks, tool results on a `user` turn, a selectable\n `alternationPolicy` (`'merge'` | `'filler'` | `'reject'`), and the `toolConfig` backfill that\n makes history replay possible at all. `STASH_KEY` `bedrockConverse`.\n See [AWS Bedrock Converse](/batteries/llm/bedrock-converse).\n\n- **Four ordering rule types derived from measured vendor behaviour**, rather than from\n documentation: `identifierFormat`, `nonEmptyTurn`, `toolIdentity`, and `schemaIntegrity`.\n The last two read the request's declared tools, which surfaced two real causes of the\n \"successful response with no content\" outcome: a `functionResponse.name` that matches no\n declared tool, and a tool schema requiring a key absent from its own `properties`.\n\n### Fixed\n\n- **`@nhtio/adk/batteries/validation`: `action: 'mutate'` no longer rejects dispatches it is\n supposed to repair.** Three independent defects made the ordering guard a net negative for\n most family recipes — on a nine-seat review panel, six seats died at iteration 0–2 and the\n three survivors were exactly those whose family carried no structural rule\n ([#15](https://gitlab.com/nhtio/adk/-/issues/15)).\n - **`AdjacencyRule` had no repair strategy at all**, so `mutate` and `enforce` were\n behaviourally identical for the 25 of 38 recipes carrying `openai_shape_baseline` — the\n guard could only ever reject. Adjacency violations now repair via `reorder-adjacent`,\n which moves the disallowed successor to just before the primitive it may not follow.\n Every primitive survives; only relative position changes.\n - **Alternation fillers had no lifecycle.** They were stored and never removed, so each\n dispatch re-evaluated the previous dispatch's output and generated fillers *between its\n own fillers*, with ids nesting exponentially (2 → 5 → 9 fillers, duplicate ids, and a\n 139-character id by the second iteration) until the guard reported `repaired` **and**\n `unrepaired` for the same pass and nacked anyway. Each pass now reaps the previous pass's\n fillers through `ctx.deleteMessage` and excludes any that remain from the timeline it\n evaluates, giving the repair a fixed point. A filler's content is also now a neutral\n acknowledgement rather than its own `__ordering-guard-filler-…` id, which was being sent\n to the model as a literal turn.\n - **`gemini-3` had no working configuration.** `thought_signature_required` is blocking and\n its only repair sat behind the global `allowMetadataFallbackRepair`, so replayed or\n cross-vendor history could not dispatch under any setting: `enforce` rejected it, `mutate`\n rejected it, and the one flag that worked is documented as a last resort. A rule may now\n authorize its own fallback with `fallbackRepairAuthorized: true`, reserved for values the\n vendor itself publishes — a sentinel is not a forged signature, it is a documented way of\n stating that no signature exists. `thought_signature_required` sets it; every other rule\n still requires the global opt-in, which is unchanged.\n\n### Changed\n\n- **Ordering rules are now advisory by default.** A live audit dispatched every rule in the\n catalog against its own **native** vendor API and found 16 of 17 describe shapes the vendor\n in fact accepts. `severity` is now available on every rule type (previously only\n `requiredMetadata` and `roleRemap`) and defaults to `'advisory'`, so a rule records its\n finding without rejecting a dispatch. `thought_signature_required` is the one rule that\n keeps `severity: 'blocking'` explicitly: Gemini genuinely returns a `400` naming both the\n field and its position, and the same history with a sentinel returns `200`.\n\n This is a bugfix for behaviour that shipped broken, not a contract change — a guard that\n rejected valid turn state was never the intended behaviour. Recipes that want the old\n gating can set `severity: 'blocking'` per rule.\n\n- **A rule is a claim about a model reached through a specific API, not about the model.**\n Every intermediary normalizes, and a gateway's repair is invisible in the response — AWS's\n Converse API is itself a translator, and an OpenAI-compatible gateway merges same-role turns\n before the vendor ever sees them. Applying a rule on a surface it was not derived from\n guards against a constraint that layer already handles. See\n [API surface scope](/batteries/validation/api-surface-scope).\n\n## 2026-09-02\n\n### Added\n\n- **New `dev_tools` battery** (`@nhtio/adk/batteries/dev-tools`, plus `/forge` and `/conformance`) — a development-editing pipeline built on the media battery's architecture rather than inside it. Media's pipe DSL cannot carry code: `unquote` applies its escape replacements in order, so `C:\\\\temp` becomes `C:\\emp`, and `apply_patch` already had to bypass the pipe for the same reason. The battery keeps what transfers — one plan IR, self-declaring engines, capability narrowing, an interceptor onion — over a workspace of files instead of a single payload, so `edit → write → eslint --fix → typecheck` is one plan, one gate per step, one composite result.\n - **Engines are deployment-supplied** and declare `format`/`lint`/`check` capabilities. Selection arbitrates over `(engineId, capabilityIndex)` pairs: `format` takes one capability per extension group, `lint` and `check` run every survivor, and a selection stage may narrow or reorder but never widen or duplicate.\n - **In-place fixers are first-class.** A capability that writes to disk itself receives a scoped `DevFileAccess` façade and triggers an authoritative re-read of its authorization envelope, so `write` sits mid-chain and a later `check` sees the fixed content rather than what the model wrote. Paths dirtied in memory earlier in the same step are withheld from subsequent in-place allowlists — otherwise a fixer reads the stale on-disk copy and its re-read discards the predecessor's edit.\n - **Every step gates once, acquisition included**, since acquisition reads the whole path set before any step runs. Granular forged tools persist within the call and carry `persists: true`, so a mutating tool answers two prompts rather than three.\n - `edit` lowers to `ParsedHunk` and delegates to the existing `applyUpdateHunks`, inheriting its match-uniquely-or-refuse contract; `apply_patch` accepts the structured envelope only and clones before applying, because the shared primitive mutates its argument and throws mid-loop.\n\n- **Dev Tools documentation section** (`docs/batteries/dev-tools/`) — six pages under Featured Batteries: the hub, the workspace and its two baselines, the steps, engines and capability selection, in-place fixers, and the agent tool surface. Plus a showcase page, *Building an agent tool surface in hostile conditions*, covering what the composition costs once nothing about it is glossed: the pipe grammar's ordered `unquote`, the path translator that throws for absent mutation targets, the four-method filesystem contract, and the non-atomic write path.\n\n- **The AI review stage is one job, and there is no bypass.** It was split into a reporting job that always exited 0 and a gate job that re-read the findings artifact; `REVIEW_ENFORCE_GATE` was already the switch, so the split cost a second job and an artifact round-trip to express what an exit code does. The gate never re-ran the panel, so collapsing them adds no LLM spend. The `REVIEW_GATE_BYPASS` escape hatch is deleted: a finding is fixed, or the panel resolves it on re-review after seeing the fix. A gate that can be turned green while findings stand is advisory, and an advisory gate is not one.\n- **`CONTRIBUTING.md` documents the build, which was filed under \"Typedoc / API Docs\" and undersold.** A `@module` tag is not doc metadata the build happens to reuse — it *is* the export declaration: `getEntries` scans every `.ts` under `src/`, the remainder after stripping the package name becomes the entry key, and `bin/package.ts` turns each key into an `exports` entry at publish time. So the committed `package.json` (one export, version `0.0.1`) is not the shipped one, a stray tag silently creates a public subpath, and a duplicate key throws the build. All four consequences are now stated. The import section is rewritten too: the battery barrel rule already existed, but not the fact that three spellings resolve to the same file, one of which (`@nhtio/adk/*`) is a tsconfig alias that reads like a package import and grants nothing. `dev_tools` now imports `guards` through the barrel as the rule requires; `isTextual`/`decodeText` have no barrel and are marked a known deviation rather than quietly left.\n\n### Changed\n\n- **`SANDBOX_EXTENSION_MIME` maps programming-language extensions.** The map had `html`/`json`/`yaml`/`csv`/`md` but no `ts`, `py`, `go`, `rs` or similar, so `stage_file('src/index.ts')` yielded `application/octet-stream` and every MIME-gated text verb refused it. `isTextual` moves to `src/lib/mime/` as one predicate shared by media's verbs and dev-tools acquisition, and now admits `xml`/`+xml` subtypes — so `redact`, `update_text`, `sanitize`, `normalize` and `append` accept SVG as the markup it is. `extract.text` needed a routing change rather than a guard change: SVG was reaching OCR before the textual branch, though `ocr: 'force'` still wins.\n- **`SandboxSearch` accepts the arguments its own allow-list already permitted.** `ALLOWED_RIPGREP_FLAGS` listed `--ignore-case`, `--fixed-strings`, `--iglob`, `--hidden` and `--no-ignore`, but no tool argument reached them. Split per method — content search takes the full set, path search only what `rg --files` honours — with `limit` required on both and truncation bounding what reaches the model, not adapter memory. `Done` gains a third arm for the over-limit case rather than widening `bound`, since its existing incomplete arm mandates `maxDepth`. `follow` is **rejected at schema validation** unless the adapter sets the new `supportsFollow` flag, declaring it contains symlinked descendants; the bundled ripgrep adapter has not audited that and does not declare it, and additionally throws if reached directly. The narrowing is `.valid(false)` on a *copy* of the permissive rule, so a BYO adapter that has verified containment still gets the full option — the flag is not disabled package-wide to spare the bundled case a runtime error. **All of it is now documented** — the argument table, `limit`'s post-collection truncation semantics, the `list_directory` protocol-violation rule, and the reason the schema stays permissive while the bundled adapter refuses: a BYO adapter that has verified its own containment may honour `follow`, and one that cannot must reject it itself. The model-facing tool descriptions say so too; they previously advertised `max_depth` as the only boundary, which stopped being true when `limit` became required.\n- **`SandboxFileSystem` gains optional `delete`/`rename`/`mkdir`.** The contract declared only `stat`/`list`/`read`/`write`, so persisting a patch's `Delete File` or `Move to` was silently wrong. Optional plus a construction-time probe: a missing operation omits the one capability that declared `needs` for it, never the engine or the pipeline, and the duck-type guard is unchanged so existing four-method adapters keep working. `ConformanceMutations` is a sibling fixture rather than more members of `ConformanceSources`, which is path-free and pre-bound and cannot express a mutation.\n- **`runOnion` extracted to `src/lib/middleware/`** and media's step onion migrated onto it. It owns the fresh runner per execution, the capture-and-rethrow idiom, and the did-not-call-`next()` sentinel — which now tracks terminal invocation explicitly, because inferring it from an `undefined` return made every void-core step throw.\n- **Patch primitives and `decodeText` move to `src/lib/`.** `parseStructuredPatch`, `applyOperations`, `applyUpdateHunks`, `normalizeWorkspacePath` and friends now live in `src/lib/patch/`, and `decodeText` in `src/lib/text/`, imported by both batteries. Media's public surface is unchanged.\n\n### Fixed\n\n- **`find_files` threw an I/O failure the moment it hit its own `limit`.** The over-limit protocol-violation throw is meant for `list_directory`, which has no `limit` and for which such a frame is impossible; it was also wired into the shared search handler, where it intercepted `find_files` — a tool whose `limit` is required and whose truncation is its ordinary outcome. The correct `result-limited` narration already sat below it, unreachable. The existing test asserted the throw, so it read as coverage while pinning the defect; it now asserts the truncation contract.\n- **The ripgrep adapter accepted a nonpositive `limit`.** The contract names the adapter as the enforcement point for \"integer >= 1\", but nothing enforced it, so `limit: 0` made the first result trip the over-limit branch and returned an empty incomplete result that reads as \"no matches\". Both methods now reject a nonpositive or fractional limit before spawning, and the contract documents the bound it was relying on.\n- **A middleware or step rejecting with `undefined` was silently ignored.** Five capture-and-rethrow sites tested the captured *value* (`if (caught !== undefined) throw caught`), which cannot distinguish a thrown `undefined` — legal JS — from \"nothing was thrown\". The onion resolved as a success: for `runOnion` the chain fell through to its did-not-call-`next()` diagnostic and blamed the interceptor's contract for what was actually a rejection; for both selection registries the stage's rejection was dropped and arbitration continued as though it had passed. All five now set a flag in the `errorHandler` instead (`runOnion`, the media and dev-tools registries, and both pipelines in the shared tools helper — where the input pipeline additionally skipped its short-circuit check).\n- **`applyUpdateHunks` rewrote every line of a CRLF file.** It split on normalized LF and rejoined with `'\\n'` unconditionally, so a one-line edit to a CRLF file came back as a whole-file newline-only diff. It now rejoins with the convention its input arrived in. Dev-tools is unaffected either way — its text is LF by the time a hunk sees it, since acquisition normalizes in `decodeText` — but media's structured patch path and any direct caller get a localized edit that stays localized.\n- **`decodeText` normalized CRLF only on the UTF-8 path.** The UTF-16 BOM branches returned early, so a BOM-marked UTF-16 file kept its `\\r\\n` line endings through `chunk`, `extract.text`, `redact`, `update_text`, `diff` and `apply_patch` — and line numbering in diagnostics disagreed with the file. Normalization moved after the encoding branch.\n\n## 2026-09-01 (earlier — v1.20260901.0)\n\n### Added\n\n- **New `openai_responses` LLM battery** — a vanilla adapter for OpenAI's Responses API, distinct from `openai_chat_completions` in wire shape rather than in provider. The Responses API replaces the flat `messages[]` array with a flat `input: Item[]` array, where a tool call and its result are two *sibling top-level items* (`function_call` then `function_call_output`) rather than one message carrying both; the system prompt lives in a top-level `instructions` string by default (`systemPromptChannel` can render it as a leading `developer`/`system` item instead for gateways that only understand the item form). Hand-rolled `fetch` + SSE, no `openai` SDK dependency, matching the sibling batteries.\n - **Native reasoning-item replay** (`reasoningReplay: 'off' | 'encrypted' | 'summary-only'`, default `'off'`; also requires `replayCompatibility: ['openai-responses-reasoning-v1']`, which defaults to an empty list). Guarded by an adjacency-sweep pass over the assembled `input`, because the Responses API enforces an **undocumented** constraint — a `reasoning` item must sit immediately beside its paired output item, in both directions ([`openai/openai-node#1791`](https://github.com/openai/openai-node/issues/1791), reproduced across five official SDKs). OpenAI's own docs state the opposite (that stray reasoning items are silently discarded), so a rejection is treated as *recoverable*: the adapter strips every reasoning item and retries once, degrading to no-replay rather than failing the turn.\n - **Document media** (`Media.kind === 'document'` → `input_file`) with the wire contract confirmed against the live API. Audio and video have no Responses representation and route through `unsupportedMediaPolicy` — unlike `openai_chat_completions`, which supports audio natively.\n - **Deliberately stateless.** `store` is hard-rejected as a settable option (always sent `false`), and `previous_response_id` / `conversation` / `prompt` / `context_management` are refused outright: ADK owns history, and the full `input` array is resent every iteration. `background: true` is rejected at validation time, since the adapter has no polling/resumption path for an async response.\n - Extracted the canonical-JSON + SHA-256 prefix-fingerprinting primitive out of `anthropic_messages`'s private helpers into a shared `canonicalFingerprint()` in `chat_common`, now used by both batteries (a refactor with no behaviour change to the Anthropic path).\n- New `tests/unit/build/published_subpath_imports.node.spec.ts` — asserts every `@nhtio/adk/...` subpath the test suite imports actually exists in the published `exports` map, using the same `getEntries` the packaging step uses. Subpaths exist only for `@module`-tagged modules, and several (`batteries/llm/chat_common` and its `helpers`/`types`) are deliberately private; because only the master-only smoke jobs resolve the built package, a bad import previously survived every MR pipeline and broke master. This closes that gap on every MR.\n\n### Fixed\n\n- **`tests/_fixtures/scripted_executor.ts` imported a subpath that is not published**, which took all four smoke checks and 19 functional suites down at import time with `Missing \"./batteries/llm/chat_common/helpers\" specifier`. The bad import dated to 2026-08-11 and had simply never met a master smoke run.\n- **Pinecone integration tests leaked namespaces** until the `adk-vector-test` index hit its 100-namespace serverless cap and every subsequent upsert failed. Two causes: the cleanup list was populated only *after* `connect()`/`createCollection()` succeeded — so a store that failed to initialise (which is what happens once the cap is reached) was never tracked and never reclaimed, making each failing run leak further; and a failed reclaim logged one `console.warn` per store, which scrolls past unread in an otherwise-passing run. Cleanup now registers up front and reports leaks loudly, in aggregate.\n\n### Changed\n\n- The `AI Code Review` CI job now runs with `NODE_OPTIONS=--max-old-space-size=8192`. Node caps its default old-space around 4 GB regardless of host memory, so the `bigmem` runner tag was supplying memory V8 would not use; the job died with `Reached heap limit … JavaScript heap out of memory` (exit 134) after climbing to ~2.5 GB. Peak heap scales with the concurrent reviewer count and the diff size, so a further OOM at 8 GiB means fewer seats in `REVIEW_MODELS`, not a larger ceiling.\n\n## 2026-08-30\n\n### Fixed\n\n- **`adk/require-string-empty-disposition` (repo-internal copy) mis-analyzed two variable shapes**, in ways that could both raise a false positive and silently miss a real one:\n - A straight-line chain split across reassignments lost everything the earlier assignment applied — the accumulated call list was overwritten rather than appended to, so `let s = validator.string().allow(''); s = s.optional()` saw only `.optional()` and reported a schema that was correctly disposed.\n - Tracked events were grouped by variable **name** alone, so a nested block shadowing an identifier joined the outer variable's event list. Since the inner declaration re-roots at `validator.string()` — a disqualifying re-root under the Shape-A grammar — it suppressed a genuine finding on the *outer* schema. Events now key on the declaring binding, with `var` correctly hoisted to its function scope rather than keyed to the block it is written in (`let`/`const` remain per-block).\n- **Tool-parameter descriptions across every battery touched by the 2026-08-28 empty-string fix now state what an empty string actually does.** The schemas accepted `\"\"` but their descriptions never said so, and the description string is the only thing a model reads — a schema that silently accepts a value its documentation doesn't mention is a documentation defect, not a cosmetic one. Updated for `scrapper` (`device`/`user_agent`/`extra_http_headers`/`proxy_server`), `datetime_extended` (four `timezone` params plus `reference_date`/`to`), `datetime_math`, `time`, `memory`, `retrievables`, `searxng`, `data_structure`, `formatting`'s `currency`, `string_processing`'s `flags`, `parsing`'s `delimiter`, and `media`'s `redact.replace`.\n\n### Added\n\n- Published-plugin test coverage for the `.empty('')` clearing method, which shares one predicate with `.allow('')` but had never been exercised independently and could therefore regress unnoticed.\n\n## 2026-08-29\n\n### Fixed\n\n- `openai_responses` battery: fixed four issues surfaced by AI code review on the `openai_responses`/empty-string-fixes MR:\n - Timeline media rendering ignored a caller-supplied `renderUntrustedContent`/`renderTrustedContent` override, falling back to the module defaults on nested media blocks instead.\n - Reasoning-item persistence recorded the *preceding* item's id as `pairedItemId` instead of the *following* item's id, undermining the reasoning/output-item adjacency-sweep validation.\n - Streaming SSE frame parsing only split on a bare `\\n\\n`, silently dropping every event once a gateway/proxy normalised line endings to CRLF.\n - A terminal event (or any other event) arriving as the very last bytes of a stream, with no trailing blank-line separator before EOF, was left sitting unprocessed in the internal buffer and silently dropped — the decoder is now flushed and the final buffered frame is processed once more after EOF.\n - `reasoningReplay: 'summary-only'` returned the stored reasoning item verbatim instead of stripping `content`/`encrypted_content`, leaking full reasoning text the mode promises to omit.\n\n### Changed\n\n- `openai_responses` battery: `background: true` is now rejected at validation time (`E_INVALID_OPENAI_RESPONSES_OPTIONS`) rather than silently accepted and mishandled — the adapter has no polling/resumption logic for a `queued`/`in_progress` background response, so it was previously treating the initial async response as a completed, empty answer and discarding whatever the background job eventually produced. `background: false`/omitted (the default, synchronous request) is unaffected.\n\n## 2026-08-28\n\n### Added\n\n- New `adk/require-string-empty-disposition` ESLint rule, in both the repo-internal plugin (`eslint-rules/`, broader detection covering straight-line/bounded-conditional variable tracking and `ScrapperParamSpec`-shaped object literals) and the published `@nhtio/adk/eslint` plugin (narrower, scoped to a `validator.string()` chain written literally inside a `new Tool`/`new ArtifactTool` `inputSchema`). Flags an `.optional()`/`.default(...)` string schema with no `.allow('')`/`.empty('')`/`.valid(...)`/`.forbidden()` disposition — the exact shape behind the fixes below. `switch`-statement-based schema assembly is permanently out of scope for both copies (see the `media` fix below, found by direct source review instead).\n\n### Fixed\n\n- **`validator.string()` (Joi-based) rejects an empty string `\"\"` on an `.optional()`/`.default(...)` schema, regardless of the modifier — including when `\"\"` is the schema's own configured default.** A model filling in a tool call routinely sends `\"\"` instead of omitting an unwanted optional parameter, which previously failed schema validation outright instead of degrading gracefully. Fixed across every battery the new lint rule (and, for `media`, direct source review) found affected:\n - **`scrapper`** — `device`/`user_agent`/`extra_http_headers`/`proxy_server` now accept `\"\"` and are correctly omitted from the outgoing request (an empty string is never forwarded as a wire query value, including when pinned via `config.fixed`).\n - **`data_structure`**'s `set_operations` — `data_b`/`compare_key` now accept `\"\"`, treated identically to omission.\n - **`memory`/`retrievables`** — `content` (`update_memory`/`update_retrievable`) now treats `\"\"` as \"no change, keep the existing value\"; `id` (`store_memory`/`store_retrievable`) now treats `\"\"` as \"auto-generate\"; `source`/`kind` (`store_retrievable`) now normalize `\"\"` to `undefined` on the newly constructed record.\n - **`searxng`** — `categories`/`engines`/`language` now accept `\"\"`, correctly omitted from the search request.\n - **`sandbox`**'s `run_shell_command` — `cwd` now accepts an explicit `\"\"`, resolving to the workspace root exactly like an omitted `cwd`.\n - **`media`** — `granularSchemaFor`'s string-type verb args (19 args across 14 verbs, including `update_text.replace`/`redact.replace`) now accept `\"\"`. This is a real functional fix, not just a validation nicety: `update_text`'s own documented contract (\"empty string deletes\") was previously unreachable through the granular per-verb tool surface. Note the accepted side effects: `update_text.anchor: ''` now inserts the replacement at position 0 (since `String.prototype.includes('')` is always `true`), and `data.set`/`data.delete` with `path: ''` passes schema validation but still fails cleanly at the handler level (`path must be a non-empty string`).\n - **`datetime_extended`/`datetime_math`/`time`** — timezone-shaped params now accept `\"\"`, resolving to UTC exactly like an omitted value (`time`'s `get_current_time`/`convert_time`, which lacked the other two batteries' existing falsy-check normalization, needed an additional handler-side fix to avoid a worse \"Invalid timezone\" error after the schema loosened).\n - **`formatting`** — `currency` now accepts `\"\"`, degrading to the same \"currency required\" error as omission; `locale` deliberately keeps rejecting `\"\"` (not a valid BCP 47 tag) via an explicit lint-rule exception.\n - **`string_processing`**'s `string_extract` — `flags` now accepts `\"\"`, degrading to the same effective `'g'`-flag behavior as omission.\n\n- New `openai_responses` LLM battery: a vanilla adapter for OpenAI's Responses API, wrapping the flat `input: Item[]` wire shape (a tool call and its result are two sibling top-level items — `function_call`/`function_call_output` — not one message containing both) rather than the Chat Completions `messages[]` array. Ships hand-rolled `fetch`+SSE streaming (no `openai` SDK dependency), the same swappable-translation-helper and three-layer-options-merge design as the sibling Chat Completions/Anthropic batteries, native reasoning-item replay (`reasoningReplay: 'off' | 'encrypted' | 'summary-only'`, with a reasoning/output-item adjacency-sweep pass working around an undocumented pairing constraint in the upstream API), and document-media support (`Media.kind === 'document'` → `input_file` with a `data:;base64,` payload, confirmed against the real API). The adapter is deliberately stateless: `store` is hard-rejected as a settable option (always sent as `false`), and `previous_response_id`/`conversation`/`prompt`/`context_management` are all rejected outright — the full `input` array is resent every iteration, same as every other battery. No Azure/Codex/Mistral/Gemini/Bedrock variants shipped alongside it; this is the vanilla OpenAI Responses API only.\n\n### Fixed\n\n- Extracted the canonical-JSON-plus-SHA-256 prefix-fingerprinting primitive out of `anthropic_messages`'s private `fingerprint()`/`canonical()` pair into a new exported `canonicalFingerprint()` in `chat_common/helpers.ts`, reused by both the Anthropic battery (refactor only, no behavior change) and the new `openai_responses` battery's reasoning-replay adjacency sweep.\n\n## 2026-08-27\n\n### Added\n\n- New `claude_code_cli` LLM battery: a CLI-harness adapter wrapping the Claude Code CLI binary as a `DispatchExecutorFn` destination. Every dispatch iteration is stateless — the full history renders into one `-p` prompt and spawns a fresh, permission-bypassed `claude --bare` process with its own built-in tools fully disabled (`--tools \"\"`). Real ADK tools are bridged into the CLI's tool loop over a local MCP server; the bridge itself (not `--allowedTools`) enforces which bridged tools are callable, since `--dangerously-skip-permissions` removes the permission engine an allow-rule would otherwise feed. Supports both `apiKey`/`authToken` auth (mutually exclusive), a capability-probed `maxTurns` for forward compatibility with CLIs that support it, and CLI-native `maxBudgetUsd` safety caps in place of client-side context-window accounting. POSIX-only in v1 (`darwin`/`linux`) — reliable process-group cleanup has no Windows equivalent. This is the first of a new \"CLI harness battery\" family; the wrapper-process/wire-protocol pattern is documented in `CONTRIBUTING.md` as the template for future Codex CLI / Pi agent batteries.\n\n## 2026-08-26\n\n### Changed\n\n- Retrievable records backed by spooled artifacts now render as handles by default; storage-time auto-spooling covers store/mutate on both context types, fetch results, and DispatchRunner preload normalization, except from-scratch `turnRetrievables.add()` records. Dynamic `Tokenizable` content remains unspooled. Handle-mode budget accounting now applies across all six LLM adapters; the thrift pass excludes unhinted, unmeasurable handle-mode records unconditionally rather than guessing. This may leave orphaned bytes when persistence fails after a successful spool write. Non-core duck-typed thrift callers must set `sizeUnknown` themselves for the same safety guarantee.\n- `web_retrieval` converters now accept `ToRetrievableOptions.inline`; links default to `true` so short link text remains inline after auto-spooling. `scrapperLinksToRetrievables` now accepts `recommend` and genuinely supports its declared `spool` hook, in parity with the other converters.\n\n## 2026-08-24\n\n### Fixed\n\n- **`orderingGuardDispatchMiddleware` in `action: 'mutate'` mode killed the turn on its third\n dispatch iteration, even with zero ordering rules in play.** `runGuard` unconditionally stashed\n the live, in-flight timeline (real `Message`/`Thought`/`ToolCall` instances, `.value` untouched)\n under `EFFECTIVE_TIMELINE` on every pass. `ctx.stash` (a `Registry`) klona-clones its *entire*\n backing store on every `.get()`, regardless of which key is requested — and klona's\n generic-object clone strategy calls `new x.constructor()` with zero arguments before copying\n properties. `Message`/`Thought`/`ToolCall` (and `Thought`'s nested `Identity`) all throw on\n zero-arg construction, so the very next unrelated stash read (the guard's own `SNAPSHOT` read on\n the following iteration) walked the whole store, hit the poisoned entry, and crashed the\n dispatch. Fixed by projecting each stashed entry's `.value` onto a bare plain object carrying\n only the fields any consumer of the stashed timeline actually reads (`id`, `payload`,\n `replayCompatibility`) instead of the live class instance or its `[ENCODE_METHOD]()` snapshot —\n the latter was tried first and found insufficient, since it still nests other live class\n instances (`Identity`, Luxon `DateTime`) that klona chokes on one level deeper. Closes #13.\n\n## 2026-08-23\n\n### Added\n\n- **New opt-in battery `@nhtio/adk/batteries/validation` — the `ordering_guard` turn-state\n validation battery.** Every existing LLM adapter assembles wire history by sorting\n `Message`/`Thought`/`ToolCall` primitives purely by `createdAt`, with no enforcement that a\n vendor's own ordering rules (Anthropic thinking-before-tool-use, Gemini's mandatory\n `thoughtSignature` on the first function call, Nova/Gemma/DeepSeek strict role alternation, Kimi/\n MiniMax/Qwen history-retention invariants, and more) are actually satisfied before dispatch. This\n battery closes that gap: seven typed `OrderingRule` variants (`OrderRule`, `RequiredMetadataRule`,\n `AlternationRule`, `AdjacencyRule`, `PreservationRule`, `RoleRemapRule`,\n `StaleContentAdvisoryRule`) compose into 16 atomic behavior profiles and 38 pre-built family\n recipes spanning Anthropic, Gemini, Nova, Bedrock Converse, DeepSeek, Qwen, GLM, Kimi, MiniMax,\n Mistral, Llama, Nemotron, Gemma, GPT-OSS, Cohere, Phi, Granite, Grok, and a few explicitly-flagged\n unconfirmed baselines.\n\n Two operating modes via `action`: `'enforce'` (strict, zero-mutation validation — rejects any\n violation) and `'mutate'` (best-effort automated repair — reorders primitives, inserts\n alternation fillers, and optionally fills missing vendor metadata). Any repair that could\n fabricate provenance-sensitive metadata (e.g. Gemini's `thoughtSignature` sentinel bypass) is\n gated behind an explicit double opt-in (`allowMetadataFallbackRepair: true`, on top of\n `action: 'mutate'`) so a caller never gets silent metadata fabrication as a side effect of\n turning mutate mode on.\n\n `orderingGuardDispatchMiddleware` and `orderingGuardTurnMiddleware` wire into existing\n `dispatchInputPipeline`/`turnInputPipeline` arrays. `ToolCall` gains an optional\n `payload`/`replayCompatibility` pair (mirroring `Thought`'s existing pattern) to carry\n vendor-opaque metadata like Gemini's thought signature.\n\n See the [Ordering Guard & Validation Battery](https://claude-adk.nhtio.co/batteries/validation/)\n documentation for the full atomic-behavior catalog, the family-recipe lookup table, and the\n repair-strategy reference.\n\n### Fixed\n\n- **`mutateMessage`/`mutateThought`/`mutateToolCall`/`mutateRetrievable`/`mutateMemory` silently\n duplicated the primitive instead of replacing it, in both `DispatchContext` and the parent-flush\n path `DispatchRunner` uses when a nested dispatch runs against a `TurnContext`.** `Set.add()`\n compares by reference, not by a primitive's `id` — a \"mutated\" instance is always a *new* object,\n so every one of these five `#doMutate*` methods on `DispatchContext` called `Set.add(newInstance)`\n without first removing the stale instance sharing that `id`. The stale and fresh copies then\n coexisted in `turnMessages`/`turnThoughts`/`turnToolCalls`/`turnRetrievables`/`turnMemories`\n forever, and any adapter reading those Sets to build a wire payload saw both. The identical bug\n existed independently in `DispatchRunner`'s `#applyDeltaToParent` — the mechanism that flushes a\n nested dispatch's mutation back onto its parent `TurnContext` at the end of each iteration — so a\n mutation correctly deduplicated on a child `DispatchContext` still re-duplicated the moment it\n reached the parent.\n\n Surfaced while building the `ordering_guard` battery's `mutate`-mode repair path, which calls\n these methods directly and was the first code in this ADK to actually exercise them at scale.\n Confirmed via a full audit that this was a genuine oversight rather than a design choice: the\n sibling `#doDelete*` methods, written in the very same initial commit, already contained the\n correct find-by-id-then-remove pattern, and no test anywhere exercised `mutate*`'s effect on Set\n contents before now.\n\n Fixed at both layers: `DispatchContext`'s five `#doMutate*` methods now remove *every* stale\n same-id instance (not just the first — a state the bug itself could produce) before inserting the\n replacement, preserving the replaced primitive's original insertion-order position rather than\n relocating it to the end (several adapters, and this battery's own timeline builder, use Set\n iteration order as the deterministic tie-break for primitives sharing an identical `createdAt`).\n `DispatchRunner` gained an equivalent in-place `Set` rebuild for its own parent-flush path.\n\n- **The `ordering_guard` battery's `mutate`-mode reorder repair now genuinely reaches the live turn\n state.** It previously only reordered a private in-memory copy of the timeline and recorded a\n `__orderingGuardSeqOverride` stash hint no adapter ever consumed — the guard reported the repair\n as \"applied\" and let dispatch proceed, but the real `turnMessages`/`turnThoughts`/`turnToolCalls`\n Sets (and therefore the wire payload an adapter would build) were untouched. Now shifts the\n offending primitive's `createdAt` via the real `ctx.mutateMessage`/`mutateThought`/`mutateToolCall`\n call, which is what the `DispatchContext`/`DispatchRunner` fix above made trustworthy. The\n now-superseded stash mechanism and its `ORDERING_GUARD_SEQ_OVERRIDE_STASH_KEY` export were removed.\n\n## 2026-08-22\n\n### Added\n\n- **The OpenAI Chat Completions battery now reports generation stats.** `finish_reason` and\n `usage` were already typed on this adapter's own response types, but nothing ever read them —\n `helpers.reportGenerationStats` was never called on either the streaming or non-streaming path,\n making the adapter behaviorally inconsistent with its `ollama` and `anthropic_messages` siblings.\n\n Non-streaming: `reportGenerationStats` now fires once per dispatch, reading `finish_reason` and\n `usage.{prompt,completion,total}_tokens` off the response body.\n\n Streaming: the adapter now defaults `stream_options: { include_usage: true }` into the request\n body when streaming (left untouched if the consumer already set one) — OpenAI only sends `usage`\n on the final SSE chunk, and only when this option is set. `finish_reason` and `usage` are read\n independently off the stream rather than off \"the last chunk\", because OpenAI splits them across\n two different chunks: `finish_reason` arrives on the last content-bearing chunk, while `usage`\n arrives on a SEPARATE final chunk with an EMPTY `choices` array.\n\n## 2026-08-21\n\n### Fixed\n\n- **An empty tool-call name from the model crashed the turn, in all six LLM battery adapters.**\n Every adapter's \"unknown tool name\" and \"malformed tool-call args\" fallback branches — the code\n that exists specifically to survive a bad `call.name` from the model — built their error-carrying\n `ToolCall` from the raw `call.name` unguarded. `ToolCall.tool` is validated by a bare\n `validator.string().required()`, which rejects the empty string (not just `undefined`/`null`), so\n the one input those branches exist to handle gracefully crashed them instead with\n `E_INVALID_INITIAL_TOOL_CALL_VALUE`, surfaced to a consumer logging only `err.message` as the\n generic `The LLM execution executor callback threw an error.` — no indication the cause was an\n unnamed tool call, and no path back to the model to self-correct.\n\n Observed in production: a model emitted a tool call with `name: \"\"` mid-run in a multi-vendor\n review panel, permanently killing that one seat for the rest of the job with no retry.\n\n Added `normalizeToolName` (`chat_common/helpers`), substituting a `'(unnamed tool call)'`\n placeholder for an empty name at every such construction site, in `anthropic_messages`,\n `litert_lm`, `ollama`, `openai_chat_completions`, `transformers_js`, and\n `webllm_chat_completions`. The malformed-args branch runs before the unknown-tool-name check and\n has the identical unguarded pattern, so both are fixed identically — a model degenerating enough\n to emit an empty name is just as likely to also emit garbage args.\n\n## 2026-08-16\n\n### Fixed\n\n- **The Qdrant vector-store battery was unusable from a published-package install (three\n independent defects).** None of the three reproduced from ADK's own `src/`, because the test\n suite aliases `@nhtio/adk` straight to source — only a real `pnpm install` of the built package\n hit them.\n\n 1. `uuidFromId` called `require('js-sha256')` directly. The published build (rolldown) rewrites\n bare `require` calls into a runtime shim that throws in real Node ESM (`\"type\": \"module\"`, no\n `require` global) — so every `upsert()` failed with\n `E_VECTOR_STORE_DRIVER_UNAVAILABLE: js-sha256`. Now imports `sha256` statically, matching the\n `weaviate` battery's existing pattern.\n 2. Search called `client.search(...)`, which `@qdrant/js-client-rest` removed in `1.19.0` —\n a version the package's own `^1.18.0` range permits resolving to. Switched to `client.query(...)`\n with a `{ nearest: vector }` query, which exists at both `1.18.0` and `1.19.0`.\n 3. `close()` called `this.#client.close()`, a method `QdrantClient` has never had at either\n client version — so every `close()` call threw. It now just drops the client reference, matching\n the other REST-only vector batteries (`pinecone`, `typesense`, `meilisearch`).\n\n Verified against a live `qdrant/qdrant` container, driving the built `dist` bundle from outside\n the repo (not vitest's source aliasing), at both `@qdrant/js-client-rest@1.18.0` and `1.19.0`.\n\n## 2026-08-14\n\n### Changed\n\n- **BREAKING (sandbox battery): a sandboxed child no longer inherits the host environment.** It gets\n `PATH` and nothing else — not `HOME`, not `USER`, not `TMPDIR`, and none of your credentials.\n\n Before this, `srtEnforcer` spawned every child with the full `process.env`, and the tool factory had\n no way to change that. Since `run_shell_command` exists to run commands the **model** chose, and `env`\n is one of them, every secret in the host process was one tool call from the model's own context — and\n no filesystem or network policy prevents that, because the value arrives in the tool result rather\n than over the wire.\n\n Two new `srtEnforcer` options control it: `envAllowList` (default `['PATH']`) names what a child may\n inherit, and **replaces** that default rather than extending it — pass `['PATH', 'CARGO_HOME']`, not\n `['CARGO_HOME']`, or binaries stop resolving. `inheritHostEnv: true` restores the old behaviour in one\n line, and hands the model every secret in the process; prefer naming what you need.\n `createRunShellCommandTool` also gains an `env` option for explicit per-call variables, applied last.\n\n SRT's own proxy, CA and git plumbing is injected separately and always survives, so the network\n boundary is unaffected. Most deployments need no change: `PATH` is what ordinary commands and the\n ripgrep searcher actually depend on.\n\n### Added\n\n- **`enableWeakerNestedSandbox` on `srtEnforcer`**, for running the sandbox inside an unprivileged\n container — a containerised CI job being the common case. Bubblewrap cannot mount a fresh `/proc`\n there, so every sandboxed command failed with `apply-seccomp: write /proc/self/uid_map: Operation not\n permitted` and **no diagnostics** — exit 1, empty stdout, indistinguishable from a policy denial.\n There was previously no way to express the option at all.\n\n It lands on the enforcer's options rather than on `SandboxPolicy`, which is deliberately SRT-neutral\n vocabulary. Upstream's caveat applies and is worth repeating: the bind-mounted `/proc` exposes process\n information a fresh mount would hide, so enable it only when the **outer** container already provides\n the isolation you need.\n\n- **A CI job that runs the Linux sandbox suite**, in docker-in-docker so it executes in an unprivileged\n container. Until now no job ran bubblewrap at all: the live suites skip themselves into a passing\n report, which is how the missing environment control above shipped unnoticed.\n\n Its first runs established a limit worth stating rather than discovering later: **this runner's dind\n daemon forbids unprivileged user namespaces outright**, so bubblewrap fails before the `/proc`\n question arises — an earlier failure than the one issue #5 reports. `enableWeakerNestedSandbox`\n therefore cannot be validated in CI; confirming it fixes a real container needs a kernel that permits\n capability-bearing unprivileged user namespaces. The job is non-blocking and reports what it observed.\n\n## 2026-08-12\n\n### Added\n\n- **Sandbox batteries — an OS boundary and a JavaScript boundary, deliberately distinct**\n (`@nhtio/adk/batteries/sandbox`, `.../sandbox/tools`, `.../sandbox/node`, `.../sandbox/js`). The ADK\n shipped 23 tool categories and could not run `ls`; that gap was deliberate, because an ungated shell\n is the most dangerous thing you can hand a model. Two boundaries answer two different questions —\n *what can this **process** reach?* (Anthropic's `@anthropic-ai/sandbox-runtime`: Seatbelt /\n bubblewrap+seccomp / WFP, no container) and *what can this **code** reach?* (a hardened `ses`\n `Compartment`). Both are optional peers; neither substitutes for the other.\n\n Nine tools, every one gated: `run_shell_command` (the streaming shell — and the git tool),\n `open_file`/`open_json_file`/`open_markdown_file` (query, returning a spooled artifact),\n `stage_file`/`save_media` (mutate, then make it real on disk), `list_directory`,\n `search_files`/`find_files`, plus `evaluate_javascript` on the SES side. `sandboxedExecutor` adapts\n the existing `BinaryExecutor` for media pipelines.\n\n **Gates are mandatory on every tool, reads included, and no reference gate ships.** The threat model\n for a read is exfiltration — a read of `.env` is unrecoverable, and `search_files` is a\n secret-discovery primitive — so a shipped default would be adopted unread as \"the safe config\". A\n gate is a real suspension: a harness with no decider hangs the turn.\n\n **Failures throw a narrated `E_SANDBOX_*` rather than returning a string, deliberately against house\n style.** A returned string is spooled and renders as an artifact *handle*, so the model would spend a\n call querying an artifact to read one line of refusal. What the model actually reads is\n `The tool handler threw an error during execution. ` — that prefix is core behaviour, so\n the narrated exception must be the direct cause. Outcomes that *did* run return their artifact\n instead: a non-zero exit is a final line, a timeout returns the partial output, and a sandbox\n violation is woven in where it was observed.\n\n **Read the docs before deploying.** `docs/batteries/sandbox/` states the residuals where you meet\n them: TOCTOU on the in-process paths, the four (not one) platform case-matching rules, the fact that\n only the shell and search paths get OS enforcement, and that a green CI run is **no evidence** the OS\n boundary works — the suites that prove it skip silently without `TEST_SANDBOX_LIVE`. Browser\n deployments **require** CSP: CORS gates response readability, not request emission.\n\n Measured and disclosed rather than assumed: on macOS with SRT 0.0.71, `diagnosticsFor()` returns `[]`\n for both a denied read and a blocked host while enforcement itself works correctly — so the\n structured violation this battery's value-add rests on is not populated on that platform today.\n\n A command that cannot be spawned at all — a missing wrapper binary, an unusable `cwd` — settles as a\n failed command rather than taking the host process down with it. An unhandled `'error'` on a\n `ChildProcess` is an uncaught exception, so a sandbox misconfiguration would otherwise have killed the\n agent instead of failing one tool call.\n\n### Changed\n\n- **`ToolHandler` may now return a `SpooledArtifact`** (core). Previously the return union was\n `string | Uint8Array | Media | Media[]`, so a handler that streamed a large file into storage and\n held a reader had no way to return it — and an artifact returned anyway fell into a defensive branch\n and was spooled as **`\"[object Object]\"` with no error**. That silent corruption is gone. Additive:\n no existing handler can return an artifact today, so nothing observable changes for current code.\n\n- **The Anthropic Messages battery now honours `ToolCall.inline`.** `inline` is core vocabulary\n defaulting to `false`, and the other five LLM batteries render a spooled result as a handle\n accordingly; this adapter ignored the flag and inlined the entire artifact. A 5 MB log was a handle\n on five backends and 5 MB of prompt on the sixth. **This is a behavioural change for Anthropic\n deployments**: results that previously arrived inline now arrive as artifact handles. Set\n `inline: true` on the producing call to keep the old behaviour. The `SpooledArtifact[]` array path\n still inlines on every adapter — a wider, separate defect, recorded rather than silently folded in.\n\n## 2026-08-02\n\n### Added\n\n- **`resolveErrorStatus` on the Anthropic Messages battery — a seam for recovering an HTTP status the\n SDK never saw** (`@nhtio/adk/batteries/llm/anthropic_messages`). Unlike the Ollama and OpenAI\n batteries, which read `response.status` off a raw `fetch` and therefore always observe the real\n code, this battery classifies from the SDK's `APIError`. When a gateway terminates the HTTP request\n itself and reports the upstream failure *inside the response body*, `err.status` is absent, coerces\n to `0`, matches nothing in `retry.retriableStatuses`, and the error is classified **fatal** — so a\n transient upstream `529 overloaded_error` failed on first occurrence with `retry.maxAttempts` never\n consulted. The symptom is a distinctive `Anthropic Messages HTTP error 0: 529 {...}`, where the `0`\n is the coercion and the real status sits in the body.\n\n The new optional {@link AnthropicMessagesAdapterOptions.resolveErrorStatus} hook receives\n `{ error, bodyText, sdkStatus }` and returns a status to classify against, or `undefined` to\n decline. The resolved status is what reaches `retriableStatuses`, the\n `E_ANTHROPIC_MESSAGES_HTTP_ERROR` payload, and the log line — so a recovered `529` is reported as\n `529`, not `0`. It runs before both the context-overflow body-text check and retriable\n classification. A resolver that throws, returns a non-integer, or returns a value outside 100–599\n is ignored with a warning and treated as declining, so a misbehaving hook can never replace the\n real upstream error with one from the diagnostic path.\n\n **The ADK deliberately ships no default parser and no behaviour change.** A gateway's error\n envelope is the consumer's knowledge, not the ADK's; a built-in regex would risk reading a\n three-digit request id — or a genuine deterministic `4xx` — as a retriable status. Without a\n resolver, classification is byte-for-byte what it was before this release, including a statusless\n `APIError` remaining fatal. Consumers behind such a gateway opt in explicitly.\n\n### Fixed\n\n- **`countTokens()` shared the same statusless-`APIError` misclassification.** The token-count path\n carried a byte-identical private copy of the error classifier, so the defect above existed there\n too and was not covered by the original report. Both paths now share one\n `translateAnthropicError` (exported, along with `CONTEXT_OVERFLOW_PHRASE` and the\n `AnthropicErrorClassification` type), which is why a single fix now reaches both instead of\n silently leaving one wrong.\n\n## 2026-07-29\n\n### Fixed\n\n- **An empty thinking block no longer kills the turn** (`@nhtio/adk/batteries/llm/anthropic_messages`,\n {@link Thought}). When Anthropic returned a thinking block whose text was empty, the adapter built a\n {@link Thought} with `content: ''` — and `Thought`'s schema rejected the empty string, throwing out of\n the dispatch executor callback and aborting the whole agent turn. The failure was entirely\n client-side: the API call succeeded and the crash happened while persisting the response, so there\n was no HTTP error and no 4xx to point at. Any consumer with thinking enabled could lose a turn\n non-deterministically, depending only on whether the model happened to emit an empty thinking block;\n a response whose only thinking block was `redacted_thinking` (which by definition carries no\n plaintext) failed every time.\n\n {@link Thought} now validates `content` and `payload` as an **either-or**: a thought must carry\n meaning through its prose *or* through an opaque replay payload.\n - `payload` **absent** (plain-text mode) — `content` stays REQUIRED and non-empty, exactly as before.\n The prose is the only thing the thought has, so an empty one is indistinguishable from a bug.\n - `payload` **present** (opaque mode) — `content` may now be empty or omitted. This is what the\n opaque-mode contract already promised: the payload is what round-trips to the wire, and `content`\n is kept only for token-accounting and human/observer inspection. A signed-but-textless thinking\n block still carries a replayable `signature`, so discarding the thought to dodge validation would\n have silently broken signed-thinking replay — strictly worse than storing a thought with no prose.\n\n `Thought.content` remains a `Tokenizable` in every case and is never `undefined` (absent input\n resolves to an empty `Tokenizable`), so no reader needs a presence guard and no existing consumer\n changes. `RawThought.content` is now optional at the type level, which affects only code that *reads*\n a `RawThought` and assumes presence; constructing one is unchanged. New\n {@link Tokenizable.emptyableSchema} backs the emptyable field — {@link Tokenizable.schema} stays\n strict, so an empty `systemPrompt`, standing instruction, `Identity.representation`, or\n `Memory.content` is still a validation error.\n\n- **`E_LLM_EXECUTION_EXECUTOR_ERROR` now names the underlying failure in its own `message`.** The cause\n chain was already preserved, but the wrapper's text was the static `The LLM execution executor\n callback threw an error.` — so a consumer logging `err.message` (the common case) got no signal at\n all, not even the category of failure: a client-side validation error read identically to a transport\n failure, an engine abort, or a bug in the executor. The cause's message is now appended after the\n static text, which is retained as the prefix so existing log greps and string matches keep working.\n Nothing is appended when the cause adds nothing, so unchanged cases stay byte-for-byte identical, and\n `.cause` is untouched.\n\n## 2026-07-18\n\n### Added\n\n- **New opt-in LLM battery `@nhtio/adk/batteries/llm/anthropic_messages` — Anthropic's first-party Messages API.** Ships {@link AnthropicMessagesAdapter}, a complete {@link DispatchExecutorFn} for Claude/Anthropic-shaped Messages endpoints with prompt caching, signed thinking replay (`anthropic-messages-thinking-v1`), native `refusal` stop handling with `stop_details`, image + base64-PDF input, token counting via `countTokens(input, overrides?)`, ADK-owned retry/timeout behavior, and the battery-scoped `E_ANTHROPIC_MESSAGES_*` exception family. `model` and `maxTokens` are required. The adapter is node-first; `dangerouslyAllowBrowser` is exposed but a gateway/server is the supported browser pattern so first-party Anthropic keys are not shipped to users. The battery warns but does not repair request-shape hazards such as invalid tool-use IDs, unsupported `output_config.format` schema keywords, deprecated sampling params, or incompatible model/param combinations.\n - **`@anthropic-ai/sdk` is an optional peer dependency** — it is not bundled into `@nhtio/adk`. Install it yourself (`pnpm add @anthropic-ai/sdk`) when you want this battery; importing either the Anthropic subpath or the aggregate LLM barrel without the peer produces the normal module-not-found for the missing SDK.\n\n- **New generation engine: `local_diffusion` — a BYO-inference-subprocess image-generation engine over a stdio line protocol.** The Node-only {@link LocalDiffusionGenerationAdapter} (`@nhtio/adk/batteries/generation/local_diffusion`, subpath-only — excluded from the environment-neutral generation aggregate) drives a user-supplied inference subprocess over a stdin/stdout line protocol (modeled on DiffusionBee), so a consumer can run a local Stable-Diffusion checkpoint without the ADK bundling Python/torch. Same `generate`/`edit` → `Promise` contract as the other generation engines, plus streamed per-step progress (`dnpr` → the `generating` lifecycle phase), best-effort cancellation (`AbortSignal` → advisory `__stop__`, with `reset()`/`dispose()` as the hard stop), single-flight admission, `outputDir`-contained cleanup of backend-written files, and both inline-base64 and file-path image results. Ships the protocol + a documented Python reference backend; the consumer supplies the process.\n\n## 2026-07-13\n\n### Added\n\n- **New battery domain: `tts` — text-to-speech synthesis generating audio from text.** Two new engines under the shared contract `synthesize(text, opts?) → Promise`: a model-backed {@link TransformersJsTtsAdapter} (`@nhtio/adk/batteries/tts/transformers_js`, MMS-VITS / SpeechT5 via `@huggingface/transformers`), and a zero-config, node-only {@link NativeTtsAdapter} (`@nhtio/adk/batteries/tts/native`) that shells out to macOS `say`, Linux `espeak-ng`, or Windows PowerShell.\n- **New embeddings battery: Ollama.** A fourth engine ships under the shared embeddings shape, targeting Ollama's native `/api/embed` endpoint. The new {@link OllamaEmbeddingsAdapter} (`@nhtio/adk/batteries/embeddings/ollama`) supports `baseURL`, `truncate`, `keepAlive`, and runtime `options`, with zero environment constraints (runs in Node, browser, edge).\n\n## 2026-07-12\n\n### Added\n\n- **New battery domain: `specialists` — on-device speech-to-text, OCR, and image captioning, each a\n narrow single-purpose model turning one modality into TEXT for any text-only LLM.** Three adapters:\n {@link TransformersJsSttAdapter} (`@nhtio/adk/batteries/specialists/stt/transformers_js`, Whisper-family\n ASR via `@huggingface/transformers`, `transcribe(input, opts?) → { text, segments? }`),\n {@link TesseractJsOcrAdapter} (`@nhtio/adk/batteries/specialists/ocr/tesseract_js`, pure-WASM\n `tesseract.js`, `recognize(input, opts?) → { text, confidence? }`), and\n {@link TransformersJsCaptionAdapter} (`@nhtio/adk/batteries/specialists/caption/transformers_js`,\n transformers.js's `image-to-text` pipeline, `describe(input, opts?) → { text }`). All three mirror the\n embeddings adapters' construct-once/`preload`/`reset`/`dispose` shape and are ENVIRONMENT-NEUTRAL —\n `isAvailable()` is always `true`, no WebGPU or platform gate — proven against real weights in both Node\n and a headed, real-GPU Chromium session\n (`tests/functional/batteries/specialists/specialists.webgpu.spec.ts`).\n - **Zero-core-import at the structural-contract layer**, the same posture as the `thrift`/`compact`\n context batteries: `SpecialistMediaLike`/`SpecialistAudioInput`/`SpecialistImageInput`\n (`src/batteries/specialists/_shared`) are locally-declared duck types a real `@nhtio/adk` `Media`\n satisfies without either side importing the other. STT resamples any input — pre-decoded PCM at any\n sample rate, or an encoded container via an injectable `DecodeAudioFn` (default: lazy `audio-decode`\n peer + downmix-to-mono) — to 16kHz mono before the pipeline call; the linear-interpolation resampler\n and the mono-downmix helper were lifted into a shared `lib/utils/audio` module rather than duplicated\n per adapter.\n - **OCR's cached-worker posture is a deliberate divergence from the media battery's own `tesseract_js`\n engine**: one `TesseractJsOcrAdapter` holds a single warm worker across every `recognize()` call\n (construct-once, single-flight resolution) instead of booting a fresh worker per call. tesseract.js v7\n has no safe way to re-language an already-booted worker, so a per-call `languages` override that\n doesn't match the constructor's set throws `E_TESSERACT_JS_OCR_ENGINE_ERROR` rather than silently\n switching; `reset()` and `dispose()` are aliases here (both terminate the worker — no lighter tier\n exists for a live WASM worker).\n - **Composition, proven**: `tests/functional/batteries/specialists/specialist_compose.node.spec.ts`\n feeds Whisper's transcript of `speech.wav` (\"The quick brown fox jumps over the lazy dog.\") and\n Tesseract's OCR of `sample_ocr.png` (\"HELLO OCR\\n123\") to a separate text-only Llama-3.2-1B, which\n grounds its answer (\"Fox\") on that text alone — the pattern this domain exists to enable, not just\n each specialist's own accuracy.\n - **Deliberately no agent integration and no cloud engines.** Same posture as the embeddings batteries:\n the adapter is the whole product — no `Tool` class, no forged tool, no `TurnRunnerConfig` wiring. And\n unlike the LLM/vector batteries (which abstract a real, converged wire contract), the cloud\n STT/OCR/vision landscape has no such convergence — every vendor's API has its own auth model, request\n shape, and SDK, with nothing worth abstracting — so this domain draws the line at on-device only, on\n all three adapters, full stop. New docs section `docs/batteries/specialists/` (overview + one\n reference page per adapter) covers the thesis and the three ways a consumer actually wires one in: a\n BYO `Tool` over the adapter (byo-tools pattern), a direct call outside the tool-call loop, or a\n courtesy write to `Media.stash` that an LLM battery's `fallback-stash` `UnsupportedMediaPolicy` reads\n automatically.\n- **New battery domain: `isolation` — a transport-agnostic protocol substrate for running heavy or\n untrusted work off the main thread (Web Worker) or out of process (node `child_process`), instead of\n hand-rolling the spawn/request-response/crash-recovery plumbing per callsite.** Declare a service once\n with {@link defineIsolatedService} (`methods`/`streams`/`events`), implement it guest-side via\n {@link serveIsolated}/{@link serveIsolatedOverPort}, and drive it host-side via\n {@link createIsolatedService} — over a real browser Web Worker ({@link spawnIsolated}/\n {@link createWorkerTransport}, `@nhtio/adk/batteries/isolation`) or a real node `child_process`\n ({@link forkIsolated}/{@link createChildProcessTransport}, the node-only deep import\n `@nhtio/adk/batteries/isolation/child_process` — not re-exported from the main barrel or the batteries\n aggregate because it imports `node:child_process` directly).\n - **`child_process` over `worker_threads`, deliberately**: threads share the host's address space, so a\n native-addon segfault or V8 fatal error inside one can take the whole host process down with it; a\n real OS child process only kills itself, surfacing to the host as an ordinary `'exit'`/`'error'`\n event. `forkIsolated` pins `serialization: 'advanced'` by default so the tiered codec's opaque\n containers (`TypedArray`/`ArrayBuffer`/`DataView`/`Date`/`RegExp`/`Map`/`Set`) round-trip faithfully\n rather than silently degrading under node's default JSON-style IPC serialization.\n - **Crash containment and recovery**: a transport-reported crash rejects in-flight calls/streams with\n `E_ISOLATED_CRASHED`, flips `state` to `'crashed'`, and fans out to `.onCrash(...)` subscribers;\n recover via manual `.recycle()` or `autoRespawn: { policy }`, a sliding-window {@link createCrashPolicy}\n generalizing the flagship agent's hand-rolled `GpuLossPolicy` into a domain-neutral decider either\n transport's crash can consult.\n - **This exact pattern was hand-rolled three separate times in this repo before the battery shipped**:\n the flagship's 582-line LiteRT-LM worker pair, the media battery's `BinaryExecutor` seam, and the\n specialists' `createPipeline` factory seams — the battery generalizes all three into one spec-first\n substrate. Proven by refit, not by assertion: a `CreateLiteRtLmEngine`-typed factory over\n `forkIsolated` drives a LiteRT-shaped guest end-to-end\n (`tests/functional/batteries/isolation/litert_refit.node.spec.ts`, plus a Web Worker variant), and\n the REAL, unmodified {@link TransformersJsEmbeddingsAdapter} runs its feature-extraction pipeline\n out-of-process through its public `createPipeline` injection seam\n (`tests/functional/batteries/isolation/embeddings_pipeline.node.spec.ts`).\n - **`isolateFunction`** is a separate Blob-URL escape hatch for running an in-memory function value in a\n throwaway Worker without writing a guest file — an explicit, opt-in, `eval`-equivalent trust surface\n gated behind the literal `{ allowSourceRehydration: true }` acknowledgement, both at the type level and\n at runtime.\n - New docs section `docs/batteries/isolation/` (hub, browser, node, recipes) covers the thesis, both\n transports' full option surfaces, and four end-to-end recipes: the LiteRT-LM worker pair refit,\n isolated embeddings over a real adapter unchanged, custom classes crossing the wire via\n `@nhtio/encoder`'s custom-encodable protocol, and wiring an observability dashboard.\n- **New battery domain: `generation` — text-to-image generation and image editing, three engines behind one\n shared contract, for agents that PRODUCE media instead of just consuming it.** Every engine exposes the\n same `generate(prompt, opts?)` / `edit(inputs, prompt, opts?)` → `Promise`\n contract over the same `BaseGenerationAdapterOptions{ model: string }` base (required, no default,\n mirroring the embeddings batteries): {@link OpenAIGenerationAdapter}\n (`@nhtio/adk/batteries/generation/openai`, raw `fetch` against `/v1/images/generations` +\n `/v1/images/edits`, multipart edits, `responseFormatMode` tri-state for the `dall-e`/`gpt-image` split),\n {@link GeminiGenerationAdapter} (`@nhtio/adk/batteries/generation/gemini`, raw `fetch` against the native\n `generateContent` REST surface, probe-confirmed image-parts-first/text-last part ordering for `edit()`,\n refusals surfaced as a thrown malformed-response error with the refusal text embedded), and\n {@link TransformersJsGenerationAdapter} (`@nhtio/adk/batteries/generation/transformers_js`, EXPERIMENTAL\n on-device text→image via DeepSeek Janus's `MultiModalityCausalLM.generate_images()` — the only\n image-generation surface transformers.js exposes, no `pipeline('text-to-image')` task exists — real\n knobs cross-verified against the installed package's own sampler/config source).\n - **`edit()` support is not uniform across engines**: OpenAI and Gemini both support it (multipart form\n data vs. inline base64 image parts, respectively); the transformers.js engine always throws\n `E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION(['edit', reason])` — Janus is text-conditioned\n generation only, with no image-conditioned edit/inpaint entry point in the installed API.\n - **Live-verified through the same LB gateway topology the other cloud batteries use**: both engines'\n `.cross.spec.ts` specs route through the repo's own polyglot LB rather than each vendor's API directly,\n authenticating via a gateway-style `Authorization: Bearer` header instead of each adapter's own native\n scheme (`x-goog-api-key` for Gemini, its own `Authorization: Bearer` for OpenAI). The OpenAI-shaped\n live spec only exercises `generate()` — probing the gateway's `/v1/images/edits` route returned a 404\n (the gateway does not implement OpenAI-shaped image edits, only generations) — while the Gemini live\n spec proves both `generate()` and `edit()` (including a real pixel-level recolor of a fixture image)\n through that same gateway.\n - **Deliberately no agent integration**, the same posture as every other domain in this family: the\n adapter is the whole product — no `Tool` class, no forged tool, no `TurnRunnerConfig` wiring.\n `GenerationImageInput` accepts a real `Media` instance structurally (`{ mimeType, asBytes() }`), zero\n import coupling either direction. New docs section `docs/batteries/generation/` (hub, one reference\n page per engine, recipes) covers the shared contract, each engine's full wire behavior, and how to wire\n a `generate`/`edit` call into a BYO `Tool`, an edit-tool consuming an inbound `Media` attachment, a\n courtesy `Media.stash` caption, and running the on-device engine behind `forkIsolated`.\n\n## 2026-07-07\n\n### Security\n\n- **Prototype pollution in the `data.*` media steps (GHSA-xwg2-cvvj-3w4v).** `data.set` and\n `data.delete` walk a caller-supplied dot/bracket path (`a.b[2].c`) with plain bracket access\n (`container[seg]`); a path segment of `__proto__`, `prototype`, or `constructor` resolved\n through the real prototype chain instead of stopping at an own property, so `data.set` with\n `path: \"__proto__.polluted\"` reached `Object.prototype` and poisoned every plain object in\n the process for the remainder of its lifetime — reachable from LLM tool-call arguments via\n the forged `media_query`/`data_set` tool surface. `parsePath` now rejects any segment in that\n denylist before `walkToParent` ever runs, closing both verbs (they share the same parser).\n `data.merge` used a different code path (`{ ...target }` spread) that is not independently\n exploitable — spreading onto a fresh object literal makes `__proto__` an inert own property,\n not a prototype reassignment — but a new `assertSafeObjectKeys` guard now rejects the same\n three keys anywhere in a merge fragment's tree before either the shallow or deep merge\n strategy runs, so the verb can't be used to smuggle a poisoned key back out through a\n round-tripped document.\n- **Defense-in-depth: reject the same three keys in vector-adapter metadata.** An audit for\n the same vulnerability class found five adapters (`pinecone`, `s3vectors`, `qdrant`, `redis`,\n `cloudflare`) that spread caller-supplied `record.metadata` onto a fresh object literal before\n upsert. None of these were independently exploitable for the reason above — the spread target\n is always a new `{}`, never a walked reference — but a `__proto__`-keyed metadata object would\n otherwise round-trip verbatim through storage and back out to a caller. A new\n `sanitizeMetadata` helper (`src/batteries/vector/helpers.ts`) strips `__proto__`, `prototype`,\n and `constructor` keys before each adapter's upsert path builds its stored record.\n- Audited the rest of the codebase for the same reachable-prototype-chain pattern — the\n `data_structure` and `structured_data` tool batteries, the `apply_patch` media step, the\n data-format `MediaEngine`, and `Registry`'s `dset`-backed path storage — and found no further\n instances; everything else either only reads, or only ever writes to a freshly constructed\n object.\n\n### Added\n\n- **`Tokenizable` accepts a dynamic evaluator, resolved at prompt-assembly time.** Alongside a plain\n string, the constructor now takes a {@link TokenizableEvaluator} — a `(ctx?) => string` — so wrapped\n content can compute itself coherent with the live `DispatchContext` it ships in (e.g. an instruction\n that adapts to whether a tool survived the subtractive-context pass). Resolutions are cached\n per-context in a `WeakMap` so repeated measures of the same dispatch (subtractive pass + overflow\n guard) don't re-invoke the evaluator. A `render(ctx)` method is the explicit, context-aware read;\n the standard string-coercion protocol (`toString`/`valueOf`/`toJSON`) resolves with no context, hitting\n the evaluator's own `undefined`-branch fallback. An evaluator that throws or returns a non-string\n raises the new `E_TOKENIZABLE_EVALUATOR_INVALID` — loud, no silent coercion. New `'gemma'` encoding\n identifier for {@link Tokenizable.estimateTokens} (Gemma 2/3/4, backed by the same\n `@lenml/tokenizer-gemini` SentencePiece vocabulary as `'gemini'` — deliberate reuse, distinct name).\n Files: `src/lib/classes/tokenizable.ts`, `src/lib/exceptions/runtime.ts`.\n- **Token-estimation failures degrade instead of silently returning `Infinity`.** A real-tokenizer\n failure (e.g. a special-token literal, an encoder bug) inside a `TurnRunner` run or `DispatchRunner`\n dispatch now emits a `warning` and falls back to a char-based guesstimate, rather than the previous\n silent `Number.POSITIVE_INFINITY` — which, combined with the overflow guards, could spuriously trip\n an `E_*_CONTEXT_OVERFLOW` on ordinary text. Outside any runner execution, the failure still re-throws\n (a genuine bug in non-runner code must surface). The ambient channel a runner publishes for the\n duration of its run is `src/lib/utils/estimation_context.ts` (new) — a LIFO stack of warn-emit sinks\n so a dispatch nested inside a turn routes to its own (richer) emitter.\n- **WebGPU memory observability for the on-device LLM batteries.** `probeGpuBudget()`\n (`src/batteries/llm/chat_common/gpu_budget.ts`, new) reads the WebGPU adapter's buffer-size limits\n and adapter info, non-invasively — observability only, allocates nothing. A new opt-in\n `instrumentGpuBuffers()` wraps `GPUDevice.prototype.createBuffer` to track live/peak GPU buffer bytes\n against that budget, for an application that wants a live \"you're at X of Y GiB\" gauge. Paired with a\n new typed `E_LLM_GPU_OUT_OF_MEMORY` (`chat_common/exceptions.ts`, new) — `isGpuOutOfMemoryError()`\n matches ORT-web's several GPU-exhaustion and WASM-linear-memory-exhaustion error signatures and both\n the `transformers_js` and `litert_lm` batteries translate a raw provider throw into this one typed,\n catchable error, surfaced via a non-fatal `ctx.nack(...)` rather than a throw. A new `gpuBudget` field\n on the battery lifecycle report carries the probed snapshot. Consistent with the ADK's\n surface-don't-impose stance: the batteries never auto-cap the caller's context window.\n- **Shared tool-call parser layer expanded and hardened.** The `gemma` parser is rewritten as a\n string-aware balanced-brace scanner — correctly handles nested argument objects and the curly smart\n quotes (`“…”`, `‘…’`) small models emit in place of ASCII quotes, instead of the previous lazy-regex\n approach. Two new parser families: `'bare_pythonic'` and `'loose_keyed'` (`toolCallParser` /\n `ToolCallParserName`). New observer seams on every LLM battery's options: `onRawGeneration` (the raw\n model text for a completed generation, after envelope-stripping but before persistence — reasoning /\n tool-call parser bring-up, live abstention debugging, fixture capture) and `onPromptAssembled` (the\n fully-assembled request about to ship, the mirror tap on the way in). Both are purely observational,\n default-absent, and consumed by all five LLM batteries (`chat_common/tool_parsers.ts`,\n `chat_common/lifecycle.ts`, `chat_common/types.ts`).\n- **`litert_lm` battery: engine hosted in a disposable Web Worker.** New standalone worker build\n configs — `litert-lm-worker.vite.config.mts` and `webllm-worker.vite.config.mts` — with matching\n `build:litert-lm-worker` / `build:webllm-worker` package scripts, compiling the LiteRT-LM (IIFE,\n classic-worker-compatible — LiteRT's Emscripten glue calls `importScripts()`, illegal in a module\n worker) and WebLLM (ES module worker) engine handlers as separate bundles co-located with their wasm\n assets, so a long-lived session can recover from a browser-level WebGPU device loss by terminating\n and respawning the worker rather than reusing a dead `GPUAdapter`. The adapter's existing\n `createEngine` injection seam (`LiteRtLmAdapterOptions.createEngine`) is what a host wires a\n worker-backed engine through; the battery itself stays runtime-agnostic.\n- **`DispatchRunner` / `TurnRunner` emit a `WarningEvent`** observability payload — non-fatal\n conditions (starting with the token-estimation degrade above) surfaced through the same observability\n bus as `LogEvent` / `GenerationStatsEvent`, carrying `dispatchId`/`iteration`, a `source`, and a\n `kind`. Executor-thrown and nacked errors also now preserve a meaningful `Error`-shaped `cause` even\n when the thrown/nacked value is not itself a strict `Error` (a raw string or cross-realm error no\n longer collapses to a cause-less generic wrapper) — `toErrorCause` in `src/lib/dispatch_runner.ts`.\n- **Documentation: the \"Punching Above Its Weights\" showcase family.** The flagship agent showcase\n (`docs/showcase/punching-above-its-weights.md`) demonstrates building a real tool-using agent under\n hostile conditions — Gemma-4 E2B via `LiteRtLmAdapter` in a browser tab, a 4GB GPU ceiling, a\n live-draggable context window — technique by technique (planner book-end, subtractive pass over the\n shipped context battery, gate cascade, artifact handles, GPU survival), each with real code embeds\n and field-note receipts, closing on the blind-judged 5-cell evaluation matrix. Its companion\n **\"The Agent, In Full\"** (`docs/showcase/punching-above-its-weights-source.md`) exposes the complete\n 31-file agent source in a read-only in-page Monaco viewer, with an LLM-consumable full-source\n mirror emitted through the docs pipeline for coding agents to port from. Method-side pages:\n **Token Thrift** (`docs/the-loop/token-thrift.md`, the context-discipline lever), **Behavioral\n Rails** (`docs/the-loop/behavioral-rails.md`, gates/own-voice nudges/the planner contract), **Read\n the Wire** (`docs/the-loop/read-the-wire.md`, evidence-directed agent debugging), and **Runtime\n Loading** (`docs/assembly/runtime-loading.md`, the `@nhtio/adk/shims` consumption guide). The\n underlying evaluation/research harness (corpus runs, floor calibration, adversarial threads, the\n LiteRT worker Step-0 probe) is committed under `research/`.\n\n- **New context battery domain: `thrift` and `compact`, two strategies for what goes into one\n dispatch's window.** `src/batteries/context/thrift` is the subtractive strategy already backing\n the Token Thrift work above — `subtractToFit`, `stripPriorTurnThoughts`, and the calibrated\n `selectRelevantTurns`/`scaledRelevanceFloor` relevance-based turn selection (floor constants\n `RELEVANCE_FLOOR_MIN`/`MAX`/`CURVE` calibrated against a triple-oracle, 94-turn stress corpus) are\n now a standalone, importable battery rather than flagship-agent-only code.\n `src/batteries/context/compact` is new: a faithful extraction of the flagship agent's own\n Claude-Code-style auto-compaction (`assembleCompactedTurns`, `summariseTurns`,\n `COMPACTION_SYSTEM_PROMPT`) — keep the newest turns verbatim, fold everything older into a\n rolling summary once it crosses a token threshold. Both batteries are built entirely on injected\n resolvers rather than bundled capabilities: `EstimateTokensFn` (no default tokenizer) and, for\n `compact`, `SummarizeFn` (no default model transport) — with **zero imports from `@nhtio/adk`\n core** at the structural-contract layer (`WorkingMessage`, `WorkingMemory`, `WorkingRetrievable`,\n and friends are locally-declared, duck-typed shapes a real core object satisfies structurally\n without either side importing the other). This decoupling is practical against real models\n because of the token-estimator registry added above ({@link registerTokenEstimator}) — a caller\n can register a custom encoding's estimator without editing `Tokenizable`'s internal switch, so\n `thrift`/`compact` work against any encoding a project uses, built-in or not. The two batteries\n are composable: `thrift`'s `isSummaryMessage` predicate (default id `'__compact-summary'`,\n matching `compact`'s `DEFAULT_SUMMARY_MESSAGE_ID`) protects `compact`'s rolling summary message\n from being shed like an ordinary old turn when both run in the same pipeline. Evaluated\n head-to-head against a naive-recency baseline across five model/window cells on a shared 94-turn\n corpus: thrift is the lightest arm nearly everywhere and never collapses, while compact tops the\n two cells where real context pressure meets a paid summarizer budget (kimi-k2.5 @ 128k, 1.48 vs.\n 1.13; gemma-31b @ 128k, 1.48 vs. 1.35 — both 3-judge) — documented in full,\n including the naive baseline's 0.08 collapse on the kimi cell and per-cell dispatch/summarizer-\n overhead tables, in the new `docs/batteries/context/` pages.\n\n- **`@nhtio/adk/shims` — an async-resolver seam for binding a runtime-loaded ADK bundle without\n importing core into the consumer's module graph.** {@link createAdkShim} wraps a consumer-supplied\n {@link AdkResolverFn} (all environment knowledge — `fetch` + dynamic `import()`, a Worker handshake,\n a host-injected global — lives in that one function; the shim ships no loading policy of its own)\n and returns `{ resolve, get, resolved, proxy }`: single-flight `resolve()`, a synchronous `get()` for\n already-resolved reads, a live `resolved` boolean, and a `proxy` that replaces the hand-rolled\n `export let Foo: typeof Module.Foo` holder pattern with one destructurable object. Memoization is\n GC-safe — the resolved bundle is held via `WeakRef` (never strongly retained by the shim itself),\n falling back to a plain strong reference only where `WeakRef` is unavailable. A module-scope ambient\n variant (`registerAdkResolver` + `adk`) covers the \"many files, one shared binding\" case. Three typed\n exceptions cover the failure modes: `E_SHIM_NOT_RESOLVED` (a sync read before anything resolved),\n `E_SHIM_RESOLUTION_FAILED` (the resolver rejected or threw, cause preserved), and\n `E_SHIM_RESOLVER_ALREADY_RESOLVED` (re-registering the ambient resolver after it already resolved\n once — a split-brain guard). `src/shims/index.ts` is a **leaf module** — proven at dist level\n (`shims.mjs`, 17.7KB) to import only the exceptions chunk plus `@nhtio/validation` and `fast-printf`,\n zero core graph — and deliberately not re-exported from the root `@nhtio/adk` barrel, since doing so\n would drag the very module graph this subpath exists to let you avoid back into the import. The docs\n site itself now dogfoods this exact seam: `docs/.vitepress/theme/components/quickstart_demo_runtime.ts`\n replaced its own four-times-hand-rolled memoizing loader (the one that exists because importing ADK\n source into the VitePress module graph overflows the JS call stack on iOS WebKit) with\n `createAdkShim(resolver)`, the resolver supplying only the docs app's URL-resolving policy.\n\n### Changed\n\n- **`@sqlite.org/sqlite-wasm` and `kysely` are now docs-site devDependencies** — used by the docs\n site's in-browser SQLite demo tooling, never shipped in the published package. **`katex`** is now a\n runtime `dependency` (previously absent) — it backs the math tools battery\n (`src/batteries/tools/math/index.ts`).\n\n## 2026-06-26\n\n### Added\n\n- **Portable generation vocabulary shared by the two text-out on-device batteries** (`transformers_js`,\n `litert_lm`). Both now accept one canonical {@link ChatGenerationOptions} surface — `maxTokens`, `sampler`\n (`'greedy'`|`'top-k'`|`'top-p'`), `temperature`, `topK`, `topP`, `seed`, `enableThinking`,\n `multimodal: { image, audio }` — and each adapter maps it onto its own runtime API. Precedence is\n **canonical-wins**: the canonical field is honored and the battery's native field (transformers.js\n `maxNewTokens`, LiteRT `maxOutputTokens` / `samplerParams`) is the fallback consulted only when the canonical\n one is absent, so existing native-field config keeps working. Defaults are identical across both batteries\n and chosen for reproducibility (`sampler: 'greedy'`, `enableThinking: false` — many reasoning templates\n default thinking *on* and burn the token budget before the answer; this turns it off unless asked).\n- **Normalized lifecycle hook surface across all on-device batteries** (`transformers_js`, `litert_lm`,\n `webllm_chat_completions`, and the transformers.js embeddings battery). A new opt-in {@link BatteryLifecycleHooks}\n block: an `onLifecycle` firehose plus per-phase hooks `onLoading` → `onCompiling` → `onReady` →\n `onGenerating` → `onComplete` (or `onError`), each handed a normalized `BatteryLifecycleReport`\n (`{ phase, battery, model, at, detail?, progress?, raw?, error? }`). `progress` is normalized to `0..1`\n during `loading` when the provider reports it; the `compiling` phase marks the WebGPU/wasm shader/graph\n build between download and first token — often the slowest part of a cold start, and previously invisible.\n Purely additive — omit the hooks and behavior is byte-for-byte unchanged; a throwing consumer hook can never\n abort a load or a turn. The existing per-provider `onInitProgress` is untouched.\n- **Multimodal INPUT for the transformers.js battery.** Image and audio flow through the model's processor\n (called positionally, `_call(text, images, audio)`); a multimodal model genuinely perceives them. For the\n common audio case — uncompressed PCM WAV — the battery decodes the RIFF itself with a `DataView`,\n dependency-free and **env-neutral**, *before* importing the heavy peer (transformers.js's own `read_audio`\n needs the Web Audio API's `AudioContext`, which does not exist in Node; compressed containers still fall\n back to it, browser-only). Enable per kind via the canonical `multimodal: { image, audio }`.\n- **Opt-in media-OUTPUT seam (`extractMediaOutputs`) on the `transformers_js` and `litert_lm` batteries.**\n Default absent → text-out, byte-for-byte unchanged. Supply the hook and a wrapped media-emitting model's\n generated audio/image is persisted via `ctx.storeMediaBytes`, wrapped as a first-party `Media.toolGenerated(...)`,\n and surfaced as an assistant `Message.attachments` entry (a media-only turn — empty text + attachment — is\n legitimate). The batteries remain multimodal-in / text-out by default; this is for an LLM turn that produces\n media alongside or instead of text.\n- **`'phi'` tool-call parser** added to the shared parser layer's `toolCallParser` set and the `'auto'`\n priority order (`hermes → gemma → gpt_oss → phi → pythonic → llama3_json → mistral → qwen3_coder`). Anchored\n on the literal `functools` token (verified against vLLM's `phi4_mini_json` parser), so it runs with the\n other marker-anchored families ahead of the weak-signal JSON/pythonic forms.\n- **`EmbeddingGemma 300M`** (`onnx-community/embeddinggemma-300m-ONNX`) verified through the\n `transformers_js` embeddings battery — 768-dim, unit-norm, deterministic — alongside the existing\n MiniLM / BGE-small / Arctic-S entries.\n- **The real-model test matrix** (`tests/_fixtures/model_matrix.ts`, gated on `TEST_MODEL_MATRIX=1`): loads\n each real ONNX / `.litertlm` model, drives one dispatch turn, and asserts the expected parser family or\n multimodal grounding is extracted — because a small model may not emit the format its chat template implies\n (Gemma 4 E2B emits the decoder-stripped `call:NAME{k:v}`, not the template's `<|tool_call>…`). A Node half\n (`pnpm run test:matrix`) and a headed-WebGPU browser half (`pnpm run test:matrix:browser`, local-only — CI\n runners have no GPU). `bin/capture_tool_outputs.ts` (`pnpm run capture:tools`) captures real raw output from\n hosted big-only families (`qwen3_coder`, `gpt_oss`, `mistral`) via any OpenAI-compatible proxy into committed\n parser fixtures — configured with `--base-url`/`--api-key` or the generic `CAPTURE_BASE_URL` /\n `CAPTURE_API_KEY` env vars; never run in CI.\n- **Documentation: a dedicated \"LLM Batteries\" section** under Featured Batteries — an overview hub, a\n \"Shared Contract\" page (the three `chat_common` pillars: parser layer, portable generation vocabulary,\n lifecycle hooks), and a reference page per battery (OpenAI, Ollama, WebLLM, LiteRT-LM, Transformers.js) each\n carrying a tested-model table grounded in the matrix. Plus a showcase, \"Building the On-Device Batteries,\"\n documenting the parser archaeology, the false-green fixtures, and the one wall we could not engineer around:\n **LiteRT-LM in the browser runs Gemma and only Gemma**, proven at the file-format level\n (`tf_lite_prefill_decode` vs `tf_lite_artisan_text_decoder`) — converting a non-Gemma model to a\n browser-runnable `.litertlm` is a dead end with the public toolchain. The dead `convert_model` / `deploy_model`\n scripts (which described a fictional CLI) were removed and the conversion doc rewritten as \"The Real-Model\n Matrix.\" Docs are bundled in the npm package and served by the ADK Assembly MCP, so this ships with the release.\n\n### Changed\n\n- **`bin/capture_tool_outputs.ts` now reads its proxy URL/key from `CAPTURE_BASE_URL` / `CAPTURE_API_KEY`**\n (or the existing `--base-url` / `--api-key` flags), replacing internal-specific env-var names. Dev tool only;\n not part of the published runtime surface.\n\n### Fixed\n\n- Fixed the documentation release pipeline.\n\n## 2026-06-25\n\n### Added\n\n- **New opt-in LLM battery `@nhtio/adk/batteries/llm/transformers_js` — on-device ONNX text generation,\n in Node AND the browser.** Ships `TransformersJsAdapter`, a one-line {@link DispatchExecutorFn} wrapping\n [`@huggingface/transformers`](https://www.npmjs.com/package/@huggingface/transformers) (an optional peer,\n already present for the media ASR engine). Unlike the WebLLM and LiteRT-LM batteries (WebGPU/browser-only),\n transformers.js is **environment-neutral** — it auto-selects `onnxruntime-node` (native, plain Node, no GPU)\n or `onnxruntime-web` (WASM + WebGPU) — so this battery runs server-side and client-side from one codepath\n and does **not** gate on `navigator.gpu`. `device`/`dtype` pick the backend and quantization. `STASH_KEY`\n is `'transformersJs'`.\n- **New opt-in embeddings battery `@nhtio/adk/batteries/embeddings/transformers_js`.** Ships\n `TransformersJsEmbeddingsAdapter` — on-device `feature-extraction` embeddings with the same\n `embed`/`embedMany`/`dimensions`/`preload`/`reset`/`isAvailable` surface and `number[]` return shape as the\n OpenAI and WebLLM embedders, plus `pooling` (default `'mean'`) and `normalize` (default `true`). Being\n environment-neutral, it is surfaced from the `@nhtio/adk/batteries/embeddings` aggregate barrel (alongside\n OpenAI; WebLLM stays deep-import-only).\n- **New shared, configurable tool-call + reasoning text-parser layer** (re-exported from both\n `transformers_js` and `litert_lm`). Text-only on-device runtimes inject tool definitions into the chat\n template but emit tool calls and reasoning as **family-specific raw text**, not structured fields — so the\n battery parses them out, the way vLLM/SGLang/Ollama do (post-hoc, per-family, flag-selected). Two options,\n both defaulting to `'auto'` (try the bundled family parsers in priority order, first match wins):\n - `toolCallParser`: `'auto'` · `'hermes'` · `'gemma'` (E2B/E4B) · `'gpt_oss'` (Harmony) · `'pythonic'` ·\n `'llama3_json'` · `'mistral'` · `'qwen3_coder'` · `'none'` · a custom `ToolCallParserFn`.\n - `reasoningParser`: `'auto'` · `'think_tag'` (`…`) · `'harmony_analysis'` · `'gemma_channel'`\n · `'none'` · a custom `ReasoningParserFn`.\n Marker-anchored families run first (no cross-family false positives); weak-signal JSON/pythonic forms are\n gated on the callee being a real tool. Parsed reasoning becomes ADK Thoughts; cleaned prose is the assistant\n Message; tool-call `arguments` are a plain object (no `JSON.parse`). Bundled defaults target the small ONNX /\n Ollama-Cloud-tier open-weight families (Gemma 4 E2B/E4B, gpt-oss:20b, Qwen3-Instruct, Llama 3.2, SmolLM).\n Gemma's tool-call + reasoning delimiters were verified byte-exact against the model's own\n `tokenizer_config.json`; both batteries were validated end-to-end against real ONNX models (MiniLM embeddings,\n SmolLM2-135M generation).\n\n### Fixed\n\n- **LiteRT-LM tool calling and reasoning extraction now actually work** (`@nhtio/adk/batteries/llm/litert_lm`).\n The battery as first shipped (v1.20260625.0) read `Message.tool_calls` and `Message.channels` off model\n output — but the `@litert-lm/core` v0.13.1 JS runtime is **text-in / text-out** and never populates those\n fields on output (they are input-only wire fields; the package README confirms text-only I/O). So the prior\n tool-calling and reasoning support was **non-functional against real models** (the mocked tests passed\n because the fakes populated the fields). The adapter now parses tool calls and reasoning out of the model's\n **text** via the new shared parser layer, with the same `toolCallParser` / `reasoningParser` options\n (default `'auto'`). If you relied on LiteRT-LM tool calls or thoughts before, they begin functioning with\n this release.\n\n## 2026-06-24\n\n### Added\n\n- **New opt-in LLM battery `@nhtio/adk/batteries/llm/litert_lm` — on-device WebGPU inference of Google's\n `.litertlm` models.** Ships `LiteRtLmAdapter`, a one-line {@link DispatchExecutorFn} wrapping\n [`@litert-lm/core`](https://www.npmjs.com/package/@litert-lm/core) (browser/WebGPU + a bundled wasm\n runtime). Unlike the WebLLM battery it is **standalone, not an OpenAI-wire subclass**: it drives\n LiteRT's native `Engine.create() → createConversation({ preface }) → sendMessageStreaming():\n ReadableStream` API, takes tool-call `arguments` as a parsed object (no `JSON.parse`), and\n surfaces \"thinking\" via `Message.channels` → ADK thoughts. Full parity with the other batteries: text,\n streaming, thoughts, tool use, sampler/limit controls (`samplerParams`, `maxOutputTokens`,\n `maxNumTokens`, `backend`), and the typed multimodal contract (`audioModalityEnabled` /\n `visionModalityEnabled`). It reuses the format-agnostic render helpers; only the wire-shape mappers are\n LiteRT-native (`buildLiteRtConversationInput`, `toolsToLiteRtTools`, `renderLiteRtToolResult`, the\n streaming accumulator), each swappable via `helpers`. `STASH_KEY` is `'liteRtLm'`; exceptions are the\n `E_LITERT_LM_*` family plus `E_INVALID_LITERT_LM_OPTIONS` and `E_UNSUPPORTED_MEDIA_MODALITY`.\n - **`@litert-lm/core` is an optional peer dependency**, pinned exact (`0.13.1`) — it ships its own\n ~19 MB wasm and is **not** bundled into `@nhtio/adk`. Install it yourself (`pnpm add @litert-lm/core`)\n when you want this battery; it is never required for type-checking a consumer.\n - **The published `@litert-lm/core` docs lag the library** — tool use, channels, sampler controls, and\n multimodality are typed but undocumented. The adapter is mapped against the installed `.d.ts` (the\n source of truth); re-verify on upgrade. Preview `.litertlm` models are text-in/text-out today, so the\n native multimodal path is built-to-contract but not yet exercisable end-to-end.\n- **Serialization: the ADK primitives now round-trip through [`@nhtio/encoder`](https://encoder.nht.io).**\n Encode an entire conversation graph — `Message`s with nested `Identity`, `Tokenizable`, and `Media`;\n `ToolCall`s with their results; `Memory`, `Thought`, `Retrievable`, `Registry` — to a string with\n `encode()` and rebuild it (instances, not plain objects) with `decode()`. Every primitive implements\n the encoder's custom-class contract via raw `Symbol.for()` keys, so **the contract adds zero\n dependency to the core** — `@nhtio/encoder` is an optional peer, pulled in only by the new battery.\n- **New opt-in battery `@nhtio/adk/batteries/encoding`.** Call `registerAdkEncodables()` once at startup,\n before your first `decode()` — it registers every primitive with the decoder and auto-registers the\n binding-free reader resolvers (in-memory, fetch). This is the only code that imports `@nhtio/encoder`.\n- **Reader handles round-trip, not bytes.** `Media` and `SpooledArtifact` serialize the *handle* — a\n tagged, re-openable locator — via a new optional `describe()` method on the `MediaReader` /\n `SpoolReader` contracts. On decode, a tag→reader resolver registry (`registerMediaReaderResolver` /\n `registerSpoolReaderResolver`) re-binds the handle to a live reader; for durable stores (flydrive,\n OPFS) the consumer registers the resolver carrying the live `Disk`/root the locator cannot itself\n carry. In-memory readers inline their buffer; the fetch reader captures its URL.\n- **New exceptions** `E_READER_NOT_DESCRIBABLE` (encoding a primitive whose reader has no `describe()` —\n e.g. a `fromWebFile`-backed `Media`) and `E_NO_READER_RESOLVER` (decoding a handle whose tag has no\n registered resolver), both exported from `@nhtio/adk/exceptions`.\n\n#### Not encodable, by design\n\n- **`TurnGate`** wraps a live pending Promise + `AbortController` — there is no serialized form of \"a\n thing some caller is awaiting\", so it deliberately does not implement the contract.\n- **`Tool` handlers serialize by source text only.** A handler that closes over `ctx`, service clients,\n or config loses those bindings on decode (the captured variables read back `undefined`); a `.bind()`-ed\n or native handler cannot be serialized at all. `Tool.inputSchema` round-trips losslessly via\n `@nhtio/validation`'s own `encode`/`decode`. Tools are rarely serialized; when they are, reconstruct\n dependencies inside the handler body rather than closing over them.\n- **`fromWebFile`-backed `Media`** is not encodable — a browser `Blob` has no re-openable locator and the\n synchronous encoder cannot drain it. Persist to a media/spool store and wrap in a describable reader\n first.\n\nThis release is **additive — no major bump** (per the `..` scheme, the major moves\nonly on core-contract breaks). The symbol methods are new surface; the new optional `describe()` on the\nreader contracts is backward-compatible (optional method, duck-typed schemas unchanged); no existing\nprimitive constructor or field changed.\n\n### Fixed\n\n- **`Message` with empty `attachments` is no longer mis-rejected by its own serializer.** The\n newly-added `Message` encode path emitted `attachments: []` for text-only messages, which the message\n schema's \"at least one of content/attachments, and a present `attachments` must be non-empty\"\n cross-field rule then rejected on `decode()`. The encode snapshot now omits `attachments` entirely when\n empty. Only reachable via the new serialization path — no impact on existing construction.\n\n## 2026-06-23\n\n### Fixed\n\n- **`Tokenizable` now caches the tiktoken encoder instead of rebuilding it per call**\n (reported against `1.20260612.0` from a Node/AdonisJS host embedding the ADK). `js-tiktoken`'s\n `getEncoding` has no internal cache — every call does `new Tiktoken()`, parsing the full\n BPE rank table (~800 ms for `o200k_base`), which is ~1000× the cost of the `encode()` that\n follows. The tiktoken backend was the one estimator that never got the lazy-singleton treatment\n the Gemini and Llama backends already had, so a fresh encoder was constructed on **every**\n `estimateTokens` invocation that missed the per-value memo. On a tool-heavy turn — where a\n battery re-measures an accumulating dispatch context once per iteration — this rebuilt the BPE\n table O(results × iterations) times, saturating a single-threaded host's event loop (CPU pegged,\n RSS oscillating multi-GB under GC of the repeatedly-allocated vocabulary, co-tenant HTTP\n starved). The encoder is now memoized in a module-level `Map`, mirroring\n the existing Gemini/Llama singletons; construction drops to once per encoding per process.\n Behaviour-preserving (`Tiktoken` instances are stateless and reusable), benefits every\n tokenization path ADK-wide, and is the single highest-leverage change against the reported\n event-loop starvation.\n\n## 2026-06-12\n\n### Added\n\n- **Media generation: the `empty:` sentinel.** Agents can now CREATE media, not just\n derive it. `media_id: \"empty:xlsx\"` (or `empty:png`, `empty:json`, …) mints a brand-new\n blank file and runs the statement against it — creation and population in one round-trip;\n `@empty:` works as a statement ref too (`merge with=@empty:xlsx`). Strictly\n additive: harness ids are UUIDs, so every `empty:*` value was previously a guaranteed\n `MEDIA_NOT_FOUND`. Under the hood, generation is one new convert edge — the virtual source\n MIME `EMPTY_MIME` (`application/x-adk-empty`) — declared per engine; the creatable set is\n pure graph reachability (`convertTargets(EMPTY_MIME)`, multi-hop included), never a policy\n list. Deterministic generation (blank workbook/canvas/silence) ships bundled; model-based\n semantic generation (diffusion/TTS) is BYO via the same edge. Generation edges landed on\n jimp + sharp (1024×1024 white canvas), audio_decode (1 s of 16-bit mono silence at\n 44100 Hz, dependency-free), soffice (its whole matrix, via zero-byte seed files —\n LibreOffice treats an empty seed as an empty document; pinned by a binary-gated spec), and\n the three new engines below.\n- **`edits` — a third engine capability kind** (additive: `MediaEngine.edits?`,\n `EditCapability`/`EditRequest`/`EditResult`, `registry.edit()`/`hasEdit()`, selection\n middleware sees `kind: 'edit'`). Structural document ops are now declared, dispatched, and\n swappable like converts and mutates — and two engines may declare the same ops with\n different fidelity, with supply order picking the winner.\n- **New engine `engines/sheetjs`** (`sheetjsEngine()`, optional peer `xlsx` **>=0.20.2 — install\n from the SheetJS CDN**, the npm registry copy is frozen at 0.18.5 with CVE-2023-30533 and\n CVE-2024-22363): the in-process, cross-env spreadsheet engine. Reads\n xlsx/xlsm/xlsb/xls(all BIFFs)/ods/fods/csv/NUMBERS/sylk/dif/dbf; writes those plus\n txt/html/rtf/json; generates any write target from `EMPTY_MIME`; edits every `sheet.*` op\n over its whole read matrix. SheetJS CE strips styling — documented loudly, asserted in\n tests, and the reason exceljs exists alongside it.\n- **New engine `engines/exceljs`** (`exceljsEngine()`): workbook editing promoted out of the\n `sheet.*` steps into a fleet-visible engine. Edits every `sheet.*` op over xlsx with\n **styling preserved** (bold/fills/comments/formulas survive untouched — the fidelity pin is\n a test), and generates blank xlsx from `EMPTY_MIME`. Compose it before sheetjs when\n formatting matters; sheetjs alone covers data-only workloads without the extra peer.\n- **New engine `engines/data`** (`dataEngine()`): the deterministic text/data engine. Generates\n txt/md/json/yaml/csv/html seeds from `EMPTY_MIME`; converts json⇄yaml, json⇄csv (papaparse\n peer, lazy), json→txt.\n- **New verbs: `append`, `data.set`, `data.merge`, `data.delete`.** The lossy text family is\n first-class media now: append a line to txt/md/csv/yaml, set/merge/delete at a JSON or YAML\n path (output format follows the input). `empty:json | data set path=… value=…` is a\n complete create-then-populate chain with zero engine requirements.\n- **Structured `apply_patch` envelope** — the GitHub Copilot apply_patch dialect\n (`*** Begin Patch`, Add/Delete/Update File, `*** Move to:`, `@@` context hunks), preserved\n exactly because models already know it. Multi-file via `with=@refs`; Add File can grow the\n workspace, so the result may be multiple media. Ambiguous hunk context fails rather than\n guessing. The unified-diff path is untouched, and the diff→apply_patch round-trip is now a\n tested contract (`diff A with=@B` applied to A reproduces B byte-exact).\n- **`redact` and `update_text` on ODF** (odt/ods/odp — in-place `content.xml` edits with the\n same paragraph-aggregation matching the OOXML path uses) and **`redact` on PDF** — VISUAL\n redaction via pdf-lib (draw-over on matching pages + metadata strip). The caveat ships in\n the verb description and the docs because it is a trust boundary: content streams keep the\n original text; for content-level redaction, extract text first.\n- **Spreadsheet vocabulary expansion**: xlsm/xlsb/fods/sylk/dif/dbf/numbers/yaml join the\n format tables and `convert to=` targets; all spreadsheet-family MIMEs normalize to xlsx for\n `sheet.*` edits whenever any configured engine declares the conversion (sheetjs in-process,\n or soffice).\n\n### Changed\n\n- **`sheet.*` verbs now require a registered edit-capable engine** (`requires: { capability:\n 'edit' }`). Previously the steps lazy-imported exceljs directly, so merely installing the\n peer lit the verbs up; now the consumer registers `exceljsEngine()` (or `sheetjsEngine()`)\n in the engines array like every other capability. This is a behavior change for deployments\n that installed exceljs without declaring it — the failure message names the exact fix, and\n the engines docs carry a migration note.\n- `convert` may newly appear in image-only deployments: jimp/sharp now declare generation\n convert edges, so `hasConvert()` turns true. A model attempting an unreachable conversion\n still gets the existing model-actionable reachable-targets failure.\n- `MediaPipeline.capabilities` is now typed as the full `EngineRegistry` (the runtime value\n always was); `CapabilityProbe` gains an optional `hasEdit()`.\n- **`dist/package.json` gains `mcpName: \"io.nht/adk-assembly\"`** and the build emits\n `dist/server.json` for the MCP Registry. No behavioral change for existing consumers.\n\n## 2026-06-11\n\n### Security\n\n- **npm trusted publishing is live — releases no longer use a long-lived token.** Completing\n the groundwork below: the package's Trusted Publisher is configured on npmjs.com (GitLab\n CI/CD → this project's `.gitlab-ci.yml`, `npm publish` only), and both npm deploy jobs now\n authenticate exclusively with the short-lived OIDC `id_token` — every `NPM_TOKEN` reference\n is gone from this repository's CI. Verified live twice before removal: npm preferred the\n OIDC exchange even with the token fallback still present (publisher identity\n `GitLab CI/CD `), and the first fully tokenless publish\n succeeded with the same identity. A stolen CI token — the credential class behind most of\n the recent registry-compromise worms — can no longer publish this package; publish rights\n are bound to this repository's pipeline identity instead of a bearer secret.\n- **Supply-chain hardening across the build and dependency pipeline** (prompted by the recent\n npm worm campaigns; none of these change the published API):\n - **Release cooldown**: pnpm now refuses to resolve any dependency version published less\n than 3 days ago (`minimumReleaseAge` in `pnpm-workspace.yaml`). Compromised releases in\n recent supply-chain attacks were typically yanked within hours-to-days; the cooldown means\n a poisoned version ages out of the registry before it can enter our lockfile.\n - **Frozen lockfile in CI**: every pipeline job now installs with\n `pnpm install --frozen-lockfile`, so CI can never silently resolve packages that aren't in\n the committed, cooldown-vetted lockfile.\n - **Dependency floors** for transitive advisories in the dev tree: `dompurify >=3.4.0`\n (XSS bypasses; pinned older by monaco-editor), `lodash-es >=4.18.1` (`_.template` code\n injection; via chevrotain), and `uuid ^11.1.1` under exceljs (buffer-bounds advisory).\n - **Dropped `@xenova/transformers`** (dev) in favor of the already-present\n `@huggingface/transformers` for the Ask ADK embedder, reranker, and index builder. The\n abandoned v2 line dragged in `protobufjs ≤7.5.5` via `onnxruntime-web`, which carries a\n critical arbitrary-code-execution advisory plus seven others — all gone. Both the\n build-time index embedder and the browser query embedder migrated together (same runtime,\n same `q8` weights), so index and query vectors stay comparable.\n - **Trusted-publishing groundwork**: the npm deploy job now requests a GitLab OIDC\n `id_token` with the npm registry audience. Once the package's Trusted Publisher is\n configured on npmjs.com, the long-lived `NPM_TOKEN` CI secret — the artifact stolen in\n most registry-compromise incidents — can be deleted outright.\n - Net effect: consumer-facing prod tree remains at zero known vulnerabilities; the dev-tree\n audit drops from 27 advisories to 7 (all in the docs-site toolchain: vitepress's vite 5\n line and markdown-it, not reachable from any published code path).\n - Housekeeping from the lockfile rebuild: `@nhtio/eslint-config` is pinned to exactly\n `1.20260518.0` — its `1.20260609.0` successor ships stricter jsdoc rules that fail the\n current tree (~1,300 errors in `bin/` and the docs theme). Dev-only; upgrading the config\n is a separate chore with that cleanup attached.\n\n### Changed\n\n- **The Cloudflare Vectorize conformance suite is now opt-in and out of CI.** Vectorize's public\n endpoint is aggressively eventually-consistent — its query index flaps for seconds after a\n write or delete — and even with the conformance harness's retries the read-after-write race\n lost often enough to red-flag otherwise-green releases (it had been carried as an\n `allow_failure` job, which is just noise that trains you to ignore red). It now requires an\n explicit `TEST_VECTOR_CLOUDFLARE_ENABLED=1` opt-in on top of its credentials and skips\n otherwise. Run it by hand when you want to exercise the adapter against live Vectorize. The\n `cloudflare` adapter itself is unchanged and still shipped.\n\n### Fixed\n\n- **Vector adapter query-construction hardening** (from an internal security review; neither\n issue crossed a privilege or data boundary, both are belt-and-braces):\n - The Milvus adapter's `nearId` seed-vector lookup now serializes the id with\n `JSON.stringify` instead of raw template interpolation, matching the adapter's own\n delete path — an id containing a double quote can no longer alter the filter expression.\n - The Redis adapter's numeric range filters (`gt`/`gte`/`lt`/`lte`, and numeric `eq`/`ne`)\n now coerce the bound through `Number()` and throw\n `E_VECTOR_STORE_UNSUPPORTED_FILTER_OPERATOR` on non-finite results, so a non-numeric\n string can no longer break out of the RediSearch `[lo hi]` bracket and append query\n clauses. Numeric strings (`'2024'`) still work.\n\n## 2026-06-10\n\n### Added\n\n- **The Media Pipeline battery (`@nhtio/adk/batteries/media`)** — a knex-inspired local media\n pipeline: one declarative `MediaPlan` with three front-ends (a chainable thenable builder, a\n pipe-string DSL, and JSON ops) compiling identically, executed as an `@nhtio/middleware` onion\n over in-memory bytes. Most stacks process media by shipping bytes to an external API or\n flooding the context window; this is the third option — local processing, no external APIs by\n default, your data stays in your infrastructure unless an engine you composed says otherwise.\n Verbs cover documents (select/split/merge/reorder/redact/sanitize/normalize/update_text/diff/\n apply_patch/convert/extract assets), unified text extraction (`extract text` routes PDF, DOCX,\n XLSX, ODT/ODS/ODP, PPTX, plain text, and images through one verb, with OCR fallback for\n scanned input), chunking and metadata, ten `sheet.*` mutations (ExcelJS), eight `slides.*`\n mutations (JSZip OOXML surgery), fused `image.*` transforms (adjacent steps cost one\n decode/encode), and `audio.transcribe` (decode → 16 kHz mono resample → ASR).\n- **The pipe DSL** — the LLM-facing surface: `select pages=2-5 | redact match=/…/ | convert\n to=pdf`. Named args only, separator-insensitive verb folding, 1-based indices, bare-number-is-\n index/quoted-string-is-name targeting, quoted-JSON structured payloads, inline `@id` media\n refs, and two-layer model-actionable errors (position-bearing syntax errors plus semantic\n did-you-mean narrowed to the deployment's configured engines, every message ending in a\n corrective exemplar). Round-trip is fixed-point and pipe/ops forms produce identical plans.\n- **Engines as self-declaring capability providers** (`@nhtio/adk/batteries/media/contracts` +\n one subpath per implementation): a `MediaEngine` is `{ id, converts?, mutates? }` — exactly\n two capability shapes, because a media engine only ever changes the format or changes the\n content. `ConvertCapability` declares uniform from×to blocks over MIME patterns and format\n tokens (OCR is `image/*`→txt, transcription is `pcm`→txt/srt/vtt/json, audio decoding is\n `audio/*`→pcm, PDF embedded-image extraction is `pdf`→images multi-output); a new capability\n is a new edge in the data, never a new contract. Engines are supplied as a **flat ordered\n array** (`engines: [resolver, …]`) resolved eagerly at construction — declarations drive\n verb narrowing; heavy peers still lazy-load inside capability methods. Dispatch is one rule\n everywhere: capability filter, then an optional `selection` middleware onion (stages may\n exclude or reorder candidates, never add — the seam for content-dependent quality rules like\n routing complex workbooks past a pure-JS converter to LibreOffice), then array order among\n survivors. Convert computes shortest multi-hop paths (up to three hops) through the declared\n format graph when no direct edge exists, with lossy/virtual tokens (txt, json, srt, `pcm`,\n `images`) as endpoints, never intermediates. `ConvertRequest.options` is a typed,\n consumer-augmentable `ConvertOptions` interface (declaration merging against the contracts\n subpath). Bundled: `engines/jimp` (cross-env image mutate), `engines/sharp` (Node mutate\n incl. webp/avif + `fromSharp` BYO adapter), `engines/tesseract_js` (cross-env OCR convert;\n languages required), `engines/audio_decode` (cross-env audio→pcm, no ffmpeg),\n `engines/transformers_asr` (cross-env Whisper pcm→text; model id required — no silent\n multi-hundred-MB downloads), and `engines/soffice` (the LibreOffice convert matrix, which\n now also covers ODS/legacy-xls→xlsx — sheet normalization is just a conversion edge, not a\n separate engine). Binary-backed engines compose two further BYO contracts: `BinaryExecutor`\n (bundled `engines/execa_executor`) and `ScratchWorkspace` (bundled `engines/fs_workspace`;\n explicit root, no `os.tmpdir()` default) — process execution and filesystem access are\n movable seams, not Node assumptions. The registry is exported (`buildEngineRegistry`) for\n standalone dispatch.\n- **A battery-scoped ESLint plugin for the media pipeline**\n (`@nhtio/adk/batteries/media/lint`, namespace `adk-media`) — battery-specific contracts ship\n with the battery, not the core `@nhtio/adk/eslint` plugin. Three rules:\n `adk-media/prefer-engine-resolver` (static value imports of bundled engine subpaths — the\n canonical supply form is the dynamic-import resolver; type-only imports pass),\n `adk-media/no-shadowed-engine` (an engine whose statically-known capabilities are fully\n covered by an earlier engine in the array is dead code under first-capable-wins dispatch),\n and `adk-media/augment-contracts-module` (`ConvertOptions` declaration merging that targets\n any module other than `batteries/media/contracts` silently never merges).\n- **Forged agent tools** (`@nhtio/adk/batteries/media/forge`): `forgeMediaTools(mp, { surface })`\n mints either the composite surface (one `media_query` tool taking `{ media_id, q | ops }`,\n its description embedding the engine-narrowed grammar with toPipe-generated examples, plus\n `list_media`) or the granular surface (one tool per available verb). Outputs persist via\n `ctx.storeMediaBytes` and return first-party `Media`; processing and DSL failures render as\n readable `Error (CODE): …` strings the model can repair from. An optional `gate?: ToolGateFn`\n runs before every execution — the human-approval/RBAC seam built on `ctx.waitFor`.\n- **Inline media id-markers in every LLM battery.** Rendered media (attachments and tool\n results) is now preceded by a harness-authored `[media id: | ]` text block so\n models can reference media by id in tool calls without a discovery round-trip. The marker is\n structural reference data from the harness-controlled `Media.id` — no authority, fixed\n phrasing, outside the untrusted envelope. OpenAI is the reference implementation (WebLLM\n inherits); Ollama emits the same shape on its text channel.\n- **Gate seam retrofit for SearXNG and Scrapper.** Both factory batteries now accept the same\n optional `gate?: ToolGateFn`, run before the HTTP request — network side effects deserve the\n approval seam too. Additive and backward-compatible.\n- New optional peer dependencies (pulled only by the engine/parser that needs them): `moo`,\n `pdf-lib`, `pdf-parse`, `mammoth`, `exceljs`, `jszip`, `jimp`, `sharp`, `audio-decode`,\n `@huggingface/transformers`, `tesseract.js`, `execa`.\n\n### Fixed\n\n- **API documentation gaps closed.** Several types referenced by public API surfaces were not\n themselves exported, so their doc pages didn't exist and links to them dangled:\n `EngineSummary` (referenced by the media lint plugin's `BUNDLED_SUMMARIES`), `ChainExecutor`\n (the media chain's executor seam), and `AudioDecodeFn`/`AudioBufferLike` (the audio-decode\n engine's override surface) are now exported and documented. The web-retrieval docs' links to\n `RawRetrievable` now point at `@nhtio/adk/common`, where the type actually lives, and\n `ScrapperBaseConfig` is re-exported from the scrapper barrel. Cosmetic prose fixes in the\n media docs ride along. No runtime behavior changes.\n\n## 2026-06-09\n\n### Fixed\n\n- **OpenAI Chat Completions battery now accepts `reasoning_effort: 'none'`.** The request\n validator constrained `reasoning_effort` to `['minimal', 'low', 'medium', 'high']` and rejects\n unknown top-level keys (`.unknown(false)`), so there was no way to send `none` — the documented\n value Ollama's OpenAI-compatible `/v1/chat/completions` needs to turn a thinking model's (e.g.\n Gemma's) reasoning **off**. `'none'` is now in the enum (and the `reasoning_effort` type union);\n it flows to the wire through the existing body-assembly passthrough, and the strict-unknown-key\n protection is unchanged. The WebLLM battery is unaffected — upstream WebLLM has no\n `reasoning_effort` field and disables thinking via `extra_body.enable_thinking`, already an open\n passthrough there.\n\n- **OpenAI Chat Completions battery now retries transport failures (HTTP status 0).** When `fetch`\n rejected before any HTTP response arrived (DNS failure, connection refused, TLS error, socket\n drop), the adapter immediately `nack`'d with status 0 **without consulting `retry.maxAttempts`** —\n so a single transient network blip killed the turn even when retries were configured. The\n transport-failure branch now retries with backoff up to `maxAttempts` before surfacing the error,\n matching the request-timeout branch beside it and the sibling embeddings adapter. Governed by the\n existing `retry.maxAttempts` knob; `retriableStatuses` is untouched (it gates HTTP responses,\n which transport errors never produce).\n\n- **Bundled deterministic tools now do exactly what their descriptions say.** A correctness audit\n of the 17 deterministic tool batteries (`src/batteries/tools/*`) — driven by a schema-fuzzing\n invariant harness and two independent model reviews, with every finding verified against the\n running tool — surfaced a class of defects where a tool would throw an unexpected runtime error,\n refuse work it advertised, or silently return a wrong value. All are fixed; each tool was changed\n to meet its label (no description or test was weakened to match broken behaviour):\n - **`json_transform`** — `top_n` returned the wrong end of the range (comparator inverted; `desc`\n now returns the largest *n*, `asc` the smallest); `unique_by` never deduplicated object/array\n key values (reference-identity `Set` → now value-serialised); `sum` over a non-numeric array\n silently returned `0` (now a clear error); a `null` operation entry crashed the dispatch (now a\n clean schema rejection).\n - **`compare_records`** — a nested array and an integer-keyed object (`[1,2]` vs `{\"0\":1,\"1\":2}`)\n were reported equal; they are now distinct.\n - **`color_contrast` / `color_scheme` / `color_adjust`** — `hexToRgb` accepted hex strings with\n trailing non-hex characters (`#1Z2Z3Z` → silent `rgb(1,2,3)`); invalid hex is now rejected.\n - **`string_transform`** — `reverse` split astral characters/emoji into broken surrogate halves\n (`A💥B` now reverses to `B💥A`); `slug` destroyed non-decomposing Latin-1 letters (`føtex` →\n `f-tex`), now transliterated (`fotex`).\n - **`parse_yaml`** — an empty/whitespace/BOM-only document returned a non-string (`undefined`),\n now `null`; `.NaN` / `.inf` / `-.inf` were silently corrupted to `null`, now preserved.\n - **`format_table`** — null/primitive rows threw; they now render empty cells or return a clear\n \"provide columns\" error.\n - **`format_list`** — an unbounded `indent` threw `RangeError`; it is now clamped to 100.\n - **`evaluate_katex`** — scientific notation (`2e3`) misparsed, and `\\log_b(x)` change-of-base\n produced malformed output; both now evaluate correctly.\n - **`encode_text`** — HTML-entity decoding of astral code points used `String.fromCharCode`\n (truncating to 16 bits); `🎉` / `🎉` now decode to 🎉 via `String.fromCodePoint`.\n - **`date_period`** — fiscal-quarter boundaries spanning the calendar-year boundary were computed\n in the wrong year (e.g. FY-Feb, `2024-01-15` → now correctly `2023-11-01`).\n - **`convert_unit`** — temperatures below absolute zero are now rejected instead of silently\n returned.\n - **`calculate`** — a non-finite scalar result (`1/0`, `2^5000`) now returns a clear error rather\n than printing `Result: Infinity`.\n\n- **Updated three stale functional tests to the corrected `stats_describe` contract.** The\n `statistics`/`flydrive` through-runner tests still passed `stats_describe`'s `numbers` as a JSON\n **string** and asserted numeric `mean`/`sum` — both invalidated by the tool-correctness pass above,\n which retyped `numbers` to a real array (restoring NaN/∞/`>2^53` rejection) and emits computed\n aggregates as precision-formatted BigNumber **strings**. The tests now pass actual arrays and\n assert the string-valued aggregates; no production behaviour changed.\n\n### Added\n\n- **Scrapper web-extraction tool battery (`@nhtio/adk/batteries/tools/scrapper`).** Tools for any\n [Scrapper](https://github.com/amerkurev/scrapper) instance — a headless-browser service that gives\n an agent browser-grade page reading (JS-rendered pages a plain fetch can't see) as a **stateless**\n HTTP call: fresh incognito context per request, no stored session/cookies/credentials. Two verbs,\n each with an async factory (accepts a dynamic-import `artifact` resolver) and a sync variant:\n `createScrapperArticleTool`/`…Sync` (`/api/article`) and `createScrapperLinksTool`/`…Sync`\n (`/api/links`). Like the SearXNG battery these are factories (not constants) and must not be\n bulk-registered via `Object.values(batteries)`.\n - **Per-parameter disposition** — for every modeled knob the factory chooses: `fixed` (pinned;\n sent always, removed from the model schema), `defaults` (model-overridable), or open\n (model-settable). `url` is always required; `fixedQuery` is a raw kebab passthrough for\n un-modeled params, keeping the battery generic across instances/versions.\n - **Two distinct header channels** — `config.headers` (static or sync/async resolver) authenticates\n to the Scrapper *instance*; the `extra_http_headers` *param* (`'K:v;K2:v2'`) is what the scraper's\n browser sends to the *target site*.\n - Same SearXNG-style two-level output (`resultFormat` normalized/raw/either), `artifact` resolver,\n and input/output middleware pipelines (`shortCircuit`, fresh runner per call). Errors degrade to\n `Error:` strings (parses Scrapper's `{detail:[{msg}]}`; missing `url` → HTTP 422); bad config →\n `E_INVALID_SCRAPPER_CONFIG`. Documented as a featured-battery page with TSDoc `@warning`s for the\n `scroll_down`-needs-`sleep` and instance-relative-URI gotchas. Cross-env unit spec (stubbed\n `fetch`, disposition, resolver, all-three-artifact round-trips) + env-gated live integration spec\n (`TEST_SCRAPPER_URL` / `TEST_SCRAPPER_HEADERS`).\n\n- **Web-retrieval RAG glue (`@nhtio/adk/batteries/tools/web_retrieval`).** The shared seam from\n search/scrape results to turn `Retrievable`s, used by both the Scrapper and SearXNG batteries.\n Pure converters — `searxngResultsToRetrievables`, `scrapperArticleToRetrievable`,\n `scrapperLinksToRetrievables` — return plain `RawRetrievable[]` (zero core-class instantiation;\n core referenced as `import type` only). `storeRetrievables(ctx, raws, { retrievable })` constructs\n and stores records via a **resolver-injected** `Retrievable` constructor (ctor / sync / async /\n dynamic-import), so the module never value-imports core. Long page text becomes a reader-backed\n `SpooledArtifact` via a caller `spool` hook (the converter recommends an open\n `ArtifactConstructorResolver` for the content — markdown/json/text — so a consumer's own subclass\n works unchanged; no chunker). Web content defaults to `trustTier: 'third-party-public'` (a\n constant, not URL inference — CONTRIBUTING DD#12).\n\n- **Shared tool-battery helpers (`@nhtio/adk/batteries/tools/_shared`).** Internal building blocks\n for the configured-HTTP tool batteries: `resolveArtifact`/`resolveArtifactSync` (resolver → sync\n `() => Ctor`), the onion middleware-pipeline runners (fresh runner per call, short-circuit +\n non-terminal detection), header resolution, and the `ArtifactResolver`/`SyncArtifactResolver`\n types. SearXNG and Scrapper both build on it instead of carrying copies.\n\n- **SearXNG search tool battery (`@nhtio/adk/batteries/tools/searxng`).** A web-search tool for any\n [SearXNG](https://docs.searxng.org/dev/search_api.html) instance, exposed via **factories** —\n async `createSearxngSearchTool(config)` and sync `createSearxngSearchToolSync(config)` — rather\n than a ready-made constant. It is the first factory-style tool battery: a search tool has to know\n *which* instance to query and is usually behind custom authentication, so it needs per-deployment\n config that cannot be baked in at module load. Because it exports factories (not a `Tool`), they\n must not be bulk-registered via `Object.values(batteries)` — call a factory first, then register\n the returned tool.\n - **Custom-header auth** — `config.headers` accepts a static `Record` or a\n sync/async resolver (`() => headers | Promise`); the resolver runs on every search, so\n refreshable bearer tokens work. Caller headers override the default `Accept`/`User-Agent`.\n - **Two-level output-format control** — `config.resultFormat: 'normalized' | 'raw' | 'either'`\n (default `'either'`). Pinning it forces the shape AND removes the model-facing `format` arg from\n the schema; leaving it neutral lets the model choose per call. `normalized` trims each result to\n `{title,url,content,engine,score,publishedDate}` plus non-empty `answers`/`infoboxes`/\n `suggestions`/`corrections`; `raw` returns the full SearXNG JSON.\n - **Input/output middleware pipelines** — `config.inputPipeline` / `config.outputPipeline` are\n onion middleware `(ctx, next)` built on `@nhtio/middleware`. Input stages mutate the\n query/params/headers before the request or `ctx.shortCircuit(string)` to skip the fetch (cache\n hit); output stages filter/re-rank `ctx.results`, mutate `ctx.raw`, or set `ctx.output` verbatim\n (e.g. rendered markdown). A `ctx.stash` Map carries across both; a fresh runner is minted per\n invocation (middleware runners are single-use).\n - **Configurable spool artifact (resolver)** — `config.artifact` (default `() => SpooledJsonArtifact`)\n is an open `ArtifactConstructorResolver`: a ctor, a sync resolver, or — via the async factory —\n an async/dynamic-import resolver (`() => import('@nhtio/adk/spooled_artifact').then(m => m.SpooledMarkdownArtifact)`),\n so a consumer's own `SpooledArtifact` subclass works with no battery change. The async factory\n resolves it before building the `Tool` (whose `artifactConstructor` must be sync); the sync\n factory accepts only the sync subset.\n - **Graceful failures** — a disabled-JSON instance (SearXNG disables JSON by default → HTTP 403),\n network errors, timeouts, and thrown pipeline stages all return `Error:` strings the model can\n react to; only malformed args throw (`E_INVALID_TOOL_ARGS`). Invalid config throws the\n battery-scoped `E_INVALID_SEARXNG_CONFIG` at factory-call time.\n - Documented as a featured-battery page, with a TypeDoc `@warning` recording the upstream quirk\n that SearXNG's `number_of_results` is frequently `0` even when results exist\n ([searxng#2987](https://github.com/searxng/searxng/issues/2987),\n [searxng#2457](https://github.com/searxng/searxng/issues/2457)) — the tool passes it through\n verbatim; use `results.length`. Covered by a cross-env unit spec (stubbed `fetch`, all three\n artifact types round-tripped) and an env-gated live integration spec\n (`TEST_SEARXNG_URL` / `TEST_SEARXNG_HEADERS`).\n\n- **Documentation-coverage gate (`bin/doc_coverage.ts`, `pnpm run doc:coverage`).** A standalone\n helper that bootstraps TypeDoc read-only over the same entrypoints the published docs use\n (`bin/utils/index.ts` `getEntries`) and reports every public API symbol missing a TSDoc comment,\n grouped by its deepest `@module` submodule. Modes: a human report (default), `--json`, `--ci`\n (non-zero exit when any non-allowlisted symbol is undocumented — wired into CI as a job, currently\n `allow_failure: true`), `--hook` (emits a Claude Code `additionalContext` envelope and always exits\n 0), and `--primary` (audits `@primaryExport` placement). The shared `blockTags` list moved to an\n exported `BLOCK_TAGS` const so the helper and `makeApiDocs` never drift. **The entire public API\n surface is now documented — the gate reports zero undocumented symbols.** Every interface,\n type, class member, options field, wire shape, and exported function across the LLM, vector,\n embeddings, storage, and ESLint-rule batteries carries an accurate TSDoc comment.\n\n The API-doc build is also link-clean: every TypeDoc cross-reference now resolves. Types that\n documented symbols referenced but that were not themselves exported are now public —\n `ArtifactConstructorResolver` (`@nhtio/adk/forge`), the four `DispatchRetrievable*Fn` callback\n types (`@nhtio/adk/types`), and the pgvector / sqlite-vec adapter options interfaces, renamed for\n consistency with the other 24 adapters to `PgVectorStoreOptions` and\n `SqliteVecVectorStoreOptions`. Vendor types referenced in comments (`BigNumber`, `Set`, `Disk`)\n now link to their upstream docs via `externalSymbolLinkMappings`, and broken `{@link}` targets\n (wrong or non-exported names) were corrected. The internal, sentinel-gated `DispatchRunner`\n constructor is marked `@internal` (construct via the static `DispatchRunner.dispatch`).\n\n- **Native Ollama LLM battery (`@nhtio/adk/batteries/llm/ollama`).** Ships `OllamaAdapter`, an\n executor targeting Ollama's **native `/api/chat`** endpoint — distinct from pointing the OpenAI\n Chat Completions battery at `/v1`, which it complements rather than replaces. Works with both\n local Ollama (`http://localhost:11434`, no auth — the default `baseURL`) and cloud Ollama\n (`https://ollama.com`, `apiKey` → `Authorization: Bearer`); only `baseURL` plus the auth header\n differ. Native-only capabilities the `/v1` compat layer cannot express are first-class: per-request\n context size via the nested `options.num_ctx`, native reasoning via `think`\n (`boolean | 'low' | 'medium' | 'high'`) surfaced as `message.thinking`, structured output via\n `format` (`'json'` or a JSON schema), and model lifecycle via `keep_alive`. Generation params live\n in a nested `options` block (not at the top level, unlike the OpenAI wire). The adapter parses\n NDJSON streaming (terminated by `done: true`, no `[DONE]` sentinel), takes tool-call `arguments` as\n a JSON object (no `JSON.parse`), labels tool-result history messages with `tool_name` (not\n `tool_call_id`), and follows every cross-battery design rule (trust-framed envelopes, per-tool\n trust, swappable helpers, `ctx.stash.ollama` per-iteration overrides, `ToolCall.inline` handling,\n trust-tier-distinct buckets). Native `/api/chat` carries images only; other modalities route\n through `unsupportedMediaPolicy`. `tool_choice` is intentionally unsupported (native `/api/chat`\n has no such field). Ollama is HTTP-only — Unix-socket deployments are reached via a bridge or a\n custom `fetch`.\n\n- **Dedicated generation-stats observability channel on `DispatchRunner`.** Executors can emit\n provider-agnostic generation accounting (token counts, nanosecond durations, finish reason, model,\n provider, plus the raw provider object) via a new `helpers.reportGenerationStats(stats)` method;\n the runner enriches each record with `dispatchId` / `iteration` / `emittedAt` and fires it on a new\n `generationStats` observability hook (subscribe through `observers.generationStats`). This is\n additive and non-breaking — `DispatchExecutorHelpers` is runner-produced, so existing executors\n gain the method without change. The native Ollama battery emits its terminal-chunk stats through\n this channel; the new `GenerationStats` / `GenerationStatsEvent` types are exported from\n `@nhtio/adk/dispatch_runner`.\n\n- **Shared Chat-family helper submodule.** The wire-shape-agnostic translation helpers (trust\n envelopes, memory/retrievable/standing-instruction rendering, system-prompt assembly, JSON-schema\n and function-tool conversion, thought filtering) were extracted to an internal\n `src/batteries/llm/chat_common` module shared by the OpenAI Chat Completions and native Ollama\n batteries. Behaviour-preserving: every existing `@nhtio/adk/batteries/llm/openai_chat_completions`\n helper export keeps its name and value identity (the battery re-exports the shared names), and the\n WebLLM battery is untouched. The shared module is internal — not a public package subpath.\n\n- **NDJSON cassette support in the cross-env test harness.** `tests/_fixtures/cassette.ts` gained an\n `ndjson` response mode (parallel to the existing SSE `sse` mode) plus Ollama-native programmatic\n builders (`buildOllamaChatResponse`, `buildOllamaStreamFrames`, `singleOllamaResponseCassette`,\n `singleOllamaStreamCassette`) for deterministic native-wire replay.\n\n- **Arbitrary-precision numeric handling across the math tools.** A shared\n `src/lib/helpers/bignum.ts` (a BigNumber-configured `mathjs` instance) backs the numeric\n batteries so float64 limitations no longer corrupt results: large in-range sums stay exact\n instead of overflowing to `Infinity`, tiny ratios don't underflow to `0`, and precision is\n preserved end-to-end (`sum([0.1, 0.2]) → 0.3`). `statistics`, `data_structure`, and\n `unit_conversion` now compute aggregates/conversions through it. The `statistics` tools take\n typed number arrays (`validator.array().items(validator.number())`) instead of JSON strings —\n restoring schema rejection of `NaN`/`Infinity`/`> 2^53` at the boundary and removing the prior\n silent-drop behaviour. Tools that format numeric output gained an optional `precision` argument\n (significant digits, default 8). **This changes those tool signatures and some output shapes**\n (computed aggregates may be precision-formatted strings).\n\n- **Tool correctness test infrastructure.** A `callTool` helper in\n `tests/_fixtures/tool_ctx_stub.ts` captures a tool invocation's resolve-vs-throw outcome as a\n value (making the no-crash contract directly assertable), and a new\n `tests/unit/batteries/tools/fuzz.node.spec.ts` invariant harness introspects every bundled tool's\n schema, feeds adversarial input, and asserts each call either resolves to a string/`Uint8Array`\n or rejects with `E_INVALID_TOOL_ARGS` — never any other throw.\n\n## 2026-06-07\n\n### Added\n\n- **SoDK — a mental-model doc that teaches the loop in human terms.** A new page,\n `docs/sodk.md` (\"Society Development Kit\"), retells [How agents work](https://adk.nht.io/how-agents-work)\n and [What ADK is](https://adk.nht.io/what-adk-is) with exactly one noun swapped: where ADK says\n *model*, SoDK says *person*. It is a teaching device for the reader who can't yet see why an agent\n is the loop, not the LLM — role↔agent, task↔turn, briefing↔context, request↔tool, process↔middleware,\n \"say where things get filed\"↔the required storage callbacks. The human-facing prose plays it\n straight; the `` block names the metaphor outright and carries the full 1:1 map, so an\n agent answering a question can explain a concept *through* the framing or translate either way. Wired\n into the sidebar and home listing, and cross-linked from both source docs. Docs only — no code, types,\n or package surface change.\n\n- **Importable ESLint plugin (`@nhtio/adk/eslint`).** The harness's documented contracts are now\n machine-checkable: a flat-config plugin that flags footguns the TypeScript compiler cannot see\n because they live in runtime validators or conventions, not types. Five rules ship —\n `require-validator-any-required` (a `validator.any()` chain with no explicit\n `.required()`/`.optional()`/`.default()`/`.forbidden()` silently admits null/undefined),\n `thought-payload-requires-replay-tag` (a `Thought` with a vendor `payload` but no\n `replayCompatibility` can never be safely replayed), `token-encoding-requires-context-window` (a\n Chat Completions adapter that counts tokens with no budget never runs its overflow guard),\n `artifact-tool-forbids-artifact-constructor` (an `ArtifactTool` that wraps another artifact\n recurses forever), and `no-model-in-tool-handler` (a model call inside a tool handler hides an\n unmanaged dispatch — unless the handler runs its own scoped sub-agent via `new TurnRunner(...)` or\n `DispatchRunner.dispatch(...)`). Import the assembled plugin\n from `@nhtio/adk/eslint` (or `adk.configs.recommended` for all five), or individual rules from\n `@nhtio/adk/eslint/rules/`. `eslint` and `@typescript-eslint/utils` are **optional peers** —\n installed only by consumers who lint with the plugin. Rules are report-only with inline\n `eslint-disable` carve-outs. See the new **Developer Tools** docs section, which also now houses\n the ADK Assembly MCP guide.\n\n- **Vector conformance harness is now public (`@nhtio/adk/batteries/vector/conformance`).** The\n `runVectorStoreConformance` suite (plus `stubEncoder` / `paddedStubEncoder`) that the 29 shipped\n adapters test against is now an exported, deep-import-only subpath, so anyone writing their own\n adapter can prove it against the exact same contract. The subpath imports `vitest`, declared as an\n **optional peer** (`peerDependenciesMeta`) — install it to run the suite; it is never pulled in by\n the `@nhtio/adk/batteries/vector` barrel, so a `createVectorStore` consumer takes on no test-runner\n dependency. See `docs/batteries/vector/custom-adapter.md`.\n\n- **Query-builder grouping callbacks — mix AND and OR.** The `VectorQueryBuilder` filter methods\n (`.where` / `.andWhere` / `.orWhere` / `.whereNot` / new `.orWhereNot`) now accept a callback that\n receives a filter-only `FilterBuilder`, so you can express `A AND (B OR C)` and negated groups\n (`{ not: }`) at any nesting depth — previously the builder could only emit flat DNF. The\n scalar forms are unchanged (`.whereNot('f', v)` is still `→ ne`). Groups compile to the neutral\n `FilterGroup` tree; the 6 native filter translators recurse over it and the over-fetch adapters\n JS-evaluate it. **Chroma** rejects a `not` group with `E_VECTOR_STORE_UNSUPPORTED_FILTER_OPERATOR`\n (consistent with its existing `exists`/`contains` limits); nested AND/OR works on all 29. See\n `docs/batteries/vector/query-builder.md`.\n\n### Fixed\n\n- **`.orWhere()` no longer silently drops its branch.** `where(A).where(B).orWhere(C)` previously\n compiled to `(A AND B) OR (A AND B AND C)`, which collapses to just `(A AND B)` — the `.orWhere(C)`\n was a no-op. It now correctly yields `(A AND B) OR C`, matching the documented knex semantics.\n\n- **Chroma multi-row filter-scan.** A filter-scan (no `.near*()`) that matched more than one record\n returned only the first row: the adapter unwrapped `query()`'s nested result arrays on the `get()`\n path too. Fixed to unwrap only on the similarity path.\n\n## 2026-06-06\n\n### Added\n\n- **Cloudflare Vectorize adapter (`@nhtio/adk/batteries/vector/cloudflare`).** Managed, serverless\n vector store over the Vectorize **V2 REST API** — pure `fetch`, no driver/peer dependency. A\n logical collection maps to a Vectorize index (`indexNamePrefix` isolates per use). Upserts use\n the NDJSON multipart endpoint (field `vectors`); query/get/delete use JSON. Dimensions must be\n **32–1536**. KNN `score` is recomputed locally from the returned values to the `[0,1]` contract;\n the document rides in a reserved `__document` metadata key. Native metadata filtering needs\n pre-created metadata indexes and lacks `$and`/`$or`, so the adapter **over-fetches (topK 50, the\n service cap when returning values/metadata) and JS-filters** via the neutral `evaluateFilter`\n for full cross-adapter parity. Cloudflare Vectorize is **aggressively eventually-consistent** —\n a fresh index takes ~8–34s before its first write is queryable and the query index flaps for\n seconds after writes/deletes; the adapter settle-polls the query index for stability, and the\n integration spec additionally uses **vitest `retry`** to ride out the flap deterministically\n (slow, ~8 min, but green). Managed, so no docker/CI matrix entry (like Pinecone / S3 Vectors).\n Verified 7/7 conformance against live Cloudflare Vectorize. This also adds an optional\n `retry`/`timeout` parameter to the shared `runVectorStoreConformance` harness (defaults preserve\n existing behavior).\n\n- **Oracle 23ai AI Vector Search adapter (`@nhtio/adk/batteries/vector/oracle23ai`).** Each\n collection is a table with a native `VECTOR(dims, FLOAT32)` column; vectors are bound/read as\n `Float32Array` via the `oracledb` driver in **thin mode** (no Instant Client). KNN uses\n `VECTOR_DISTANCE(vec, :q, COSINE|EUCLIDEAN|DOT) ORDER BY … FETCH APPROX FIRST k ROWS ONLY`; the\n raw distance only orders candidates — the `[0,1]` score is recomputed locally from the stored\n vector. Metadata is a JSON-string CLOB (read via `fetchInfo` STRING) filtered with the neutral\n `evaluateFilter`; identifiers are double-quoted and `tablePrefix` isolates collections. Strongly\n consistent (commit per write). NB: VECTOR columns are rejected in the SYSTEM tablespace — the\n connecting user must default to a normal tablespace (e.g. USERS) and have CREATE TABLE; the\n docker `oracle` profile provisions such a user via `APP_USER`. Verified 7/7 conformance ×3\n against a live Oracle Free 23ai. Closes the Oracle 23ai gap in the Open WebUI minimum-support set.\n\n- **AWS S3 Vectors adapter (`@nhtio/adk/batteries/vector/s3vectors`).** Managed, serverless vector\n store (no container, like Pinecone). The vector bucket is provisioned out-of-band; a logical\n collection maps to an **index** inside the bucket (`indexPrefix` isolates per use — index names\n must be 3–63 chars). KNN via `QueryVectors` (the returned `distance` is converted to the\n battery's normalized `[0,1]` score — cosine `sim = 1 - distance`); `PutVectors`/`GetVectors`/\n `DeleteVectors` for upsert/fetch/delete by key; metadata is native JSON with the document under a\n reserved `__document` key. `topK` is capped at the service max of **100**, so filtered/scan reads\n over-fetch to that ceiling and JS-filter via the neutral `evaluateFilter` for cross-adapter\n parity; eventual-consistency settle-polling makes read-after-write deterministic. Metrics:\n `cosine`/`euclidean` (S3 Vectors has no dot-product — `dot` throws at createCollection). Driver:\n `@aws-sdk/client-s3vectors` (lazy; credentials from the ambient AWS chain). Verified 7/7\n conformance ×3 against a live bucket in eu-west-1. Closes the S3 Vector Bucket gap in the Open\n WebUI minimum-support set.\n\n- **Elasticsearch 8 vector adapter (`@nhtio/adk/batteries/vector/elasticsearch`).** A dedicated\n adapter for the Elasticsearch 8 dialect — each collection is an index with a `dense_vector`\n field, and KNN uses ES8's **top-level `knn` search clause** with an optional `filter`. This is\n distinct from the existing `opensearch` adapter, which speaks OpenSearch's `knn_vector` /\n `query.knn` dialect (an ES client cannot drive it). The neutral filter tree compiles to ES\n bool/term/range over `metadata.*` (`.keyword` for strings) via the exported\n `translateElasticsearchFilter`; writes use `bulk({ refresh: true })` for strong consistency;\n cosine `_score` (already `(sim+1)/2 ∈ [0,1]`) is normalized defensively. Driver:\n `@elastic/elasticsearch` (lazy; use the **v8** client against an 8.x server — a v9 client sends a\n compatibility header an 8.x server rejects). BYO client supported via\n `connection.client`. Verified 7/7 conformance ×3 against a live Elasticsearch 8.18.\n\n- **Vespa vector adapter (`@nhtio/adk/batteries/vector/vespa`).** Vespa has no runtime\n collection creation — a collection is a *document type* declared in a deployed **application\n package**. The adapter holds the package state in memory and rebuilds + redeploys it (via a\n dependency-free, store-only ZIP writer — no zip lib needed) to the config server's\n `prepareandactivate` endpoint on each `createCollection`/`dropCollection`, generating\n `services.xml`, `hosts.xml`, a `validation-overrides.xml` (≤30-day window, for schema-removal /\n type-change), and a `schemas/.sd` per collection with an HNSW tensor field. KNN uses\n a YQL `nearestNeighbor` query with a `closeness` rank profile; filter-scan/delete use YQL +\n document-API; scores are re-computed locally from the stored vector via `normalizeScore` for the\n [0,1] contract guarantee (metric maps cosine→angular, dot→dotproduct, euclidean→euclidean). No\n npm driver — pure HTTP/`fetch`. Metadata is a JSON string field filtered with the neutral\n evaluator. Verified 7/7 conformance ×3 against a live Vespa.\n\n- **Couchbase vector adapter (`@nhtio/adk/batteries/vector/couchbase`).** Enterprise Edition only —\n vector search is an EE feature; Community throws \"vector typed fields not supported\". A logical\n collection maps to a Couchbase scope.collection. KV operations (upsert/get/remove) are strongly\n consistent and serve point reads; the scoped FTS vector index is async, so it is settle-polled\n after writes and used **only** to retrieve the KNN candidate id set — scores are then\n re-computed locally from the stored vector via `normalizeScore`, guaranteeing the [0,1] contract\n regardless of the backend metric (cosine/dot_product/l2_norm). Filter-scan, enumerate and\n delete-by-filter use N1QL with `RequestPlus` for strong reads. `collectionPrefix` isolates\n collections (avoids per-test FTS-index rebuild churn). Metadata is a JSON string field filtered\n with the neutral evaluator. Driver: `couchbase`. Cluster/bucket are provisioned non-interactively\n (REST `clusterInit` + bucket create — see the docker-compose `couchbase` profile's init sidecar);\n the adapter manages scopes/collections + the FTS vector index. Omitted from the CI matrix (its\n two-step init can't be expressed as a single service alias); verified 7/7 conformance ×3 against\n a live Couchbase EE 8.0.\n\n## 2026-06-05\n\n### Added\n\n- **MongoDB Atlas Vector Search adapter (`@nhtio/adk/batteries/vector/mongodb`).** Each collection\n is a MongoDB collection with an Atlas `vectorSearch` index on `vec`; KNN uses the `$vectorSearch`\n aggregation stage (cosine `vectorSearchScore`, [0,1]). Because the Atlas vector *index* updates\n asynchronously (~1s) while the document store is strongly consistent, filter-scans / fetch-by-id\n / delete read-back use a plain `find()` (immediate) and only KNN goes through `$vectorSearch` —\n with a post-write settle polling until the inserted ids are index-visible. `collectionPrefix`\n isolates collections (avoids per-test index rebuild churn). Metadata is a JSON string field\n filtered with the neutral evaluator. Driver: `mongodb`; works against `mongodb/mongodb-atlas-local`\n or a real Atlas cluster. Verified 7/7 conformance against a live atlas-local.\n\n- **Apache Solr vector adapter (`@nhtio/adk/batteries/vector/solr`).** Dense-vector / kNN query\n parser (Solr 9+): a collection maps to a Solr core, the adapter ensures a `DenseVectorField`\n (`vec`) + `document`/`metadata` fields in the core schema, and searches with\n `{!knn f=vec topK=N}[…]` (cosine score already [0,1]). Metadata is a JSON string field filtered\n with the neutral filter tree's JS reference evaluator. No driver dependency — plain HTTP/JSON via\n `fetch`. The target core must already exist (`solr-precreate `); the adapter manages its\n schema, not the core. Verified 7/7 conformance against a live Solr 9.\n\n- **HNSWLib vector adapter (`@nhtio/adk/batteries/vector/hnswlib`).** Embedded, in-process (no\n server). Wraps the `hnswlib-node` native ANN index for KNN, paired with a JS sidecar that owns\n id↔label mapping and the document/metadata records (hnswlib stores vectors only); metadata\n filtering, filter-scans, projection, and delete are served from the sidecar via the neutral\n filter tree's JS reference evaluator. Native build must be approved (pnpm-workspace.yaml\n `allowBuilds`). Verified 7/7 conformance in-process.\n\n- **ArangoDB vector adapter (`@nhtio/adk/batteries/vector/arangodb`).** Each collection is an\n ArangoDB document collection keyed by `_key`; KNN uses the exact AQL `COSINE_SIMILARITY` /\n `L2_DISTANCE` functions (no index required, always correct), with the experimental IVF\n `vector` index created lazily on first upsert for production-scale ANN. Metadata in a JSON\n string attribute filtered with the neutral filter tree's JS reference evaluator. Driver:\n `arangojs`. Verified 7/7 conformance against a live ArangoDB 3.12 backend.\n\n- **Neo4j vector adapter (`@nhtio/adk/batteries/vector/neo4j`).** Native vector index (5.13+):\n each collection is a node label with a `VECTOR INDEX` on `vec`; KNN via\n `db.index.vector.queryNodes` (cosine score already [0,1]). Metadata is a JSON string property\n filtered with the neutral filter tree's JS reference evaluator. Upsert via `MERGE`; integer\n params wrapped with `neo4j.int()`. Driver: `neo4j-driver`. Verified 7/7 conformance against a\n live Neo4j 5 backend.\n\n- **SurrealDB vector adapter (`@nhtio/adk/batteries/vector/surrealdb`).** Multi-model; each\n collection is a SurrealDB table storing the vector as an array field, KNN via\n `vector::similarity::cosine` / `vector::distance::euclidean` ordered appropriately. Metadata in\n a JSON string field filtered with the neutral filter tree's JS reference evaluator. All queries\n parameterized (`type::thing`, `$bindings`). Upsert via `UPSERT`. Driver: `surrealdb`. Verified\n 7/7 conformance against a live SurrealDB v2 backend.\n\n- **LanceDB vector adapter (`@nhtio/adk/batteries/vector/lancedb`).** Embedded, no server\n (file-based, like sqlite-vec/duckdb). Each collection is a Lance table with an explicit Arrow\n schema (`vec` as `FixedSizeList`); KNN via `table.search(vector).distanceType(...)`,\n metadata in a JSON string column filtered with the neutral filter tree's JS reference evaluator.\n Upsert via merge-insert on `id`. Drivers: `@lancedb/lancedb` + `apache-arrow` (prebuilt binary,\n no native compile). Verified 7/7 conformance in-process (temp dir).\n\n- **MariaDB vector adapter (`@nhtio/adk/batteries/vector/mariadb`).** Native `VECTOR(N)` columns\n (MariaDB 11.7+): vectors written with `VEC_FromText` / read with `VEC_ToText`, KNN via\n `VEC_DISTANCE_COSINE` / `VEC_DISTANCE_EUCLIDEAN`; metadata in a `JSON` column filtered with the\n neutral filter tree's JS reference evaluator. SQL backend → transactions + rawSql. Upsert via\n `ON DUPLICATE KEY UPDATE`. Driver: `mariadb`. Verified 7/7 conformance against a live MariaDB 11.7.\n\n- **Meilisearch vector adapter (`@nhtio/adk/batteries/vector/meilisearch`).** Each collection is a\n Meilisearch index with a `userProvided` embedder (BYO vectors under `_vectors.default`); KNN via\n semantic search (`vector` + `hybrid.semanticRatio = 1`), `_rankingScore` maps directly to the\n [0,1] score contract. Metadata is a JSON string field filtered with the neutral filter tree's JS\n reference evaluator. Writes await task completion (strongly consistent). Enables the `vectorStore`\n experimental feature on connect. Driver: `meilisearch`. Verified 7/7 conformance against a live\n Meilisearch backend.\n\n- **Typesense vector adapter (`@nhtio/adk/batteries/vector/typesense`).** Each collection is a\n Typesense collection with a native `float[]` vector field (KNN via `vector_query`); metadata is\n a JSON string field filtered with the neutral filter tree's JS reference evaluator. Native upsert\n by id; strongly consistent (writes searchable on resolve). Driver: `typesense`. Verified 7/7\n conformance against a live Typesense backend.\n\n- **Elasticsearch / OpenSearch vector adapter (`@nhtio/adk/batteries/vector/opensearch`).** One\n adapter for the whole family — they share the kNN `_search` data model. Each collection is an\n index with a `knn_vector` (HNSW/Lucene) field; the neutral filter tree compiles to a bool-query\n over `metadata.*` keyword/numeric sub-fields. Writes use `refresh: true` for read-after-write\n consistency. Driver: `@opensearch-project/opensearch` by default; pass an `@elastic/elasticsearch`\n client via `connection.client` to target Elasticsearch. Verified 7/7 conformance against a live\n OpenSearch backend.\n\n- **ClickHouse vector adapter (`@nhtio/adk/batteries/vector/clickhouse`).** Vectors in an\n `Array(Float32)` column, KNN via `cosineDistance` / `L2Distance` / negative-inner-product\n ordered ascending; metadata in a JSON `String` column. MergeTree allows duplicate keys, so\n upsert is delete-then-insert, and writes are made read-after-write consistent with\n `mutations_sync = 2`. Driver: `@clickhouse/client`. Verified 7/7 conformance against a live\n ClickHouse backend.\n\n- **DuckDB vector adapter (`@nhtio/adk/batteries/vector/duckdb`).** In-process, no server\n (like sqlite-vec) — uses the `vss` community extension's `array_*_distance` functions over a\n `FLOAT[N]` column for KNN, with metadata in a `JSON` column. Driver: `@duckdb/node-api`.\n Verified 7/7 conformance in-process (`:memory:`).\n\n- **Redis / Valkey vector adapter (`@nhtio/adk/batteries/vector/redis`).** One adapter for the\n whole Redis family via the RediSearch module (`redis/redis-stack-server`, or any Redis/Valkey\n with RediSearch loaded). Vectors are stored as FLOAT32 blobs on Redis hashes and searched with\n `FT.SEARCH ... KNN`; the neutral filter tree compiles to RediSearch query syntax (TAG/NUMERIC).\n Verified 7/7 conformance against a live RediSearch backend.\n\n- **The `evaluate_katex` math tool now evaluates calculus numerically.** It previously mangled any\n calculus input — `\\int_{0}^{1} x dx` had its bounds stripped by the LaTeX flattener and produced a\n cryptic `Syntax error in part \"\\int^(1) x dx\"`. The tool now detects calculus on the raw LaTeX\n before flattening and computes it numerically with the bundled mathjs (no new dependency):\n definite integrals (`\\int_{a}^{b} f \\,dx`) via Simpson quadrature, derivatives at a point\n (`\\frac{d}{dx} f \\big|_{x=a}`) via central finite difference, and limits (`\\lim_{x \\to a} f`,\n including `a = \\pm\\infty`) via a two-sided approach. Results are rounded and labelled\n `Result (numeric):` to flag the approximation. Genuinely uncomputable inputs (indefinite integrals,\n derivatives without a point, infinite integration bounds, singular integrands, divergent limits)\n return a specific, guiding error instead of a garbled one. mathjs has no symbolic integration and\n its symbolic `derivative` is intentionally blocklisted here, so these are numeric methods.\n\n### Fixed\n\n- **`evaluate_katex` now maps inverse trig to the correct mathjs names.** `\\arcsin`, `\\arccos`, and\n `\\arctan` were passed through as `arcsin`/`arccos`/`arctan`, which mathjs does not define, so every\n inverse-trig expression errored with `Undefined function`. They now translate to `asin`/`acos`/`atan`.\n\n### Changed\n\n- **Replaced the hand-rolled LaTeX regex parser with evaluatex.** The `evaluate_katex` tool's\n LaTeX-to-mathjs translator (`latexToMathjs`) used brittle regex substitutions that could not handle\n nested braces, causing expressions like `\\frac{\\sqrt{100}}{2}` to produce a Syntax Error.\n It is replaced by the evaluatex library (v2.2.0, zero deps, ~56KB, works in Node.js and all browsers),\n which parses LaTeX with a proper recursive parser. The scalar evaluation path now uses evaluatex\n directly; the numeric calculus path (integrals, derivatives, limits) still uses mathjs for\n per-point evaluation via a shared lightweight LaTeX-to-string translator. evaluatex is an optional\n peer dependency, following the existing battery pattern.\n\n- **`ToolRegistry` now supports hidden tools.** A tool can be registered and callable without being\n immediately visible to the model — hidden state lives on the registry, not the tool. New methods:\n `hide(...names)`, `unhide(...names)`, `setHidden(...names)`, `clearHidden()`, `visible()`, and\n `hidden()`. The LLM batteries now read `visible()` instead of `all()` when building the tool\n definition list, so hidden tools are excluded from the rendered tool list but still resolve when\n called by name. Hidden state propagates through `ToolRegistry.merge`, and unregistering a tool\n automatically cleans up its hidden state. This enables discovery patterns where an agent has a\n tool that enumerates available tools, and the model picks one to call in a subsequent iteration\n without listing everything upfront.\n\n## 2026-06-04\n\n### Fixed\n\n- **LLM batteries now surface reasoning from providers that use the `reasoning` field.** The OpenAI\n and WebLLM Chat Completions batteries read only `reasoning_content`, so thinking output from\n endpoints that emit `reasoning` (Ollama's `/v1`, post-rename vLLM, OpenRouter) produced **no**\n thought events in either streaming or non-streaming mode. Reasoning is not part of OpenAI's\n official Chat Completions spec, so OpenAI-compatible providers disagree on the field name; both\n batteries now read `reasoning` and `reasoning_content` across both the streaming delta and\n non-streaming message shapes. Verified live against a per-model matrix of real endpoints\n (claude-haiku-4-5, gemini-3.5-flash, gemma4, deepseek-v4-flash, glm-5.1, gpt-oss:20b, kimi-k2.6,\n and a workstation Ollama tag).\n\n### Added\n\n- **`reasoningFieldPrecedence` option on the Chat Completions batteries.** An ordered, de-duplicating\n control over which provider reasoning field wins. When more than one listed field is present with\n identical content (or only one is present) a single thought is emitted, attributed to the\n highest-precedence field; when they diverge, each surfaces as its own thought rather than silently\n dropping one (in streaming mode both stream live and are de-duplicated by content at persistence).\n Defaults to `['reasoning', 'reasoning_content']`. A typed `reasoning` field was added to the\n `ChatCompletionsChunkDelta` and `ChatCompletionsResponseMessage` wire shapes, and the new\n `ReasoningField` / `ReasoningFieldPrecedence` / `ReasoningExtract` types plus the\n `extractReasoningFields` helper are exported from both batteries.\n\n## 2026-06-03\n\n### Changed\n\n- **MCP install examples now render the current package version at docs build time.** The ADK MCP\n guide uses a `1.20260921.0` token for pinned `@nhtio/adk@...` examples, and the docs build\n rewrites it from `package.json` for VitePress pages, LLM artifacts, the Ask ADK index, and the\n packaged MCP corpus. Release docs now stay aligned with the published package version without\n hand-editing install snippets before every tag.\n\n## 2026-06-02\n\n### Fixed\n\n- **Corrected the `callId` documentation on the tool-execution events.** `ToolExecutionStartEvent.callId`\n and `ToolExecutionEndEvent.callId` were documented as correlating with `ToolCall.id`. They do not:\n `callId` is `sha256({ tool, args })` — the same value as `TurnToolCallContent.checksum` and\n `ToolCall.checksum`. The two buses join on **`toolCall.checksum === toolExecution*.callId`**, never\n on `toolCall.id`. The hash collides by design for identical `(tool, args)` (that is what\n `DispatchContext.toolCallCount` counts), so order or disambiguate repeated calls by the `DateTime`\n fields (`createdAt` / `updatedAt`, `startedAt` / `endedAt`). TSDoc and the Events guides now state\n this contract; no runtime behavior changed.\n\n## 2026-06-01\n\n### Added\n\n- **Embeddings batteries** (`@nhtio/adk/batteries/embeddings/openai`,\n `@nhtio/adk/batteries/embeddings/webllm`) — two opt-in embedders that share one shape and differ\n only in their engine. `OpenAIEmbeddingsAdapter` POSTs to any OpenAI-`/v1/embeddings`-compatible\n endpoint over raw `fetch` (Node/browser/edge/workers); `WebLLMEmbeddingsAdapter` embeds in-process\n on WebGPU via `@mlc-ai/web-llm`. Both expose `embed` / `embedMany` / `dimensions` / `preload` /\n `reset` / `isAvailable`, return wire-native `number[]` / `number[][]`, require an explicit `model`\n (no default), and handle query/document instruction prefixes identically via a shared\n `kind: 'query' | 'document'` option. The environment-neutral OpenAI battery is re-exported from\n `@nhtio/adk/batteries/embeddings`; the WebGPU-only WebLLM battery is reachable only via its own\n subpath. Embedders are tools you call from your own retrieval middleware — they do not plug into\n an executor slot. See the new `docs/assembly/batteries-embeddings.md`.\n\n### Fixed\n\n- **`E_INVALID_TURN_RUNNER_CONFIG` now names the offending field.** A misconfigured `TurnRunner`\n previously threw a generic \"cannot be instantiated with the provided configuration\" with no\n indication of which field failed. The exception now carries the validator's field-level detail\n (e.g. `…: storeMediaBytesCallback is required`) and attaches the raw `ValidationError` on `cause`.\n- **Unknown-tool errors now list the available tools.** When the model calls a tool that is not in\n the registry, the OpenAI and WebLLM Chat Completions batteries persist a tool-call error reading\n `Tool not found: . Available tools: .` (or `No tools are available this turn.`) so\n the model can self-correct on the next iteration instead of dead-ending on an opaque \"not found\".\n\n## 2026-05-31\n\n### Added\n\n- **Packaged ADK Assembly MCP server** (`src/mcp/server.ts`) — `@nhtio/adk` now ships a local\n stdio MCP server that can be launched with `npx -y @nhtio/adk`. The server exposes ADK assembly\n guidance, packaged documentation search, document reads, generated API lookup, and pasted-code\n assembly review through MCP tools, resources, and prompts.\n- **Version-aligned MCP documentation corpus** (`dist/mcp/adk-docs-corpus.json`) — package\n generation now copies hand-written docs, generated TypeDoc API pages, changelog content, and the\n ADK assembly Skill into a read-only corpus for the MCP server. The corpus is built from the docs\n available at package time so MCP answers match the installed package version.\n- **ADK MCP documentation page** (`docs/mcp.md`) — added a VitePress guide for installing and using\n the ADK MCP across common coding-agent clients, including VS Code / Copilot, Claude Code, Claude\n Desktop, Cursor, Windsurf, Cline / Roo Code, and Continue.\n- **Unified `ByteStore` storage contract** (`src/lib/contracts/byte_store.ts`) — the single\n low-level \"give bytes, get a reader\" shape every storage layer implements, with `SpoolStore`\n (`ByteStore`) and `MediaStore` (`ByteStore`) semantic aliases. `write`\n accepts `string | Uint8Array | ReadableStream`; string input is UTF-8-encoded.\n Exported alongside `implementsByteStore` and `byteStoreSchema`.\n- **Injectable `spoolStore` option** on the OpenAI and WebLLM Chat Completions batteries — back\n tool-output artifacts with durable storage (`OpfsSpoolStore`, a Flydrive-backed store) instead of\n the default per-dispatch in-memory store. Durable stores also stream large/binary tool output to\n disk rather than buffering it in memory.\n- **`ctx.storeMediaBytes(id, bytes)` → `MediaReader`** and **`ctx.storeRetrievableBytes(id, bytes)`\n → `SpoolReader`** — handler-reachable byte-persistence conduits that route tool-generated media\n and large extracted RAG text into consumer storage. Both accept a `ReadableStream`. Exposed on\n `TurnContext` and `DispatchContext`; `ConduitBytes` is exported from the public API.\n- **Reader-backed `Retrievable.content`** — `content` now accepts a `SpooledArtifact` in addition\n to `string | Tokenizable`, so large extracted RAG text can live in a consumer `ByteStore` instead\n of permanently on the heap. New `Retrievable.estimateTokens(encoding)` and\n `Retrievable.contentString()` accessors. (Note: token estimation and render still materialise the\n body transiently; reader-backing removes *permanent* heap residency, not the transient\n allocation.)\n\n### Fixed\n\n- **`InMemorySpoolStore` no longer corrupts binary tool output.** It previously UTF-8-decoded every\n `Uint8Array` at write time, mangling non-text bytes (PDFs, images). Bytes are now stored\n byte-faithfully; `InMemorySpoolReader` decodes on demand for line/text reads and reports the true\n stored byte length.\n\n### Changed (BREAKING)\n\n- **Documentation now builds before the library package in CI.** The package build consumes the\n generated docs, API reference, and changelog artifact so the npm package always includes the MCP\n documentation corpus when built from tagged/default-branch CI jobs.\n- **The generated npm package now exposes an `adk` binary.** `bin/package.ts` writes\n `bin.adk = \"./adk-mcp.mjs\"` into the packaged manifest and bundles the MCP SDK/Zod-backed server\n entry while keeping those MCP implementation dependencies out of the published runtime dependency\n list.\n- **Render helpers are now async.** `renderFirstPartyRetrievables`,\n `renderThirdPartyPublicRetrievables`, `renderThirdPartyPrivateRetrievables`, `renderRetrievables`,\n and `renderChatCompletionsSystemPrompt` on `ChatCompletionsHelpers` now return `Promise`\n (previously `string`). Consumers who override these helpers must update their signatures.\n- **`TurnRunnerConfig` gains two required callbacks** — `storeMediaBytesCallback` and\n `storeRetrievableBytesCallback` (both arity 3). `RawDispatchContext` gains the matching required\n `storeMediaBytes` / `storeRetrievableBytes` fields.\n- **Tool-output spool writes are now awaited** — a custom `spoolStore.write()` may return a\n `Promise` (required for `ReadableStream` input).\n"},{"id":"doc:.vitepress/dist/api","title":"@nhtio/adk","kind":"doc","path":"docs/.vitepress/dist/api.md","uri":"adk://docs/.vitepress/dist/api","content":"---\nurl: 'https://adk.nht.io/api.md'\n---\n\n# @nhtio/adk\n\n## Modules\n\n| Module | Description |\n| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [@nhtio/adk](@nhtio/adk/index.md) | Root convenience barrel for the ADK's core runtime values and public TypeScript contracts. |\n| [@nhtio/adk/batteries](@nhtio/adk/batteries/index.md) | Opt-in aggregate barrel for bundled ADK batteries across LLMs, tools, and storage. |\n| [@nhtio/adk/batteries/artifacts](@nhtio/adk/batteries/artifacts/index.md) | Artifacts battery: structured query tools for multiple document formats. |\n| [@nhtio/adk/batteries/artifacts/toon](@nhtio/adk/batteries/artifacts/toon/index.md) | TOON artifact battery — structured queries over TOON format artifacts. |\n| [@nhtio/adk/batteries/artifacts/xml](@nhtio/adk/batteries/artifacts/xml/index.md) | A structured artifact battery for XML documents. |\n| [@nhtio/adk/batteries/artifacts/yaml](@nhtio/adk/batteries/artifacts/yaml/index.md) | YAML artifact battery: [SpooledYamlArtifact](@nhtio/adk/batteries/artifacts/yaml/classes/SpooledYamlArtifact.md) and bidirectional converters. |\n| [@nhtio/adk/batteries/context](@nhtio/adk/batteries/context/index.md) | Aggregate barrel for bundled context-management batteries — strategies for fitting a large working set of messages, memories, retrievables, thoughts, and tools into a model's context window. |\n| [@nhtio/adk/batteries/context/compact](@nhtio/adk/batteries/context/compact/index.md) | Compact — summarize-over-threshold context management. Instead of shedding old turns outright, pay for a model call to fold them into a running summary, trading a real API cost for retaining compressed signal from everything folded away. |\n| [@nhtio/adk/batteries/context/compact/contracts](@nhtio/adk/batteries/context/compact/contracts/index.md) | Structural contracts for the Compact (summarize-over-threshold) context-management battery — the seams it invokes via injected functions, and the one cost-observability shape it hands back. |\n| [@nhtio/adk/batteries/context/compact/summarizer](@nhtio/adk/batteries/context/compact/summarizer/index.md) | The Compact summarizer and history assembler — the whole Compact thesis, in code. |\n| [@nhtio/adk/batteries/context/exceptions](@nhtio/adk/batteries/context/exceptions/index.md) | Shared exception for the context-management batteries — the one failure class `thrift` and `compact` have in common. |\n| [@nhtio/adk/batteries/context/thrift](@nhtio/adk/batteries/context/thrift/index.md) | Token Thrift — subtractive context management. A pure, model-free algorithm that holds a large WORKING set (messages, memories, retrievables, thoughts, an image, tools) and SUBTRACTS it down to the highest-signal slice that fits the active model's context window. |\n| [@nhtio/adk/batteries/context/thrift/contracts](@nhtio/adk/batteries/context/thrift/contracts/index.md) | Structural contracts for the Token Thrift subtractive-pass battery — every shape it reads off a caller's objects, and every capability it invokes via an injected function. |\n| [@nhtio/adk/batteries/context/thrift/relevance](@nhtio/adk/batteries/context/thrift/relevance/index.md) | Relevance-based history-turn selection — the companion to subtractToFit that decides WHICH prior turns are worth replaying at all, before the subtractive pass ever runs. |\n| [@nhtio/adk/batteries/context/thrift/subtractive\\_pass](@nhtio/adk/batteries/context/thrift/subtractive_pass/index.md) | The subtractive pass — the whole Token Thrift thesis, in code. |\n| [@nhtio/adk/batteries/dev-tools](@nhtio/adk/batteries/dev-tools/index.md) | Typed development-editing pipeline contracts and factory. |\n| [@nhtio/adk/batteries/dev-tools/conformance](@nhtio/adk/batteries/dev-tools/conformance/index.md) | Development-tools conformance surface. |\n| [@nhtio/adk/batteries/dev-tools/forge](@nhtio/adk/batteries/dev-tools/forge/index.md) | Agent glue for the structured development-tools surface. |\n| [@nhtio/adk/batteries/embeddings](@nhtio/adk/batteries/embeddings/index.md) | Environment-neutral aggregate barrel for bundled embeddings batteries. |\n| [@nhtio/adk/batteries/embeddings/ollama](@nhtio/adk/batteries/embeddings/ollama/index.md) | Ollama Embeddings adapter battery — the environment-neutral embeddings battery for Ollama. |\n| [@nhtio/adk/batteries/embeddings/ollama/adapter](@nhtio/adk/batteries/embeddings/ollama/adapter/index.md) | Cross-environment Ollama Embeddings adapter battery. |\n| [@nhtio/adk/batteries/embeddings/ollama/exceptions](@nhtio/adk/batteries/embeddings/ollama/exceptions/index.md) | Battery-scoped exception constructors for Ollama Embeddings adapter failures. |\n| [@nhtio/adk/batteries/embeddings/ollama/types](@nhtio/adk/batteries/embeddings/ollama/types/index.md) | Option and wire-shape types for the Ollama Embeddings adapter. |\n| [@nhtio/adk/batteries/embeddings/ollama/validation](@nhtio/adk/batteries/embeddings/ollama/validation/index.md) | Runtime validation schema and wrapper for Ollama Embeddings adapter options. |\n| [@nhtio/adk/batteries/embeddings/openai](@nhtio/adk/batteries/embeddings/openai/index.md) | OpenAI Embeddings adapter battery — the environment-neutral embeddings battery and owner of the shared embeddings option base. |\n| [@nhtio/adk/batteries/embeddings/openai/adapter](@nhtio/adk/batteries/embeddings/openai/adapter/index.md) | Cross-environment OpenAI Embeddings adapter battery. |\n| [@nhtio/adk/batteries/embeddings/openai/exceptions](@nhtio/adk/batteries/embeddings/openai/exceptions/index.md) | Battery-scoped exception constructors for OpenAI Embeddings adapter failures. |\n| [@nhtio/adk/batteries/embeddings/openai/helpers](@nhtio/adk/batteries/embeddings/openai/helpers/index.md) | Shared, engine-agnostic helpers for the embeddings batteries. |\n| [@nhtio/adk/batteries/embeddings/openai/types](@nhtio/adk/batteries/embeddings/openai/types/index.md) | Option and wire-shape types for the OpenAI Embeddings adapter, plus the shared embeddings battery base type both bundled embeddings batteries build on. |\n| [@nhtio/adk/batteries/embeddings/openai/validation](@nhtio/adk/batteries/embeddings/openai/validation/index.md) | Runtime validation schema and wrapper for OpenAI Embeddings adapter options. |\n| [@nhtio/adk/batteries/embeddings/transformers\\_js](@nhtio/adk/batteries/embeddings/transformers_js/index.md) | transformers.js Embeddings adapter battery — dual-environment ONNX feature-extraction. |\n| [@nhtio/adk/batteries/embeddings/transformers\\_js/adapter](@nhtio/adk/batteries/embeddings/transformers_js/adapter/index.md) | transformers.js (ONNX, dual-environment) Embeddings adapter battery. |\n| [@nhtio/adk/batteries/embeddings/transformers\\_js/exceptions](@nhtio/adk/batteries/embeddings/transformers_js/exceptions/index.md) | Battery-scoped exception constructors for the transformers.js Embeddings adapter. |\n| [@nhtio/adk/batteries/embeddings/transformers\\_js/pooling](@nhtio/adk/batteries/embeddings/transformers_js/pooling/index.md) | Deterministic, battery-owned pooling + L2-normalization for the transformers.js embeddings battery. |\n| [@nhtio/adk/batteries/embeddings/transformers\\_js/types](@nhtio/adk/batteries/embeddings/transformers_js/types/index.md) | Option and pipeline types for the transformers.js Embeddings adapter. |\n| [@nhtio/adk/batteries/embeddings/transformers\\_js/validation](@nhtio/adk/batteries/embeddings/transformers_js/validation/index.md) | Runtime validation schema and wrapper for transformers.js Embeddings adapter options. |\n| [@nhtio/adk/batteries/embeddings/webllm](@nhtio/adk/batteries/embeddings/webllm/index.md) | WebLLM Embeddings adapter battery — WebGPU/in-process embeddings via `@mlc-ai/web-llm`. |\n| [@nhtio/adk/batteries/embeddings/webllm/adapter](@nhtio/adk/batteries/embeddings/webllm/adapter/index.md) | WebLLM (WebGPU, in-process) Embeddings adapter battery. |\n| [@nhtio/adk/batteries/embeddings/webllm/exceptions](@nhtio/adk/batteries/embeddings/webllm/exceptions/index.md) | Battery-scoped exception constructors for WebLLM Embeddings adapter failures. |\n| [@nhtio/adk/batteries/embeddings/webllm/types](@nhtio/adk/batteries/embeddings/webllm/types/index.md) | Option and engine types for the WebLLM Embeddings adapter. |\n| [@nhtio/adk/batteries/embeddings/webllm/validation](@nhtio/adk/batteries/embeddings/webllm/validation/index.md) | Runtime validation schema and wrapper for WebLLM Embeddings adapter options. |\n| [@nhtio/adk/batteries/encoding](@nhtio/adk/batteries/encoding/index.md) | Opt-in serialization battery: make the ADK primitives round-trip through `@nhtio/encoder`. |\n| [@nhtio/adk/batteries/generation](@nhtio/adk/batteries/generation/index.md) | Environment-neutral aggregate barrel for bundled media generation batteries. |\n| [@nhtio/adk/batteries/generation/\\_shared](@nhtio/adk/batteries/generation/_shared/index.md) | Structural contracts and normalization helpers shared by the media generation batteries (text→image + image editing). |\n| [@nhtio/adk/batteries/generation/gemini](@nhtio/adk/batteries/generation/gemini/index.md) | Gemini media generation adapter battery. |\n| [@nhtio/adk/batteries/generation/gemini/adapter](@nhtio/adk/batteries/generation/gemini/adapter/index.md) | Cross-environment Gemini media generation adapter battery. |\n| [@nhtio/adk/batteries/generation/gemini/exceptions](@nhtio/adk/batteries/generation/gemini/exceptions/index.md) | Battery-scoped exception constructors for Gemini media generation adapter failures. |\n| [@nhtio/adk/batteries/generation/gemini/types](@nhtio/adk/batteries/generation/gemini/types/index.md) | Option and wire-shape types for the Gemini media generation adapter. |\n| [@nhtio/adk/batteries/generation/gemini/validation](@nhtio/adk/batteries/generation/gemini/validation/index.md) | Runtime validation schema and wrapper for Gemini media generation adapter options. |\n| [@nhtio/adk/batteries/generation/local\\_diffusion/adapter](@nhtio/adk/batteries/generation/local_diffusion/adapter/index.md) | Node-only local diffusion generation adapter. |\n| [@nhtio/adk/batteries/generation/local\\_diffusion/exceptions](@nhtio/adk/batteries/generation/local_diffusion/exceptions/index.md) | Local diffusion battery exceptions. |\n| [@nhtio/adk/batteries/generation/local\\_diffusion/protocol](@nhtio/adk/batteries/generation/local_diffusion/protocol/index.md) | Pure protocol constants, frame parsing, and byte-safe line framing for local diffusion backends. |\n| [@nhtio/adk/batteries/generation/local\\_diffusion/types](@nhtio/adk/batteries/generation/local_diffusion/types/index.md) | Node-only option and process contracts for local diffusion generation. |\n| [@nhtio/adk/batteries/generation/local\\_diffusion/validation](@nhtio/adk/batteries/generation/local_diffusion/validation/index.md) | Runtime validation for local diffusion options. |\n| [@nhtio/adk/batteries/generation/openai](@nhtio/adk/batteries/generation/openai/index.md) | OpenAI media generation adapter battery — the environment-neutral generation battery and owner of the shared generation option base. |\n| [@nhtio/adk/batteries/generation/openai/adapter](@nhtio/adk/batteries/generation/openai/adapter/index.md) | Cross-environment OpenAI media generation adapter battery. |\n| [@nhtio/adk/batteries/generation/openai/exceptions](@nhtio/adk/batteries/generation/openai/exceptions/index.md) | Battery-scoped exception constructors for OpenAI media generation adapter failures. |\n| [@nhtio/adk/batteries/generation/openai/types](@nhtio/adk/batteries/generation/openai/types/index.md) | Option and wire-shape types for the OpenAI media generation adapter, plus the shared generation battery base type both current and future generation batteries build on. |\n| [@nhtio/adk/batteries/generation/openai/validation](@nhtio/adk/batteries/generation/openai/validation/index.md) | Runtime validation schema and wrapper for OpenAI media generation adapter options. |\n| [@nhtio/adk/batteries/generation/transformers\\_js](@nhtio/adk/batteries/generation/transformers_js/index.md) | transformers.js Generation battery — dual-environment, EXPERIMENTAL on-device Janus text→image. |\n| [@nhtio/adk/batteries/generation/transformers\\_js/adapter](@nhtio/adk/batteries/generation/transformers_js/adapter/index.md) | transformers.js (on-device, EXPERIMENTAL) Generation adapter battery — DeepSeek Janus text→image. |\n| [@nhtio/adk/batteries/generation/transformers\\_js/exceptions](@nhtio/adk/batteries/generation/transformers_js/exceptions/index.md) | Battery-scoped exception constructors for the transformers.js Generation (on-device text→image) adapter. |\n| [@nhtio/adk/batteries/generation/transformers\\_js/helpers](@nhtio/adk/batteries/generation/transformers_js/helpers/index.md) | Env-branched PNG-encoding helper for transformers.js Generation's `RawImage` results. |\n| [@nhtio/adk/batteries/generation/transformers\\_js/types](@nhtio/adk/batteries/generation/transformers_js/types/index.md) | Option and model/processor seam types for the transformers.js (on-device Janus) Generation adapter. |\n| [@nhtio/adk/batteries/generation/transformers\\_js/validation](@nhtio/adk/batteries/generation/transformers_js/validation/index.md) | Runtime validation schema and wrapper for transformers.js Generation adapter options. |\n| [@nhtio/adk/batteries/llm](@nhtio/adk/batteries/llm/index.md) | Aggregate barrel for bundled LLM adapters and their helper, option, and exception exports. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages](@nhtio/adk/batteries/llm/anthropic_messages/index.md) | Native Anthropic Messages API adapter battery with swappable translation helpers and wire types. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages/adapter](@nhtio/adk/batteries/llm/anthropic_messages/adapter/index.md) | Cross-environment executor adapter for the Anthropic Messages API. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages/count\\_tokens](@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/index.md) | Token-count helpers for the Anthropic Messages battery. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages/error\\_translation](@nhtio/adk/batteries/llm/anthropic_messages/error_translation/index.md) | SDK error → ADK classification for the Anthropic Messages battery. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages/exceptions](@nhtio/adk/batteries/llm/anthropic_messages/exceptions/index.md) | Battery-scoped exception constructors for the Anthropic Messages adapter. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages/helpers](@nhtio/adk/batteries/llm/anthropic_messages/helpers/index.md) | Anthropic Messages translation helpers. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages/types](@nhtio/adk/batteries/llm/anthropic_messages/types/index.md) | TypeScript wire shapes, helper contracts, and option types for the Anthropic Messages battery. |\n| [@nhtio/adk/batteries/llm/anthropic\\_messages/validation](@nhtio/adk/batteries/llm/anthropic_messages/validation/index.md) | Runtime validation schema and wrapper for Anthropic Messages adapter options. |\n| [@nhtio/adk/batteries/llm/bedrock\\_converse](@nhtio/adk/batteries/llm/bedrock_converse/index.md) | Native AWS Bedrock Converse adapter battery with swappable translation helpers and wire types. |\n| [@nhtio/adk/batteries/llm/bedrock\\_converse/adapter](@nhtio/adk/batteries/llm/bedrock_converse/adapter/index.md) | Cross-environment executor adapter for AWS Bedrock's native Converse API. |\n| [@nhtio/adk/batteries/llm/bedrock\\_converse/exceptions](@nhtio/adk/batteries/llm/bedrock_converse/exceptions/index.md) | Battery-scoped exception constructors for the native Bedrock Converse adapter. |\n| [@nhtio/adk/batteries/llm/bedrock\\_converse/helpers](@nhtio/adk/batteries/llm/bedrock_converse/helpers/index.md) | Translation helpers for the native Bedrock Converse battery. |\n| [@nhtio/adk/batteries/llm/bedrock\\_converse/types](@nhtio/adk/batteries/llm/bedrock_converse/types/index.md) | Wire shapes, helper contracts, and option types for the native Bedrock Converse battery. |\n| [@nhtio/adk/batteries/llm/bedrock\\_converse/validation](@nhtio/adk/batteries/llm/bedrock_converse/validation/index.md) | Runtime option validation for the native Bedrock Converse battery. |\n| [@nhtio/adk/batteries/llm/chat\\_common/exceptions](@nhtio/adk/batteries/llm/chat_common/exceptions/index.md) | Shared, wire-shape-agnostic exceptions for the on-device LLM batteries. |\n| [@nhtio/adk/batteries/llm/claude\\_code\\_cli](@nhtio/adk/batteries/llm/claude_code_cli/index.md) | Claude Code CLI battery — the first in the \"CLI harness\" LLM-battery family, wrapping the `claude` CLI binary as a `DispatchExecutorFn` destination. |\n| [@nhtio/adk/batteries/llm/claude\\_code\\_cli/adapter](@nhtio/adk/batteries/llm/claude_code_cli/adapter/index.md) | Cross-environment executor adapter that wraps the Claude Code CLI as a `DispatchExecutorFn` destination. |\n| [@nhtio/adk/batteries/llm/claude\\_code\\_cli/exceptions](@nhtio/adk/batteries/llm/claude_code_cli/exceptions/index.md) | Battery-scoped exception constructors for the Claude Code CLI adapter. |\n| [@nhtio/adk/batteries/llm/claude\\_code\\_cli/helpers](@nhtio/adk/batteries/llm/claude_code_cli/helpers/index.md) | Swappable translation helpers for rendering ADK state into the Claude Code CLI's `-p` prompt string and MCP tool-result content. |\n| [@nhtio/adk/batteries/llm/claude\\_code\\_cli/types](@nhtio/adk/batteries/llm/claude_code_cli/types/index.md) | TypeScript wire shapes, helper contracts, and option types for the Claude Code CLI battery. |\n| [@nhtio/adk/batteries/llm/claude\\_code\\_cli/validation](@nhtio/adk/batteries/llm/claude_code_cli/validation/index.md) | Runtime validation schema and wrapper for Claude Code CLI adapter options. |\n| [@nhtio/adk/batteries/llm/claude\\_code\\_cli/wire](@nhtio/adk/batteries/llm/claude_code_cli/wire/index.md) | The normalized adapter↔wrapper protocol shared by every CLI-harness LLM battery. |\n| [@nhtio/adk/batteries/llm/gemini\\_generate\\_content](@nhtio/adk/batteries/llm/gemini_generate_content/index.md) | Native Gemini `generateContent` adapter battery with swappable translation helpers and wire types. |\n| [@nhtio/adk/batteries/llm/gemini\\_generate\\_content/adapter](@nhtio/adk/batteries/llm/gemini_generate_content/adapter/index.md) | Cross-environment executor adapter for Google's native Gemini `generateContent` endpoint. |\n| [@nhtio/adk/batteries/llm/gemini\\_generate\\_content/exceptions](@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/index.md) | Battery-scoped exception constructors for the native Gemini `generateContent` adapter. |\n| [@nhtio/adk/batteries/llm/gemini\\_generate\\_content/helpers](@nhtio/adk/batteries/llm/gemini_generate_content/helpers/index.md) | Translation helpers for the native Gemini `generateContent` battery. |\n| [@nhtio/adk/batteries/llm/gemini\\_generate\\_content/types](@nhtio/adk/batteries/llm/gemini_generate_content/types/index.md) | Wire shapes, helper contracts, and option types for the native Gemini `generateContent` battery. |\n| [@nhtio/adk/batteries/llm/gemini\\_generate\\_content/validation](@nhtio/adk/batteries/llm/gemini_generate_content/validation/index.md) | Runtime option validation for the native Gemini `generateContent` battery. |\n| [@nhtio/adk/batteries/llm/litert\\_lm](@nhtio/adk/batteries/llm/litert_lm/index.md) | LiteRT-LM adapter battery — browser/WebGPU on-device inference with swappable translation helpers. |\n| [@nhtio/adk/batteries/llm/litert\\_lm/adapter](@nhtio/adk/batteries/llm/litert_lm/adapter/index.md) | Browser/WebGPU executor adapter for Google's LiteRT-LM (`@litert-lm/core`). |\n| [@nhtio/adk/batteries/llm/litert\\_lm/exceptions](@nhtio/adk/batteries/llm/litert_lm/exceptions/index.md) | Battery-scoped exception constructors for LiteRT-LM adapter failures. |\n| [@nhtio/adk/batteries/llm/litert\\_lm/helpers](@nhtio/adk/batteries/llm/litert_lm/helpers/index.md) | Translation helpers for the LiteRT-LM adapter. |\n| [@nhtio/adk/batteries/llm/litert\\_lm/types](@nhtio/adk/batteries/llm/litert_lm/types/index.md) | Types for the LiteRT-LM adapter — options, engine/conversation aliases, and the LiteRT wire shapes re-exported from `@litert-lm/core`. |\n| [@nhtio/adk/batteries/llm/litert\\_lm/validation](@nhtio/adk/batteries/llm/litert_lm/validation/index.md) | Runtime validation schema and wrapper for LiteRT-LM adapter options. |\n| [@nhtio/adk/batteries/llm/ollama](@nhtio/adk/batteries/llm/ollama/index.md) | Native Ollama `/api/chat` adapter battery with swappable translation helpers and wire types. |\n| [@nhtio/adk/batteries/llm/ollama/adapter](@nhtio/adk/batteries/llm/ollama/adapter/index.md) | Cross-environment executor adapter for the native Ollama `/api/chat` endpoint. |\n| [@nhtio/adk/batteries/llm/ollama/exceptions](@nhtio/adk/batteries/llm/ollama/exceptions/index.md) | Battery-scoped exception constructors for the native Ollama `/api/chat` adapter. |\n| [@nhtio/adk/batteries/llm/ollama/helpers](@nhtio/adk/batteries/llm/ollama/helpers/index.md) | Swappable translation helpers for rendering ADK state into native Ollama `/api/chat` requests. |\n| [@nhtio/adk/batteries/llm/ollama/types](@nhtio/adk/batteries/llm/ollama/types/index.md) | TypeScript wire shapes, helper contracts, and option types for the native Ollama battery. |\n| [@nhtio/adk/batteries/llm/ollama/validation](@nhtio/adk/batteries/llm/ollama/validation/index.md) | Runtime validation schema and wrapper for native Ollama adapter options. |\n| [@nhtio/adk/batteries/llm/openai\\_chat\\_completions](@nhtio/adk/batteries/llm/openai_chat_completions/index.md) | OpenAI Chat Completions adapter battery with swappable translation helpers and wire types. |\n| [@nhtio/adk/batteries/llm/openai\\_chat\\_completions/adapter](@nhtio/adk/batteries/llm/openai_chat_completions/adapter/index.md) | Cross-environment executor adapter for OpenAI Chat Completions compatible endpoints. |\n| [@nhtio/adk/batteries/llm/openai\\_chat\\_completions/exceptions](@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/index.md) | Battery-scoped exception constructors for OpenAI Chat Completions adapter failures. |\n| [@nhtio/adk/batteries/llm/openai\\_chat\\_completions/helpers](@nhtio/adk/batteries/llm/openai_chat_completions/helpers/index.md) | Swappable translation helpers for rendering ADK state into Chat Completions requests. |\n| [@nhtio/adk/batteries/llm/openai\\_chat\\_completions/types](@nhtio/adk/batteries/llm/openai_chat_completions/types/index.md) | TypeScript wire shapes, helper contracts, and option types for the Chat Completions battery. |\n| [@nhtio/adk/batteries/llm/openai\\_chat\\_completions/validation](@nhtio/adk/batteries/llm/openai_chat_completions/validation/index.md) | Runtime validation schema and wrapper for OpenAI Chat Completions adapter options. |\n| [@nhtio/adk/batteries/llm/openai\\_responses](@nhtio/adk/batteries/llm/openai_responses/index.md) | Native OpenAI Responses API adapter battery with swappable translation helpers and wire types. |\n| [@nhtio/adk/batteries/llm/openai\\_responses/adapter](@nhtio/adk/batteries/llm/openai_responses/adapter/index.md) | Cross-environment executor adapter for the OpenAI Responses API. |\n| [@nhtio/adk/batteries/llm/openai\\_responses/exceptions](@nhtio/adk/batteries/llm/openai_responses/exceptions/index.md) | Battery-scoped exception constructors for the OpenAI Responses adapter. |\n| [@nhtio/adk/batteries/llm/openai\\_responses/helpers](@nhtio/adk/batteries/llm/openai_responses/helpers/index.md) | Swappable translation helpers for rendering ADK state into OpenAI Responses requests. |\n| [@nhtio/adk/batteries/llm/openai\\_responses/types](@nhtio/adk/batteries/llm/openai_responses/types/index.md) | TypeScript wire shapes, helper contracts, and option types for the OpenAI Responses battery. |\n| [@nhtio/adk/batteries/llm/openai\\_responses/validation](@nhtio/adk/batteries/llm/openai_responses/validation/index.md) | Runtime validation schema and wrapper for OpenAI Responses adapter options. |\n| [@nhtio/adk/batteries/llm/transformers\\_js](@nhtio/adk/batteries/llm/transformers_js/index.md) | transformers.js LLM adapter battery — dual-environment (Node + browser) on-device text generation. |\n| [@nhtio/adk/batteries/llm/transformers\\_js/adapter](@nhtio/adk/batteries/llm/transformers_js/adapter/index.md) | Dual-environment (Node + browser) executor adapter for transformers.js (`@huggingface/transformers`). |\n| [@nhtio/adk/batteries/llm/transformers\\_js/exceptions](@nhtio/adk/batteries/llm/transformers_js/exceptions/index.md) | Battery-scoped exception constructors for the transformers.js LLM adapter. |\n| [@nhtio/adk/batteries/llm/transformers\\_js/helpers](@nhtio/adk/batteries/llm/transformers_js/helpers/index.md) | Translation helpers for the transformers.js LLM adapter. |\n| [@nhtio/adk/batteries/llm/transformers\\_js/model\\_source](@nhtio/adk/batteries/llm/transformers_js/model_source/index.md) | Custom model-source resolver for transformers.js — the dual-environment seam that lets a consumer serve a model's files (each submodule ONNX, the tokenizer, the config) from anywhere: OPFS, a different repo per modality, bundled bytes, an in-memory map. |\n| [@nhtio/adk/batteries/llm/transformers\\_js/types](@nhtio/adk/batteries/llm/transformers_js/types/index.md) | Types for the transformers.js LLM adapter — options, pipeline aliases, and the parser option types. |\n| [@nhtio/adk/batteries/llm/transformers\\_js/validation](@nhtio/adk/batteries/llm/transformers_js/validation/index.md) | Runtime validation schema and wrapper for transformers.js LLM adapter options. |\n| [@nhtio/adk/batteries/llm/webllm\\_chat\\_completions](@nhtio/adk/batteries/llm/webllm_chat_completions/index.md) | WebLLM Chat Completions adapter battery with swappable translation helpers and wire types. |\n| [@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/adapter](@nhtio/adk/batteries/llm/webllm_chat_completions/adapter/index.md) | Cross-environment executor adapter for WebLLM Chat Completions compatible endpoints. |\n| [@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/exceptions](@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/index.md) | Battery-scoped exception constructors for WebLLM Chat Completions adapter failures. |\n| [@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/helpers](@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/index.md) | Swappable translation helpers for rendering ADK state into WebLLM Chat Completions requests. |\n| [@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/validation](@nhtio/adk/batteries/llm/webllm_chat_completions/validation/index.md) | Runtime validation schema and wrapper for WebLLM Chat Completions adapter options. |\n| [@nhtio/adk/batteries/media](@nhtio/adk/batteries/media/index.md) | A knex-inspired local media pipeline: one declarative plan, three front-ends (chainable builder, pipe string, JSON ops), engines as composable seams. |\n| [@nhtio/adk/batteries/media/contracts](@nhtio/adk/batteries/media/contracts/index.md) | Generic engine contracts for the media pipeline battery — the seams every implementation (bundled or BYO) plugs into. |\n| [@nhtio/adk/batteries/media/engines/audio\\_decode](@nhtio/adk/batteries/media/engines/audio_decode/index.md) | A cross-environment audio-decoding [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md) backed by the `audio-decode` package (pure JS/WASM codecs — no ffmpeg, no native bindings; works in Node and browsers). |\n| [@nhtio/adk/batteries/media/engines/data](@nhtio/adk/batteries/media/engines/data/index.md) | The deterministic text/data [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md): seeds and conversions for the text-shaped family (txt/md/json/yaml/csv/html). |\n| [@nhtio/adk/batteries/media/engines/exceljs](@nhtio/adk/batteries/media/engines/exceljs/index.md) | The ExcelJS-backed workbook [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md): the fidelity-preserving structural editor for xlsx, plus in-process blank-workbook generation. |\n| [@nhtio/adk/batteries/media/engines/execa\\_executor](@nhtio/adk/batteries/media/engines/execa_executor/index.md) | A [@nhtio/adk/batteries/media/contracts!BinaryExecutor](@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecutor.md) implementation that runs invocations as local child processes via execa. |\n| [@nhtio/adk/batteries/media/engines/fs\\_workspace](@nhtio/adk/batteries/media/engines/fs_workspace/index.md) | A [@nhtio/adk/batteries/media/contracts!ScratchWorkspace](@nhtio/adk/batteries/media/contracts/interfaces/ScratchWorkspace.md) implementation backed by the local filesystem via `node:fs/promises`. |\n| [@nhtio/adk/batteries/media/engines/jimp](@nhtio/adk/batteries/media/engines/jimp/index.md) | A cross-environment image [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md) backed by Jimp (pure JavaScript — no native bindings, no binaries). |\n| [@nhtio/adk/batteries/media/engines/sharp](@nhtio/adk/batteries/media/engines/sharp/index.md) | A Node-native image [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md) backed by sharp (libvips bindings — fast, full-format). |\n| [@nhtio/adk/batteries/media/engines/sheetjs](@nhtio/adk/batteries/media/engines/sheetjs/index.md) | The SheetJS-backed spreadsheet [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md): the in-process, cross-environment spreadsheet converter, generator, and structural editor. |\n| [@nhtio/adk/batteries/media/engines/soffice](@nhtio/adk/batteries/media/engines/soffice/index.md) | The LibreOffice-backed [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md): document, spreadsheet, and presentation conversion via the `soffice` binary. |\n| [@nhtio/adk/batteries/media/engines/tesseract\\_js](@nhtio/adk/batteries/media/engines/tesseract_js/index.md) | A cross-environment OCR [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md) backed by tesseract.js (WASM Tesseract — Node and browsers, no binary). |\n| [@nhtio/adk/batteries/media/engines/transformers\\_asr](@nhtio/adk/batteries/media/engines/transformers_asr/index.md) | A cross-environment transcription [@nhtio/adk/batteries/media/contracts!MediaEngine](@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md) backed by `@huggingface/transformers` Whisper (ONNX in Node, WASM/WebGPU in browsers). |\n| [@nhtio/adk/batteries/media/forge](@nhtio/adk/batteries/media/forge/index.md) | Agent glue: forge ADK tools from a media pipeline, so a model can drive local media work. |\n| [@nhtio/adk/batteries/orchestration](@nhtio/adk/batteries/orchestration/index.md) | The orchestration battery — plan lifecycle, execution, and the model-facing tool forge. |\n| [@nhtio/adk/batteries/orchestration/conformance](@nhtio/adk/batteries/orchestration/conformance/index.md) | The shared conformance suite for [PlanStore](@nhtio/adk/batteries/orchestration/interfaces/PlanStore.md) backends. |\n| [@nhtio/adk/batteries/orchestration/dispatch\\_reasoner](@nhtio/adk/batteries/orchestration/dispatch_reasoner/index.md) | - |\n| [@nhtio/adk/batteries/orchestration/encoding](@nhtio/adk/batteries/orchestration/encoding/index.md) | Encoding battery for orchestration: the reference classes the IR is built from, their `@nhtio/encoder` registration, and the plan digest every approval binds to. |\n| [@nhtio/adk/batteries/orchestration/forge](@nhtio/adk/batteries/orchestration/forge/index.md) | The model-facing tool forge for the orchestration battery. |\n| [@nhtio/adk/batteries/orchestration/in\\_memory](@nhtio/adk/batteries/orchestration/in_memory/index.md) | - |\n| [@nhtio/adk/batteries/orchestration/ops](@nhtio/adk/batteries/orchestration/ops/index.md) | The op-log fold and the branch-key renderer for orchestration. |\n| [@nhtio/adk/batteries/orchestration/plan](@nhtio/adk/batteries/orchestration/plan/index.md) | The IR's runtime helpers: pure, graph-shaped predicates and guards. |\n| [@nhtio/adk/batteries/orchestration/raw](@nhtio/adk/batteries/orchestration/raw/index.md) | The machine-readable reading surface for a plan's op log. |\n| [@nhtio/adk/batteries/orchestration/render](@nhtio/adk/batteries/orchestration/render/index.md) | Prose projection of a plan — the review surface an operator reads at the approval gate, and the re-consumption surface a model reads for a plan it did not author. |\n| [@nhtio/adk/batteries/orchestration/runs](@nhtio/adk/batteries/orchestration/runs/index.md) | The run-event fold: turn a persisted run log into a `RunProjection`. |\n| [@nhtio/adk/batteries/orchestration/templates](@nhtio/adk/batteries/orchestration/templates/index.md) | Template validation and instantiation for orchestration. |\n| [@nhtio/adk/batteries/orchestration/types](@nhtio/adk/batteries/orchestration/types/index.md) | The orchestration battery's shared type contracts — the normative source for every type more than one part of the battery touches. |\n| [@nhtio/adk/batteries/orchestration/validation](@nhtio/adk/batteries/orchestration/validation/index.md) | Submit-time validation and the lifecycle machine. |\n| [@nhtio/adk/batteries/sandbox](@nhtio/adk/batteries/sandbox/index.md) | - |\n| [@nhtio/adk/batteries/sandbox/tools](@nhtio/adk/batteries/sandbox/tools/index.md) | - |\n| [@nhtio/adk/batteries/skills](@nhtio/adk/batteries/skills/index.md) | Stateful skill discovery, activation, and deactivation for ADK agents. |\n| [@nhtio/adk/batteries/skills/conformance](@nhtio/adk/batteries/skills/conformance/index.md) | Conformance suite for [SkillSource](@nhtio/adk/batteries/skills/interfaces/SkillSource.md) implementations. |\n| [@nhtio/adk/batteries/skills/in\\_memory](@nhtio/adk/batteries/skills/in_memory/index.md) | Reference in-memory SkillSource for tests and small deployments. |\n| [@nhtio/adk/batteries/specialists](@nhtio/adk/batteries/specialists/index.md) | Environment-neutral aggregate barrel for bundled specialist batteries. |\n| [@nhtio/adk/batteries/specialists/\\_shared](@nhtio/adk/batteries/specialists/_shared/index.md) | Structural contracts and normalization helpers shared by the on-device specialist batteries (STT / OCR / caption). |\n| [@nhtio/adk/batteries/specialists/caption](@nhtio/adk/batteries/specialists/caption/index.md) | Caption (image-to-text) specialist modality barrel. |\n| [@nhtio/adk/batteries/specialists/caption/transformers\\_js](@nhtio/adk/batteries/specialists/caption/transformers_js/index.md) | transformers.js Caption specialist battery — dual-environment ONNX image-to-text. |\n| [@nhtio/adk/batteries/specialists/caption/transformers\\_js/adapter](@nhtio/adk/batteries/specialists/caption/transformers_js/adapter/index.md) | transformers.js (ONNX, dual-environment) Caption (image-to-text) specialist adapter battery. |\n| [@nhtio/adk/batteries/specialists/caption/transformers\\_js/exceptions](@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/index.md) | Battery-scoped exception constructors for the transformers.js Caption specialist adapter. |\n| [@nhtio/adk/batteries/specialists/caption/transformers\\_js/types](@nhtio/adk/batteries/specialists/caption/transformers_js/types/index.md) | Option and pipeline types for the transformers.js Caption (image-to-text) specialist adapter. |\n| [@nhtio/adk/batteries/specialists/caption/transformers\\_js/validation](@nhtio/adk/batteries/specialists/caption/transformers_js/validation/index.md) | Runtime validation schema and wrapper for transformers.js Caption adapter options. |\n| [@nhtio/adk/batteries/specialists/ocr](@nhtio/adk/batteries/specialists/ocr/index.md) | Environment-neutral aggregate barrel for bundled OCR specialist batteries. |\n| [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js](@nhtio/adk/batteries/specialists/ocr/tesseract_js/index.md) | tesseract.js OCR specialist adapter battery — dual-environment WASM Tesseract. |\n| [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/adapter](@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter/index.md) | tesseract.js (WASM Tesseract, dual-environment) OCR specialist adapter battery. |\n| [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/exceptions](@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/index.md) | Battery-scoped exception constructors for the tesseract.js OCR specialist adapter. |\n| [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/types](@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/index.md) | Option and result types for the tesseract.js OCR specialist adapter. |\n| [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/validation](@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/index.md) | Runtime validation schema and wrapper for tesseract.js OCR adapter options. |\n| [@nhtio/adk/batteries/specialists/stt](@nhtio/adk/batteries/specialists/stt/index.md) | Environment-neutral aggregate barrel for bundled STT (speech-to-text) specialist batteries. |\n| [@nhtio/adk/batteries/specialists/stt/transformers\\_js](@nhtio/adk/batteries/specialists/stt/transformers_js/index.md) | transformers.js STT adapter battery — dual-environment ONNX Whisper transcription. |\n| [@nhtio/adk/batteries/storage](@nhtio/adk/batteries/storage/index.md) | Environment-neutral aggregate barrel for bundled storage batteries. |\n| [@nhtio/adk/batteries/storage/flydrive](@nhtio/adk/batteries/storage/flydrive/index.md) | Flydrive-backed spooled artifact storage for Node and server runtimes. |\n| [@nhtio/adk/batteries/storage/in\\_memory](@nhtio/adk/batteries/storage/in_memory/index.md) | In-memory spool readers and stores for tests, scripts, and non-durable prototypes. |\n| [@nhtio/adk/batteries/storage/opfs](@nhtio/adk/batteries/storage/opfs/index.md) | Browser-only Origin Private File System storage for spooled artifacts. |\n| [@nhtio/adk/batteries/tools](@nhtio/adk/batteries/tools/index.md) | Aggregate barrel for every pre-constructed bundled tool category. |\n| [@nhtio/adk/batteries/tools/\\_shared](@nhtio/adk/batteries/tools/_shared/index.md) | Cross-battery helpers shared by the configured HTTP tool batteries (SearXNG, Scrapper, …). |\n| [@nhtio/adk/batteries/tools/color](@nhtio/adk/batteries/tools/color/index.md) | Pre-constructed tools for color conversion and palette-oriented calculations. |\n| [@nhtio/adk/batteries/tools/comparison](@nhtio/adk/batteries/tools/comparison/index.md) | Pre-constructed tools for comparing primitive values, arrays, and ranges. |\n| [@nhtio/adk/batteries/tools/data\\_structure](@nhtio/adk/batteries/tools/data_structure/index.md) | Pre-constructed tools for querying, filtering, grouping, and reshaping structured values. |\n| [@nhtio/adk/batteries/tools/datetime\\_extended](@nhtio/adk/batteries/tools/datetime_extended/index.md) | Pre-constructed tools for parsing natural-language dates and business-calendar calculations. |\n| [@nhtio/adk/batteries/tools/datetime\\_math](@nhtio/adk/batteries/tools/datetime_math/index.md) | Pre-constructed tools for ISO datetime arithmetic, differences, and timezone-aware formatting. |\n| [@nhtio/adk/batteries/tools/encoding](@nhtio/adk/batteries/tools/encoding/index.md) | Pre-constructed tools for common text encodings and decoding operations. |\n| [@nhtio/adk/batteries/tools/formatting](@nhtio/adk/batteries/tools/formatting/index.md) | Pre-constructed tools for locale-aware number, list, table, and text formatting. |\n| [@nhtio/adk/batteries/tools/geo\\_basics](@nhtio/adk/batteries/tools/geo_basics/index.md) | Pre-constructed tools for basic geographic distance and coordinate calculations. |\n| [@nhtio/adk/batteries/tools/math](@nhtio/adk/batteries/tools/math/index.md) | Pre-constructed tools for safe arithmetic, expression evaluation, and numeric operations. |\n| [@nhtio/adk/batteries/tools/memory](@nhtio/adk/batteries/tools/memory/index.md) | Pre-constructed CRUD tools for model-visible ADK memory management. |\n| [@nhtio/adk/batteries/tools/parsing](@nhtio/adk/batteries/tools/parsing/index.md) | Pre-constructed tools for parsing CSV, TSV, JSON, YAML, and other structured text formats. |\n| [@nhtio/adk/batteries/tools/retrievables](@nhtio/adk/batteries/tools/retrievables/index.md) | Pre-constructed CRUD tools for model-visible retrievable and RAG-record management. |\n| [@nhtio/adk/batteries/tools/scrapper](@nhtio/adk/batteries/tools/scrapper/index.md) | Factories for configured Scrapper web-extraction tools (article + links). |\n| [@nhtio/adk/batteries/tools/searxng](@nhtio/adk/batteries/tools/searxng/index.md) | Factory for a configured SearXNG metasearch tool. |\n| [@nhtio/adk/batteries/tools/standing\\_instructions](@nhtio/adk/batteries/tools/standing_instructions/index.md) | Pre-constructed CRUD tools for model-visible standing instruction management. |\n| [@nhtio/adk/batteries/tools/statistics](@nhtio/adk/batteries/tools/statistics/index.md) | Pre-constructed tools for descriptive statistics, correlation, quantiles, and numeric summaries. |\n| [@nhtio/adk/batteries/tools/string\\_processing](@nhtio/adk/batteries/tools/string_processing/index.md) | Pre-constructed tools for casing, trimming, normalizing, and transforming strings. |\n| [@nhtio/adk/batteries/tools/structured\\_data](@nhtio/adk/batteries/tools/structured_data/index.md) | Pre-constructed tools for transforming arrays and objects into tables and tabular text. |\n| [@nhtio/adk/batteries/tools/text\\_analysis](@nhtio/adk/batteries/tools/text_analysis/index.md) | Pre-constructed tools for extracting counts, token estimates, and character statistics from text. |\n| [@nhtio/adk/batteries/tools/text\\_comparison](@nhtio/adk/batteries/tools/text_comparison/index.md) | Pre-constructed tools for text diffs, similarity checks, and edit-distance comparisons. |\n| [@nhtio/adk/batteries/tools/time](@nhtio/adk/batteries/tools/time/index.md) | Pre-constructed tools for current time lookup and timezone-aware time formatting. |\n| [@nhtio/adk/batteries/tools/unit\\_conversion](@nhtio/adk/batteries/tools/unit_conversion/index.md) | Pre-constructed tools for converting values across common measurement units. |\n| [@nhtio/adk/batteries/tools/web\\_retrieval](@nhtio/adk/batteries/tools/web_retrieval/index.md) | RAG glue: turn web-search and web-scrape results into `Retrievable` records for a turn. |\n| [@nhtio/adk/batteries/tts](@nhtio/adk/batteries/tts/index.md) | Environment-neutral aggregate barrel for bundled TTS (text-to-speech) batteries. |\n| [@nhtio/adk/batteries/tts/\\_shared](@nhtio/adk/batteries/tts/_shared/index.md) | Structural contracts shared across every TTS (text-to-speech) engine — the model-backed transformers.js engine and the OS-native CLI engine both build on these. |\n| [@nhtio/adk/batteries/tts/native](@nhtio/adk/batteries/tts/native/index.md) | OS-native TTS (text-to-speech) battery — shells out to the OS's own speech binary. |\n| [@nhtio/adk/batteries/tts/native/adapter](@nhtio/adk/batteries/tts/native/adapter/index.md) | OS-native TTS (text-to-speech) adapter battery — shells out to the platform's own speech binary. |\n| [@nhtio/adk/batteries/tts/native/exceptions](@nhtio/adk/batteries/tts/native/exceptions/index.md) | Battery-scoped exception constructors for the OS-native TTS adapter. |\n| [@nhtio/adk/batteries/tts/native/helpers](@nhtio/adk/batteries/tts/native/helpers/index.md) | Pure invocation builders for the OS-native TTS adapter — the platform-specific argument arrays the adapter shells out with. This module is the hermetic, unit-tested core: NO node builtins, NO I/O. |\n| [@nhtio/adk/batteries/tts/native/types](@nhtio/adk/batteries/tts/native/types/index.md) | Option and seam types for the OS-native TTS (text-to-speech) adapter. |\n| [@nhtio/adk/batteries/tts/native/validation](@nhtio/adk/batteries/tts/native/validation/index.md) | Runtime validation schema and wrapper for OS-native TTS adapter options. |\n| [@nhtio/adk/batteries/tts/transformers\\_js](@nhtio/adk/batteries/tts/transformers_js/index.md) | transformers.js TTS adapter battery — dual-environment ONNX text-to-speech. |\n| [@nhtio/adk/batteries/tts/transformers\\_js/adapter](@nhtio/adk/batteries/tts/transformers_js/adapter/index.md) | transformers.js (ONNX, dual-environment) TTS (text-to-speech) adapter battery. |\n| [@nhtio/adk/batteries/tts/transformers\\_js/exceptions](@nhtio/adk/batteries/tts/transformers_js/exceptions/index.md) | Battery-scoped exception constructors for the transformers.js TTS adapter. |\n| [@nhtio/adk/batteries/tts/transformers\\_js/types](@nhtio/adk/batteries/tts/transformers_js/types/index.md) | Option, result, and pipeline types for the transformers.js TTS (text-to-speech) adapter. |\n| [@nhtio/adk/batteries/tts/transformers\\_js/validation](@nhtio/adk/batteries/tts/transformers_js/validation/index.md) | Runtime validation schema and wrapper for transformers.js TTS adapter options. |\n| [@nhtio/adk/batteries/validation](@nhtio/adk/batteries/validation/index.md) | Declarative ordering validation and pipeline guards. |\n| [@nhtio/adk/batteries/validation/exceptions](@nhtio/adk/batteries/validation/exceptions/index.md) | Exceptions raised by the ordering validation battery. |\n| [@nhtio/adk/batteries/validation/types](@nhtio/adk/batteries/validation/types/index.md) | Declarative contracts for validating the ordering of ADK conversation primitives. |\n| [@nhtio/adk/batteries/validation/validation](@nhtio/adk/batteries/validation/validation/index.md) | Runtime validation for ordering guard options. |\n| [@nhtio/adk/batteries/vector](@nhtio/adk/batteries/vector/index.md) | - |\n| [@nhtio/adk/batteries/vector/builder](@nhtio/adk/batteries/vector/builder/index.md) | Knex-style chainable query builder for the vector storage battery. |\n| [@nhtio/adk/batteries/vector/chroma](@nhtio/adk/batteries/vector/chroma/index.md) | - |\n| [@nhtio/adk/batteries/vector/conformance](@nhtio/adk/batteries/vector/conformance/index.md) | Shared conformance suite for vector-store adapters. Drive any adapter through [runVectorStoreConformance](@nhtio/adk/batteries/vector/conformance/functions/runVectorStoreConformance.md) to verify it honours the same contract all shipped adapters do. Public, deep-import-only (`@nhtio/adk/batteries/vector/conformance`). The suite has no test-runner dependency: callers invoke it and await the returned promise from any test framework. |\n| [@nhtio/adk/batteries/vector/contract](@nhtio/adk/batteries/vector/contract/index.md) | - |\n| [@nhtio/adk/batteries/vector/exceptions](@nhtio/adk/batteries/vector/exceptions/index.md) | Battery-scoped exception constructors for vector store adapter failures. |\n| [@nhtio/adk/batteries/vector/factory](@nhtio/adk/batteries/vector/factory/index.md) | - |\n| [@nhtio/adk/batteries/vector/filters](@nhtio/adk/batteries/vector/filters/index.md) | Filter types and evaluator for the vector battery. |\n| [@nhtio/adk/batteries/vector/helpers](@nhtio/adk/batteries/vector/helpers/index.md) | Helper utilities for the vector storage provider battery. |\n| [@nhtio/adk/batteries/vector/in\\_memory](@nhtio/adk/batteries/vector/in_memory/index.md) | - |\n| [@nhtio/adk/batteries/vector/migrate](@nhtio/adk/batteries/vector/migrate/index.md) | Knex-style migration runner for the vector battery. |\n| [@nhtio/adk/batteries/vector/milvus](@nhtio/adk/batteries/vector/milvus/index.md) | - |\n| [@nhtio/adk/batteries/vector/orama](@nhtio/adk/batteries/vector/orama/index.md) | - |\n| [@nhtio/adk/batteries/vector/pgvector](@nhtio/adk/batteries/vector/pgvector/index.md) | - |\n| [@nhtio/adk/batteries/vector/pinecone](@nhtio/adk/batteries/vector/pinecone/index.md) | - |\n| [@nhtio/adk/batteries/vector/plan](@nhtio/adk/batteries/vector/plan/index.md) | Compiled query plans for the vector storage battery. |\n| [@nhtio/adk/batteries/vector/qdrant](@nhtio/adk/batteries/vector/qdrant/index.md) | - |\n| [@nhtio/adk/batteries/vector/retrievable](@nhtio/adk/batteries/vector/retrievable/index.md) | - |\n| [@nhtio/adk/batteries/vector/schema](@nhtio/adk/batteries/vector/schema/index.md) | Knex-style schema builder for the vector battery. |\n| [@nhtio/adk/batteries/vector/sqlite\\_vec](@nhtio/adk/batteries/vector/sqlite_vec/index.md) | - |\n| [@nhtio/adk/batteries/vector/types](@nhtio/adk/batteries/vector/types/index.md) | Type definitions for the vector storage provider battery. |\n| [@nhtio/adk/batteries/vector/validation](@nhtio/adk/batteries/vector/validation/index.md) | Runtime validation schemas and throwing wrappers for the vector battery. |\n| [@nhtio/adk/batteries/vector/vector\\_store\\_constructor](@nhtio/adk/batteries/vector/vector_store_constructor/index.md) | - |\n| [@nhtio/adk/batteries/vector/weaviate](@nhtio/adk/batteries/vector/weaviate/index.md) | - |\n| [@nhtio/adk/common](@nhtio/adk/common/index.md) | Core value classes, runtime primitives, media helpers, and their companion input types. |\n| [@nhtio/adk/dispatch\\_runner](@nhtio/adk/dispatch_runner/index.md) | The LLM execution runner and its dispatch, hook, event, and helper types. |\n| [@nhtio/adk/exceptions](@nhtio/adk/exceptions/index.md) | Core ADK exception classes and reusable runtime error constructors. |\n| [@nhtio/adk/factories](@nhtio/adk/factories/index.md) | Factory helpers for creating configured runtime values and exception classes. |\n| [@nhtio/adk/forge](@nhtio/adk/forge/index.md) | Schema-first tool construction, invocation records, artifact tools, and registries. |\n| [@nhtio/adk/guards](@nhtio/adk/guards/index.md) | Runtime type guards for ADK primitives, contexts, runners, tools, and artifacts. |\n| [@nhtio/adk/lib/helpers/bignum](@nhtio/adk/lib/helpers/bignum/index.md) | Arbitrary-precision numeric helpers for the bundled tools. |\n| [@nhtio/adk/lib/utils/audio](@nhtio/adk/lib/utils/audio/index.md) | Environment-neutral PCM audio primitives shared across the media battery and the on-device specialist batteries. |\n| [@nhtio/adk/lib/utils/retry](@nhtio/adk/lib/utils/retry/index.md) | Environment-neutral retry/backoff/timeout primitives shared across HTTP-backed batteries. |\n| [@nhtio/adk/shims](@nhtio/adk/shims/index.md) | Runtime-binding shims — use `@nhtio/adk` (or any bundle) WITHOUT importing it into your module graph. |\n| [@nhtio/adk/spooled\\_artifact](@nhtio/adk/spooled_artifact/index.md) | Lazy, line-oriented artifact readers and format-aware spooled artifact subclasses. |\n| [@nhtio/adk/turn\\_runner](@nhtio/adk/turn_runner/index.md) | The turn runner orchestration surface and its configuration, event, and middleware types. |\n| [@nhtio/adk/types](@nhtio/adk/types/index.md) | Type-only export surface for raw shapes, callbacks, events, hooks, and internal contracts. |\n| [batteries/artifacts/ecmascript](batteries/artifacts/ecmascript/index.md) | - |\n| [batteries/generation/local\\_diffusion](batteries/generation/local_diffusion/index.md) | - |\n| [batteries/isolation](batteries/isolation/index.md) | - |\n| [batteries/isolation/child\\_process](batteries/isolation/child_process/index.md) | - |\n| [batteries/media/lint](batteries/media/lint/index.md) | - |\n| [batteries/orchestration/approval](batteries/orchestration/approval/index.md) | - |\n| [batteries/orchestration/cells/jexl](batteries/orchestration/cells/jexl/index.md) | - |\n| [batteries/orchestration/cells/lua](batteries/orchestration/cells/lua/index.md) | The Lua predicate cell — an untrusted-script evaluator for `branch` and `select` nodes. |\n| [batteries/orchestration/cells/structured](batteries/orchestration/cells/structured/index.md) | - |\n| [batteries/orchestration/executor](batteries/orchestration/executor/index.md) | - |\n| [batteries/orchestration/outline](batteries/orchestration/outline/index.md) | - |\n| [batteries/orchestration/reason](batteries/orchestration/reason/index.md) | - |\n| [batteries/sandbox/js](batteries/sandbox/js/index.md) | - |\n| [batteries/sandbox/node](batteries/sandbox/node/index.md) | - |\n| [batteries/vector/arangodb](batteries/vector/arangodb/index.md) | - |\n| [batteries/vector/clickhouse](batteries/vector/clickhouse/index.md) | - |\n| [batteries/vector/cloudflare](batteries/vector/cloudflare/index.md) | - |\n| [batteries/vector/couchbase](batteries/vector/couchbase/index.md) | - |\n| [batteries/vector/duckdb](batteries/vector/duckdb/index.md) | - |\n| [batteries/vector/elasticsearch](batteries/vector/elasticsearch/index.md) | - |\n| [batteries/vector/hnswlib](batteries/vector/hnswlib/index.md) | - |\n| [batteries/vector/lancedb](batteries/vector/lancedb/index.md) | - |\n| [batteries/vector/mariadb](batteries/vector/mariadb/index.md) | - |\n| [batteries/vector/meilisearch](batteries/vector/meilisearch/index.md) | - |\n| [batteries/vector/mongodb](batteries/vector/mongodb/index.md) | - |\n| [batteries/vector/neo4j](batteries/vector/neo4j/index.md) | - |\n| [batteries/vector/opensearch](batteries/vector/opensearch/index.md) | - |\n| [batteries/vector/oracle23ai](batteries/vector/oracle23ai/index.md) | - |\n| [batteries/vector/redis](batteries/vector/redis/index.md) | - |\n| [batteries/vector/s3vectors](batteries/vector/s3vectors/index.md) | - |\n| [batteries/vector/solr](batteries/vector/solr/index.md) | - |\n| [batteries/vector/surrealdb](batteries/vector/surrealdb/index.md) | - |\n| [batteries/vector/typesense](batteries/vector/typesense/index.md) | - |\n| [batteries/vector/vespa](batteries/vector/vespa/index.md) | - |\n| [eslint](eslint/index.md) | - |\n| [eslint/rules](eslint/rules/index.md) | - |\n| [eslint/rules/artifact\\_tool\\_forbids\\_artifact\\_constructor](eslint/rules/artifact_tool_forbids_artifact_constructor/index.md) | - |\n| [eslint/rules/no\\_model\\_in\\_tool\\_handler](eslint/rules/no_model_in_tool_handler/index.md) | - |\n| [eslint/rules/require\\_string\\_empty\\_disposition](eslint/rules/require_string_empty_disposition/index.md) | - |\n| [eslint/rules/require\\_validator\\_any\\_required](eslint/rules/require_validator_any_required/index.md) | - |\n| [eslint/rules/thought\\_payload\\_requires\\_replay\\_tag](eslint/rules/thought_payload_requires_replay_tag/index.md) | - |\n| [eslint/rules/token\\_encoding\\_requires\\_context\\_window](eslint/rules/token_encoding_requires_context_window/index.md) | - |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk","title":"@nhtio/adk","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk.md'\ndescription: >-\n Root convenience barrel for the ADK's core runtime values and public\n TypeScript contracts.\n---\n\n# @nhtio/adk\n\nRoot convenience barrel for the ADK's core runtime values and public TypeScript contracts.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [WarningEvent](interfaces/WarningEvent.md) | A non-fatal warning surfaced on a runner's observability bus. Distinct from `error` (which ends the turn/dispatch): a `warning` means \"something degraded but we continued.\" The first consumer is the token-estimation contract — when a real tokenizer throws inside a runner, the estimator degrades to a char-based guesstimate and emits this instead of throwing (see `utils/estimation_context`). The event shape mirrors [LogEvent](dispatch_runner/interfaces/LogEvent.md) so consumers can render both uniformly, with `dispatchId`/`iteration` optional because a warning can also originate from a turn-level scope (no active dispatch). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [TokenEncodingId](type-aliases/TokenEncodingId.md) | A recognised token-encoding identifier: one of the closed [TokenEncoding](common/variables/TokenEncoding.md) built-ins, OR any other string registered via [registerTokenEstimator](functions/registerTokenEstimator.md). |\n| [TokenEstimatorFn](type-aliases/TokenEstimatorFn.md) | A custom token-count function registered for a non-built-in [TokenEncodingId](type-aliases/TokenEncodingId.md) via [registerTokenEstimator](functions/registerTokenEstimator.md). |\n| [TokenizableEvaluator](type-aliases/TokenizableEvaluator.md) | A DYNAMIC Tokenizable value: a function evaluated at prompt-ASSEMBLY time with the live dispatch context, so the wrapped content computes itself coherent with the dispatch it ships in (e.g. a citation instruction that adapts to whether the answer tool survived the subtractive-pass shed). |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------- | ----------------------------------- |\n| [version](variables/version.md) | The current version of the package. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [registerTokenEstimator](functions/registerTokenEstimator.md) | Register (or replace) a [TokenEstimatorFn](type-aliases/TokenEstimatorFn.md) for a custom [TokenEncodingId](type-aliases/TokenEncodingId.md), so [Tokenizable.estimateTokens](common/classes/Tokenizable.md#estimatetokens) can measure it without a core code change. |\n\n## References\n\n### ArtifactTool\n\nRe-exports [ArtifactTool](forge/classes/ArtifactTool.md)\n\n***\n\n### ArtifactToolHandler\n\nRe-exports [ArtifactToolHandler](forge/type-aliases/ArtifactToolHandler.md)\n\n***\n\n### BaseException\n\nRe-exports [BaseException](factories/classes/BaseException.md)\n\n***\n\n### ConduitBytes\n\nRe-exports [ConduitBytes](types/type-aliases/ConduitBytes.md)\n\n***\n\n### DispatchContext\n\nRe-exports [DispatchContext](types/interfaces/DispatchContext.md)\n\n***\n\n### DispatchContextHookRegistrations\n\nRe-exports [DispatchContextHookRegistrations](types/type-aliases/DispatchContextHookRegistrations.md)\n\n***\n\n### DispatchContextHooks\n\nRe-exports [DispatchContextHooks](types/type-aliases/DispatchContextHooks.md)\n\n***\n\n### DispatchEndEvent\n\nRe-exports [DispatchEndEvent](dispatch_runner/interfaces/DispatchEndEvent.md)\n\n***\n\n### DispatchExecutorFn\n\nRe-exports [DispatchExecutorFn](dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### DispatchExecutorHelpers\n\nRe-exports [DispatchExecutorHelpers](dispatch_runner/interfaces/DispatchExecutorHelpers.md)\n\n***\n\n### DispatchExecutorLogChannel\n\nRe-exports [DispatchExecutorLogChannel](dispatch_runner/interfaces/DispatchExecutorLogChannel.md)\n\n***\n\n### DispatchExecutorLogEntry\n\nRe-exports [DispatchExecutorLogEntry](dispatch_runner/interfaces/DispatchExecutorLogEntry.md)\n\n***\n\n### DispatchExecutorLogLevel\n\nRe-exports [DispatchExecutorLogLevel](dispatch_runner/type-aliases/DispatchExecutorLogLevel.md)\n\n***\n\n### DispatchMediaBytesStoreFn\n\nRe-exports [DispatchMediaBytesStoreFn](types/type-aliases/DispatchMediaBytesStoreFn.md)\n\n***\n\n### DispatchMemoryDeleteFn\n\nRe-exports [DispatchMemoryDeleteFn](types/type-aliases/DispatchMemoryDeleteFn.md)\n\n***\n\n### DispatchMemoryMutateFn\n\nRe-exports [DispatchMemoryMutateFn](types/type-aliases/DispatchMemoryMutateFn.md)\n\n***\n\n### DispatchMemoryRetrievalFn\n\nRe-exports [DispatchMemoryRetrievalFn](types/type-aliases/DispatchMemoryRetrievalFn.md)\n\n***\n\n### DispatchMemoryStoreFn\n\nRe-exports [DispatchMemoryStoreFn](types/type-aliases/DispatchMemoryStoreFn.md)\n\n***\n\n### DispatchMessageDeleteFn\n\nRe-exports [DispatchMessageDeleteFn](types/type-aliases/DispatchMessageDeleteFn.md)\n\n***\n\n### DispatchMessageMutateFn\n\nRe-exports [DispatchMessageMutateFn](types/type-aliases/DispatchMessageMutateFn.md)\n\n***\n\n### DispatchMessageRetrievalFn\n\nRe-exports [DispatchMessageRetrievalFn](types/type-aliases/DispatchMessageRetrievalFn.md)\n\n***\n\n### DispatchMessageStoreFn\n\nRe-exports [DispatchMessageStoreFn](types/type-aliases/DispatchMessageStoreFn.md)\n\n***\n\n### DispatchPipelineMiddlewareFn\n\nRe-exports [DispatchPipelineMiddlewareFn](dispatch_runner/type-aliases/DispatchPipelineMiddlewareFn.md)\n\n***\n\n### DispatchRetrievableBytesStoreFn\n\nRe-exports [DispatchRetrievableBytesStoreFn](types/type-aliases/DispatchRetrievableBytesStoreFn.md)\n\n***\n\n### DispatchRunner\n\nRe-exports [DispatchRunner](dispatch_runner/classes/DispatchRunner.md)\n\n***\n\n### DispatchRunnerFunctionalHookRegistrations\n\nRe-exports [DispatchRunnerFunctionalHookRegistrations](dispatch_runner/type-aliases/DispatchRunnerFunctionalHookRegistrations.md)\n\n***\n\n### DispatchRunnerFunctionalHooks\n\nRe-exports [DispatchRunnerFunctionalHooks](dispatch_runner/type-aliases/DispatchRunnerFunctionalHooks.md)\n\n***\n\n### DispatchRunnerObservabilityHookRegistrations\n\nRe-exports [DispatchRunnerObservabilityHookRegistrations](dispatch_runner/type-aliases/DispatchRunnerObservabilityHookRegistrations.md)\n\n***\n\n### DispatchRunnerObservabilityHooks\n\nRe-exports [DispatchRunnerObservabilityHooks](dispatch_runner/type-aliases/DispatchRunnerObservabilityHooks.md)\n\n***\n\n### DispatchStandingInstructionDeleteFn\n\nRe-exports [DispatchStandingInstructionDeleteFn](types/type-aliases/DispatchStandingInstructionDeleteFn.md)\n\n***\n\n### DispatchStandingInstructionMutateFn\n\nRe-exports [DispatchStandingInstructionMutateFn](types/type-aliases/DispatchStandingInstructionMutateFn.md)\n\n***\n\n### DispatchStandingInstructionsRefreshFn\n\nRe-exports [DispatchStandingInstructionsRefreshFn](types/type-aliases/DispatchStandingInstructionsRefreshFn.md)\n\n***\n\n### DispatchStandingInstructionStoreFn\n\nRe-exports [DispatchStandingInstructionStoreFn](types/type-aliases/DispatchStandingInstructionStoreFn.md)\n\n***\n\n### DispatchStartEvent\n\nRe-exports [DispatchStartEvent](dispatch_runner/interfaces/DispatchStartEvent.md)\n\n***\n\n### DispatchThoughtDeleteFn\n\nRe-exports [DispatchThoughtDeleteFn](types/type-aliases/DispatchThoughtDeleteFn.md)\n\n***\n\n### DispatchThoughtMutateFn\n\nRe-exports [DispatchThoughtMutateFn](types/type-aliases/DispatchThoughtMutateFn.md)\n\n***\n\n### DispatchThoughtRetrievalFn\n\nRe-exports [DispatchThoughtRetrievalFn](types/type-aliases/DispatchThoughtRetrievalFn.md)\n\n***\n\n### DispatchThoughtStoreFn\n\nRe-exports [DispatchThoughtStoreFn](types/type-aliases/DispatchThoughtStoreFn.md)\n\n***\n\n### DispatchToolCallDeleteFn\n\nRe-exports [DispatchToolCallDeleteFn](types/type-aliases/DispatchToolCallDeleteFn.md)\n\n***\n\n### DispatchToolCallMutateFn\n\nRe-exports [DispatchToolCallMutateFn](types/type-aliases/DispatchToolCallMutateFn.md)\n\n***\n\n### DispatchToolCallRetrievalFn\n\nRe-exports [DispatchToolCallRetrievalFn](types/type-aliases/DispatchToolCallRetrievalFn.md)\n\n***\n\n### DispatchToolCallStoreFn\n\nRe-exports [DispatchToolCallStoreFn](types/type-aliases/DispatchToolCallStoreFn.md)\n\n***\n\n### DispatchToolsRetrievalFn\n\nRe-exports [DispatchToolsRetrievalFn](types/type-aliases/DispatchToolsRetrievalFn.md)\n\n***\n\n### E\\_ARTIFACT\\_ID\\_COLLISION\n\nRe-exports [E\\_ARTIFACT\\_ID\\_COLLISION](exceptions/variables/E_ARTIFACT_ID_COLLISION.md)\n\n***\n\n### E\\_DISPATCH\\_PIPELINE\\_ERROR\n\nRe-exports [E\\_DISPATCH\\_PIPELINE\\_ERROR](exceptions/variables/E_DISPATCH_PIPELINE_ERROR.md)\n\n***\n\n### E\\_INPUT\\_PIPELINE\\_ERROR\n\nRe-exports [E\\_INPUT\\_PIPELINE\\_ERROR](exceptions/variables/E_INPUT_PIPELINE_ERROR.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_IDENTITY\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_IDENTITY\\_VALUE](exceptions/variables/E_INVALID_INITIAL_IDENTITY_VALUE.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_MEMORY\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_MEMORY\\_VALUE](exceptions/variables/E_INVALID_INITIAL_MEMORY_VALUE.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_MESSAGE\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_MESSAGE\\_VALUE](exceptions/variables/E_INVALID_INITIAL_MESSAGE_VALUE.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_REGISTRY\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_REGISTRY\\_VALUE](exceptions/variables/E_INVALID_INITIAL_REGISTRY_VALUE.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_THOUGHT\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_THOUGHT\\_VALUE](exceptions/variables/E_INVALID_INITIAL_THOUGHT_VALUE.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_TOOL\\_CALL\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_TOOL\\_CALL\\_VALUE](exceptions/variables/E_INVALID_INITIAL_TOOL_CALL_VALUE.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_TOOL\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_TOOL\\_VALUE](exceptions/variables/E_INVALID_INITIAL_TOOL_VALUE.md)\n\n***\n\n### E\\_INVALID\\_INITIAL\\_TURN\\_GATE\\_VALUE\n\nRe-exports [E\\_INVALID\\_INITIAL\\_TURN\\_GATE\\_VALUE](exceptions/variables/E_INVALID_INITIAL_TURN_GATE_VALUE.md)\n\n***\n\n### E\\_INVALID\\_LLM\\_DISPATCH\\_INPUT\n\nRe-exports [E\\_INVALID\\_LLM\\_DISPATCH\\_INPUT](exceptions/variables/E_INVALID_LLM_DISPATCH_INPUT.md)\n\n***\n\n### E\\_INVALID\\_LLM\\_EXECUTION\\_CONTEXT\n\nRe-exports [E\\_INVALID\\_LLM\\_EXECUTION\\_CONTEXT](exceptions/variables/E_INVALID_LLM_EXECUTION_CONTEXT.md)\n\n***\n\n### E\\_INVALID\\_TOOL\\_ARGS\n\nRe-exports [E\\_INVALID\\_TOOL\\_ARGS](exceptions/variables/E_INVALID_TOOL_ARGS.md)\n\n***\n\n### E\\_INVALID\\_TURN\\_CONTEXT\n\nRe-exports [E\\_INVALID\\_TURN\\_CONTEXT](exceptions/variables/E_INVALID_TURN_CONTEXT.md)\n\n***\n\n### E\\_INVALID\\_TURN\\_GATE\\_RESOLUTION\n\nRe-exports [E\\_INVALID\\_TURN\\_GATE\\_RESOLUTION](exceptions/variables/E_INVALID_TURN_GATE_RESOLUTION.md)\n\n***\n\n### E\\_INVALID\\_TURN\\_RUNNER\\_CONFIG\n\nRe-exports [E\\_INVALID\\_TURN\\_RUNNER\\_CONFIG](exceptions/variables/E_INVALID_TURN_RUNNER_CONFIG.md)\n\n***\n\n### E\\_LLM\\_EXECUTION\\_ALREADY\\_SIGNALLED\n\nRe-exports [E\\_LLM\\_EXECUTION\\_ALREADY\\_SIGNALLED](exceptions/variables/E_LLM_EXECUTION_ALREADY_SIGNALLED.md)\n\n***\n\n### E\\_LLM\\_EXECUTION\\_EXECUTOR\\_ERROR\n\nRe-exports [E\\_LLM\\_EXECUTION\\_EXECUTOR\\_ERROR](exceptions/variables/E_LLM_EXECUTION_EXECUTOR_ERROR.md)\n\n***\n\n### E\\_LLM\\_EXECUTION\\_GATE\\_NOT\\_SUPPORTED\n\nRe-exports [E\\_LLM\\_EXECUTION\\_GATE\\_NOT\\_SUPPORTED](exceptions/variables/E_LLM_EXECUTION_GATE_NOT_SUPPORTED.md)\n\n***\n\n### E\\_NO\\_READER\\_RESOLVER\n\nRe-exports [E\\_NO\\_READER\\_RESOLVER](exceptions/variables/E_NO_READER_RESOLVER.md)\n\n***\n\n### E\\_NOT\\_A\\_SPOOL\\_READER\n\nRe-exports [E\\_NOT\\_A\\_SPOOL\\_READER](exceptions/variables/E_NOT_A_SPOOL_READER.md)\n\n***\n\n### E\\_OUTPUT\\_PIPELINE\\_ERROR\n\nRe-exports [E\\_OUTPUT\\_PIPELINE\\_ERROR](exceptions/variables/E_OUTPUT_PIPELINE_ERROR.md)\n\n***\n\n### E\\_PIPELINE\\_SHORT\\_CIRCUITED\n\nRe-exports [E\\_PIPELINE\\_SHORT\\_CIRCUITED](exceptions/variables/E_PIPELINE_SHORT_CIRCUITED.md)\n\n***\n\n### E\\_READER\\_NOT\\_DESCRIBABLE\n\nRe-exports [E\\_READER\\_NOT\\_DESCRIBABLE](exceptions/variables/E_READER_NOT_DESCRIBABLE.md)\n\n***\n\n### E\\_TOKEN\\_ESTIMATOR\\_SHADOWS\\_BUILTIN\n\nRe-exports [E\\_TOKEN\\_ESTIMATOR\\_SHADOWS\\_BUILTIN](exceptions/variables/E_TOKEN_ESTIMATOR_SHADOWS_BUILTIN.md)\n\n***\n\n### E\\_TOKENIZABLE\\_EVALUATOR\\_INVALID\n\nRe-exports [E\\_TOKENIZABLE\\_EVALUATOR\\_INVALID](exceptions/variables/E_TOKENIZABLE_EVALUATOR_INVALID.md)\n\n***\n\n### E\\_TOOL\\_ALREADY\\_REGISTERED\n\nRe-exports [E\\_TOOL\\_ALREADY\\_REGISTERED](exceptions/variables/E_TOOL_ALREADY_REGISTERED.md)\n\n***\n\n### E\\_TOOL\\_DOWNSTREAM\\_ERROR\n\nRe-exports [E\\_TOOL\\_DOWNSTREAM\\_ERROR](exceptions/variables/E_TOOL_DOWNSTREAM_ERROR.md)\n\n***\n\n### E\\_TURN\\_GATE\\_ABORTED\n\nRe-exports [E\\_TURN\\_GATE\\_ABORTED](exceptions/variables/E_TURN_GATE_ABORTED.md)\n\n***\n\n### E\\_TURN\\_GATE\\_TIMEOUT\n\nRe-exports [E\\_TURN\\_GATE\\_TIMEOUT](exceptions/variables/E_TURN_GATE_TIMEOUT.md)\n\n***\n\n### EmitMessageFn\n\nRe-exports [EmitMessageFn](turn_runner/type-aliases/EmitMessageFn.md)\n\n***\n\n### EmitThoughtFn\n\nRe-exports [EmitThoughtFn](turn_runner/type-aliases/EmitThoughtFn.md)\n\n***\n\n### EmitToolCallFn\n\nRe-exports [EmitToolCallFn](turn_runner/type-aliases/EmitToolCallFn.md)\n\n***\n\n### EmitToolExecutionEndFn\n\nRe-exports [EmitToolExecutionEndFn](turn_runner/type-aliases/EmitToolExecutionEndFn.md)\n\n***\n\n### EmitToolExecutionStartFn\n\nRe-exports [EmitToolExecutionStartFn](turn_runner/type-aliases/EmitToolExecutionStartFn.md)\n\n***\n\n### fromFetch\n\nRe-exports [fromFetch](common/functions/fromFetch.md)\n\n***\n\n### fromWebFile\n\nRe-exports [fromWebFile](common/functions/fromWebFile.md)\n\n***\n\n### Identity\n\nRe-exports [Identity](common/classes/Identity.md)\n\n***\n\n### implementsMediaReader\n\nRe-exports [implementsMediaReader](common/functions/implementsMediaReader.md)\n\n***\n\n### implementsSpoolReader\n\nRe-exports [implementsSpoolReader](spooled_artifact/functions/implementsSpoolReader.md)\n\n***\n\n### inMemoryMediaReader\n\nRe-exports [inMemoryMediaReader](common/functions/inMemoryMediaReader.md)\n\n***\n\n### isArtifactTool\n\nRe-exports [isArtifactTool](guards/functions/isArtifactTool.md)\n\n***\n\n### isBaseException\n\nRe-exports [isBaseException](guards/functions/isBaseException.md)\n\n***\n\n### isDispatchContext\n\nRe-exports [isDispatchContext](guards/functions/isDispatchContext.md)\n\n***\n\n### isDispatchRunner\n\nRe-exports [isDispatchRunner](guards/functions/isDispatchRunner.md)\n\n***\n\n### isError\n\nRe-exports [isError](guards/functions/isError.md)\n\n***\n\n### isIdentity\n\nRe-exports [isIdentity](guards/functions/isIdentity.md)\n\n***\n\n### isInstanceOf\n\nRe-exports [isInstanceOf](guards/functions/isInstanceOf.md)\n\n***\n\n### isMedia\n\nRe-exports [isMedia](common/functions/isMedia.md)\n\n***\n\n### isMemory\n\nRe-exports [isMemory](guards/functions/isMemory.md)\n\n***\n\n### isMessage\n\nRe-exports [isMessage](guards/functions/isMessage.md)\n\n***\n\n### isObject\n\nRe-exports [isObject](guards/functions/isObject.md)\n\n***\n\n### isRegistry\n\nRe-exports [isRegistry](guards/functions/isRegistry.md)\n\n***\n\n### isSpooledArtifact\n\nRe-exports [isSpooledArtifact](guards/functions/isSpooledArtifact.md)\n\n***\n\n### isSpooledArtifactConstructor\n\nRe-exports [isSpooledArtifactConstructor](guards/functions/isSpooledArtifactConstructor.md)\n\n***\n\n### isSpooledJsonArtifact\n\nRe-exports [isSpooledJsonArtifact](guards/functions/isSpooledJsonArtifact.md)\n\n***\n\n### isSpooledMarkdownArtifact\n\nRe-exports [isSpooledMarkdownArtifact](guards/functions/isSpooledMarkdownArtifact.md)\n\n***\n\n### isThought\n\nRe-exports [isThought](guards/functions/isThought.md)\n\n***\n\n### isTokenizable\n\nRe-exports [isTokenizable](guards/functions/isTokenizable.md)\n\n***\n\n### isTool\n\nRe-exports [isTool](guards/functions/isTool.md)\n\n***\n\n### isToolCall\n\nRe-exports [isToolCall](guards/functions/isToolCall.md)\n\n***\n\n### isToolRegistry\n\nRe-exports [isToolRegistry](guards/functions/isToolRegistry.md)\n\n***\n\n### isTurnContext\n\nRe-exports [isTurnContext](guards/functions/isTurnContext.md)\n\n***\n\n### isTurnGate\n\nRe-exports [isTurnGate](guards/functions/isTurnGate.md)\n\n***\n\n### isTurnRunner\n\nRe-exports [isTurnRunner](guards/functions/isTurnRunner.md)\n\n***\n\n### IterationEndEvent\n\nRe-exports [IterationEndEvent](dispatch_runner/interfaces/IterationEndEvent.md)\n\n***\n\n### IterationStartEvent\n\nRe-exports [IterationStartEvent](dispatch_runner/interfaces/IterationStartEvent.md)\n\n***\n\n### JsonArtifactFormat\n\nRe-exports [JsonArtifactFormat](spooled_artifact/type-aliases/JsonArtifactFormat.md)\n\n***\n\n### LogEvent\n\nRe-exports [LogEvent](dispatch_runner/interfaces/LogEvent.md)\n\n***\n\n### MarkdownCodeEntry\n\nRe-exports [MarkdownCodeEntry](spooled_artifact/interfaces/MarkdownCodeEntry.md)\n\n***\n\n### MarkdownHeadingEntry\n\nRe-exports [MarkdownHeadingEntry](spooled_artifact/interfaces/MarkdownHeadingEntry.md)\n\n***\n\n### MarkdownSection\n\nRe-exports [MarkdownSection](spooled_artifact/interfaces/MarkdownSection.md)\n\n***\n\n### Media\n\nRe-exports [Media](common/classes/Media.md)\n\n***\n\n### MediaBytesStoreFn\n\nRe-exports [MediaBytesStoreFn](types/type-aliases/MediaBytesStoreFn.md)\n\n***\n\n### MediaKind\n\nRe-exports [MediaKind](common/type-aliases/MediaKind.md)\n\n***\n\n### MediaModalityHazard\n\nRe-exports [MediaModalityHazard](common/type-aliases/MediaModalityHazard.md)\n\n***\n\n### MediaReader\n\nRe-exports [MediaReader](common/interfaces/MediaReader.md)\n\n***\n\n### mediaReaderSchema\n\nRe-exports [mediaReaderSchema](common/variables/mediaReaderSchema.md)\n\n***\n\n### MediaStashEntry\n\nRe-exports [MediaStashEntry](common/interfaces/MediaStashEntry.md)\n\n***\n\n### MediaTrustTier\n\nRe-exports [MediaTrustTier](common/type-aliases/MediaTrustTier.md)\n\n***\n\n### Memory\n\nRe-exports [Memory](common/classes/Memory.md)\n\n***\n\n### MemoryDeleteFn\n\nRe-exports [MemoryDeleteFn](types/type-aliases/MemoryDeleteFn.md)\n\n***\n\n### MemoryMutateFn\n\nRe-exports [MemoryMutateFn](types/type-aliases/MemoryMutateFn.md)\n\n***\n\n### MemoryRetrievalFn\n\nRe-exports [MemoryRetrievalFn](types/type-aliases/MemoryRetrievalFn.md)\n\n***\n\n### MemoryStoreFn\n\nRe-exports [MemoryStoreFn](types/type-aliases/MemoryStoreFn.md)\n\n***\n\n### MergeOptions\n\nRe-exports [MergeOptions](common/interfaces/MergeOptions.md)\n\n***\n\n### Message\n\nRe-exports [Message](common/classes/Message.md)\n\n***\n\n### MessageDeleteFn\n\nRe-exports [MessageDeleteFn](types/type-aliases/MessageDeleteFn.md)\n\n***\n\n### MessageMutateFn\n\nRe-exports [MessageMutateFn](types/type-aliases/MessageMutateFn.md)\n\n***\n\n### MessageRetrievalFn\n\nRe-exports [MessageRetrievalFn](types/type-aliases/MessageRetrievalFn.md)\n\n***\n\n### MessageRole\n\nRe-exports [MessageRole](common/type-aliases/MessageRole.md)\n\n***\n\n### MessageStoreFn\n\nRe-exports [MessageStoreFn](types/type-aliases/MessageStoreFn.md)\n\n***\n\n### OpenGateFn\n\nRe-exports [OpenGateFn](turn_runner/type-aliases/OpenGateFn.md)\n\n***\n\n### RawArtifactTool\n\nRe-exports [RawArtifactTool](forge/interfaces/RawArtifactTool.md)\n\n***\n\n### RawDispatchContext\n\nRe-exports [RawDispatchContext](types/interfaces/RawDispatchContext.md)\n\n***\n\n### RawDispatchRunnerInput\n\nRe-exports [RawDispatchRunnerInput](dispatch_runner/interfaces/RawDispatchRunnerInput.md)\n\n***\n\n### RawIdentity\n\nRe-exports [RawIdentity](common/interfaces/RawIdentity.md)\n\n***\n\n### RawMedia\n\nRe-exports [RawMedia](common/interfaces/RawMedia.md)\n\n***\n\n### RawMemory\n\nRe-exports [RawMemory](common/interfaces/RawMemory.md)\n\n***\n\n### RawMessage\n\nRe-exports [RawMessage](common/interfaces/RawMessage.md)\n\n***\n\n### RawThought\n\nRe-exports [RawThought](common/interfaces/RawThought.md)\n\n***\n\n### RawTool\n\nRe-exports [RawTool](forge/interfaces/RawTool.md)\n\n***\n\n### RawToolCall\n\nRe-exports [RawToolCall](forge/interfaces/RawToolCall.md)\n\n***\n\n### RawTurnContext\n\nRe-exports [RawTurnContext](types/interfaces/RawTurnContext.md)\n\n***\n\n### RawTurnGate\n\nRe-exports [RawTurnGate](common/interfaces/RawTurnGate.md)\n\n***\n\n### Registry\n\nRe-exports [Registry](common/classes/Registry.md)\n\n***\n\n### ResolvedTurnContext\n\nRe-exports [ResolvedTurnContext](types/type-aliases/ResolvedTurnContext.md)\n\n***\n\n### ResolvedTurnRunnerConfig\n\nRe-exports [ResolvedTurnRunnerConfig](turn_runner/type-aliases/ResolvedTurnRunnerConfig.md)\n\n***\n\n### Retrievable\n\nRe-exports [Retrievable](common/classes/Retrievable.md)\n\n***\n\n### RetrievableBytesStoreFn\n\nRe-exports [RetrievableBytesStoreFn](types/type-aliases/RetrievableBytesStoreFn.md)\n\n***\n\n### RetrievableDeleteFn\n\nRe-exports [RetrievableDeleteFn](types/type-aliases/RetrievableDeleteFn.md)\n\n***\n\n### RetrievableMutateFn\n\nRe-exports [RetrievableMutateFn](types/type-aliases/RetrievableMutateFn.md)\n\n***\n\n### RetrievableRetrievalFn\n\nRe-exports [RetrievableRetrievalFn](types/type-aliases/RetrievableRetrievalFn.md)\n\n***\n\n### RetrievableStoreFn\n\nRe-exports [RetrievableStoreFn](types/type-aliases/RetrievableStoreFn.md)\n\n***\n\n### SerializedMedia\n\nRe-exports [SerializedMedia](common/interfaces/SerializedMedia.md)\n\n***\n\n### SpooledArtifact\n\nRe-exports [SpooledArtifact](spooled_artifact/classes/SpooledArtifact.md)\n\n***\n\n### SpooledArtifactConstructor\n\nRe-exports [SpooledArtifactConstructor](forge/type-aliases/SpooledArtifactConstructor.md)\n\n***\n\n### SpooledJsonArtifact\n\nRe-exports [SpooledJsonArtifact](spooled_artifact/classes/SpooledJsonArtifact.md)\n\n***\n\n### SpooledMarkdownArtifact\n\nRe-exports [SpooledMarkdownArtifact](spooled_artifact/classes/SpooledMarkdownArtifact.md)\n\n***\n\n### SpoolReader\n\nRe-exports [SpoolReader](spooled_artifact/interfaces/SpoolReader.md)\n\n***\n\n### StandingInstructionDeleteFn\n\nRe-exports [StandingInstructionDeleteFn](types/type-aliases/StandingInstructionDeleteFn.md)\n\n***\n\n### StandingInstructionMutateFn\n\nRe-exports [StandingInstructionMutateFn](types/type-aliases/StandingInstructionMutateFn.md)\n\n***\n\n### StandingInstructionsRefreshFn\n\nRe-exports [StandingInstructionsRefreshFn](types/type-aliases/StandingInstructionsRefreshFn.md)\n\n***\n\n### StandingInstructionStoreFn\n\nRe-exports [StandingInstructionStoreFn](types/type-aliases/StandingInstructionStoreFn.md)\n\n***\n\n### Thought\n\nRe-exports [Thought](common/classes/Thought.md)\n\n***\n\n### ThoughtDeleteFn\n\nRe-exports [ThoughtDeleteFn](types/type-aliases/ThoughtDeleteFn.md)\n\n***\n\n### ThoughtMutateFn\n\nRe-exports [ThoughtMutateFn](types/type-aliases/ThoughtMutateFn.md)\n\n***\n\n### ThoughtRetrievalFn\n\nRe-exports [ThoughtRetrievalFn](types/type-aliases/ThoughtRetrievalFn.md)\n\n***\n\n### ThoughtStoreFn\n\nRe-exports [ThoughtStoreFn](types/type-aliases/ThoughtStoreFn.md)\n\n***\n\n### TokenEncoding\n\nRe-exports [TokenEncoding](common/variables/TokenEncoding.md)\n\n***\n\n### Tokenizable\n\nRe-exports [Tokenizable](common/classes/Tokenizable.md)\n\n***\n\n### Tool\n\nRe-exports [Tool](forge/classes/Tool.md)\n\n***\n\n### ToolCall\n\nRe-exports [ToolCall](forge/classes/ToolCall.md)\n\n***\n\n### ToolCallDeleteFn\n\nRe-exports [ToolCallDeleteFn](types/type-aliases/ToolCallDeleteFn.md)\n\n***\n\n### ToolCallMutateFn\n\nRe-exports [ToolCallMutateFn](types/type-aliases/ToolCallMutateFn.md)\n\n***\n\n### ToolCallRetrievalFn\n\nRe-exports [ToolCallRetrievalFn](types/type-aliases/ToolCallRetrievalFn.md)\n\n***\n\n### ToolCallStoreFn\n\nRe-exports [ToolCallStoreFn](types/type-aliases/ToolCallStoreFn.md)\n\n***\n\n### ToolExecutionEndEvent\n\nRe-exports [ToolExecutionEndEvent](turn_runner/interfaces/ToolExecutionEndEvent.md)\n\n***\n\n### ToolExecutionStartEvent\n\nRe-exports [ToolExecutionStartEvent](turn_runner/interfaces/ToolExecutionStartEvent.md)\n\n***\n\n### ToolHandler\n\nRe-exports [ToolHandler](forge/type-aliases/ToolHandler.md)\n\n***\n\n### ToolMethodDescriptor\n\nRe-exports [ToolMethodDescriptor](common/interfaces/ToolMethodDescriptor.md)\n\n***\n\n### ToolRegistry\n\nRe-exports [ToolRegistry](forge/classes/ToolRegistry.md)\n\n***\n\n### ToolsRetrievalFn\n\nRe-exports [ToolsRetrievalFn](types/type-aliases/ToolsRetrievalFn.md)\n\n***\n\n### TurnContext\n\nRe-exports [TurnContext](types/interfaces/TurnContext.md)\n\n***\n\n### TurnEndEvent\n\nRe-exports [TurnEndEvent](turn_runner/interfaces/TurnEndEvent.md)\n\n***\n\n### TurnEvent\n\nRe-exports [TurnEvent](turn_runner/type-aliases/TurnEvent.md)\n\n***\n\n### TurnEventListener\n\nRe-exports [TurnEventListener](turn_runner/type-aliases/TurnEventListener.md)\n\n***\n\n### TurnEvents\n\nRe-exports [TurnEvents](turn_runner/type-aliases/TurnEvents.md)\n\n***\n\n### TurnGate\n\nRe-exports [TurnGate](common/interfaces/TurnGate.md)\n\n***\n\n### TurnGateClosedEvent\n\nRe-exports [TurnGateClosedEvent](turn_runner/interfaces/TurnGateClosedEvent.md)\n\n***\n\n### TurnObservabilityEvent\n\nRe-exports [TurnObservabilityEvent](turn_runner/type-aliases/TurnObservabilityEvent.md)\n\n***\n\n### TurnObservabilityEventListener\n\nRe-exports [TurnObservabilityEventListener](turn_runner/type-aliases/TurnObservabilityEventListener.md)\n\n***\n\n### TurnObservabilityEvents\n\nRe-exports [TurnObservabilityEvents](turn_runner/type-aliases/TurnObservabilityEvents.md)\n\n***\n\n### TurnPipelineMiddlewareFn\n\nRe-exports [TurnPipelineMiddlewareFn](turn_runner/type-aliases/TurnPipelineMiddlewareFn.md)\n\n***\n\n### TurnRunner\n\nRe-exports [TurnRunner](turn_runner/classes/TurnRunner.md)\n\n***\n\n### TurnRunnerConfig\n\nRe-exports [TurnRunnerConfig](turn_runner/interfaces/TurnRunnerConfig.md)\n\n***\n\n### TurnStartEvent\n\nRe-exports [TurnStartEvent](turn_runner/interfaces/TurnStartEvent.md)\n\n***\n\n### TurnStreamableContent\n\nRe-exports [TurnStreamableContent](turn_runner/interfaces/TurnStreamableContent.md)\n\n***\n\n### TurnToolCallContent\n\nRe-exports [TurnToolCallContent](turn_runner/interfaces/TurnToolCallContent.md)\n\n***\n\n### ValidationException\n\nRe-exports [ValidationException](exceptions/classes/ValidationException.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries","title":"@nhtio/adk/batteries","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries.md'\ndescription: >-\n Opt-in aggregate barrel for bundled ADK batteries across LLMs, tools, and\n storage.\n---\n\n# @nhtio/adk/batteries\n\nOpt-in aggregate barrel for bundled ADK batteries across LLMs, tools, and storage.\n\n## Remarks\n\nOpt-in bundled tools that ship with the ADK. This barrel is **not** re-exported from the\nroot entry — consumers must explicitly `import { ... } from '@nhtio/adk/batteries'` to use\nthese tools, and consumers who do not import this barrel pay nothing in their bundle.\n\nThe barrel is a plain re-export of every category. Finer-grained subpaths exist for\ntree-shaking:\n\n* `@nhtio/adk/batteries/tools` — every tool, identical to this barrel\n* `@nhtio/adk/batteries/tools/` — just one category (e.g. `math`, `color`,\n `datetime_math`)\n\nEach export is a pre-constructed [@nhtio/adk!Tool](../forge/classes/Tool.md) instance ready to be registered with a\n`ToolRegistry`. The ADK has no opinion on storage — the consumer's executor middleware is\nresponsible for persisting tool output and assembling the `ToolCall.results` field using each\ntool's `artifactConstructor`.\n\nNeed every bundled tool? `import * as batteries from '@nhtio/adk/batteries'` then\n`Object.values(batteries)`. Need just one category? Deep-import the subpath and pay only for\nthat bundle.\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [GuestEndpoint](classes/GuestEndpoint.md) | Guest-side correlation engine over a [PortLike](interfaces/PortLike.md). Owns per-call `AbortController`s (aborted on an inbound `abort`/`stream:cancel` envelope) and exposes `settleCall`/`pushDelta`/`endStream`/ `errorStream` for `serve.ts` to report outcomes back across the wire. |\n| [HostEndpoint](classes/HostEndpoint.md) | Host-side correlation engine over a [PortLike](interfaces/PortLike.md). Queues calls/stream-starts made before `ready` and flushes them in order once it arrives; tracks in-flight calls (one-shot, resolved/rejected by a `result` envelope) and open streams (persistent, fed by `stream:delta`/`stream:end`/`stream:error` until closed). `terminate()` rejects every in-flight call and errors every open stream with a caller-supplied reason (the message text `host.ts` uses is `E_ISOLATED_TERMINATED`'s message). |\n| [TransformersJsSttAdapter](classes/TransformersJsSttAdapter.md) | STT adapter for transformers.js's automatic-speech-recognition (Whisper-family) pipeline. |\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [BrowserErrorEvent](interfaces/BrowserErrorEvent.md) | Minimal subset of the DOM `ErrorEvent` interface this module touches — fired on a `Worker` instance when an uncaught error escapes the worker's top-level scope. |\n| [BrowserMessageEvent](interfaces/BrowserMessageEvent.md) | Minimal subset of the DOM `MessageEvent` interface this module touches. |\n| [BrowserWorker](interfaces/BrowserWorker.md) | Minimal subset of the DOM `Worker` interface this module touches. Structurally compatible with the real DOM `Worker` — callers (and [WorkerResolver](type-aliases/WorkerResolver.md) implementations) pass/construct real `Worker` instances directly. |\n| [BrowserWorkerOptions](interfaces/BrowserWorkerOptions.md) | Minimal subset of the DOM `WorkerOptions` dictionary this module forwards verbatim to `new Worker(url, options)` — used ONLY for the `string | URL`spawn form (a caller-supplied [WorkerResolver](type-aliases/WorkerResolver.md) constructs its own`Worker` however it likes, this dictionary never applies there). Classic scripts are the default (`type` omitted) — matching this repo's own LiteRT-LM Worker prototype (`docs/.vitepress/theme/components/agent/litert_lm_worker_proxy.ts`), which deliberately avoids `{ type: 'module' }`because Emscripten-style glue calls`importScripts()`, illegal in a module worker. Pass `{ type: 'module' }` explicitly when the guest script is an ES module. |\n| [ChatCompletionsRetryConfig](interfaces/ChatCompletionsRetryConfig.md) | Retry/backoff configuration for a Chat-family battery's HTTP requests. |\n| [ChatCompletionsTool](interfaces/ChatCompletionsTool.md) | Wire shape of a single function tool advertised to the model — identical for OpenAI Chat Completions and Ollama. |\n| [CrashInfo](interfaces/CrashInfo.md) | Information about a crashed isolated guest, reported via `IsolationTransport.onCrash`. |\n| [CrashPolicy](interfaces/CrashPolicy.md) | A sliding-window crash-escalation decider, as returned by [createCrashPolicy](functions/createCrashPolicy.md). |\n| [CrashPolicyOptions](interfaces/CrashPolicyOptions.md) | Options accepted by [createCrashPolicy](functions/createCrashPolicy.md). |\n| [DescriptionLike](interfaces/DescriptionLike.md) | Structural shape of a validator/Joi `describe()` output, as consumed by the JSON-Schema renderer. A loose superset — only the fields the renderer reads are typed; the index signature carries everything else through untouched. |\n| [EncoderModule](interfaces/EncoderModule.md) | The slice of `@nhtio/encoder`'s API surface this codec uses. Deliberately non-generic (`unknown` in, `unknown` out) — this codec always encodes/decodes values whose shape it cannot statically know, so the real encoder's ``-constrained signature is narrowed away via defaultEncoderLoader's adapter rather than reflected here. |\n| [EventDescriptor](interfaces/EventDescriptor.md) | An event descriptor produced by [event](functions/event.md). Phantom-typed like [MethodDescriptor](interfaces/MethodDescriptor.md). |\n| [GeneratedMediaOutput](interfaces/GeneratedMediaOutput.md) | One piece of media a model GENERATED as turn output — the descriptor a [MediaOutputExtractorFn](llm/transformers_js/type-aliases/MediaOutputExtractorFn.md) returns for the adapter to persist + attach to the assistant [@nhtio/adk!Message](../common/classes/Message.md). |\n| [GuestEndpointHooks](interfaces/GuestEndpointHooks.md) | Hooks [GuestEndpoint](classes/GuestEndpoint.md) invokes for the guest server (`serve.ts`) to react to. |\n| [HostEndpointHooks](interfaces/HostEndpointHooks.md) | Callback surface for observing host-endpoint lifecycle and guest-originated events. |\n| [IsolatedFunctionHandle](interfaces/IsolatedFunctionHandle.md) | The live handle returned by [isolateFunction](functions/isolateFunction.md). |\n| [IsolatedService](interfaces/IsolatedService.md) | The host-side handle `createIsolatedService` returns. |\n| [IsolatedServiceOptions](interfaces/IsolatedServiceOptions.md) | Options accepted by [createIsolatedService](functions/createIsolatedService.md). |\n| [IsolatedServiceSpec](interfaces/IsolatedServiceSpec.md) | A fully-resolved isolated-service spec, as returned by [defineIsolatedService](functions/defineIsolatedService.md). Consumed by both `createIsolatedService` (host.ts) and `serveIsolated` (serve.ts) to type-check the facade / implementation respectively, and read at runtime for wire validation (method/stream/event name lookups). |\n| [IsolatedServiceSpecInput](interfaces/IsolatedServiceSpecInput.md) | Input shape accepted by [defineIsolatedService](functions/defineIsolatedService.md). |\n| [IsolateFunctionOptions](interfaces/IsolateFunctionOptions.md) | Options accepted by [isolateFunction](functions/isolateFunction.md). |\n| [IsolationCallContext](interfaces/IsolationCallContext.md) | Trailing parameter a guest method implementation receives when its descriptor declared `{ signal: true }`. Carries the AbortSignal the host aborts to cancel this in-flight call. |\n| [IsolationObservabilityHooks](interfaces/IsolationObservabilityHooks.md) | The opt-in observability option block mixed into `createIsolatedService`/`serveIsolated` options. Every reported phase fires [onIsolation](interfaces/IsolationObservabilityHooks.md#property-onisolation) (the firehose) AND its matching per-phase-group hook; subscribe to either or both. All optional — omitting them leaves behavior byte-for-byte unchanged. |\n| [IsolationReport](interfaces/IsolationReport.md) | A single normalized isolation observability report. Every phase stamps `phase`/`at`/`spawnCount` plus its own extra fields (see the per-phase hook docs on [IsolationObservabilityHooks](interfaces/IsolationObservabilityHooks.md) for which extra fields a given `phase` populates). |\n| [IsolationTransport](interfaces/IsolationTransport.md) | The environment-specific spawn/lifecycle duck a host-side transport implements — the Web Worker and Node child\\_process transports each provide one; `createIsolatedService` (host.ts) drives only this interface, never a concrete Worker/ChildProcess type. |\n| [JsonSchema](interfaces/JsonSchema.md) | The subset of JSON Schema that Chat-family tool/function `parameters` accept, as emitted by [ChatHelpersCommon.descriptionToChatCompletionsJsonSchema](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema). The index signature allows extra keywords to pass through to the wire. |\n| [MemoryAttrs](interfaces/MemoryAttrs.md) | Attribute bag rendered onto a memory block. |\n| [MethodDescriptor](interfaces/MethodDescriptor.md) | A method descriptor produced by [method](functions/method.md). Carries the declared runtime options plus phantom (never-constructed) fields that pin down the argument tuple and return type for the mapped types below — reading `descriptor.__args`/`descriptor.__result` at the TYPE level only, never at runtime. |\n| [MethodOptions](interfaces/MethodOptions.md) | Runtime options accepted by [method](functions/method.md). |\n| [PortLike](interfaces/PortLike.md) | The minimal message-passing duck the wire protocol (`protocol.ts`) is built over. A `Worker` / `MessagePort` (`post` = `postMessage`, `onMessage` wraps `addEventListener('message', ...)`) and a Node `ChildProcess` / `process` (`post` = `.send`, `onMessage` wraps `.on('message', ...)`) both satisfy this structurally — the shared protocol is exercised against linked in-memory fake ports; the browser and Node transports wire it to the real transports. |\n| [PromptAssembledObservation](interfaces/PromptAssembledObservation.md) | One observation of the fully-assembled request a battery is about to send TO the model, fired the instant assembly completes and BEFORE the engine/HTTP dispatch. It is the mirror of [RawGenerationObservation](interfaces/RawGenerationObservation.md): that seam exposes the raw text coming back FROM the model; this one exposes the raw request going TO it. Together they let you read ground truth at both ends of the wire — e.g. to settle whether a \"smart quote\" in a rendered answer came from the model itself or from a downstream markdown renderer, you inspect the bytes here, not the DOM. |\n| [RawGenerationObservation](interfaces/RawGenerationObservation.md) | One observation of a battery's raw model output for a single completed generation, fired the instant the full text is in hand — AFTER envelope-token stripping + reasoning/tool-call parsing, but BEFORE the parsed result is persisted. The whole point is to expose the gap between what the model literally emitted (`rawText`) and what the battery managed to extract (`cleanedText` / `toolCalls` / `reasoning`): when a small on-device model emits a tool call in a shape no parser matches, the call silently leaks into `cleanedText` as prose, and this is the ONLY seam where that is visible. |\n| [RetrievableAttrs](interfaces/RetrievableAttrs.md) | Attribute bag rendered onto a retrievable block. |\n| [ScrapperBaseConfig](interfaces/ScrapperBaseConfig.md) | Configuration common to every Scrapper factory. `A` is the accepted `artifact` resolver type. |\n| [ScrapperRequestContext](interfaces/ScrapperRequestContext.md) | Mutable context handed to each input-pipeline stage **before** the HTTP request is sent. Identical for both verbs. |\n| [ScrapperResponseContext](interfaces/ScrapperResponseContext.md) | Mutable context handed to each output-pipeline stage **after** the response JSON is parsed. |\n| [ServeIsolatedOptions](interfaces/ServeIsolatedOptions.md) | Options accepted by [serveIsolated](functions/serveIsolated.md)/[serveIsolatedOverPort](functions/serveIsolatedOverPort.md). |\n| [SpawnIsolatedOptions](interfaces/SpawnIsolatedOptions.md) | Options accepted by [spawnIsolated](functions/spawnIsolated.md)/[createWorkerTransport](functions/createWorkerTransport.md), layered on top of [IsolatedServiceOptions](interfaces/IsolatedServiceOptions.md). |\n| [StandingInstructionAttrs](interfaces/StandingInstructionAttrs.md) | Attribute bag rendered onto a standing-instruction block. |\n| [StreamDescriptor](interfaces/StreamDescriptor.md) | A stream descriptor produced by [stream](functions/stream.md). Phantom-typed like [MethodDescriptor](interfaces/MethodDescriptor.md). |\n| [StreamHandle](interfaces/StreamHandle.md) | Trailing parameter every guest stream implementation receives (regardless of declared options). Carries the AbortSignal the host aborts (via `stream:cancel`) when the reader cancels the host-side `ReadableStream`. |\n| [StreamOptions](interfaces/StreamOptions.md) | Runtime options accepted by [stream](functions/stream.md). |\n| [SttSegment](interfaces/SttSegment.md) | A single recognized speech segment with its time bounds and text. |\n| [ThoughtAttrs](interfaces/ThoughtAttrs.md) | Attribute bag rendered onto a thought block. |\n| [TranscribeOptions](interfaces/TranscribeOptions.md) | Per-call options for [TransformersJsSttAdapter.transcribe](classes/TransformersJsSttAdapter.md#transcribe). |\n| [TranscribeResult](interfaces/TranscribeResult.md) | The result of a [transcribe](interfaces/TranscribeOptions.md) call. |\n| [TransformersJsSttAdapterOptions](interfaces/TransformersJsSttAdapterOptions.md) | Constructor options for the transformers.js STT adapter. |\n| [TrustedContentAttrs](interfaces/TrustedContentAttrs.md) | Attribute bag rendered onto the trust envelope that wraps trusted (first-party) content. |\n| [UntrustedContentAttrs](interfaces/UntrustedContentAttrs.md) | Attribute bag rendered onto the trust envelope that wraps untrusted (third-party) content. |\n| [WebLLMChatCompletionsAdapterOptions](interfaces/WebLLMChatCompletionsAdapterOptions.md) | Configuration options for the in-browser WebLLM Chat Completions adapter — the OpenAI options minus the network-transport fields (no HTTP is involved), plus WebLLM-specific engine controls. |\n| [WireError](interfaces/WireError.md) | An error as it crosses the wire. `message`/`name`/`stack` are ALWAYS present baseline string fields (never omitted, regardless of encoder availability) so error-classification-by-message-signature always works even when the encoder is unavailable or fails to decode. `nhtio` carries the `@nhtio/encoder`-encoded original `Error` instance when BOTH sides advertised `encoderAvailable` on `ready` — the receiving side decodes it for full fidelity (custom error subclasses, extra properties) and falls back silently to the baseline fields on any decode failure. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | ----- | ----- | --- |\n| [ChatCompletionsBucketLabel](type-aliases/ChatCompletionsBucketLabel.md) | Name of a system-prompt content bucket whose render order is configurable. |\n| [ChatCompletionsBucketOrder](type-aliases/ChatCompletionsBucketOrder.md) | Ordered list of [ChatCompletionsBucketLabel](type-aliases/ChatCompletionsBucketLabel.md)s controlling the sequence in which content buckets are assembled into the prompt. |\n| [CodecMode](type-aliases/CodecMode.md) | Serialization strategy for a single method/stream call's arguments — see `codec.ts` for the tiered codec this selects. `'auto'` (the default when omitted) traverses each argument and escalates only the exotic leaves it finds; `'raw'` skips traversal entirely (trust the caller — cheapest, but unsafe for values containing functions/Errors/custom-encodables); `'encoded'` whole-value encodes every argument via the optional `@nhtio/encoder` peer. A caller may also inject a literal `{ encode, decode }` pair to bring their own codec, bypassing both the traversal and the encoder peer entirely. |\n| [CrashVerdict](type-aliases/CrashVerdict.md) | The escalation [CrashPolicy.record](interfaces/CrashPolicy.md#record) decided for a single crash event. |\n| [CreateTransformersJsSttPipeline](type-aliases/CreateTransformersJsSttPipeline.md) | Factory for lazily creating an automatic-speech-recognition pipeline. Defaults to a dynamic import of `@huggingface/transformers` + `pipeline('automatic-speech-recognition', …)`; override to inject a pre-built pipeline or a test double. |\n| [EventMap](type-aliases/EventMap.md) | The shape of an `events` map passed to [defineIsolatedService](functions/defineIsolatedService.md): unsolicited-notification descriptors keyed by channel name. |\n| [GuestToHostEnvelope](type-aliases/GuestToHostEnvelope.md) | Guest → host envelopes. |\n| [HostToGuestEnvelope](type-aliases/HostToGuestEnvelope.md) | Host → guest envelopes. |\n| [IsolatedEmitter](type-aliases/IsolatedEmitter.md) | Emit an event declared on a spec — the guest-side capability handed alongside the implementation. |\n| [IsolatedEventListener](type-aliases/IsolatedEventListener.md) | A typed event-channel listener for the host-side `IsolatedService.on(channel, fn)`. |\n| [IsolatedFacade](type-aliases/IsolatedFacade.md) | The host-side callable facade a [IsolatedServiceSpec](interfaces/IsolatedServiceSpec.md) maps to — `.api` on the `IsolatedService` returned by `createIsolatedService`. Every declared method becomes an async function returning `Promise` and accepting an optional trailing `AbortSignal` (accepted uniformly regardless of whether the method declared `{ signal: true }` — a signal handed to a method that didn't opt in is simply not forwarded to the guest). Every declared stream becomes a synchronous function returning a `ReadableStream` immediately. |\n| [IsolatedImplementation](type-aliases/IsolatedImplementation.md) | The guest-side implementation object a caller of `serveIsolated` must provide — one function per declared method/stream. Method implementations may return their result synchronously or as a `Promise`. Every method implementation accepts an optional trailing [IsolationCallContext](interfaces/IsolationCallContext.md) uniformly (a deliberate typing simplification — see remarks below); at RUNTIME a context is only ever constructed and passed when the method descriptor declared `{ signal: true }`, so an implementation that ignores the parameter for a non-`signal` method simply never receives one. Stream implementations may return a `ReadableStream` or any `AsyncIterable` (e.g. an async generator), and always receive a trailing [StreamHandle](interfaces/StreamHandle.md). Declared `events` are NOT part of this object — see `serveIsolated`'s factory `emit` parameter. |\n| [IsolatedImplementationFactory](type-aliases/IsolatedImplementationFactory.md) | The implementation factory `serveIsolated`/`serveIsolatedOverPort` calls once, up front, to obtain the guest-side method/stream implementations plus the `emit` capability for declared events. |\n| [IsolatedServiceState](type-aliases/IsolatedServiceState.md) | Lifecycle state of an [IsolatedService](interfaces/IsolatedService.md). |\n| [IsolationReportCallback](type-aliases/IsolationReportCallback.md) | An isolation report consumer. |\n| [IsolationReportPhase](type-aliases/IsolationReportPhase.md) | The coarse phase groups an isolation report can belong to. |\n| [MethodMap](type-aliases/MethodMap.md) | The shape of a `methods` map passed to [defineIsolatedService](functions/defineIsolatedService.md): request/response descriptors keyed by method name. |\n| [PromptAssembledObserverFn](type-aliases/PromptAssembledObserverFn.md) | Observe the fully-assembled request a battery is about to dispatch. Injectable + defaulted to absent on every LLM battery, mirroring [RawGenerationObserverFn](type-aliases/RawGenerationObserverFn.md). Fired once per terminal generation, after assembly and before dispatch; purely observational (return value ignored, errors swallowed). The request is handed back AS-IS — see [PromptAssembledObservation](interfaces/PromptAssembledObservation.md) for the no-redaction contract. |\n| [RawGenerationObserverFn](type-aliases/RawGenerationObserverFn.md) | Observe a battery's raw model output for one completed generation. Injectable + defaulted to absent on the on-device LLM batteries (transformers.js, LiteRT-LM), mirroring the `toolCallParser` / `reasoningParser` / `extractMediaOutputs` injection seams. Fired once per terminal generation, after parsing and before persistence; purely observational (return value ignored, errors swallowed). |\n| [ScrapperInputMiddlewareFn](type-aliases/ScrapperInputMiddlewareFn.md) | An input-pipeline stage. Onion middleware over [ScrapperRequestContext](interfaces/ScrapperRequestContext.md). |\n| [ScrapperOutputMiddlewareFn](type-aliases/ScrapperOutputMiddlewareFn.md) | An output-pipeline stage over a verb's [ScrapperResponseContext](interfaces/ScrapperResponseContext.md). |\n| [StreamMap](type-aliases/StreamMap.md) | The shape of a `streams` map passed to [defineIsolatedService](functions/defineIsolatedService.md): fire-and-forward streaming descriptors keyed by stream name. |\n| [ToolCallIdFilterFn](type-aliases/ToolCallIdFilterFn.md) | Shapes a provider-supplied tool-call id at adapter ingress, before the call is stored or used for spool/result correlation. This hook exists to prevent the concrete failure seen with grok-4.3 on Bedrock Mantle, which repeats `call_0` across tool-calling turns. Default absent = identity, so adapters retain today's behaviour unless a consumer opts in. |\n| [TransformersJsSttDataType](type-aliases/TransformersJsSttDataType.md) | Quantization/precision dtype: `'auto' | 'fp32' | 'fp16' | 'q8' | 'q4' | …`. |\n| [TransformersJsSttDeviceType](type-aliases/TransformersJsSttDeviceType.md) | Inference device: `'auto' | 'webgpu' | 'wasm' | 'cpu' | 'gpu' | …`. |\n| [TransformersJsSttModelSource](type-aliases/TransformersJsSttModelSource.md) | Custom model-source resolver — the dual-environment seam for serving model files from OPFS, a different source, or bundled bytes (see the LLM battery's `model_source` module). Called once per file; return bytes / a path-or-URL string / a `Response`, or `undefined` to fall through to HF. |\n| [TransformersJsSttPipeline](type-aliases/TransformersJsSttPipeline.md) | The transformers.js automatic-speech-recognition pipeline this battery drives. |\n| [TransformersJsSttProgressCallback](type-aliases/TransformersJsSttProgressCallback.md) | Model-load progress callback. |\n| [WebLLMChatCompletionsRequestBody](type-aliases/WebLLMChatCompletionsRequestBody.md) | The request-body shape for the WebLLM adapter — the OpenAI Chat Completions body with `model` relaxed to optional, since the model is fixed at engine-load time rather than per request. |\n| [WebLLMEngine](type-aliases/WebLLMEngine.md) | The in-browser MLC engine instance the adapter drives. |\n| [WebLLMInitProgressReport](type-aliases/WebLLMInitProgressReport.md) | Progress report emitted while a WebLLM model loads/initializes. |\n| [WireEnvelope](type-aliases/WireEnvelope.md) | Either direction's envelope — used by generic wire-tracing hooks. |\n| [WireValue](type-aliases/WireValue.md) | A single argument/result value as it crosses the wire — the codec's (`codec.ts`) output shape. `enc: 'raw'` ships the value (mostly) untouched; `enc: 'nhtio'` ships an `@nhtio/encoder`-encoded string (or a BYO-codec-encoded string). `transfer` is a pass-through marker the browser transport unwraps into a `postMessage` transfer list; Node transports ignore it. |\n| [WorkerResolver](type-aliases/WorkerResolver.md) | Bring-your-own Worker spawner — the first-class seam for handing [spawnIsolated](functions/spawnIsolated.md)/[createWorkerTransport](functions/createWorkerTransport.md) a `Worker` constructed however the caller's bundler/pooling strategy demands (a `new Worker(new URL(...), import.meta.url)` Vite/webpack pattern, a worker pool that recycles threads, a test harness's Blob-URL worker, etc.). Called once per `connect()` (including every `recycle()`) — see [createWorkerTransport](functions/createWorkerTransport.md)'s remarks for why this makes a resolver the SINGLE source of Worker creation for a given transport. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [deCollideToolCallIds](variables/deCollideToolCallIds.md) | De-collides a provider-supplied tool-call id against calls already adopted in this dispatch. It prevents the concrete `call_0`-repeated-across-turns failure seen with grok-4.3 on Bedrock Mantle. Default absent = identity; this implementation returns the original id when no collision exists. |\n| [DEFAULT\\_CRASH\\_POLICY\\_MAX\\_CRASHES](variables/DEFAULT_CRASH_POLICY_MAX_CRASHES.md) | How many crashes inside the window are tolerated (with `'respawn'`) before `'giveUp'`. |\n| [DEFAULT\\_CRASH\\_POLICY\\_WINDOW\\_MS](variables/DEFAULT_CRASH_POLICY_WINDOW_MS.md) | How long a run of crashes must fall within to count toward the same escalation window. |\n| [defaultDescriptionToChatCompletionsJsonSchema](variables/defaultDescriptionToChatCompletionsJsonSchema.md) | Default JSON-Schema renderer; alias of [descriptionToChatCompletionsJsonSchema](functions/descriptionToChatCompletionsJsonSchema.md). |\n| [defaultFilterThoughts](variables/defaultFilterThoughts.md) | Default thought filter; alias of [filterThoughts](functions/filterThoughts.md). |\n| [defaultRenderChatCompletionsSystemPrompt](variables/defaultRenderChatCompletionsSystemPrompt.md) | Default system-prompt renderer; alias of [renderChatCompletionsSystemPrompt](functions/renderChatCompletionsSystemPrompt.md). |\n| [defaultRenderFirstPartyRetrievables](variables/defaultRenderFirstPartyRetrievables.md) | Default first-party retrievables renderer; alias of [renderFirstPartyRetrievables](functions/renderFirstPartyRetrievables.md). |\n| [defaultRenderMemories](variables/defaultRenderMemories.md) | Default memories renderer; alias of [renderMemories](functions/renderMemories.md). |\n| [defaultRenderRetrievables](variables/defaultRenderRetrievables.md) | Default retrievables orchestrator; alias of [renderRetrievables](functions/renderRetrievables.md). |\n| [defaultRenderRetrievableSafetyDirective](variables/defaultRenderRetrievableSafetyDirective.md) | Default safety-directive renderer; alias of [renderRetrievableSafetyDirective](functions/renderRetrievableSafetyDirective.md). |\n| [defaultRenderStandingInstructions](variables/defaultRenderStandingInstructions.md) | Default standing-instructions renderer; alias of [renderStandingInstructions](functions/renderStandingInstructions.md). |\n| [defaultRenderThirdPartyPrivateRetrievables](variables/defaultRenderThirdPartyPrivateRetrievables.md) | Default third-party-private retrievables renderer; alias of [renderThirdPartyPrivateRetrievables](functions/renderThirdPartyPrivateRetrievables.md). |\n| [defaultRenderThirdPartyPublicRetrievables](variables/defaultRenderThirdPartyPublicRetrievables.md) | Default third-party-public retrievables renderer; alias of [renderThirdPartyPublicRetrievables](functions/renderThirdPartyPublicRetrievables.md). |\n| [defaultRenderThought](variables/defaultRenderThought.md) | Default thought renderer; alias of [renderThought](functions/renderThought.md). |\n| [defaultRenderTrustedContent](variables/defaultRenderTrustedContent.md) | Default trusted-content renderer; alias of [renderTrustedContent](functions/renderTrustedContent.md). |\n| [defaultRenderUntrustedContent](variables/defaultRenderUntrustedContent.md) | Default untrusted-content renderer; alias of [renderUntrustedContent](functions/renderUntrustedContent.md). |\n| [defaultToolsToChatCompletionsTools](variables/defaultToolsToChatCompletionsTools.md) | Default tool-translation helper; alias of [toolsToChatCompletionsTools](functions/toolsToChatCompletionsTools.md). |\n| [E\\_INVALID\\_ISOLATION\\_OPTIONS](variables/E_INVALID_ISOLATION_OPTIONS.md) | Thrown when an isolation battery options bag (spec input, host options, codec options, crash-policy options) fails eager validation — e.g. an unknown top-level key, or a duplicate name across a spec's `methods`/`streams`/`events`. Fatal: config bugs fail loud, not at first use. |\n| [E\\_INVALID\\_SCRAPPER\\_CONFIG](variables/E_INVALID_SCRAPPER_CONFIG.md) | Thrown when a Scrapper factory receives invalid configuration. |\n| [E\\_INVALID\\_SEARXNG\\_CONFIG](variables/E_INVALID_SEARXNG_CONFIG.md) | Thrown when [createSearxngSearchTool](tools/searxng/functions/createSearxngSearchTool.md) receives invalid configuration. |\n| [E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS](variables/E_INVALID_TRANSFORMERS_JS_STT_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `transformersJsSttAdapterOptionsSchema` — e.g. a missing/empty `model` or an unknown option key. Fatal: config bugs fail loud, not at transcribe time. |\n| [E\\_ISOLATE\\_FUNCTION\\_ARG\\_UNSUPPORTED](variables/E_ISOLATE_FUNCTION_ARG_UNSUPPORTED.md) | Thrown when an `invoke()` argument contains an exotic leaf (a function/Error/custom-encodable) that `codec.ts`'s tiered encoder would need to escalate past the `'raw'` tier. The isolated Blob guest has no module imports (by design — no bare specifiers survive a Blob URL) and therefore cannot load `@nhtio/encoder` to decode an `enc: 'nhtio'` value; `isolateFunction` only ever supports plain, structured-cloneable arguments. Non-fatal: a caller can pass different, plain arguments instead. |\n| [E\\_ISOLATE\\_FUNCTION\\_REQUIRES\\_SOURCE\\_REHYDRATION](variables/E_ISOLATE_FUNCTION_REQUIRES_SOURCE_REHYDRATION.md) | Thrown when [isolateFunction](functions/isolateFunction.md) is called without the literal `{ allowSourceRehydration: true }` acknowledgement. Fatal: this is a configuration/call-site error, caught before anything is spawned. |\n| [E\\_ISOLATE\\_FUNCTION\\_UNSERIALIZABLE](variables/E_ISOLATE_FUNCTION_UNSERIALIZABLE.md) | Thrown when the function passed to [isolateFunction](functions/isolateFunction.md) cannot be serialized — `@nhtio/encoder/function_serializer`'s `FunctionSerializer.canSerialize` rejects native functions (`fn.toString()` containing `[native code]`) and bound functions (which stringify the same way). Fatal: detected before any Worker is spawned; there is no fallback representation to fall back to. |\n| [E\\_ISOLATED\\_CRASHED](variables/E_ISOLATED_CRASHED.md) | Thrown by `IsolatedService` calls made (or in flight) after the guest crashed and `autoRespawn`/manual `recycle()` has not yet brought it back. Printf arg: the service name. |\n| [E\\_ISOLATED\\_TERMINATED](variables/E_ISOLATED_TERMINATED.md) | Thrown to reject every in-flight call and error every open stream when an `IsolatedService` is disposed or recycled — the guest connection those calls/streams were bound to no longer exists. |\n| [E\\_ISOLATION\\_ENCODER\\_REQUIRED](variables/E_ISOLATION_ENCODER_REQUIRED.md) | Thrown when the codec must escalate a value past the `'raw'` tier (an exotic leaf: function, Error, or registered custom-encodable) but the optional `@nhtio/encoder` peer is not installed. Printf arg: the offending argument path. Non-fatal: a caller can catch this and pass the value through their own BYO codec instead. |\n| [E\\_ISOLATION\\_READY\\_TIMEOUT](variables/E_ISOLATION_READY_TIMEOUT.md) | Thrown by `IsolatedService` calls made while the guest has not yet signaled `ready` and the configured `readyTimeoutMs` has elapsed. Printf arg: the elapsed timeout in milliseconds. |\n| [E\\_ISOLATION\\_UNENCODABLE](variables/E_ISOLATION_UNENCODABLE.md) | Thrown when a value cannot be encoded even with the encoder peer available — most commonly a circular reference that ALSO contains an exotic leaf (a plain circular raw value is fine; see `codec.ts`), or the encoder itself rejects the value. Wraps the encoder's own `E_CIRCULAR_REFERENCE`/`E_UNENCODABLE_VALUE` as `cause`. |\n| [E\\_ISOLATION\\_UNSUPPORTED\\_ENV](variables/E_ISOLATION_UNSUPPORTED_ENV.md) | Thrown when `serveIsolated()` cannot duck-detect a supported guest environment — neither `globalThis.self.postMessage` (Web Worker) nor `globalThis.process?.send` (node child\\_process) is present. Fatal: there is no meaningful guest to serve. |\n| [E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR](variables/E_TRANSFORMERS_JS_STT_ENGINE_ERROR.md) | Thrown when the transformers.js pipeline fails to load (e.g. the `@huggingface/transformers` peer is not installed) or the `automatic-speech-recognition` call throws/returns a malformed result. Non-fatal. Printf arg: `[detail]`. |\n| [transformersJsSttAdapterOptionsSchema](variables/transformersJsSttAdapterOptionsSchema.md) | Validator schema for `TransformersJsSttAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [createCrashPolicy](functions/createCrashPolicy.md) | Build a sliding-window crash-escalation policy: the first `maxCrashes - 1` crashes inside `windowMs` each return `'respawn'`; the `maxCrashes`-th (and every crash after it, while still inside the window) returns `'giveUp'`. Two crashes spaced further apart than `windowMs` are each treated as a fresh, first-in-window crash — an occasional isolated crash over a long-running session never escalates. |\n| [createIsolatedService](functions/createIsolatedService.md) | Build an [IsolatedService](interfaces/IsolatedService.md) over `transport` for `spec`. Connection + the first `ready` handshake begin immediately (fire-and-forget internally); calls made before `ready` queue inside the underlying [HostEndpoint](classes/HostEndpoint.md) and flush in order once it arrives. |\n| [createWorkerTransport](functions/createWorkerTransport.md) | Build an [IsolationTransport](interfaces/IsolationTransport.md) that spawns/re-spawns a real browser `Worker` per [SpawnIsolatedOptions.worker](interfaces/SpawnIsolatedOptions.md#property-worker). |\n| [defineIsolatedService](functions/defineIsolatedService.md) | Define an isolated service's spec — validates `input` eagerly (see validateIsolatedServiceSpecInput) then resolves it via @nhtio/adk/batteries/isolation!resolveIsolatedServiceSpec. This is the public entry point re-exported as `defineIsolatedService` from this battery's `index.ts` barrel. |\n| [descriptionToChatCompletionsJsonSchema](functions/descriptionToChatCompletionsJsonSchema.md) | Implements [ChatHelpersCommon.descriptionToChatCompletionsJsonSchema](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema). |\n| [emitIsolationReport](functions/emitIsolationReport.md) | Build an [IsolationReport](interfaces/IsolationReport.md) (stamping `at`) and dispatch it to the firehose ([IsolationObservabilityHooks.onIsolation](interfaces/IsolationObservabilityHooks.md#property-onisolation)) AND the per-phase-group hook for `phase`. A no-op when `hooks` is undefined or carries no relevant callbacks — callers should additionally guard expensive `extra` computation (e.g. `approxBytes` sizing) behind [hasIsolationHook](functions/hasIsolationHook.md) so it is never computed when unhooked. Each callback is invoked through safeInvoke, so a throwing consumer never disrupts the battery. |\n| [event](functions/event.md) | Declare an unsolicited event channel on an isolated service's spec — the guest-side implementation factory receives an `emit(payload)` function for this channel; the host subscribes via `service.on(channel, fn)`. Events are never implemented by the guest's per-method object (there is no \"handler\" to provide) — they are purely an outbound notification channel. |\n| [filterThoughts](functions/filterThoughts.md) | Implements [ChatHelpersCommon.filterThoughts](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts). |\n| [floorTrustTier](functions/floorTrustTier.md) | Clamp a stash entry's trust tier to its containing media's tier as a FLOOR: a stash entry may render at the parent's tier or LOWER (less trusted), never HIGHER. |\n| [hasIsolationHook](functions/hasIsolationHook.md) | Returns `true` when at least one hook relevant to `phase` is registered — the guard [emitIsolationReport](functions/emitIsolationReport.md) uses to skip assembling a report entirely (zero overhead when unhooked). |\n| [isEncoderAvailable](functions/isEncoderAvailable.md) | Whether the encoder peer is currently available. Used to populate `ready.encoderAvailable`. |\n| [isolateFunction](functions/isolateFunction.md) | Run `fn` inside a throwaway, source-rehydrated Worker. See this module's doc comment for the full design and the trust-boundary implications of `allowSourceRehydration`. |\n| [method](functions/method.md) | Declare a request/response method on an isolated service's spec — the host gets a `(...args) => Promise` facade method; the guest implementation returns (or resolves to) `R` directly (or throws/rejects, crossing back as a rejected promise on the host). |\n| [neutraliseDeveloperRulesTag](functions/neutraliseDeveloperRulesTag.md) | Neutralise the **no-nonce** `` / `` developer-rules tier if it appears inside model- or user-supplied BODY content. |\n| [nextCorrelationId](functions/nextCorrelationId.md) | Monotonic id generator shared by both endpoints (module-scoped counter — fine across many instances in one realm since ids are only ever compared within a single connection). |\n| [registerEncodableClasses](functions/registerEncodableClasses.md) | Register classes for `@nhtio/encoder`'s custom-encodable round-trip (sugar over `registerClass`, called lazily once the encoder is loaded). Throws `E_ISOLATION_ENCODER_REQUIRED` when classes are listed but the peer is not installed. |\n| [renderChatCompletionsSystemPrompt](functions/renderChatCompletionsSystemPrompt.md) | Implements [ChatHelpersCommon.renderChatCompletionsSystemPrompt](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt). |\n| [renderFirstPartyRetrievables](functions/renderFirstPartyRetrievables.md) | Implements [ChatHelpersCommon.renderFirstPartyRetrievables](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables). |\n| [renderMemories](functions/renderMemories.md) | Implements [ChatHelpersCommon.renderMemories](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories). |\n| [renderRetrievables](functions/renderRetrievables.md) | Implements [ChatHelpersCommon.renderRetrievables](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables). |\n| [renderRetrievableSafetyDirective](functions/renderRetrievableSafetyDirective.md) | Implements [ChatHelpersCommon.renderRetrievableSafetyDirective](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective). |\n| [renderStandingInstructions](functions/renderStandingInstructions.md) | Implements [ChatHelpersCommon.renderStandingInstructions](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions). |\n| [renderThirdPartyPrivateRetrievables](functions/renderThirdPartyPrivateRetrievables.md) | Implements [ChatHelpersCommon.renderThirdPartyPrivateRetrievables](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables). |\n| [renderThirdPartyPublicRetrievables](functions/renderThirdPartyPublicRetrievables.md) | Implements [ChatHelpersCommon.renderThirdPartyPublicRetrievables](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables). |\n| [renderThought](functions/renderThought.md) | Implements [ChatHelpersCommon.renderThought](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought). |\n| [renderTrustedContent](functions/renderTrustedContent.md) | Implements [ChatHelpersCommon.renderTrustedContent](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent). |\n| [renderUntrustedContent](functions/renderUntrustedContent.md) | Implements [ChatHelpersCommon.renderUntrustedContent](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent). |\n| [resolveIsolatedServiceSpec](functions/resolveIsolatedServiceSpec.md) | Resolve an isolated-service spec input into its final [IsolatedServiceSpec](interfaces/IsolatedServiceSpec.md) shape — filling in `{}` defaults for omitted `methods`/`streams`/`events`. Pure and zero-import: performs NO validation (no duplicate-name check, no empty-`name` check). This is the primitive the public, validating `defineIsolatedService` (exported from `validation.ts` and re-exported from this battery's `index.ts` barrel) delegates to after it validates the input — call this directly only from tests that intentionally want to bypass validation. |\n| [sanitizeFilenameForDescription](functions/sanitizeFilenameForDescription.md) | Sanitise a media `filename` for interpolation into a synthetic-description line that is then placed INSIDE a trust envelope whose body is not XML-escaped. |\n| [sanitizeMimeType](functions/sanitizeMimeType.md) | Validate a media `mimeType` for safe interpolation into a `data:;base64,…` URI, a `Blob({type})`, or a synthetic-description line. |\n| [serveIsolated](functions/serveIsolated.md) | Serve `spec` in the CURRENT environment, duck-detecting a Web Worker global scope (`globalThis.self.postMessage`) or a node child\\_process (`globalThis.process.send`) — in that order — and building the matching [PortLike](interfaces/PortLike.md) automatically. This module never imports any `node:*` builtin, so it is safe to bundle for either target; the detection is a pure `globalThis` duck check. |\n| [serveIsolatedOverPort](functions/serveIsolatedOverPort.md) | Serve `spec` over an already-constructed [PortLike](interfaces/PortLike.md) — the environment-neutral primitive. Builds the implementation via `factory`, wires a [GuestEndpoint](classes/GuestEndpoint.md) to it, and announces readiness (`ready` envelope) once the encoder-availability probe resolves. |\n| [spawnIsolated](functions/spawnIsolated.md) | Sugar for `createIsolatedService(spec, createWorkerTransport(spec, options), options)` — spawn a real Worker-backed [IsolatedService](interfaces/IsolatedService.md) in one call. |\n| [stream](functions/stream.md) | Declare a fire-and-forward streaming method on an isolated service's spec — the host gets a `(...args) => ReadableStream` facade method (synchronous: the stream is returned immediately, fed by deltas as they cross the wire); the guest implementation returns (or is called to produce) a `ReadableStream` or `AsyncIterable`. |\n| [stripEnvelopeSpecialTokens](functions/stripEnvelopeSpecialTokens.md) | Strip the non-semantic envelope/turn-boundary special tokens (see ENVELOPE\\_SPECIAL\\_TOKEN\\_RE) from decoded model text before it reaches the parser layer. |\n| [toolsToChatCompletionsTools](functions/toolsToChatCompletionsTools.md) | Implements [ChatHelpersCommon.toolsToChatCompletionsTools](llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools). |\n| [transfer](functions/transfer.md) | Mark `value` for transfer (rather than clone) across a `postMessage`-based transport — the Web Worker transport unwraps this into the message's transfer list. The codec passes marked values through as `raw` with `transferables` preserved on the [WireValue](type-aliases/WireValue.md) envelope's `transfer` field. Node transports ignore the marker entirely (structured-clone/pipe semantics don't have a transfer list), so `transfer()` is safe to use in transport-agnostic code that may run over either. |\n| [validateTransformersJsSttOptions](functions/validateTransformersJsSttOptions.md) | Validates an arbitrary input against `transformersJsSttAdapterOptionsSchema`. |\n| [wireErrorToError](functions/wireErrorToError.md) | Reconstruct an `Error` from a [WireError](interfaces/WireError.md) baseline (name/message/stack only — the `nhtio`-rich path is decoded separately by the caller when an encoder is available; see `host.ts`). |\n\n## References\n\n### addStandingInstructionTool\n\nRe-exports [addStandingInstructionTool](tools/standing_instructions/variables/addStandingInstructionTool.md)\n\n***\n\n### AnthropicCacheBreakpoints\n\nRe-exports [AnthropicCacheBreakpoints](llm/anthropic_messages/types/type-aliases/AnthropicCacheBreakpoints.md)\n\n***\n\n### AnthropicCacheControlEphemeral\n\nRe-exports [AnthropicCacheControlEphemeral](llm/anthropic_messages/types/type-aliases/AnthropicCacheControlEphemeral.md)\n\n***\n\n### AnthropicCacheTtl\n\nRe-exports [AnthropicCacheTtl](llm/anthropic_messages/types/type-aliases/AnthropicCacheTtl.md)\n\n***\n\n### AnthropicContentBlock\n\nRe-exports [AnthropicContentBlock](llm/anthropic_messages/types/type-aliases/AnthropicContentBlock.md)\n\n***\n\n### AnthropicContentBlockParam\n\nRe-exports [AnthropicContentBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicContentBlockParam.md)\n\n***\n\n### AnthropicDocumentBlockParam\n\nRe-exports [AnthropicDocumentBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicDocumentBlockParam.md)\n\n***\n\n### AnthropicImageBlockParam\n\nRe-exports [AnthropicImageBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicImageBlockParam.md)\n\n***\n\n### AnthropicJSONOutputFormat\n\nRe-exports [AnthropicJSONOutputFormat](llm/anthropic_messages/types/type-aliases/AnthropicJSONOutputFormat.md)\n\n***\n\n### AnthropicMessage\n\nRe-exports [AnthropicMessage](llm/anthropic_messages/types/type-aliases/AnthropicMessage.md)\n\n***\n\n### AnthropicMessageCountTokensParams\n\nRe-exports [AnthropicMessageCountTokensParams](llm/anthropic_messages/types/type-aliases/AnthropicMessageCountTokensParams.md)\n\n***\n\n### AnthropicMessageCreateParams\n\nRe-exports [AnthropicMessageCreateParams](llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParams.md)\n\n***\n\n### AnthropicMessageCreateParamsBase\n\nRe-exports [AnthropicMessageCreateParamsBase](llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParamsBase.md)\n\n***\n\n### AnthropicMessageDeltaUsage\n\nRe-exports [AnthropicMessageDeltaUsage](llm/anthropic_messages/types/type-aliases/AnthropicMessageDeltaUsage.md)\n\n***\n\n### AnthropicMessageParam\n\nRe-exports [AnthropicMessageParam](llm/anthropic_messages/types/type-aliases/AnthropicMessageParam.md)\n\n***\n\n### AnthropicMessagesAdapter\n\nRe-exports [AnthropicMessagesAdapter](llm/anthropic_messages/adapter/classes/AnthropicMessagesAdapter.md)\n\n***\n\n### AnthropicMessagesAdapterOptions\n\nRe-exports [AnthropicMessagesAdapterOptions](llm/anthropic_messages/types/interfaces/AnthropicMessagesAdapterOptions.md)\n\n***\n\n### AnthropicMessagesCountTokensDeps\n\nRe-exports [AnthropicMessagesCountTokensDeps](llm/anthropic_messages/count_tokens/interfaces/AnthropicMessagesCountTokensDeps.md)\n\n***\n\n### AnthropicMessagesCountTokensInput\n\nRe-exports [AnthropicMessagesCountTokensInput](llm/anthropic_messages/types/interfaces/AnthropicMessagesCountTokensInput.md)\n\n***\n\n### AnthropicMessagesCountTokensRequestInput\n\nRe-exports [AnthropicMessagesCountTokensRequestInput](llm/anthropic_messages/count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput.md)\n\n***\n\n### AnthropicMessagesHelpers\n\nRe-exports [AnthropicMessagesHelpers](llm/anthropic_messages/types/interfaces/AnthropicMessagesHelpers.md)\n\n***\n\n### anthropicMessagesOptionsSchema\n\nRe-exports [anthropicMessagesOptionsSchema](llm/anthropic_messages/validation/variables/anthropicMessagesOptionsSchema.md)\n\n***\n\n### AnthropicMessageTokensCount\n\nRe-exports [AnthropicMessageTokensCount](llm/anthropic_messages/types/type-aliases/AnthropicMessageTokensCount.md)\n\n***\n\n### AnthropicModel\n\nRe-exports [AnthropicModel](llm/anthropic_messages/types/type-aliases/AnthropicModel.md)\n\n***\n\n### AnthropicOutputConfig\n\nRe-exports [AnthropicOutputConfig](llm/anthropic_messages/types/type-aliases/AnthropicOutputConfig.md)\n\n***\n\n### AnthropicRawContentBlockDelta\n\nRe-exports [AnthropicRawContentBlockDelta](llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDelta.md)\n\n***\n\n### AnthropicRawContentBlockDeltaEvent\n\nRe-exports [AnthropicRawContentBlockDeltaEvent](llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDeltaEvent.md)\n\n***\n\n### AnthropicRawContentBlockStartEvent\n\nRe-exports [AnthropicRawContentBlockStartEvent](llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStartEvent.md)\n\n***\n\n### AnthropicRawContentBlockStopEvent\n\nRe-exports [AnthropicRawContentBlockStopEvent](llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStopEvent.md)\n\n***\n\n### AnthropicRawMessageDeltaEvent\n\nRe-exports [AnthropicRawMessageDeltaEvent](llm/anthropic_messages/types/type-aliases/AnthropicRawMessageDeltaEvent.md)\n\n***\n\n### AnthropicRawMessageStartEvent\n\nRe-exports [AnthropicRawMessageStartEvent](llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStartEvent.md)\n\n***\n\n### AnthropicRawMessageStopEvent\n\nRe-exports [AnthropicRawMessageStopEvent](llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStopEvent.md)\n\n***\n\n### AnthropicRawMessageStreamEvent\n\nRe-exports [AnthropicRawMessageStreamEvent](llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStreamEvent.md)\n\n***\n\n### AnthropicRedactedThinkingBlock\n\nRe-exports [AnthropicRedactedThinkingBlock](llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlock.md)\n\n***\n\n### AnthropicRedactedThinkingBlockParam\n\nRe-exports [AnthropicRedactedThinkingBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlockParam.md)\n\n***\n\n### AnthropicRefusalStopDetails\n\nRe-exports [AnthropicRefusalStopDetails](llm/anthropic_messages/types/type-aliases/AnthropicRefusalStopDetails.md)\n\n***\n\n### AnthropicStopReason\n\nRe-exports [AnthropicStopReason](llm/anthropic_messages/types/type-aliases/AnthropicStopReason.md)\n\n***\n\n### AnthropicTextBlockParam\n\nRe-exports [AnthropicTextBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicTextBlockParam.md)\n\n***\n\n### AnthropicThinkingBlock\n\nRe-exports [AnthropicThinkingBlock](llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlock.md)\n\n***\n\n### AnthropicThinkingBlockParam\n\nRe-exports [AnthropicThinkingBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlockParam.md)\n\n***\n\n### AnthropicThinkingConfigParam\n\nRe-exports [AnthropicThinkingConfigParam](llm/anthropic_messages/types/type-aliases/AnthropicThinkingConfigParam.md)\n\n***\n\n### AnthropicThinkingReplayPayload\n\nRe-exports [AnthropicThinkingReplayPayload](llm/anthropic_messages/types/type-aliases/AnthropicThinkingReplayPayload.md)\n\n***\n\n### AnthropicTool\n\nRe-exports [AnthropicTool](llm/anthropic_messages/types/type-aliases/AnthropicTool.md)\n\n***\n\n### AnthropicToolChoice\n\nRe-exports [AnthropicToolChoice](llm/anthropic_messages/types/type-aliases/AnthropicToolChoice.md)\n\n***\n\n### AnthropicToolResultBlockParam\n\nRe-exports [AnthropicToolResultBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicToolResultBlockParam.md)\n\n***\n\n### AnthropicToolUseBlock\n\nRe-exports [AnthropicToolUseBlock](llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlock.md)\n\n***\n\n### AnthropicToolUseBlockParam\n\nRe-exports [AnthropicToolUseBlockParam](llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlockParam.md)\n\n***\n\n### AnthropicUsage\n\nRe-exports [AnthropicUsage](llm/anthropic_messages/types/type-aliases/AnthropicUsage.md)\n\n***\n\n### applyEmbeddingPrefix\n\nRe-exports [applyEmbeddingPrefix](embeddings/openai/helpers/functions/applyEmbeddingPrefix.md)\n\n***\n\n### argText\n\nRe-exports [argText](context/thrift/relevance/functions/argText.md)\n\n***\n\n### ArticleContentSource\n\nRe-exports [ArticleContentSource](tools/web_retrieval/type-aliases/ArticleContentSource.md)\n\n***\n\n### ArticleToRetrievableOptions\n\nRe-exports [ArticleToRetrievableOptions](tools/web_retrieval/interfaces/ArticleToRetrievableOptions.md)\n\n***\n\n### ArtifactRecommendations\n\nRe-exports [ArtifactRecommendations](tools/web_retrieval/interfaces/ArtifactRecommendations.md)\n\n***\n\n### assembleCompactedTurns\n\nRe-exports [assembleCompactedTurns](context/compact/summarizer/functions/assembleCompactedTurns.md)\n\n***\n\n### AssembleCompactedTurnsOptions\n\nRe-exports [AssembleCompactedTurnsOptions](context/compact/summarizer/interfaces/AssembleCompactedTurnsOptions.md)\n\n***\n\n### AssembleCompactedTurnsResult\n\nRe-exports [AssembleCompactedTurnsResult](context/compact/summarizer/interfaces/AssembleCompactedTurnsResult.md)\n\n***\n\n### AssembledToolCall\n\nRe-exports [AssembledToolCall](llm/openai_chat_completions/types/interfaces/AssembledToolCall.md)\n\n***\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](embeddings/openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### BaseGenerationAdapterOptions\n\nRe-exports [BaseGenerationAdapterOptions](generation/openai/types/interfaces/BaseGenerationAdapterOptions.md)\n\n***\n\n### BaseTtsAdapterOptions\n\nRe-exports [BaseTtsAdapterOptions](tts/_shared/interfaces/BaseTtsAdapterOptions.md)\n\n***\n\n### BaseVectorStore\n\nRe-exports [BaseVectorStore](vector/contract/classes/BaseVectorStore.md)\n\n***\n\n### BaseVectorStoreOptions\n\nRe-exports [BaseVectorStoreOptions](vector/types/interfaces/BaseVectorStoreOptions.md)\n\n***\n\n### baseVectorStoreOptionsSchema\n\nRe-exports [baseVectorStoreOptionsSchema](vector/validation/variables/baseVectorStoreOptionsSchema.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### BucketTrace\n\nRe-exports [BucketTrace](context/thrift/subtractive_pass/interfaces/BucketTrace.md)\n\n***\n\n### buildChatCompletionsHistory\n\nRe-exports [buildChatCompletionsHistory](llm/openai_chat_completions/helpers/functions/buildChatCompletionsHistory.md)\n\n***\n\n### calculateTool\n\nRe-exports [calculateTool](tools/math/variables/calculateTool.md)\n\n***\n\n### CallableVectorStore\n\nRe-exports [CallableVectorStore](vector/contract/type-aliases/CallableVectorStore.md)\n\n***\n\n### ChatCompletionsChunk\n\nRe-exports [ChatCompletionsChunk](llm/openai_chat_completions/types/interfaces/ChatCompletionsChunk.md)\n\n***\n\n### ChatCompletionsHelpers\n\nRe-exports [ChatCompletionsHelpers](llm/openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### ChatCompletionsMessage\n\nRe-exports [ChatCompletionsMessage](llm/openai_chat_completions/types/interfaces/ChatCompletionsMessage.md)\n\n***\n\n### ChatCompletionsResponse\n\nRe-exports [ChatCompletionsResponse](llm/openai_chat_completions/types/interfaces/ChatCompletionsResponse.md)\n\n***\n\n### ChatCompletionsToolCallDelta\n\nRe-exports [ChatCompletionsToolCallDelta](llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDelta.md)\n\n***\n\n### ChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [ChatCompletionsToolCallDeltaAccumulator](llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### clamp01\n\nRe-exports [clamp01](vector/helpers/functions/clamp01.md)\n\n***\n\n### ClaudeCodeCliAdapter\n\nRe-exports [ClaudeCodeCliAdapter](llm/claude_code_cli/adapter/classes/ClaudeCodeCliAdapter.md)\n\n***\n\n### ClaudeCodeCliAdapterOptions\n\nRe-exports [ClaudeCodeCliAdapterOptions](llm/claude_code_cli/types/interfaces/ClaudeCodeCliAdapterOptions.md)\n\n***\n\n### ClaudeCodeCliExtraArg\n\nRe-exports [ClaudeCodeCliExtraArg](llm/claude_code_cli/wire/interfaces/ClaudeCodeCliExtraArg.md)\n\n***\n\n### ClaudeCodeCliHelpers\n\nRe-exports [ClaudeCodeCliHelpers](llm/claude_code_cli/types/interfaces/ClaudeCodeCliHelpers.md)\n\n***\n\n### claudeCodeCliOptionsSchema\n\nRe-exports [claudeCodeCliOptionsSchema](llm/claude_code_cli/validation/variables/claudeCodeCliOptionsSchema.md)\n\n***\n\n### CollectionBuilder\n\nRe-exports [CollectionBuilder](vector/schema/classes/CollectionBuilder.md)\n\n***\n\n### CollectionFieldSpec\n\nRe-exports [CollectionFieldSpec](vector/plan/interfaces/CollectionFieldSpec.md)\n\n***\n\n### CollectionSpec\n\nRe-exports [CollectionSpec](vector/plan/interfaces/CollectionSpec.md)\n\n***\n\n### colorAdjustTool\n\nRe-exports [colorAdjustTool](tools/color/variables/colorAdjustTool.md)\n\n***\n\n### colorContrastTool\n\nRe-exports [colorContrastTool](tools/color/variables/colorContrastTool.md)\n\n***\n\n### colorSchemeTool\n\nRe-exports [colorSchemeTool](tools/color/variables/colorSchemeTool.md)\n\n***\n\n### COMPACTION\\_SYSTEM\\_PROMPT\n\nRe-exports [COMPACTION\\_SYSTEM\\_PROMPT](context/compact/summarizer/variables/COMPACTION_SYSTEM_PROMPT.md)\n\n***\n\n### CompactionCostEvent\n\nRe-exports [CompactionCostEvent](context/compact/contracts/interfaces/CompactionCostEvent.md)\n\n***\n\n### compareRecordsTool\n\nRe-exports [compareRecordsTool](tools/comparison/variables/compareRecordsTool.md)\n\n***\n\n### compareValuesTool\n\nRe-exports [compareValuesTool](tools/comparison/variables/compareValuesTool.md)\n\n***\n\n### ContentLike\n\nRe-exports [ContentLike](context/thrift/contracts/interfaces/ContentLike.md)\n\n***\n\n### contentTokens\n\nRe-exports [contentTokens](context/thrift/relevance/functions/contentTokens.md)\n\n***\n\n### convertTimeTool\n\nRe-exports [convertTimeTool](tools/time/variables/convertTimeTool.md)\n\n***\n\n### convertUnitTool\n\nRe-exports [convertUnitTool](tools/unit_conversion/variables/convertUnitTool.md)\n\n***\n\n### createChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [createChatCompletionsToolCallDeltaAccumulator](llm/openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### createScrapperArticleTool\n\nRe-exports [createScrapperArticleTool](tools/scrapper/functions/createScrapperArticleTool.md)\n\n***\n\n### createScrapperArticleToolSync\n\nRe-exports [createScrapperArticleToolSync](tools/scrapper/functions/createScrapperArticleToolSync.md)\n\n***\n\n### createScrapperLinksTool\n\nRe-exports [createScrapperLinksTool](tools/scrapper/functions/createScrapperLinksTool.md)\n\n***\n\n### createScrapperLinksToolSync\n\nRe-exports [createScrapperLinksToolSync](tools/scrapper/functions/createScrapperLinksToolSync.md)\n\n***\n\n### createSearxngSearchTool\n\nRe-exports [createSearxngSearchTool](tools/searxng/functions/createSearxngSearchTool.md)\n\n***\n\n### createSearxngSearchToolSync\n\nRe-exports [createSearxngSearchToolSync](tools/searxng/functions/createSearxngSearchToolSync.md)\n\n***\n\n### CreateTesseractJsModule\n\nRe-exports [CreateTesseractJsModule](specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsModule.md)\n\n***\n\n### CreateTesseractJsWorker\n\nRe-exports [CreateTesseractJsWorker](specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsWorker.md)\n\n***\n\n### CreateTransformersJsCaptionPipeline\n\nRe-exports [CreateTransformersJsCaptionPipeline](specialists/caption/transformers_js/types/type-aliases/CreateTransformersJsCaptionPipeline.md)\n\n***\n\n### CreateTransformersJsEmbeddingsPipeline\n\nRe-exports [CreateTransformersJsEmbeddingsPipeline](embeddings/transformers_js/types/type-aliases/CreateTransformersJsEmbeddingsPipeline.md)\n\n***\n\n### CreateTransformersJsGenerationModel\n\nRe-exports [CreateTransformersJsGenerationModel](generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationModel.md)\n\n***\n\n### CreateTransformersJsGenerationProcessor\n\nRe-exports [CreateTransformersJsGenerationProcessor](generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationProcessor.md)\n\n***\n\n### CreateTransformersJsTtsPipeline\n\nRe-exports [CreateTransformersJsTtsPipeline](tts/transformers_js/types/type-aliases/CreateTransformersJsTtsPipeline.md)\n\n***\n\n### createVectorRetrievableCallbacks\n\nRe-exports [createVectorRetrievableCallbacks](vector/retrievable/functions/createVectorRetrievableCallbacks.md)\n\n***\n\n### createVectorStore\n\nRe-exports [createVectorStore](vector/factory/functions/createVectorStore.md)\n\n***\n\n### CreateVectorStoreConfig\n\nRe-exports [CreateVectorStoreConfig](vector/factory/interfaces/CreateVectorStoreConfig.md)\n\n***\n\n### dateAddTool\n\nRe-exports [dateAddTool](tools/datetime_math/variables/dateAddTool.md)\n\n***\n\n### dateBusinessDaysTool\n\nRe-exports [dateBusinessDaysTool](tools/datetime_extended/variables/dateBusinessDaysTool.md)\n\n***\n\n### dateCalendarInfoTool\n\nRe-exports [dateCalendarInfoTool](tools/datetime_extended/variables/dateCalendarInfoTool.md)\n\n***\n\n### dateDiffTool\n\nRe-exports [dateDiffTool](tools/datetime_math/variables/dateDiffTool.md)\n\n***\n\n### dateNthWeekdayTool\n\nRe-exports [dateNthWeekdayTool](tools/datetime_extended/variables/dateNthWeekdayTool.md)\n\n***\n\n### dateParseTool\n\nRe-exports [dateParseTool](tools/datetime_extended/variables/dateParseTool.md)\n\n***\n\n### datePeriodTool\n\nRe-exports [datePeriodTool](tools/datetime_extended/variables/datePeriodTool.md)\n\n***\n\n### DecodeAudioFn\n\nRe-exports [DecodeAudioFn](specialists/_shared/type-aliases/DecodeAudioFn.md)\n\n***\n\n### DEFAULT\\_ENCODING\n\nRe-exports [DEFAULT\\_ENCODING](context/thrift/subtractive_pass/variables/DEFAULT_ENCODING.md)\n\n***\n\n### DEFAULT\\_KEEP\\_VERBATIM\n\nRe-exports [DEFAULT\\_KEEP\\_VERBATIM](context/compact/summarizer/variables/DEFAULT_KEEP_VERBATIM.md)\n\n***\n\n### DEFAULT\\_RESERVE\\_FRACTION\n\nRe-exports [DEFAULT\\_RESERVE\\_FRACTION](context/thrift/subtractive_pass/variables/DEFAULT_RESERVE_FRACTION.md)\n\n***\n\n### DEFAULT\\_SUMMARISE\\_AT\\_TOKENS\n\nRe-exports [DEFAULT\\_SUMMARISE\\_AT\\_TOKENS](context/compact/summarizer/variables/DEFAULT_SUMMARISE_AT_TOKENS.md)\n\n***\n\n### DEFAULT\\_SUMMARY\\_MESSAGE\\_ID\n\nRe-exports [DEFAULT\\_SUMMARY\\_MESSAGE\\_ID](context/compact/summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID.md)\n\n***\n\n### DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP\n\nRe-exports [DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP](context/thrift/subtractive_pass/variables/DEFAULT_THIS_TURN_RESULT_KEEP.md)\n\n***\n\n### defaultBuildChatCompletionsHistory\n\nRe-exports [defaultBuildChatCompletionsHistory](llm/openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory.md)\n\n***\n\n### defaultCreateChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [defaultCreateChatCompletionsToolCallDeltaAccumulator](llm/openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### defaultDecodeAudio\n\nRe-exports [defaultDecodeAudio](specialists/_shared/variables/defaultDecodeAudio.md)\n\n***\n\n### defaultRenderChatCompletionsToolCallResult\n\nRe-exports [defaultRenderChatCompletionsToolCallResult](llm/openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult.md)\n\n***\n\n### defaultRenderTimelineMessage\n\nRe-exports [defaultRenderTimelineMessage](llm/openai_chat_completions/helpers/variables/defaultRenderTimelineMessage.md)\n\n***\n\n### deleteMemoryTool\n\nRe-exports [deleteMemoryTool](tools/memory/variables/deleteMemoryTool.md)\n\n***\n\n### DeletePlan\n\nRe-exports [DeletePlan](vector/plan/interfaces/DeletePlan.md)\n\n***\n\n### deleteRetrievableTool\n\nRe-exports [deleteRetrievableTool](tools/retrievables/variables/deleteRetrievableTool.md)\n\n***\n\n### DescribeOptions\n\nRe-exports [DescribeOptions](specialists/caption/transformers_js/types/interfaces/DescribeOptions.md)\n\n***\n\n### DescribeResult\n\nRe-exports [DescribeResult](specialists/caption/transformers_js/types/interfaces/DescribeResult.md)\n\n***\n\n### detectDelimiterTool\n\nRe-exports [detectDelimiterTool](tools/parsing/variables/detectDelimiterTool.md)\n\n***\n\n### dimensionsMatch\n\nRe-exports [dimensionsMatch](vector/helpers/functions/dimensionsMatch.md)\n\n***\n\n### DistanceMetric\n\nRe-exports [DistanceMetric](vector/types/type-aliases/DistanceMetric.md)\n\n***\n\n### durationFormatTool\n\nRe-exports [durationFormatTool](tools/datetime_math/variables/durationFormatTool.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW](llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR](llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS](llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT](llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR](llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED](llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_ERROR.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_STALLED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_TURN_FAILED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR](llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR.md)\n\n***\n\n### E\\_CONTEXT\\_RESOLVER\\_MISSING\n\nRe-exports [E\\_CONTEXT\\_RESOLVER\\_MISSING](context/exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR](generation/gemini/exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE](generation/gemini/exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT](generation/gemini/exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS](llm/anthropic_messages/exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS](llm/claude_code_cli/exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS](generation/gemini/exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_LITERT\\_LM\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_LITERT\\_LM\\_OPTIONS](llm/litert_lm/exceptions/variables/E_INVALID_LITERT_LM_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS](embeddings/ollama/exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OLLAMA\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OLLAMA\\_OPTIONS](llm/ollama/exceptions/variables/E_INVALID_OLLAMA_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS](llm/openai_chat_completions/exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS](embeddings/openai/exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS](generation/openai/exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS](llm/openai_responses/exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS](specialists/ocr/tesseract_js/exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS](specialists/caption/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS](embeddings/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS](generation/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS](llm/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_TTS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_TTS\\_OPTIONS](tts/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_TTS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_VECTOR\\_RECORD\n\nRe-exports [E\\_INVALID\\_VECTOR\\_RECORD](vector/exceptions/variables/E_INVALID_VECTOR_RECORD.md)\n\n***\n\n### E\\_INVALID\\_VECTOR\\_STORE\\_CONFIG\n\nRe-exports [E\\_INVALID\\_VECTOR\\_STORE\\_CONFIG](vector/exceptions/variables/E_INVALID_VECTOR_STORE_CONFIG.md)\n\n***\n\n### E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS](llm/webllm_chat_completions/exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md)\n\n***\n\n### E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW](llm/litert_lm/exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS](llm/litert_lm/exceptions/variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_LITERT\\_LM\\_STREAM\\_ERROR\n\nRe-exports [E\\_LITERT\\_LM\\_STREAM\\_ERROR](llm/litert_lm/exceptions/variables/E_LITERT_LM_STREAM_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OLLAMA\\_CONTEXT\\_OVERFLOW](llm/ollama/exceptions/variables/E_OLLAMA_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR](embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OLLAMA\\_HTTP\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_HTTP\\_ERROR](llm/ollama/exceptions/variables/E_OLLAMA_HTTP_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS](llm/ollama/exceptions/variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OLLAMA\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OLLAMA\\_REQUEST\\_TIMEOUT](llm/ollama/exceptions/variables/E_OLLAMA_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OLLAMA\\_STREAM\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_STREAM\\_ERROR](llm/ollama/exceptions/variables/E_OLLAMA_STREAM_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_STREAM\\_STALLED\n\nRe-exports [E\\_OLLAMA\\_STREAM\\_STALLED](llm/ollama/exceptions/variables/E_OLLAMA_STREAM_STALLED.md)\n\n***\n\n### E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY](llm/ollama/exceptions/variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR](llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT](llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED](llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR](embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR](generation/openai/exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE](generation/openai/exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT](generation/openai/exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_STALLED.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR](specialists/ocr/tesseract_js/exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR](specialists/caption/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW](llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR](embeddings/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR](generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION](generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS](llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR](llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_STREAM_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED](llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_TTS\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_TTS\\_ENGINE\\_ERROR](tts/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TTS_ENGINE_ERROR.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_COLLECTION\\_FAILED\n\nRe-exports [E\\_VECTOR\\_STORE\\_COLLECTION\\_FAILED](vector/exceptions/variables/E_VECTOR_STORE_COLLECTION_FAILED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_CONNECTION\\_FAILED\n\nRe-exports [E\\_VECTOR\\_STORE\\_CONNECTION\\_FAILED](vector/exceptions/variables/E_VECTOR_STORE_CONNECTION_FAILED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_CONSISTENCY\\_TIMEOUT\n\nRe-exports [E\\_VECTOR\\_STORE\\_CONSISTENCY\\_TIMEOUT](vector/exceptions/variables/E_VECTOR_STORE_CONSISTENCY_TIMEOUT.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_DELETE\\_FAILED\n\nRe-exports [E\\_VECTOR\\_STORE\\_DELETE\\_FAILED](vector/exceptions/variables/E_VECTOR_STORE_DELETE_FAILED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_DIMENSION\\_MISMATCH\n\nRe-exports [E\\_VECTOR\\_STORE\\_DIMENSION\\_MISMATCH](vector/exceptions/variables/E_VECTOR_STORE_DIMENSION_MISMATCH.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_DRIVER\\_UNAVAILABLE\n\nRe-exports [E\\_VECTOR\\_STORE\\_DRIVER\\_UNAVAILABLE](vector/exceptions/variables/E_VECTOR_STORE_DRIVER_UNAVAILABLE.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_ENCODER\\_REQUIRED\n\nRe-exports [E\\_VECTOR\\_STORE\\_ENCODER\\_REQUIRED](vector/exceptions/variables/E_VECTOR_STORE_ENCODER_REQUIRED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_MIGRATION\\_FAILED\n\nRe-exports [E\\_VECTOR\\_STORE\\_MIGRATION\\_FAILED](vector/exceptions/variables/E_VECTOR_STORE_MIGRATION_FAILED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_PROJECTION\\_REQUIRED\n\nRe-exports [E\\_VECTOR\\_STORE\\_PROJECTION\\_REQUIRED](vector/exceptions/variables/E_VECTOR_STORE_PROJECTION_REQUIRED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_QUERY\\_CONFLICT\n\nRe-exports [E\\_VECTOR\\_STORE\\_QUERY\\_CONFLICT](vector/exceptions/variables/E_VECTOR_STORE_QUERY_CONFLICT.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_RAW\\_BINDING\\_MISMATCH\n\nRe-exports [E\\_VECTOR\\_STORE\\_RAW\\_BINDING\\_MISMATCH](vector/exceptions/variables/E_VECTOR_STORE_RAW_BINDING_MISMATCH.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_SEARCH\\_FAILED\n\nRe-exports [E\\_VECTOR\\_STORE\\_SEARCH\\_FAILED](vector/exceptions/variables/E_VECTOR_STORE_SEARCH_FAILED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_TRANSACTIONS\\_UNSUPPORTED\n\nRe-exports [E\\_VECTOR\\_STORE\\_TRANSACTIONS\\_UNSUPPORTED](vector/exceptions/variables/E_VECTOR_STORE_TRANSACTIONS_UNSUPPORTED.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_UNSUPPORTED\\_FILTER\\_OPERATOR\n\nRe-exports [E\\_VECTOR\\_STORE\\_UNSUPPORTED\\_FILTER\\_OPERATOR](vector/exceptions/variables/E_VECTOR_STORE_UNSUPPORTED_FILTER_OPERATOR.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_UNSUPPORTED\\_OPERATION\n\nRe-exports [E\\_VECTOR\\_STORE\\_UNSUPPORTED\\_OPERATION](vector/exceptions/variables/E_VECTOR_STORE_UNSUPPORTED_OPERATION.md)\n\n***\n\n### E\\_VECTOR\\_STORE\\_UPSERT\\_FAILED\n\nRe-exports [E\\_VECTOR\\_STORE\\_UPSERT\\_FAILED](vector/exceptions/variables/E_VECTOR_STORE_UPSERT_FAILED.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR.md)\n\n***\n\n### EDIT\\_IMAGE\\_FIELD\\_NAME\n\nRe-exports [EDIT\\_IMAGE\\_FIELD\\_NAME](generation/openai/adapter/variables/EDIT_IMAGE_FIELD_NAME.md)\n\n***\n\n### EditOptions\n\nRe-exports [EditOptions](generation/openai/types/interfaces/EditOptions.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](embeddings/openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbeddingsLike\n\nRe-exports [EmbeddingsLike](vector/factory/interfaces/EmbeddingsLike.md)\n\n***\n\n### EmbeddingsRetryConfig\n\nRe-exports [EmbeddingsRetryConfig](embeddings/openai/types/interfaces/EmbeddingsRetryConfig.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](embeddings/openai/types/interfaces/EmbedOptions.md)\n\n***\n\n### EncodeKind\n\nRe-exports [EncodeKind](vector/types/type-aliases/EncodeKind.md)\n\n***\n\n### EncodeRawImageFn\n\nRe-exports [EncodeRawImageFn](generation/transformers_js/types/type-aliases/EncodeRawImageFn.md)\n\n***\n\n### encoderFromEmbeddings\n\nRe-exports [encoderFromEmbeddings](vector/factory/functions/encoderFromEmbeddings.md)\n\n***\n\n### encodeTextTool\n\nRe-exports [encodeTextTool](tools/encoding/variables/encodeTextTool.md)\n\n***\n\n### EnsureCollectionOptions\n\nRe-exports [EnsureCollectionOptions](vector/types/interfaces/EnsureCollectionOptions.md)\n\n***\n\n### Estimable\n\nRe-exports [Estimable](context/thrift/contracts/interfaces/Estimable.md)\n\n***\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](context/thrift/contracts/type-aliases/EstimateTokensFn.md)\n\n***\n\n### EstimatorOptions\n\nRe-exports [EstimatorOptions](context/thrift/subtractive_pass/interfaces/EstimatorOptions.md)\n\n***\n\n### evaluateFilter\n\nRe-exports [evaluateFilter](vector/filters/functions/evaluateFilter.md)\n\n***\n\n### evaluateKatexTool\n\nRe-exports [evaluateKatexTool](tools/math/variables/evaluateKatexTool.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](llm/openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### FieldChain\n\nRe-exports [FieldChain](vector/schema/interfaces/FieldChain.md)\n\n***\n\n### FilterBuilder\n\nRe-exports [FilterBuilder](vector/builder/classes/FilterBuilder.md)\n\n***\n\n### FilterCallback\n\nRe-exports [FilterCallback](vector/builder/type-aliases/FilterCallback.md)\n\n***\n\n### FilterCondition\n\nRe-exports [FilterCondition](vector/filters/interfaces/FilterCondition.md)\n\n***\n\n### FilterGroup\n\nRe-exports [FilterGroup](vector/filters/interfaces/FilterGroup.md)\n\n***\n\n### FilterOperator\n\nRe-exports [FilterOperator](vector/filters/type-aliases/FilterOperator.md)\n\n***\n\n### formatListTool\n\nRe-exports [formatListTool](tools/formatting/variables/formatListTool.md)\n\n***\n\n### formatNumberTool\n\nRe-exports [formatNumberTool](tools/formatting/variables/formatNumberTool.md)\n\n***\n\n### formatTableTool\n\nRe-exports [formatTableTool](tools/structured_data/variables/formatTableTool.md)\n\n***\n\n### GeminiContent\n\nRe-exports [GeminiContent](generation/gemini/types/interfaces/GeminiContent.md)\n\n***\n\n### GeminiEditOptions\n\nRe-exports [GeminiEditOptions](generation/gemini/types/interfaces/GeminiEditOptions.md)\n\n***\n\n### GeminiGenerateContentRequestBody\n\nRe-exports [GeminiGenerateContentRequestBody](generation/gemini/types/interfaces/GeminiGenerateContentRequestBody.md)\n\n***\n\n### GeminiGenerateContentResponse\n\nRe-exports [GeminiGenerateContentResponse](generation/gemini/types/interfaces/GeminiGenerateContentResponse.md)\n\n***\n\n### GeminiGenerateOptions\n\nRe-exports [GeminiGenerateOptions](generation/gemini/types/interfaces/GeminiGenerateOptions.md)\n\n***\n\n### GeminiGenerationAdapter\n\nRe-exports [GeminiGenerationAdapter](generation/gemini/adapter/classes/GeminiGenerationAdapter.md)\n\n***\n\n### GeminiGenerationAdapterOptions\n\nRe-exports [GeminiGenerationAdapterOptions](generation/gemini/types/interfaces/GeminiGenerationAdapterOptions.md)\n\n***\n\n### GeminiGenerationConfig\n\nRe-exports [GeminiGenerationConfig](generation/gemini/types/interfaces/GeminiGenerationConfig.md)\n\n***\n\n### geminiGenerationOptionsSchema\n\nRe-exports [geminiGenerationOptionsSchema](generation/gemini/validation/variables/geminiGenerationOptionsSchema.md)\n\n***\n\n### GeminiRequestPart\n\nRe-exports [GeminiRequestPart](generation/gemini/types/type-aliases/GeminiRequestPart.md)\n\n***\n\n### GeminiResponseModality\n\nRe-exports [GeminiResponseModality](generation/gemini/types/type-aliases/GeminiResponseModality.md)\n\n***\n\n### GeminiResponsePart\n\nRe-exports [GeminiResponsePart](generation/gemini/types/type-aliases/GeminiResponsePart.md)\n\n***\n\n### GenerateOptions\n\nRe-exports [GenerateOptions](generation/openai/types/interfaces/GenerateOptions.md)\n\n***\n\n### GenerationBytesInput\n\nRe-exports [GenerationBytesInput](generation/_shared/interfaces/GenerationBytesInput.md)\n\n***\n\n### GenerationImageInput\n\nRe-exports [GenerationImageInput](generation/_shared/type-aliases/GenerationImageInput.md)\n\n***\n\n### GenerationMediaLike\n\nRe-exports [GenerationMediaLike](generation/_shared/interfaces/GenerationMediaLike.md)\n\n***\n\n### GenerationRetryConfig\n\nRe-exports [GenerationRetryConfig](generation/openai/types/interfaces/GenerationRetryConfig.md)\n\n***\n\n### geoBboxContainsTool\n\nRe-exports [geoBboxContainsTool](tools/geo_basics/variables/geoBboxContainsTool.md)\n\n***\n\n### geoDistanceTool\n\nRe-exports [geoDistanceTool](tools/geo_basics/variables/geoDistanceTool.md)\n\n***\n\n### geoWithinRadiusTool\n\nRe-exports [geoWithinRadiusTool](tools/geo_basics/variables/geoWithinRadiusTool.md)\n\n***\n\n### getCurrentTimeTool\n\nRe-exports [getCurrentTimeTool](tools/time/variables/getCurrentTimeTool.md)\n\n***\n\n### groupHistoryIntoTurns\n\nRe-exports [groupHistoryIntoTurns](context/thrift/relevance/functions/groupHistoryIntoTurns.md)\n\n***\n\n### HistoryTurn\n\nRe-exports [HistoryTurn](context/thrift/relevance/interfaces/HistoryTurn.md)\n\n***\n\n### implementsVectorStoreConstructor\n\nRe-exports [implementsVectorStoreConstructor](vector/vector_store_constructor/functions/implementsVectorStoreConstructor.md)\n\n***\n\n### InMemoryVectorStore\n\nRe-exports [InMemoryVectorStore](vector/in_memory/classes/InMemoryVectorStore.md)\n\n***\n\n### InMemoryVectorStoreOptions\n\nRe-exports [InMemoryVectorStoreOptions](vector/in_memory/interfaces/InMemoryVectorStoreOptions.md)\n\n***\n\n### IsEphemeralMessageFn\n\nRe-exports [IsEphemeralMessageFn](context/thrift/contracts/type-aliases/IsEphemeralMessageFn.md)\n\n***\n\n### isFilterCondition\n\nRe-exports [isFilterCondition](vector/filters/functions/isFilterCondition.md)\n\n***\n\n### isFilterGroup\n\nRe-exports [isFilterGroup](vector/filters/functions/isFilterGroup.md)\n\n***\n\n### isFiniteVector\n\nRe-exports [isFiniteVector](vector/helpers/functions/isFiniteVector.md)\n\n***\n\n### isPcmInput\n\nRe-exports [isPcmInput](specialists/_shared/functions/isPcmInput.md)\n\n***\n\n### isRawExpr\n\nRe-exports [isRawExpr](vector/filters/functions/isRawExpr.md)\n\n***\n\n### isRawFilter\n\nRe-exports [isRawFilter](vector/filters/functions/isRawFilter.md)\n\n***\n\n### IsSummaryMessageFn\n\nRe-exports [IsSummaryMessageFn](context/thrift/contracts/type-aliases/IsSummaryMessageFn.md)\n\n***\n\n### jsonFormatTool\n\nRe-exports [jsonFormatTool](tools/structured_data/variables/jsonFormatTool.md)\n\n***\n\n### jsonTransformTool\n\nRe-exports [jsonTransformTool](tools/data_structure/variables/jsonTransformTool.md)\n\n***\n\n### listMemoriesTool\n\nRe-exports [listMemoriesTool](tools/memory/variables/listMemoriesTool.md)\n\n***\n\n### listRetrievablesTool\n\nRe-exports [listRetrievablesTool](tools/retrievables/variables/listRetrievablesTool.md)\n\n***\n\n### listStandingInstructionsTool\n\nRe-exports [listStandingInstructionsTool](tools/standing_instructions/variables/listStandingInstructionsTool.md)\n\n***\n\n### LiteRtLmAdapter\n\nRe-exports [LiteRtLmAdapter](llm/litert_lm/adapter/classes/LiteRtLmAdapter.md)\n\n***\n\n### LiteRtLmAdapterOptions\n\nRe-exports [LiteRtLmAdapterOptions](llm/litert_lm/types/interfaces/LiteRtLmAdapterOptions.md)\n\n***\n\n### LiteRtLmConversation\n\nRe-exports [LiteRtLmConversation](llm/litert_lm/types/type-aliases/LiteRtLmConversation.md)\n\n***\n\n### LiteRtLmEngine\n\nRe-exports [LiteRtLmEngine](llm/litert_lm/types/type-aliases/LiteRtLmEngine.md)\n\n***\n\n### liteRtLmOptionsSchema\n\nRe-exports [liteRtLmOptionsSchema](llm/litert_lm/validation/variables/liteRtLmOptionsSchema.md)\n\n***\n\n### mapMetric\n\nRe-exports [mapMetric](vector/helpers/functions/mapMetric.md)\n\n***\n\n### memoryTools\n\nRe-exports [memoryTools](tools/memory/variables/memoryTools.md)\n\n***\n\n### MigrationLedger\n\nRe-exports [MigrationLedger](vector/migrate/interfaces/MigrationLedger.md)\n\n***\n\n### MillisTimestamp\n\nRe-exports [MillisTimestamp](context/thrift/contracts/interfaces/MillisTimestamp.md)\n\n***\n\n### normalizeScore\n\nRe-exports [normalizeScore](vector/helpers/functions/normalizeScore.md)\n\n***\n\n### OllamaAdapter\n\nRe-exports [OllamaAdapter](llm/ollama/adapter/classes/OllamaAdapter.md)\n\n***\n\n### OllamaAdapterOptions\n\nRe-exports [OllamaAdapterOptions](llm/ollama/types/interfaces/OllamaAdapterOptions.md)\n\n***\n\n### OllamaChatRequestBody\n\nRe-exports [OllamaChatRequestBody](llm/ollama/types/interfaces/OllamaChatRequestBody.md)\n\n***\n\n### OllamaChatResponse\n\nRe-exports [OllamaChatResponse](llm/ollama/types/interfaces/OllamaChatResponse.md)\n\n***\n\n### OllamaChatStreamChunk\n\nRe-exports [OllamaChatStreamChunk](llm/ollama/types/interfaces/OllamaChatStreamChunk.md)\n\n***\n\n### OllamaEmbeddingsAdapter\n\nRe-exports [OllamaEmbeddingsAdapter](embeddings/ollama/adapter/classes/OllamaEmbeddingsAdapter.md)\n\n***\n\n### OllamaEmbeddingsAdapterOptions\n\nRe-exports [OllamaEmbeddingsAdapterOptions](embeddings/ollama/types/interfaces/OllamaEmbeddingsAdapterOptions.md)\n\n***\n\n### ollamaEmbeddingsOptionsSchema\n\nRe-exports [ollamaEmbeddingsOptionsSchema](embeddings/ollama/validation/variables/ollamaEmbeddingsOptionsSchema.md)\n\n***\n\n### OllamaEmbeddingsRequestBody\n\nRe-exports [OllamaEmbeddingsRequestBody](embeddings/ollama/types/interfaces/OllamaEmbeddingsRequestBody.md)\n\n***\n\n### OllamaEmbeddingsResponseBody\n\nRe-exports [OllamaEmbeddingsResponseBody](embeddings/ollama/types/interfaces/OllamaEmbeddingsResponseBody.md)\n\n***\n\n### OllamaEmbeddingsRuntimeOptions\n\nRe-exports [OllamaEmbeddingsRuntimeOptions](embeddings/ollama/types/interfaces/OllamaEmbeddingsRuntimeOptions.md)\n\n***\n\n### OllamaFormat\n\nRe-exports [OllamaFormat](llm/ollama/types/type-aliases/OllamaFormat.md)\n\n***\n\n### OllamaHelpers\n\nRe-exports [OllamaHelpers](llm/ollama/types/interfaces/OllamaHelpers.md)\n\n***\n\n### OllamaMessage\n\nRe-exports [OllamaMessage](llm/ollama/types/interfaces/OllamaMessage.md)\n\n***\n\n### ollamaOptionsSchema\n\nRe-exports [ollamaOptionsSchema](llm/ollama/validation/variables/ollamaOptionsSchema.md)\n\n***\n\n### OllamaRuntimeOptions\n\nRe-exports [OllamaRuntimeOptions](llm/ollama/types/interfaces/OllamaRuntimeOptions.md)\n\n***\n\n### OllamaThink\n\nRe-exports [OllamaThink](llm/ollama/types/type-aliases/OllamaThink.md)\n\n***\n\n### OllamaTool\n\nRe-exports [OllamaTool](llm/ollama/types/type-aliases/OllamaTool.md)\n\n***\n\n### OllamaToolCall\n\nRe-exports [OllamaToolCall](llm/ollama/types/interfaces/OllamaToolCall.md)\n\n***\n\n### OnCostFn\n\nRe-exports [OnCostFn](context/compact/contracts/type-aliases/OnCostFn.md)\n\n***\n\n### OpenAIChatCompletionsAdapter\n\nRe-exports [OpenAIChatCompletionsAdapter](llm/openai_chat_completions/adapter/classes/OpenAIChatCompletionsAdapter.md)\n\n***\n\n### OpenAIChatCompletionsAdapterOptions\n\nRe-exports [OpenAIChatCompletionsAdapterOptions](llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md)\n\n***\n\n### openAIChatCompletionsOptionsSchema\n\nRe-exports [openAIChatCompletionsOptionsSchema](llm/openai_chat_completions/validation/variables/openAIChatCompletionsOptionsSchema.md)\n\n***\n\n### OpenAIChatCompletionsRequestBody\n\nRe-exports [OpenAIChatCompletionsRequestBody](llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsRequestBody.md)\n\n***\n\n### OpenAIEditOptions\n\nRe-exports [OpenAIEditOptions](generation/openai/types/interfaces/OpenAIEditOptions.md)\n\n***\n\n### OpenAIEmbeddingsAdapter\n\nRe-exports [OpenAIEmbeddingsAdapter](embeddings/openai/adapter/classes/OpenAIEmbeddingsAdapter.md)\n\n***\n\n### OpenAIEmbeddingsAdapterOptions\n\nRe-exports [OpenAIEmbeddingsAdapterOptions](embeddings/openai/types/interfaces/OpenAIEmbeddingsAdapterOptions.md)\n\n***\n\n### openAIEmbeddingsOptionsSchema\n\nRe-exports [openAIEmbeddingsOptionsSchema](embeddings/openai/validation/variables/openAIEmbeddingsOptionsSchema.md)\n\n***\n\n### OpenAIEmbeddingsRequestBody\n\nRe-exports [OpenAIEmbeddingsRequestBody](embeddings/openai/types/interfaces/OpenAIEmbeddingsRequestBody.md)\n\n***\n\n### OpenAIEmbeddingsResponseBody\n\nRe-exports [OpenAIEmbeddingsResponseBody](embeddings/openai/types/interfaces/OpenAIEmbeddingsResponseBody.md)\n\n***\n\n### OpenAIGenerateOptions\n\nRe-exports [OpenAIGenerateOptions](generation/openai/types/interfaces/OpenAIGenerateOptions.md)\n\n***\n\n### OpenAIGenerationAdapter\n\nRe-exports [OpenAIGenerationAdapter](generation/openai/adapter/classes/OpenAIGenerationAdapter.md)\n\n***\n\n### OpenAIGenerationAdapterOptions\n\nRe-exports [OpenAIGenerationAdapterOptions](generation/openai/types/interfaces/OpenAIGenerationAdapterOptions.md)\n\n***\n\n### openAIGenerationOptionsSchema\n\nRe-exports [openAIGenerationOptionsSchema](generation/openai/validation/variables/openAIGenerationOptionsSchema.md)\n\n***\n\n### OpenAIImagesGenerationRequestBody\n\nRe-exports [OpenAIImagesGenerationRequestBody](generation/openai/types/interfaces/OpenAIImagesGenerationRequestBody.md)\n\n***\n\n### OpenAIImagesResponse\n\nRe-exports [OpenAIImagesResponse](generation/openai/types/interfaces/OpenAIImagesResponse.md)\n\n***\n\n### OpenAIResponsesAdapter\n\nRe-exports [OpenAIResponsesAdapter](llm/openai_responses/adapter/classes/OpenAIResponsesAdapter.md)\n\n***\n\n### OpenAIResponsesAdapterOptions\n\nRe-exports [OpenAIResponsesAdapterOptions](llm/openai_responses/types/interfaces/OpenAIResponsesAdapterOptions.md)\n\n***\n\n### OpenAIResponsesCompletedEvent\n\nRe-exports [OpenAIResponsesCompletedEvent](llm/openai_responses/types/interfaces/OpenAIResponsesCompletedEvent.md)\n\n***\n\n### OpenAIResponsesErrorEvent\n\nRe-exports [OpenAIResponsesErrorEvent](llm/openai_responses/types/interfaces/OpenAIResponsesErrorEvent.md)\n\n***\n\n### OpenAIResponsesFailedEvent\n\nRe-exports [OpenAIResponsesFailedEvent](llm/openai_responses/types/interfaces/OpenAIResponsesFailedEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallArgumentsDeltaEvent\n\nRe-exports [OpenAIResponsesFunctionCallArgumentsDeltaEvent](llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallArgumentsDoneEvent\n\nRe-exports [OpenAIResponsesFunctionCallArgumentsDoneEvent](llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallItem\n\nRe-exports [OpenAIResponsesFunctionCallItem](llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallItem.md)\n\n***\n\n### OpenAIResponsesFunctionCallOutputItem\n\nRe-exports [OpenAIResponsesFunctionCallOutputItem](llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallOutputItem.md)\n\n***\n\n### OpenAIResponsesHelpers\n\nRe-exports [OpenAIResponsesHelpers](llm/openai_responses/types/interfaces/OpenAIResponsesHelpers.md)\n\n***\n\n### OpenAIResponsesIncludable\n\nRe-exports [OpenAIResponsesIncludable](llm/openai_responses/types/type-aliases/OpenAIResponsesIncludable.md)\n\n***\n\n### OpenAIResponsesIncompleteEvent\n\nRe-exports [OpenAIResponsesIncompleteEvent](llm/openai_responses/types/interfaces/OpenAIResponsesIncompleteEvent.md)\n\n***\n\n### OpenAIResponsesInputContentBlock\n\nRe-exports [OpenAIResponsesInputContentBlock](llm/openai_responses/types/type-aliases/OpenAIResponsesInputContentBlock.md)\n\n***\n\n### OpenAIResponsesInputItem\n\nRe-exports [OpenAIResponsesInputItem](llm/openai_responses/types/type-aliases/OpenAIResponsesInputItem.md)\n\n***\n\n### OpenAIResponsesMessageItem\n\nRe-exports [OpenAIResponsesMessageItem](llm/openai_responses/types/interfaces/OpenAIResponsesMessageItem.md)\n\n***\n\n### OpenAIResponsesOpaqueOutputItem\n\nRe-exports [OpenAIResponsesOpaqueOutputItem](llm/openai_responses/types/interfaces/OpenAIResponsesOpaqueOutputItem.md)\n\n***\n\n### openAIResponsesOptionsSchema\n\nRe-exports [openAIResponsesOptionsSchema](llm/openai_responses/validation/variables/openAIResponsesOptionsSchema.md)\n\n***\n\n### OpenAIResponsesOutputItem\n\nRe-exports [OpenAIResponsesOutputItem](llm/openai_responses/types/type-aliases/OpenAIResponsesOutputItem.md)\n\n***\n\n### OpenAIResponsesOutputItemAddedEvent\n\nRe-exports [OpenAIResponsesOutputItemAddedEvent](llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemAddedEvent.md)\n\n***\n\n### OpenAIResponsesOutputItemDoneEvent\n\nRe-exports [OpenAIResponsesOutputItemDoneEvent](llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemDoneEvent.md)\n\n***\n\n### OpenAIResponsesOutputMessageContentPart\n\nRe-exports [OpenAIResponsesOutputMessageContentPart](llm/openai_responses/types/type-aliases/OpenAIResponsesOutputMessageContentPart.md)\n\n***\n\n### OpenAIResponsesOutputMessageItem\n\nRe-exports [OpenAIResponsesOutputMessageItem](llm/openai_responses/types/interfaces/OpenAIResponsesOutputMessageItem.md)\n\n***\n\n### OpenAIResponsesOutputTextDeltaEvent\n\nRe-exports [OpenAIResponsesOutputTextDeltaEvent](llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesOutputTextDoneEvent\n\nRe-exports [OpenAIResponsesOutputTextDoneEvent](llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesReasoningContentPart\n\nRe-exports [OpenAIResponsesReasoningContentPart](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningContentPart.md)\n\n***\n\n### OpenAIResponsesReasoningItem\n\nRe-exports [OpenAIResponsesReasoningItem](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningItem.md)\n\n***\n\n### OpenAIResponsesReasoningReplayPayload\n\nRe-exports [OpenAIResponsesReasoningReplayPayload](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningReplayPayload.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryPart\n\nRe-exports [OpenAIResponsesReasoningSummaryPart](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryPart.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryTextDeltaEvent\n\nRe-exports [OpenAIResponsesReasoningSummaryTextDeltaEvent](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryTextDoneEvent\n\nRe-exports [OpenAIResponsesReasoningSummaryTextDoneEvent](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesReasoningTextDeltaEvent\n\nRe-exports [OpenAIResponsesReasoningTextDeltaEvent](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesReasoningTextDoneEvent\n\nRe-exports [OpenAIResponsesReasoningTextDoneEvent](llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesRefusalDeltaEvent\n\nRe-exports [OpenAIResponsesRefusalDeltaEvent](llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDeltaEvent.md)\n\n***\n\n### OpenAIResponsesRefusalDoneEvent\n\nRe-exports [OpenAIResponsesRefusalDoneEvent](llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDoneEvent.md)\n\n***\n\n### OpenAIResponsesRequestBody\n\nRe-exports [OpenAIResponsesRequestBody](llm/openai_responses/types/interfaces/OpenAIResponsesRequestBody.md)\n\n***\n\n### OpenAIResponsesResponseObject\n\nRe-exports [OpenAIResponsesResponseObject](llm/openai_responses/types/interfaces/OpenAIResponsesResponseObject.md)\n\n***\n\n### OpenAIResponsesStreamEvent\n\nRe-exports [OpenAIResponsesStreamEvent](llm/openai_responses/types/type-aliases/OpenAIResponsesStreamEvent.md)\n\n***\n\n### OpenAIResponsesTool\n\nRe-exports [OpenAIResponsesTool](llm/openai_responses/types/type-aliases/OpenAIResponsesTool.md)\n\n***\n\n### OpenAIResponsesToolChoice\n\nRe-exports [OpenAIResponsesToolChoice](llm/openai_responses/types/type-aliases/OpenAIResponsesToolChoice.md)\n\n***\n\n### OpenAIResponsesUsage\n\nRe-exports [OpenAIResponsesUsage](llm/openai_responses/types/interfaces/OpenAIResponsesUsage.md)\n\n***\n\n### OramaVectorStore\n\nRe-exports [OramaVectorStore](vector/orama/classes/OramaVectorStore.md)\n\n***\n\n### OramaVectorStoreOptions\n\nRe-exports [OramaVectorStoreOptions](vector/orama/interfaces/OramaVectorStoreOptions.md)\n\n***\n\n### parseCsvTool\n\nRe-exports [parseCsvTool](tools/parsing/variables/parseCsvTool.md)\n\n***\n\n### parseKvTool\n\nRe-exports [parseKvTool](tools/parsing/variables/parseKvTool.md)\n\n***\n\n### parseYamlTool\n\nRe-exports [parseYamlTool](tools/parsing/variables/parseYamlTool.md)\n\n***\n\n### PlanSink\n\nRe-exports [PlanSink](vector/builder/interfaces/PlanSink.md)\n\n***\n\n### Projection\n\nRe-exports [Projection](vector/plan/interfaces/Projection.md)\n\n***\n\n### raw\n\nRe-exports [raw](vector/filters/functions/raw.md)\n\n***\n\n### RawAudioLike\n\nRe-exports [RawAudioLike](tts/_shared/interfaces/RawAudioLike.md)\n\n***\n\n### RawExpr\n\nRe-exports [RawExpr](vector/filters/interfaces/RawExpr.md)\n\n***\n\n### RawFilter\n\nRe-exports [RawFilter](vector/filters/interfaces/RawFilter.md)\n\n***\n\n### ReasoningExtract\n\nRe-exports [ReasoningExtract](llm/openai_chat_completions/types/interfaces/ReasoningExtract.md)\n\n***\n\n### ReasoningField\n\nRe-exports [ReasoningField](llm/openai_chat_completions/types/type-aliases/ReasoningField.md)\n\n***\n\n### ReasoningFieldPrecedence\n\nRe-exports [ReasoningFieldPrecedence](llm/openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md)\n\n***\n\n### ReasoningParserFn\n\nRe-exports [ReasoningParserFn](llm/transformers_js/helpers/type-aliases/ReasoningParserFn.md)\n\n***\n\n### ReasoningParserName\n\nRe-exports [ReasoningParserName](llm/transformers_js/helpers/type-aliases/ReasoningParserName.md)\n\n***\n\n### ReasoningReplayMode\n\nRe-exports [ReasoningReplayMode](llm/openai_responses/types/type-aliases/ReasoningReplayMode.md)\n\n***\n\n### RecognizeOptions\n\nRe-exports [RecognizeOptions](specialists/ocr/tesseract_js/types/interfaces/RecognizeOptions.md)\n\n***\n\n### RecognizeResult\n\nRe-exports [RecognizeResult](specialists/ocr/tesseract_js/types/interfaces/RecognizeResult.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_CURVE\n\nRe-exports [RELEVANCE\\_FLOOR\\_CURVE](context/thrift/relevance/variables/RELEVANCE_FLOOR_CURVE.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_MAX\n\nRe-exports [RELEVANCE\\_FLOOR\\_MAX](context/thrift/relevance/variables/RELEVANCE_FLOOR_MAX.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_MIN\n\nRe-exports [RELEVANCE\\_FLOOR\\_MIN](context/thrift/relevance/variables/RELEVANCE_FLOOR_MIN.md)\n\n***\n\n### RelevanceMessage\n\nRe-exports [RelevanceMessage](context/thrift/relevance/interfaces/RelevanceMessage.md)\n\n***\n\n### RelevanceToolCall\n\nRe-exports [RelevanceToolCall](context/thrift/relevance/interfaces/RelevanceToolCall.md)\n\n***\n\n### relevanceToQuery\n\nRe-exports [relevanceToQuery](context/thrift/relevance/functions/relevanceToQuery.md)\n\n***\n\n### removeStandingInstructionTool\n\nRe-exports [removeStandingInstructionTool](tools/standing_instructions/variables/removeStandingInstructionTool.md)\n\n***\n\n### renderChatCompletionsToolCallResult\n\nRe-exports [renderChatCompletionsToolCallResult](llm/openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult.md)\n\n***\n\n### renderTimelineMessage\n\nRe-exports [renderTimelineMessage](llm/openai_chat_completions/helpers/functions/renderTimelineMessage.md)\n\n***\n\n### RenderToolsFn\n\nRe-exports [RenderToolsFn](context/thrift/contracts/type-aliases/RenderToolsFn.md)\n\n***\n\n### resolveBudget\n\nRe-exports [resolveBudget](context/thrift/subtractive_pass/functions/resolveBudget.md)\n\n***\n\n### resolveClientCtor\n\nRe-exports [resolveClientCtor](vector/validation/functions/resolveClientCtor.md)\n\n***\n\n### Resolver\n\nRe-exports [Resolver](tools/web_retrieval/type-aliases/Resolver.md)\n\n***\n\n### ResponsesOutputSlot\n\nRe-exports [ResponsesOutputSlot](llm/openai_responses/types/type-aliases/ResponsesOutputSlot.md)\n\n***\n\n### ResponsesOutputSlotMachine\n\nRe-exports [ResponsesOutputSlotMachine](llm/openai_responses/types/interfaces/ResponsesOutputSlotMachine.md)\n\n***\n\n### ResponsesTextSlot\n\nRe-exports [ResponsesTextSlot](llm/openai_responses/types/interfaces/ResponsesTextSlot.md)\n\n***\n\n### ResponsesThinkingSlot\n\nRe-exports [ResponsesThinkingSlot](llm/openai_responses/types/interfaces/ResponsesThinkingSlot.md)\n\n***\n\n### ResponsesToolCallSlot\n\nRe-exports [ResponsesToolCallSlot](llm/openai_responses/types/interfaces/ResponsesToolCallSlot.md)\n\n***\n\n### RetrievableCtor\n\nRe-exports [RetrievableCtor](tools/web_retrieval/type-aliases/RetrievableCtor.md)\n\n***\n\n### RetrievableStoreCtx\n\nRe-exports [RetrievableStoreCtx](tools/web_retrieval/interfaces/RetrievableStoreCtx.md)\n\n***\n\n### retrievableTools\n\nRe-exports [retrievableTools](tools/retrievables/variables/retrievableTools.md)\n\n***\n\n### sanitizeMetadata\n\nRe-exports [sanitizeMetadata](vector/helpers/functions/sanitizeMetadata.md)\n\n***\n\n### scaledRelevanceFloor\n\nRe-exports [scaledRelevanceFloor](context/thrift/relevance/functions/scaledRelevanceFloor.md)\n\n***\n\n### SchemaExecutor\n\nRe-exports [SchemaExecutor](vector/schema/interfaces/SchemaExecutor.md)\n\n***\n\n### ScoreKind\n\nRe-exports [ScoreKind](vector/helpers/type-aliases/ScoreKind.md)\n\n***\n\n### ScrapperArticle\n\nRe-exports [ScrapperArticle](tools/scrapper/interfaces/ScrapperArticle.md)\n\n***\n\n### ScrapperArticleConfig\n\nRe-exports [ScrapperArticleConfig](tools/scrapper/type-aliases/ScrapperArticleConfig.md)\n\n***\n\n### ScrapperArticleConfigSync\n\nRe-exports [ScrapperArticleConfigSync](tools/scrapper/type-aliases/ScrapperArticleConfigSync.md)\n\n***\n\n### ScrapperArticleLike\n\nRe-exports [ScrapperArticleLike](tools/web_retrieval/interfaces/ScrapperArticleLike.md)\n\n***\n\n### ScrapperArticleParams\n\nRe-exports [ScrapperArticleParams](tools/scrapper/interfaces/ScrapperArticleParams.md)\n\n***\n\n### scrapperArticleToRetrievable\n\nRe-exports [scrapperArticleToRetrievable](tools/web_retrieval/functions/scrapperArticleToRetrievable.md)\n\n***\n\n### ScrapperCommonParams\n\nRe-exports [ScrapperCommonParams](tools/scrapper/interfaces/ScrapperCommonParams.md)\n\n***\n\n### ScrapperLink\n\nRe-exports [ScrapperLink](tools/scrapper/interfaces/ScrapperLink.md)\n\n***\n\n### ScrapperLinkLike\n\nRe-exports [ScrapperLinkLike](tools/web_retrieval/interfaces/ScrapperLinkLike.md)\n\n***\n\n### ScrapperLinks\n\nRe-exports [ScrapperLinks](tools/scrapper/interfaces/ScrapperLinks.md)\n\n***\n\n### ScrapperLinksConfig\n\nRe-exports [ScrapperLinksConfig](tools/scrapper/type-aliases/ScrapperLinksConfig.md)\n\n***\n\n### ScrapperLinksConfigSync\n\nRe-exports [ScrapperLinksConfigSync](tools/scrapper/type-aliases/ScrapperLinksConfigSync.md)\n\n***\n\n### ScrapperLinksLike\n\nRe-exports [ScrapperLinksLike](tools/web_retrieval/interfaces/ScrapperLinksLike.md)\n\n***\n\n### ScrapperLinksParams\n\nRe-exports [ScrapperLinksParams](tools/scrapper/interfaces/ScrapperLinksParams.md)\n\n***\n\n### scrapperLinksToRetrievables\n\nRe-exports [scrapperLinksToRetrievables](tools/web_retrieval/functions/scrapperLinksToRetrievables.md)\n\n***\n\n### SearchPlan\n\nRe-exports [SearchPlan](vector/plan/interfaces/SearchPlan.md)\n\n***\n\n### SearxngHeaders\n\nRe-exports [SearxngHeaders](tools/searxng/type-aliases/SearxngHeaders.md)\n\n***\n\n### SearxngHeadersResolver\n\nRe-exports [SearxngHeadersResolver](tools/searxng/type-aliases/SearxngHeadersResolver.md)\n\n***\n\n### SearxngInputMiddlewareFn\n\nRe-exports [SearxngInputMiddlewareFn](tools/searxng/type-aliases/SearxngInputMiddlewareFn.md)\n\n***\n\n### SearxngOutputMiddlewareFn\n\nRe-exports [SearxngOutputMiddlewareFn](tools/searxng/type-aliases/SearxngOutputMiddlewareFn.md)\n\n***\n\n### SearxngPayloadLike\n\nRe-exports [SearxngPayloadLike](tools/web_retrieval/interfaces/SearxngPayloadLike.md)\n\n***\n\n### SearxngRequestContext\n\nRe-exports [SearxngRequestContext](tools/searxng/interfaces/SearxngRequestContext.md)\n\n***\n\n### SearxngResponseContext\n\nRe-exports [SearxngResponseContext](tools/searxng/interfaces/SearxngResponseContext.md)\n\n***\n\n### SearxngResult\n\nRe-exports [SearxngResult](tools/searxng/interfaces/SearxngResult.md)\n\n***\n\n### SearxngResultFormat\n\nRe-exports [SearxngResultFormat](tools/searxng/type-aliases/SearxngResultFormat.md)\n\n***\n\n### SearxngResultLike\n\nRe-exports [SearxngResultLike](tools/web_retrieval/interfaces/SearxngResultLike.md)\n\n***\n\n### searxngResultsToRetrievables\n\nRe-exports [searxngResultsToRetrievables](tools/web_retrieval/functions/searxngResultsToRetrievables.md)\n\n***\n\n### SearxngToolConfig\n\nRe-exports [SearxngToolConfig](tools/searxng/interfaces/SearxngToolConfig.md)\n\n***\n\n### SelectArg\n\nRe-exports [SelectArg](vector/builder/type-aliases/SelectArg.md)\n\n***\n\n### selectNaiveTurns\n\nRe-exports [selectNaiveTurns](context/thrift/relevance/functions/selectNaiveTurns.md)\n\n***\n\n### SelectNaiveTurnsOptions\n\nRe-exports [SelectNaiveTurnsOptions](context/thrift/relevance/interfaces/SelectNaiveTurnsOptions.md)\n\n***\n\n### selectRelevantTurns\n\nRe-exports [selectRelevantTurns](context/thrift/relevance/functions/selectRelevantTurns.md)\n\n***\n\n### SelectRelevantTurnsOptions\n\nRe-exports [SelectRelevantTurnsOptions](context/thrift/relevance/interfaces/SelectRelevantTurnsOptions.md)\n\n***\n\n### setOperationsTool\n\nRe-exports [setOperationsTool](tools/data_structure/variables/setOperationsTool.md)\n\n***\n\n### ShedRankFn\n\nRe-exports [ShedRankFn](context/thrift/contracts/type-aliases/ShedRankFn.md)\n\n***\n\n### SpecialistAudioInput\n\nRe-exports [SpecialistAudioInput](specialists/_shared/type-aliases/SpecialistAudioInput.md)\n\n***\n\n### SpecialistBytesInput\n\nRe-exports [SpecialistBytesInput](specialists/_shared/interfaces/SpecialistBytesInput.md)\n\n***\n\n### SpecialistImageInput\n\nRe-exports [SpecialistImageInput](specialists/_shared/type-aliases/SpecialistImageInput.md)\n\n***\n\n### SpecialistMediaLike\n\nRe-exports [SpecialistMediaLike](specialists/_shared/interfaces/SpecialistMediaLike.md)\n\n***\n\n### SpecialistPcmInput\n\nRe-exports [SpecialistPcmInput](specialists/_shared/interfaces/SpecialistPcmInput.md)\n\n***\n\n### SpoolHook\n\nRe-exports [SpoolHook](tools/web_retrieval/type-aliases/SpoolHook.md)\n\n***\n\n### standingInstructionTools\n\nRe-exports [standingInstructionTools](tools/standing_instructions/variables/standingInstructionTools.md)\n\n***\n\n### statsCorrelateTool\n\nRe-exports [statsCorrelateTool](tools/statistics/variables/statsCorrelateTool.md)\n\n***\n\n### statsDescribeTool\n\nRe-exports [statsDescribeTool](tools/statistics/variables/statsDescribeTool.md)\n\n***\n\n### statsHistogramTool\n\nRe-exports [statsHistogramTool](tools/statistics/variables/statsHistogramTool.md)\n\n***\n\n### statsTransformTool\n\nRe-exports [statsTransformTool](tools/statistics/variables/statsTransformTool.md)\n\n***\n\n### storeMemoryTool\n\nRe-exports [storeMemoryTool](tools/memory/variables/storeMemoryTool.md)\n\n***\n\n### storeRetrievables\n\nRe-exports [storeRetrievables](tools/web_retrieval/functions/storeRetrievables.md)\n\n***\n\n### storeRetrievableTool\n\nRe-exports [storeRetrievableTool](tools/retrievables/variables/storeRetrievableTool.md)\n\n***\n\n### stringExtractTool\n\nRe-exports [stringExtractTool](tools/string_processing/variables/stringExtractTool.md)\n\n***\n\n### stringSimilarityTool\n\nRe-exports [stringSimilarityTool](tools/text_comparison/variables/stringSimilarityTool.md)\n\n***\n\n### stringTransformTool\n\nRe-exports [stringTransformTool](tools/string_processing/variables/stringTransformTool.md)\n\n***\n\n### stripPriorTurnThoughts\n\nRe-exports [stripPriorTurnThoughts](context/thrift/subtractive_pass/functions/stripPriorTurnThoughts.md)\n\n***\n\n### subtractToFit\n\nRe-exports [subtractToFit](context/thrift/subtractive_pass/functions/subtractToFit.md)\n\n***\n\n### SubtractToFitOptions\n\nRe-exports [SubtractToFitOptions](context/thrift/subtractive_pass/interfaces/SubtractToFitOptions.md)\n\n***\n\n### summariseTurns\n\nRe-exports [summariseTurns](context/compact/summarizer/functions/summariseTurns.md)\n\n***\n\n### SummariseTurnsOptions\n\nRe-exports [SummariseTurnsOptions](context/compact/summarizer/interfaces/SummariseTurnsOptions.md)\n\n***\n\n### SummarizeFn\n\nRe-exports [SummarizeFn](context/compact/contracts/type-aliases/SummarizeFn.md)\n\n***\n\n### SynthesizeOptions\n\nRe-exports [SynthesizeOptions](tts/_shared/interfaces/SynthesizeOptions.md)\n\n***\n\n### SystemPromptChannel\n\nRe-exports [SystemPromptChannel](llm/openai_responses/types/type-aliases/SystemPromptChannel.md)\n\n***\n\n### TesseractJsModule\n\nRe-exports [TesseractJsModule](specialists/ocr/tesseract_js/types/type-aliases/TesseractJsModule.md)\n\n***\n\n### TesseractJsOcrAdapter\n\nRe-exports [TesseractJsOcrAdapter](specialists/ocr/tesseract_js/adapter/classes/TesseractJsOcrAdapter.md)\n\n***\n\n### TesseractJsOcrAdapterOptions\n\nRe-exports [TesseractJsOcrAdapterOptions](specialists/ocr/tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions.md)\n\n***\n\n### tesseractJsOcrOptionsSchema\n\nRe-exports [tesseractJsOcrOptionsSchema](specialists/ocr/tesseract_js/validation/variables/tesseractJsOcrOptionsSchema.md)\n\n***\n\n### TesseractJsWorker\n\nRe-exports [TesseractJsWorker](specialists/ocr/tesseract_js/types/type-aliases/TesseractJsWorker.md)\n\n***\n\n### textAnalyzeTool\n\nRe-exports [textAnalyzeTool](tools/text_analysis/variables/textAnalyzeTool.md)\n\n***\n\n### textDiffTool\n\nRe-exports [textDiffTool](tools/text_comparison/variables/textDiffTool.md)\n\n***\n\n### textEscapeTool\n\nRe-exports [textEscapeTool](tools/encoding/variables/textEscapeTool.md)\n\n***\n\n### textLinesTool\n\nRe-exports [textLinesTool](tools/text_analysis/variables/textLinesTool.md)\n\n***\n\n### ThriftTrace\n\nRe-exports [ThriftTrace](context/thrift/subtractive_pass/interfaces/ThriftTrace.md)\n\n***\n\n### toBytes\n\nRe-exports [toBytes](specialists/_shared/functions/toBytes.md)\n\n***\n\n### toGenerationBytes\n\nRenames and re-exports [toBytes](generation/_shared/functions/toBytes.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](llm/transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](llm/transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### ToRetrievableOptions\n\nRe-exports [ToRetrievableOptions](tools/web_retrieval/interfaces/ToRetrievableOptions.md)\n\n***\n\n### TransformersJsAdapter\n\nRe-exports [TransformersJsAdapter](llm/transformers_js/adapter/classes/TransformersJsAdapter.md)\n\n***\n\n### TransformersJsAdapterOptions\n\nRe-exports [TransformersJsAdapterOptions](llm/transformers_js/types/interfaces/TransformersJsAdapterOptions.md)\n\n***\n\n### TransformersJsCaptionAdapter\n\nRe-exports [TransformersJsCaptionAdapter](specialists/caption/transformers_js/adapter/classes/TransformersJsCaptionAdapter.md)\n\n***\n\n### TransformersJsCaptionAdapterOptions\n\nRe-exports [TransformersJsCaptionAdapterOptions](specialists/caption/transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions.md)\n\n***\n\n### TransformersJsCaptionDataType\n\nRe-exports [TransformersJsCaptionDataType](specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDataType.md)\n\n***\n\n### TransformersJsCaptionDeviceType\n\nRe-exports [TransformersJsCaptionDeviceType](specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDeviceType.md)\n\n***\n\n### TransformersJsCaptionModelSource\n\nRe-exports [TransformersJsCaptionModelSource](specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionModelSource.md)\n\n***\n\n### transformersJsCaptionOptionsSchema\n\nRe-exports [transformersJsCaptionOptionsSchema](specialists/caption/transformers_js/validation/variables/transformersJsCaptionOptionsSchema.md)\n\n***\n\n### TransformersJsCaptionPipeline\n\nRe-exports [TransformersJsCaptionPipeline](specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionPipeline.md)\n\n***\n\n### TransformersJsCaptionProgressCallback\n\nRe-exports [TransformersJsCaptionProgressCallback](specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionProgressCallback.md)\n\n***\n\n### TransformersJsEmbeddingsAdapter\n\nRe-exports [TransformersJsEmbeddingsAdapter](embeddings/transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter.md)\n\n***\n\n### TransformersJsEmbeddingsAdapterOptions\n\nRe-exports [TransformersJsEmbeddingsAdapterOptions](embeddings/transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions.md)\n\n***\n\n### TransformersJsEmbeddingsDataType\n\nRe-exports [TransformersJsEmbeddingsDataType](embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDataType.md)\n\n***\n\n### TransformersJsEmbeddingsDeviceType\n\nRe-exports [TransformersJsEmbeddingsDeviceType](embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDeviceType.md)\n\n***\n\n### transformersJsEmbeddingsOptionsSchema\n\nRe-exports [transformersJsEmbeddingsOptionsSchema](embeddings/transformers_js/validation/variables/transformersJsEmbeddingsOptionsSchema.md)\n\n***\n\n### TransformersJsEmbeddingsPipeline\n\nRe-exports [TransformersJsEmbeddingsPipeline](embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsPipeline.md)\n\n***\n\n### TransformersJsEmbeddingsProgressCallback\n\nRe-exports [TransformersJsEmbeddingsProgressCallback](embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsProgressCallback.md)\n\n***\n\n### TransformersJsGenerateOptions\n\nRe-exports [TransformersJsGenerateOptions](generation/transformers_js/types/interfaces/TransformersJsGenerateOptions.md)\n\n***\n\n### TransformersJsGenerationAdapter\n\nRe-exports [TransformersJsGenerationAdapter](generation/transformers_js/adapter/classes/TransformersJsGenerationAdapter.md)\n\n***\n\n### TransformersJsGenerationAdapterOptions\n\nRe-exports [TransformersJsGenerationAdapterOptions](generation/transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions.md)\n\n***\n\n### TransformersJsGenerationDataType\n\nRe-exports [TransformersJsGenerationDataType](generation/transformers_js/types/type-aliases/TransformersJsGenerationDataType.md)\n\n***\n\n### TransformersJsGenerationDeviceType\n\nRe-exports [TransformersJsGenerationDeviceType](generation/transformers_js/types/type-aliases/TransformersJsGenerationDeviceType.md)\n\n***\n\n### TransformersJsGenerationModel\n\nRe-exports [TransformersJsGenerationModel](generation/transformers_js/types/interfaces/TransformersJsGenerationModel.md)\n\n***\n\n### TransformersJsGenerationModelSource\n\nRe-exports [TransformersJsGenerationModelSource](generation/transformers_js/types/type-aliases/TransformersJsGenerationModelSource.md)\n\n***\n\n### transformersJsGenerationOptionsSchema\n\nRe-exports [transformersJsGenerationOptionsSchema](generation/transformers_js/validation/variables/transformersJsGenerationOptionsSchema.md)\n\n***\n\n### TransformersJsGenerationProcessor\n\nRe-exports [TransformersJsGenerationProcessor](generation/transformers_js/types/interfaces/TransformersJsGenerationProcessor.md)\n\n***\n\n### TransformersJsGenerationProgressCallback\n\nRe-exports [TransformersJsGenerationProgressCallback](generation/transformers_js/types/type-aliases/TransformersJsGenerationProgressCallback.md)\n\n***\n\n### TransformersJsMessage\n\nRe-exports [TransformersJsMessage](llm/transformers_js/types/type-aliases/TransformersJsMessage.md)\n\n***\n\n### transformersJsOptionsSchema\n\nRe-exports [transformersJsOptionsSchema](llm/transformers_js/validation/variables/transformersJsOptionsSchema.md)\n\n***\n\n### TransformersJsPipeline\n\nRe-exports [TransformersJsPipeline](llm/transformers_js/types/type-aliases/TransformersJsPipeline.md)\n\n***\n\n### TransformersJsPooling\n\nRe-exports [TransformersJsPooling](embeddings/transformers_js/types/type-aliases/TransformersJsPooling.md)\n\n***\n\n### TransformersJsRawImageLike\n\nRe-exports [TransformersJsRawImageLike](generation/transformers_js/types/interfaces/TransformersJsRawImageLike.md)\n\n***\n\n### TransformersJsSynthesizeOptions\n\nRe-exports [TransformersJsSynthesizeOptions](tts/transformers_js/types/interfaces/TransformersJsSynthesizeOptions.md)\n\n***\n\n### TransformersJsTtsAdapter\n\nRe-exports [TransformersJsTtsAdapter](tts/transformers_js/adapter/classes/TransformersJsTtsAdapter.md)\n\n***\n\n### TransformersJsTtsAdapterOptions\n\nRe-exports [TransformersJsTtsAdapterOptions](tts/transformers_js/types/interfaces/TransformersJsTtsAdapterOptions.md)\n\n***\n\n### TransformersJsTtsDataType\n\nRe-exports [TransformersJsTtsDataType](tts/transformers_js/types/type-aliases/TransformersJsTtsDataType.md)\n\n***\n\n### TransformersJsTtsDeviceType\n\nRe-exports [TransformersJsTtsDeviceType](tts/transformers_js/types/type-aliases/TransformersJsTtsDeviceType.md)\n\n***\n\n### TransformersJsTtsModelSource\n\nRe-exports [TransformersJsTtsModelSource](tts/transformers_js/types/type-aliases/TransformersJsTtsModelSource.md)\n\n***\n\n### transformersJsTtsOptionsSchema\n\nRe-exports [transformersJsTtsOptionsSchema](tts/transformers_js/validation/variables/transformersJsTtsOptionsSchema.md)\n\n***\n\n### TransformersJsTtsPipeline\n\nRe-exports [TransformersJsTtsPipeline](tts/transformers_js/types/type-aliases/TransformersJsTtsPipeline.md)\n\n***\n\n### TransformersJsTtsProgressCallback\n\nRe-exports [TransformersJsTtsProgressCallback](tts/transformers_js/types/type-aliases/TransformersJsTtsProgressCallback.md)\n\n***\n\n### TransformersJsTtsSpeakerEmbeddings\n\nRe-exports [TransformersJsTtsSpeakerEmbeddings](tts/transformers_js/types/type-aliases/TransformersJsTtsSpeakerEmbeddings.md)\n\n***\n\n### TtsSynthesisResult\n\nRe-exports [TtsSynthesisResult](tts/_shared/type-aliases/TtsSynthesisResult.md)\n\n***\n\n### unicodeNormalizeTool\n\nRe-exports [unicodeNormalizeTool](tools/encoding/variables/unicodeNormalizeTool.md)\n\n***\n\n### updateMemoryTool\n\nRe-exports [updateMemoryTool](tools/memory/variables/updateMemoryTool.md)\n\n***\n\n### updateRetrievableTool\n\nRe-exports [updateRetrievableTool](tools/retrievables/variables/updateRetrievableTool.md)\n\n***\n\n### UpsertPlan\n\nRe-exports [UpsertPlan](vector/plan/interfaces/UpsertPlan.md)\n\n***\n\n### validateAnthropicMessagesOptions\n\nRenames and re-exports [validateOptions](llm/anthropic_messages/validation/functions/validateOptions.md)\n\n***\n\n### validateClaudeCodeCliOptions\n\nRenames and re-exports [validateOptions](llm/claude_code_cli/validation/functions/validateOptions.md)\n\n***\n\n### validateCreateConfig\n\nRe-exports [validateCreateConfig](vector/validation/functions/validateCreateConfig.md)\n\n***\n\n### validateFormatTool\n\nRe-exports [validateFormatTool](tools/structured_data/variables/validateFormatTool.md)\n\n***\n\n### validateGeminiGenerationOptions\n\nRenames and re-exports [validateOptions](generation/gemini/validation/functions/validateOptions.md)\n\n***\n\n### validateLiteRtLmOptions\n\nRenames and re-exports [validateOptions](llm/litert_lm/validation/functions/validateOptions.md)\n\n***\n\n### validateOllamaEmbeddingsOptions\n\nRenames and re-exports [validateOptions](embeddings/ollama/validation/functions/validateOptions.md)\n\n***\n\n### validateOllamaOptions\n\nRenames and re-exports [validateOptions](llm/ollama/validation/functions/validateOptions.md)\n\n***\n\n### validateOpenAIEmbeddingsOptions\n\nRenames and re-exports [validateOptions](embeddings/openai/validation/functions/validateOptions.md)\n\n***\n\n### validateOpenAIGenerationOptions\n\nRenames and re-exports [validateOptions](generation/openai/validation/functions/validateOptions.md)\n\n***\n\n### validateOpenAIResponsesOptions\n\nRenames and re-exports [validateOptions](llm/openai_responses/validation/functions/validateOptions.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](llm/openai_chat_completions/validation/functions/validateOptions.md)\n\n***\n\n### validateRecords\n\nRe-exports [validateRecords](vector/validation/functions/validateRecords.md)\n\n***\n\n### validateTesseractJsOcrOptions\n\nRenames and re-exports [validateOptions](specialists/ocr/tesseract_js/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsCaptionOptions\n\nRenames and re-exports [validateOptions](specialists/caption/transformers_js/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsEmbeddingsOptions\n\nRenames and re-exports [validateOptions](embeddings/transformers_js/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsGenerationOptions\n\nRenames and re-exports [validateOptions](generation/transformers_js/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsOptions\n\nRenames and re-exports [validateOptions](llm/transformers_js/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsTtsOptions\n\nRenames and re-exports [validateOptions](tts/transformers_js/validation/functions/validateOptions.md)\n\n***\n\n### validateWebLLMChatCompletionsOptions\n\nRenames and re-exports [validateOptions](llm/webllm_chat_completions/validation/functions/validateOptions.md)\n\n***\n\n### VectorConsistency\n\nRe-exports [VectorConsistency](vector/types/type-aliases/VectorConsistency.md)\n\n***\n\n### VectorConsistencyCapability\n\nRe-exports [VectorConsistencyCapability](vector/types/interfaces/VectorConsistencyCapability.md)\n\n***\n\n### VectorEncoderFn\n\nRe-exports [VectorEncoderFn](vector/types/type-aliases/VectorEncoderFn.md)\n\n***\n\n### VectorFilter\n\nRe-exports [VectorFilter](vector/filters/type-aliases/VectorFilter.md)\n\n***\n\n### vectorFilterSchema\n\nRe-exports [vectorFilterSchema](vector/filters/variables/vectorFilterSchema.md)\n\n***\n\n### VectorInput\n\nRe-exports [VectorInput](vector/types/type-aliases/VectorInput.md)\n\n***\n\n### VectorMatch\n\nRe-exports [VectorMatch](vector/types/interfaces/VectorMatch.md)\n\n***\n\n### VectorMetadata\n\nRe-exports [VectorMetadata](vector/types/type-aliases/VectorMetadata.md)\n\n***\n\n### VectorMetadataValue\n\nRe-exports [VectorMetadataValue](vector/types/type-aliases/VectorMetadataValue.md)\n\n***\n\n### VectorMigrateOptions\n\nRe-exports [VectorMigrateOptions](vector/migrate/interfaces/VectorMigrateOptions.md)\n\n***\n\n### VectorMigration\n\nRe-exports [VectorMigration](vector/migrate/interfaces/VectorMigration.md)\n\n***\n\n### VectorMigrationContext\n\nRe-exports [VectorMigrationContext](vector/migrate/interfaces/VectorMigrationContext.md)\n\n***\n\n### VectorMigrator\n\nRe-exports [VectorMigrator](vector/migrate/classes/VectorMigrator.md)\n\n***\n\n### VectorQueryBuilder\n\nRe-exports [VectorQueryBuilder](vector/builder/classes/VectorQueryBuilder.md)\n\n***\n\n### VectorRecord\n\nRe-exports [VectorRecord](vector/types/interfaces/VectorRecord.md)\n\n***\n\n### vectorRecordSchema\n\nRe-exports [vectorRecordSchema](vector/validation/variables/vectorRecordSchema.md)\n\n***\n\n### VectorRetrievableCallbacks\n\nRe-exports [VectorRetrievableCallbacks](vector/retrievable/interfaces/VectorRetrievableCallbacks.md)\n\n***\n\n### VectorRetrievableGlueOptions\n\nRe-exports [VectorRetrievableGlueOptions](vector/retrievable/interfaces/VectorRetrievableGlueOptions.md)\n\n***\n\n### VectorSchemaBuilder\n\nRe-exports [VectorSchemaBuilder](vector/schema/classes/VectorSchemaBuilder.md)\n\n***\n\n### VectorStore\n\nRe-exports [VectorStore](vector/contract/interfaces/VectorStore.md)\n\n***\n\n### VectorStoreCapabilities\n\nRe-exports [VectorStoreCapabilities](vector/types/interfaces/VectorStoreCapabilities.md)\n\n***\n\n### VectorStoreClient\n\nRe-exports [VectorStoreClient](vector/factory/type-aliases/VectorStoreClient.md)\n\n***\n\n### VectorStoreConstructor\n\nRe-exports [VectorStoreConstructor](vector/factory/interfaces/VectorStoreConstructor.md)\n\n***\n\n### VectorStoreConstructorLike\n\nRe-exports [VectorStoreConstructorLike](vector/vector_store_constructor/type-aliases/VectorStoreConstructorLike.md)\n\n***\n\n### vectorStoreConstructorSchema\n\nRe-exports [vectorStoreConstructorSchema](vector/vector_store_constructor/variables/vectorStoreConstructorSchema.md)\n\n***\n\n### VectorTx\n\nRe-exports [VectorTx](vector/contract/interfaces/VectorTx.md)\n\n***\n\n### WebLLMChatCompletionsAdapter\n\nRe-exports [WebLLMChatCompletionsAdapter](llm/webllm_chat_completions/adapter/classes/WebLLMChatCompletionsAdapter.md)\n\n***\n\n### webLLMChatCompletionsOptionsSchema\n\nRe-exports [webLLMChatCompletionsOptionsSchema](llm/webllm_chat_completions/validation/variables/webLLMChatCompletionsOptionsSchema.md)\n\n***\n\n### WorkingImage\n\nRe-exports [WorkingImage](context/thrift/contracts/interfaces/WorkingImage.md)\n\n***\n\n### WorkingMemory\n\nRe-exports [WorkingMemory](context/thrift/contracts/interfaces/WorkingMemory.md)\n\n***\n\n### WorkingMessage\n\nRe-exports [WorkingMessage](context/thrift/contracts/interfaces/WorkingMessage.md)\n\n***\n\n### WorkingRetrievable\n\nRe-exports [WorkingRetrievable](context/thrift/contracts/interfaces/WorkingRetrievable.md)\n\n***\n\n### WorkingSet\n\nRe-exports [WorkingSet](context/thrift/subtractive_pass/interfaces/WorkingSet.md)\n\n***\n\n### WorkingThought\n\nRe-exports [WorkingThought](context/thrift/contracts/interfaces/WorkingThought.md)\n\n***\n\n### WorkingTool\n\nRe-exports [WorkingTool](context/thrift/contracts/interfaces/WorkingTool.md)\n\n***\n\n### WorkingToolCall\n\nRe-exports [WorkingToolCall](context/thrift/contracts/interfaces/WorkingToolCall.md)\n\n***\n\n### WorkingToolRegistry\n\nRe-exports [WorkingToolRegistry](context/thrift/contracts/interfaces/WorkingToolRegistry.md)\n\n***\n\n### WrapperAuth\n\nRe-exports [WrapperAuth](llm/claude_code_cli/wire/interfaces/WrapperAuth.md)\n\n***\n\n### WrapperBridgedTool\n\nRe-exports [WrapperBridgedTool](llm/claude_code_cli/wire/interfaces/WrapperBridgedTool.md)\n\n***\n\n### WrapperCommand\n\nRe-exports [WrapperCommand](llm/claude_code_cli/wire/type-aliases/WrapperCommand.md)\n\n***\n\n### WrapperErrorEvent\n\nRe-exports [WrapperErrorEvent](llm/claude_code_cli/wire/interfaces/WrapperErrorEvent.md)\n\n***\n\n### WrapperEvent\n\nRe-exports [WrapperEvent](llm/claude_code_cli/wire/type-aliases/WrapperEvent.md)\n\n***\n\n### WrapperInitEvent\n\nRe-exports [WrapperInitEvent](llm/claude_code_cli/wire/interfaces/WrapperInitEvent.md)\n\n***\n\n### WrapperLogEvent\n\nRe-exports [WrapperLogEvent](llm/claude_code_cli/wire/interfaces/WrapperLogEvent.md)\n\n***\n\n### WrapperMessageDeltaEvent\n\nRe-exports [WrapperMessageDeltaEvent](llm/claude_code_cli/wire/interfaces/WrapperMessageDeltaEvent.md)\n\n***\n\n### WrapperReadyEvent\n\nRe-exports [WrapperReadyEvent](llm/claude_code_cli/wire/interfaces/WrapperReadyEvent.md)\n\n***\n\n### WrapperResultEvent\n\nRe-exports [WrapperResultEvent](llm/claude_code_cli/wire/interfaces/WrapperResultEvent.md)\n\n***\n\n### WrapperRetryEvent\n\nRe-exports [WrapperRetryEvent](llm/claude_code_cli/wire/interfaces/WrapperRetryEvent.md)\n\n***\n\n### WrapperRunCommand\n\nRe-exports [WrapperRunCommand](llm/claude_code_cli/wire/interfaces/WrapperRunCommand.md)\n\n***\n\n### WrapperShutdownCommand\n\nRe-exports [WrapperShutdownCommand](llm/claude_code_cli/wire/interfaces/WrapperShutdownCommand.md)\n\n***\n\n### WrapperShutdownCompleteEvent\n\nRe-exports [WrapperShutdownCompleteEvent](llm/claude_code_cli/wire/interfaces/WrapperShutdownCompleteEvent.md)\n\n***\n\n### WrapperThoughtDeltaEvent\n\nRe-exports [WrapperThoughtDeltaEvent](llm/claude_code_cli/wire/interfaces/WrapperThoughtDeltaEvent.md)\n\n***\n\n### WrapperToolCallRequestEvent\n\nRe-exports [WrapperToolCallRequestEvent](llm/claude_code_cli/wire/interfaces/WrapperToolCallRequestEvent.md)\n\n***\n\n### WrapperToolCallResponseCommand\n\nRe-exports [WrapperToolCallResponseCommand](llm/claude_code_cli/wire/interfaces/WrapperToolCallResponseCommand.md)\n\n***\n\n### WrapperToolResultContentBlock\n\nRe-exports [WrapperToolResultContentBlock](llm/claude_code_cli/wire/type-aliases/WrapperToolResultContentBlock.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts","title":"@nhtio/adk/batteries/artifacts","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/artifacts.md'\ndescription: 'Artifacts battery: structured query tools for multiple document formats.'\n---\n\n# @nhtio/adk/batteries/artifacts\n\nArtifacts battery: structured query tools for multiple document formats.\n\n## Remarks\n\nExports the four artifact classes ([SpooledToonArtifact](toon/classes/SpooledToonArtifact.md),\n[SpooledYamlArtifact](yaml/classes/SpooledYamlArtifact.md), [SpooledXmlArtifact](xml/classes/SpooledXmlArtifact.md), [SpooledEcmaScriptArtifact](../../../../batteries/artifacts/ecmascript/classes/SpooledEcmaScriptArtifact.md))\nand their converters from their respective batteries. Also exports the\n[registerArtifactEncodables](functions/registerArtifactEncodables.md) function for encoding support.\n\nNote: `decode()` on artifact instances throws until `registerArtifactEncodables()`\nhas been called. `encode()` requires no setup — the classes carry the\n`Symbol.for('@nhtio/encoder:toEncoded')` method with zero dependency on the encoder.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| [E\\_TOON\\_DECODE\\_FAILED](variables/E_TOON_DECODE_FAILED.md) | Thrown when TOON decoding fails. |\n| [E\\_TOON\\_PEER\\_MISSING](variables/E_TOON_PEER_MISSING.md) | Thrown when the TOON peer dependency cannot be loaded. |\n| [E\\_TYPESCRIPT\\_PEER\\_MISSING](variables/E_TYPESCRIPT_PEER_MISSING.md) | Thrown when the TypeScript peer dependency fails to load. |\n| [E\\_XML\\_PARSE\\_FAILED](variables/E_XML_PARSE_FAILED.md) | Thrown when XML parsing fails due to malformed markup. |\n| [E\\_XML\\_PARSER\\_PEER\\_MISSING](variables/E_XML_PARSER_PEER_MISSING.md) | Thrown when the fast-xml-parser optional peer is not installed or fails to load. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------------- | ---------------------------------------------------------------------- |\n| [registerArtifactEncodables](functions/registerArtifactEncodables.md) | Registers the four artifact classes with the '@nhtio/encoder' decoder. |\n\n## References\n\n### E\\_YAML\\_PARSE\\_ERROR\n\nRe-exports [E\\_YAML\\_PARSE\\_ERROR](yaml/variables/E_YAML_PARSE_ERROR.md)\n\n***\n\n### E\\_YAML\\_PEER\\_MISSING\n\nRe-exports [E\\_YAML\\_PEER\\_MISSING](yaml/variables/E_YAML_PEER_MISSING.md)\n\n***\n\n### EcmaScriptExport\n\nRe-exports [EcmaScriptExport](../../../../batteries/artifacts/ecmascript/interfaces/EcmaScriptExport.md)\n\n***\n\n### EcmaScriptImport\n\nRe-exports [EcmaScriptImport](../../../../batteries/artifacts/ecmascript/interfaces/EcmaScriptImport.md)\n\n***\n\n### EcmaScriptSymbol\n\nRe-exports [EcmaScriptSymbol](../../../../batteries/artifacts/ecmascript/interfaces/EcmaScriptSymbol.md)\n\n***\n\n### IdentifierReference\n\nRe-exports [IdentifierReference](../../../../batteries/artifacts/ecmascript/interfaces/IdentifierReference.md)\n\n***\n\n### jsonToToonTool\n\nRe-exports [jsonToToonTool](toon/variables/jsonToToonTool.md)\n\n***\n\n### jsonToXmlTool\n\nRe-exports [jsonToXmlTool](xml/variables/jsonToXmlTool.md)\n\n***\n\n### jsonToYamlTool\n\nRe-exports [jsonToYamlTool](yaml/variables/jsonToYamlTool.md)\n\n***\n\n### OutlineEntry\n\nRe-exports [OutlineEntry](../../../../batteries/artifacts/ecmascript/interfaces/OutlineEntry.md)\n\n***\n\n### OutlineMember\n\nRe-exports [OutlineMember](../../../../batteries/artifacts/ecmascript/interfaces/OutlineMember.md)\n\n***\n\n### SpooledEcmaScriptArtifact\n\nRe-exports [SpooledEcmaScriptArtifact](../../../../batteries/artifacts/ecmascript/classes/SpooledEcmaScriptArtifact.md)\n\n***\n\n### SpooledToonArtifact\n\nRe-exports [SpooledToonArtifact](toon/classes/SpooledToonArtifact.md)\n\n***\n\n### SpooledXmlArtifact\n\nRe-exports [SpooledXmlArtifact](xml/classes/SpooledXmlArtifact.md)\n\n***\n\n### SpooledYamlArtifact\n\nRe-exports [SpooledYamlArtifact](yaml/classes/SpooledYamlArtifact.md)\n\n***\n\n### ToonDecodeOptions\n\nRe-exports [ToonDecodeOptions](toon/interfaces/ToonDecodeOptions.md)\n\n***\n\n### toonToJsonTool\n\nRe-exports [toonToJsonTool](toon/variables/toonToJsonTool.md)\n\n***\n\n### xmlToJsonTool\n\nRe-exports [xmlToJsonTool](xml/variables/xmlToJsonTool.md)\n\n***\n\n### yamlToJsonTool\n\nRe-exports [yamlToJsonTool](yaml/variables/yamlToJsonTool.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/functions/registerArtifactEncodables","title":"Function: registerArtifactEncodables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/functions/registerArtifactEncodables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/functions/registerArtifactEncodables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/functions/registerArtifactEncodables.md\n---\n\n# Function: registerArtifactEncodables()\n\n```ts\nfunction registerArtifactEncodables(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/index.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/index.ts#L40)\n\nRegisters the four artifact classes with the '@nhtio/encoder' decoder.\n\n## Returns\n\n`Promise`<`void`>\n\nA promise that resolves when registration is complete.\n\n## Remarks\n\nThis function must be called once before decoding artifact instances that were\npreviously encoded. It is idempotent and safe to call multiple times. Consumers\nwho need both core primitives and artifacts typically call\n`registerAdkEncodables()` (from the encoding battery) followed by this function.\n\n## Throws\n\nIf '@nhtio/encoder' is not available or registration fails.\n\n## Example\n\n```ts\nimport { registerArtifactEncodables } from \"@nhtio/adk/batteries/artifacts\";\nawait registerArtifactEncodables();\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon","title":"@nhtio/adk/batteries/artifacts/toon","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/toon.md'\ndescription: TOON artifact battery — structured queries over TOON format artifacts.\n---\n\n# @nhtio/adk/batteries/artifacts/toon\n\nTOON artifact battery — structured queries over TOON format artifacts.\n\n## Remarks\n\nAdds [SpooledToonArtifact](classes/SpooledToonArtifact.md), a [@nhtio/adk!SpooledArtifact](../../../spooled_artifact/classes/SpooledArtifact.md) specialisation for\nstructured TOON queries. TOON encodes the JSON data model in a compact text format; parsing\nproduces the same values as decoding JSON, so queries use [JSONPath-Plus](https://github.com/JSONPath-Plus/JSONPath) for path navigation, exactly as [@nhtio/adk!SpooledJsonArtifact](../../../spooled_artifact/classes/SpooledJsonArtifact.md) does.\n\nRequires the optional peer `@toon-format/toon` (version `^4.1.1`). If it is not installed,\nmethods requiring it throw [E\\_TOON\\_PEER\\_MISSING](../variables/E_TOON_PEER_MISSING.md) with installation instructions.\n\nExport note: registerArtifactEncodables must be called before any attempt to\n`decode()` a spooled TOON artifact. Call it once at startup:\n\n```ts\nimport { registerArtifactEncodables } from \"@nhtio/adk/batteries/artifacts\";\nawait registerArtifactEncodables();\n```\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| [SpooledToonArtifact](classes/SpooledToonArtifact.md) | A [@nhtio/adk!SpooledArtifact](../../../spooled_artifact/classes/SpooledArtifact.md) specialisation that adds TOON-aware read operations. |\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------- | -------------------- |\n| [ToonDecodeOptions](interfaces/ToonDecodeOptions.md) | TOON decode options. |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------- | ----------------------------- |\n| [jsonToToonTool](variables/jsonToToonTool.md) | Converter tool: JSON to TOON. |\n| [toonToJsonTool](variables/toonToJsonTool.md) | Converter tool: TOON to JSON. |\n\n## References\n\n### E\\_TOON\\_DECODE\\_FAILED\n\nRe-exports [E\\_TOON\\_DECODE\\_FAILED](../variables/E_TOON_DECODE_FAILED.md)\n\n***\n\n### E\\_TOON\\_PEER\\_MISSING\n\nRe-exports [E\\_TOON\\_PEER\\_MISSING](../variables/E_TOON_PEER_MISSING.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/classes/SpooledToonArtifact","title":"Class: SpooledToonArtifact","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/classes/SpooledToonArtifact.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/classes/SpooledToonArtifact","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/toon/classes/SpooledToonArtifact.md\ndescription: >-\n A {@link @nhtio/adk!SpooledArtifact} specialisation that adds TOON-aware read\n operations.\n---\n\n# Class: SpooledToonArtifact\n\nDefined in: [src/batteries/artifacts/toon/index.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L90)\n\nA [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) specialisation that adds TOON-aware read operations.\n\n## Remarks\n\nConstruct with an optional `options` object to control decoding. When omitted, the TOON is\ndecoded with `strict: true` (default). Once decoded (on first access), the parsed value is\ncached for the lifetime of the instance.\n\nAll TOON methods are async, consistent with [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md).\n\nPath-based methods (`toon_get`, `toon_filter`, `toon_pluck`) use\n[JSONPath-Plus](https://github.com/JSONPath-Plus/JSONPath) expressions. Full JSONPath syntax\nis supported, including recursive descent (`..`), filter expressions (`[?(@.age > 18)]`),\nand union selectors.\n\n## Extends\n\n* [`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew SpooledToonArtifact(reader: SpoolReader, options?: ToonDecodeOptions): SpooledToonArtifact;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L99)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ---------- | ----------------------------------------------------------------------- | ------------------------------- |\n| `reader` | [`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md) | The backing store to read from. |\n| `options?` | [`ToonDecodeOptions`](../interfaces/ToonDecodeOptions.md) | Optional TOON decode options. |\n\n#### Returns\n\n`SpooledToonArtifact`\n\n#### Overrides\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`constructor`](../../../../spooled_artifact/classes/SpooledArtifact.md#constructor)\n\n## Properties\n\n| Property | Modifier | Type | Description | Overrides | Defined in |\n| ----------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `toolMethods` | `static` | readonly [`ToolMethodDescriptor`](../../../../common/interfaces/ToolMethodDescriptor.md)\\[] | The TOON-specific artifact-query descriptors this class adds on top of the base set. **Remarks** Lists `artifact_toon_type`, `artifact_toon_keys`, `artifact_toon_length`, `artifact_toon_get`, `artifact_toon_filter`, `artifact_toon_slice`, `artifact_toon_pluck`. The base seven descriptors (`artifact_head`, etc.) are NOT included here — they are forged separately by [SpooledToonArtifact.forgeTools](#forgetools), which calls `SpooledArtifact.forgeTools(ctx)` to produce the base-narrowed tools and then registers its own TOON tools on the result. Downstream consumers building custom subclasses should follow the same pattern: own only your own descriptors; override `forgeTools` to compose with the base output. | [`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`toolMethods`](../../../../spooled_artifact/classes/SpooledArtifact.md#property-toolmethods) | [src/batteries/artifacts/toon/index.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L133) |\n\n## Methods\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: unknown;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:457](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L457)\n\nSerialise this SpooledToonArtifact into an `@nhtio/encoder` snapshot — the reader **handle** plus\nthe decode `options`.\n\n#### Returns\n\n`unknown`\n\nA snapshot consumed by SpooledToonArtifact.\\[DECODE\\_METHOD].\n\n#### Remarks\n\nOverrides SpooledArtifact.\\[ENCODE\\_METHOD] to carry the constructor's `options` (the\nparsed-value cache is derived and not encoded). Round-trips via\nSpooledToonArtifact.\\[DECODE\\_METHOD].\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`[ENCODE_METHOD]`](../../../../spooled_artifact/classes/SpooledArtifact.md#encode_method)\n\n***\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: unknown;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L361)\n\nSerialise this SpooledArtifact into an `@nhtio/encoder` snapshot — the reader **handle**, not the\nbytes.\n\n#### Returns\n\n`unknown`\n\nA snapshot consumed by SpooledArtifact.\\[DECODE\\_METHOD].\n\n#### Remarks\n\nEmits the backing reader's [ReaderDescriptor](../../../../common/interfaces/ReaderDescriptor.md); decode re-binds the reader through the\nregistered resolver. Throws [@nhtio/adk!E\\_READER\\_NOT\\_DESCRIBABLE](../../../../exceptions/variables/E_READER_NOT_DESCRIBABLE.md) when the reader cannot\ndescribe itself. Subclasses override this to include their own discriminators (e.g.\n[@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md) adds `format`).\n\n#### Inherited from\n\n```ts\nSpooledArtifact.[ENCODE_METHOD]\n```\n\n***\n\n### asString()\n\n```ts\nasString(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:677](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L677)\n\nReturns the full artifact body as a single byte-faithful string.\n\n#### Returns\n\n`Promise`<`string`>\n\nThe full content as a single string.\n\n#### Remarks\n\nRound-trip faithful to whatever bytes the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md) was constructed over —\npreserves trailing newlines and non-`\\n` line terminators that [SpooledArtifact.cat](../../../../spooled_artifact/classes/SpooledArtifact.md#cat)\ndiscards via its line-based view. This is the canonical primitive for \"inline the artifact\ncontent directly into a message\" use cases.\n\n`asString()` and the static `forgeTools(ctx)` factory on each subclass are independent\nalternatives — a consumer chooses per turn whether to inline the body in a message\n(`await tc.results.asString()`) or hand the model query tools\n(`SpooledArtifact.forgeTools(ctx)`). Neither calls the other; either works with neither.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`asString`](../../../../spooled_artifact/classes/SpooledArtifact.md#asstring)\n\n***\n\n### byteLength()\n\n```ts\nbyteLength(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:548](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L548)\n\nReturns the total byte length of the underlying data.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe byte length as reported by the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`byteLength`](../../../../spooled_artifact/classes/SpooledArtifact.md#bytelength)\n\n***\n\n### cat()\n\n```ts\ncat(start?: number, end?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:529](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L529)\n\nReturns lines from the artifact, optionally bounded to a range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | -------------------------------------------------------------- |\n| `start?` | `number` | 0-based start line index (inclusive). Defaults to `0`. |\n| `end?` | `number` | 0-based end line index (exclusive). Defaults to `lineCount()`. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings in the requested range.\n\n#### Remarks\n\nWithout arguments, returns all lines — equivalent to POSIX `cat`. With `start` and/or `end`,\nbehaves like `Array.prototype.slice`: `start` defaults to `0`, `end` defaults to the total\nline count, and only lines in `[start, end)` are fetched from the backing store. For large\nartifacts, prefer a bounded range or [SpooledArtifact.head](../../../../spooled_artifact/classes/SpooledArtifact.md#head) / [SpooledArtifact.tail](../../../../spooled_artifact/classes/SpooledArtifact.md#tail).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`cat`](../../../../spooled_artifact/classes/SpooledArtifact.md#cat)\n\n***\n\n### estimateHandleTokens()\n\n```ts\nestimateHandleTokens(\n callId: string,\n encoding:\n | \"gpt2\"\n | \"r50k_base\"\n | \"p50k_base\"\n | \"p50k_edit\"\n | \"cl100k_base\"\n | \"o200k_base\"\n | \"gemini\"\n | \"gemma\"\n | \"llama2\"\n | \"claude\",\n renderer?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n}) => string): number;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:594](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L594)\n\nEstimates tokens for the exact handle-body metadata rendered for this artifact.\n\nThe fallback renderer is an interim core-safe implementation. Its output is deliberately\nspecified here for fan-in parity: the lines are the fixed prose and metadata strings below,\nwith one `\\n` separator, and method entries formatted as `- name — description` (or `- name`).\nThe canonical renderer in `chat_common` should eventually delegate to this builder rather than\nmaintain a second copy.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |\n| `callId` | `string` | The turn-local artifact identifier. |\n| `encoding` | | `\"gpt2\"` | `\"r50k_base\"` | `\"p50k_base\"` | `\"p50k_edit\"` | `\"cl100k_base\"` | `\"o200k_base\"` | `\"gemini\"` | `\"gemma\"` | `\"llama2\"` | `\"claude\"` | The token encoding used for estimation. |\n| `renderer?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Optional renderer overriding the interim default. |\n\n#### Returns\n\n`number`\n\nA synchronous token estimate.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`estimateHandleTokens`](../../../../spooled_artifact/classes/SpooledArtifact.md#estimatehandletokens)\n\n***\n\n### estimateTokens()\n\n```ts\nestimateTokens(encoding:\n | \"gpt2\"\n | \"r50k_base\"\n | \"p50k_base\"\n | \"p50k_edit\"\n | \"cl100k_base\"\n | \"o200k_base\"\n | \"gemini\"\n | \"gemma\"\n | \"llama2\"\n| \"claude\"): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:656](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L656)\n\nEstimates the total token count of the artifact under `encoding`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |\n| `encoding` | | `\"gpt2\"` | `\"r50k_base\"` | `\"p50k_base\"` | `\"p50k_edit\"` | `\"cl100k_base\"` | `\"o200k_base\"` | `\"gemini\"` | `\"gemma\"` | `\"llama2\"` | `\"claude\"` | The encoding identifier to use for counting. |\n\n#### Returns\n\n`Promise`<`number`>\n\nThe estimated number of tokens.\n\n#### Remarks\n\nReads the full byte-faithful content via [SpooledArtifact.asString](../../../../spooled_artifact/classes/SpooledArtifact.md#asstring) (which delegates to\n[@nhtio/adk!SpoolReader.readAll](../../../../spooled_artifact/interfaces/SpoolReader.md#readall)) and delegates to [@nhtio/adk!Tokenizable.estimateTokens](../../../../common/classes/Tokenizable.md#estimatetokens). The estimate\ntherefore reflects the actual source bytes — including trailing newlines and non-`\\n` line\nterminators that the line-based [SpooledArtifact.cat](../../../../spooled_artifact/classes/SpooledArtifact.md#cat) view would otherwise discard or\nmisrepresent.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`estimateTokens`](../../../../spooled_artifact/classes/SpooledArtifact.md#estimatetokens)\n\n***\n\n### grep()\n\n```ts\ngrep(pattern: RegExp): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:501](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L501)\n\nReturns all lines that match `pattern`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------- |\n| `pattern` | `RegExp` | The regular expression to test each line against. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of matching line strings, in order.\n\n#### Remarks\n\nBehaves like POSIX `grep`: each line is tested against the pattern and included in the result\nwhen it matches. The pattern is applied as a JavaScript `RegExp`; flags (e.g. case-\ninsensitivity) should be encoded in the expression itself.\n\nStateful flags (`g`, `y`) on the supplied `RegExp` would normally cause `pattern.test()` to\nadvance `lastIndex` across calls, producing skipped matches and order-dependent results. To\nkeep the per-line semantics stateless, `grep` resets `pattern.lastIndex` to `0` before each\nline test. The forged `artifact_grep` tool also rejects `g` and `y` flags up-front at schema\nvalidation time.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`grep`](../../../../spooled_artifact/classes/SpooledArtifact.md#grep)\n\n***\n\n### hasSizeHints()\n\n```ts\nhasSizeHints(): boolean;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:567](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L567)\n\nReturns whether producer-computed size metadata is available.\n\n#### Returns\n\n`boolean`\n\n`true` when SpooledArtifact.\\_setSizeHints has populated the cache.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`hasSizeHints`](../../../../spooled_artifact/classes/SpooledArtifact.md#hassizehints)\n\n***\n\n### head()\n\n```ts\nhead(n?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L448)\n\nReturns the first `n` lines of the artifact.\n\n#### Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | -------- | ------------- | ------------------------------------------ |\n| `n` | `number` | `10` | Number of lines to return. Defaults to 10. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings, without trailing newlines.\n\n#### Remarks\n\nIf the artifact contains fewer than `n` lines, all available lines are returned. Matches the\nbehaviour of POSIX `head -n`.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`head`](../../../../spooled_artifact/classes/SpooledArtifact.md#head)\n\n***\n\n### lineCount()\n\n```ts\nlineCount(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:576](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L576)\n\nReturns the total number of lines in the artifact.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe line count as reported by the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`lineCount`](../../../../spooled_artifact/classes/SpooledArtifact.md#linecount)\n\n***\n\n### tail()\n\n```ts\ntail(n?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:471](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L471)\n\nReturns the last `n` lines of the artifact.\n\n#### Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | -------- | ------------- | ------------------------------------------ |\n| `n` | `number` | `10` | Number of lines to return. Defaults to 10. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings, without trailing newlines.\n\n#### Remarks\n\nIf the artifact contains fewer than `n` lines, all available lines are returned. Matches the\nbehaviour of POSIX `tail -n`.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`tail`](../../../../spooled_artifact/classes/SpooledArtifact.md#tail)\n\n***\n\n### toon\\_filter()\n\n```ts\ntoon_filter(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:406](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L406)\n\nReturns elements matched by a JSONPath filter expression.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------------------- |\n| `path` | `string` | A JSONPath expression (e.g. `'$[?(@.status === \"active\")]'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matching elements (at most one element, the root if matched).\n\n#### Remarks\n\nEvaluates `path` against the root value and returns it in an array if matched.\n\n***\n\n### toon\\_get()\n\n```ts\ntoon_get(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:392](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L392)\n\nEvaluates a JSONPath expression against the parsed TOON content.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------------------------ |\n| `path` | `string` | A JSONPath expression (e.g. `'$.user.address.city'`, `'$..name'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matched values. Empty array when no matches are found.\n\n#### Remarks\n\nUses [JSONPath-Plus](https://github.com/JSONPath-Plus/JSONPath). Full JSONPath syntax is\nsupported: recursive descent (`$..*`), filter expressions (`$[?(@.age > 18)]`), union\nselectors, and more.\n\n***\n\n### toon\\_keys()\n\n```ts\ntoon_keys(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:356](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L356)\n\nReturns the top-level keys of the parsed TOON content.\n\n#### Returns\n\n`Promise`<`string`\\[] | `undefined`>\n\nArray of key strings, or `undefined` when the root is not an object.\n\n#### Remarks\n\n* If the root is an object, returns its keys.\n* If the root is not a plain object (e.g. an array or scalar), returns `undefined`.\n\n***\n\n### toon\\_length()\n\n```ts\ntoon_length(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:373](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L373)\n\nReturns the element count of the parsed TOON content.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe element count.\n\n#### Remarks\n\n* If the root is an array, returns the array length.\n* Otherwise, returns `1` (the root is a single element).\n\n***\n\n### toon\\_pluck()\n\n```ts\ntoon_pluck(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:442](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L442)\n\nReturns all values matched by a JSONPath expression.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------- |\n| `path` | `string` | A JSONPath expression (e.g. `'$..name'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matched values.\n\n#### Remarks\n\nConvenience over [SpooledToonArtifact.toon\\_get](#toon_get) with an identical signature — use\nwhichever name better communicates intent at the call site. `toon_pluck` reads well for\nextracting a single field; `toon_get` reads well for structured queries.\n\n***\n\n### toon\\_slice()\n\n```ts\ntoon_slice(start?: number, end?: number): Promise;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:423](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L423)\n\nReturns a slice of the parsed content by index range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------------------- |\n| `start?` | `number` | Start index (inclusive). Defaults to `0`. |\n| `end?` | `number` | End index (exclusive). Defaults to the element count. |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of sliced elements.\n\n#### Remarks\n\n* If the root is an array, behaves like `Array.prototype.slice`.\n* If the root is not an array, returns the entire root in an array.\n\n***\n\n### toon\\_type()\n\n```ts\ntoon_type(): Promise<{\n format: string;\n}>;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:342](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L342)\n\nReturns the format of a TOON artifact.\n\n#### Returns\n\n`Promise`<{\n`format`: `string`;\n}>\n\nAn object with `format: 'toon'`.\n\n#### Remarks\n\nReports only the format name. The delimiter is deliberately not reported: the TOON decoder\nexposes no delimiter information, and every method of inferring one from the source proved\nunreliable for some class of strict-valid document. Four distinct approaches were attempted,\neach defeated by its own edge case:\n\n* Lexical scanning for the delimiter character failed on unquoted pipes inside values\n* Anchored header regex requiring a word key failed on quoted keys and keyless root arrays\n* Widened regex accepting quoted keys failed on escaped quotes within the key (e.g., \"a\"b\")\n* Byte-exact round-trip re-encoding failed on non-canonical formatting (indentation, line\n endings, trailing newlines)\n\nDelimiter inference is no longer attempted: nothing in the model's workflow needs it, and\nthe TOON decoder is the source of truth for all document metadata.\n\nThis result is cached after the first parse and returned identically on every call.\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: SpooledToonArtifact;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:468](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L468)\n\nReconstruct a SpooledToonArtifact from a SpooledToonArtifact.\\[ENCODE\\_METHOD]\nsnapshot.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------------------------------- |\n| `data` | `unknown` | The snapshot produced by SpooledToonArtifact.\\[ENCODE\\_METHOD]. |\n\n#### Returns\n\n`SpooledToonArtifact`\n\nA fresh SpooledToonArtifact} backed by a freshly-resolved reader.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`[DECODE_METHOD]`](../../../../spooled_artifact/classes/SpooledArtifact.md#decode_method)\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: SpooledArtifact;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:375](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L375)\n\nReconstruct a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) from an SpooledArtifact.\\[ENCODE\\_METHOD] snapshot.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------------------------------- |\n| `data` | `unknown` | The snapshot produced by SpooledArtifact.\\[ENCODE\\_METHOD]. |\n\n#### Returns\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)\n\nA fresh [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) backed by a freshly-resolved reader.\n\n#### Remarks\n\nRe-binds the reader via @nhtio/adk!resolveSpoolReader; throws\n[@nhtio/adk!E\\_NO\\_READER\\_RESOLVER](../../../../exceptions/variables/E_NO_READER_RESOLVER.md) when no resolver is registered for the descriptor's tag.\n\n#### Inherited from\n\n```ts\nSpooledArtifact.[DECODE_METHOD]\n```\n\n***\n\n### forgeTools()\n\n```ts\nstatic forgeTools(ctx: DispatchContext): ToolRegistry;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L209)\n\nForges base-class tools plus TOON-specific tools narrowed to SpooledToonArtifact.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------------------------------- |\n| `ctx` | [`DispatchContext`](../../../../types/interfaces/DispatchContext.md) |\n\n#### Returns\n\n[`ToolRegistry`](../../../../forge/classes/ToolRegistry.md)\n\n#### Remarks\n\nStandard subclass extension pattern: call `SpooledArtifact.forgeTools(ctx)` to produce\nthe base seven `artifact_*` tools narrowed to any `SpooledArtifact` in the turn, then\nregister one `ArtifactTool` per TOON-specific descriptor narrowed to TOON artifacts.\nDownstream consumers building their own subclasses should follow the same shape.\n\n#### Overrides\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`forgeTools`](../../../../spooled_artifact/classes/SpooledArtifact.md#forgetools)\n\n***\n\n### isSpooledArtifact()\n\n```ts\nstatic isSpooledArtifact(value: unknown): value is SpooledArtifact;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L408)\n\nReturns `true` if `value` is a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) instance (including any subclass).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledArtifact`\n\n`true` when `value` is a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) instance.\n\n#### Remarks\n\nUses the cross-realm-safe [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) guard: `instanceof` first, then\n`Symbol.hasInstance`, then a `constructor.name` fallback. Subclass instances (e.g.\n[@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md)) satisfy this guard because `instanceof` walks the prototype\nchain. The fallbacks handle the dual-module-copy case where two distinct `SpooledArtifact`\nclasses coexist in the same realm (e.g. one bundled into a downstream library, one in the\nconsumer's `node_modules`).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`isSpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md#isspooledartifact)\n\n***\n\n### isSpooledArtifactConstructor()\n\n```ts\nstatic isSpooledArtifactConstructor(value: unknown): value is SpooledArtifactConstructor;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L425)\n\nReturns `true` if `value` is a constructor function whose prototype chain includes\n[SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) (including `SpooledArtifact` itself).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledArtifactConstructor`\n\n`true` when `value` is a constructor for `SpooledArtifact` or a subclass.\n\n#### Remarks\n\nUsed by [@nhtio/adk!Tool](../../../../forge/classes/Tool.md) to validate the optional `artifactConstructor` field. Performs an\n`instanceof`-based check on the prototype chain; falls back to a duck-type test that looks\nfor the canonical SpooledArtifact instance methods on `value.prototype` for cross-realm\nsafety (constructors passed from a different module copy or VM context).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`isSpooledArtifactConstructor`](../../../../spooled_artifact/classes/SpooledArtifact.md#isspooledartifactconstructor)\n\n***\n\n### isSpooledToonArtifact()\n\n```ts\nstatic isSpooledToonArtifact(value: unknown): value is SpooledToonArtifact;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L116)\n\nReturns `true` if `value` is a SpooledToonArtifact instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledToonArtifact`\n\n`true` when `value` is a SpooledToonArtifact instance.\n\n#### Remarks\n\nUses the cross-realm-safe [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) guard: `instanceof` first, then\n`Symbol.hasInstance`, then a `constructor.name` fallback. Matches the pattern used by every\nother class guard in the ADK; safe against the dual-module-copy case where two distinct\n`SpooledToonArtifact` classes coexist in the same realm.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/interfaces/ToonDecodeOptions","title":"Interface: ToonDecodeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/interfaces/ToonDecodeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/interfaces/ToonDecodeOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/toon/interfaces/ToonDecodeOptions.md\ndescription: TOON decode options.\n---\n\n# Interface: ToonDecodeOptions\n\nDefined in: [src/batteries/artifacts/toon/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L68)\n\nTOON decode options.\n\n## Remarks\n\nPassed to the `@toon-format/toon` `decode` function.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | --------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `indentSize?` | `number` | The indent size used in the TOON encoding (default: 2). | [src/batteries/artifacts/toon/index.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L70) |\n| `strict?` | `boolean` | When `true`, reject non-standard TOON (default: `true`). | [src/batteries/artifacts/toon/index.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L72) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/variables/jsonToToonTool","title":"Variable: jsonToToonTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/variables/jsonToToonTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/variables/jsonToToonTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/toon/variables/jsonToToonTool.md\ndescription: 'Converter tool: JSON to TOON.'\n---\n\n# Variable: jsonToToonTool\n\n```ts\nconst jsonToToonTool: Tool;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:564](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L564)\n\nConverter tool: JSON to TOON.\n\n## Remarks\n\nAccepts either inline JSON text or a reference to a JSON artifact produced earlier in this turn.\nConverts to TOON and returns a new [SpooledToonArtifact](../classes/SpooledToonArtifact.md).\n\nThis is a plain [@nhtio/adk!Tool](../../../../forge/classes/Tool.md), not an [@nhtio/adk!ArtifactTool](../../../../forge/classes/ArtifactTool.md) — the handler\nreturns the new artifact directly, allowing the forge to discover and query it on the next\niteration without explicit wiring.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/variables/toonToJsonTool","title":"Variable: toonToJsonTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/variables/toonToJsonTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/toon/variables/toonToJsonTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/toon/variables/toonToJsonTool.md\ndescription: 'Converter tool: TOON to JSON.'\n---\n\n# Variable: toonToJsonTool\n\n```ts\nconst toonToJsonTool: Tool;\n```\n\nDefined in: [src/batteries/artifacts/toon/index.ts:488](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/index.ts#L488)\n\nConverter tool: TOON to JSON.\n\n## Remarks\n\nAccepts either inline TOON text or a reference to an artifact produced earlier in this turn.\nConverts to JSON and returns a new [@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md).\n\nThis is a plain [@nhtio/adk!Tool](../../../../forge/classes/Tool.md), not an [@nhtio/adk!ArtifactTool](../../../../forge/classes/ArtifactTool.md) — the handler\nreturns the new artifact directly, allowing the forge to discover and query it on the next\niteration without explicit wiring.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_DECODE_FAILED","title":"Variable: E\\_TOON\\_DECODE\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_DECODE_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_DECODE_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_DECODE_FAILED.md\ndescription: Thrown when TOON decoding fails.\n---\n\n# Variable: E\\_TOON\\_DECODE\\_FAILED\n\n```ts\nconst E_TOON_DECODE_FAILED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/artifacts/toon/exceptions.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/exceptions.ts#L36)\n\nThrown when TOON decoding fails.\n\n## Remarks\n\nWraps the underlying `ToonDecodeError` from the `@toon-format/toon` package, surfacing its\n`line` and `source` properties so the model can self-correct.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_PEER_MISSING","title":"Variable: E\\_TOON\\_PEER\\_MISSING","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_PEER_MISSING.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_PEER_MISSING","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/variables/E_TOON_PEER_MISSING.md\ndescription: Thrown when the TOON peer dependency cannot be loaded.\n---\n\n# Variable: E\\_TOON\\_PEER\\_MISSING\n\n```ts\nconst E_TOON_PEER_MISSING: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/artifacts/toon/exceptions.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/toon/exceptions.ts#L22)\n\nThrown when the TOON peer dependency cannot be loaded.\n\n## Remarks\n\nThe @toon-format/toon package is an optional peer. If it is not installed, methods requiring\nit throw this exception with installation instructions. The message template includes the package\nname, a description of its purpose, the underlying error, and the exact install command, so the\nconsumer sees a complete, actionable message regardless of call site.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TYPESCRIPT_PEER_MISSING","title":"Variable: E\\_TYPESCRIPT\\_PEER\\_MISSING","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TYPESCRIPT_PEER_MISSING.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_TYPESCRIPT_PEER_MISSING","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/variables/E_TYPESCRIPT_PEER_MISSING.md\ndescription: Thrown when the TypeScript peer dependency fails to load.\n---\n\n# Variable: E\\_TYPESCRIPT\\_PEER\\_MISSING\n\n```ts\nconst E_TYPESCRIPT_PEER_MISSING: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/artifacts/ecmascript/exceptions.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/ecmascript/exceptions.ts#L22)\n\nThrown when the TypeScript peer dependency fails to load.\n\n## Remarks\n\nThe battery requires typescript as an optional peer. This exception surfaces when the\ndynamic import fails, typically because the package is not installed or cannot be resolved.\nThe message template includes the package name, a description of its purpose, the underlying\nerror, and the exact install command, so the consumer sees a complete, actionable message\nregardless of call site.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSE_FAILED","title":"Variable: E\\_XML\\_PARSE\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSE_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSE_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSE_FAILED.md\ndescription: Thrown when XML parsing fails due to malformed markup.\n---\n\n# Variable: E\\_XML\\_PARSE\\_FAILED\n\n```ts\nconst E_XML_PARSE_FAILED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/artifacts/xml/exceptions.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/exceptions.ts#L35)\n\nThrown when XML parsing fails due to malformed markup.\n\n## Remarks\n\nPrintf args: `[errorDetail]` — includes the parser's own reason for the failure.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSER_PEER_MISSING","title":"Variable: E\\_XML\\_PARSER\\_PEER\\_MISSING","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSER_PEER_MISSING.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSER_PEER_MISSING","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/variables/E_XML_PARSER_PEER_MISSING.md\ndescription: >-\n Thrown when the fast-xml-parser optional peer is not installed or fails to\n load.\n---\n\n# Variable: E\\_XML\\_PARSER\\_PEER\\_MISSING\n\n```ts\nconst E_XML_PARSER_PEER_MISSING: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/artifacts/xml/exceptions.ts:21](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/exceptions.ts#L21)\n\nThrown when the fast-xml-parser optional peer is not installed or fails to load.\n\n## Remarks\n\nThe message template includes the package name, a description of its purpose, the underlying\nerror, and the exact install command, so the consumer sees a complete, actionable message\nregardless of call site.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml","title":"@nhtio/adk/batteries/artifacts/xml","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/xml.md'\ndescription: A structured artifact battery for XML documents.\n---\n\n# @nhtio/adk/batteries/artifacts/xml\n\nA structured artifact battery for XML documents.\n\n## Remarks\n\nProvides [SpooledXmlArtifact](classes/SpooledXmlArtifact.md) — a `SpooledArtifact` specialisation that parses XML\ninto a JSON projection and offers path-based query tools over that projection. The XML-to-JSON\nmapping defaults to `ignoreAttributes: false` and `attributeNamePrefix: '_'`, both settable\nper instance through the constructor; `preserveOrder: false` is fixed. Under the default\nmapping:\n\n* Element attributes become keys prefixed with `_` (e.g., `root-element` with `href=\"x\"`\n becomes `{ a: { _href: 'x', ... } }`).\n* Element text content becomes a `#text` key when the element also has attributes or siblings.\n* Repeated sibling elements collapse into an array.\n* The full projection is queryable via JSONPath expressions (e.g., `$..name` finds all name\n elements anywhere in the tree). Attributes are accessed via underscore-prefixed keys,\n e.g. `$..[\"_href\"]` for the href attribute (recursive descent).\n\nThe battery also exports two converter `Tool` constants: `xmlToJsonTool` and `jsonToXmlTool`.\nThese accept either inline XML/JSON text or a reference to an artifact produced earlier in\nthe turn, and return the converted result as a new `SpooledJsonArtifact` or\n`SpooledXmlArtifact`.\n\nBattery exceptions are defined in this module's `exceptions.ts` file — `createException`\nre-exported from `@nhtio/adk/factories`. Decoding a [SpooledXmlArtifact](classes/SpooledXmlArtifact.md) instance via\n`decode()` throws until `registerArtifactEncodables()` has run (see\n[@nhtio/adk/batteries/artifacts!registerArtifactEncodables](../functions/registerArtifactEncodables.md)).\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [SpooledXmlArtifact](classes/SpooledXmlArtifact.md) | A [@nhtio/adk!SpooledArtifact](../../../spooled_artifact/classes/SpooledArtifact.md) specialisation that adds XML-aware read operations. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------- | -------------------------------------------------------------- |\n| [jsonToXmlTool](variables/jsonToXmlTool.md) | A tool that converts JSON (inline or from an artifact) to XML. |\n| [xmlToJsonTool](variables/xmlToJsonTool.md) | A tool that converts XML (inline or from an artifact) to JSON. |\n\n## References\n\n### E\\_XML\\_PARSE\\_FAILED\n\nRe-exports [E\\_XML\\_PARSE\\_FAILED](../variables/E_XML_PARSE_FAILED.md)\n\n***\n\n### E\\_XML\\_PARSER\\_PEER\\_MISSING\n\nRe-exports [E\\_XML\\_PARSER\\_PEER\\_MISSING](../variables/E_XML_PARSER_PEER_MISSING.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/classes/SpooledXmlArtifact","title":"Class: SpooledXmlArtifact","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/classes/SpooledXmlArtifact.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/classes/SpooledXmlArtifact","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/xml/classes/SpooledXmlArtifact.md\ndescription: >-\n A {@link @nhtio/adk!SpooledArtifact} specialisation that adds XML-aware read\n operations.\n---\n\n# Class: SpooledXmlArtifact\n\nDefined in: [src/batteries/artifacts/xml/index.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L107)\n\nA [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) specialisation that adds XML-aware read operations.\n\n## Remarks\n\nThe artifact parses XML into a JSON projection on first access and caches it for the\nlifetime of the instance. The projection uses `ignoreAttributes` and `attributeNamePrefix` as\nsupplied to the constructor — defaulting to `false` and `'_'` — with `preserveOrder: false`.\n\nUnder this mapping, an XML element like:\n\n`root-element` with an `href` attribute and text content becomes a JSON object like:\n`{ root: { element: { _href: 'value', '#text': 'content' } } }`\n\nAttributes are prefixed with `_` by default rather than the conventional `@_`, because\n`jsonpath-plus` reads a leading `@` in a path segment as its type-selector sigil before\nhonouring quotes: `$..[\"@_href\"]` throws `Unknown value type _hr`, while `$..[\"_href\"]`\nmatches. Text nodes use the `#text` key.\n\nAll XML methods are async, consistent with [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md).\n\nPath-based methods (`xml_get`, `xml_filter`, `xml_pluck`) use\n[JSONPath-Plus](https://github.com/JSONPath-Plus/JSONPath) expressions over the projection.\nFull JSONPath syntax is supported, including recursive descent (`..`), filter expressions,\nand union selectors.\n\n## Extends\n\n* [`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew SpooledXmlArtifact(reader: SpoolReader, options?: {\n attributeNamePrefix?: string;\n ignoreAttributes?: boolean;\n}): SpooledXmlArtifact;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L123)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------------------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `reader` | [`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md) | The backing store to read from. |\n| `options?` | { `attributeNamePrefix?`: `string`; `ignoreAttributes?`: `boolean`; } | Optional parser configuration. |\n| `options.attributeNamePrefix?` | `string` | Prefix for attribute keys (default: '*'). Set to '@*' if you need the conventional XML-to-JSON mapping, but be aware that naming such a key in a JSONPath segment fails — `$..[\"@_attr\"]` throws `Unknown value type _at`, and quoting does not escape it. A filter expression still reaches it (`$..[?(@['@_attr'])]`); a wildcard does too, but only when placed exactly one level above the key, so the working path depends on whether repeated elements collapsed into an array. |\n| `options.ignoreAttributes?` | `boolean` | When true, ignore element attributes (default: false). |\n\n#### Returns\n\n`SpooledXmlArtifact`\n\n#### Overrides\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`constructor`](../../../../spooled_artifact/classes/SpooledArtifact.md#constructor)\n\n## Properties\n\n| Property | Modifier | Type | Description | Overrides | Defined in |\n| ----------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `toolMethods` | `static` | readonly [`ToolMethodDescriptor`](../../../../common/interfaces/ToolMethodDescriptor.md)\\[] | The XML-specific artifact-query descriptors this class adds on top of the base set. **Remarks** Lists `artifact_xml_root`, `artifact_xml_keys`, `artifact_xml_tags`, `artifact_xml_length`, `artifact_xml_get`, `artifact_xml_filter`, `artifact_xml_pluck`. The base seven descriptors (`artifact_head`, etc.) are NOT included here — they are forged separately by [SpooledXmlArtifact.forgeTools](#forgetools). | [`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`toolMethods`](../../../../spooled_artifact/classes/SpooledArtifact.md#property-toolmethods) | [src/batteries/artifacts/xml/index.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L179) |\n\n## Methods\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: unknown;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L524)\n\nSerialise this SpooledXmlArtifact into an `@nhtio/encoder` snapshot — the reader **handle**\nplus the constructor options for `attributeNamePrefix` and `ignoreAttributes`.\n\n#### Returns\n\n`unknown`\n\nA snapshot consumed by SpooledXmlArtifact.\\[DECODE\\_METHOD].\n\n#### Remarks\n\nOverrides SpooledArtifact.\\[ENCODE\\_METHOD] to carry the constructor's options\n(the parsed projection cache is derived and not encoded). Round-trips via\nSpooledXmlArtifact.\\[DECODE\\_METHOD].\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`[ENCODE_METHOD]`](../../../../spooled_artifact/classes/SpooledArtifact.md#encode_method)\n\n***\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: unknown;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L361)\n\nSerialise this SpooledArtifact into an `@nhtio/encoder` snapshot — the reader **handle**, not the\nbytes.\n\n#### Returns\n\n`unknown`\n\nA snapshot consumed by SpooledArtifact.\\[DECODE\\_METHOD].\n\n#### Remarks\n\nEmits the backing reader's [ReaderDescriptor](../../../../common/interfaces/ReaderDescriptor.md); decode re-binds the reader through the\nregistered resolver. Throws [@nhtio/adk!E\\_READER\\_NOT\\_DESCRIBABLE](../../../../exceptions/variables/E_READER_NOT_DESCRIBABLE.md) when the reader cannot\ndescribe itself. Subclasses override this to include their own discriminators (e.g.\n[@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md) adds `format`).\n\n#### Inherited from\n\n```ts\nSpooledArtifact.[ENCODE_METHOD]\n```\n\n***\n\n### asString()\n\n```ts\nasString(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:677](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L677)\n\nReturns the full artifact body as a single byte-faithful string.\n\n#### Returns\n\n`Promise`<`string`>\n\nThe full content as a single string.\n\n#### Remarks\n\nRound-trip faithful to whatever bytes the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md) was constructed over —\npreserves trailing newlines and non-`\\n` line terminators that [SpooledArtifact.cat](../../../../spooled_artifact/classes/SpooledArtifact.md#cat)\ndiscards via its line-based view. This is the canonical primitive for \"inline the artifact\ncontent directly into a message\" use cases.\n\n`asString()` and the static `forgeTools(ctx)` factory on each subclass are independent\nalternatives — a consumer chooses per turn whether to inline the body in a message\n(`await tc.results.asString()`) or hand the model query tools\n(`SpooledArtifact.forgeTools(ctx)`). Neither calls the other; either works with neither.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`asString`](../../../../spooled_artifact/classes/SpooledArtifact.md#asstring)\n\n***\n\n### byteLength()\n\n```ts\nbyteLength(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:548](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L548)\n\nReturns the total byte length of the underlying data.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe byte length as reported by the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`byteLength`](../../../../spooled_artifact/classes/SpooledArtifact.md#bytelength)\n\n***\n\n### cat()\n\n```ts\ncat(start?: number, end?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:529](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L529)\n\nReturns lines from the artifact, optionally bounded to a range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | -------------------------------------------------------------- |\n| `start?` | `number` | 0-based start line index (inclusive). Defaults to `0`. |\n| `end?` | `number` | 0-based end line index (exclusive). Defaults to `lineCount()`. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings in the requested range.\n\n#### Remarks\n\nWithout arguments, returns all lines — equivalent to POSIX `cat`. With `start` and/or `end`,\nbehaves like `Array.prototype.slice`: `start` defaults to `0`, `end` defaults to the total\nline count, and only lines in `[start, end)` are fetched from the backing store. For large\nartifacts, prefer a bounded range or [SpooledArtifact.head](../../../../spooled_artifact/classes/SpooledArtifact.md#head) / [SpooledArtifact.tail](../../../../spooled_artifact/classes/SpooledArtifact.md#tail).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`cat`](../../../../spooled_artifact/classes/SpooledArtifact.md#cat)\n\n***\n\n### estimateHandleTokens()\n\n```ts\nestimateHandleTokens(\n callId: string,\n encoding:\n | \"gpt2\"\n | \"r50k_base\"\n | \"p50k_base\"\n | \"p50k_edit\"\n | \"cl100k_base\"\n | \"o200k_base\"\n | \"gemini\"\n | \"gemma\"\n | \"llama2\"\n | \"claude\",\n renderer?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n}) => string): number;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:594](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L594)\n\nEstimates tokens for the exact handle-body metadata rendered for this artifact.\n\nThe fallback renderer is an interim core-safe implementation. Its output is deliberately\nspecified here for fan-in parity: the lines are the fixed prose and metadata strings below,\nwith one `\\n` separator, and method entries formatted as `- name — description` (or `- name`).\nThe canonical renderer in `chat_common` should eventually delegate to this builder rather than\nmaintain a second copy.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |\n| `callId` | `string` | The turn-local artifact identifier. |\n| `encoding` | | `\"gpt2\"` | `\"r50k_base\"` | `\"p50k_base\"` | `\"p50k_edit\"` | `\"cl100k_base\"` | `\"o200k_base\"` | `\"gemini\"` | `\"gemma\"` | `\"llama2\"` | `\"claude\"` | The token encoding used for estimation. |\n| `renderer?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Optional renderer overriding the interim default. |\n\n#### Returns\n\n`number`\n\nA synchronous token estimate.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`estimateHandleTokens`](../../../../spooled_artifact/classes/SpooledArtifact.md#estimatehandletokens)\n\n***\n\n### estimateTokens()\n\n```ts\nestimateTokens(encoding:\n | \"gpt2\"\n | \"r50k_base\"\n | \"p50k_base\"\n | \"p50k_edit\"\n | \"cl100k_base\"\n | \"o200k_base\"\n | \"gemini\"\n | \"gemma\"\n | \"llama2\"\n| \"claude\"): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:656](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L656)\n\nEstimates the total token count of the artifact under `encoding`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |\n| `encoding` | | `\"gpt2\"` | `\"r50k_base\"` | `\"p50k_base\"` | `\"p50k_edit\"` | `\"cl100k_base\"` | `\"o200k_base\"` | `\"gemini\"` | `\"gemma\"` | `\"llama2\"` | `\"claude\"` | The encoding identifier to use for counting. |\n\n#### Returns\n\n`Promise`<`number`>\n\nThe estimated number of tokens.\n\n#### Remarks\n\nReads the full byte-faithful content via [SpooledArtifact.asString](../../../../spooled_artifact/classes/SpooledArtifact.md#asstring) (which delegates to\n[@nhtio/adk!SpoolReader.readAll](../../../../spooled_artifact/interfaces/SpoolReader.md#readall)) and delegates to [@nhtio/adk!Tokenizable.estimateTokens](../../../../common/classes/Tokenizable.md#estimatetokens). The estimate\ntherefore reflects the actual source bytes — including trailing newlines and non-`\\n` line\nterminators that the line-based [SpooledArtifact.cat](../../../../spooled_artifact/classes/SpooledArtifact.md#cat) view would otherwise discard or\nmisrepresent.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`estimateTokens`](../../../../spooled_artifact/classes/SpooledArtifact.md#estimatetokens)\n\n***\n\n### getParserOptions()\n\n```ts\ngetParserOptions(): {\n attributeNamePrefix: string;\n ignoreAttributes: boolean;\n};\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L160)\n\nReturns the effective XML-to-JSON parser configuration for this artifact.\n\n#### Returns\n\n```ts\n{\n attributeNamePrefix: string;\n ignoreAttributes: boolean;\n}\n```\n\nAn object with `attributeNamePrefix` and `ignoreAttributes` keys.\n\n| Name | Type | Defined in |\n| --------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `attributeNamePrefix` | `string` | [src/batteries/artifacts/xml/index.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L161) |\n| `ignoreAttributes` | `boolean` | [src/batteries/artifacts/xml/index.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L162) |\n\n#### Remarks\n\nWhen converting an XML artifact to JSON by call\\_id, the converter inherits the source\nartifact's attribute prefix and ignoreAttributes setting. This accessor exposes those\noptions so the converter can apply them consistently.\n\n***\n\n### grep()\n\n```ts\ngrep(pattern: RegExp): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:501](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L501)\n\nReturns all lines that match `pattern`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------- |\n| `pattern` | `RegExp` | The regular expression to test each line against. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of matching line strings, in order.\n\n#### Remarks\n\nBehaves like POSIX `grep`: each line is tested against the pattern and included in the result\nwhen it matches. The pattern is applied as a JavaScript `RegExp`; flags (e.g. case-\ninsensitivity) should be encoded in the expression itself.\n\nStateful flags (`g`, `y`) on the supplied `RegExp` would normally cause `pattern.test()` to\nadvance `lastIndex` across calls, producing skipped matches and order-dependent results. To\nkeep the per-line semantics stateless, `grep` resets `pattern.lastIndex` to `0` before each\nline test. The forged `artifact_grep` tool also rejects `g` and `y` flags up-front at schema\nvalidation time.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`grep`](../../../../spooled_artifact/classes/SpooledArtifact.md#grep)\n\n***\n\n### hasSizeHints()\n\n```ts\nhasSizeHints(): boolean;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:567](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L567)\n\nReturns whether producer-computed size metadata is available.\n\n#### Returns\n\n`boolean`\n\n`true` when SpooledArtifact.\\_setSizeHints has populated the cache.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`hasSizeHints`](../../../../spooled_artifact/classes/SpooledArtifact.md#hassizehints)\n\n***\n\n### head()\n\n```ts\nhead(n?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L448)\n\nReturns the first `n` lines of the artifact.\n\n#### Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | -------- | ------------- | ------------------------------------------ |\n| `n` | `number` | `10` | Number of lines to return. Defaults to 10. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings, without trailing newlines.\n\n#### Remarks\n\nIf the artifact contains fewer than `n` lines, all available lines are returned. Matches the\nbehaviour of POSIX `head -n`.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`head`](../../../../spooled_artifact/classes/SpooledArtifact.md#head)\n\n***\n\n### lineCount()\n\n```ts\nlineCount(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:576](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L576)\n\nReturns the total number of lines in the artifact.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe line count as reported by the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`lineCount`](../../../../spooled_artifact/classes/SpooledArtifact.md#linecount)\n\n***\n\n### tail()\n\n```ts\ntail(n?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:471](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L471)\n\nReturns the last `n` lines of the artifact.\n\n#### Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | -------- | ------------- | ------------------------------------------ |\n| `n` | `number` | `10` | Number of lines to return. Defaults to 10. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings, without trailing newlines.\n\n#### Remarks\n\nIf the artifact contains fewer than `n` lines, all available lines are returned. Matches the\nbehaviour of POSIX `tail -n`.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`tail`](../../../../spooled_artifact/classes/SpooledArtifact.md#tail)\n\n***\n\n### xml\\_filter()\n\n```ts\nxml_filter(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L371)\n\nReturns the elements (subtrees) that match a JSONPath expression.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ---------------------------------------------------------------------- |\n| `path` | `string` | A JSONPath expression (e.g. '$.root.item\\[\\*].\\_id' or '$\\[?(@.status)]'). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matching element subtrees. Empty array when no matches found.\n\n#### Remarks\n\nEvaluates the path against the XML projection and returns the elements that\ncontain matching values. Unlike xml\\_get (which returns matched values), xml\\_filter\nreturns the element objects containing those matches.\n\nCandidate set definition for XML's single-rooted projection:\n\n* If the root element contains an array of repeated siblings (e.g., root.item\n where item is an array property), filters across those siblings and returns\n elements that have matching content.\n* If the root element contains a single object, evaluates the path against it\n and returns it when matched.\n\nThe path is evaluated using JSONPath-Plus with resultType 'all' to extract\nparent elements of matched values. The immediate parent object of any matched\nvalue is included in the result, deduplicating elements.\n\nExample: for XML with root containing multiple 'item' elements each with an\n'id' attribute, xml\\_filter('$.root.item\\[\\*].\\_id') returns the item elements\nthat have an id attribute, whereas xml\\_get would return the id values themselves.\n\n***\n\n### xml\\_get()\n\n```ts\nxml_get(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:339](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L339)\n\nQuery the document via JSONPath expression.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------ |\n| `path` | `string` | A JSONPath expression (e.g., `'$..name'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matched values.\n\n***\n\n### xml\\_keys()\n\n```ts\nxml_keys(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:271](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L271)\n\nKeys directly under the root element.\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of key names at the root level.\n\n***\n\n### xml\\_length()\n\n```ts\nxml_length(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L322)\n\nElement count when the root contains an array of children; otherwise 1.\n\n#### Returns\n\n`Promise`<`number`>\n\nNumber of elements.\n\n***\n\n### xml\\_pluck()\n\n```ts\nxml_pluck(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:422](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L422)\n\nAlias for xml\\_get — extract values matching a JSONPath.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------ |\n| `path` | `string` | A JSONPath expression (e.g., `'$..name'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matched values.\n\n***\n\n### xml\\_root()\n\n```ts\nxml_root(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L257)\n\nThe root element name of the XML document.\n\n#### Returns\n\n`Promise`<`string`>\n\nThe name of the root element.\n\n#### Throws\n\nError when the document is malformed or empty.\n\n***\n\n### xml\\_tags()\n\n```ts\nxml_tags(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L290)\n\nEvery distinct element name in the document, deduplicated.\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nSorted array of unique element names.\n\n#### Remarks\n\nWalks the entire projection recursively, excluding attribute keys (prefixed with the\nconfigured `attributeNamePrefix`, default `_`) and `#text` keys. This is what a model\ncalls before it can write a path into an unfamiliar document.\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: SpooledXmlArtifact;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L539)\n\nReconstruct a SpooledXmlArtifact from a SpooledXmlArtifact.\\[ENCODE\\_METHOD]\nsnapshot.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | -------------------------------------------------------------- |\n| `data` | `unknown` | The snapshot produced by SpooledXmlArtifact.\\[ENCODE\\_METHOD]. |\n\n#### Returns\n\n`SpooledXmlArtifact`\n\nA fresh SpooledXmlArtifact backed by a freshly-resolved reader.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`[DECODE_METHOD]`](../../../../spooled_artifact/classes/SpooledArtifact.md#decode_method)\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: SpooledArtifact;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:375](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L375)\n\nReconstruct a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) from an SpooledArtifact.\\[ENCODE\\_METHOD] snapshot.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------------------------------- |\n| `data` | `unknown` | The snapshot produced by SpooledArtifact.\\[ENCODE\\_METHOD]. |\n\n#### Returns\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)\n\nA fresh [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) backed by a freshly-resolved reader.\n\n#### Remarks\n\nRe-binds the reader via @nhtio/adk!resolveSpoolReader; throws\n[@nhtio/adk!E\\_NO\\_READER\\_RESOLVER](../../../../exceptions/variables/E_NO_READER_RESOLVER.md) when no resolver is registered for the descriptor's tag.\n\n#### Inherited from\n\n```ts\nSpooledArtifact.[DECODE_METHOD]\n```\n\n***\n\n### forgeTools()\n\n```ts\nstatic forgeTools(ctx: DispatchContext): ToolRegistry;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:431](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L431)\n\nStandard subclass extension pattern: call `SpooledArtifact.forgeTools(ctx)` to produce\nthe base seven `artifact_*` tools narrowed to any `SpooledArtifact` in the turn, then\nregister one `ArtifactTool` per XML-specific descriptor narrowed to XML artifacts.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------------------------------- |\n| `ctx` | [`DispatchContext`](../../../../types/interfaces/DispatchContext.md) |\n\n#### Returns\n\n[`ToolRegistry`](../../../../forge/classes/ToolRegistry.md)\n\n#### Overrides\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`forgeTools`](../../../../spooled_artifact/classes/SpooledArtifact.md#forgetools)\n\n***\n\n### isSpooledArtifact()\n\n```ts\nstatic isSpooledArtifact(value: unknown): value is SpooledArtifact;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L408)\n\nReturns `true` if `value` is a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) instance (including any subclass).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledArtifact`\n\n`true` when `value` is a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) instance.\n\n#### Remarks\n\nUses the cross-realm-safe [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) guard: `instanceof` first, then\n`Symbol.hasInstance`, then a `constructor.name` fallback. Subclass instances (e.g.\n[@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md)) satisfy this guard because `instanceof` walks the prototype\nchain. The fallbacks handle the dual-module-copy case where two distinct `SpooledArtifact`\nclasses coexist in the same realm (e.g. one bundled into a downstream library, one in the\nconsumer's `node_modules`).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`isSpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md#isspooledartifact)\n\n***\n\n### isSpooledArtifactConstructor()\n\n```ts\nstatic isSpooledArtifactConstructor(value: unknown): value is SpooledArtifactConstructor;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L425)\n\nReturns `true` if `value` is a constructor function whose prototype chain includes\n[SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) (including `SpooledArtifact` itself).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledArtifactConstructor`\n\n`true` when `value` is a constructor for `SpooledArtifact` or a subclass.\n\n#### Remarks\n\nUsed by [@nhtio/adk!Tool](../../../../forge/classes/Tool.md) to validate the optional `artifactConstructor` field. Performs an\n`instanceof`-based check on the prototype chain; falls back to a duck-type test that looks\nfor the canonical SpooledArtifact instance methods on `value.prototype` for cross-realm\nsafety (constructors passed from a different module copy or VM context).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`isSpooledArtifactConstructor`](../../../../spooled_artifact/classes/SpooledArtifact.md#isspooledartifactconstructor)\n\n***\n\n### isSpooledXmlArtifact()\n\n```ts\nstatic isSpooledXmlArtifact(value: unknown): value is SpooledXmlArtifact;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L146)\n\nReturns `true` if `value` is a SpooledXmlArtifact instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledXmlArtifact`\n\n`true` when `value` is a SpooledXmlArtifact instance.\n\n#### Remarks\n\nUses the cross-realm-safe [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) guard. Safe against the\ndual-module-copy case where two distinct `SpooledXmlArtifact` classes coexist in the same\nrealm.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/variables/jsonToXmlTool","title":"Variable: jsonToXmlTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/variables/jsonToXmlTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/variables/jsonToXmlTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/xml/variables/jsonToXmlTool.md\ndescription: A tool that converts JSON (inline or from an artifact) to XML.\n---\n\n# Variable: jsonToXmlTool\n\n```ts\nconst jsonToXmlTool: Tool;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:651](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L651)\n\nA tool that converts JSON (inline or from an artifact) to XML.\n\n## Remarks\n\nInput is either `text` (inline JSON) or `call_id` (a JSON artifact from earlier in this turn).\nProvide exactly one. Returns a new [SpooledXmlArtifact](../classes/SpooledXmlArtifact.md).\n\nNote: XML has no faithful JSON inverse. A JSON document that never came from XML may not\nrebuild into sensible markup. This tool converts on a best-effort basis; the result may not\nround-trip perfectly back to the original JSON.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/variables/xmlToJsonTool","title":"Variable: xmlToJsonTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/variables/xmlToJsonTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/xml/variables/xmlToJsonTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/xml/variables/xmlToJsonTool.md\ndescription: A tool that converts XML (inline or from an artifact) to JSON.\n---\n\n# Variable: xmlToJsonTool\n\n```ts\nconst xmlToJsonTool: Tool>;\n```\n\nDefined in: [src/batteries/artifacts/xml/index.ts:559](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/xml/index.ts#L559)\n\nA tool that converts XML (inline or from an artifact) to JSON.\n\n## Remarks\n\nInput is either `text` (inline XML) or `call_id` (an XML artifact from earlier in this turn).\nProvide exactly one. Returns a new [SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml","title":"@nhtio/adk/batteries/artifacts/yaml","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/yaml.md'\ndescription: >-\n YAML artifact battery: [`SpooledYamlArtifact`](https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/yaml/classes/SpooledYamlArtifact) and bidirectional\n converters.\n---\n\n# @nhtio/adk/batteries/artifacts/yaml\n\nYAML artifact battery: [SpooledYamlArtifact](classes/SpooledYamlArtifact.md) and bidirectional converters.\n\n## Remarks\n\nProvides structured query tools for YAML documents, both single-document and\nmulti-document streams. Includes converter tools to transform between YAML and JSON\nrepresentations without materialising the artifact contents.\n\nRequires the optional peer `js-yaml@^4.1.1`. Install with:\n\n```\npnpm add js-yaml\n```\n\nNote: `decode()` on `SpooledYamlArtifact` instances throws until\n`registerArtifactEncodables()` has been called.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| [SpooledYamlArtifact](classes/SpooledYamlArtifact.md) | A [SpooledArtifact](../../../spooled_artifact/classes/SpooledArtifact.md) specialisation that adds YAML-aware read operations. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------- | -------------------------------------------------------------------- |\n| [E\\_YAML\\_PARSE\\_ERROR](variables/E_YAML_PARSE_ERROR.md) | Thrown when YAML parsing fails due to invalid syntax. |\n| [E\\_YAML\\_PEER\\_MISSING](variables/E_YAML_PEER_MISSING.md) | Thrown when the js-yaml peer dependency is missing or fails to load. |\n| [jsonToYamlTool](variables/jsonToYamlTool.md) | Converter tool: JSON → YAML. |\n| [yamlToJsonTool](variables/yamlToJsonTool.md) | Converter tool: YAML → JSON. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/classes/SpooledYamlArtifact","title":"Class: SpooledYamlArtifact","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/classes/SpooledYamlArtifact.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/classes/SpooledYamlArtifact","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/yaml/classes/SpooledYamlArtifact.md\ndescription: 'A [`SpooledArtifact`](https://adk.nht.io/api/@nhtio/adk/spooled_artifact/classes/SpooledArtifact) specialisation that adds YAML-aware read operations.'\n---\n\n# Class: SpooledYamlArtifact\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L95)\n\nA [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) specialisation that adds YAML-aware read operations.\n\n## Remarks\n\nHandles both single-document YAML and multi-document streams (delimited by `---`).\nParsed documents are cached in a private field for the lifetime of the instance.\n\nFor multi-document streams:\n\n* `yaml_length` reports the document count.\n* `yaml_keys` returns the deduplicated union of keys across all documents.\n* `yaml_get` / `yaml_filter` / `yaml_pluck` evaluate paths against all documents and return\n a flat array of all matches.\n\nNon-finite numbers (`.NaN`, `.inf`, `-.inf`) present in the YAML are preserved through the\n`yaml_to_json` converter using a custom replacer.\n\n## Extends\n\n* [`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew SpooledYamlArtifact(reader: SpoolReader, options?: {\n multiDocument?: boolean;\n}): SpooledYamlArtifact;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L108)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------------------ | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `reader` | [`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md) | The backing store to read from. |\n| `options?` | { `multiDocument?`: `boolean`; } | Optional configuration for parsing. |\n| `options.multiDocument?` | `boolean` | Declares the source's document mode. `true` parses as a stream and makes [SpooledYamlArtifact.yaml\\_type](#yaml_type) report `'multi-document'` regardless of the current count. `false` asserts exactly one document and parses with `load`, so a `---` stream raises `E_YAML_PARSE_ERROR` instead of being silently accepted. When omitted, mode is auto-detected by parsing the content with `loadAll`. |\n\n#### Returns\n\n`SpooledYamlArtifact`\n\n#### Overrides\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`constructor`](../../../../spooled_artifact/classes/SpooledArtifact.md#constructor)\n\n## Properties\n\n| Property | Modifier | Type | Description | Overrides | Defined in |\n| ----------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `toolMethods` | `static` | readonly [`ToolMethodDescriptor`](../../../../common/interfaces/ToolMethodDescriptor.md)\\[] | The YAML-specific artifact-query descriptors this class adds on top of the base set. **Remarks** Lists `artifact_yaml_type`, `artifact_yaml_keys`, `artifact_yaml_length`, `artifact_yaml_get`, `artifact_yaml_filter`, `artifact_yaml_slice`, `artifact_yaml_pluck`. The base seven descriptors (`artifact_head`, etc.) are NOT included here — they are forged separately by [SpooledYamlArtifact.forgeTools](#forgetools). | [`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`toolMethods`](../../../../spooled_artifact/classes/SpooledArtifact.md#property-toolmethods) | [src/batteries/artifacts/yaml/index.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L139) |\n\n## Methods\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: unknown;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:455](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L455)\n\nSerialise this SpooledYamlArtifact into an `@nhtio/encoder` snapshot.\n\n#### Returns\n\n`unknown`\n\nA snapshot consumed by SpooledYamlArtifact.\\[DECODE\\_METHOD].\n\n#### Remarks\n\nOverrides SpooledArtifact.\\[ENCODE\\_METHOD] to carry the constructor's `multiDocument`\noption. The parsed-document cache is derived and not encoded. Round-trips via\nSpooledYamlArtifact.\\[DECODE\\_METHOD].\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`[ENCODE_METHOD]`](../../../../spooled_artifact/classes/SpooledArtifact.md#encode_method)\n\n***\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: unknown;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L361)\n\nSerialise this SpooledArtifact into an `@nhtio/encoder` snapshot — the reader **handle**, not the\nbytes.\n\n#### Returns\n\n`unknown`\n\nA snapshot consumed by SpooledArtifact.\\[DECODE\\_METHOD].\n\n#### Remarks\n\nEmits the backing reader's [ReaderDescriptor](../../../../common/interfaces/ReaderDescriptor.md); decode re-binds the reader through the\nregistered resolver. Throws [@nhtio/adk!E\\_READER\\_NOT\\_DESCRIBABLE](../../../../exceptions/variables/E_READER_NOT_DESCRIBABLE.md) when the reader cannot\ndescribe itself. Subclasses override this to include their own discriminators (e.g.\n[@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md) adds `format`).\n\n#### Inherited from\n\n```ts\nSpooledArtifact.[ENCODE_METHOD]\n```\n\n***\n\n### asString()\n\n```ts\nasString(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:677](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L677)\n\nReturns the full artifact body as a single byte-faithful string.\n\n#### Returns\n\n`Promise`<`string`>\n\nThe full content as a single string.\n\n#### Remarks\n\nRound-trip faithful to whatever bytes the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md) was constructed over —\npreserves trailing newlines and non-`\\n` line terminators that [SpooledArtifact.cat](../../../../spooled_artifact/classes/SpooledArtifact.md#cat)\ndiscards via its line-based view. This is the canonical primitive for \"inline the artifact\ncontent directly into a message\" use cases.\n\n`asString()` and the static `forgeTools(ctx)` factory on each subclass are independent\nalternatives — a consumer chooses per turn whether to inline the body in a message\n(`await tc.results.asString()`) or hand the model query tools\n(`SpooledArtifact.forgeTools(ctx)`). Neither calls the other; either works with neither.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`asString`](../../../../spooled_artifact/classes/SpooledArtifact.md#asstring)\n\n***\n\n### byteLength()\n\n```ts\nbyteLength(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:548](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L548)\n\nReturns the total byte length of the underlying data.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe byte length as reported by the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`byteLength`](../../../../spooled_artifact/classes/SpooledArtifact.md#bytelength)\n\n***\n\n### cat()\n\n```ts\ncat(start?: number, end?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:529](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L529)\n\nReturns lines from the artifact, optionally bounded to a range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | -------------------------------------------------------------- |\n| `start?` | `number` | 0-based start line index (inclusive). Defaults to `0`. |\n| `end?` | `number` | 0-based end line index (exclusive). Defaults to `lineCount()`. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings in the requested range.\n\n#### Remarks\n\nWithout arguments, returns all lines — equivalent to POSIX `cat`. With `start` and/or `end`,\nbehaves like `Array.prototype.slice`: `start` defaults to `0`, `end` defaults to the total\nline count, and only lines in `[start, end)` are fetched from the backing store. For large\nartifacts, prefer a bounded range or [SpooledArtifact.head](../../../../spooled_artifact/classes/SpooledArtifact.md#head) / [SpooledArtifact.tail](../../../../spooled_artifact/classes/SpooledArtifact.md#tail).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`cat`](../../../../spooled_artifact/classes/SpooledArtifact.md#cat)\n\n***\n\n### estimateHandleTokens()\n\n```ts\nestimateHandleTokens(\n callId: string,\n encoding:\n | \"gpt2\"\n | \"r50k_base\"\n | \"p50k_base\"\n | \"p50k_edit\"\n | \"cl100k_base\"\n | \"o200k_base\"\n | \"gemini\"\n | \"gemma\"\n | \"llama2\"\n | \"claude\",\n renderer?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n}) => string): number;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:594](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L594)\n\nEstimates tokens for the exact handle-body metadata rendered for this artifact.\n\nThe fallback renderer is an interim core-safe implementation. Its output is deliberately\nspecified here for fan-in parity: the lines are the fixed prose and metadata strings below,\nwith one `\\n` separator, and method entries formatted as `- name — description` (or `- name`).\nThe canonical renderer in `chat_common` should eventually delegate to this builder rather than\nmaintain a second copy.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |\n| `callId` | `string` | The turn-local artifact identifier. |\n| `encoding` | | `\"gpt2\"` | `\"r50k_base\"` | `\"p50k_base\"` | `\"p50k_edit\"` | `\"cl100k_base\"` | `\"o200k_base\"` | `\"gemini\"` | `\"gemma\"` | `\"llama2\"` | `\"claude\"` | The token encoding used for estimation. |\n| `renderer?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Optional renderer overriding the interim default. |\n\n#### Returns\n\n`number`\n\nA synchronous token estimate.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`estimateHandleTokens`](../../../../spooled_artifact/classes/SpooledArtifact.md#estimatehandletokens)\n\n***\n\n### estimateTokens()\n\n```ts\nestimateTokens(encoding:\n | \"gpt2\"\n | \"r50k_base\"\n | \"p50k_base\"\n | \"p50k_edit\"\n | \"cl100k_base\"\n | \"o200k_base\"\n | \"gemini\"\n | \"gemma\"\n | \"llama2\"\n| \"claude\"): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:656](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L656)\n\nEstimates the total token count of the artifact under `encoding`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |\n| `encoding` | | `\"gpt2\"` | `\"r50k_base\"` | `\"p50k_base\"` | `\"p50k_edit\"` | `\"cl100k_base\"` | `\"o200k_base\"` | `\"gemini\"` | `\"gemma\"` | `\"llama2\"` | `\"claude\"` | The encoding identifier to use for counting. |\n\n#### Returns\n\n`Promise`<`number`>\n\nThe estimated number of tokens.\n\n#### Remarks\n\nReads the full byte-faithful content via [SpooledArtifact.asString](../../../../spooled_artifact/classes/SpooledArtifact.md#asstring) (which delegates to\n[@nhtio/adk!SpoolReader.readAll](../../../../spooled_artifact/interfaces/SpoolReader.md#readall)) and delegates to [@nhtio/adk!Tokenizable.estimateTokens](../../../../common/classes/Tokenizable.md#estimatetokens). The estimate\ntherefore reflects the actual source bytes — including trailing newlines and non-`\\n` line\nterminators that the line-based [SpooledArtifact.cat](../../../../spooled_artifact/classes/SpooledArtifact.md#cat) view would otherwise discard or\nmisrepresent.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`estimateTokens`](../../../../spooled_artifact/classes/SpooledArtifact.md#estimatetokens)\n\n***\n\n### grep()\n\n```ts\ngrep(pattern: RegExp): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:501](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L501)\n\nReturns all lines that match `pattern`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------- |\n| `pattern` | `RegExp` | The regular expression to test each line against. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of matching line strings, in order.\n\n#### Remarks\n\nBehaves like POSIX `grep`: each line is tested against the pattern and included in the result\nwhen it matches. The pattern is applied as a JavaScript `RegExp`; flags (e.g. case-\ninsensitivity) should be encoded in the expression itself.\n\nStateful flags (`g`, `y`) on the supplied `RegExp` would normally cause `pattern.test()` to\nadvance `lastIndex` across calls, producing skipped matches and order-dependent results. To\nkeep the per-line semantics stateless, `grep` resets `pattern.lastIndex` to `0` before each\nline test. The forged `artifact_grep` tool also rejects `g` and `y` flags up-front at schema\nvalidation time.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`grep`](../../../../spooled_artifact/classes/SpooledArtifact.md#grep)\n\n***\n\n### hasSizeHints()\n\n```ts\nhasSizeHints(): boolean;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:567](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L567)\n\nReturns whether producer-computed size metadata is available.\n\n#### Returns\n\n`boolean`\n\n`true` when SpooledArtifact.\\_setSizeHints has populated the cache.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`hasSizeHints`](../../../../spooled_artifact/classes/SpooledArtifact.md#hassizehints)\n\n***\n\n### head()\n\n```ts\nhead(n?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L448)\n\nReturns the first `n` lines of the artifact.\n\n#### Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | -------- | ------------- | ------------------------------------------ |\n| `n` | `number` | `10` | Number of lines to return. Defaults to 10. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings, without trailing newlines.\n\n#### Remarks\n\nIf the artifact contains fewer than `n` lines, all available lines are returned. Matches the\nbehaviour of POSIX `head -n`.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`head`](../../../../spooled_artifact/classes/SpooledArtifact.md#head)\n\n***\n\n### lineCount()\n\n```ts\nlineCount(): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:576](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L576)\n\nReturns the total number of lines in the artifact.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe line count as reported by the [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`lineCount`](../../../../spooled_artifact/classes/SpooledArtifact.md#linecount)\n\n***\n\n### tail()\n\n```ts\ntail(n?: number): Promise;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:471](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L471)\n\nReturns the last `n` lines of the artifact.\n\n#### Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | -------- | ------------- | ------------------------------------------ |\n| `n` | `number` | `10` | Number of lines to return. Defaults to 10. |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\nArray of line strings, without trailing newlines.\n\n#### Remarks\n\nIf the artifact contains fewer than `n` lines, all available lines are returned. Matches the\nbehaviour of POSIX `tail -n`.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`tail`](../../../../spooled_artifact/classes/SpooledArtifact.md#tail)\n\n***\n\n### yaml\\_filter()\n\n```ts\nyaml_filter(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L408)\n\nReturns documents matched by a JSONPath filter expression.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------------------- |\n| `path` | `string` | A JSONPath expression (e.g. `'$[?(@.status === \"active\")]'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matching documents.\n\n#### Remarks\n\nEvaluates `path` against each document and returns those for which the expression\nproduces at least one match.\n\n***\n\n### yaml\\_get()\n\n```ts\nyaml_get(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:393](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L393)\n\nEvaluates a JSONPath expression against the parsed documents.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------------------------ |\n| `path` | `string` | A JSONPath expression (e.g. `'$.user.address.city'`, `'$..name'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matched values. Empty array when no matches are found.\n\n#### Remarks\n\nFor single-document: evaluates the expression against the root value.\nFor multi-document: evaluates the expression against each document and returns a flat\narray of all matches across all documents.\n\nUses [JSONPath-Plus](https://github.com/JSONPath-Plus/JSONPath). Full JSONPath syntax is\nsupported.\n\n***\n\n### yaml\\_keys()\n\n```ts\nyaml_keys(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:347](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L347)\n\nReturns the top-level keys of the parsed content.\n\n#### Returns\n\n`Promise`<`string`\\[] | `undefined`>\n\nArray of key strings, or `undefined` when no object keys are present.\n\n#### Remarks\n\nFor single-document: returns the keys of the root object, or `undefined` when the root\nis not a plain object.\nFor multi-document: returns the union of keys across all documents that are plain objects.\nDuplicate keys are deduplicated.\n\n***\n\n### yaml\\_length()\n\n```ts\nyaml_length(): Promise;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:374](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L374)\n\nReturns the total number of documents in the artifact.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe document count.\n\n#### Remarks\n\nThe result comes directly from js-yaml.loadAll(). For sources with no actual YAML content\n(empty, whitespace-only, or BOM-only), the parser typically returns 0 documents, but certain\nwhitespace arrangements (such as a bare double newline) may yield 1. Do not rely on the exact\ncount to test for emptiness. For real documents, the count is reliable: a single-document\nYAML returns 1, and a `---`-separated stream returns its exact document count.\n\n***\n\n### yaml\\_pluck()\n\n```ts\nyaml_pluck(path: string): Promise;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:441](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L441)\n\nReturns all values matched by a JSONPath expression across every document.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------- |\n| `path` | `string` | A JSONPath expression (e.g. `'$..name'`). |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of matched values.\n\n#### Remarks\n\nConvenience over [yaml\\_get](#yaml_get) with an identical signature — use whichever name\nbetter communicates intent at the call site.\n\n***\n\n### yaml\\_slice()\n\n```ts\nyaml_slice(start?: number, end?: number): Promise;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:426](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L426)\n\nReturns a slice of documents by index range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------------------ |\n| `start?` | `number` | Start index (inclusive). Defaults to `0`. |\n| `end?` | `number` | End index (exclusive). Defaults to the document count. |\n\n#### Returns\n\n`Promise`<`unknown`\\[]>\n\nArray of sliced documents.\n\n#### Remarks\n\nBehaves like `Array.prototype.slice` over the document array.\n\n***\n\n### yaml\\_type()\n\n```ts\nyaml_type(): Promise<\"single-document\" | \"multi-document\">;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:328](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L328)\n\nReturns whether this artifact contains a single document or multiple documents.\n\n#### Returns\n\n`Promise`<`\"single-document\"` | `\"multi-document\"`>\n\n`'single-document'` or `'multi-document'`.\n\n#### Remarks\n\nWhen the constructor was given `multiDocument: true`, the source is treated as a stream and\nthis reports `'multi-document'` even if that stream currently holds one document — a\none-element stream is still a stream, and [SpooledYamlArtifact.yaml\\_length](#yaml_length) reports the\nreal count either way. `multiDocument: false` cannot disagree with the count, because parsing\na `---` stream under it fails outright rather than silently reporting the wrong mode.\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: SpooledYamlArtifact;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:466](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L466)\n\nReconstruct a SpooledYamlArtifact from a SpooledYamlArtifact.\\[ENCODE\\_METHOD]\nsnapshot.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------------------------------- |\n| `data` | `unknown` | The snapshot produced by SpooledYamlArtifact.\\[ENCODE\\_METHOD]. |\n\n#### Returns\n\n`SpooledYamlArtifact`\n\nA fresh SpooledYamlArtifact} backed by a freshly-resolved reader.\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`[DECODE_METHOD]`](../../../../spooled_artifact/classes/SpooledArtifact.md#decode_method)\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: SpooledArtifact;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:375](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L375)\n\nReconstruct a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) from an SpooledArtifact.\\[ENCODE\\_METHOD] snapshot.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------------------------------- |\n| `data` | `unknown` | The snapshot produced by SpooledArtifact.\\[ENCODE\\_METHOD]. |\n\n#### Returns\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)\n\nA fresh [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) backed by a freshly-resolved reader.\n\n#### Remarks\n\nRe-binds the reader via @nhtio/adk!resolveSpoolReader; throws\n[@nhtio/adk!E\\_NO\\_READER\\_RESOLVER](../../../../exceptions/variables/E_NO_READER_RESOLVER.md) when no resolver is registered for the descriptor's tag.\n\n#### Inherited from\n\n```ts\nSpooledArtifact.[DECODE_METHOD]\n```\n\n***\n\n### forgeTools()\n\n```ts\nstatic forgeTools(ctx: DispatchContext): ToolRegistry;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L216)\n\nForges base-class tools plus YAML-specific tools narrowed to SpooledYamlArtifact.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------------------------------- |\n| `ctx` | [`DispatchContext`](../../../../types/interfaces/DispatchContext.md) |\n\n#### Returns\n\n[`ToolRegistry`](../../../../forge/classes/ToolRegistry.md)\n\n#### Remarks\n\nStandard subclass extension pattern: call `SpooledArtifact.forgeTools(ctx)` to produce\nthe base seven `artifact_*` tools narrowed to any `SpooledArtifact` in the turn, then\nregister one `ArtifactTool` per YAML-specific descriptor narrowed to YAML artifacts.\n\n#### Overrides\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`forgeTools`](../../../../spooled_artifact/classes/SpooledArtifact.md#forgetools)\n\n***\n\n### isSpooledArtifact()\n\n```ts\nstatic isSpooledArtifact(value: unknown): value is SpooledArtifact;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L408)\n\nReturns `true` if `value` is a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) instance (including any subclass).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledArtifact`\n\n`true` when `value` is a [SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) instance.\n\n#### Remarks\n\nUses the cross-realm-safe [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) guard: `instanceof` first, then\n`Symbol.hasInstance`, then a `constructor.name` fallback. Subclass instances (e.g.\n[@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md)) satisfy this guard because `instanceof` walks the prototype\nchain. The fallbacks handle the dual-module-copy case where two distinct `SpooledArtifact`\nclasses coexist in the same realm (e.g. one bundled into a downstream library, one in the\nconsumer's `node_modules`).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`isSpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md#isspooledartifact)\n\n***\n\n### isSpooledArtifactConstructor()\n\n```ts\nstatic isSpooledArtifactConstructor(value: unknown): value is SpooledArtifactConstructor;\n```\n\nDefined in: [src/lib/classes/spooled\\_artifact.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/classes/spooled_artifact.ts#L425)\n\nReturns `true` if `value` is a constructor function whose prototype chain includes\n[SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) (including `SpooledArtifact` itself).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledArtifactConstructor`\n\n`true` when `value` is a constructor for `SpooledArtifact` or a subclass.\n\n#### Remarks\n\nUsed by [@nhtio/adk!Tool](../../../../forge/classes/Tool.md) to validate the optional `artifactConstructor` field. Performs an\n`instanceof`-based check on the prototype chain; falls back to a duck-type test that looks\nfor the canonical SpooledArtifact instance methods on `value.prototype` for cross-realm\nsafety (constructors passed from a different module copy or VM context).\n\n#### Inherited from\n\n[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md).[`isSpooledArtifactConstructor`](../../../../spooled_artifact/classes/SpooledArtifact.md#isspooledartifactconstructor)\n\n***\n\n### isSpooledYamlArtifact()\n\n```ts\nstatic isSpooledYamlArtifact(value: unknown): value is SpooledYamlArtifact;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L126)\n\nReturns `true` if `value` is a SpooledYamlArtifact instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is SpooledYamlArtifact`\n\n`true` when `value` is a SpooledYamlArtifact instance.\n\n#### Remarks\n\nUses the cross-realm-safe [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) guard. Safe against the\ndual-module-copy case where two distinct `SpooledYamlArtifact` classes coexist in the\nsame realm.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PARSE_ERROR","title":"Variable: E\\_YAML\\_PARSE\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PARSE_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PARSE_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PARSE_ERROR.md\ndescription: Thrown when YAML parsing fails due to invalid syntax.\n---\n\n# Variable: E\\_YAML\\_PARSE\\_ERROR\n\n```ts\nconst E_YAML_PARSE_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/artifacts/yaml/exceptions.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/exceptions.ts#L10)\n\nThrown when YAML parsing fails due to invalid syntax.\n\n## Remarks\n\nThe exception message includes the parser's original error reason and line/mark information\nwhen available, which enables the model to self-correct malformed YAML.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PEER_MISSING","title":"Variable: E\\_YAML\\_PEER\\_MISSING","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PEER_MISSING.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PEER_MISSING","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/yaml/variables/E_YAML_PEER_MISSING.md\ndescription: Thrown when the js-yaml peer dependency is missing or fails to load.\n---\n\n# Variable: E\\_YAML\\_PEER\\_MISSING\n\n```ts\nconst E_YAML_PEER_MISSING: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/artifacts/yaml/exceptions.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/exceptions.ts#L26)\n\nThrown when the js-yaml peer dependency is missing or fails to load.\n\n## Remarks\n\nThis occurs when the battery's consumer has not installed the optional js-yaml peer\ndependency. The message template includes the package name, a description of its purpose,\nthe underlying error, and the exact install command, so the consumer sees a complete,\nactionable message regardless of call site.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/jsonToYamlTool","title":"Variable: jsonToYamlTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/jsonToYamlTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/jsonToYamlTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/yaml/variables/jsonToYamlTool.md\ndescription: 'Converter tool: JSON → YAML.'\n---\n\n# Variable: jsonToYamlTool\n\n```ts\nconst jsonToYamlTool: Tool;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:593](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L593)\n\nConverter tool: JSON → YAML.\n\n## Remarks\n\nTakes either inline JSON text or a reference to a [SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md) produced\nearlier in the turn. Converts to YAML and returns a fresh [SpooledYamlArtifact](../classes/SpooledYamlArtifact.md)}\nimmediately queryable with YAML artifact tools.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/yamlToJsonTool","title":"Variable: yamlToJsonTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/yamlToJsonTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/artifacts/yaml/variables/yamlToJsonTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/artifacts/yaml/variables/yamlToJsonTool.md\ndescription: 'Converter tool: YAML → JSON.'\n---\n\n# Variable: yamlToJsonTool\n\n```ts\nconst yamlToJsonTool: Tool>;\n```\n\nDefined in: [src/batteries/artifacts/yaml/index.ts:505](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/artifacts/yaml/index.ts#L505)\n\nConverter tool: YAML → JSON.\n\n## Remarks\n\nTakes either inline YAML text or a reference to a [SpooledYamlArtifact](../classes/SpooledYamlArtifact.md) produced\nearlier in the turn. Converts to JSON and returns a fresh [SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md)\nimmediately queryable with JSON artifact tools.\n\nNon-finite numbers are preserved as their YAML token strings (`.NaN`, `.inf`, `-.inf`).\nUndefined values are normalised to the JSON string `'null'`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/classes/GuestEndpoint","title":"Class: GuestEndpoint","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/classes/GuestEndpoint.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/classes/GuestEndpoint","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/classes/GuestEndpoint.md'\ndescription: >-\n Guest-side correlation engine over a [`PortLike`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/PortLike). Owns per-call\n `AbortController`s (aborted on an inbound `abort`/`stream:cancel` envelope)\n and exposes `settleCall`/`pushDelta`/`endStream`/ `errorStream` for `serve.ts`\n to report outcomes back across the wire.\n---\n\n# Class: GuestEndpoint\n\nDefined in: [src/batteries/isolation/protocol.ts:432](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L432)\n\nGuest-side correlation engine over a [PortLike](../interfaces/PortLike.md). Owns per-call `AbortController`s (aborted on\nan inbound `abort`/`stream:cancel` envelope) and exposes `settleCall`/`pushDelta`/`endStream`/\n`errorStream` for `serve.ts` to report outcomes back across the wire.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew GuestEndpoint(port: PortLike, hooks?: GuestEndpointHooks): GuestEndpoint;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:442](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L442)\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------- |\n| `port` | [`PortLike`](../interfaces/PortLike.md) |\n| `hooks` | [`GuestEndpointHooks`](../interfaces/GuestEndpointHooks.md) |\n\n#### Returns\n\n`GuestEndpoint`\n\n## Methods\n\n### emit()\n\n```ts\nemit(channel: string, payload: WireValue): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:554](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L554)\n\nEmit an unsolicited event on `channel`.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------- |\n| `channel` | `string` |\n| `payload` | [`WireValue`](../type-aliases/WireValue.md) |\n\n#### Returns\n\n`void`\n\n***\n\n### endStream()\n\n```ts\nendStream(id: string): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:536](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L536)\n\nSignal a stream's clean end and release its abort controller.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `id` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### errorStream()\n\n```ts\nerrorStream(id: string, error: WireError): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:542](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L542)\n\nSignal a stream's terminal error and release its abort controller.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------- |\n| `id` | `string` |\n| `error` | [`WireError`](../interfaces/WireError.md) |\n\n#### Returns\n\n`void`\n\n***\n\n### hostcall()\n\n```ts\nhostcall(\n method: string,\n args: WireValue[],\n maxBytes?: number): {\n id: string;\n promise: Promise;\n};\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:497](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L497)\n\nIssue a guest-to-host capability request using the separate hostcall id space.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | --------------------------------------------- |\n| `method` | `string` |\n| `args` | [`WireValue`](../type-aliases/WireValue.md)\\[] |\n| `maxBytes?` | `number` |\n\n#### Returns\n\n```ts\n{\n id: string;\n promise: Promise;\n}\n```\n\n| Name | Type | Defined in |\n| --------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `string` | [src/batteries/isolation/protocol.ts:501](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L501) |\n| `promise` | `Promise`<`string` | [`WireValue`](../type-aliases/WireValue.md)> | [src/batteries/isolation/protocol.ts:501](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L501) |\n\n***\n\n### pushDelta()\n\n```ts\npushDelta(id: string, delta: WireValue): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L531)\n\nPush a stream delta.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------- |\n| `id` | `string` |\n| `delta` | [`WireValue`](../type-aliases/WireValue.md) |\n\n#### Returns\n\n`void`\n\n***\n\n### ready()\n\n```ts\nready(encoderAvailable: boolean): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:514](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L514)\n\nAnnounce readiness. Must be sent exactly once, before any `result`/`stream:*`/`event` envelope.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------ | --------- |\n| `encoderAvailable` | `boolean` |\n\n#### Returns\n\n`void`\n\n***\n\n### settleError()\n\n```ts\nsettleError(id: string, error: WireError): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:525](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L525)\n\nReport a failed call outcome and release the call's abort controller.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------- |\n| `id` | `string` |\n| `error` | [`WireError`](../interfaces/WireError.md) |\n\n#### Returns\n\n`void`\n\n***\n\n### settleOk()\n\n```ts\nsettleOk(id: string, value: WireValue): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:519](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L519)\n\nReport a successful call outcome and release the call's abort controller.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------- |\n| `id` | `string` |\n| `value` | [`WireValue`](../type-aliases/WireValue.md) |\n\n#### Returns\n\n`void`\n\n***\n\n### terminate()\n\n```ts\nterminate(reason?: string): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:548](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L548)\n\nReject all guest capability requests when this endpoint is stopped.\n\n#### Parameters\n\n| Parameter | Type | Default value |\n| --------- | -------- | ------------------------------------- |\n| `reason` | `string` | `'GuestEndpoint has been terminated'` |\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/classes/HostEndpoint","title":"Class: HostEndpoint","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/classes/HostEndpoint.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/classes/HostEndpoint","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/classes/HostEndpoint.md'\ndescription: >-\n Host-side correlation engine over a [`PortLike`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/PortLike). Queues\n calls/stream-starts made before `ready` and flushes them in order once it\n arrives; tracks in-flight calls (one-shot, resolved/rejected by a `result`\n envelope) and open streams (persistent, fed by\n `stream:delta`/`stream:end`/`stream:error` until closed). `terminate()`\n rejects every in-flight call and errors every open stream with a\n caller-supplied reason (the message text `host.ts` uses is\n `E_ISOLATED_TERMINATED`'s message).\n---\n\n# Class: HostEndpoint\n\nDefined in: [src/batteries/isolation/protocol.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L143)\n\nHost-side correlation engine over a [PortLike](../interfaces/PortLike.md). Queues calls/stream-starts made before `ready`\nand flushes them in order once it arrives; tracks in-flight calls (one-shot, resolved/rejected by a\n`result` envelope) and open streams (persistent, fed by `stream:delta`/`stream:end`/`stream:error`\nuntil closed). `terminate()` rejects every in-flight call and errors every open stream with a\ncaller-supplied reason (the message text `host.ts` uses is `E_ISOLATED_TERMINATED`'s message).\n\n## Constructors\n\n### Constructor\n\n```ts\nnew HostEndpoint(\n port: PortLike,\n hooks?: HostEndpointHooks,\n hostcalls?: {\n handlers?: ReadonlyMap;\n maxHostcallBytes?: number;\n quotas?: HostcallQuotas;\n}): HostEndpoint;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L158)\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `port` | [`PortLike`](../interfaces/PortLike.md) |\n| `hooks` | [`HostEndpointHooks`](../interfaces/HostEndpointHooks.md) |\n| `hostcalls` | { `handlers?`: `ReadonlyMap`<`string`, `HostcallHandler`>; `maxHostcallBytes?`: `number`; `quotas?`: `HostcallQuotas`; } |\n| `hostcalls.handlers?` | `ReadonlyMap`<`string`, `HostcallHandler`> |\n| `hostcalls.maxHostcallBytes?` | `number` |\n| `hostcalls.quotas?` | `HostcallQuotas` |\n\n#### Returns\n\n`HostEndpoint`\n\n## Accessors\n\n### isReady\n\n#### Get Signature\n\n```ts\nget isReady(): boolean;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L176)\n\nWhether the guest has signaled `ready` yet.\n\n##### Returns\n\n`boolean`\n\n***\n\n### openStreamCount\n\n#### Get Signature\n\n```ts\nget openStreamCount(): number;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L188)\n\nNumber of streams currently open (started, not yet ended/errored). Used by `host.ts` alongside\n[pendingCallCount](#pendingcallcount) to report an accurate `inFlight` count on a crash.\n\n##### Returns\n\n`number`\n\n***\n\n### pendingCallCount\n\n#### Get Signature\n\n```ts\nget pendingCallCount(): number;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L182)\n\nNumber of calls currently awaiting a `result` envelope. Used by `host.ts` to report an accurate\n`inFlight` count on a crash before `terminate()` clears the pending map.\n\n##### Returns\n\n`number`\n\n## Methods\n\n### abort()\n\n```ts\nabort(id: string): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:351](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L351)\n\nSend an `abort` envelope for an in-flight call's id. Does not itself reject the call — the guest\nis expected to respond with a `result` (ok:false) once it observes the abort.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `id` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### call()\n\n```ts\ncall(method: string, args: WireValue[]): {\n id: string;\n promise: Promise;\n};\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L261)\n\nIssue a request/response call. Resolves with the guest's returned [WireValue](../type-aliases/WireValue.md), rejects with a\nreconstructed `Error` (see [wireErrorToError](../functions/wireErrorToError.md)) on failure or on `terminate()`.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------- |\n| `method` | `string` |\n| `args` | [`WireValue`](../type-aliases/WireValue.md)\\[] |\n\n#### Returns\n\n```ts\n{\n id: string;\n promise: Promise;\n}\n```\n\n| Name | Type | Defined in |\n| --------- | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `string` | [src/batteries/isolation/protocol.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L261) |\n| `promise` | `Promise`<[`WireValue`](../type-aliases/WireValue.md)> | [src/batteries/isolation/protocol.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L261) |\n\n***\n\n### cancelStream()\n\n```ts\ncancelStream(id: string, reason?: WireValue): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:368](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L368)\n\nSend a `stream:cancel` envelope and stop tracking the stream locally.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------- |\n| `id` | `string` |\n| `reason?` | [`WireValue`](../type-aliases/WireValue.md) |\n\n#### Returns\n\n`void`\n\n***\n\n### hostresult()\n\n```ts\nhostresult(id: string, result:\n | {\n ok: true;\n value: string | WireValue;\n}\n | {\n error?: WireError;\n ok: false;\n value?: string;\n}): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:339](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L339)\n\nPost a guest capability result. Unknown/late ids are harmlessly ignored by the guest.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `string` |\n| `result` | | { `ok`: `true`; `value`: `string` | [`WireValue`](../type-aliases/WireValue.md); } | { `error?`: [`WireError`](../interfaces/WireError.md); `ok`: `false`; `value?`: `string`; } |\n\n#### Returns\n\n`void`\n\n***\n\n### shutdown()\n\n```ts\nshutdown(): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:374](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L374)\n\nSend a `shutdown` envelope (graceful-exit request; does not itself tear down the port).\n\n#### Returns\n\n`void`\n\n***\n\n### startStream()\n\n```ts\nstartStream(\n stream: string,\n args: WireValue[],\n sink: StreamSink): string;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:360](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L360)\n\nStart a fire-and-forward stream. Returns the correlation id immediately (before the guest\nnecessarily even exists, if not yet `ready`) and a `sink` the caller wires to a `ReadableStream`\ncontroller.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------- |\n| `stream` | `string` |\n| `args` | [`WireValue`](../type-aliases/WireValue.md)\\[] |\n| `sink` | `StreamSink` |\n\n#### Returns\n\n`string`\n\n***\n\n### terminate()\n\n```ts\nterminate(reason: string): void;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:382](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L382)\n\nReject every in-flight call and error every open stream with `reason`, clear all queued-but-unsent\nenvelopes, and unsubscribe from the port. Idempotent.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `reason` | `string` |\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/classes/TransformersJsSttAdapter","title":"Class: TransformersJsSttAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/classes/TransformersJsSttAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/classes/TransformersJsSttAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/classes/TransformersJsSttAdapter.md\ndescription: >-\n STT adapter for transformers.js's automatic-speech-recognition\n (Whisper-family) pipeline.\n---\n\n# Class: TransformersJsSttAdapter\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L76)\n\nSTT adapter for transformers.js's automatic-speech-recognition (Whisper-family) pipeline.\n\n## Remarks\n\nReusable: construct once, call [TransformersJsSttAdapter.transcribe](#transcribe) as many times as needed.\nThe pipeline is resolved lazily on first use (or via [preload](#preload)) and cached with single-flight\nsemantics so concurrent calls share one load.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew TransformersJsSttAdapter(options: unknown): TransformersJsSttAdapter;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L93)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`TransformersJsSttAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS](../variables/E_INVALID_TRANSFORMERS_JS_STT_OPTIONS.md) when invalid.\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L123)\n\nRelease the loaded model's ONNX sessions + GPU/wasm buffers, then drop the cached pipeline.\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\n`reset()` only nulls the JS reference; the native ONNX Runtime sessions and WebGPU/wasm device\nmemory stay alive until GC. `AutomaticSpeechRecognitionPipeline` extends `Pipeline`, which exposes\n`dispose()` — this awaits it so the memory is reclaimed between loads, swallows a disposal error\n(teardown must not throw), and finishes with `reset()`. Idempotent.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L99)\n\nInstance availability probe (honours an injected `isAvailable`).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L104)\n\nEagerly loads (and caches) the pipeline so the first `transcribe` call is fast. Idempotent.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L109)\n\nDrops the cached pipeline and in-flight load so the next call reloads.\n\n#### Returns\n\n`void`\n\n***\n\n### transcribe()\n\n```ts\ntranscribe(input: SpecialistAudioInput, opts?: TranscribeOptions): Promise;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L222)\n\nTranscribes an audio clip.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | [`SpecialistAudioInput`](../specialists/_shared/type-aliases/SpecialistAudioInput.md) | The audio input, in any [@nhtio/adk/batteries/specialists/\\_shared!SpecialistAudioInput](../specialists/_shared/type-aliases/SpecialistAudioInput.md) form (pre-decoded PCM or an encoded container). |\n| `opts?` | [`TranscribeOptions`](../interfaces/TranscribeOptions.md) | Per-call transcription options (language / translate / timestamps). |\n\n#### Returns\n\n`Promise`<[`TranscribeResult`](../interfaces/TranscribeResult.md)>\n\nThe recognized text, plus per-segment timing when `opts.timestamps` was set.\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR](../variables/E_TRANSFORMERS_JS_STT_ENGINE_ERROR.md) when the pipeline fails to\nload or the transcription call fails.\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/adapter.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/adapter.ts#L85)\n\nWhether this battery is available. transformers.js is environment-neutral (Node + browser), so\nthis is `true` whenever the runtime can import the peer — there is no WebGPU requirement.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context","title":"@nhtio/adk/batteries/context","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context.md'\ndescription: >-\n Aggregate barrel for bundled context-management batteries — strategies for\n fitting a large working set of messages, memories, retrievables, thoughts, and\n tools into a model's context window.\n---\n\n# @nhtio/adk/batteries/context\n\nAggregate barrel for bundled context-management batteries — strategies for fitting a large working\nset of messages, memories, retrievables, thoughts, and tools into a model's context window.\n\n## Remarks\n\nA context-management battery answers one question: given more candidate content than a dispatch's\nwindow can hold, what do you send? Different strategies answer this differently, at different\ncosts:\n\n* **`thrift`** (available now, re-exported below): SUBTRACTIVE — start with everything reasonable,\n then shed the lowest-signal content first (an image, stale tool results, the RAG tail, low-value\n memories, old turns, guidance thoughts, then tools as a last resort) until the dispatch fits.\n Every decision is a measured token comparison; **zero extra model calls**. See\n @nhtio/adk/batteries/context/thrift for the full algorithm and its head-to-head evaluation\n results.\n* **`compact`** (available now, re-exported below): SUMMARIZING — instead of shedding old turns\n outright, pay for a model call to compress them into a running summary message, trading a real API\n cost for retaining compressed signal from everything folded away. `thrift` already carries the one\n hook `compact` needs to coexist with it (the `isSummaryMessage` predicate on\n [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!SubtractToFitOptions](thrift/subtractive_pass/interfaces/SubtractToFitOptions.md)), so a caller can\n run `compact` upstream and `thrift` downstream in the same pipeline without the two strategies\n fighting over the same running-summary message. See @nhtio/adk/batteries/context/compact\n for the full algorithm and its head-to-head evaluation results.\n\nThese are genuinely different trade-offs, not tiers of the same idea — `thrift` is the cost-optimal,\nalways-available default; `compact` is the strategy to reach for when a project can afford (and\nbenefits from, per the honest head-to-head result documented in the `thrift` battery barrel) paying\nfor compression on top of subtraction. Both are meant to be composable, not mutually exclusive.\n\n## References\n\n### argText\n\nRe-exports [argText](thrift/relevance/functions/argText.md)\n\n***\n\n### assembleCompactedTurns\n\nRe-exports [assembleCompactedTurns](compact/summarizer/functions/assembleCompactedTurns.md)\n\n***\n\n### AssembleCompactedTurnsOptions\n\nRe-exports [AssembleCompactedTurnsOptions](compact/summarizer/interfaces/AssembleCompactedTurnsOptions.md)\n\n***\n\n### AssembleCompactedTurnsResult\n\nRe-exports [AssembleCompactedTurnsResult](compact/summarizer/interfaces/AssembleCompactedTurnsResult.md)\n\n***\n\n### BucketTrace\n\nRe-exports [BucketTrace](thrift/subtractive_pass/interfaces/BucketTrace.md)\n\n***\n\n### COMPACTION\\_SYSTEM\\_PROMPT\n\nRe-exports [COMPACTION\\_SYSTEM\\_PROMPT](compact/summarizer/variables/COMPACTION_SYSTEM_PROMPT.md)\n\n***\n\n### CompactionCostEvent\n\nRe-exports [CompactionCostEvent](compact/contracts/interfaces/CompactionCostEvent.md)\n\n***\n\n### ContentLike\n\nRe-exports [ContentLike](thrift/contracts/interfaces/ContentLike.md)\n\n***\n\n### contentTokens\n\nRe-exports [contentTokens](thrift/relevance/functions/contentTokens.md)\n\n***\n\n### DEFAULT\\_ENCODING\n\nRe-exports [DEFAULT\\_ENCODING](thrift/subtractive_pass/variables/DEFAULT_ENCODING.md)\n\n***\n\n### DEFAULT\\_KEEP\\_VERBATIM\n\nRe-exports [DEFAULT\\_KEEP\\_VERBATIM](compact/summarizer/variables/DEFAULT_KEEP_VERBATIM.md)\n\n***\n\n### DEFAULT\\_RESERVE\\_FRACTION\n\nRe-exports [DEFAULT\\_RESERVE\\_FRACTION](thrift/subtractive_pass/variables/DEFAULT_RESERVE_FRACTION.md)\n\n***\n\n### DEFAULT\\_SUMMARISE\\_AT\\_TOKENS\n\nRe-exports [DEFAULT\\_SUMMARISE\\_AT\\_TOKENS](compact/summarizer/variables/DEFAULT_SUMMARISE_AT_TOKENS.md)\n\n***\n\n### DEFAULT\\_SUMMARY\\_MESSAGE\\_ID\n\nRe-exports [DEFAULT\\_SUMMARY\\_MESSAGE\\_ID](compact/summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID.md)\n\n***\n\n### DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP\n\nRe-exports [DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP](thrift/subtractive_pass/variables/DEFAULT_THIS_TURN_RESULT_KEEP.md)\n\n***\n\n### E\\_CONTEXT\\_RESOLVER\\_MISSING\n\nRe-exports [E\\_CONTEXT\\_RESOLVER\\_MISSING](exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md)\n\n***\n\n### Estimable\n\nRe-exports [Estimable](thrift/contracts/interfaces/Estimable.md)\n\n***\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](thrift/contracts/type-aliases/EstimateTokensFn.md)\n\n***\n\n### EstimatorOptions\n\nRe-exports [EstimatorOptions](thrift/subtractive_pass/interfaces/EstimatorOptions.md)\n\n***\n\n### groupHistoryIntoTurns\n\nRe-exports [groupHistoryIntoTurns](thrift/relevance/functions/groupHistoryIntoTurns.md)\n\n***\n\n### HistoryTurn\n\nRe-exports [HistoryTurn](thrift/relevance/interfaces/HistoryTurn.md)\n\n***\n\n### IsEphemeralMessageFn\n\nRe-exports [IsEphemeralMessageFn](thrift/contracts/type-aliases/IsEphemeralMessageFn.md)\n\n***\n\n### IsSummaryMessageFn\n\nRe-exports [IsSummaryMessageFn](thrift/contracts/type-aliases/IsSummaryMessageFn.md)\n\n***\n\n### MillisTimestamp\n\nRe-exports [MillisTimestamp](thrift/contracts/interfaces/MillisTimestamp.md)\n\n***\n\n### OnCostFn\n\nRe-exports [OnCostFn](compact/contracts/type-aliases/OnCostFn.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_CURVE\n\nRe-exports [RELEVANCE\\_FLOOR\\_CURVE](thrift/relevance/variables/RELEVANCE_FLOOR_CURVE.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_MAX\n\nRe-exports [RELEVANCE\\_FLOOR\\_MAX](thrift/relevance/variables/RELEVANCE_FLOOR_MAX.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_MIN\n\nRe-exports [RELEVANCE\\_FLOOR\\_MIN](thrift/relevance/variables/RELEVANCE_FLOOR_MIN.md)\n\n***\n\n### RelevanceMessage\n\nRe-exports [RelevanceMessage](thrift/relevance/interfaces/RelevanceMessage.md)\n\n***\n\n### RelevanceToolCall\n\nRe-exports [RelevanceToolCall](thrift/relevance/interfaces/RelevanceToolCall.md)\n\n***\n\n### relevanceToQuery\n\nRe-exports [relevanceToQuery](thrift/relevance/functions/relevanceToQuery.md)\n\n***\n\n### RenderToolsFn\n\nRe-exports [RenderToolsFn](thrift/contracts/type-aliases/RenderToolsFn.md)\n\n***\n\n### resolveBudget\n\nRe-exports [resolveBudget](thrift/subtractive_pass/functions/resolveBudget.md)\n\n***\n\n### scaledRelevanceFloor\n\nRe-exports [scaledRelevanceFloor](thrift/relevance/functions/scaledRelevanceFloor.md)\n\n***\n\n### selectNaiveTurns\n\nRe-exports [selectNaiveTurns](thrift/relevance/functions/selectNaiveTurns.md)\n\n***\n\n### SelectNaiveTurnsOptions\n\nRe-exports [SelectNaiveTurnsOptions](thrift/relevance/interfaces/SelectNaiveTurnsOptions.md)\n\n***\n\n### selectRelevantTurns\n\nRe-exports [selectRelevantTurns](thrift/relevance/functions/selectRelevantTurns.md)\n\n***\n\n### SelectRelevantTurnsOptions\n\nRe-exports [SelectRelevantTurnsOptions](thrift/relevance/interfaces/SelectRelevantTurnsOptions.md)\n\n***\n\n### ShedRankFn\n\nRe-exports [ShedRankFn](thrift/contracts/type-aliases/ShedRankFn.md)\n\n***\n\n### stripPriorTurnThoughts\n\nRe-exports [stripPriorTurnThoughts](thrift/subtractive_pass/functions/stripPriorTurnThoughts.md)\n\n***\n\n### subtractToFit\n\nRe-exports [subtractToFit](thrift/subtractive_pass/functions/subtractToFit.md)\n\n***\n\n### SubtractToFitOptions\n\nRe-exports [SubtractToFitOptions](thrift/subtractive_pass/interfaces/SubtractToFitOptions.md)\n\n***\n\n### summariseTurns\n\nRe-exports [summariseTurns](compact/summarizer/functions/summariseTurns.md)\n\n***\n\n### SummariseTurnsOptions\n\nRe-exports [SummariseTurnsOptions](compact/summarizer/interfaces/SummariseTurnsOptions.md)\n\n***\n\n### SummarizeFn\n\nRe-exports [SummarizeFn](compact/contracts/type-aliases/SummarizeFn.md)\n\n***\n\n### ThriftTrace\n\nRe-exports [ThriftTrace](thrift/subtractive_pass/interfaces/ThriftTrace.md)\n\n***\n\n### WorkingImage\n\nRe-exports [WorkingImage](thrift/contracts/interfaces/WorkingImage.md)\n\n***\n\n### WorkingMemory\n\nRe-exports [WorkingMemory](thrift/contracts/interfaces/WorkingMemory.md)\n\n***\n\n### WorkingMessage\n\nRe-exports [WorkingMessage](thrift/contracts/interfaces/WorkingMessage.md)\n\n***\n\n### WorkingRetrievable\n\nRe-exports [WorkingRetrievable](thrift/contracts/interfaces/WorkingRetrievable.md)\n\n***\n\n### WorkingSet\n\nRe-exports [WorkingSet](thrift/subtractive_pass/interfaces/WorkingSet.md)\n\n***\n\n### WorkingThought\n\nRe-exports [WorkingThought](thrift/contracts/interfaces/WorkingThought.md)\n\n***\n\n### WorkingTool\n\nRe-exports [WorkingTool](thrift/contracts/interfaces/WorkingTool.md)\n\n***\n\n### WorkingToolCall\n\nRe-exports [WorkingToolCall](thrift/contracts/interfaces/WorkingToolCall.md)\n\n***\n\n### WorkingToolRegistry\n\nRe-exports [WorkingToolRegistry](thrift/contracts/interfaces/WorkingToolRegistry.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact","title":"@nhtio/adk/batteries/context/compact","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/compact.md'\ndescription: >-\n Compact — summarize-over-threshold context management. Instead of shedding old\n turns outright, pay for a model call to fold them into a running summary,\n trading a real API cost for retaining compressed signal from everything folded\n away.\n---\n\n# @nhtio/adk/batteries/context/compact\n\nCompact — summarize-over-threshold context management. Instead of shedding old turns outright, pay\nfor a model call to fold them into a running summary, trading a real API cost for retaining\ncompressed signal from everything folded away.\n\n## Remarks\n\n## The thesis\n\nWhere @nhtio/adk/batteries/context/thrift is a zero-model-call subtractive algorithm — shed\nthe lowest-signal content until the dispatch fits, never pay for compression — Compact takes the\nopposite bet: keep the most recent `keepVerbatim` turns in full, and once everything OLDER than that\ngrows past a token threshold, pay for ONE summarization call to compress it into a running summary\nmessage that stands in for all of it. On the next threshold crossing, the prior summary is folded\nBACK into the next summarization request (a rolling summary), so detail degrades gracefully across\nmany compactions rather than being recomputed from scratch or lost outright.\n\nThis is a direct extraction of the flagship reference agent's production \"compact\" baseline — the\nfaithful Claude Code auto-compaction schema, lifted verbatim (see\n[@nhtio/adk/batteries/context/compact/summarizer!COMPACTION\\_SYSTEM\\_PROMPT](summarizer/variables/COMPACTION_SYSTEM_PROMPT.md)) — evaluated\nHEAD-TO-HEAD against Token Thrift and a naive-recency baseline on a shared 94-turn stress corpus\nacross five models.\n\n## The evaluation (honest, both ways)\n\n* **The one win**: on a SINGLE reasoning-model cell, Compact beat Thrift 1.48 vs. 1.13 (3-judge\n committee scoring) — a reasoning model made better use of a paid compression step than of\n subtraction alone. Compact also led at the 128k-window control condition, 1.40 vs. Thrift's 1.27.\n* **The price**: ~80-89 summarizer calls and roughly 380k-550k EXTRA tokens over a 94-turn run,\n compared to Thrift's zero. This is the fundamental trade-off, not an implementation detail —\n Compact is a paid strategy by construction.\n* **Where it degenerates**: on a 1M-token window, the older-region threshold never triggered across\n the whole run (0 summarizer calls) — with that much headroom, Compact never fires and behaves\n identically to naive unbounded accumulation. It only earns its cost at real context pressure.\n* **Under a TIGHT budget, an honest caveat**: this extraction's message-shedding (whatever a caller\n layers on top to fit the FINAL dispatch, e.g. Thrift's own subtractive pass running downstream)\n is UNFAITHFUL to what real compaction products do under pressure — it drops verbatim recent turns\n outright rather than triggering an earlier/tighter re-summarization. Real Claude-Code-style\n compaction re-summarizes more aggressively as the wall approaches; a caller who needs that\n fidelity under tight budgets should tune `summariseAtTokens` down rather than rely on a downstream\n shed to save them.\n\nSee @nhtio/adk/batteries/context/thrift for the full Thrift-side account of this same\nevaluation, including where Thrift wins (cost, everywhere; quality, almost everywhere).\n\n## Choosing between the two\n\nReach for `compact` when: the target model is a reasoning model, the pipeline can afford a\nsummarizer budget (extra latency + tokens per compaction), and the window is small enough that the\nthreshold will actually fire. Reach for `thrift` (the always-safe default) when: cost matters, the\nwindow is large enough that compaction would degenerate anyway, or the model doesn't specifically\nbenefit from compressed-prose continuity over raw subtraction. The two are COMPOSABLE, not\nmutually exclusive — Thrift ships an `isSummaryMessage` predicate (default `id === '__compact-summary'`)\nthat recognizes and protects Compact's synthetic summary message from being shed like an ordinary\nold turn, so a pipeline can run `compact` upstream (turn-level assembly) and `thrift` downstream\n(final budget fit) together. See\n[@nhtio/adk/batteries/context/compact/summarizer!DEFAULT\\_SUMMARY\\_MESSAGE\\_ID](summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID.md) for that\ncontract's exact terms.\n\n## Zero-coupling, one unavoidable seam\n\nEvery structural type here is a local, duck-typed declaration (zero core imports — see\n@nhtio/adk/batteries/context/compact/contracts) except for the turn/message shapes, which\nare reused directly from @nhtio/adk/batteries/context/thrift/relevance via a relative,\nbattery-internal import (compact operates on the SAME upstream turn shape thrift's relevance\nselection produces — no need to redeclare it). The one capability this battery truly cannot bundle\nis the model call itself: [@nhtio/adk/batteries/context/compact/contracts!SummarizeFn](contracts/type-aliases/SummarizeFn.md) is an\ninjected function, never a bundled transport — see its TSDoc for the canonical ADK recipe (a\n`DispatchRunner.dispatch` call with an all-noop `RawTurnContext`).\n\n## Usage sketch\n\n```ts\nimport {\n assembleCompactedTurns,\n type SummarizeFn,\n} from \"@nhtio/adk/batteries/context/compact\";\nimport { groupHistoryIntoTurns } from \"@nhtio/adk/batteries/context/thrift\";\nimport { Tokenizable } from \"@nhtio/adk\";\n\n// A stub SummarizeFn — see the contract's TSDoc for the real DispatchRunner recipe.\nconst summarize: SummarizeFn = async ({ system, text }) => {\n const completion = await myLlmCall({ system, prompt: text });\n return completion.trim();\n};\n\nconst turns = groupHistoryIntoTurns(myMessages, myToolCalls);\nlet priorState: { summary: string | null; coveredOlder: number } | undefined;\n\nconst result = await assembleCompactedTurns(turns, {\n summarize,\n estimateTokens: (value, encoding, ctx) =>\n Tokenizable.estimateTokens(value, encoding, ctx),\n priorState,\n onCost: (event) => trackCompactionCost(event), // replaces globalThis.__agentCompactionCost\n});\n\npriorState = { summary: result.summary, coveredOlder: result.coveredOlder }; // persist for next turn\n// result.turns: [syntheticSummaryTurn?, ...recentVerbatimTurns] — feed downstream (e.g. into\n// thrift's subtractToFit) exactly like any other grouped-turn history.\n```\n\n## References\n\n### assembleCompactedTurns\n\nRe-exports [assembleCompactedTurns](summarizer/functions/assembleCompactedTurns.md)\n\n***\n\n### AssembleCompactedTurnsOptions\n\nRe-exports [AssembleCompactedTurnsOptions](summarizer/interfaces/AssembleCompactedTurnsOptions.md)\n\n***\n\n### AssembleCompactedTurnsResult\n\nRe-exports [AssembleCompactedTurnsResult](summarizer/interfaces/AssembleCompactedTurnsResult.md)\n\n***\n\n### COMPACTION\\_SYSTEM\\_PROMPT\n\nRe-exports [COMPACTION\\_SYSTEM\\_PROMPT](summarizer/variables/COMPACTION_SYSTEM_PROMPT.md)\n\n***\n\n### CompactionCostEvent\n\nRe-exports [CompactionCostEvent](contracts/interfaces/CompactionCostEvent.md)\n\n***\n\n### DEFAULT\\_KEEP\\_VERBATIM\n\nRe-exports [DEFAULT\\_KEEP\\_VERBATIM](summarizer/variables/DEFAULT_KEEP_VERBATIM.md)\n\n***\n\n### DEFAULT\\_SUMMARISE\\_AT\\_TOKENS\n\nRe-exports [DEFAULT\\_SUMMARISE\\_AT\\_TOKENS](summarizer/variables/DEFAULT_SUMMARISE_AT_TOKENS.md)\n\n***\n\n### DEFAULT\\_SUMMARY\\_MESSAGE\\_ID\n\nRe-exports [DEFAULT\\_SUMMARY\\_MESSAGE\\_ID](summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID.md)\n\n***\n\n### E\\_CONTEXT\\_RESOLVER\\_MISSING\n\nRe-exports [E\\_CONTEXT\\_RESOLVER\\_MISSING](../exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md)\n\n***\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](../thrift/contracts/type-aliases/EstimateTokensFn.md)\n\n***\n\n### HistoryTurn\n\nRe-exports [HistoryTurn](../thrift/relevance/interfaces/HistoryTurn.md)\n\n***\n\n### OnCostFn\n\nRe-exports [OnCostFn](contracts/type-aliases/OnCostFn.md)\n\n***\n\n### RelevanceMessage\n\nRe-exports [RelevanceMessage](../thrift/relevance/interfaces/RelevanceMessage.md)\n\n***\n\n### RelevanceToolCall\n\nRe-exports [RelevanceToolCall](../thrift/relevance/interfaces/RelevanceToolCall.md)\n\n***\n\n### summariseTurns\n\nRe-exports [summariseTurns](summarizer/functions/summariseTurns.md)\n\n***\n\n### SummariseTurnsOptions\n\nRe-exports [SummariseTurnsOptions](summarizer/interfaces/SummariseTurnsOptions.md)\n\n***\n\n### SummarizeFn\n\nRe-exports [SummarizeFn](contracts/type-aliases/SummarizeFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts","title":"@nhtio/adk/batteries/context/compact/contracts","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/contracts.md'\ndescription: >-\n Structural contracts for the Compact (summarize-over-threshold)\n context-management battery — the seams it invokes via injected functions, and\n the one cost-observability shape it hands back.\n---\n\n# @nhtio/adk/batteries/context/compact/contracts\n\nStructural contracts for the Compact (summarize-over-threshold) context-management battery — the\nseams it invokes via injected functions, and the one cost-observability shape it hands back.\n\n## Remarks\n\nThis module has **zero imports** — not even a type-only import from `@nhtio/adk` core. Same\ndiscipline as @nhtio/adk/batteries/context/thrift/contracts: every capability this battery\ncannot perform itself is an INJECTED function, and every shape it reads or writes is a local\nstructural declaration.\n\nCompact needs exactly TWO capabilities it cannot bundle itself:\n\n1. **Summarization** ([SummarizeFn](type-aliases/SummarizeFn.md)) — an actual model call. Unlike Token Thrift, which is a\n zero-model-call algorithm end-to-end, Compact's entire thesis is PAYING for a model call to\n compress old turns into a running summary — so this seam is unavoidable, and the battery never\n pretends otherwise.\n2. **Token estimation** ([EstimateTokensFn](../../thrift/contracts/type-aliases/EstimateTokensFn.md), re-exported from\n @nhtio/adk/batteries/context/thrift/contracts — same signature, same rationale: no\n bundled tokenizer, ever).\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [CompactionCostEvent](interfaces/CompactionCostEvent.md) | One summarization call's estimated token cost — reported via [OnCostFn](type-aliases/OnCostFn.md) so a caller can total up the real overhead this battery pays (the cost profile a `thrift`-only pipeline never incurs). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OnCostFn](type-aliases/OnCostFn.md) | Optional per-summarization cost callback — fired once per [SummarizeFn](type-aliases/SummarizeFn.md) call that actually runs, replacing the production flagship agent's `globalThis.__agentCompactionCost` ring buffer with an injectable, testable seam that leaves no global state behind. |\n| [SummarizeFn](type-aliases/SummarizeFn.md) | THE model-call seam this battery cannot perform itself: given a system prompt and a body of text to summarize, return the summary text. |\n\n## References\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](../../thrift/contracts/type-aliases/EstimateTokensFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/interfaces/CompactionCostEvent","title":"Interface: CompactionCostEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/interfaces/CompactionCostEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/interfaces/CompactionCostEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/contracts/interfaces/CompactionCostEvent.md\ndescription: >-\n One summarization call's estimated token cost — reported via [`OnCostFn`](https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/OnCostFn)\n so a caller can total up the real overhead this battery pays (the cost profile\n a `thrift`-only pipeline never incurs).\n---\n\n# Interface: CompactionCostEvent\n\nDefined in: [src/batteries/context/compact/contracts.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/contracts.ts#L94)\n\nOne summarization call's estimated token cost — reported via [OnCostFn](../type-aliases/OnCostFn.md) so a caller can total\nup the real overhead this battery pays (the cost profile a `thrift`-only pipeline never incurs).\n\n## Remarks\n\n`inTok`/`outTok` are ESTIMATES, not metered usage: when the injected [SummarizeFn](../type-aliases/SummarizeFn.md)'s transport\ndoesn't report real token usage back (many don't — a bare `Promise` return carries no usage\nenvelope), the battery has no other way to know what the call cost. It measures what it CAN measure\n— the exact text it sent (`system + text`) and the exact text it got back (the summary) — via the\nsame injected [EstimateTokensFn](../../../thrift/contracts/type-aliases/EstimateTokensFn.md) the caller already supplies for its own token accounting, so\nthese numbers are at least self-consistent with whatever budget arithmetic the caller runs\nelsewhere. A caller whose `SummarizeFn` DOES have access to real usage counts can ignore this\nestimate and total its own numbers from inside the function instead.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `calls` | `number` | How many summarization calls this event represents — always `1` per [OnCostFn](../type-aliases/OnCostFn.md) firing (one call, one event); a caller totals `calls` across events to get the run's summarizer call count. | [src/batteries/context/compact/contracts.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/contracts.ts#L97) |\n| `inTok` | `number` | Estimated input token cost: `estimateTokens(system + text, encoding)` for the exact request sent to [SummarizeFn](../type-aliases/SummarizeFn.md) this call (system prompt plus the history/prior-summary text). | [src/batteries/context/compact/contracts.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/contracts.ts#L100) |\n| `outTok` | `number` | Estimated output token cost: `estimateTokens(summary, encoding)` for the text [SummarizeFn](../type-aliases/SummarizeFn.md) returned. | [src/batteries/context/compact/contracts.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/contracts.ts#L103) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/OnCostFn","title":"Type Alias: OnCostFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/OnCostFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/OnCostFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/OnCostFn.md\ndescription: >-\n Optional per-summarization cost callback — fired once per [`SummarizeFn`](https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/SummarizeFn)\n call that actually runs, replacing the production flagship agent's\n `globalThis.__agentCompactionCost` ring buffer with an injectable, testable\n seam that leaves no global state behind.\n---\n\n# Type Alias: OnCostFn\n\n```ts\ntype OnCostFn = (event: CompactionCostEvent) => void;\n```\n\nDefined in: [src/batteries/context/compact/contracts.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/contracts.ts#L121)\n\nOptional per-summarization cost callback — fired once per [SummarizeFn](SummarizeFn.md) call that actually\nruns, replacing the production flagship agent's `globalThis.__agentCompactionCost` ring buffer with\nan injectable, testable seam that leaves no global state behind.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------- | ---------------------------------------------------------------- |\n| `event` | [`CompactionCostEvent`](../interfaces/CompactionCostEvent.md) | See [CompactionCostEvent](../interfaces/CompactionCostEvent.md). |\n\n## Returns\n\n`void`\n\n## Remarks\n\nNever invoked when the threshold hasn't been crossed (no summarization call made — see\n[@nhtio/adk/batteries/context/compact/summarizer!assembleCompactedTurns](../../summarizer/functions/assembleCompactedTurns.md)'s below-threshold\npass-through path). A caller who wants a running total across a whole session's worth of dispatches\naccumulates across `onCost` firings themselves; this battery holds no cross-call state of its own\nbeyond what a single `assembleCompactedTurns` invocation's caller threads through (the rolling prior\nsummary is passed in and returned explicitly, never stashed on `globalThis`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/SummarizeFn","title":"Type Alias: SummarizeFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/SummarizeFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/SummarizeFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/contracts/type-aliases/SummarizeFn.md\ndescription: >-\n THE model-call seam this battery cannot perform itself: given a system prompt\n and a body of text to summarize, return the summary text.\n---\n\n# Type Alias: SummarizeFn\n\n```ts\ntype SummarizeFn = (req: { system: string; text: string }) => Promise;\n```\n\nDefined in: [src/batteries/context/compact/contracts.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/contracts.ts#L78)\n\nTHE model-call seam this battery cannot perform itself: given a system prompt and a body of text to\nsummarize, return the summary text.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `req` | { `system`: `string`; `text`: `string`; } | `system`: the compaction instructions (see [@nhtio/adk/batteries/context/compact/summarizer!COMPACTION\\_SYSTEM\\_PROMPT](../../summarizer/variables/COMPACTION_SYSTEM_PROMPT.md) for the shipped default); `text`: the body of older conversation (and, on a rolling re-summarize, the prior summary folded in — see [@nhtio/adk/batteries/context/compact/summarizer!summariseTurns](../../summarizer/functions/summariseTurns.md)) to compress. |\n| `req.system` | `string` | - |\n| `req.text` | `string` | - |\n\n## Returns\n\n`Promise`<`string`>\n\nThe summary text, awaited. A rejected promise propagates to the caller of\n`summariseTurns`/`assembleCompactedTurns` uncaught — this battery does not swallow summarizer\nfailures; a caller wanting graceful degradation (e.g. \"fall back to the prior summary\") implements\nthat inside their own `SummarizeFn`, exactly as the production flagship agent's own summarizer did.\n\n## Remarks\n\nThe battery never names `DispatchRunner`, an adapter, or an executor — it has no idea how the\ncaller talks to a model, and it must not. The canonical ADK recipe for building one (the recipe the\nproduction flagship agent this battery was extracted from actually uses, and the one the docs page\nfor this battery walks through in full) is:\n\n```ts\nconst summarize: SummarizeFn = async ({ system, text }) => {\n let out = \"\";\n const noop = async (): Promise => undefined;\n const noopArr = async (): Promise => [];\n await DispatchRunner.dispatch({\n raw: {\n systemPrompt: new Tokenizable(system),\n standingInstructions: [],\n messages: [\n new Message({\n id: `__compact-${Date.now()}`,\n role: \"user\",\n content: text,\n createdAt: new Date().toISOString(),\n updatedAt: new Date().toISOString(),\n }),\n ],\n // Every other RawTurnContext capability is a noop — this dispatch never reads or writes any\n // OTHER persisted state, it only wants the model's completion text.\n fetchMemories: noopArr,\n fetchRetrievables: noopArr,\n fetchMessages: noopArr,\n fetchThoughts: noopArr,\n fetchToolCalls: noopArr,\n fetchTools: noopArr,\n refreshStandingInstructions: noopArr,\n storeStandingInstruction: noop,\n mutateStandingInstruction: noop,\n deleteStandingInstruction: noop,\n storeMemory: noop,\n mutateMemory: noop,\n deleteMemory: noop,\n storeRetrievable: noop,\n mutateRetrievable: noop,\n deleteRetrievable: noop,\n storeMessage: async (_c, v) => {\n out += v.content?.toString?.() ?? \"\";\n },\n mutateMessage: noop,\n deleteMessage: noop,\n storeThought: noop,\n mutateThought: noop,\n deleteThought: noop,\n storeToolCall: noop,\n mutateToolCall: noop,\n deleteToolCall: noop,\n storeMediaBytes: noop,\n storeRetrievableBytes: noop,\n } as never,\n executor: await adapter.executor({\n maxTokens: 1200,\n toolCallParser: \"none\",\n stream: false,\n autoAck: true,\n enableThinking: false,\n }),\n });\n return out.trim();\n};\n```\n\nA caller with a different transport (a direct HTTP call to an LLM API, a queue-backed worker, a\nmocked test double) supplies whatever function satisfies this signature — the battery only ever\nawaits the returned string.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer","title":"@nhtio/adk/batteries/context/compact/summarizer","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer.md'\ndescription: >-\n The Compact summarizer and history assembler — the whole Compact thesis, in\n code.\n---\n\n# @nhtio/adk/batteries/context/compact/summarizer\n\nThe Compact summarizer and history assembler — the whole Compact thesis, in code.\n\n## Remarks\n\nThis is a direct extraction of the flagship reference agent's `#summariseTurns` /\n`#assembleCompactedTurns` head-to-head baseline (the \"compact\" arm evaluated against Token Thrift —\nsee the battery barrel's TSDoc for the honest, both-ways evaluation results), retargeted at the\nlocal structural contracts in @nhtio/adk/batteries/context/compact/contracts and the shared\n[@nhtio/adk/batteries/context/thrift/relevance!HistoryTurn](../../thrift/relevance/interfaces/HistoryTurn.md) shape so it couples to nothing in\n`@nhtio/adk` core — the one true dependency this battery cannot avoid (an actual model call to\nsummarize) is an injected [SummarizeFn](../contracts/type-aliases/SummarizeFn.md), never a bundled transport.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [AssembleCompactedTurnsOptions](interfaces/AssembleCompactedTurnsOptions.md) | Options for [assembleCompactedTurns](functions/assembleCompactedTurns.md). |\n| [AssembleCompactedTurnsResult](interfaces/AssembleCompactedTurnsResult.md) | [assembleCompactedTurns](functions/assembleCompactedTurns.md)'s return value: the compacted turns PLUS the rolling state a caller must persist and pass back in as `options.priorState` on the next call (this battery is stateless between calls by design — no private fields, no `globalThis`). |\n| [SummariseTurnsOptions](interfaces/SummariseTurnsOptions.md) | Options for [summariseTurns](functions/summariseTurns.md). |\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [COMPACTION\\_SYSTEM\\_PROMPT](variables/COMPACTION_SYSTEM_PROMPT.md) | The FAITHFUL Claude Code compaction schema — the 9 sections extracted VERBATIM from the flagship reference agent's own real auto-compactions (~4700-token structured summaries observed across 28 compactions in that agent's development session). Using the real prompt (not an invented one) is what makes this battery's evaluation honest: the compact strategy loses exactly the detail Claude Code's own compaction loses, no more and no less. |\n| [DEFAULT\\_KEEP\\_VERBATIM](variables/DEFAULT_KEEP_VERBATIM.md) | How many of the MOST RECENT turns stay verbatim, never folded into the running summary — coreference (\"it\", \"that file\") needs the immediately preceding turns present no matter what. |\n| [DEFAULT\\_SUMMARISE\\_AT\\_TOKENS](variables/DEFAULT_SUMMARISE_AT_TOKENS.md) | The token threshold, measured over the OLDER (non-verbatim) region's combined text, past which a (re)summarization call fires. |\n| [DEFAULT\\_SUMMARY\\_MESSAGE\\_ID](variables/DEFAULT_SUMMARY_MESSAGE_ID.md) | The default id assigned to the synthetic summary message [assembleCompactedTurns](functions/assembleCompactedTurns.md) emits. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [assembleCompactedTurns](functions/assembleCompactedTurns.md) | The Compact assembly step: keep the newest `keepVerbatim` turns in full; fold everything OLDER into a running structured summary, (re)generated via [summariseTurns](functions/summariseTurns.md) when the older region grows past `summariseAtTokens` AND new turns have aged into it since the last summarization. Returns `[syntheticSummaryTurn, ...recentVerbatimTurns]`. |\n| [summariseTurns](functions/summariseTurns.md) | Run ONE summarization call: fold `priorSummary` (if any) and `historyText` into the request text exactly as the flagship reference agent's `#summariseTurns` did, dispatch it through the injected [SummarizeFn](../contracts/type-aliases/SummarizeFn.md), and report the estimated token cost via `options.onCost`. |\n\n## References\n\n### CompactionCostEvent\n\nRe-exports [CompactionCostEvent](../contracts/interfaces/CompactionCostEvent.md)\n\n***\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](../../thrift/contracts/type-aliases/EstimateTokensFn.md)\n\n***\n\n### HistoryTurn\n\nRe-exports [HistoryTurn](../../thrift/relevance/interfaces/HistoryTurn.md)\n\n***\n\n### OnCostFn\n\nRe-exports [OnCostFn](../contracts/type-aliases/OnCostFn.md)\n\n***\n\n### RelevanceMessage\n\nRe-exports [RelevanceMessage](../../thrift/relevance/interfaces/RelevanceMessage.md)\n\n***\n\n### RelevanceToolCall\n\nRe-exports [RelevanceToolCall](../../thrift/relevance/interfaces/RelevanceToolCall.md)\n\n***\n\n### SummarizeFn\n\nRe-exports [SummarizeFn](../contracts/type-aliases/SummarizeFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/functions/assembleCompactedTurns","title":"Function: assembleCompactedTurns()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/functions/assembleCompactedTurns.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/functions/assembleCompactedTurns","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/functions/assembleCompactedTurns.md\n---\n\n# Function: assembleCompactedTurns()\n\n```ts\nfunction assembleCompactedTurns(\n turns: readonly HistoryTurn[],\n options: AssembleCompactedTurnsOptions,\n): Promise>;\n```\n\nDefined in: [src/batteries/context/compact/summarizer.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L260)\n\nThe Compact assembly step: keep the newest `keepVerbatim` turns in full; fold everything OLDER into\na running structured summary, (re)generated via [summariseTurns](summariseTurns.md) when the older region grows\npast `summariseAtTokens` AND new turns have aged into it since the last summarization. Returns\n`[syntheticSummaryTurn, ...recentVerbatimTurns]`.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| `M` *extends* [`RelevanceMessage`](../../../thrift/relevance/interfaces/RelevanceMessage.md) | [`RelevanceMessage`](../../../thrift/relevance/interfaces/RelevanceMessage.md) |\n| `TC` *extends* [`RelevanceToolCall`](../../../thrift/relevance/interfaces/RelevanceToolCall.md) | [`RelevanceToolCall`](../../../thrift/relevance/interfaces/RelevanceToolCall.md) |\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `turns` | readonly [`HistoryTurn`](../../../thrift/relevance/interfaces/HistoryTurn.md)<`M`, `TC`>\\[] | The full grouped history, chronological (e.g. from [@nhtio/adk/batteries/context/thrift/relevance!groupHistoryIntoTurns](../../../thrift/relevance/functions/groupHistoryIntoTurns.md)). |\n| `options` | [`AssembleCompactedTurnsOptions`](../interfaces/AssembleCompactedTurnsOptions.md) | See [AssembleCompactedTurnsOptions](../interfaces/AssembleCompactedTurnsOptions.md). |\n\n## Returns\n\n`Promise`<[`AssembleCompactedTurnsResult`](../interfaces/AssembleCompactedTurnsResult.md)<`M`, `TC`>>\n\nSee [AssembleCompactedTurnsResult](../interfaces/AssembleCompactedTurnsResult.md).\n\n## Remarks\n\n**Faithfulness to the original** (`#assembleCompactedTurns`): the threshold/keep-verbatim/rolling\nlogic is a line-for-line port — same re-summarize condition (`older.length > coveredOlder &&\n(summary === null || olderTokens > summariseAtTokens)`), same synthetic turn shape (`qa` = the\nsummary text, `createdAt` = the epoch-zero sentinel that sorts before every real turn, one message\nwith `id: summaryMessageId`, content prefixed `[Earlier conversation, compacted summary]`, no tool\ncalls), same \"nothing to compact yet\" early return when there's no older region at all. The ONE\ndeviation: state that lived on private class fields (`#compactSummary`, `#compactCoveredOlder`) in\nthe original is now explicit input/output (`options.priorState` in, `{ summary, coveredOlder }` out)\n— a pure battery function cannot own mutable instance state, so the caller threads it through. This\nis a mechanical decoupling change, not a behavioral one: a caller who persists and re-supplies\n`priorState` exactly as returned reproduces the original's stateful behavior turn-for-turn.\n\nUnlike Token Thrift, this function CANNOT resurface the exact older detail a later turn needs — it\nonly has the summary's blurred prose. See the module barrel for the honest, both-ways evaluation of\nthat fidelity trade-off against thrift's subtractive approach.\n\n## Throws\n\n[@nhtio/adk/batteries/context/exceptions!E\\_CONTEXT\\_RESOLVER\\_MISSING](../../../exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md) When\n`options.summarize` or `options.estimateTokens` is not a function.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/functions/summariseTurns","title":"Function: summariseTurns()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/functions/summariseTurns.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/functions/summariseTurns","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/functions/summariseTurns.md\n---\n\n# Function: summariseTurns()\n\n```ts\nfunction summariseTurns(\n historyText: string,\n priorSummary: string | null,\n options: SummariseTurnsOptions,\n): Promise;\n```\n\nDefined in: [src/batteries/context/compact/summarizer.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L142)\n\nRun ONE summarization call: fold `priorSummary` (if any) and `historyText` into the request text\nexactly as the flagship reference agent's `#summariseTurns` did, dispatch it through the injected\n[SummarizeFn](../../contracts/type-aliases/SummarizeFn.md), and report the estimated token cost via `options.onCost`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| -------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `historyText` | `string` | The older-turn text to summarize (already assembled by the caller, e.g. from [assembleCompactedTurns](assembleCompactedTurns.md)'s older-turns join). |\n| `priorSummary` | `string` | `null` | The prior rolling summary, if one exists, folded into the request text ahead of `historyText` under a `PREVIOUS SUMMARY (extend/merge, do not lose facts)` header — `null` on the first summarization of a run. |\n| `options` | [`SummariseTurnsOptions`](../interfaces/SummariseTurnsOptions.md) | See [SummariseTurnsOptions](../interfaces/SummariseTurnsOptions.md). |\n\n## Returns\n\n`Promise`<`string`>\n\nThe new summary text, trimmed. Falls back to `priorSummary ?? ''` only when\n[SummarizeFn](../../contracts/type-aliases/SummarizeFn.md) resolves to an empty/whitespace-only string (never on rejection — see above).\n\n## Remarks\n\n**Faithfulness to the original**: this is a line-for-line port of `#summariseTurns`'s request\nassembly and prompt shape, with exactly one deliberate behavioral change: the original SWALLOWED a\nfailed summarizer call and degraded to `priorSummary ?? ''` (never letting a summarizer error\npropagate, since it ran inline in a chat turn that had to keep going); this battery instead lets a\nrejected [SummarizeFn](../../contracts/type-aliases/SummarizeFn.md) promise propagate UNCAUGHT (see [SummarizeFn](../../contracts/type-aliases/SummarizeFn.md)'s own TSDoc) — a\nbattery has no chat-turn context to know whether \"degrade silently\" is the right failure mode for\na given caller, so it surfaces the error and lets the caller decide (their own `SummarizeFn` can\nimplement the original's degrade-on-failure behavior internally if desired, by catching there\ninstead). The original's GPU-OOM special-case rethrow is likewise the caller's concern now — it\nlived inside the original's own adapter-specific `SummarizeFn` equivalent, not in the algorithm.\n\n## Throws\n\n[@nhtio/adk/batteries/context/exceptions!E\\_CONTEXT\\_RESOLVER\\_MISSING](../../../exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md) When\n`options.summarize` or `options.estimateTokens` is not a function.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsOptions","title":"Interface: AssembleCompactedTurnsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsOptions.md\ndescription: 'Options for [`assembleCompactedTurns`](https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/functions/assembleCompactedTurns).'\n---\n\n# Interface: AssembleCompactedTurnsOptions\n\nDefined in: [src/batteries/context/compact/summarizer.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L176)\n\nOptions for [assembleCompactedTurns](../functions/assembleCompactedTurns.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `encoding?` | `string` | The encoding to measure under. Default: `'cl100k_base'`. | [src/batteries/context/compact/summarizer.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L183) |\n| `estimateTokens` | [`EstimateTokensFn`](../../../thrift/contracts/type-aliases/EstimateTokensFn.md) | REQUIRED. Measures token costs (the older-region threshold check, and [OnCostFn](../../contracts/type-aliases/OnCostFn.md) reporting). | [src/batteries/context/compact/summarizer.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L181) |\n| `keepVerbatim?` | `number` | How many of the most recent turns stay verbatim. Default: [DEFAULT\\_KEEP\\_VERBATIM](../variables/DEFAULT_KEEP_VERBATIM.md). | [src/batteries/context/compact/summarizer.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L185) |\n| `onCost?` | [`OnCostFn`](../../contracts/type-aliases/OnCostFn.md) | Fired once per summarization call that actually runs (never on the below-threshold pass-through path). See [OnCostFn](../../contracts/type-aliases/OnCostFn.md). | [src/batteries/context/compact/summarizer.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L198) |\n| `priorState?` | { `coveredOlder`: `number`; `summary`: `string` | `null`; } | The caller's own bookkeeping of prior state, threaded through explicitly (replacing the original `#compactSummary`/`#compactCoveredOlder` private fields on the flagship agent's class instance): the rolling summary text produced by a previous call, and how many older-region turns that summary already covers. Omit on the FIRST call for a fresh run (equivalent to the originals' `null`/`0` initial values). This battery holds no state of its own between calls — see [AssembleCompactedTurnsResult](AssembleCompactedTurnsResult.md) for what to persist and pass back in on the next call. | [src/batteries/context/compact/summarizer.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L207) |\n| `priorState.coveredOlder` | `number` | - | [src/batteries/context/compact/summarizer.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L207) |\n| `priorState.summary` | `string` | `null` | - | [src/batteries/context/compact/summarizer.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L207) |\n| `summariseAtTokens?` | `number` | The older-region token threshold past which a (re)summarization fires. Default: [DEFAULT\\_SUMMARISE\\_AT\\_TOKENS](../variables/DEFAULT_SUMMARISE_AT_TOKENS.md). | [src/batteries/context/compact/summarizer.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L188) |\n| `summarize` | [`SummarizeFn`](../../contracts/type-aliases/SummarizeFn.md) | REQUIRED. The model-call seam — see [SummarizeFn](../../contracts/type-aliases/SummarizeFn.md). | [src/batteries/context/compact/summarizer.ts:178](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L178) |\n| `summaryMessageId?` | `string` | The id assigned to the synthetic summary message/turn. Default: [DEFAULT\\_SUMMARY\\_MESSAGE\\_ID](../variables/DEFAULT_SUMMARY_MESSAGE_ID.md) — see that constant's TSDoc for the cross-battery contract with Token Thrift's `isSummaryMessage` predicate before changing this. | [src/batteries/context/compact/summarizer.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L195) |\n| `systemPrompt?` | `string` | The compaction instructions passed through to [summariseTurns](../functions/summariseTurns.md). Default: [COMPACTION\\_SYSTEM\\_PROMPT](../variables/COMPACTION_SYSTEM_PROMPT.md). | [src/batteries/context/compact/summarizer.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L191) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsResult","title":"Interface: AssembleCompactedTurnsResult\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/AssembleCompactedTurnsResult.md\ndescription: >-\n [`assembleCompactedTurns`](https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/functions/assembleCompactedTurns)'s return value: the compacted turns PLUS the\n rolling state a caller must persist and pass back in as `options.priorState`\n on the next call (this battery is stateless between calls by design — no\n private fields, no `globalThis`).\n---\n\n# Interface: AssembleCompactedTurnsResult\\\n\nDefined in: [src/batteries/context/compact/summarizer.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L215)\n\n[assembleCompactedTurns](../functions/assembleCompactedTurns.md)'s return value: the compacted turns PLUS the rolling state a caller\nmust persist and pass back in as `options.priorState` on the next call (this battery is stateless\nbetween calls by design — no private fields, no `globalThis`).\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| `M` *extends* [`RelevanceMessage`](../../../thrift/relevance/interfaces/RelevanceMessage.md) | [`RelevanceMessage`](../../../thrift/relevance/interfaces/RelevanceMessage.md) |\n| `TC` *extends* [`RelevanceToolCall`](../../../thrift/relevance/interfaces/RelevanceToolCall.md) | [`RelevanceToolCall`](../../../thrift/relevance/interfaces/RelevanceToolCall.md) |\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `coveredOlder` | `number` | How many older-region turns `summary` covers — persist and pass back in as `priorState.coveredOlder` next call. | [src/batteries/context/compact/summarizer.ts:227](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L227) |\n| `summary` | `string` | `null` | The rolling summary text after this call (unchanged from `priorState.summary` when the threshold didn't fire this call) — persist and pass back in as `priorState.summary` next call. | [src/batteries/context/compact/summarizer.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L224) |\n| `turns` | [`HistoryTurn`](../../../thrift/relevance/interfaces/HistoryTurn.md)<`M`, `TC`>\\[] | `[syntheticSummaryTurn, ...verbatimRecentTurns]` when older turns exist and have been summarized at least once; otherwise just the verbatim turns unchanged (nothing to compact yet). | [src/batteries/context/compact/summarizer.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L221) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/SummariseTurnsOptions","title":"Interface: SummariseTurnsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/SummariseTurnsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/SummariseTurnsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/interfaces/SummariseTurnsOptions.md\ndescription: 'Options for [`summariseTurns`](https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/functions/summariseTurns).'\n---\n\n# Interface: SummariseTurnsOptions\n\nDefined in: [src/batteries/context/compact/summarizer.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L97)\n\nOptions for [summariseTurns](../functions/summariseTurns.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `encoding?` | `string` | The encoding to measure cost under. Default: `'cl100k_base'`. | [src/batteries/context/compact/summarizer.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L105) |\n| `estimateTokens` | [`EstimateTokensFn`](../../../thrift/contracts/type-aliases/EstimateTokensFn.md) | REQUIRED. Measures the exact request/response text's token cost for [OnCostFn](../../contracts/type-aliases/OnCostFn.md) reporting. There is no default; this battery ships with no bundled tokenizer. | [src/batteries/context/compact/summarizer.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L103) |\n| `onCost?` | [`OnCostFn`](../../contracts/type-aliases/OnCostFn.md) | Fired once, after a successful summarization call, with the estimated request/response token cost. See [OnCostFn](../../contracts/type-aliases/OnCostFn.md). | [src/batteries/context/compact/summarizer.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L111) |\n| `summarize` | [`SummarizeFn`](../../contracts/type-aliases/SummarizeFn.md) | REQUIRED. The model-call seam — see [SummarizeFn](../../contracts/type-aliases/SummarizeFn.md). There is no default; this battery ships with no bundled transport. | [src/batteries/context/compact/summarizer.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L100) |\n| `systemPrompt?` | `string` | The compaction instructions sent as `system` to [SummarizeFn](../../contracts/type-aliases/SummarizeFn.md). Default: [COMPACTION\\_SYSTEM\\_PROMPT](../variables/COMPACTION_SYSTEM_PROMPT.md). | [src/batteries/context/compact/summarizer.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L108) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/COMPACTION_SYSTEM_PROMPT","title":"Variable: COMPACTION\\_SYSTEM\\_PROMPT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/COMPACTION_SYSTEM_PROMPT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/COMPACTION_SYSTEM_PROMPT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/variables/COMPACTION_SYSTEM_PROMPT.md\ndescription: >-\n The FAITHFUL Claude Code compaction schema — the 9 sections extracted VERBATIM\n from the flagship reference agent's own real auto-compactions (~4700-token\n structured summaries observed across 28 compactions in that agent's\n development session). Using the real prompt (not an invented one) is what\n makes this battery's evaluation honest: the compact strategy loses exactly the\n detail Claude Code's own compaction loses, no more and no less.\n---\n\n# Variable: COMPACTION\\_SYSTEM\\_PROMPT\n\n```ts\nconst COMPACTION_SYSTEM_PROMPT: string;\n```\n\nDefined in: [src/batteries/context/compact/summarizer.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L70)\n\nThe FAITHFUL Claude Code compaction schema — the 9 sections extracted VERBATIM from the flagship\nreference agent's own real auto-compactions (~4700-token structured summaries observed across 28\ncompactions in that agent's development session). Using the real prompt (not an invented one) is\nwhat makes this battery's evaluation honest: the compact strategy loses exactly the detail Claude\nCode's own compaction loses, no more and no less.\n\n## Remarks\n\nThe 9 sections: (1) Primary Request and Intent, (2) Key Technical Concepts, (3) Files and Code\nSections, (4) Errors and Fixes, (5) Problem Solving, (6) All User Messages, (7) Pending Tasks,\n(8) Current Work, (9) Next Step. Callers may supply their own prompt via the `systemPrompt` option\non [assembleCompactedTurns](../functions/assembleCompactedTurns.md) (and [summariseTurns](../functions/summariseTurns.md) directly) — this default is a\ncalibrated starting point, not a hard requirement.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_KEEP_VERBATIM","title":"Variable: DEFAULT\\_KEEP\\_VERBATIM","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_KEEP_VERBATIM.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_KEEP_VERBATIM","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_KEEP_VERBATIM.md\ndescription: >-\n How many of the MOST RECENT turns stay verbatim, never folded into the running\n summary — coreference (\"it\", \"that file\") needs the immediately preceding\n turns present no matter what.\n---\n\n# Variable: DEFAULT\\_KEEP\\_VERBATIM\n\n```ts\nconst DEFAULT_KEEP_VERBATIM: 2 = 2;\n```\n\nDefined in: [src/batteries/context/compact/summarizer.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L30)\n\nHow many of the MOST RECENT turns stay verbatim, never folded into the running summary —\ncoreference (\"it\", \"that file\") needs the immediately preceding turns present no matter what.\n\n## Remarks\n\nThe flagship reference agent's own calibrated value (`COMPACT_KEEP_VERBATIM`), lifted unchanged.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARISE_AT_TOKENS","title":"Variable: DEFAULT\\_SUMMARISE\\_AT\\_TOKENS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARISE_AT_TOKENS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARISE_AT_TOKENS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARISE_AT_TOKENS.md\ndescription: >-\n The token threshold, measured over the OLDER (non-verbatim) region's combined\n text, past which a (re)summarization call fires.\n---\n\n# Variable: DEFAULT\\_SUMMARISE\\_AT\\_TOKENS\n\n```ts\nconst DEFAULT_SUMMARISE_AT_TOKENS: 2500 = 2500;\n```\n\nDefined in: [src/batteries/context/compact/summarizer.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L41)\n\nThe token threshold, measured over the OLDER (non-verbatim) region's combined text, past which a\n(re)summarization call fires.\n\n## Remarks\n\nThe flagship reference agent's own calibrated value (`COMPACT_SUMMARISE_AT_TOKENS`), lifted\nunchanged — modeled on Claude Code auto-compacting as it approaches the context limit (there, a\nfraction of an 8k window).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID","title":"Variable: DEFAULT\\_SUMMARY\\_MESSAGE\\_ID","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/compact/summarizer/variables/DEFAULT_SUMMARY_MESSAGE_ID.md\ndescription: >-\n The default id assigned to the synthetic summary message {@link\n assembleCompactedTurns} emits.\n---\n\n# Variable: DEFAULT\\_SUMMARY\\_MESSAGE\\_ID\n\n```ts\nconst DEFAULT_SUMMARY_MESSAGE_ID: \"__compact-summary\" = \"__compact-summary\";\n```\n\nDefined in: [src/batteries/context/compact/summarizer.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/compact/summarizer.ts#L54)\n\nThe default id assigned to the synthetic summary message [assembleCompactedTurns](../functions/assembleCompactedTurns.md) emits.\n\n## Remarks\n\nThis exact string is the cross-battery contract with Token Thrift: `thrift`'s\n[@nhtio/adk/batteries/context/thrift/contracts!IsSummaryMessageFn](../../../thrift/contracts/type-aliases/IsSummaryMessageFn.md) default predicate is\n`id === '__compact-summary'` — a caller running `compact` upstream of `thrift` in the same pipeline\ngets, for free, thrift's protection of this message from being shed like an ordinary old turn. If a\ncaller overrides `summaryMessageId` here, they must also override thrift's `isSummaryMessage` option\nto match, or thrift will treat the running summary as just another shed-able message.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/exceptions","title":"@nhtio/adk/batteries/context/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/exceptions.md'\ndescription: >-\n Shared exception for the context-management batteries — the one failure class\n `thrift` and `compact` have in common.\n---\n\n# @nhtio/adk/batteries/context/exceptions\n\nShared exception for the context-management batteries — the one failure class `thrift` and\n`compact` have in common.\n\n## Remarks\n\nBoth `thrift` (`subtractToFit`) and `compact` (`summariseTurns`, `assembleCompactedTurns`) require\na caller-injected resolver (`estimateTokens`, and for `compact` also `summarize`) because neither\nbattery bundles a tokenizer or a model transport of its own — see each battery's `contracts.ts` for\nthe \"surface, don't impose\" rationale. A missing resolver is the SAME failure shape in both\nbatteries (a required injected function wasn't supplied), so it is minted ONCE here rather than\nduplicated per-battery. This module lives at the `context` domain level (a sibling of `thrift/` and\n`compact/`, not inside either) specifically so both can import it without either depending on the\nother, and re-exports from `../index.ts` so a consumer of either battery's public barrel sees it\nwithout a deep import. Minted via `createException` from `@nhtio/adk/factories`, matching every\nother battery's exception convention.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_CONTEXT\\_RESOLVER\\_MISSING](variables/E_CONTEXT_RESOLVER_MISSING.md) | Thrown when a context-management battery function is called without a REQUIRED injected resolver (`estimateTokens`, or — for Compact's `summarize` seam — the model-call function). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/exceptions/variables/E_CONTEXT_RESOLVER_MISSING","title":"Variable: E\\_CONTEXT\\_RESOLVER\\_MISSING","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/exceptions/variables/E_CONTEXT_RESOLVER_MISSING","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md\ndescription: >-\n Thrown when a context-management battery function is called without a REQUIRED\n injected resolver (`estimateTokens`, or — for Compact's `summarize` seam — the\n model-call function).\n---\n\n# Variable: E\\_CONTEXT\\_RESOLVER\\_MISSING\n\n```ts\nconst E_CONTEXT_RESOLVER_MISSING: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/context/exceptions.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/exceptions.ts#L54)\n\nThrown when a context-management battery function is called without a REQUIRED injected resolver\n(`estimateTokens`, or — for Compact's `summarize` seam — the model-call function).\n\n## Remarks\n\nBoth `@nhtio/adk/batteries/context/thrift` and `@nhtio/adk/batteries/context/compact` ship with no\nbundled tokenizer and (for Compact) no bundled model transport — every capability they cannot\nperform themselves is an INJECTED function the caller must supply. Omitting one is a caller\nprogramming error (a wiring mistake, not a runtime condition to recover from): rather than let the\nomission surface later as a confusing `undefined is not a function` deep inside the algorithm, every\nentry point checks eagerly and throws this, naming both the missing option and the function that\nneeded it, so the fix is obvious at the call site. Fatal — construct the missing resolver and retry;\nthere is no degrade-and-continue path, because a battery with no way to measure tokens (or, for\nCompact, no way to call a model) cannot make progress at all.\n\nPrintf args: `[functionName, missingOption]` — e.g. `['subtractToFit', 'estimateTokens']` or\n`['summariseTurns', 'summarize']`.\n\n## Example\n\n```ts\nimport { isInstanceOf } from \"@nhtio/adk\";\n\ntry {\n subtractToFit(ws, contextWindow, relevantToolNames, {} as never);\n} catch (err) {\n if (isInstanceOf(err, \"E_CONTEXT_RESOLVER_MISSING\")) {\n // err.message: \"subtractToFit: options.estimateTokens is required — this context-management\n // battery ships with no bundled tokenizer/model transport of its own.\"\n }\n}\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift","title":"@nhtio/adk/batteries/context/thrift","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift.md'\ndescription: >-\n Token Thrift — subtractive context management. A pure, model-free algorithm\n that holds a large WORKING set (messages, memories, retrievables, thoughts, an\n image, tools) and SUBTRACTS it down to the highest-signal slice that fits the\n active model's context window.\n---\n\n# @nhtio/adk/batteries/context/thrift\n\nToken Thrift — subtractive context management. A pure, model-free algorithm that holds a large\nWORKING set (messages, memories, retrievables, thoughts, an image, tools) and SUBTRACTS it down to\nthe highest-signal slice that fits the active model's context window.\n\n## Remarks\n\n## The thesis\n\nA context window is not a chat history — it is only what you send for ONE dispatch. Most\ncontext-management strategies either accumulate (append everything, truncate blindly when it\noverflows) or pay a model call to compress (summarize). Token Thrift does neither: it is a\n**zero-model-call** algorithm — every decision is a measured, evidence-based subtraction (a token\ncount compared against a budget), never a guess and never a paid LLM round-trip. The same function\nruns identically at `contextWindow: 4096` and `contextWindow: 1_000_000`; the window span is a\nparameter, not a rewrite.\n\nThe subtraction order (lowest-signal, most-recoverable content first): an image attachment → stale\nprior-turn tool results (oldest first, this-turn results protected by a newest-N backstop) → the\ntail of a RAG ranking → low-importance memories → stale ephemeral control messages → the oldest\nconversation turns → surviving guidance thoughts (oldest first) → visible tools (last resort, driven\ntoward zero). See\n[@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](subtractive_pass/functions/subtractToFit.md) for the full,\nstep-by-step account with the rationale for each cut.\n\nUpstream of the subtractive pass, [@nhtio/adk/batteries/context/thrift/relevance!selectRelevantTurns](relevance/functions/selectRelevantTurns.md)\noffers a smarter alternative to plain recency for deciding which history turns are worth replaying\nat all — walking the ENTIRE history and keeping anything lexically relevant to the current query,\nnot just the last N turns.\n\n## The evaluation\n\nThis battery is a direct extraction of the flagship reference agent's production subtractive pass —\nevaluated HEAD-TO-HEAD across five models against alternative context-management strategies\n(recency-only truncation, and a paid summarizing \"compact\" strategy) on a shared stress corpus.\nHonest results, both wins and the one loss:\n\n* **Cost**: thrift is the outright cost winner across the matrix — roughly HALF the tokens per\n answer of the alternatives, since it never pays for a summarizer call and never carries dead\n weight forward.\n* **Quality at the constrained edge**: at tight context budgets, thrift scored 0.82 vs. 0.75 for\n the next-best strategy.\n* **Quality at a large (128k) window under control conditions**: 1.27 vs. 1.11.\n* **The one honest loss**: on a SINGLE reasoning-model cell, a paid summarizing (\"compact\")\n strategy beat thrift 1.48 vs. 1.13 — reasoning models can, in some configurations, make better use\n of a paid compression step than of subtraction alone. Thrift does not claim to dominate every\n cell; it is the stronger strategy on cost everywhere and on quality almost everywhere, honestly\n including where it wasn't.\n\nA paid summarizing sibling strategy (\"compact\") — the strategy that won that one cell — is planned\nas a future addition to the `@nhtio/adk/batteries/context` domain (see\n@nhtio/adk/batteries/context for the domain-level framing). This battery already carries the\none cross-cutting hook a future compact strategy needs from thrift: the `isSummaryMessage` predicate\non [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!SubtractToFitOptions](subtractive_pass/interfaces/SubtractToFitOptions.md), which protects\na summarizing strategy's running-summary message from being shed like an ordinary old turn.\n\n## Zero-model-call guarantee\n\nEvery export in this battery is synchronous, pure with respect to its inputs (aside from mutating\nthe working set it's handed), and makes no network or model calls of any kind. The only capability\nthis battery cannot perform itself — tokenization — is an INJECTED function\n([@nhtio/adk/batteries/context/thrift/contracts!EstimateTokensFn](contracts/type-aliases/EstimateTokensFn.md)), never a bundled tokenizer\nand never a model call.\n\n## Usage sketch\n\n```ts\nimport {\n subtractToFit,\n type WorkingSet,\n} from \"@nhtio/adk/batteries/context/thrift\";\nimport { Tokenizable } from \"@nhtio/adk\";\n\nconst ws: WorkingSet = {\n systemPrompt: mySystemPrompt, // a Tokenizable, or a plain string\n messages: myMessages,\n memories: myMemories,\n retrievables: myRagChunks,\n thoughts: myThoughts,\n tools: myToolRegistry,\n};\n\nconst trace = subtractToFit(ws, model.contextWindow, myShortlistedToolNames, {\n // Inject Tokenizable's own estimator so thrift measures byte-for-byte what your\n // own overflow guard counts — including ctx-resolved dynamic content.\n estimateTokens: (value, encoding, ctx) =>\n Tokenizable.estimateTokens(value, encoding, ctx),\n outputReserve: model.maxOutputTokens,\n});\n\nif (!trace.fits) {\n // Even the irreducible floor (system prompt + newest turn + output reserve) exceeds the\n // window — a bounded refusal, not a truncated/incoherent dispatch.\n}\n```\n\n## References\n\n### argText\n\nRe-exports [argText](relevance/functions/argText.md)\n\n***\n\n### BucketTrace\n\nRe-exports [BucketTrace](subtractive_pass/interfaces/BucketTrace.md)\n\n***\n\n### ContentLike\n\nRe-exports [ContentLike](contracts/interfaces/ContentLike.md)\n\n***\n\n### contentTokens\n\nRe-exports [contentTokens](relevance/functions/contentTokens.md)\n\n***\n\n### DEFAULT\\_ENCODING\n\nRe-exports [DEFAULT\\_ENCODING](subtractive_pass/variables/DEFAULT_ENCODING.md)\n\n***\n\n### DEFAULT\\_RESERVE\\_FRACTION\n\nRe-exports [DEFAULT\\_RESERVE\\_FRACTION](subtractive_pass/variables/DEFAULT_RESERVE_FRACTION.md)\n\n***\n\n### DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP\n\nRe-exports [DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP](subtractive_pass/variables/DEFAULT_THIS_TURN_RESULT_KEEP.md)\n\n***\n\n### E\\_CONTEXT\\_RESOLVER\\_MISSING\n\nRe-exports [E\\_CONTEXT\\_RESOLVER\\_MISSING](../exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md)\n\n***\n\n### Estimable\n\nRe-exports [Estimable](contracts/interfaces/Estimable.md)\n\n***\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](contracts/type-aliases/EstimateTokensFn.md)\n\n***\n\n### EstimatorOptions\n\nRe-exports [EstimatorOptions](subtractive_pass/interfaces/EstimatorOptions.md)\n\n***\n\n### groupHistoryIntoTurns\n\nRe-exports [groupHistoryIntoTurns](relevance/functions/groupHistoryIntoTurns.md)\n\n***\n\n### HistoryTurn\n\nRe-exports [HistoryTurn](relevance/interfaces/HistoryTurn.md)\n\n***\n\n### IsEphemeralMessageFn\n\nRe-exports [IsEphemeralMessageFn](contracts/type-aliases/IsEphemeralMessageFn.md)\n\n***\n\n### IsSummaryMessageFn\n\nRe-exports [IsSummaryMessageFn](contracts/type-aliases/IsSummaryMessageFn.md)\n\n***\n\n### MillisTimestamp\n\nRe-exports [MillisTimestamp](contracts/interfaces/MillisTimestamp.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_CURVE\n\nRe-exports [RELEVANCE\\_FLOOR\\_CURVE](relevance/variables/RELEVANCE_FLOOR_CURVE.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_MAX\n\nRe-exports [RELEVANCE\\_FLOOR\\_MAX](relevance/variables/RELEVANCE_FLOOR_MAX.md)\n\n***\n\n### RELEVANCE\\_FLOOR\\_MIN\n\nRe-exports [RELEVANCE\\_FLOOR\\_MIN](relevance/variables/RELEVANCE_FLOOR_MIN.md)\n\n***\n\n### RelevanceMessage\n\nRe-exports [RelevanceMessage](relevance/interfaces/RelevanceMessage.md)\n\n***\n\n### RelevanceToolCall\n\nRe-exports [RelevanceToolCall](relevance/interfaces/RelevanceToolCall.md)\n\n***\n\n### relevanceToQuery\n\nRe-exports [relevanceToQuery](relevance/functions/relevanceToQuery.md)\n\n***\n\n### RenderToolsFn\n\nRe-exports [RenderToolsFn](contracts/type-aliases/RenderToolsFn.md)\n\n***\n\n### resolveBudget\n\nRe-exports [resolveBudget](subtractive_pass/functions/resolveBudget.md)\n\n***\n\n### scaledRelevanceFloor\n\nRe-exports [scaledRelevanceFloor](relevance/functions/scaledRelevanceFloor.md)\n\n***\n\n### selectNaiveTurns\n\nRe-exports [selectNaiveTurns](relevance/functions/selectNaiveTurns.md)\n\n***\n\n### SelectNaiveTurnsOptions\n\nRe-exports [SelectNaiveTurnsOptions](relevance/interfaces/SelectNaiveTurnsOptions.md)\n\n***\n\n### selectRelevantTurns\n\nRe-exports [selectRelevantTurns](relevance/functions/selectRelevantTurns.md)\n\n***\n\n### SelectRelevantTurnsOptions\n\nRe-exports [SelectRelevantTurnsOptions](relevance/interfaces/SelectRelevantTurnsOptions.md)\n\n***\n\n### ShedRankFn\n\nRe-exports [ShedRankFn](contracts/type-aliases/ShedRankFn.md)\n\n***\n\n### stripPriorTurnThoughts\n\nRe-exports [stripPriorTurnThoughts](subtractive_pass/functions/stripPriorTurnThoughts.md)\n\n***\n\n### subtractToFit\n\nRe-exports [subtractToFit](subtractive_pass/functions/subtractToFit.md)\n\n***\n\n### SubtractToFitOptions\n\nRe-exports [SubtractToFitOptions](subtractive_pass/interfaces/SubtractToFitOptions.md)\n\n***\n\n### ThriftTrace\n\nRe-exports [ThriftTrace](subtractive_pass/interfaces/ThriftTrace.md)\n\n***\n\n### WorkingImage\n\nRe-exports [WorkingImage](contracts/interfaces/WorkingImage.md)\n\n***\n\n### WorkingMemory\n\nRe-exports [WorkingMemory](contracts/interfaces/WorkingMemory.md)\n\n***\n\n### WorkingMessage\n\nRe-exports [WorkingMessage](contracts/interfaces/WorkingMessage.md)\n\n***\n\n### WorkingRetrievable\n\nRe-exports [WorkingRetrievable](contracts/interfaces/WorkingRetrievable.md)\n\n***\n\n### WorkingSet\n\nRe-exports [WorkingSet](subtractive_pass/interfaces/WorkingSet.md)\n\n***\n\n### WorkingThought\n\nRe-exports [WorkingThought](contracts/interfaces/WorkingThought.md)\n\n***\n\n### WorkingTool\n\nRe-exports [WorkingTool](contracts/interfaces/WorkingTool.md)\n\n***\n\n### WorkingToolCall\n\nRe-exports [WorkingToolCall](contracts/interfaces/WorkingToolCall.md)\n\n***\n\n### WorkingToolRegistry\n\nRe-exports [WorkingToolRegistry](contracts/interfaces/WorkingToolRegistry.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts","title":"@nhtio/adk/batteries/context/thrift/contracts","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts.md'\ndescription: >-\n Structural contracts for the Token Thrift subtractive-pass battery — every\n shape it reads off a caller's objects, and every capability it invokes via an\n injected function.\n---\n\n# @nhtio/adk/batteries/context/thrift/contracts\n\nStructural contracts for the Token Thrift subtractive-pass battery — every shape it reads off a\ncaller's objects, and every capability it invokes via an injected function.\n\n## Remarks\n\nThis module has **zero imports** — not even a type-only import from `@nhtio/adk` core. Every type\nbelow is a local structural (duck-typed) declaration of the *minimum* shape the subtractive pass\nactually reads, derived field-by-field from the production algorithm this battery was extracted\nfrom (the flagship agent's `agent_subtractive_pass.ts`). A core `Message`, `Memory`, `Retrievable`,\n`Thought`, `Tool`, or `ToolRegistry` instance satisfies these interfaces structurally — you never\nneed to import the core classes to call this battery, and the battery never needs to import them\nto accept your objects. This is the \"surface, don't impose\" contract in its most literal form: the\nbattery imposes a SHAPE, never a CLASS.\n\nTwo kinds of decoupling happen here:\n\n1. **Structural types** for the read-only working-set items (messages, memories, retrievables,\n thoughts, tool calls, tools, a tool registry) — the battery only ever reads the handful of\n fields/methods declared here, never the full core class surface.\n2. **Injected resolver functions** for capabilities the battery cannot perform itself — most\n importantly token estimation ([EstimateTokensFn](type-aliases/EstimateTokensFn.md)), since this battery ships with no\n tokenizer of its own and must never guess at one.\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ContentLike](interfaces/ContentLike.md) | A `Tokenizable`-like value: renders to a string and (usually) knows its own token cost. Every content field the working set carries (system prompt, standing instructions, message/thought content) is either a plain `string` or a value shaped like this. |\n| [Estimable](interfaces/Estimable.md) | Anything that can estimate its own rendered token cost under a named encoding — the structural shape the battery expects from a `Tokenizable`-like value (system prompt, standing instruction, message content, thought content). Mirrors core's `Tokenizable` public surface, minimally. |\n| [MillisTimestamp](interfaces/MillisTimestamp.md) | Anything with a `.toMillis()` — the structural shape the battery needs from a timestamp field (a core `DateTime` satisfies this; so does a plain `{ toMillis: () => number }` test double). |\n| [WorkingImage](interfaces/WorkingImage.md) | An image (or other flat-cost media) attachment in the working set — the single biggest token hog, shed first when the dispatch is over budget. |\n| [WorkingMemory](interfaces/WorkingMemory.md) | The structural shape of a memory the working set carries. Only `content` (measured) and `importance` (sort key — low-importance memories shed first) are read. |\n| [WorkingMessage](interfaces/WorkingMessage.md) | The structural shape of a conversation message the working set carries. Only the fields the pass actually reads: `id` (for ephemeral/summary predicate matching and identity-stable tracing), `content` (measured, and — for messages with no `content` — treated as empty/attachments-only), and `createdAt` (for oldest-first shedding order). |\n| [WorkingRetrievable](interfaces/WorkingRetrievable.md) | The structural shape of a retrieved passage (RAG chunk) the working set carries. `estimateTokens` mirrors a core `Retrievable`'s own method, which MAY resolve asynchronously (a reader-backed artifact's estimate can be a `Promise`) — the battery treats a non-number return as \"measure the rendered string instead\" (see [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../subtractive_pass/functions/subtractToFit.md)'s `rTok` helper), since this pass is synchronous end-to-end and never awaits. |\n| [WorkingThought](interfaces/WorkingThought.md) | The structural shape of a \"thought\" (model-internal guidance/scratchpad content, e.g. a plan or a per-iteration nudge) the working set carries. Read for identity (`id`, matched against `keepThoughtIds`/`protectThoughtIds`), measurement (`content`), and shed ordering (`createdAt`). |\n| [WorkingTool](interfaces/WorkingTool.md) | The structural shape of a tool declaration the working set's tool registry carries. Only `name` (identity, shed-rank lookup) and `description` (the fallback `name: description` measurement proxy used when no [RenderToolsFn](type-aliases/RenderToolsFn.md) is injected) are read. |\n| [WorkingToolCall](interfaces/WorkingToolCall.md) | A prior-turn (or this-turn) tool call in the working set, carrying the PRE-COMPUTED token cost of its rendered result — the pass never renders a tool result itself (it would need to await an artifact reader, breaking synchrony), so the caller measures the result via its own renderer and hands the cost here. |\n| [WorkingToolRegistry](interfaces/WorkingToolRegistry.md) | The MINIMAL tool-registry surface the pass needs — not the full core `ToolRegistry` class. Only `all()` (enumerate every registered tool, to compute the tools bucket's \"before\" weight) and `setHidden(...names)` (replace the entire hidden set — the mechanism by which a shed tool becomes invisible to the model while remaining callable via a catalog) are invoked. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [EstimateTokensFn](type-aliases/EstimateTokensFn.md) | Estimate the token cost of a rendered string under a named encoding, optionally resolved against a live dispatch context. |\n| [IsEphemeralMessageFn](type-aliases/IsEphemeralMessageFn.md) | Decide whether a message is an EPHEMERAL control message — one that is re-derived fresh every dispatch iteration and never persisted, so only the LATEST surviving copy carries live information and every older one is pure waste. Injectable so a caller's own id-tagging scheme (or a caller with no such concept at all) can plug in; see the `isEphemeralMessage` option on [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../subtractive_pass/functions/subtractToFit.md) for the calibrated default (`id.startsWith('__eph-')`, the flagship agent's own convention). |\n| [IsSummaryMessageFn](type-aliases/IsSummaryMessageFn.md) | Decide whether a message is the load-bearing \"running summary\" a compacting/summarizing strategy maintains — content that stands in for every older turn that strategy folded away, and so must never be shed like an ordinary old turn even though it is chronologically the oldest message in the working set. Injectable; see the `isSummaryMessage` option on [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../subtractive_pass/functions/subtractToFit.md) for the calibrated default (`id === '__compact-summary'`). Callers who never run a summarizing strategy alongside thrift can ignore this entirely — the default predicate simply never matches their messages. |\n| [RenderToolsFn](type-aliases/RenderToolsFn.md) | Renders a set of tools into the EXACT prompt text a caller's LLM battery will send to the model (e.g. a `` block with full JSON-Schema per tool), so the tools bucket is measured against the REAL dispatched size rather than a cheap `name: description` proxy. Injecting this is the difference between an accurate budget and one that silently undercounts by an order of magnitude for schema-heavy tools — see the calibration note on [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../subtractive_pass/functions/subtractToFit.md). Optional: when omitted, the pass falls back to the `name: description` proxy (keeps the battery usable standalone/in tests without a real tool-rendering pipeline). |\n| [ShedRankFn](type-aliases/ShedRankFn.md) | Ranks a tool by last-resort shed priority: LOWER rank sheds FIRST. Ties are broken by encounter order (a stable sort), so two tools ranked equally shed in whatever order the caller's `relevantToolNames` listed them. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/ContentLike","title":"Interface: ContentLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/ContentLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/ContentLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/ContentLike.md\ndescription: >-\n A `Tokenizable`-like value: renders to a string and (usually) knows its own\n token cost. Every content field the working set carries (system prompt,\n standing instructions, message/thought content) is either a plain `string` or\n a value shaped like this.\n---\n\n# Interface: ContentLike\n\nDefined in: [src/batteries/context/thrift/contracts.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L85)\n\nA `Tokenizable`-like value: renders to a string and (usually) knows its own token cost. Every\ncontent field the working set carries (system prompt, standing instructions, message/thought\ncontent) is either a plain `string` or a value shaped like this.\n\n## Remarks\n\n`estimateTokens` is optional here (unlike [Estimable](Estimable.md)) because a caller may hand the battery\na plain object that only renders text (e.g. a lightweight test double) — the battery falls back to\nmeasuring `toString()` via the injected [EstimateTokensFn](../type-aliases/EstimateTokensFn.md) when `estimateTokens` is absent.\n\n## Methods\n\n### estimateTokens()?\n\n```ts\noptional estimateTokens(encoding: string, ctx?: unknown): number;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L89)\n\nOptional self-measurement, preferred over the `toString()` fallback when present.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | --------- |\n| `encoding` | `string` |\n| `ctx?` | `unknown` |\n\n#### Returns\n\n`number`\n\n***\n\n### toString()\n\n```ts\ntoString(): string;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L87)\n\nRender this value to its dispatched text form.\n\n#### Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/Estimable","title":"Interface: Estimable","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/Estimable.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/Estimable","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/Estimable.md\ndescription: >-\n Anything that can estimate its own rendered token cost under a named encoding\n — the structural shape the battery expects from a `Tokenizable`-like value\n (system prompt, standing instruction, message content, thought content).\n Mirrors core's `Tokenizable` public surface, minimally.\n---\n\n# Interface: Estimable\n\nDefined in: [src/batteries/context/thrift/contracts.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L67)\n\nAnything that can estimate its own rendered token cost under a named encoding — the structural\nshape the battery expects from a `Tokenizable`-like value (system prompt, standing instruction,\nmessage content, thought content). Mirrors core's `Tokenizable` public surface, minimally.\n\n## Methods\n\n### estimateTokens()\n\n```ts\nestimateTokens(encoding: string, ctx?: unknown): number;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L72)\n\nEstimate this value's rendered token cost under `encoding`, optionally resolved against a live\ndispatch context (see [EstimateTokensFn](../type-aliases/EstimateTokensFn.md) for why `ctx` matters for dynamic content).\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | --------- |\n| `encoding` | `string` |\n| `ctx?` | `unknown` |\n\n#### Returns\n\n`number`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/MillisTimestamp","title":"Interface: MillisTimestamp","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/MillisTimestamp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/MillisTimestamp","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/MillisTimestamp.md\ndescription: >-\n Anything with a `.toMillis()` — the structural shape the battery needs from a\n timestamp field (a core `DateTime` satisfies this; so does a plain `{\n toMillis: () => number }` test double).\n---\n\n# Interface: MillisTimestamp\n\nDefined in: [src/batteries/context/thrift/contracts.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L94)\n\nAnything with a `.toMillis()` — the structural shape the battery needs from a timestamp field\n(a core `DateTime` satisfies this; so does a plain `{ toMillis: () => number }` test double).\n\n## Methods\n\n### toMillis()\n\n```ts\ntoMillis(): number;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L96)\n\nThe instant this timestamp represents, as Unix epoch milliseconds.\n\n#### Returns\n\n`number`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingImage","title":"Interface: WorkingImage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingImage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingImage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingImage.md\ndescription: >-\n An image (or other flat-cost media) attachment in the working set — the single\n biggest token hog, shed first when the dispatch is over budget.\n---\n\n# Interface: WorkingImage\n\nDefined in: [src/batteries/context/thrift/contracts.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L235)\n\nAn image (or other flat-cost media) attachment in the working set — the single biggest token hog,\nshed first when the dispatch is over budget.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | --------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kept?` | `boolean` | Whether it survived the pass; set by `subtractToFit`, ignored on input. | [src/batteries/context/thrift/contracts.ts:241](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L241) |\n| `label` | `string` | Human label for tracing/diagnostics. | [src/batteries/context/thrift/contracts.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L237) |\n| `tokenCost` | `number` | Token cost of including this attachment in the dispatch. | [src/batteries/context/thrift/contracts.ts:239](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L239) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMemory","title":"Interface: WorkingMemory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMemory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMemory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMemory.md\ndescription: >-\n The structural shape of a memory the working set carries. Only `content`\n (measured) and `importance` (sort key — low-importance memories shed first)\n are read.\n---\n\n# Interface: WorkingMemory\n\nDefined in: [src/batteries/context/thrift/contracts.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L119)\n\nThe structural shape of a memory the working set carries. Only `content` (measured) and\n`importance` (sort key — low-importance memories shed first) are read.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | `string` | [`ContentLike`](ContentLike.md) | The memory's rendered content, measured toward the memories bucket's token weight. | [src/batteries/context/thrift/contracts.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L121) |\n| `importance?` | `number` | `[0, 1]`-ish importance score; memories sort by this (descending) before the shed, so the lowest-importance memories are popped first. Missing/absent sorts as `0` (shed first). | [src/batteries/context/thrift/contracts.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L124) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMessage","title":"Interface: WorkingMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingMessage.md\ndescription: >-\n The structural shape of a conversation message the working set carries. Only\n the fields the pass actually reads: `id` (for ephemeral/summary predicate\n matching and identity-stable tracing), `content` (measured, and — for messages\n with no `content` — treated as empty/attachments-only), and `createdAt` (for\n oldest-first shedding order).\n---\n\n# Interface: WorkingMessage\n\nDefined in: [src/batteries/context/thrift/contracts.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L105)\n\nThe structural shape of a conversation message the working set carries. Only the fields the pass\nactually reads: `id` (for ephemeral/summary predicate matching and identity-stable tracing),\n`content` (measured, and — for messages with no `content` — treated as empty/attachments-only),\nand `createdAt` (for oldest-first shedding order).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | `string` | [`ContentLike`](ContentLike.md) | The message's rendered content. Absent (attachment-only messages) measures as zero tokens. | [src/batteries/context/thrift/contracts.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L110) |\n| `createdAt` | [`MillisTimestamp`](MillisTimestamp.md) | When this message was created; drives oldest-first shedding order. | [src/batteries/context/thrift/contracts.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L112) |\n| `id` | `string` | Stable identifier, matched against `keepThoughtIds`-style id sets and the injected `isEphemeralMessage`/`isSummaryMessage` predicates. | [src/batteries/context/thrift/contracts.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L108) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingRetrievable","title":"Interface: WorkingRetrievable","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingRetrievable.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingRetrievable","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingRetrievable.md\ndescription: >-\n The structural shape of a retrieved passage (RAG chunk) the working set\n carries. `estimateTokens` mirrors a core `Retrievable`'s own method, which MAY\n resolve asynchronously (a reader-backed artifact's estimate can be a\n `Promise`) — the battery treats a non-number return as \"measure the rendered\n string instead\" (see {@link\n @nhtio/adk/batteries/context/thrift/subtractive_pass!subtractToFit}'s `rTok`\n helper), since this pass is synchronous end-to-end and never awaits.\n---\n\n# Interface: WorkingRetrievable\n\nDefined in: [src/batteries/context/thrift/contracts.ts:134](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L134)\n\nThe structural shape of a retrieved passage (RAG chunk) the working set carries. `estimateTokens`\nmirrors a core `Retrievable`'s own method, which MAY resolve asynchronously (a reader-backed\nartifact's estimate can be a `Promise`) — the battery treats a non-number return as \"measure the\nrendered string instead\" (see [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md)'s `rTok`\nhelper), since this pass is synchronous end-to-end and never awaits.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | | `string` | { `estimateTokens?`: `number` | `Promise`<`number`>; `toString`: `string`; } | The retrieved passage's rendered content. Core artifacts may expose an asynchronous estimate; thrift only accepts the synchronous result and otherwise uses its defensive fallback. | [src/batteries/context/thrift/contracts.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L139) |\n| `id?` | `string` | Stable identifier, when available, for diagnostics and trace attribution. | [src/batteries/context/thrift/contracts.ts:136](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L136) |\n| `score?` | `number` | Relevance/rerank score, `[0, 1]`-ish; retrievables sort by this (descending) before the shed, so the tail of the ranking (lowest score) sheds first. Missing/absent sorts as `0` (shed first). | [src/batteries/context/thrift/contracts.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L147) |\n| `sizeUnknown?` | `boolean` | Whether this retrievable's content cannot be synchronously measured safely by thrift. A real core `Retrievable` structurally supplies this field automatically through its `sizeUnknown` getter; no adapter or conversion object is needed. Any other, non-core duck-typed caller supplying this shape MUST set `sizeUnknown: true` for content whose size it cannot verify to receive the same never-retain safety guarantee. This field is optional only to preserve the structural API's compatibility; the obligation for such callers is not enforced by TypeScript. | [src/batteries/context/thrift/contracts.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L161) |\n\n## Methods\n\n### estimateTokens()?\n\n```ts\noptional estimateTokens(encoding: string): number | Promise;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L150)\n\nOptional self-measurement; may resolve synchronously OR as a `Promise` (a reader-backed\nartifact). A non-number result falls back to measuring `content.toString()`.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | -------- |\n| `encoding` | `string` |\n\n#### Returns\n\n`number` | `Promise`<`number`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingThought","title":"Interface: WorkingThought","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingThought.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingThought","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingThought.md\ndescription: >-\n The structural shape of a \"thought\" (model-internal guidance/scratchpad\n content, e.g. a plan or a per-iteration nudge) the working set carries. Read\n for identity (`id`, matched against `keepThoughtIds`/`protectThoughtIds`),\n measurement (`content`), and shed ordering (`createdAt`).\n---\n\n# Interface: WorkingThought\n\nDefined in: [src/batteries/context/thrift/contracts.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L169)\n\nThe structural shape of a \"thought\" (model-internal guidance/scratchpad content, e.g. a plan or a\nper-iteration nudge) the working set carries. Read for identity (`id`, matched against\n`keepThoughtIds`/`protectThoughtIds`), measurement (`content`), and shed ordering (`createdAt`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | `string` | [`ContentLike`](ContentLike.md) | The thought's rendered content. | [src/batteries/context/thrift/contracts.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L173) |\n| `createdAt` | [`MillisTimestamp`](MillisTimestamp.md) | When this thought was created; drives oldest-first shedding order. | [src/batteries/context/thrift/contracts.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L175) |\n| `id` | `string` | Stable identifier, matched against `keepThoughtIds`/`protectThoughtIds` sets. | [src/batteries/context/thrift/contracts.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L171) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingTool","title":"Interface: WorkingTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingTool.md\ndescription: >-\n The structural shape of a tool declaration the working set's tool registry\n carries. Only `name` (identity, shed-rank lookup) and `description` (the\n fallback `name: description` measurement proxy used when no {@link\n RenderToolsFn} is injected) are read.\n---\n\n# Interface: WorkingTool\n\nDefined in: [src/batteries/context/thrift/contracts.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L183)\n\nThe structural shape of a tool declaration the working set's tool registry carries. Only `name`\n(identity, shed-rank lookup) and `description` (the fallback `name: description` measurement proxy\nused when no [RenderToolsFn](../type-aliases/RenderToolsFn.md) is injected) are read.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | -------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `description?` | `string` | Human-readable description, used in the fallback `name: description` measurement proxy. | [src/batteries/context/thrift/contracts.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L187) |\n| `name` | `string` | The tool's registered name — identity, and the shed-rank lookup key. | [src/batteries/context/thrift/contracts.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L185) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolCall","title":"Interface: WorkingToolCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolCall.md\ndescription: >-\n A prior-turn (or this-turn) tool call in the working set, carrying the\n PRE-COMPUTED token cost of its rendered result — the pass never renders a tool\n result itself (it would need to await an artifact reader, breaking synchrony),\n so the caller measures the result via its own renderer and hands the cost\n here.\n---\n\n# Interface: WorkingToolCall\n\nDefined in: [src/batteries/context/thrift/contracts.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L214)\n\nA prior-turn (or this-turn) tool call in the working set, carrying the PRE-COMPUTED token cost of\nits rendered result — the pass never renders a tool result itself (it would need to await an\nartifact reader, breaking synchrony), so the caller measures the result via its own renderer and\nhands the cost here.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAtMs` | `number` | Chronological order key — oldest tool results shed first among the sheddable pool. | [src/batteries/context/thrift/contracts.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L221) |\n| `ref` | `unknown` | Opaque handle back to the caller's own call record, returned unchanged so the caller can reconcile which calls survived the shed (e.g. against a `Set` of live tool-call ids). | [src/batteries/context/thrift/contracts.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L217) |\n| `thisTurn?` | `boolean` | `true` when this call was made during the CURRENT turn (the model just made it this dispatch). Such results are the turn's active working set and are protected from ordinary budget-shedding — evicting a result the model just fetched makes it immediately re-request the same call. Only prior-turn results (falsy/absent) are eligible for ordinary shedding; this-turn results are only shed by the newest-N backstop (`thisTurnResultKeep`) as a last resort. See [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md). | [src/batteries/context/thrift/contracts.ts:230](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L230) |\n| `tokenCost` | `number` | Token cost of this call's model-facing rendered result, measured by the caller. | [src/batteries/context/thrift/contracts.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L219) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolRegistry","title":"Interface: WorkingToolRegistry","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolRegistry.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolRegistry","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/interfaces/WorkingToolRegistry.md\ndescription: >-\n The MINIMAL tool-registry surface the pass needs — not the full core\n `ToolRegistry` class. Only `all()` (enumerate every registered tool, to\n compute the tools bucket's \"before\" weight) and `setHidden(...names)` (replace\n the entire hidden set — the mechanism by which a shed tool becomes invisible\n to the model while remaining callable via a catalog) are invoked.\n---\n\n# Interface: WorkingToolRegistry\n\nDefined in: [src/batteries/context/thrift/contracts.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L201)\n\nThe MINIMAL tool-registry surface the pass needs — not the full core `ToolRegistry` class. Only\n`all()` (enumerate every registered tool, to compute the tools bucket's \"before\" weight) and\n`setHidden(...names)` (replace the entire hidden set — the mechanism by which a shed tool becomes\ninvisible to the model while remaining callable via a catalog) are invoked.\n\n## Remarks\n\n`setHidden` REPLACES the whole hidden set on each call (matching core `ToolRegistry.setHidden`'s\ncontract) — the pass always passes the COMPLETE set of currently-hidden tool names, never a delta.\nA structural registry that instead accumulates hidden names across calls would over-hide.\n\n## Methods\n\n### all()\n\n```ts\nall(): WorkingTool[];\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L203)\n\nEvery tool currently registered (visible or hidden).\n\n#### Returns\n\n[`WorkingTool`](WorkingTool.md)\\[]\n\n***\n\n### setHidden()\n\n```ts\nsetHidden(...names: string[]): void;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L205)\n\nReplace the registry's entire hidden set with exactly these tool names.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | ---------- |\n| ...`names` | `string`\\[] |\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/EstimateTokensFn","title":"Type Alias: EstimateTokensFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/EstimateTokensFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/EstimateTokensFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/EstimateTokensFn.md\ndescription: >-\n Estimate the token cost of a rendered string under a named encoding,\n optionally resolved against a live dispatch context.\n---\n\n# Type Alias: EstimateTokensFn\n\n```ts\ntype EstimateTokensFn = (\n value: string,\n encoding: string,\n ctx?: unknown,\n) => number;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L60)\n\nEstimate the token cost of a rendered string under a named encoding, optionally resolved against a\nlive dispatch context.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `value` | `string` | The exact string whose token cost should be measured (already rendered — this function never renders anything itself). |\n| `encoding` | `string` | The encoding identifier to measure under (e.g. `'cl100k_base'`, `'gemma'`) — an opaque string as far as this battery is concerned; the injected function interprets it. |\n| `ctx?` | `unknown` | The live dispatch context, when measuring a value whose rendered size can depend on it (an evaluatable/dynamic value). Static content ignores this parameter. |\n\n## Returns\n\n`number`\n\nThe estimated token count, as a plain synchronous number.\n\n## Remarks\n\nThis is the ONE capability the subtractive pass cannot perform itself — it has no bundled\ntokenizer, by design (a context-management algorithm should not force a specific encoding on every\ncaller). Every token-accounting entry point in this battery therefore takes an `estimateTokens`\noption of this shape and REQUIRES it (see [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md)).\n\nThe signature mirrors core's own `Tokenizable.estimateTokens(encoding, ctx?)` method deliberately —\na caller already holding `Tokenizable` can inject `(value, encoding, ctx) => new Tokenizable(value).estimateTokens(encoding, ctx)`\n(or, more cheaply, delegate to `Tokenizable.estimateTokens` as a static call) and get byte-for-byte\nparity with what core's own overflow guard counts. The `ctx` parameter exists for exactly that\nreason: a dynamic/evaluatable value's rendered size can depend on the live dispatch context (an\ninterpolated system prompt is the canonical example), and a battery that measured only the static\nform would under-count relative to what the caller's guard actually ships — a real production bug\nthis contract exists to prevent (see the `ctx`-resolved measurement note on\n[@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md)).\n\nA caller measuring under a CUSTOM (non-built-in) encoding registers it once via\n[@nhtio/adk!registerTokenEstimator](../../../../../functions/registerTokenEstimator.md) and otherwise injects `Tokenizable.estimateTokens` exactly\nas shown above — the registration makes the custom encoding a drop-in peer of the built-ins, so this\nbattery never needs to know the encoding is non-standard.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsEphemeralMessageFn","title":"Type Alias: IsEphemeralMessageFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsEphemeralMessageFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsEphemeralMessageFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsEphemeralMessageFn.md\ndescription: >-\n Decide whether a message is an EPHEMERAL control message — one that is\n re-derived fresh every dispatch iteration and never persisted, so only the\n LATEST surviving copy carries live information and every older one is pure\n waste. Injectable so a caller's own id-tagging scheme (or a caller with no\n such concept at all) can plug in; see the `isEphemeralMessage` option on\n {@link @nhtio/adk/batteries/context/thrift/subtractive_pass!subtractToFit} for\n the calibrated default (`id.startsWith('__eph-')`, the flagship agent's own\n convention).\n---\n\n# Type Alias: IsEphemeralMessageFn\n\n```ts\ntype IsEphemeralMessageFn = (message: WorkingMessage) => boolean;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:287](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L287)\n\nDecide whether a message is an EPHEMERAL control message — one that is re-derived fresh every\ndispatch iteration and never persisted, so only the LATEST surviving copy carries live information\nand every older one is pure waste. Injectable so a caller's own id-tagging scheme (or a caller with\nno such concept at all) can plug in; see the `isEphemeralMessage` option on\n[@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md) for the calibrated\ndefault (`id.startsWith('__eph-')`, the flagship agent's own convention).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------- |\n| `message` | [`WorkingMessage`](../interfaces/WorkingMessage.md) |\n\n## Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsSummaryMessageFn","title":"Type Alias: IsSummaryMessageFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsSummaryMessageFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsSummaryMessageFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/IsSummaryMessageFn.md\ndescription: >-\n Decide whether a message is the load-bearing \"running summary\" a\n compacting/summarizing strategy maintains — content that stands in for every\n older turn that strategy folded away, and so must never be shed like an\n ordinary old turn even though it is chronologically the oldest message in the\n working set. Injectable; see the `isSummaryMessage` option on {@link\n @nhtio/adk/batteries/context/thrift/subtractive_pass!subtractToFit} for the\n calibrated default (`id === '__compact-summary'`). Callers who never run a\n summarizing strategy alongside thrift can ignore this entirely — the default\n predicate simply never matches their messages.\n---\n\n# Type Alias: IsSummaryMessageFn\n\n```ts\ntype IsSummaryMessageFn = (message: WorkingMessage) => boolean;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:298](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L298)\n\nDecide whether a message is the load-bearing \"running summary\" a compacting/summarizing strategy\nmaintains — content that stands in for every older turn that strategy folded away, and so must\nnever be shed like an ordinary old turn even though it is chronologically the oldest message in the\nworking set. Injectable; see the `isSummaryMessage` option on\n[@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md) for the calibrated\ndefault (`id === '__compact-summary'`). Callers who never run a summarizing strategy alongside\nthrift can ignore this entirely — the default predicate simply never matches their messages.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------- |\n| `message` | [`WorkingMessage`](../interfaces/WorkingMessage.md) |\n\n## Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/RenderToolsFn","title":"Type Alias: RenderToolsFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/RenderToolsFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/RenderToolsFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/RenderToolsFn.md\ndescription: >-\n Renders a set of tools into the EXACT prompt text a caller's LLM battery will\n send to the model (e.g. a `` block with full JSON-Schema per\n tool), so the tools bucket is measured against the REAL dispatched size rather\n than a cheap `name: description` proxy. Injecting this is the difference\n between an accurate budget and one that silently undercounts by an order of\n magnitude for schema-heavy tools — see the calibration note on {@link\n @nhtio/adk/batteries/context/thrift/subtractive_pass!subtractToFit}. Optional:\n when omitted, the pass falls back to the `name: description` proxy (keeps the\n battery usable standalone/in tests without a real tool-rendering pipeline).\n---\n\n# Type Alias: RenderToolsFn\n\n```ts\ntype RenderToolsFn = (tools: ReadonlyArray) => string;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L257)\n\nRenders a set of tools into the EXACT prompt text a caller's LLM battery will send to the model\n(e.g. a `` block with full JSON-Schema per tool), so the tools bucket is measured\nagainst the REAL dispatched size rather than a cheap `name: description` proxy. Injecting this is\nthe difference between an accurate budget and one that silently undercounts by an order of\nmagnitude for schema-heavy tools — see the calibration note on\n[@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md). Optional: when omitted,\nthe pass falls back to the `name: description` proxy (keeps the battery usable standalone/in tests\nwithout a real tool-rendering pipeline).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------- |\n| `tools` | `ReadonlyArray`<[`WorkingTool`](../interfaces/WorkingTool.md)> | The subset of tools currently visible (post-hiding), to render/measure. |\n\n## Returns\n\n`string`\n\nThe exact rendered text the caller's battery would send for these tools.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/ShedRankFn","title":"Type Alias: ShedRankFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/ShedRankFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/ShedRankFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/contracts/type-aliases/ShedRankFn.md\ndescription: >-\n Ranks a tool by last-resort shed priority: LOWER rank sheds FIRST. Ties are\n broken by encounter order (a stable sort), so two tools ranked equally shed in\n whatever order the caller's `relevantToolNames` listed them.\n---\n\n# Type Alias: ShedRankFn\n\n```ts\ntype ShedRankFn = (name: string) => number;\n```\n\nDefined in: [src/batteries/context/thrift/contracts.ts:277](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/contracts.ts#L277)\n\nRanks a tool by last-resort shed priority: LOWER rank sheds FIRST. Ties are broken by encounter\norder (a stable sort), so two tools ranked equally shed in whatever order the caller's\n`relevantToolNames` listed them.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | --------------------------- |\n| `name` | `string` | The tool's registered name. |\n\n## Returns\n\n`number`\n\nA rank; lower sheds first. Any finite number is valid — there is no required range.\n\n## Remarks\n\nThis replaces a hard-coded, domain-specific tier list (the flagship agent's `TOOL_SHED_ORDER`,\nwhich knew tool names like `provide_answer` and `search_docs_semantic`) with an INJECTABLE policy.\nThe battery ships a generic default (see the `shedRank` option on\n[@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../../subtractive_pass/functions/subtractToFit.md)) that treats every tool\nequally — it has no domain knowledge of which of a caller's tools are \"delivery\" tools vs. \"gather\"\ntools vs. \"exotic reader\" tools. A caller who DOES have that knowledge (as the flagship agent does)\nshould supply a `ShedRankFn` that encodes it, exactly as the flagship's own `TOOL_SHED_ORDER`-derived\nfunction did in production.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance","title":"@nhtio/adk/batteries/context/thrift/relevance","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance.md'\ndescription: >-\n Relevance-based history-turn selection — the companion to {@link\n subtractToFit} that decides WHICH prior turns are worth replaying at all,\n before the subtractive pass ever runs.\n---\n\n# @nhtio/adk/batteries/context/thrift/relevance\n\nRelevance-based history-turn selection — the companion to subtractToFit that decides WHICH\nprior turns are worth replaying at all, before the subtractive pass ever runs.\n\n## Remarks\n\n[@nhtio/adk/batteries/context/thrift/subtractive\\_pass!subtractToFit](../subtractive_pass/functions/subtractToFit.md) sheds a working set's\nOLDEST turns first once the budget is blown — a purely recency-based (FIFO) policy. This module is\na smarter alternative for the turn-selection step upstream of that: instead of \"the last N turns,\"\nwalk the ENTIRE history (no turn-count cap) and keep any turn whose content is LEXICALLY RELEVANT to\nthe current query, regardless of how old it is, while always keeping the most recent `keepRecent`\nturns verbatim (coreference — \"it\", \"that file\" — needs the immediately preceding turns present no\nmatter what).\n\nThis is a genuine head-to-head-evaluated alternative to naive recency, not a hypothetical: in the\nflagship reference agent this battery was extracted from, [selectRelevantTurns](functions/selectRelevantTurns.md) was the\nTREATMENT arm and [selectNaiveTurns](functions/selectNaiveTurns.md) was the BASELINE arm of the same evaluation the battery\nbarrel documents. Use `selectRelevantTurns` when you want the evaluated win; `selectNaiveTurns`\nremains exported as an honest, drop-in comparison baseline (or for a caller who simply wants FIFO).\n\nZero imports, same as every module in this battery — token measurement is via an injected\n[EstimateTokensFn](../contracts/type-aliases/EstimateTokensFn.md), never a bundled tokenizer.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [HistoryTurn](interfaces/HistoryTurn.md) | One grouped conversation turn: the messages from a user message through the next assistant message (inclusive), plus any tool calls that occurred during it, and `qa` — the turn's full combined text (every message's content plus every tool call's `name args` fragment) used for relevance scoring. |\n| [RelevanceMessage](interfaces/RelevanceMessage.md) | The minimal structural shape of a conversation message this module groups into turns. `createdAt` is a lexicographically-sortable timestamp string (e.g. ISO-8601) — turns and tool calls are ordered by string comparison (`localeCompare`), not parsed into a `Date`, so any consistently-formatted sortable string works. |\n| [RelevanceToolCall](interfaces/RelevanceToolCall.md) | The minimal structural shape of a tool call this module attaches to the turn it occurred in. |\n| [SelectNaiveTurnsOptions](interfaces/SelectNaiveTurnsOptions.md) | Options for [selectNaiveTurns](functions/selectNaiveTurns.md). |\n| [SelectRelevantTurnsOptions](interfaces/SelectRelevantTurnsOptions.md) | Options for [selectRelevantTurns](functions/selectRelevantTurns.md). |\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [RELEVANCE\\_FLOOR\\_CURVE](variables/RELEVANCE_FLOOR_CURVE.md) | The exponent shaping how the relevance floor scales between [RELEVANCE\\_FLOOR\\_MIN](variables/RELEVANCE_FLOOR_MIN.md) and [RELEVANCE\\_FLOOR\\_MAX](variables/RELEVANCE_FLOOR_MAX.md) as window utilization rises from 0 to 1 (see [scaledRelevanceFloor](functions/scaledRelevanceFloor.md)). |\n| [RELEVANCE\\_FLOOR\\_MAX](variables/RELEVANCE_FLOOR_MAX.md) | The relevance floor's upper bound — the minimum shared-content-word fraction required when the window is nearly full (strict: only keep turns with strong, unambiguous overlap). |\n| [RELEVANCE\\_FLOOR\\_MIN](variables/RELEVANCE_FLOOR_MIN.md) | The relevance floor's lower bound — the minimum fraction of the current query's content words a turn must share to be kept, used when the window is nearly empty (permissive: keep almost anything that shares ANY real overlap). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [argText](functions/argText.md) | Render a tool call's arguments into a short text fragment for inclusion in a turn's relevance text (see [groupHistoryIntoTurns](functions/groupHistoryIntoTurns.md)) — best-effort `JSON.stringify`, truncated, empty on failure (e.g. circular structures) or absent args. |\n| [contentTokens](functions/contentTokens.md) | Extract the \"content word\" tokens of a string for lexical overlap scoring: lowercased alphanumeric runs of length >= 4, deduplicated into a set. Deliberately crude (no stemming, no stopword list beyond the length-4 floor) — this is a cheap, zero-model-call, zero-dependency relevance signal, not a semantic one; the calibration in [RELEVANCE\\_FLOOR\\_MIN](variables/RELEVANCE_FLOOR_MIN.md)/[RELEVANCE\\_FLOOR\\_MAX](variables/RELEVANCE_FLOOR_MAX.md) was run against exactly this scoring function, so changing it invalidates those constants. |\n| [groupHistoryIntoTurns](functions/groupHistoryIntoTurns.md) | Group a flat message history (plus its tool calls) into [HistoryTurn](interfaces/HistoryTurn.md)s: a new turn starts at each message that begins a fresh exchange and closes at the next `'assistant'`-role message (inclusive); every message up to the first turn boundary that has no preceding messages also starts a turn. Tool calls are attributed to the LATEST turn whose first message precedes the call's timestamp. |\n| [relevanceToQuery](functions/relevanceToQuery.md) | What fraction of the QUERY's content words appear in `text` — the relevance of a prior turn to the CURRENT query (not the reverse: a turn need not share all its own content, only enough of the query's). |\n| [scaledRelevanceFloor](functions/scaledRelevanceFloor.md) | Scale the relevance floor between [RELEVANCE\\_FLOOR\\_MIN](variables/RELEVANCE_FLOOR_MIN.md) (empty window, permissive) and [RELEVANCE\\_FLOOR\\_MAX](variables/RELEVANCE_FLOOR_MAX.md) (full window, strict) by a convex curve on window utilization — see [RELEVANCE\\_FLOOR\\_CURVE](variables/RELEVANCE_FLOOR_CURVE.md) for why convex. |\n| [selectNaiveTurns](functions/selectNaiveTurns.md) | The recency (FIFO) baseline: keep the newest turns, oldest-first-dropped, until `historyBudget` is exhausted — walking backward from the newest turn and stopping (WITHOUT including) the first turn that would push the running total over budget. The single newest turn is always kept even if it alone exceeds `historyBudget`. |\n| [selectRelevantTurns](functions/selectRelevantTurns.md) | Select which turns to replay by RELEVANCE to the current query: always keep the most recent `keepRecent` turns, and among the OLDER turns keep any whose [relevanceToQuery](functions/relevanceToQuery.md) score against the query's content words clears a floor that scales with how much of the older-history budget is already spoken for (see [scaledRelevanceFloor](functions/scaledRelevanceFloor.md)). Walks the ENTIRE history — there is no turn-count cap — so a turn from far in the past survives if it is genuinely relevant, which a recency-only policy (see [selectNaiveTurns](functions/selectNaiveTurns.md)) can never do. |\n\n## References\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](../contracts/type-aliases/EstimateTokensFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/argText","title":"Function: argText()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/argText.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/argText","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/argText.md\n---\n\n# Function: argText()\n\n```ts\nfunction argText(args: unknown): string;\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L117)\n\nRender a tool call's arguments into a short text fragment for inclusion in a turn's relevance text\n(see [groupHistoryIntoTurns](groupHistoryIntoTurns.md)) — best-effort `JSON.stringify`, truncated, empty on failure\n(e.g. circular structures) or absent args.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------------------------------------------------------- |\n| `args` | `unknown` | The tool call's arguments, in whatever shape the caller's tool-call record carries. |\n\n## Returns\n\n`string`\n\nA short (<=200 char) text fragment, or an empty string if `args` is nullish or\nunserializable.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/contentTokens","title":"Function: contentTokens()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/contentTokens.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/contentTokens","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/contentTokens.md\n---\n\n# Function: contentTokens()\n\n```ts\nfunction contentTokens(text: string): Set;\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L102)\n\nExtract the \"content word\" tokens of a string for lexical overlap scoring: lowercased alphanumeric\nruns of length >= 4, deduplicated into a set. Deliberately crude (no stemming, no stopword list\nbeyond the length-4 floor) — this is a cheap, zero-model-call, zero-dependency relevance signal, not\na semantic one; the calibration in [RELEVANCE\\_FLOOR\\_MIN](../variables/RELEVANCE_FLOOR_MIN.md)/[RELEVANCE\\_FLOOR\\_MAX](../variables/RELEVANCE_FLOOR_MAX.md) was run\nagainst exactly this scoring function, so changing it invalidates those constants.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------- |\n| `text` | `string` | Text to extract content-word tokens from. |\n\n## Returns\n\n[`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>\n\nThe distinct content words found, lowercased.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/groupHistoryIntoTurns","title":"Function: groupHistoryIntoTurns()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/groupHistoryIntoTurns.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/groupHistoryIntoTurns","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/groupHistoryIntoTurns.md\n---\n\n# Function: groupHistoryIntoTurns()\n\n```ts\nfunction groupHistoryIntoTurns(\n messages: readonly M[],\n toolCalls: readonly TC[],\n): HistoryTurn[];\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L213)\n\nGroup a flat message history (plus its tool calls) into [HistoryTurn](../interfaces/HistoryTurn.md)s: a new turn starts at\neach message that begins a fresh exchange and closes at the next `'assistant'`-role message\n(inclusive); every message up to the first turn boundary that has no preceding messages also starts\na turn. Tool calls are attributed to the LATEST turn whose first message precedes the call's\ntimestamp.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ------------------------------------------------------------------------ | --------------------------------------------------------- |\n| `M` *extends* [`RelevanceMessage`](../interfaces/RelevanceMessage.md) | [`RelevanceMessage`](../interfaces/RelevanceMessage.md) |\n| `TC` *extends* [`RelevanceToolCall`](../interfaces/RelevanceToolCall.md) | [`RelevanceToolCall`](../interfaces/RelevanceToolCall.md) |\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------- | -------------------------------------------------------------------------------------------------------- |\n| `messages` | readonly `M`\\[] | The full flat message history, in chronological order. |\n| `toolCalls` | readonly `TC`\\[] | The full flat tool-call history, in any order (this function sorts by attribution, not the input order). |\n\n## Returns\n\n[`HistoryTurn`](../interfaces/HistoryTurn.md)<`M`, `TC`>\\[]\n\nThe grouped turns, in chronological order.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/relevanceToQuery","title":"Function: relevanceToQuery()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/relevanceToQuery.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/relevanceToQuery","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/relevanceToQuery.md\n---\n\n# Function: relevanceToQuery()\n\n```ts\nfunction relevanceToQuery(\n text: string,\n queryTokens: ReadonlySet,\n): number;\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L135)\n\nWhat fraction of the QUERY's content words appear in `text` — the relevance of a prior turn to the\nCURRENT query (not the reverse: a turn need not share all its own content, only enough of the\nquery's).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------- | ------------------------- | ----------------------------------------------------------------------------- |\n| `text` | `string` | The candidate turn's combined text (see `HistoryTurn.qa`). |\n| `queryTokens` | `ReadonlySet`<`string`> | The current query's content-word set, from [contentTokens](contentTokens.md). |\n\n## Returns\n\n`number`\n\nA fraction in `[0, 1]`; `0` when `queryTokens` is empty (an empty query matches nothing).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/scaledRelevanceFloor","title":"Function: scaledRelevanceFloor()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/scaledRelevanceFloor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/scaledRelevanceFloor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/scaledRelevanceFloor.md\n---\n\n# Function: scaledRelevanceFloor()\n\n```ts\nfunction scaledRelevanceFloor(utilization: number): number;\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L84)\n\nScale the relevance floor between [RELEVANCE\\_FLOOR\\_MIN](../variables/RELEVANCE_FLOOR_MIN.md) (empty window, permissive) and\n[RELEVANCE\\_FLOOR\\_MAX](../variables/RELEVANCE_FLOOR_MAX.md) (full window, strict) by a convex curve on window utilization — see\n[RELEVANCE\\_FLOOR\\_CURVE](../variables/RELEVANCE_FLOOR_CURVE.md) for why convex.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `utilization` | `number` | How full the window already is, as a fraction in `[0, 1]` (values outside the range are clamped). Typically `olderTurnsTokens / historyBudget` — how much of the OLDER-turn budget is already spent by turns kept unconditionally (e.g. the `keepRecent` window). |\n\n## Returns\n\n`number`\n\nThe minimum shared-content-word fraction (see [relevanceToQuery](relevanceToQuery.md)) a turn must clear\nto survive selection at this utilization level.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectNaiveTurns","title":"Function: selectNaiveTurns()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectNaiveTurns.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectNaiveTurns","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectNaiveTurns.md\n---\n\n# Function: selectNaiveTurns()\n\n```ts\nfunction selectNaiveTurns(\n turns: readonly HistoryTurn[],\n historyBudget: number,\n options: SelectNaiveTurnsOptions,\n): HistoryTurn[];\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:354](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L354)\n\nThe recency (FIFO) baseline: keep the newest turns, oldest-first-dropped, until `historyBudget` is\nexhausted — walking backward from the newest turn and stopping (WITHOUT including) the first turn\nthat would push the running total over budget. The single newest turn is always kept even if it\nalone exceeds `historyBudget`.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ------------------------------------------------------------------------ | --------------------------------------------------------- |\n| `M` *extends* [`RelevanceMessage`](../interfaces/RelevanceMessage.md) | [`RelevanceMessage`](../interfaces/RelevanceMessage.md) |\n| `TC` *extends* [`RelevanceToolCall`](../interfaces/RelevanceToolCall.md) | [`RelevanceToolCall`](../interfaces/RelevanceToolCall.md) |\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| `turns` | readonly [`HistoryTurn`](../interfaces/HistoryTurn.md)<`M`, `TC`>\\[] | The full grouped history, chronological. |\n| `historyBudget` | `number` | The token budget to fit turns into, newest-first. |\n| `options` | [`SelectNaiveTurnsOptions`](../interfaces/SelectNaiveTurnsOptions.md) | See [SelectNaiveTurnsOptions](../interfaces/SelectNaiveTurnsOptions.md). |\n\n## Returns\n\n[`HistoryTurn`](../interfaces/HistoryTurn.md)<`M`, `TC`>\\[]\n\nThe surviving turns, in their original chronological order.\n\n## Remarks\n\nThis function exists as an honest COMPARISON BASELINE, not a recommended default — it is the\n\"before\" arm the flagship reference agent's evaluation measured [selectRelevantTurns](selectRelevantTurns.md) against.\nThe evaluation's own honest finding: naive recency is not merely worse in the general case, it can\nCOLLAPSE entirely on a reasoning-heavy model under enough context pressure — one matrix cell\nobserved the naive baseline degrade to keeping essentially nothing useful (effectively `floor 0.08`\n/ `3` turns of real signal) once the window filled, while relevance selection kept answering\ncorrectly at the same pressure. Use `selectRelevantTurns` unless you specifically need a\nrecency-only policy or are reproducing that comparison yourself.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectRelevantTurns","title":"Function: selectRelevantTurns()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectRelevantTurns.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectRelevantTurns","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectRelevantTurns.md\n---\n\n# Function: selectRelevantTurns()\n\n```ts\nfunction selectRelevantTurns(\n turns: readonly HistoryTurn[],\n queryText: string,\n options: SelectRelevantTurnsOptions,\n): HistoryTurn[];\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:295](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L295)\n\nSelect which turns to replay by RELEVANCE to the current query: always keep the most recent\n`keepRecent` turns, and among the OLDER turns keep any whose [relevanceToQuery](relevanceToQuery.md) score against\nthe query's content words clears a floor that scales with how much of the older-history budget is\nalready spoken for (see [scaledRelevanceFloor](scaledRelevanceFloor.md)). Walks the ENTIRE history — there is no\nturn-count cap — so a turn from far in the past survives if it is genuinely relevant, which a\nrecency-only policy (see [selectNaiveTurns](selectNaiveTurns.md)) can never do.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ------------------------------------------------------------------------ | --------------------------------------------------------- |\n| `M` *extends* [`RelevanceMessage`](../interfaces/RelevanceMessage.md) | [`RelevanceMessage`](../interfaces/RelevanceMessage.md) |\n| `TC` *extends* [`RelevanceToolCall`](../interfaces/RelevanceToolCall.md) | [`RelevanceToolCall`](../interfaces/RelevanceToolCall.md) |\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |\n| `turns` | readonly [`HistoryTurn`](../interfaces/HistoryTurn.md)<`M`, `TC`>\\[] | The full grouped history, chronological, from [groupHistoryIntoTurns](groupHistoryIntoTurns.md). |\n| `queryText` | `string` | The current user query (or turn text) to score every older turn against. |\n| `options` | [`SelectRelevantTurnsOptions`](../interfaces/SelectRelevantTurnsOptions.md) | See [SelectRelevantTurnsOptions](../interfaces/SelectRelevantTurnsOptions.md). |\n\n## Returns\n\n[`HistoryTurn`](../interfaces/HistoryTurn.md)<`M`, `TC`>\\[]\n\nThe surviving turns, in their original chronological order.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/HistoryTurn","title":"Interface: HistoryTurn\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/HistoryTurn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/HistoryTurn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/HistoryTurn.md\ndescription: >-\n One grouped conversation turn: the messages from a user message through the\n next assistant message (inclusive), plus any tool calls that occurred during\n it, and `qa` — the turn's full combined text (every message's content plus\n every tool call's `name args` fragment) used for relevance scoring.\n---\n\n# Interface: HistoryTurn\\\n\nDefined in: [src/batteries/context/thrift/relevance.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L185)\n\nOne grouped conversation turn: the messages from a user message through the next assistant message\n(inclusive), plus any tool calls that occurred during it, and `qa` — the turn's full combined text\n(every message's content plus every tool call's `name args` fragment) used for relevance scoring.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ---------------------------------------------------------- | ------------------------------------------- |\n| `M` *extends* [`RelevanceMessage`](RelevanceMessage.md) | [`RelevanceMessage`](RelevanceMessage.md) |\n| `TC` *extends* [`RelevanceToolCall`](RelevanceToolCall.md) | [`RelevanceToolCall`](RelevanceToolCall.md) |\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAt` | `string` | The turn's timestamp, updated to the latest message folded into it — used for `selectNaiveTurns`' recency ordering. | [src/batteries/context/thrift/relevance.ts:194](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L194) |\n| `messages` | `M`\\[] | The messages belonging to this turn, in order. | [src/batteries/context/thrift/relevance.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L196) |\n| `qa` | `string` | The turn's combined text (all message content + `tool argText(args)` fragments), the string [relevanceToQuery](../functions/relevanceToQuery.md) scores against. | [src/batteries/context/thrift/relevance.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L191) |\n| `toolCalls` | `TC`\\[] | The tool calls attributed to this turn (by timestamp — see [groupHistoryIntoTurns](../functions/groupHistoryIntoTurns.md)). | [src/batteries/context/thrift/relevance.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L198) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceMessage","title":"Interface: RelevanceMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceMessage.md\ndescription: >-\n The minimal structural shape of a conversation message this module groups into\n turns. `createdAt` is a lexicographically-sortable timestamp string (e.g.\n ISO-8601) — turns and tool calls are ordered by string comparison\n (`localeCompare`), not parsed into a `Date`, so any consistently-formatted\n sortable string works.\n---\n\n# Interface: RelevanceMessage\n\nDefined in: [src/batteries/context/thrift/relevance.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L156)\n\nThe minimal structural shape of a conversation message this module groups into turns. `createdAt`\nis a lexicographically-sortable timestamp string (e.g. ISO-8601) — turns and tool calls are ordered\nby string comparison (`localeCompare`), not parsed into a `Date`, so any consistently-formatted\nsortable string works.\n\n## Remarks\n\nThis is intentionally a DIFFERENT (simpler) shape than\n[@nhtio/adk/batteries/context/thrift/contracts!WorkingMessage](../../contracts/interfaces/WorkingMessage.md) — turn grouping runs UPSTREAM\nof the subtractive pass, over raw conversation history, before it becomes working-set items. A\ncaller's real message type will usually carry more fields than this; because every function here\naccepts a generic `M extends RelevanceMessage`, extra fields pass through untouched.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | `string` | The message's rendered text, folded into the turn's combined relevance text. | [src/batteries/context/thrift/relevance.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L161) |\n| `createdAt` | `string` | Sortable creation timestamp (e.g. ISO-8601). | [src/batteries/context/thrift/relevance.ts:163](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L163) |\n| `role` | `string` | `'user'`, `'assistant'`, or any other role identifier — an `'assistant'` message closes the current turn (see [groupHistoryIntoTurns](../functions/groupHistoryIntoTurns.md)). | [src/batteries/context/thrift/relevance.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L159) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceToolCall","title":"Interface: RelevanceToolCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceToolCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceToolCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/RelevanceToolCall.md\ndescription: >-\n The minimal structural shape of a tool call this module attaches to the turn\n it occurred in.\n---\n\n# Interface: RelevanceToolCall\n\nDefined in: [src/batteries/context/thrift/relevance.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L169)\n\nThe minimal structural shape of a tool call this module attaches to the turn it occurred in.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `args?` | `unknown` | The call's arguments, rendered via [argText](../functions/argText.md) into the turn's combined relevance text. | [src/batteries/context/thrift/relevance.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L177) |\n| `createdAt` | `string` | Sortable creation timestamp (e.g. ISO-8601), compared against message timestamps to find which turn a call belongs to. | [src/batteries/context/thrift/relevance.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L172) |\n| `tool?` | `string` | The tool's name, folded into the turn's combined relevance text when present. Omit for a call with no resolved tool name yet. | [src/batteries/context/thrift/relevance.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L175) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectNaiveTurnsOptions","title":"Interface: SelectNaiveTurnsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectNaiveTurnsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectNaiveTurnsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectNaiveTurnsOptions.md\ndescription: 'Options for [`selectNaiveTurns`](https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectNaiveTurns).'\n---\n\n# Interface: SelectNaiveTurnsOptions\n\nDefined in: [src/batteries/context/thrift/relevance.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L326)\n\nOptions for [selectNaiveTurns](../functions/selectNaiveTurns.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `encoding?` | `string` | The encoding to measure under. Default: `'cl100k_base'`. | [src/batteries/context/thrift/relevance.ts:330](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L330) |\n| `estimateTokens` | [`EstimateTokensFn`](../../contracts/type-aliases/EstimateTokensFn.md) | REQUIRED. Measures a turn's combined `qa` text's token cost. | [src/batteries/context/thrift/relevance.ts:328](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L328) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectRelevantTurnsOptions","title":"Interface: SelectRelevantTurnsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectRelevantTurnsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectRelevantTurnsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/interfaces/SelectRelevantTurnsOptions.md\ndescription: 'Options for [`selectRelevantTurns`](https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/selectRelevantTurns).'\n---\n\n# Interface: SelectRelevantTurnsOptions\n\nDefined in: [src/batteries/context/thrift/relevance.ts:248](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L248)\n\nOptions for [selectRelevantTurns](../functions/selectRelevantTurns.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `encoding?` | `string` | The encoding to measure under. Default: `'cl100k_base'` (see [@nhtio/adk/batteries/context/thrift/subtractive\\_pass!DEFAULT\\_ENCODING](../../subtractive_pass/variables/DEFAULT_ENCODING.md) for the rationale — this module makes the identical choice for the identical reason). | [src/batteries/context/thrift/relevance.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L257) |\n| `estimateTokens` | [`EstimateTokensFn`](../../contracts/type-aliases/EstimateTokensFn.md) | REQUIRED. Measures a turn's combined `qa` text's token cost. There is no default — this battery ships with no bundled tokenizer. | [src/batteries/context/thrift/relevance.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L253) |\n| `floorCurve?` | `number` | Override for [RELEVANCE\\_FLOOR\\_CURVE](../variables/RELEVANCE_FLOOR_CURVE.md). Same caveat as `floorMin`. | [src/batteries/context/thrift/relevance.ts:279](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L279) |\n| `floorMax?` | `number` | Override for [RELEVANCE\\_FLOOR\\_MAX](../variables/RELEVANCE_FLOOR_MAX.md). Same caveat as `floorMin`. | [src/batteries/context/thrift/relevance.ts:277](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L277) |\n| `floorMin?` | `number` | Override for [RELEVANCE\\_FLOOR\\_MIN](../variables/RELEVANCE_FLOOR_MIN.md). Overriding without re-running the oracle calibration forfeits the calibrated guarantee — see that constant's TSDoc before changing it. | [src/batteries/context/thrift/relevance.ts:275](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L275) |\n| `historyBudget` | `number` | The token budget available for OLDER (non-`keepRecent`) history — used only to compute window UTILIZATION for [scaledRelevanceFloor](../functions/scaledRelevanceFloor.md) (how full is the older-history slice already, before any turns are dropped), not as a hard cap this function enforces itself (that is `subtractToFit`'s job, downstream). A `historyBudget` of `0` scores utilization as `0` (maximally permissive floor). | [src/batteries/context/thrift/relevance.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L272) |\n| `keepRecent?` | `number` | How many of the MOST RECENT turns to always keep regardless of relevance score — coreference (\"it\", \"that file\", \"the one you just showed me\") needs the immediately preceding turns present no matter what a lexical-overlap score says about them. Default: `2`, the flagship reference agent's own calibrated value (`KEEP_RECENT_TURNS`). | [src/batteries/context/thrift/relevance.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L264) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_CURVE","title":"Variable: RELEVANCE\\_FLOOR\\_CURVE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_CURVE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_CURVE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_CURVE.md\ndescription: >-\n The exponent shaping how the relevance floor scales between {@link\n RELEVANCE_FLOOR_MIN} and [`RELEVANCE_FLOOR_MAX`](https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MAX) as window utilization\n rises from 0 to 1 (see [`scaledRelevanceFloor`](https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/functions/scaledRelevanceFloor)).\n---\n\n# Variable: RELEVANCE\\_FLOOR\\_CURVE\n\n```ts\nconst RELEVANCE_FLOOR_CURVE: 2 = 2;\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L71)\n\nThe exponent shaping how the relevance floor scales between [RELEVANCE\\_FLOOR\\_MIN](RELEVANCE_FLOOR_MIN.md) and\n[RELEVANCE\\_FLOOR\\_MAX](RELEVANCE_FLOOR_MAX.md) as window utilization rises from 0 to 1 (see\n[scaledRelevanceFloor](../functions/scaledRelevanceFloor.md)).\n\n## Remarks\n\n`2` — a CONVEX curve (utilization raised to this power) — was chosen deliberately over a linear\nscale: it stays permissive across most of the window's life (older turns keep surviving on weak\noverlap while there's room to spare) and only tightens sharply once the window is GENUINELY filling\nup, rather than progressively squeezing out marginal turns from the very first token of pressure.\nThe convex shape is itself part of what the calibration run validated, not an arbitrary choice.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MAX","title":"Variable: RELEVANCE\\_FLOOR\\_MAX","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MAX.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MAX","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MAX.md\ndescription: >-\n The relevance floor's upper bound — the minimum shared-content-word fraction\n required when the window is nearly full (strict: only keep turns with strong,\n unambiguous overlap).\n---\n\n# Variable: RELEVANCE\\_FLOOR\\_MAX\n\n```ts\nconst RELEVANCE_FLOOR_MAX: 0.43 = 0.43;\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L57)\n\nThe relevance floor's upper bound — the minimum shared-content-word fraction required when the\nwindow is nearly full (strict: only keep turns with strong, unambiguous overlap).\n\n## Remarks\n\nCALIBRATED against the same triple-oracle stress corpus as [RELEVANCE\\_FLOOR\\_MIN](RELEVANCE_FLOOR_MIN.md): the\nhigh-precision floor (precision ≥ 0.9, i.e. \"when in doubt about whether this survives, don't miss\non the side of dropping something the user is about to ask about\") landed BIT-IDENTICAL at\n`0.4286` across all three judge models (gpt-5.5, gemini-3.5-flash, claude-haiku-4.5) — a striking\ncross-model agreement that grounds this as a real property of the corpus, not judge idiosyncrasy.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MIN","title":"Variable: RELEVANCE\\_FLOOR\\_MIN","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MIN.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MIN","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/relevance/variables/RELEVANCE_FLOOR_MIN.md\ndescription: >-\n The relevance floor's lower bound — the minimum fraction of the current\n query's content words a turn must share to be kept, used when the window is\n nearly empty (permissive: keep almost anything that shares ANY real overlap).\n---\n\n# Variable: RELEVANCE\\_FLOOR\\_MIN\n\n```ts\nconst RELEVANCE_FLOOR_MIN: 0.125 = 0.125;\n```\n\nDefined in: [src/batteries/context/thrift/relevance.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/relevance.ts#L44)\n\nThe relevance floor's lower bound — the minimum fraction of the current query's content words a\nturn must share to be kept, used when the window is nearly empty (permissive: keep almost anything\nthat shares ANY real overlap).\n\n## Remarks\n\nCALIBRATED against a relevance oracle over a 94-turn stress corpus, triple-confirmed across three\nmodel families acting as independent judges (gpt-5.5, gemini-3.5-flash, claude-haiku-4.5): the\nF1-optimal floor (best balance of precision and recall when window budget is abundant) landed at\n`0.125` for gpt-5.5 and claude-haiku-4.5 exactly, and `0.111` for gemini-3.5-flash — `0.125` was\nchosen as the shared default (a hair stricter than gemini's number, i.e. slightly more permissive\nthan not, which the calibration run characterized as \"slightly permissive\" rather than\nunder-inclusive — the safer direction to err when the window has room to spare).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass","title":"@nhtio/adk/batteries/context/thrift/subtractive\\_pass","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass.md'\ndescription: 'The subtractive pass — the whole Token Thrift thesis, in code.'\n---\n\n# @nhtio/adk/batteries/context/thrift/subtractive\\_pass\n\nThe subtractive pass — the whole Token Thrift thesis, in code.\n\n## Remarks\n\nA context window is NOT a chat history. It is just what you send for ONE dispatch. So: hold a\nlarge WORKING set (messages, memories, retrievables, thoughts, an image, tools), then SUBTRACT it\ndown to the high-signal slice that fits the active model's window — focus, don't accumulate.\n\nThis module is the model-facing plane only. Where the human-facing chat history lives (a SQLite\nstore, an in-memory array, anything else) is entirely the caller's concern — this battery never\ntouches it. Everything here is window-agnostic: the same function runs at `contextWindow: 4096`\nand `contextWindow: 1_000_000` — the span is a parameter, not a rewrite.\n\nThis is a direct extraction of the flagship reference agent's production subtractive pass\n(evaluated head-to-head across five models — see the battery barrel's TSDoc for the results),\nretargeted at the local structural contracts in\n@nhtio/adk/batteries/context/thrift/contracts so it couples to nothing in `@nhtio/adk`\ncore — every value it reads is duck-typed, and its one true dependency (token estimation) is an\ninjected function, never a bundled tokenizer.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [BucketTrace](interfaces/BucketTrace.md) | A line in the \"what got cut\" trace — one bucket's before/after token weight. |\n| [EstimatorOptions](interfaces/EstimatorOptions.md) | Options shared by every entry point in this module that needs to measure a value's token cost — the injected estimator plus the encoding it measures under. |\n| [SubtractToFitOptions](interfaces/SubtractToFitOptions.md) | Options accepted by [subtractToFit](functions/subtractToFit.md). `estimateTokens` (via [EstimatorOptions](interfaces/EstimatorOptions.md)) is the only option with no default; every other field is a calibrated default, documented on its own declaration below, that a caller can override. |\n| [ThriftTrace](interfaces/ThriftTrace.md) | The full record of one subtractive pass — before/after weights per bucket, and whether the dispatch ultimately fits the budget. |\n| [WorkingSet](interfaces/WorkingSet.md) | The mutable working set a dispatch starts from — the \"everything reasonable\" set this pass subtracts down to what fits. Every field is a local structural type from @nhtio/adk/batteries/context/thrift/contracts — nothing here requires a core ADK value. |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |\n| [DEFAULT\\_ENCODING](variables/DEFAULT_ENCODING.md) | The token encoding this battery measures under, by default. |\n| [DEFAULT\\_RESERVE\\_FRACTION](variables/DEFAULT_RESERVE_FRACTION.md) | Fallback output reserve, as a fraction of the window, used ONLY when the exact max-output budget is unknown. |\n| [DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP](variables/DEFAULT_THIS_TURN_RESULT_KEEP.md) | How many of the NEWEST this-turn tool-result bodies to protect from budget-shedding as a last-resort backstop, by default. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [resolveBudget](functions/resolveBudget.md) | Resolve the per-dispatch INPUT token budget from the ACTIVE model's window: the window minus the room held back for the model's own output. The same call works for a 4K model and a 1M model. |\n| [stripPriorTurnThoughts](functions/stripPriorTurnThoughts.md) | Gemma model card §3 — \"No Thinking Content in History\": thoughts from previous model turns MUST NOT be re-added before the next user turn. Enforced here as a standalone, callable step (not a silent battery-wide flag), because it is also pure thrift: prior-turn reasoning is the highest-volume, lowest-reuse content a working set carries. |\n| [subtractToFit](functions/subtractToFit.md) | The subtractive pass. Start wide; measure every bucket; then shed lowest-signal first until the dispatch fits the active window's budget — the image (the single biggest hog) goes first when it doesn't fit, then tools the turn doesn't need, the tail of the retrieval ranking, low-value memories, the oldest conversation turns. Each cut is by EVIDENCE (a measured bucket), never a guess. If even the floor (system prompt + newest turn) won't fit, the dispatch REFUSES (`fits: false`) — a bounded refusal beats a truncated, incoherent dispatch. |\n\n## References\n\n### EstimateTokensFn\n\nRe-exports [EstimateTokensFn](../contracts/type-aliases/EstimateTokensFn.md)\n\n***\n\n### IsEphemeralMessageFn\n\nRe-exports [IsEphemeralMessageFn](../contracts/type-aliases/IsEphemeralMessageFn.md)\n\n***\n\n### IsSummaryMessageFn\n\nRe-exports [IsSummaryMessageFn](../contracts/type-aliases/IsSummaryMessageFn.md)\n\n***\n\n### RenderToolsFn\n\nRe-exports [RenderToolsFn](../contracts/type-aliases/RenderToolsFn.md)\n\n***\n\n### ShedRankFn\n\nRe-exports [ShedRankFn](../contracts/type-aliases/ShedRankFn.md)\n\n***\n\n### WorkingImage\n\nRe-exports [WorkingImage](../contracts/interfaces/WorkingImage.md)\n\n***\n\n### WorkingMemory\n\nRe-exports [WorkingMemory](../contracts/interfaces/WorkingMemory.md)\n\n***\n\n### WorkingMessage\n\nRe-exports [WorkingMessage](../contracts/interfaces/WorkingMessage.md)\n\n***\n\n### WorkingRetrievable\n\nRe-exports [WorkingRetrievable](../contracts/interfaces/WorkingRetrievable.md)\n\n***\n\n### WorkingThought\n\nRe-exports [WorkingThought](../contracts/interfaces/WorkingThought.md)\n\n***\n\n### WorkingTool\n\nRe-exports [WorkingTool](../contracts/interfaces/WorkingTool.md)\n\n***\n\n### WorkingToolCall\n\nRe-exports [WorkingToolCall](../contracts/interfaces/WorkingToolCall.md)\n\n***\n\n### WorkingToolRegistry\n\nRe-exports [WorkingToolRegistry](../contracts/interfaces/WorkingToolRegistry.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/resolveBudget","title":"Function: resolveBudget()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/resolveBudget.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/resolveBudget","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/resolveBudget.md\n---\n\n# Function: resolveBudget()\n\n```ts\nfunction resolveBudget(\n contextWindow: number,\n outputReserve?: number,\n reserveFraction?: number,\n): number;\n```\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:353](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L353)\n\nResolve the per-dispatch INPUT token budget from the ACTIVE model's window: the window minus the\nroom held back for the model's own output. The same call works for a 4K model and a 1M model.\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| ------------------ | -------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `contextWindow` | `number` | `undefined` | The active model's context window (input + output share it). |\n| `outputReserve?` | `number` | `undefined` | The EXACT number of tokens to hold back for output — pass the generation `maxTokens` the model is configured with. When omitted, falls back to `reserveFraction` of the window (a guess, for callers that don't know the cap). Clamped so the reserve never exceeds the window. |\n| `reserveFraction?` | `number` | `DEFAULT_RESERVE_FRACTION` | The fallback fraction used when `outputReserve` is omitted. Default: [DEFAULT\\_RESERVE\\_FRACTION](../variables/DEFAULT_RESERVE_FRACTION.md). |\n\n## Returns\n\n`number`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/stripPriorTurnThoughts","title":"Function: stripPriorTurnThoughts()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/stripPriorTurnThoughts.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/stripPriorTurnThoughts","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/stripPriorTurnThoughts.md\n---\n\n# Function: stripPriorTurnThoughts()\n\n```ts\nfunction stripPriorTurnThoughts(\n ws: Pick,\n options: EstimatorOptions,\n keepIds?: ReadonlySet,\n): {\n dropped: number;\n tokens: number;\n};\n```\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:386](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L386)\n\nGemma model card §3 — \"No Thinking Content in History\": thoughts from previous model turns MUST\nNOT be re-added before the next user turn. Enforced here as a standalone, callable step (not a\nsilent battery-wide flag), because it is also pure thrift: prior-turn reasoning is the\nhighest-volume, lowest-reuse content a working set carries.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |\n| `ws` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<[`WorkingSet`](../interfaces/WorkingSet.md), `\"thoughts\"`> | A working set exposing (at least) a mutable `thoughts` array; mutated in place. |\n| `options` | [`EstimatorOptions`](../interfaces/EstimatorOptions.md) | The estimator used to measure the tokens reclaimed by dropped thoughts. |\n| `keepIds?` | `ReadonlySet`<`string`> | Thought ids to preserve. |\n\n## Returns\n\n```ts\n{\n dropped: number;\n tokens: number;\n}\n```\n\nHow many thoughts were dropped, and how many tokens that reclaimed.\n\n| Name | Type | Defined in |\n| --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dropped` | `number` | [src/batteries/context/thrift/subtractive\\_pass.ts:390](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L390) |\n| `tokens` | `number` | [src/batteries/context/thrift/subtractive\\_pass.ts:390](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L390) |\n\n## Remarks\n\n`keepIds` is an allow-list of thought ids to PRESERVE — used for e.g. a planner's synthetic\nTHIS-TURN plan thought, which is fresh guidance generated for the current request (NOT prior-turn\nchain-of-thought, and NOT subject to the §3 policy): it must survive into the next dispatch's\nprompt so the model follows the plan. Everything else is dropped.\n\n`subtractToFit` calls this internally as step 1 (gated by its `stripPriorTurnThoughts` option,\ndefault `true`); it is also exported standalone for a caller who wants the strip without running\nthe rest of the pass.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/subtractToFit","title":"Function: subtractToFit()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/subtractToFit.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/subtractToFit","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/subtractToFit.md\n---\n\n# Function: subtractToFit()\n\n```ts\nfunction subtractToFit(\n ws: WorkingSet,\n contextWindow: number,\n relevantToolNames: string[],\n options: SubtractToFitOptions,\n): ThriftTrace;\n```\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L425)\n\nThe subtractive pass. Start wide; measure every bucket; then shed lowest-signal first until the\ndispatch fits the active window's budget — the image (the single biggest hog) goes first when it\ndoesn't fit, then tools the turn doesn't need, the tail of the retrieval ranking, low-value\nmemories, the oldest conversation turns. Each cut is by EVIDENCE (a measured bucket), never a\nguess. If even the floor (system prompt + newest turn) won't fit, the dispatch REFUSES (`fits:\nfalse`) — a bounded refusal beats a truncated, incoherent dispatch.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `ws` | [`WorkingSet`](../interfaces/WorkingSet.md) | The working set to subtract in place. Mutated: `thoughts`, `retrievables`, `memories`, `messages`, `toolCalls`, `image.kept`, and the visible/hidden state of `tools` may all change. |\n| `contextWindow` | `number` | The active model's context window. |\n| `relevantToolNames` | `string`\\[] | The names (from `ws.tools.all()`) that should start VISIBLE for this turn — every other registered tool starts hidden (0 schema tokens, still callable via a catalog). The last-resort shed (step 9) may hide some of these too. |\n| `options` | [`SubtractToFitOptions`](../interfaces/SubtractToFitOptions.md) | See [SubtractToFitOptions](../interfaces/SubtractToFitOptions.md). |\n\n## Returns\n\n[`ThriftTrace`](../interfaces/ThriftTrace.md)\n\n## Remarks\n\n`options.estimateTokens` is REQUIRED — this battery ships with no bundled tokenizer, so a missing\nestimator throws [@nhtio/adk/batteries/context/exceptions!E\\_CONTEXT\\_RESOLVER\\_MISSING](../../../exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md)\nimmediately (naming the option) rather than silently guessing at token counts.\n\n## Throws\n\n[@nhtio/adk/batteries/context/exceptions!E\\_CONTEXT\\_RESOLVER\\_MISSING](../../../exceptions/variables/E_CONTEXT_RESOLVER_MISSING.md) When\n`options.estimateTokens` is not a function.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/BucketTrace","title":"Interface: BucketTrace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/BucketTrace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/BucketTrace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/BucketTrace.md\ndescription: A line in the \"what got cut\" trace — one bucket's before/after token weight.\n---\n\n# Interface: BucketTrace\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L103)\n\nA line in the \"what got cut\" trace — one bucket's before/after token weight.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `afterCount` | `number` | How many items this bucket held after this step ran. | [src/batteries/context/thrift/subtractive\\_pass.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L114) |\n| `afterTokens` | `number` | This bucket's measured token weight after this step ran. | [src/batteries/context/thrift/subtractive\\_pass.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L110) |\n| `beforeCount` | `number` | How many items this bucket held before this step ran. | [src/batteries/context/thrift/subtractive\\_pass.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L112) |\n| `beforeTokens` | `number` | This bucket's measured token weight before this step ran. | [src/batteries/context/thrift/subtractive\\_pass.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L108) |\n| `bucket` | `string` | The bucket's name (e.g. `'thoughts'`, `'tools'`, `'image'`, `'toolCalls'`, `'retrievables'`, `'memories'`, `'messages'`, `'thoughts-shed'`, `'tools-shed'`) — one entry per step of the pass. | [src/batteries/context/thrift/subtractive\\_pass.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L106) |\n| `ids?` | `string`\\[] | Item identifiers affected by this bucket, when the working items expose ids. | [src/batteries/context/thrift/subtractive\\_pass.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L118) |\n| `note?` | `string` | A short human-readable rationale for what this step did (or didn't do), for diagnostics/tracing. | [src/batteries/context/thrift/subtractive\\_pass.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L116) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/EstimatorOptions","title":"Interface: EstimatorOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/EstimatorOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/EstimatorOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/EstimatorOptions.md\ndescription: >-\n Options shared by every entry point in this module that needs to measure a\n value's token cost — the injected estimator plus the encoding it measures\n under.\n---\n\n# Interface: EstimatorOptions\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L188)\n\nOptions shared by every entry point in this module that needs to measure a value's token cost —\nthe injected estimator plus the encoding it measures under.\n\n## Extended by\n\n* [`SubtractToFitOptions`](SubtractToFitOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `encoding?` | `string` | The encoding to measure under. Default: [DEFAULT\\_ENCODING](../variables/DEFAULT_ENCODING.md). | [src/batteries/context/thrift/subtractive\\_pass.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L196) |\n| `estimateTokens` | [`EstimateTokensFn`](../../contracts/type-aliases/EstimateTokensFn.md) | REQUIRED. Measures a rendered string's token cost under `encoding`, optionally resolved against a live dispatch context. There is no default — this battery ships with no bundled tokenizer, so a caller who omits this gets a clear thrown error naming the option, not a silent guess. | [src/batteries/context/thrift/subtractive\\_pass.ts:194](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L194) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/SubtractToFitOptions","title":"Interface: SubtractToFitOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/SubtractToFitOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/SubtractToFitOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/SubtractToFitOptions.md\ndescription: >-\n Options accepted by [`subtractToFit`](https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/functions/subtractToFit). `estimateTokens` (via {@link\n EstimatorOptions}) is the only option with no default; every other field is a\n calibrated default, documented on its own declaration below, that a caller can\n override.\n---\n\n# Interface: SubtractToFitOptions\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L213)\n\nOptions accepted by [subtractToFit](../functions/subtractToFit.md). `estimateTokens` (via [EstimatorOptions](EstimatorOptions.md)) is the\nonly option with no default; every other field is a calibrated default, documented on its own\ndeclaration below, that a caller can override.\n\n## Remarks\n\nEarlier positional-argument forms of this function (as it existed in the flagship reference agent\nthis battery was extracted from) took `outputReserve`, `keepThoughtIds`, `renderTools`,\n`protectThoughtIds`, `renderCtx`, and `protectedToolNames` as seven trailing positional parameters.\nThey are collected here into one options object to keep the call site legible and to give each a\ndocumented default — the mapping from the old positional order to these keys is: position 4 →\n`outputReserve`, 5 → `keepThoughtIds`, 6 → `renderTools`, 7 → `protectThoughtIds`, 8 → `renderCtx`,\n9 → `protectedToolNames`.\n\n## Extends\n\n* [`EstimatorOptions`](EstimatorOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `encoding?` | `string` | The encoding to measure under. Default: [DEFAULT\\_ENCODING](../variables/DEFAULT_ENCODING.md). | [`EstimatorOptions`](EstimatorOptions.md).[`encoding`](EstimatorOptions.md#property-encoding) | [src/batteries/context/thrift/subtractive\\_pass.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L196) |\n| `estimateTokens` | [`EstimateTokensFn`](../../contracts/type-aliases/EstimateTokensFn.md) | REQUIRED. Measures a rendered string's token cost under `encoding`, optionally resolved against a live dispatch context. There is no default — this battery ships with no bundled tokenizer, so a caller who omits this gets a clear thrown error naming the option, not a silent guess. | [`EstimatorOptions`](EstimatorOptions.md).[`estimateTokens`](EstimatorOptions.md#property-estimatetokens) | [src/batteries/context/thrift/subtractive\\_pass.ts:194](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L194) |\n| `isEphemeralMessage?` | [`IsEphemeralMessageFn`](../../contracts/type-aliases/IsEphemeralMessageFn.md) | Decides whether a message is an ephemeral control message (step 6) — re-derived fresh every dispatch iteration, never persisted, so only the LATEST surviving copy carries live information. Default: `(m) => m.id.startsWith('__eph-')`, the flagship reference agent's own convention. A caller with a different (or no) ephemeral-message convention should override this; the default simply never matches when a caller's ids don't use that prefix, degrading step 6 to a no-op. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:300](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L300) |\n| `isSummaryMessage?` | [`IsSummaryMessageFn`](../../contracts/type-aliases/IsSummaryMessageFn.md) | Decides whether a message is a summarizing strategy's load-bearing running summary (step 7) — content that stands in for every older turn that strategy folded away, and so must never be shed like an ordinary old turn even though it renders as the chronologically oldest message. Default: `(m) => m.id === '__compact-summary'`, the flagship reference agent's own convention for its paired summarizing (\"compact\") strategy. Callers who never run a summarizing strategy alongside this battery can ignore this option entirely — the default predicate simply never matches. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L309) |\n| `keepThoughtIds?` | `ReadonlySet`<`string`> | Thought ids to PRESERVE through the prior-turn strip (step 1) — e.g. a planner's synthetic THIS-TURN plan thought, which is fresh guidance generated for the current request (not prior-turn chain-of-thought, and not subject to the §3 policy above). Everything else is dropped when stripping is enabled. Omit to drop every thought when stripping is enabled. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L245) |\n| `outputReserve?` | `number` | The EXACT number of tokens to hold back for the model's own output — pass the generation `maxTokens` the model is configured with. When omitted, falls back to [DEFAULT\\_RESERVE\\_FRACTION](../variables/DEFAULT_RESERVE_FRACTION.md) of the window (a guess, for callers that don't know the cap). Clamped so the reserve never exceeds the window. Forwarded to [resolveBudget](../functions/resolveBudget.md). | - | [src/batteries/context/thrift/subtractive\\_pass.ts:220](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L220) |\n| `protectedToolNames?` | `ReadonlySet`<`string`> | Tool names the caller's CURRENT PLAN has committed to that have NOT yet been called this turn. These are UNSHEDDABLE by the last-resort tool shed (step 9) until every other tool has already shed — removing a plan-committed tool from the visible set leaves the model instructed to call a tool it can no longer see. The protection is bounded: once the tool HAS been called (its result is already in context) it should be dropped from this set by the caller, so it is never a permanent floor. Omit to make every visible tool sheddable on equal footing. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:281](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L281) |\n| `protectThoughtIds?` | `ReadonlySet`<`string`> | Thought ids that must NEVER be shed for budget (step 8) even when the dispatch is over — the this-turn scaffolding the model needs to answer at all (e.g. a plan thought + a citation reinforcement thought). Everything else in the surviving keep-set (per-iteration nudge thoughts, older synthetic guidance) is sheddable oldest-first when the dispatch still doesn't fit. This is a SUBSET of `keepThoughtIds`: `keepThoughtIds` decides what survives the prior-turn strip (step 1); `protectThoughtIds` decides what additionally survives the budget shed (step 8). Omit to make every surviving thought sheddable. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L263) |\n| `renderCtx?` | `unknown` | The live dispatch context, so a DYNAMIC (evaluatable) value's token count reflects the string it will resolve to for THIS dispatch — forwarded as the `ctx` argument to `estimateTokens`. Without it, a dynamic value is measured at its no-`ctx` fallback size, and the budget can disagree with what the caller's own battery ships (an under-count, since evaluated content is typically LARGER than its static form — e.g. an interpolated system prompt). Optional; static content measures identically with or without it. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L272) |\n| `renderTools?` | [`RenderToolsFn`](../../contracts/type-aliases/RenderToolsFn.md) | The caller's tool-declaration renderer. When supplied, the tools bucket is measured against the REAL rendered tool-definitions block (e.g. full JSON-Schema per tool) instead of a `name: description` proxy — the proxy can undercount a schema-heavy tool block by an order of magnitude relative to what actually gets dispatched. Omit to fall back to the proxy (keeps this battery usable standalone, without a real tool-rendering pipeline, e.g. in tests). | - | [src/batteries/context/thrift/subtractive\\_pass.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L253) |\n| `reserveFraction?` | `number` | The fallback reserve fraction used when `outputReserve` is omitted. Default: [DEFAULT\\_RESERVE\\_FRACTION](../variables/DEFAULT_RESERVE_FRACTION.md). Forwarded to [resolveBudget](../functions/resolveBudget.md). | - | [src/batteries/context/thrift/subtractive\\_pass.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L225) |\n| `shedRank?` | [`ShedRankFn`](../../contracts/type-aliases/ShedRankFn.md) | Ranks a tool by last-resort shed priority for step 9 (lower sheds first). Default: a single generic tier — every tool ranks equally, so the shed proceeds in the order `relevantToolNames` listed them (a stable sort preserves input order when every rank ties). This battery has no domain knowledge of which of a caller's tools are cheap-to-lose \"gather\" tools versus load-bearing \"delivery\" tools, so it does not guess a tiering. A caller WHO DOES have that knowledge (as the flagship reference agent does — it ranks ~90 known tool names into seven tiers, sheds its `provide_answer` tool before its core artifact readers, etc.) should inject a `ShedRankFn` that encodes it; see [ShedRankFn](../../contracts/type-aliases/ShedRankFn.md) for the contract. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:292](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L292) |\n| `stripPriorTurnThoughts?` | `boolean` | Whether to apply the prior-turn thought strip (step 1) at all. Default `true`. **Remarks** The default is driven by Gemma's model card §3, \"No Thinking Content in History\": thoughts from previous model turns must not be re-added before the next user turn. This is also pure thrift — prior-turn reasoning is the highest-volume, lowest-reuse content there is, Gemma or not — so the default stays `true` even for callers on a different model family; a caller whose model genuinely benefits from replaying its own prior chain-of-thought (uncommon) can set this `false` to skip the strip entirely and let every thought flow into the later per-thought budget shed (step 8) instead. | - | [src/batteries/context/thrift/subtractive\\_pass.ts:238](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L238) |\n| `thisTurnResultKeep?` | `number` | How many of the NEWEST this-turn tool-result bodies the newest-N backstop (step 3b) protects from shedding once ordinary prior-turn shedding is exhausted and the dispatch still doesn't fit. Default: [DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP](../variables/DEFAULT_THIS_TURN_RESULT_KEEP.md). | - | [src/batteries/context/thrift/subtractive\\_pass.ts:315](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L315) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/ThriftTrace","title":"Interface: ThriftTrace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/ThriftTrace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/ThriftTrace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/ThriftTrace.md\ndescription: >-\n The full record of one subtractive pass — before/after weights per bucket, and\n whether the dispatch ultimately fits the budget.\n---\n\n# Interface: ThriftTrace\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L123)\n\nThe full record of one subtractive pass — before/after weights per bucket, and whether the\ndispatch ultimately fits the budget.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buckets` | [`BucketTrace`](BucketTrace.md)\\[] | One entry per step of the pass, in the order the steps ran, for diagnostics/tracing. | [src/batteries/context/thrift/subtractive\\_pass.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L140) |\n| `budget` | `number` | The INPUT token budget — `contextWindow - reserve`. | [src/batteries/context/thrift/subtractive\\_pass.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L129) |\n| `contextWindow` | `number` | The active model's context window this pass was run against. | [src/batteries/context/thrift/subtractive\\_pass.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L125) |\n| `fits` | `boolean` | Whether `totalAfter` fits within `budget`. | [src/batteries/context/thrift/subtractive\\_pass.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L135) |\n| `refused` | `boolean` | The dispatch should be refused: `!fits` — even after every possible shed, the irreducible floor (system prompt + standing instructions + newest turn + output reserve) still exceeds the window. | [src/batteries/context/thrift/subtractive\\_pass.ts:138](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L138) |\n| `reserve` | `number` | Tokens held back for the model's own output (see [resolveBudget](../functions/resolveBudget.md)). | [src/batteries/context/thrift/subtractive\\_pass.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L127) |\n| `totalAfter` | `number` | Total measured token weight AFTER every shedding step ran. | [src/batteries/context/thrift/subtractive\\_pass.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L133) |\n| `totalBefore` | `number` | Total measured token weight BEFORE any shedding (the \"everything reasonable\" starting point). | [src/batteries/context/thrift/subtractive\\_pass.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L131) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/WorkingSet","title":"Interface: WorkingSet","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/WorkingSet.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/WorkingSet","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/interfaces/WorkingSet.md\ndescription: >-\n The mutable working set a dispatch starts from — the \"everything reasonable\"\n set this pass subtracts down to what fits. Every field is a local structural\n type from {@link @nhtio/adk/batteries/context/thrift/contracts} — nothing here\n requires a core ADK value.\n---\n\n# Interface: WorkingSet\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L146)\n\nThe mutable working set a dispatch starts from — the \"everything reasonable\" set this pass\nsubtracts down to what fits. Every field is a local structural type from\n@nhtio/adk/batteries/context/thrift/contracts — nothing here requires a core ADK value.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------ | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `image?` | [`WorkingImage`](../../contracts/interfaces/WorkingImage.md) | Optional image (or other flat-cost media) attachment. The single biggest token hog. | [src/batteries/context/thrift/subtractive\\_pass.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L181) |\n| `memories` | [`WorkingMemory`](../../contracts/interfaces/WorkingMemory.md)\\[] | Durable memories available to this dispatch — sheds lowest-`importance` first (step 5). | [src/batteries/context/thrift/subtractive\\_pass.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L162) |\n| `messages` | [`WorkingMessage`](../../contracts/interfaces/WorkingMessage.md)\\[] | The conversation history this dispatch would replay — sheds stale ephemeral control messages first (step 6), then the oldest turns (step 7); the newest turn is always kept. | [src/batteries/context/thrift/subtractive\\_pass.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L160) |\n| `retrievables` | [`WorkingRetrievable`](../../contracts/interfaces/WorkingRetrievable.md)\\[] | Retrieved (RAG) passages available to this dispatch — sheds the tail of the ranking (lowest `score`) first (step 4), keeping the best-ranked chunks. | [src/batteries/context/thrift/subtractive\\_pass.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L165) |\n| `standingInstructions?` | (`string` | [`ContentLike`](../../contracts/interfaces/ContentLike.md))\\[] | Durable directives the caller renders into every dispatch (the caller's battery counts these too). They are a FIXED cost like the system prompt — never shed — so the pass only ADDS them to the running total, never trims them. Omit (or pass an empty array) when the caller uses none. A consumer that DOES render standing instructions must pass them here or thrift would undercount relative to the caller's own guard. | [src/batteries/context/thrift/subtractive\\_pass.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L157) |\n| `systemPrompt` | `string` | [`ContentLike`](../../contracts/interfaces/ContentLike.md) | The dispatch's system prompt. Measured ctx-resolved (see [subtractToFit](../functions/subtractToFit.md)'s `renderCtx` option) to match what a caller's own overflow guard counts. | [src/batteries/context/thrift/subtractive\\_pass.ts:149](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L149) |\n| `thoughts` | [`WorkingThought`](../../contracts/interfaces/WorkingThought.md)\\[] | Model-internal guidance content (plans, per-iteration nudges, and — unless `stripPriorTurnThoughts` is disabled — prior-turn chain-of-thought, dropped in step 1). Surviving thoughts are sheddable oldest-first as a last resort (step 8), except any ids named in `protectThoughtIds`. | [src/batteries/context/thrift/subtractive\\_pass.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L170) |\n| `toolCalls?` | [`WorkingToolCall`](../../contracts/interfaces/WorkingToolCall.md)\\[] | Prior-turn (and this-turn) tool calls whose RENDERED RESULTS the caller puts in the prompt. Omit (or pass an empty array) when the caller doesn't measure them — the pass then treats tool-result weight as `0`. | [src/batteries/context/thrift/subtractive\\_pass.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L179) |\n| `tools` | [`WorkingToolRegistry`](../../contracts/interfaces/WorkingToolRegistry.md) | The tool registry this dispatch draws visible tools from — mutated via `setHidden` as tools are shed (steps 2 and 9). | [src/batteries/context/thrift/subtractive\\_pass.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L173) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_ENCODING","title":"Variable: DEFAULT\\_ENCODING","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_ENCODING.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_ENCODING","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_ENCODING.md\ndescription: 'The token encoding this battery measures under, by default.'\n---\n\n# Variable: DEFAULT\\_ENCODING\n\n```ts\nconst DEFAULT_ENCODING: \"cl100k_base\" = \"cl100k_base\";\n```\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L74)\n\nThe token encoding this battery measures under, by default.\n\n## Remarks\n\n`'cl100k_base'` — a widely-available, model-agnostic tiktoken encoding — is the default because\nthis battery is core-agnostic: unlike the flagship reference agent it was extracted from (which\nhard-codes the `gemma` encoding because its engine IS Gemma via LiteRT-LM), this battery has no\nopinion on which model you run. `cl100k_base` is a reasonable, broadly-supported baseline for a\ncaller who hasn't thought about encodings yet; a caller running Gemma, Claude, or any other model\nwith a distinct tokenizer should pass their own `encoding` (and a matching [EstimateTokensFn](../../contracts/type-aliases/EstimateTokensFn.md))\nso the budget math agrees with what their model/battery actually counts. The encoding identifier is\nan opaque string as far as this module is concerned — it is never validated or interpreted here,\nonly threaded through to the injected [EstimateTokensFn](../../contracts/type-aliases/EstimateTokensFn.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_RESERVE_FRACTION","title":"Variable: DEFAULT\\_RESERVE\\_FRACTION","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_RESERVE_FRACTION.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_RESERVE_FRACTION","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_RESERVE_FRACTION.md\ndescription: >-\n Fallback output reserve, as a fraction of the window, used ONLY when the exact\n max-output budget is unknown.\n---\n\n# Variable: DEFAULT\\_RESERVE\\_FRACTION\n\n```ts\nconst DEFAULT_RESERVE_FRACTION: 0.35 = 0.35;\n```\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L87)\n\nFallback output reserve, as a fraction of the window, used ONLY when the exact max-output budget is\nunknown.\n\n## Remarks\n\nPrefer passing the caller's actual generation `maxTokens` as `outputReserve` — reserving a flat\nfraction of the window when the model can emit at most, say, 2048 tokens throws away real input\nbudget (RAG chunks, history) for output that can never be produced. This fraction is the calibrated\nvalue from the flagship reference agent (0.35 of the window), kept as the default for a caller who\ngenuinely doesn't know their generation cap yet.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_THIS_TURN_RESULT_KEEP","title":"Variable: DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_THIS_TURN_RESULT_KEEP.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_THIS_TURN_RESULT_KEEP","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/context/thrift/subtractive_pass/variables/DEFAULT_THIS_TURN_RESULT_KEEP.md\ndescription: >-\n How many of the NEWEST this-turn tool-result bodies to protect from\n budget-shedding as a last-resort backstop, by default.\n---\n\n# Variable: DEFAULT\\_THIS\\_TURN\\_RESULT\\_KEEP\n\n```ts\nconst DEFAULT_THIS_TURN_RESULT_KEEP: 3 = 3;\n```\n\nDefined in: [src/batteries/context/thrift/subtractive\\_pass.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/context/thrift/subtractive_pass.ts#L100)\n\nHow many of the NEWEST this-turn tool-result bodies to protect from budget-shedding as a\nlast-resort backstop, by default.\n\n## Remarks\n\nA normal read→answer turn produces 1–2 this-turn results, so `N = 3` leaves the common case\nuntouched; a deep read-loop (several searches/reads in one turn) that piles up more can shed its\nOLDEST bodies past this cap (the model has moved past them by the time it has made this many\ncalls). The single newest this-turn result is always kept regardless of this cap — see\n[subtractToFit](../functions/subtractToFit.md)'s step 3b.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools","title":"@nhtio/adk/batteries/dev-tools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools.md'\ndescription: Typed development-editing pipeline contracts and factory.\n---\n\n# @nhtio/adk/batteries/dev-tools\n\nTyped development-editing pipeline contracts and factory.\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [CheckCapability](interfaces/CheckCapability.md) | A checker capability declaration. |\n| [CheckRequest](interfaces/CheckRequest.md) | Request passed to a checker. |\n| [DevCandidate](interfaces/DevCandidate.md) | A candidate exposed to selection middleware. |\n| [DevCapabilityProbe](interfaces/DevCapabilityProbe.md) | A synchronous declaration-only capability probe. |\n| [DevChain](interfaces/DevChain.md) | Chainable development plan builder. |\n| [DevEngine](interfaces/DevEngine.md) | A self-declaring development engine. |\n| [DevFileAccess](interfaces/DevFileAccess.md) | Narrow filesystem façade granted to in-place capabilities. |\n| [DevGateCall](interfaces/DevGateCall.md) | Description of the step presented to a gate. |\n| [DevGateContext](interfaces/DevGateContext.md) | Context supplied to a development-tools gate. |\n| [DevPipeline](interfaces/DevPipeline.md) | Development pipeline callable and its front ends. |\n| [DevPlan](interfaces/DevPlan.md) | Development plan. |\n| [DevResult](interfaces/DevResult.md) | The composite result of a development-tools execution. |\n| [DevSelectionContext](interfaces/DevSelectionContext.md) | Selection middleware context. |\n| [DevStep](interfaces/DevStep.md) | Development plan step. |\n| [DevStepContext](interfaces/DevStepContext.md) | Step middleware context. |\n| [DevWorkspace](interfaces/DevWorkspace.md) | Mutable workspace state passed to step middleware. |\n| [DevWorkspaceToken](interfaces/DevWorkspaceToken.md) | Opaque provenance token for one workspace value. Tokens are runtime-minted and unique per execution and persistence point, so a short-circuit cannot restore a stale or foreign workspace. |\n| [Diagnostic](interfaces/Diagnostic.md) | A diagnostic returned by the pipeline. |\n| [FileChangeSummary](interfaces/FileChangeSummary.md) | A summary row for one final workspace change. |\n| [FormatCapability](interfaces/FormatCapability.md) | A formatter capability declaration. |\n| [FormatRequest](interfaces/FormatRequest.md) | Request passed to a formatter. |\n| [LintCapability](interfaces/LintCapability.md) | A linter capability declaration. |\n| [LintRequest](interfaces/LintRequest.md) | Request passed to a linter. |\n| [RawDiagnostic](interfaces/RawDiagnostic.md) | A diagnostic returned by an engine before runtime provenance is added. |\n| [RunOptions](interfaces/RunOptions.md) | Execution options. |\n| [WorkspaceBounds](interfaces/WorkspaceBounds.md) | Workspace resource limits. |\n| [WorkspaceDelta](interfaces/WorkspaceDelta.md) | The common result of every engine capability. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------- | -------------------------------------------------------- |\n| [DevGateFn](type-aliases/DevGateFn.md) | Gate callback used by the pipeline. |\n| [DevGateVerdict](type-aliases/DevGateVerdict.md) | Gate verdict; omission or approval permits the step. |\n| [DevOp](type-aliases/DevOp.md) | Operation-shaped plan input. |\n| [DevSelectionMiddlewareFn](type-aliases/DevSelectionMiddlewareFn.md) | Selection middleware callback. |\n| [DevStepMiddlewareFn](type-aliases/DevStepMiddlewareFn.md) | Step middleware callback. |\n| [Severity](type-aliases/Severity.md) | Diagnostic severity, ordered from most to least serious. |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | ----------------------------------------------------------- |\n| [E\\_DEV\\_BAD\\_ARG](variables/E_DEV_BAD_ARG.md) | Invalid development-step argument. |\n| [E\\_DEV\\_ENGINE\\_REQUIRED](variables/E_DEV_ENGINE_REQUIRED.md) | A requested engine capability is not configured. |\n| [E\\_DEV\\_GATE\\_DECLINED](variables/E_DEV_GATE_DECLINED.md) | A gate declined a step. |\n| [E\\_DEV\\_STEP\\_FAILED](variables/E_DEV_STEP_FAILED.md) | A development step failed during execution or validation. |\n| [E\\_DEV\\_STEP\\_UNAVAILABLE](variables/E_DEV_STEP_UNAVAILABLE.md) | A step implementation is not available. |\n| [E\\_DEV\\_UNKNOWN\\_STEP](variables/E_DEV_UNKNOWN_STEP.md) | Unknown development step. |\n| [E\\_DEV\\_WORKSPACE\\_BOUNDS](variables/E_DEV_WORKSPACE_BOUNDS.md) | Workspace bounds were exceeded. |\n| [E\\_INVALID\\_DEV\\_PIPELINE\\_CONFIG](variables/E_INVALID_DEV_PIPELINE_CONFIG.md) | Fatal configuration error for a development-tools pipeline. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------- | ----------------------------------------- |\n| [createDevPipeline](functions/createDevPipeline.md) | Construct a development-editing pipeline. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/conformance","title":"@nhtio/adk/batteries/dev-tools/conformance","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/conformance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/conformance","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/conformance.md'\ndescription: Development-tools conformance surface.\n---\n\n# @nhtio/adk/batteries/dev-tools/conformance\n\nDevelopment-tools conformance surface.\n\n## References\n\n### ConformanceMutations\n\nRe-exports [ConformanceMutations](../../sandbox/interfaces/ConformanceMutations.md)\n\n***\n\n### runSandboxConformance\n\nRe-exports [runSandboxConformance](../../sandbox/functions/runSandboxConformance.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge","title":"@nhtio/adk/batteries/dev-tools/forge","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/forge.md'\ndescription: Agent glue for the structured development-tools surface.\n---\n\n# @nhtio/adk/batteries/dev-tools/forge\n\nAgent glue for the structured development-tools surface.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |\n| [ForgeDevToolsOptions](interfaces/ForgeDevToolsOptions.md) | Configuration for [forgeDevTools](functions/forgeDevTools.md). The pipeline owns approval; the forge never gates. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------- | ---------------------------------------------------------------- |\n| [forgeDevTools](functions/forgeDevTools.md) | Forge model-facing tools over a configured development pipeline. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge/functions/forgeDevTools","title":"Function: forgeDevTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge/functions/forgeDevTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge/functions/forgeDevTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/forge/functions/forgeDevTools.md\n---\n\n# Function: forgeDevTools()\n\n```ts\nfunction forgeDevTools(\n pipeline: DevPipeline,\n options: ForgeDevToolsOptions,\n): Record;\n```\n\nDefined in: [src/batteries/dev\\_tools/forge.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/forge.ts#L53)\n\nForge model-facing tools over a configured development pipeline.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | --------------------------------------------------------------- |\n| `pipeline` | [`DevPipeline`](../../interfaces/DevPipeline.md) |\n| `options` | [`ForgeDevToolsOptions`](../interfaces/ForgeDevToolsOptions.md) |\n\n## Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Tool`](../../../../forge/classes/Tool.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge/interfaces/ForgeDevToolsOptions","title":"Interface: ForgeDevToolsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge/interfaces/ForgeDevToolsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/forge/interfaces/ForgeDevToolsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/forge/interfaces/ForgeDevToolsOptions.md\ndescription: >-\n Configuration for [`forgeDevTools`](https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/forge/functions/forgeDevTools). The pipeline owns approval; the forge\n never gates.\n---\n\n# Interface: ForgeDevToolsOptions\n\nDefined in: [src/batteries/dev\\_tools/forge.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/forge.ts#L9)\n\nConfiguration for [forgeDevTools](../functions/forgeDevTools.md). The pipeline owns approval; the forge never gates.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `overrides?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, { `description?`: `string`; `name?`: `string`; }> | Optional names and descriptions keyed by their default tool name. | [src/batteries/dev\\_tools/forge.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/forge.ts#L13) |\n| `surface` | `\"composite\"` | `\"granular\"` | Select the single composite tool or the stateless per-step tools. | [src/batteries/dev\\_tools/forge.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/forge.ts#L11) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/functions/createDevPipeline","title":"Function: createDevPipeline()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/functions/createDevPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/functions/createDevPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/functions/createDevPipeline.md\n---\n\n# Function: createDevPipeline()\n\n```ts\nfunction createDevPipeline(config: DevPipelineConfig): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/index.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/index.ts#L259)\n\nConstruct a development-editing pipeline.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------- |\n| `config` | `DevPipelineConfig` |\n\n## Returns\n\n`Promise`<[`DevPipeline`](../interfaces/DevPipeline.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckCapability","title":"Interface: CheckCapability","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckCapability.md\ndescription: A checker capability declaration.\n---\n\n# Interface: CheckCapability\n\nDefined in: [src/batteries/dev\\_tools/types.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L120)\n\nA checker capability declaration.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `extensions` | readonly `string`\\[] | Extensions participating in this selection pass. | [src/batteries/dev\\_tools/types.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L122) |\n\n## Methods\n\n### check()\n\n```ts\ncheck(request: CheckRequest): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L124)\n\nChecks the whole workspace and returns diagnostics; checks do not receive mutation access.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------- |\n| `request` | [`CheckRequest`](CheckRequest.md) |\n\n#### Returns\n\n`Promise`<[`WorkspaceDelta`](WorkspaceDelta.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckRequest","title":"Interface: CheckRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/CheckRequest.md\ndescription: Request passed to a checker.\n---\n\n# Interface: CheckRequest\n\nDefined in: [src/batteries/dev\\_tools/types.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L158)\n\nRequest passed to a checker.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------- | ------------------------------------------ | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `files` | `ReadonlyMap`<`string`, `WorkspaceFile`> | Current mutable workspace file map. | [src/batteries/dev\\_tools/types.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L160) |\n| `root` | `string` | Absolute host workspace root used as the subprocess working directory. | [src/batteries/dev\\_tools/types.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L162) |\n| `signal?` | `AbortSignal` | Optional cancellation signal. | [src/batteries/dev\\_tools/types.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L164) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCandidate","title":"Interface: DevCandidate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCandidate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCandidate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCandidate.md\ndescription: A candidate exposed to selection middleware.\n---\n\n# Interface: DevCandidate\n\nDefined in: [src/batteries/dev\\_tools/types.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L247)\n\nA candidate exposed to selection middleware.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `capabilityIndex` | `number` | Original declaration-array index, retained across capability omission so identity stays stable. | [src/batteries/dev\\_tools/types.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L251) |\n| `engineId` | `string` | Stable engine identity used to attribute findings and selection decisions. | [src/batteries/dev\\_tools/types.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L249) |\n| `extensions` | readonly `string`\\[] | Extensions participating in this selection pass. | [src/batteries/dev\\_tools/types.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L253) |\n| `inPlace` | `boolean` | Whether the selected capability requires the in-place façade. | [src/batteries/dev\\_tools/types.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L255) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCapabilityProbe","title":"Interface: DevCapabilityProbe","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCapabilityProbe.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCapabilityProbe","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevCapabilityProbe.md\ndescription: A synchronous declaration-only capability probe.\n---\n\n# Interface: DevCapabilityProbe\n\nDefined in: [src/batteries/dev\\_tools/types.ts:6](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L6)\n\nA synchronous declaration-only capability probe.\n\n## Methods\n\n### hasCheck()\n\n```ts\nhasCheck(extension?: string): boolean;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L12)\n\nWhether a check capability is declared for an extension.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | -------- |\n| `extension?` | `string` |\n\n#### Returns\n\n`boolean`\n\n***\n\n### hasFormat()\n\n```ts\nhasFormat(extension?: string): boolean;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L8)\n\nWhether a format capability is declared for an extension.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | -------- |\n| `extension?` | `string` |\n\n#### Returns\n\n`boolean`\n\n***\n\n### hasLint()\n\n```ts\nhasLint(extension?: string): boolean;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L10)\n\nWhether a lint capability is declared for an extension.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | -------- |\n| `extension?` | `string` |\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevChain","title":"Interface: DevChain","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevChain.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevChain","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevChain.md'\ndescription: Chainable development plan builder.\n---\n\n# Interface: DevChain\n\nDefined in: [src/batteries/dev\\_tools/types.ts:327](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L327)\n\nChainable development plan builder.\n\n## Extends\n\n* `PromiseLike`<[`DevResult`](DevResult.md)>\n\n## Methods\n\n### applyPatch()\n\n```ts\napplyPatch(args: {\n patch: string;\n}): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:333](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L333)\n\nAppend a structured patch step.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | ------------------------ |\n| `args` | { `patch`: `string`; } |\n| `args.patch` | `string` |\n\n#### Returns\n\n`DevChain`\n\n***\n\n### check()\n\n```ts\ncheck(): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:341](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L341)\n\nAppend a whole-workspace checker step.\n\n#### Returns\n\n`DevChain`\n\n***\n\n### edit()\n\n```ts\nedit(args: {\n edits: readonly {\n find: string;\n replace: string;\n }[];\n path: string;\n}): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:331](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L331)\n\nAppend deterministic find-and-replace edits to the plan.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | ----------------------------------------------------------------------------------------- |\n| `args` | { `edits`: readonly { `find`: `string`; `replace`: `string`; }\\[]; `path`: `string`; } |\n| `args.edits` | readonly { `find`: `string`; `replace`: `string`; }\\[] |\n| `args.path` | `string` |\n\n#### Returns\n\n`DevChain`\n\n***\n\n### format()\n\n```ts\nformat(args?: {\n paths?: readonly string[];\n}): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L337)\n\nAppend a formatter step.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | ------------------------------------ |\n| `args?` | { `paths?`: readonly `string`\\[]; } |\n| `args.paths?` | readonly `string`\\[] |\n\n#### Returns\n\n`DevChain`\n\n***\n\n### lint()\n\n```ts\nlint(args?: {\n fix?: boolean;\n paths?: readonly string[];\n}): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:339](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L339)\n\nAppend a linter step, optionally granting fix permission.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | ------------------------------------------------------- |\n| `args?` | { `fix?`: `boolean`; `paths?`: readonly `string`\\[]; } |\n| `args.fix?` | `boolean` |\n| `args.paths?` | readonly `string`\\[] |\n\n#### Returns\n\n`DevChain`\n\n***\n\n### readLines()\n\n```ts\nreadLines(args: {\n end?: number;\n label?: string;\n path: string;\n start: number;\n}): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L329)\n\nAppend a line-reading step; label is lifted to the operation metadata.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------------------------------------------------------------------------------- |\n| `args` | { `end?`: `number`; `label?`: `string`; `path`: `string`; `start`: `number`; } |\n| `args.end?` | `number` |\n| `args.label?` | `string` |\n| `args.path` | `string` |\n| `args.start` | `number` |\n\n#### Returns\n\n`DevChain`\n\n***\n\n### run()\n\n```ts\nrun(options?: RunOptions): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:343](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L343)\n\nExecute this immutable chain, overriding its open-time options when supplied.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | ----------------------------- |\n| `options?` | [`RunOptions`](RunOptions.md) |\n\n#### Returns\n\n`Promise`<[`DevResult`](DevResult.md)>\n\n***\n\n### toOps()\n\n```ts\ntoOps(): DevOp[];\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:345](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L345)\n\nReturn the serializable operations currently held by this chain.\n\n#### Returns\n\n[`DevOp`](../type-aliases/DevOp.md)\\[]\n\n***\n\n### write()\n\n```ts\nwrite(args?: {\n paths?: readonly string[];\n}): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L335)\n\nAppend the persistence step, optionally restricted to normalized paths.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | ------------------------------------ |\n| `args?` | { `paths?`: readonly `string`\\[]; } |\n| `args.paths?` | readonly `string`\\[] |\n\n#### Returns\n\n`DevChain`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevEngine","title":"Interface: DevEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevEngine","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevEngine.md'\ndescription: A self-declaring development engine.\n---\n\n# Interface: DevEngine\n\nDefined in: [src/batteries/dev\\_tools/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L127)\n\nA self-declaring development engine.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ---------------------------------------- | ---------- | ---------------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `checks?` | `readonly` | readonly [`CheckCapability`](CheckCapability.md)\\[] | Checker declarations relevant to the workspace. | [src/batteries/dev\\_tools/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L135) |\n| `formats?` | `readonly` | readonly [`FormatCapability`](FormatCapability.md)\\[] | Formatter declarations in declaration order. | [src/batteries/dev\\_tools/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L131) |\n| `id` | `readonly` | `string` | Unique stable identifier used in diagnostics and candidate identity. | [src/batteries/dev\\_tools/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L129) |\n| `lints?` | `readonly` | readonly [`LintCapability`](LintCapability.md)\\[] | Linter declarations in declaration order. | [src/batteries/dev\\_tools/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L133) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevFileAccess","title":"Interface: DevFileAccess","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevFileAccess.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevFileAccess","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevFileAccess.md\ndescription: Narrow filesystem façade granted to in-place capabilities.\n---\n\n# Interface: DevFileAccess\n\nDefined in: [src/batteries/dev\\_tools/types.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L167)\n\nNarrow filesystem façade granted to in-place capabilities.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------- | ---------- | ------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `scope` | `readonly` | readonly `string`\\[] | Concrete allowlist enforced for this invocation, after selector narrowing and dirty-path withholding. | [src/batteries/dev\\_tools/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L181) |\n\n## Methods\n\n### delete()\n\n```ts\ndelete(path: string): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L173)\n\nDeletes an authorized file; availability is controlled by the declared `needs` set.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### exists()\n\n```ts\nexists(path: string): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L179)\n\nProbes whether an authorized create target exists; stat failures return false.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`boolean`>\n\n***\n\n### mkdir()\n\n```ts\nmkdir(path: string): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L177)\n\nCreates an authorized directory and parents when `mkdir` was declared.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### read()\n\n```ts\nread(path: string): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L169)\n\nReads an authorized workspace-relative file through the façade.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`string`>\n\n***\n\n### rename()\n\n```ts\nrename(from: string, to: string): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L175)\n\nMoves an authorized source to an absent, authorized destination.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `from` | `string` |\n| `to` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### write()\n\n```ts\nwrite(path: string, text: string): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L171)\n\nWrites an existing authorized file or creates an absent, glob-authorized file.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n| `text` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateCall","title":"Interface: DevGateCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateCall.md\ndescription: Description of the step presented to a gate.\n---\n\n# Interface: DevGateCall\n\nDefined in: [src/batteries/dev\\_tools/types.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L224)\n\nDescription of the step presented to a gate.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | `unknown` | Validated arguments exactly as authored by the caller. | [src/batteries/dev\\_tools/types.ts:228](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L228) |\n| `engines?` | readonly { `engineId`: `string`; `extensions`: readonly `string`\\[]; `inPlace`: `boolean`; `scope?`: readonly `string`\\[]; }\\[] | Capability declarations that will actually participate in the step. | [src/batteries/dev\\_tools/types.ts:234](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L234) |\n| `mayCreate?` | readonly `string`\\[] | Glob envelope under which the step may create files. | [src/batteries/dev\\_tools/types.ts:232](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L232) |\n| `step` | `string` | Name of the step being approved. | [src/batteries/dev\\_tools/types.ts:226](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L226) |\n| `targets?` | readonly `string`\\[] | Resolved existing paths the step will touch. | [src/batteries/dev\\_tools/types.ts:230](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L230) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateContext","title":"Interface: DevGateContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevGateContext.md\ndescription: Context supplied to a development-tools gate.\n---\n\n# Interface: DevGateContext\n\nDefined in: [src/batteries/dev\\_tools/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L217)\n\nContext supplied to a development-tools gate.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `abortSignal?` | `AbortSignal` | Optional cancellation signal for gate decisions. | [src/batteries/dev\\_tools/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L219) |\n| `waitFor?` | [`OpenGateFn`](../../../turn_runner/type-aliases/OpenGateFn.md) | Optional suspension function; an omitted one is synthesized as a rejecting function. | [src/batteries/dev\\_tools/types.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L221) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPipeline","title":"Interface: DevPipeline()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPipeline.md\ndescription: Development pipeline callable and its front ends.\n---\n\n# Interface: DevPipeline()\n\nDefined in: [src/batteries/dev\\_tools/types.ts:348](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L348)\n\nDevelopment pipeline callable and its front ends.\n\n```ts\nDevPipeline(paths: readonly string[], options?: RunOptions): DevChain;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:350](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L350)\n\nStarts an immutable chain for the acquired paths.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ----------------------------- |\n| `paths` | readonly `string`\\[] |\n| `options?` | [`RunOptions`](RunOptions.md) |\n\n## Returns\n\n[`DevChain`](DevChain.md)\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------- | ---------- | -------------------------------------- | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `capabilities` | `readonly` | `DevEngineRegistry` | Declaration-only registry used for capability selection. | [src/batteries/dev\\_tools/types.ts:356](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L356) |\n| `engines` | `readonly` | readonly [`DevEngine`](DevEngine.md)\\[] | Resolved engines in deployment order. | [src/batteries/dev\\_tools/types.ts:358](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L358) |\n\n## Methods\n\n### compile()\n\n```ts\ncompile(ops: DevOp[]): DevPlan;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:354](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L354)\n\nValidates operations without executing them.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------- |\n| `ops` | [`DevOp`](../type-aliases/DevOp.md)\\[] |\n\n#### Returns\n\n[`DevPlan`](DevPlan.md)\n\n***\n\n### ops()\n\n```ts\nops(\n paths: readonly string[],\n ops: DevOp[],\noptions?: RunOptions): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:352](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L352)\n\nExecutes operations immediately over the acquired paths.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------------- |\n| `paths` | readonly `string`\\[] |\n| `ops` | [`DevOp`](../type-aliases/DevOp.md)\\[] |\n| `options?` | [`RunOptions`](RunOptions.md) |\n\n#### Returns\n\n`Promise`<[`DevResult`](DevResult.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPlan","title":"Interface: DevPlan","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPlan.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPlan","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevPlan.md'\ndescription: Development plan.\n---\n\n# Interface: DevPlan\n\nDefined in: [src/batteries/dev\\_tools/types.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L278)\n\nDevelopment plan.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | ------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `steps` | [`DevStep`](DevStep.md)\\[] | Ordered operations comprising the plan. | [src/batteries/dev\\_tools/types.ts:280](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L280) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevResult","title":"Interface: DevResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevResult","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevResult.md'\ndescription: The composite result of a development-tools execution.\n---\n\n# Interface: DevResult\n\nDefined in: [src/batteries/dev\\_tools/types.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L70)\n\nThe composite result of a development-tools execution.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `changes` | [`FileChangeSummary`](FileChangeSummary.md)\\[] | Final-state change summaries compared with acquisition. | [src/batteries/dev\\_tools/types.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L74) |\n| `diagnostics` | [`Diagnostic`](Diagnostic.md)\\[] | Accumulated normalized diagnostics in production order. | [src/batteries/dev\\_tools/types.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L72) |\n| `lineCountsAvailable` | `boolean` | Whether optional line-diff counts are available. | [src/batteries/dev\\_tools/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L84) |\n| `ok` | `boolean` | False exactly when an error-severity diagnostic exists. | [src/batteries/dev\\_tools/types.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L82) |\n| `reads` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Read-lines output keyed by label. | [src/batteries/dev\\_tools/types.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L76) |\n| `unreadable` | `string`\\[] | Paths that were in the workspace but were dropped by a failed re-read; they remain on disk, are excluded from changes, and surface in the result. | [src/batteries/dev\\_tools/types.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L80) |\n| `written` | `string`\\[] | Paths actually persisted, in write execution order. | [src/batteries/dev\\_tools/types.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L78) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevSelectionContext","title":"Interface: DevSelectionContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevSelectionContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevSelectionContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevSelectionContext.md\ndescription: Selection middleware context.\n---\n\n# Interface: DevSelectionContext\n\nDefined in: [src/batteries/dev\\_tools/types.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L258)\n\nSelection middleware context.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `candidates` | [`DevCandidate`](DevCandidate.md)\\[] | Candidates middleware may narrow or reorder, but never widen. | [src/batteries/dev\\_tools/types.ts:266](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L266) |\n| `group` | `string` | `null` | Current extension group, or null for generator and check passes. | [src/batteries/dev\\_tools/types.ts:262](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L262) |\n| `kind` | `\"format\"` | `\"lint\"` | `\"check\"` | Capability kind being arbitrated. | [src/batteries/dev\\_tools/types.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L260) |\n| `request` | { `extensions`: readonly `string`\\[]; `paths`: readonly `string`\\[]; } | Pass-local resolved paths and relevant extensions. | [src/batteries/dev\\_tools/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L264) |\n| `request.extensions` | readonly `string`\\[] | - | [src/batteries/dev\\_tools/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L264) |\n| `request.paths` | readonly `string`\\[] | - | [src/batteries/dev\\_tools/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L264) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStep","title":"Interface: DevStep","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStep.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStep","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStep.md'\ndescription: Development plan step.\n---\n\n# Interface: DevStep\n\nDefined in: [src/batteries/dev\\_tools/types.ts:269](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L269)\n\nDevelopment plan step.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Validated step arguments, preserved separately from normalized selection data. | [src/batteries/dev\\_tools/types.ts:273](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L273) |\n| `label?` | `string` | Optional read-lines result key; accepted and ignored by other steps. | [src/batteries/dev\\_tools/types.ts:275](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L275) |\n| `step` | `string` | The current authored step. | [src/batteries/dev\\_tools/types.ts:271](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L271) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStepContext","title":"Interface: DevStepContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStepContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStepContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevStepContext.md\ndescription: Step middleware context.\n---\n\n# Interface: DevStepContext\n\nDefined in: [src/batteries/dev\\_tools/types.ts:301](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L301)\n\nStep middleware context.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | --------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `engines` | `readonly` | `DevEngineRegistry` | Resolved engines in deployment order. | [src/batteries/dev\\_tools/types.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L317) |\n| `plan` | `readonly` | [`DevPlan`](DevPlan.md) | Plan being executed. | [src/batteries/dev\\_tools/types.ts:303](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L303) |\n| `signal?` | `readonly` | `AbortSignal` | Optional cancellation signal passed to capability work. | [src/batteries/dev\\_tools/types.ts:313](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L313) |\n| `stash` | `readonly` | `Map`<`string`, `unknown`> | Per-execution storage shared by step middleware. | [src/batteries/dev\\_tools/types.ts:311](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L311) |\n| `step` | `readonly` | [`DevStep`](DevStep.md) | Current authored step. | [src/batteries/dev\\_tools/types.ts:307](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L307) |\n| `stepIndex` | `readonly` | `number` | Zero-based current step index. | [src/batteries/dev\\_tools/types.ts:305](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L305) |\n| `workspace` | `public` | [`DevWorkspace`](DevWorkspace.md) | Live workspace; middleware may replace it only with a matching token. | [src/batteries/dev\\_tools/types.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L309) |\n\n## Methods\n\n### shortCircuit()\n\n```ts\nshortCircuit(ws: DevWorkspace): never;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:315](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L315)\n\nReplace the current workspace, preserving its opaque provenance token.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------- |\n| `ws` | [`DevWorkspace`](DevWorkspace.md) |\n\n#### Returns\n\n`never`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspace","title":"Interface: DevWorkspace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspace.md\ndescription: Mutable workspace state passed to step middleware.\n---\n\n# Interface: DevWorkspace\n\nDefined in: [src/batteries/dev\\_tools/types.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L196)\n\nMutable workspace state passed to step middleware.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `diagnostics` | `public` | [`Diagnostic`](Diagnostic.md)\\[] | Accumulated normalized diagnostics in production order. | [src/batteries/dev\\_tools/types.ts:204](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L204) |\n| `files` | `public` | `Map`<`string`, `WorkspaceFile`> | Current mutable workspace file map. | [src/batteries/dev\\_tools/types.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L198) |\n| `pendingDeletions` | `public` | `Map`<`string`, `string`> | Workspace path to on-disk path awaiting deletion; retained when a persisted file is removed from memory. | [src/batteries/dev\\_tools/types.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L210) |\n| `persistedPaths` | `public` | `Map`<`string`, `string`> | Workspace path to its current on-disk path; acquisition seeds identity and renames re-key it so later writes use the live disk source. | [src/batteries/dev\\_tools/types.ts:208](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L208) |\n| `recreated` | `public` | [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`> | Paths vacated and then newly created during this execution; these summarize as additions, not modifications. | [src/batteries/dev\\_tools/types.ts:212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L212) |\n| `renames` | `public` | `Map`<`string`, `string`> | Destination-to-original acquisition path identity map, retained across writes for final rename reporting. | [src/batteries/dev\\_tools/types.ts:206](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L206) |\n| `token` | `readonly` | [`DevWorkspaceToken`](DevWorkspaceToken.md) | Runtime-minted opaque identity unique per execution and persistence point; middleware must copy it unchanged or stale short-circuits are refused. | [src/batteries/dev\\_tools/types.ts:202](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L202) |\n| `unreadable` | `public` | [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`> | Paths that were in the workspace but were dropped by a failed re-read; they remain on disk, are excluded from changes, and surface in the result. | [src/batteries/dev\\_tools/types.ts:200](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L200) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspaceToken","title":"Interface: DevWorkspaceToken","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspaceToken.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspaceToken","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/DevWorkspaceToken.md\ndescription: >-\n Opaque provenance token for one workspace value. Tokens are runtime-minted and\n unique per execution and persistence point, so a short-circuit cannot restore\n a stale or foreign workspace.\n---\n\n# Interface: DevWorkspaceToken\n\nDefined in: [src/batteries/dev\\_tools/types.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L188)\n\nOpaque provenance token for one workspace value. Tokens are runtime-minted and unique per\nexecution and persistence point, so a short-circuit cannot restore a stale or foreign workspace.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------------------------------- | ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `[devWorkspaceTokenBrand]` | `readonly` | `true` | Brand proving this token was minted by the runtime. Middleware cannot construct a valid token; it must copy the token unchanged when short-circuiting within the same execution epoch. | [src/batteries/dev\\_tools/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L193) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/Diagnostic","title":"Interface: Diagnostic","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/Diagnostic.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/Diagnostic","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/Diagnostic.md'\ndescription: A diagnostic returned by the pipeline.\n---\n\n# Interface: Diagnostic\n\nDefined in: [src/batteries/dev\\_tools/types.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L37)\n\nA diagnostic returned by the pipeline.\n\n## Extends\n\n* [`RawDiagnostic`](RawDiagnostic.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| --------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `column?` | `number` | Optional one-based start column; requires a valid line. | [`RawDiagnostic`](RawDiagnostic.md).[`column`](RawDiagnostic.md#property-column) | [src/batteries/dev\\_tools/types.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L30) |\n| `endColumn?` | `number` | Optional one-based range end column. | [`RawDiagnostic`](RawDiagnostic.md).[`endColumn`](RawDiagnostic.md#property-endcolumn) | [src/batteries/dev\\_tools/types.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L34) |\n| `endLine?` | `number` | Optional one-based range end line. | [`RawDiagnostic`](RawDiagnostic.md).[`endLine`](RawDiagnostic.md#property-endline) | [src/batteries/dev\\_tools/types.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L32) |\n| `engineId` | `string` | `null` | Engine id stamped by dispatch; null identifies diagnostics produced by the runtime. | - | [src/batteries/dev\\_tools/types.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L39) |\n| `line?` | `number` | Optional one-based start line; invalid values are removed during normalization. | [`RawDiagnostic`](RawDiagnostic.md).[`line`](RawDiagnostic.md#property-line) | [src/batteries/dev\\_tools/types.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L28) |\n| `message` | `string` | Human-readable finding text; it remains useful even when invalid coordinates are removed. | [`RawDiagnostic`](RawDiagnostic.md).[`message`](RawDiagnostic.md#property-message) | [src/batteries/dev\\_tools/types.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L24) |\n| `outOfScope` | `boolean` | True when the normalized file path is absent from the post-step workspace; always false for null paths. | - | [src/batteries/dev\\_tools/types.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L41) |\n| `path` | `string` | `null` | Workspace-relative file path; null identifies a workspace-level diagnostic with no single file. | [`RawDiagnostic`](RawDiagnostic.md).[`path`](RawDiagnostic.md#property-path) | [src/batteries/dev\\_tools/types.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L20) |\n| `rule?` | `string` | Optional engine rule identifier. | [`RawDiagnostic`](RawDiagnostic.md).[`rule`](RawDiagnostic.md#property-rule) | [src/batteries/dev\\_tools/types.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L26) |\n| `severity` | [`Severity`](../type-aliases/Severity.md) | Diagnostic severity; only `error` makes a plan unsuccessful. | [`RawDiagnostic`](RawDiagnostic.md).[`severity`](RawDiagnostic.md#property-severity) | [src/batteries/dev\\_tools/types.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L22) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FileChangeSummary","title":"Interface: FileChangeSummary","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FileChangeSummary.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FileChangeSummary","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/FileChangeSummary.md\ndescription: A summary row for one final workspace change.\n---\n\n# Interface: FileChangeSummary\n\nDefined in: [src/batteries/dev\\_tools/types.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L57)\n\nA summary row for one final workspace change.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `added?` | `number` | Lines inserted; absent when the optional diff peer is unavailable. | [src/batteries/dev\\_tools/types.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L63) |\n| `from?` | `string` | Rename source path; present if and only if kind is 'renamed'. | [src/batteries/dev\\_tools/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L67) |\n| `kind` | `\"modified\"` | `\"added\"` | `\"deleted\"` | `\"renamed\"` | Final-state change classification relative to the acquisition workspace. | [src/batteries/dev\\_tools/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L61) |\n| `path` | `string` | Workspace-relative file path; for a rename, this is the destination path. | [src/batteries/dev\\_tools/types.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L59) |\n| `removed?` | `number` | Lines deleted; absent when the optional diff peer is unavailable. | [src/batteries/dev\\_tools/types.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L65) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatCapability","title":"Interface: FormatCapability","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatCapability.md\ndescription: A formatter capability declaration.\n---\n\n# Interface: FormatCapability\n\nDefined in: [src/batteries/dev\\_tools/types.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L88)\n\nA formatter capability declaration.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `extensions` | readonly `string`\\[] | Extensions participating in this selection pass. | [src/batteries/dev\\_tools/types.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L90) |\n| `generates?` | `boolean` | Allows output when the invocation has no input paths. | [src/batteries/dev\\_tools/types.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L98) |\n| `inPlace?` | `boolean` | Selects disk-mutating execution through the restricted access façade. | [src/batteries/dev\\_tools/types.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L92) |\n| `needs?` | readonly (`\"delete\"` | `\"rename\"` | `\"mkdir\"`)\\[] | Filesystem operations granted to an in-place capability; duplicates are ignored. | [src/batteries/dev\\_tools/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L96) |\n| `scope?` | readonly `string`\\[] | Glob permission used for selection and in-place authorization. | [src/batteries/dev\\_tools/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L94) |\n\n## Methods\n\n### format()\n\n```ts\nformat(request: FormatRequest): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L100)\n\nFormats the supplied paths and returns a workspace delta; it must not mutate the map directly.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------- |\n| `request` | [`FormatRequest`](FormatRequest.md) |\n\n#### Returns\n\n`Promise`<[`WorkspaceDelta`](WorkspaceDelta.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatRequest","title":"Interface: FormatRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatRequest.md\ndescription: Request passed to a formatter.\n---\n\n# Interface: FormatRequest\n\nDefined in: [src/batteries/dev\\_tools/types.ts:138](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L138)\n\nRequest passed to a formatter.\n\n## Extended by\n\n* [`LintRequest`](LintRequest.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `access?` | [`DevFileAccess`](DevFileAccess.md) | Scoped disk façade supplied only to in-place capabilities. | [src/batteries/dev\\_tools/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L148) |\n| `files` | `ReadonlyMap`<`string`, `WorkspaceFile`> | Current mutable workspace file map. | [src/batteries/dev\\_tools/types.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L140) |\n| `paths` | readonly `string`\\[] | Resolved existing workspace paths this invocation must handle; selection is frozen for the step. | [src/batteries/dev\\_tools/types.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L142) |\n| `root` | `string` | Absolute host workspace root used as the subprocess working directory. | [src/batteries/dev\\_tools/types.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L146) |\n| `selector` | readonly `string`\\[] | `null` | Normalized authored path patterns, or null when the step supplied no selector. | [src/batteries/dev\\_tools/types.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L144) |\n| `signal?` | `AbortSignal` | Optional cancellation signal. | [src/batteries/dev\\_tools/types.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L150) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/LintCapability","title":"Interface: LintCapability","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/LintCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/LintCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/LintCapability.md\ndescription: A linter capability declaration.\n---\n\n# Interface: LintCapability\n\nDefined in: [src/batteries/dev\\_tools/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L103)\n\nA linter capability declaration.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `extensions` | readonly `string`\\[] | Extensions participating in this selection pass. | [src/batteries/dev\\_tools/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L105) |\n| `fixable` | `boolean` | Whether this linter may receive `fix: true`; generating linters must be fixable. | [src/batteries/dev\\_tools/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L107) |\n| `generates?` | `boolean` | Allows output when the invocation has no input paths. | [src/batteries/dev\\_tools/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L115) |\n| `inPlace?` | `boolean` | Selects disk-mutating execution through the restricted access façade. | [src/batteries/dev\\_tools/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L109) |\n| `needs?` | readonly (`\"delete\"` | `\"rename\"` | `\"mkdir\"`)\\[] | Filesystem operations granted to an in-place capability; duplicates are ignored. | [src/batteries/dev\\_tools/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L113) |\n| `scope?` | readonly `string`\\[] | Glob permission used for selection and in-place authorization. | [src/batteries/dev\\_tools/types.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L111) |\n\n## Methods\n\n### lint()\n\n```ts\nlint(request: LintRequest): Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L117)\n\nRuns lint and returns diagnostics and any permitted fix delta.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------- |\n| `request` | [`LintRequest`](LintRequest.md) |\n\n#### Returns\n\n`Promise`<[`WorkspaceDelta`](WorkspaceDelta.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/LintRequest","title":"Interface: LintRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/LintRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/LintRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/LintRequest.md\ndescription: Request passed to a linter.\n---\n\n# Interface: LintRequest\n\nDefined in: [src/batteries/dev\\_tools/types.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L153)\n\nRequest passed to a linter.\n\n## Extends\n\n* [`FormatRequest`](FormatRequest.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `access?` | [`DevFileAccess`](DevFileAccess.md) | Scoped disk façade supplied only to in-place capabilities. | [`FormatRequest`](FormatRequest.md).[`access`](FormatRequest.md#property-access) | [src/batteries/dev\\_tools/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L148) |\n| `files` | `ReadonlyMap`<`string`, `WorkspaceFile`> | Current mutable workspace file map. | [`FormatRequest`](FormatRequest.md).[`files`](FormatRequest.md#property-files) | [src/batteries/dev\\_tools/types.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L140) |\n| `fix` | `boolean` | Concrete permission requested for this invocation; false is forced for non-fixable linters. | - | [src/batteries/dev\\_tools/types.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L155) |\n| `paths` | readonly `string`\\[] | Resolved existing workspace paths this invocation must handle; selection is frozen for the step. | [`FormatRequest`](FormatRequest.md).[`paths`](FormatRequest.md#property-paths) | [src/batteries/dev\\_tools/types.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L142) |\n| `root` | `string` | Absolute host workspace root used as the subprocess working directory. | [`FormatRequest`](FormatRequest.md).[`root`](FormatRequest.md#property-root) | [src/batteries/dev\\_tools/types.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L146) |\n| `selector` | readonly `string`\\[] | `null` | Normalized authored path patterns, or null when the step supplied no selector. | [`FormatRequest`](FormatRequest.md).[`selector`](FormatRequest.md#property-selector) | [src/batteries/dev\\_tools/types.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L144) |\n| `signal?` | `AbortSignal` | Optional cancellation signal. | [`FormatRequest`](FormatRequest.md).[`signal`](FormatRequest.md#property-signal) | [src/batteries/dev\\_tools/types.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L150) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/RawDiagnostic","title":"Interface: RawDiagnostic","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/RawDiagnostic.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/RawDiagnostic","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/RawDiagnostic.md\ndescription: A diagnostic returned by an engine before runtime provenance is added.\n---\n\n# Interface: RawDiagnostic\n\nDefined in: [src/batteries/dev\\_tools/types.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L18)\n\nA diagnostic returned by an engine before runtime provenance is added.\n\n## Extended by\n\n* [`Diagnostic`](Diagnostic.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `column?` | `number` | Optional one-based start column; requires a valid line. | [src/batteries/dev\\_tools/types.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L30) |\n| `endColumn?` | `number` | Optional one-based range end column. | [src/batteries/dev\\_tools/types.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L34) |\n| `endLine?` | `number` | Optional one-based range end line. | [src/batteries/dev\\_tools/types.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L32) |\n| `line?` | `number` | Optional one-based start line; invalid values are removed during normalization. | [src/batteries/dev\\_tools/types.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L28) |\n| `message` | `string` | Human-readable finding text; it remains useful even when invalid coordinates are removed. | [src/batteries/dev\\_tools/types.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L24) |\n| `path` | `string` | `null` | Workspace-relative file path; null identifies a workspace-level diagnostic with no single file. | [src/batteries/dev\\_tools/types.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L20) |\n| `rule?` | `string` | Optional engine rule identifier. | [src/batteries/dev\\_tools/types.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L26) |\n| `severity` | [`Severity`](../type-aliases/Severity.md) | Diagnostic severity; only `error` makes a plan unsuccessful. | [src/batteries/dev\\_tools/types.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L22) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/RunOptions","title":"Interface: RunOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/RunOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/RunOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/RunOptions.md'\ndescription: Execution options.\n---\n\n# Interface: RunOptions\n\nDefined in: [src/batteries/dev\\_tools/types.ts:294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L294)\n\nExecution options.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | ------------------------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `gateContext?` | [`DevGateContext`](DevGateContext.md) | Optional execution gate context. | [src/batteries/dev\\_tools/types.ts:298](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L298) |\n| `signal?` | `AbortSignal` | Optional cancellation signal. | [src/batteries/dev\\_tools/types.ts:296](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L296) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceBounds","title":"Interface: WorkspaceBounds","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceBounds.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceBounds","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceBounds.md\ndescription: Workspace resource limits.\n---\n\n# Interface: WorkspaceBounds\n\nDefined in: [src/batteries/dev\\_tools/types.ts:285](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L285)\n\nWorkspace resource limits.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------- | -------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `maxBytesPerFile` | `number` | Maximum bytes admitted for one workspace file. | [src/batteries/dev\\_tools/types.ts:289](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L289) |\n| `maxFiles` | `number` | Maximum admitted workspace file count. | [src/batteries/dev\\_tools/types.ts:287](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L287) |\n| `maxTotalBytes` | `number` | Maximum total admitted workspace bytes. | [src/batteries/dev\\_tools/types.ts:291](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L291) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceDelta","title":"Interface: WorkspaceDelta","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceDelta.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceDelta","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/WorkspaceDelta.md\ndescription: The common result of every engine capability.\n---\n\n# Interface: WorkspaceDelta\n\nDefined in: [src/batteries/dev\\_tools/types.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L44)\n\nThe common result of every engine capability.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `added?` | `Map`<`string`, `WorkspaceFile`> | Optional inserted-line count; omitted when line diffing is unavailable. | [src/batteries/dev\\_tools/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L48) |\n| `changed?` | `Map`<`string`, `string`> | Path-to-text entries describing genuinely changed workspace files. | [src/batteries/dev\\_tools/types.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L46) |\n| `deleted?` | [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`> | Paths removed from the workspace by this delta. | [src/batteries/dev\\_tools/types.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L50) |\n| `diagnostics?` | [`RawDiagnostic`](RawDiagnostic.md)\\[] | Engine findings before the registry adds provenance. | [src/batteries/dev\\_tools/types.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L54) |\n| `renamed?` | `Map`<`string`, `string`> | Source-to-destination moves preserving atomic rename semantics. | [src/batteries/dev\\_tools/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L52) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateFn","title":"Type Alias: DevGateFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateFn.md\ndescription: Gate callback used by the pipeline.\n---\n\n# Type Alias: DevGateFn\n\n```ts\ntype DevGateFn = (\n ctx: DevGateContext,\n call: DevGateCall,\n) => DevGateVerdict | void | Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:242](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L242)\n\nGate callback used by the pipeline.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------- |\n| `ctx` | [`DevGateContext`](../interfaces/DevGateContext.md) |\n| `call` | [`DevGateCall`](../interfaces/DevGateCall.md) |\n\n## Returns\n\n| [`DevGateVerdict`](DevGateVerdict.md)\n| `void`\n| `Promise`<[`DevGateVerdict`](DevGateVerdict.md) | `void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateVerdict","title":"Type Alias: DevGateVerdict","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateVerdict.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateVerdict","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevGateVerdict.md\ndescription: Gate verdict; omission or approval permits the step.\n---\n\n# Type Alias: DevGateVerdict\n\n```ts\ntype DevGateVerdict =\n | {\n approved: true;\n }\n | {\n approved: false;\n note?: string;\n };\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L215)\n\nGate verdict; omission or approval permits the step.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevOp","title":"Type Alias: DevOp","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevOp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevOp","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevOp.md'\ndescription: Operation-shaped plan input.\n---\n\n# Type Alias: DevOp\n\n```ts\ntype DevOp = Omit;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:283](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L283)\n\nOperation-shaped plan input.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevSelectionMiddlewareFn","title":"Type Alias: DevSelectionMiddlewareFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevSelectionMiddlewareFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevSelectionMiddlewareFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevSelectionMiddlewareFn.md\ndescription: Selection middleware callback.\n---\n\n# Type Alias: DevSelectionMiddlewareFn\n\n```ts\ntype DevSelectionMiddlewareFn = (\n ctx: DevSelectionContext,\n next: NextFn,\n) => void | Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L322)\n\nSelection middleware callback.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------- |\n| `ctx` | [`DevSelectionContext`](../interfaces/DevSelectionContext.md) |\n| `next` | `NextFn` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevStepMiddlewareFn","title":"Type Alias: DevStepMiddlewareFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevStepMiddlewareFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevStepMiddlewareFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/type-aliases/DevStepMiddlewareFn.md\ndescription: Step middleware callback.\n---\n\n# Type Alias: DevStepMiddlewareFn\n\n```ts\ntype DevStepMiddlewareFn = (\n ctx: DevStepContext,\n next: NextFn,\n) => void | Promise;\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L320)\n\nStep middleware callback.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------- |\n| `ctx` | [`DevStepContext`](../interfaces/DevStepContext.md) |\n| `next` | `NextFn` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/Severity","title":"Type Alias: Severity","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/Severity.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/type-aliases/Severity","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/type-aliases/Severity.md'\ndescription: 'Diagnostic severity, ordered from most to least serious.'\n---\n\n# Type Alias: Severity\n\n```ts\ntype Severity = \"error\" | \"warning\" | \"info\";\n```\n\nDefined in: [src/batteries/dev\\_tools/types.ts:16](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/types.ts#L16)\n\nDiagnostic severity, ordered from most to least serious.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_BAD_ARG","title":"Variable: E\\_DEV\\_BAD\\_ARG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_BAD_ARG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_BAD_ARG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_BAD_ARG.md\ndescription: Invalid development-step argument.\n---\n\n# Variable: E\\_DEV\\_BAD\\_ARG\n\n```ts\nconst E_DEV_BAD_ARG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L20)\n\nInvalid development-step argument.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_ENGINE_REQUIRED","title":"Variable: E\\_DEV\\_ENGINE\\_REQUIRED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_ENGINE_REQUIRED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_ENGINE_REQUIRED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_ENGINE_REQUIRED.md\ndescription: A requested engine capability is not configured.\n---\n\n# Variable: E\\_DEV\\_ENGINE\\_REQUIRED\n\n```ts\nconst E_DEV_ENGINE_REQUIRED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L28)\n\nA requested engine capability is not configured.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_GATE_DECLINED","title":"Variable: E\\_DEV\\_GATE\\_DECLINED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_GATE_DECLINED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_GATE_DECLINED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_GATE_DECLINED.md\ndescription: A gate declined a step.\n---\n\n# Variable: E\\_DEV\\_GATE\\_DECLINED\n\n```ts\nconst E_DEV_GATE_DECLINED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L60)\n\nA gate declined a step.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_FAILED","title":"Variable: E\\_DEV\\_STEP\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_FAILED.md\ndescription: A development step failed during execution or validation.\n---\n\n# Variable: E\\_DEV\\_STEP\\_FAILED\n\n```ts\nconst E_DEV_STEP_FAILED: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L36)\n\nA development step failed during execution or validation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_UNAVAILABLE","title":"Variable: E\\_DEV\\_STEP\\_UNAVAILABLE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_UNAVAILABLE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_UNAVAILABLE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_STEP_UNAVAILABLE.md\ndescription: A step implementation is not available.\n---\n\n# Variable: E\\_DEV\\_STEP\\_UNAVAILABLE\n\n```ts\nconst E_DEV_STEP_UNAVAILABLE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L44)\n\nA step implementation is not available.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_UNKNOWN_STEP","title":"Variable: E\\_DEV\\_UNKNOWN\\_STEP","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_UNKNOWN_STEP.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_UNKNOWN_STEP","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_UNKNOWN_STEP.md\ndescription: Unknown development step.\n---\n\n# Variable: E\\_DEV\\_UNKNOWN\\_STEP\n\n```ts\nconst E_DEV_UNKNOWN_STEP: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L12)\n\nUnknown development step.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_WORKSPACE_BOUNDS","title":"Variable: E\\_DEV\\_WORKSPACE\\_BOUNDS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_WORKSPACE_BOUNDS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_WORKSPACE_BOUNDS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_DEV_WORKSPACE_BOUNDS.md\ndescription: Workspace bounds were exceeded.\n---\n\n# Variable: E\\_DEV\\_WORKSPACE\\_BOUNDS\n\n```ts\nconst E_DEV_WORKSPACE_BOUNDS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L52)\n\nWorkspace bounds were exceeded.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_INVALID_DEV_PIPELINE_CONFIG","title":"Variable: E\\_INVALID\\_DEV\\_PIPELINE\\_CONFIG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_INVALID_DEV_PIPELINE_CONFIG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/dev-tools/variables/E_INVALID_DEV_PIPELINE_CONFIG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/variables/E_INVALID_DEV_PIPELINE_CONFIG.md\ndescription: Fatal configuration error for a development-tools pipeline.\n---\n\n# Variable: E\\_INVALID\\_DEV\\_PIPELINE\\_CONFIG\n\n```ts\nconst E_INVALID_DEV_PIPELINE_CONFIG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/dev\\_tools/exceptions.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/dev_tools/exceptions.ts#L4)\n\nFatal configuration error for a development-tools pipeline.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings","title":"@nhtio/adk/batteries/embeddings","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings.md'\ndescription: Environment-neutral aggregate barrel for bundled embeddings batteries.\n---\n\n# @nhtio/adk/batteries/embeddings\n\nEnvironment-neutral aggregate barrel for bundled embeddings batteries.\n\n## Remarks\n\nAggregate barrel for the embeddings batteries. Re-exports the **environment-neutral** embeddings\nbatteries — the OpenAI battery (raw `fetch`, runs anywhere) and the transformers.js battery (ONNX\nRuntime, auto-selecting native Node vs WASM/WebGPU in the browser) — so consumers can import this\nbarrel from either Node or the browser without dragging in environment-specific runtime\nrequirements.\n\nThe browser/WebGPU-only WebLLM embeddings battery is reachable only through its own subpath:\n\n* `@nhtio/adk/batteries/embeddings/webllm` — browser-only (uses WebGPU via `@mlc-ai/web-llm`).\n\nDeep-import that subpath when you need it; don't expect it to be re-exported here. All batteries\nshare one option base and an identical method surface — see\n[@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions](openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).\n\n## References\n\n### applyEmbeddingPrefix\n\nRe-exports [applyEmbeddingPrefix](openai/helpers/functions/applyEmbeddingPrefix.md)\n\n***\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### CreateTransformersJsEmbeddingsPipeline\n\nRe-exports [CreateTransformersJsEmbeddingsPipeline](transformers_js/types/type-aliases/CreateTransformersJsEmbeddingsPipeline.md)\n\n***\n\n### E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS](ollama/exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS](openai/exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS](transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR](ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR](openai/exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](openai/exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](openai/exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbeddingsRetryConfig\n\nRe-exports [EmbeddingsRetryConfig](openai/types/interfaces/EmbeddingsRetryConfig.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](openai/types/interfaces/EmbedOptions.md)\n\n***\n\n### OllamaEmbeddingsAdapter\n\nRe-exports [OllamaEmbeddingsAdapter](ollama/adapter/classes/OllamaEmbeddingsAdapter.md)\n\n***\n\n### OllamaEmbeddingsAdapterOptions\n\nRe-exports [OllamaEmbeddingsAdapterOptions](ollama/types/interfaces/OllamaEmbeddingsAdapterOptions.md)\n\n***\n\n### ollamaEmbeddingsOptionsSchema\n\nRe-exports [ollamaEmbeddingsOptionsSchema](ollama/validation/variables/ollamaEmbeddingsOptionsSchema.md)\n\n***\n\n### OllamaEmbeddingsRequestBody\n\nRe-exports [OllamaEmbeddingsRequestBody](ollama/types/interfaces/OllamaEmbeddingsRequestBody.md)\n\n***\n\n### OllamaEmbeddingsResponseBody\n\nRe-exports [OllamaEmbeddingsResponseBody](ollama/types/interfaces/OllamaEmbeddingsResponseBody.md)\n\n***\n\n### OllamaEmbeddingsRuntimeOptions\n\nRe-exports [OllamaEmbeddingsRuntimeOptions](ollama/types/interfaces/OllamaEmbeddingsRuntimeOptions.md)\n\n***\n\n### OpenAIEmbeddingsAdapter\n\nRe-exports [OpenAIEmbeddingsAdapter](openai/adapter/classes/OpenAIEmbeddingsAdapter.md)\n\n***\n\n### OpenAIEmbeddingsAdapterOptions\n\nRe-exports [OpenAIEmbeddingsAdapterOptions](openai/types/interfaces/OpenAIEmbeddingsAdapterOptions.md)\n\n***\n\n### openAIEmbeddingsOptionsSchema\n\nRe-exports [openAIEmbeddingsOptionsSchema](openai/validation/variables/openAIEmbeddingsOptionsSchema.md)\n\n***\n\n### OpenAIEmbeddingsRequestBody\n\nRe-exports [OpenAIEmbeddingsRequestBody](openai/types/interfaces/OpenAIEmbeddingsRequestBody.md)\n\n***\n\n### OpenAIEmbeddingsResponseBody\n\nRe-exports [OpenAIEmbeddingsResponseBody](openai/types/interfaces/OpenAIEmbeddingsResponseBody.md)\n\n***\n\n### TransformersJsEmbeddingsAdapter\n\nRe-exports [TransformersJsEmbeddingsAdapter](transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter.md)\n\n***\n\n### TransformersJsEmbeddingsAdapterOptions\n\nRe-exports [TransformersJsEmbeddingsAdapterOptions](transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions.md)\n\n***\n\n### TransformersJsEmbeddingsDataType\n\nRe-exports [TransformersJsEmbeddingsDataType](transformers_js/types/type-aliases/TransformersJsEmbeddingsDataType.md)\n\n***\n\n### TransformersJsEmbeddingsDeviceType\n\nRe-exports [TransformersJsEmbeddingsDeviceType](transformers_js/types/type-aliases/TransformersJsEmbeddingsDeviceType.md)\n\n***\n\n### transformersJsEmbeddingsOptionsSchema\n\nRe-exports [transformersJsEmbeddingsOptionsSchema](transformers_js/validation/variables/transformersJsEmbeddingsOptionsSchema.md)\n\n***\n\n### TransformersJsEmbeddingsPipeline\n\nRe-exports [TransformersJsEmbeddingsPipeline](transformers_js/types/type-aliases/TransformersJsEmbeddingsPipeline.md)\n\n***\n\n### TransformersJsEmbeddingsProgressCallback\n\nRe-exports [TransformersJsEmbeddingsProgressCallback](transformers_js/types/type-aliases/TransformersJsEmbeddingsProgressCallback.md)\n\n***\n\n### TransformersJsPooling\n\nRe-exports [TransformersJsPooling](transformers_js/types/type-aliases/TransformersJsPooling.md)\n\n***\n\n### validateOllamaEmbeddingsOptions\n\nRenames and re-exports [validateOptions](ollama/validation/functions/validateOptions.md)\n\n***\n\n### validateOpenAIEmbeddingsOptions\n\nRenames and re-exports [validateOptions](openai/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsEmbeddingsOptions\n\nRenames and re-exports [validateOptions](transformers_js/validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama","title":"@nhtio/adk/batteries/embeddings/ollama","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama.md'\ndescription: >-\n Ollama Embeddings adapter battery — the environment-neutral embeddings battery\n for Ollama.\n---\n\n# @nhtio/adk/batteries/embeddings/ollama\n\nOllama Embeddings adapter battery — the environment-neutral embeddings battery for Ollama.\n\n## Remarks\n\nRe-exports the adapter class, every option / wire-shape type alias (including the shared\n[@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions](../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md),\n[@nhtio/adk/batteries/embeddings/openai/types!EmbeddingKind](../openai/types/type-aliases/EmbeddingKind.md),\n[@nhtio/adk/batteries/embeddings/openai/types!EmbedOptions](../openai/types/interfaces/EmbedOptions.md)), the validation schema +\n`validateOptions` wrapper, and the battery-scoped exceptions.\n\n## References\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS](exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR](exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](../openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](../openai/types/interfaces/EmbedOptions.md)\n\n***\n\n### OllamaEmbeddingsAdapter\n\nRe-exports [OllamaEmbeddingsAdapter](adapter/classes/OllamaEmbeddingsAdapter.md)\n\n***\n\n### OllamaEmbeddingsAdapterOptions\n\nRe-exports [OllamaEmbeddingsAdapterOptions](types/interfaces/OllamaEmbeddingsAdapterOptions.md)\n\n***\n\n### ollamaEmbeddingsOptionsSchema\n\nRe-exports [ollamaEmbeddingsOptionsSchema](validation/variables/ollamaEmbeddingsOptionsSchema.md)\n\n***\n\n### OllamaEmbeddingsRequestBody\n\nRe-exports [OllamaEmbeddingsRequestBody](types/interfaces/OllamaEmbeddingsRequestBody.md)\n\n***\n\n### OllamaEmbeddingsResponseBody\n\nRe-exports [OllamaEmbeddingsResponseBody](types/interfaces/OllamaEmbeddingsResponseBody.md)\n\n***\n\n### OllamaEmbeddingsRuntimeOptions\n\nRe-exports [OllamaEmbeddingsRuntimeOptions](types/interfaces/OllamaEmbeddingsRuntimeOptions.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/adapter","title":"@nhtio/adk/batteries/embeddings/ollama/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/adapter.md'\ndescription: Cross-environment Ollama Embeddings adapter battery.\n---\n\n# @nhtio/adk/batteries/embeddings/ollama/adapter\n\nCross-environment Ollama Embeddings adapter battery.\n\n## Remarks\n\nOpinionated embeddings battery for the Ollama `/api/embed` wire shape. Ships an\n[OllamaEmbeddingsAdapter](classes/OllamaEmbeddingsAdapter.md) that targets any Ollama-compatible endpoint over raw `fetch` —\nno SDK dependency, so it runs unchanged in Node, the browser, edge runtimes, and workers.\n\nThe class shares its method surface, return types, prefix handling, and option base with the\nOpenAI Embeddings battery: the two differ only in their engine. See\n[@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions](../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).\n\nConstruction validates options eagerly via [@nhtio/adk/batteries/embeddings/ollama/validation!validateOptions](../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries/embeddings/ollama/exceptions!E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS](../exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md) on failure — config bugs fail loud, not at embed time.\n\n## Classes\n\n| Class | Description |\n| ------------------------------------------------------------- | ---------------------------------------------------------- |\n| [OllamaEmbeddingsAdapter](classes/OllamaEmbeddingsAdapter.md) | Embeddings adapter for the Ollama `/api/embed` wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/adapter/classes/OllamaEmbeddingsAdapter","title":"Class: OllamaEmbeddingsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/adapter/classes/OllamaEmbeddingsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/adapter/classes/OllamaEmbeddingsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/adapter/classes/OllamaEmbeddingsAdapter.md\ndescription: Embeddings adapter for the Ollama `/api/embed` wire shape.\n---\n\n# Class: OllamaEmbeddingsAdapter\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L50)\n\nEmbeddings adapter for the Ollama `/api/embed` wire shape.\n\n## Remarks\n\nReusable: construct once, call [OllamaEmbeddingsAdapter.embed](#embed) / [embedMany](#embedmany) as many\ntimes as needed. `embedMany` issues one request per call (Ollama embeds a batch in a single\nround-trip); `embed` is sugar over `embedMany([text])`.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OllamaEmbeddingsAdapter(options: unknown): OllamaEmbeddingsAdapter;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L67)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`OllamaEmbeddingsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/ollama/exceptions!E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS](../../exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md) when `options` does not satisfy\n[@nhtio/adk/batteries/embeddings/ollama/validation!ollamaEmbeddingsOptionsSchema](../../validation/variables/ollamaEmbeddingsOptionsSchema.md) (e.g. missing `model`).\n\n## Accessors\n\n### dimensions\n\n#### Get Signature\n\n```ts\nget dimensions(): number | undefined;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L72)\n\nDeclared output dimensionality (from options), or `undefined` if not configured.\n\n##### Returns\n\n`number` | `undefined`\n\n## Methods\n\n### embed()\n\n```ts\nembed(text: string, opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L103)\n\nEmbeds a single string.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------ | -------------------------- |\n| `text` | `string` | The input text. |\n| `opts?` | [`EmbedOptions`](../../../openai/types/interfaces/EmbedOptions.md) | Per-call options (`kind`). |\n\n#### Returns\n\n`Promise`<`number`\\[]>\n\nThe embedding vector as a plain `number[]`.\n\n***\n\n### embedMany()\n\n```ts\nembedMany(texts: string[], opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L118)\n\nEmbeds a batch of strings in a single request.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |\n| `texts` | `string`\\[] | The input texts. |\n| `opts?` | [`EmbedOptions`](../../../openai/types/interfaces/EmbedOptions.md) | Per-call options (`kind`). Defaults to `kind: 'document'`. |\n\n#### Returns\n\n`Promise`<`number`\\[]\\[]>\n\nOne embedding vector per input, in input order, each a plain `number[]`.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/ollama/exceptions!E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR](../../exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR.md) on a non-2xx response or transport failure.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/ollama/exceptions!E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](../../exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT.md) when the handshake exceeds `requestTimeoutMs`.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/ollama/exceptions!E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](../../exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE.md) when the 2xx body is not the expected shape.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L77)\n\nSee [OllamaEmbeddingsAdapter.isAvailable](#isavailable-1). Instance alias for surface-parity.\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L85)\n\nNo-op warm-up. The Ollama battery has no engine to preload; present for surface-parity with\nthe WebLLM battery so callers can treat the two interchangeably.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L92)\n\nNo-op state reset. Present for surface-parity with the WebLLM battery.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/ollama/adapter.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/adapter.ts#L58)\n\nWhether this battery can run in the current environment. For the HTTP-backed Ollama battery\nthis is always `true` (a `fetch` is always resolvable); present for surface-parity with the\nWebLLM battery's WebGPU gate.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions","title":"@nhtio/adk/batteries/embeddings/ollama/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/exceptions.md'\ndescription: Battery-scoped exception constructors for Ollama Embeddings adapter failures.\n---\n\n# @nhtio/adk/batteries/embeddings/ollama/exceptions\n\nBattery-scoped exception constructors for Ollama Embeddings adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the Ollama Embeddings adapter. These exceptions are owned\nby the battery (not the ADK core) and are minted via `createException` from\n`@nhtio/adk/factories`. Re-exported from the battery's barrel.\n\nThe categories mirror the OpenAI Embeddings battery one-to-one so the two batteries fail with\nparallel semantics — only the engine-specific transport exception differs.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS](variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `ollamaEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, or an unknown option key. Fatal: config bugs fail loud at construction time, not at embed time. |\n| [E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR](variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR.md) | Thrown when the upstream `/api/embed` endpoint returns a non-2xx response (after retries are exhausted), or the transport throws. Non-fatal. Printf args: `[status, detail]` — `status` is `0` for a transport-level failure with no HTTP response. |\n| [E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE.md) | Thrown when a 2xx response body cannot be parsed into the expected `{ embeddings: number[][] }` shape (malformed JSON, missing `embeddings`, wrong vector count). Non-fatal. Printf arg: `[detail]`. |\n| [E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT.md) | Thrown when the request handshake does not complete before `requestTimeoutMs` (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS","title":"Variable: E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `ollamaEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, or an unknown\n option key. Fatal: config bugs fail loud at construction time, not at embed\n time.\n---\n\n# Variable: E\\_INVALID\\_OLLAMA\\_EMBEDDINGS\\_OPTIONS\n\n```ts\nconst E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/ollama/exceptions.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/exceptions.ts#L22)\n\nThrown when the resolved adapter options fail validation against\n`ollamaEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, or an unknown option key.\nFatal: config bugs fail loud at construction time, not at embed time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR","title":"Variable: E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_HTTP_ERROR.md\ndescription: >-\n Thrown when the upstream `/api/embed` endpoint returns a non-2xx response\n (after retries are exhausted), or the transport throws. Non-fatal. Printf\n args: `[status, detail]` — `status` is `0` for a transport-level failure with\n no HTTP response.\n---\n\n# Variable: E\\_OLLAMA\\_EMBEDDINGS\\_HTTP\\_ERROR\n\n```ts\nconst E_OLLAMA_EMBEDDINGS_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/embeddings/ollama/exceptions.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/exceptions.ts#L35)\n\nThrown when the upstream `/api/embed` endpoint returns a non-2xx response (after retries\nare exhausted), or the transport throws. Non-fatal. Printf args: `[status, detail]` — `status`\nis `0` for a transport-level failure with no HTTP response.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE","title":"Variable: E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE.md\ndescription: >-\n Thrown when a 2xx response body cannot be parsed into the expected `{\n embeddings: number[][] }` shape (malformed JSON, missing `embeddings`, wrong\n vector count). Non-fatal. Printf arg: `[detail]`.\n---\n\n# Variable: E\\_OLLAMA\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\n```ts\nconst E_OLLAMA_EMBEDDINGS_MALFORMED_RESPONSE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/ollama/exceptions.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/exceptions.ts#L60)\n\nThrown when a 2xx response body cannot be parsed into the expected\n`{ embeddings: number[][] }` shape (malformed JSON, missing `embeddings`, wrong vector\ncount). Non-fatal. Printf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT","title":"Variable: E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/exceptions/variables/E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT.md\ndescription: >-\n Thrown when the request handshake does not complete before `requestTimeoutMs`\n (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n---\n\n# Variable: E\\_OLLAMA\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_OLLAMA_EMBEDDINGS_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/embeddings/ollama/exceptions.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/exceptions.ts#L47)\n\nThrown when the request handshake does not complete before `requestTimeoutMs` (and retries are\nexhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types","title":"@nhtio/adk/batteries/embeddings/ollama/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/types.md'\ndescription: Option and wire-shape types for the Ollama Embeddings adapter.\n---\n\n# @nhtio/adk/batteries/embeddings/ollama/types\n\nOption and wire-shape types for the Ollama Embeddings adapter.\n\n## Remarks\n\nThis module builds on the **shared** embeddings option base owned by the OpenAI Embeddings\nbattery ([@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions](../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)). The\nOllama Embeddings battery re-exports and `extends` these rather than redefining them — exactly\nhow the WebLLM Embeddings battery extends the shared base.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [OllamaEmbeddingsAdapterOptions](interfaces/OllamaEmbeddingsAdapterOptions.md) | Constructor options for [@nhtio/adk/batteries/embeddings/ollama/adapter!OllamaEmbeddingsAdapter](../adapter/classes/OllamaEmbeddingsAdapter.md). |\n| [OllamaEmbeddingsRequestBody](interfaces/OllamaEmbeddingsRequestBody.md) | The JSON request body POSTed to `/api/embed`. |\n| [OllamaEmbeddingsResponseBody](interfaces/OllamaEmbeddingsResponseBody.md) | The relevant subset of the `/api/embed` JSON response shape. |\n| [OllamaEmbeddingsRuntimeOptions](interfaces/OllamaEmbeddingsRuntimeOptions.md) | Runtime options for Ollama's `/api/embed` endpoint. These map directly to the `options` field in the Ollama request body. |\n\n## References\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](../../openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbeddingsRetryConfig\n\nRe-exports [EmbeddingsRetryConfig](../../openai/types/interfaces/EmbeddingsRetryConfig.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](../../openai/types/interfaces/EmbedOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsAdapterOptions","title":"Interface: OllamaEmbeddingsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsAdapterOptions.md\ndescription: >-\n Constructor options for {@link\n @nhtio/adk/batteries/embeddings/ollama/adapter!OllamaEmbeddingsAdapter}.\n---\n\n# Interface: OllamaEmbeddingsAdapterOptions\n\nDefined in: [src/batteries/embeddings/ollama/types.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L43)\n\nConstructor options for [@nhtio/adk/batteries/embeddings/ollama/adapter!OllamaEmbeddingsAdapter](../../adapter/classes/OllamaEmbeddingsAdapter.md).\n\n## Remarks\n\nExtends [BaseEmbeddingsAdapterOptions](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md) with the HTTP transport fields for targeting an\nOllama instance. `model` is **required with no default** — naming the embedding model is the\ncaller's responsibility, never the battery's.\n\n## Extends\n\n* [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | Bearer token. Sent as `Authorization: Bearer ` unless overridden by `headers`. | - | [src/batteries/embeddings/ollama/types.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L45) |\n| `baseURL?` | `string` | API base URL. Default `http://localhost:11434`. A trailing slash is trimmed. | - | [src/batteries/embeddings/ollama/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L47) |\n| `dimensions?` | `number` | Declared output dimensionality, surfaced via `adapter.dimensions`. Optional metadata for callers that pre-allocate buffers; the battery does not enforce it against responses. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`dimensions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-dimensions) | [src/batteries/embeddings/openai/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L84) |\n| `documentPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'document'`. Unset → no prefix. Most asymmetric models (including Arctic) use no document prefix; exposed for symmetry and the models that do. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`documentPrefix`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-documentprefix) | [src/batteries/embeddings/openai/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L79) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Custom `fetch` implementation. Default `globalThis.fetch`. | - | [src/batteries/embeddings/ollama/types.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L51) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Extra request headers. Override built defaults (including `Authorization`) key-by-key. | - | [src/batteries/embeddings/ollama/types.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L49) |\n| `keepAlive?` | `string` | `number` | How long to keep the model loaded after the request. Accepts a duration string or number (ms). | - | [src/batteries/embeddings/ollama/types.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L59) |\n| `model` | `string` | Model id to embed with. **Required, no default.** For OpenAI this is e.g. `text-embedding-3-small`; for WebLLM it is an MLC embedding model id (e.g. `snowflake-arctic-embed-m-q0f32-MLC`). | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`model`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-model) | [src/batteries/embeddings/openai/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L67) |\n| `options?` | [`OllamaEmbeddingsRuntimeOptions`](OllamaEmbeddingsRuntimeOptions.md) | Runtime options forwarded to Ollama's `options` field in the request body. | - | [src/batteries/embeddings/ollama/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L61) |\n| `queryPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'query'`. Unset → no prefix. For Snowflake Arctic Embed, the documented value is `'Represent this sentence for searching relevant passages: '`. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`queryPrefix`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-queryprefix) | [src/batteries/embeddings/openai/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L73) |\n| `requestTimeoutMs?` | `number` | Per-request handshake timeout in ms. `0`/unset disables the timeout. | - | [src/batteries/embeddings/ollama/types.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L55) |\n| `retry?` | [`EmbeddingsRetryConfig`](../../../openai/types/interfaces/EmbeddingsRetryConfig.md) | Retry/backoff configuration. Default: a single attempt (no retry). | - | [src/batteries/embeddings/ollama/types.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L53) |\n| `truncate?` | `boolean` | Whether to truncate inputs that exceed the model's context window. Default `false`. | - | [src/batteries/embeddings/ollama/types.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L57) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRequestBody","title":"Interface: OllamaEmbeddingsRequestBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRequestBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRequestBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRequestBody.md\ndescription: The JSON request body POSTed to `/api/embed`.\n---\n\n# Interface: OllamaEmbeddingsRequestBody\n\nDefined in: [src/batteries/embeddings/ollama/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L67)\n\nThe JSON request body POSTed to `/api/embed`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dimensions?` | `number` | Optional output dimensionality for models that support truncation. | [src/batteries/embeddings/ollama/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L73) |\n| `input` | `string`\\[] | The batch of texts to embed. Always an array, even for a single input. | [src/batteries/embeddings/ollama/types.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L71) |\n| `keep_alive?` | `string` | `number` | How long to keep the model loaded after the request. | [src/batteries/embeddings/ollama/types.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L77) |\n| `model` | `string` | ID of the embedding model to use. | [src/batteries/embeddings/ollama/types.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L69) |\n| `options?` | [`OllamaEmbeddingsRuntimeOptions`](OllamaEmbeddingsRuntimeOptions.md) | Runtime options for the embedding model. | [src/batteries/embeddings/ollama/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L79) |\n| `truncate?` | `boolean` | Whether to truncate inputs that exceed the model's context window. | [src/batteries/embeddings/ollama/types.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L75) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsResponseBody","title":"Interface: OllamaEmbeddingsResponseBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsResponseBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsResponseBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsResponseBody.md\ndescription: The relevant subset of the `/api/embed` JSON response shape.\n---\n\n# Interface: OllamaEmbeddingsResponseBody\n\nDefined in: [src/batteries/embeddings/ollama/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L85)\n\nThe relevant subset of the `/api/embed` JSON response shape.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ------------ | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `embeddings` | `number`\\[]\\[] | The embedding vectors, returned in input order (positional, no index field). | [src/batteries/embeddings/ollama/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L89) |\n| `model?` | `string` | Model that produced the embeddings. | [src/batteries/embeddings/ollama/types.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L87) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRuntimeOptions","title":"Interface: OllamaEmbeddingsRuntimeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRuntimeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRuntimeOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/types/interfaces/OllamaEmbeddingsRuntimeOptions.md\ndescription: >-\n Runtime options for Ollama's `/api/embed` endpoint. These map directly to the\n `options` field in the Ollama request body.\n---\n\n# Interface: OllamaEmbeddingsRuntimeOptions\n\nDefined in: [src/batteries/embeddings/ollama/types.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L28)\n\nRuntime options for Ollama's `/api/embed` endpoint. These map directly to the `options` field\nin the Ollama request body.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | -------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `num_ctx?` | `number` | Context size override for the embedding model. | [src/batteries/embeddings/ollama/types.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L30) |\n| `num_thread?` | `number` | Number of threads to use for inference. | [src/batteries/embeddings/ollama/types.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/types.ts#L32) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation","title":"@nhtio/adk/batteries/embeddings/ollama/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/validation.md'\ndescription: Runtime validation schema and wrapper for Ollama Embeddings adapter options.\n---\n\n# @nhtio/adk/batteries/embeddings/ollama/validation\n\nRuntime validation schema and wrapper for Ollama Embeddings adapter options.\n\n## Remarks\n\nValidates `OllamaEmbeddingsAdapterOptions` at construction time. Throws\n`E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS` on failure — the same hard-fail policy as every other ADK\ncontract. `model` is required; unknown top-level keys are rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| [ollamaEmbeddingsOptionsSchema](variables/ollamaEmbeddingsOptionsSchema.md) | Validator schema for `OllamaEmbeddingsAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `ollamaEmbeddingsOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS` (carrying the validator's report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): OllamaEmbeddingsAdapterOptions;\n```\n\nDefined in: [src/batteries/embeddings/ollama/validation.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/validation.ts#L73)\n\nValidates an arbitrary input against `ollamaEmbeddingsOptionsSchema` and returns the resolved\noptions shape. Throws `E_INVALID_OLLAMA_EMBEDDINGS_OPTIONS` (carrying the validator's report on\n`cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`OllamaEmbeddingsAdapterOptions`](../../types/interfaces/OllamaEmbeddingsAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation/variables/ollamaEmbeddingsOptionsSchema","title":"Variable: ollamaEmbeddingsOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation/variables/ollamaEmbeddingsOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/ollama/validation/variables/ollamaEmbeddingsOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/ollama/validation/variables/ollamaEmbeddingsOptionsSchema.md\ndescription: >-\n Validator schema for `OllamaEmbeddingsAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: ollamaEmbeddingsOptionsSchema\n\n```ts\nconst ollamaEmbeddingsOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/embeddings/ollama/validation.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/ollama/validation.ts#L40)\n\nValidator schema for `OllamaEmbeddingsAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai","title":"@nhtio/adk/batteries/embeddings/openai","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai.md'\ndescription: >-\n OpenAI Embeddings adapter battery — the environment-neutral embeddings battery\n and owner of the shared embeddings option base.\n---\n\n# @nhtio/adk/batteries/embeddings/openai\n\nOpenAI Embeddings adapter battery — the environment-neutral embeddings battery and owner of the\nshared embeddings option base.\n\n## Remarks\n\nRe-exports the adapter class, the shared prefix helper, every option / wire-shape type alias\n(including the shared [BaseEmbeddingsAdapterOptions](types/interfaces/BaseEmbeddingsAdapterOptions.md), [EmbeddingKind](types/type-aliases/EmbeddingKind.md),\n[EmbedOptions](types/interfaces/EmbedOptions.md), and [EmbeddingsRetryConfig](types/interfaces/EmbeddingsRetryConfig.md) that the WebLLM Embeddings battery builds\non), the validation schema + `validateOptions` wrapper, and the battery-scoped exceptions.\n\n## References\n\n### applyEmbeddingPrefix\n\nRe-exports [applyEmbeddingPrefix](helpers/functions/applyEmbeddingPrefix.md)\n\n***\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS](exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR](exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbeddingsRetryConfig\n\nRe-exports [EmbeddingsRetryConfig](types/interfaces/EmbeddingsRetryConfig.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](types/interfaces/EmbedOptions.md)\n\n***\n\n### OpenAIEmbeddingsAdapter\n\nRe-exports [OpenAIEmbeddingsAdapter](adapter/classes/OpenAIEmbeddingsAdapter.md)\n\n***\n\n### OpenAIEmbeddingsAdapterOptions\n\nRe-exports [OpenAIEmbeddingsAdapterOptions](types/interfaces/OpenAIEmbeddingsAdapterOptions.md)\n\n***\n\n### openAIEmbeddingsOptionsSchema\n\nRe-exports [openAIEmbeddingsOptionsSchema](validation/variables/openAIEmbeddingsOptionsSchema.md)\n\n***\n\n### OpenAIEmbeddingsRequestBody\n\nRe-exports [OpenAIEmbeddingsRequestBody](types/interfaces/OpenAIEmbeddingsRequestBody.md)\n\n***\n\n### OpenAIEmbeddingsResponseBody\n\nRe-exports [OpenAIEmbeddingsResponseBody](types/interfaces/OpenAIEmbeddingsResponseBody.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/adapter","title":"@nhtio/adk/batteries/embeddings/openai/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/adapter.md'\ndescription: Cross-environment OpenAI Embeddings adapter battery.\n---\n\n# @nhtio/adk/batteries/embeddings/openai/adapter\n\nCross-environment OpenAI Embeddings adapter battery.\n\n## Remarks\n\nOpinionated embeddings battery for the OpenAI `/v1/embeddings` wire shape. Ships an\n[OpenAIEmbeddingsAdapter](classes/OpenAIEmbeddingsAdapter.md) that targets any OpenAI-`/v1/embeddings`-compatible endpoint\n(OpenAI proper, Azure-behind-proxy, vLLM, Together, a local gateway, etc.) over raw `fetch` —\nno SDK dependency, so it runs unchanged in Node, the browser, edge runtimes, and workers.\n\nThe class shares its method surface, return types, prefix handling, and option base with the\nWebLLM Embeddings battery: the two differ only in their engine. See\n[@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions](../types/interfaces/BaseEmbeddingsAdapterOptions.md).\n\nConstruction validates options eagerly via [@nhtio/adk/batteries/embeddings/openai/validation!validateOptions](../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries/embeddings/openai/exceptions!E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS](../exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md) on failure — config bugs fail loud, not at embed time.\n\n## Classes\n\n| Class | Description |\n| ------------------------------------------------------------- | -------------------------------------------------------------- |\n| [OpenAIEmbeddingsAdapter](classes/OpenAIEmbeddingsAdapter.md) | Embeddings adapter for the OpenAI `/v1/embeddings` wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/adapter/classes/OpenAIEmbeddingsAdapter","title":"Class: OpenAIEmbeddingsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/adapter/classes/OpenAIEmbeddingsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/adapter/classes/OpenAIEmbeddingsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/adapter/classes/OpenAIEmbeddingsAdapter.md\ndescription: Embeddings adapter for the OpenAI `/v1/embeddings` wire shape.\n---\n\n# Class: OpenAIEmbeddingsAdapter\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L51)\n\nEmbeddings adapter for the OpenAI `/v1/embeddings` wire shape.\n\n## Remarks\n\nReusable: construct once, call [OpenAIEmbeddingsAdapter.embed](#embed) / [embedMany](#embedmany) as many\ntimes as needed. `embedMany` issues one request per call (OpenAI embeds a batch in a single\nround-trip); `embed` is sugar over `embedMany([text])`.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OpenAIEmbeddingsAdapter(options: unknown): OpenAIEmbeddingsAdapter;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L68)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`OpenAIEmbeddingsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/openai/exceptions!E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS](../../exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md) when `options` does not satisfy\n[@nhtio/adk/batteries/embeddings/openai/validation!openAIEmbeddingsOptionsSchema](../../validation/variables/openAIEmbeddingsOptionsSchema.md) (e.g. missing `model`).\n\n## Accessors\n\n### dimensions\n\n#### Get Signature\n\n```ts\nget dimensions(): number | undefined;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L73)\n\nDeclared output dimensionality (from options), or `undefined` if not configured.\n\n##### Returns\n\n`number` | `undefined`\n\n## Methods\n\n### embed()\n\n```ts\nembed(text: string, opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L104)\n\nEmbeds a single string.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------- | -------------------------- |\n| `text` | `string` | The input text. |\n| `opts?` | [`EmbedOptions`](../../types/interfaces/EmbedOptions.md) | Per-call options (`kind`). |\n\n#### Returns\n\n`Promise`<`number`\\[]>\n\nThe embedding vector as a plain `number[]`.\n\n***\n\n### embedMany()\n\n```ts\nembedMany(texts: string[], opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L119)\n\nEmbeds a batch of strings in a single request.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------- | ---------------------------------------------------------- |\n| `texts` | `string`\\[] | The input texts. |\n| `opts?` | [`EmbedOptions`](../../types/interfaces/EmbedOptions.md) | Per-call options (`kind`). Defaults to `kind: 'document'`. |\n\n#### Returns\n\n`Promise`<`number`\\[]\\[]>\n\nOne embedding vector per input, in input order, each a plain `number[]`.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/openai/exceptions!E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR](../../exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR.md) on a non-2xx response or transport failure.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/openai/exceptions!E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](../../exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT.md) when the handshake exceeds `requestTimeoutMs`.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/openai/exceptions!E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](../../exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE.md) when the 2xx body is not the expected shape.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L78)\n\nSee [OpenAIEmbeddingsAdapter.isAvailable](#isavailable-1). Instance alias for surface-parity.\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L86)\n\nNo-op warm-up. The OpenAI battery has no engine to preload; present for surface-parity with\nthe WebLLM battery so callers can treat the two interchangeably.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L93)\n\nNo-op state reset. Present for surface-parity with the WebLLM battery.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/openai/adapter.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/adapter.ts#L59)\n\nWhether this battery can run in the current environment. For the HTTP-backed OpenAI battery\nthis is always `true` (a `fetch` is always resolvable); present for surface-parity with the\nWebLLM battery's WebGPU gate.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions","title":"@nhtio/adk/batteries/embeddings/openai/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/exceptions.md'\ndescription: Battery-scoped exception constructors for OpenAI Embeddings adapter failures.\n---\n\n# @nhtio/adk/batteries/embeddings/openai/exceptions\n\nBattery-scoped exception constructors for OpenAI Embeddings adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the OpenAI Embeddings adapter. These exceptions are owned\nby the battery (not the ADK core) and are minted via `createException` from\n`@nhtio/adk/factories`. Re-exported from the battery's barrel.\n\nThe categories mirror the WebLLM Embeddings battery one-to-one so the two batteries fail with\nparallel semantics — only the engine-specific transport exception differs.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS](variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `openAIEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, or an unknown option key. Fatal: config bugs fail loud at construction time, not at embed time. |\n| [E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR](variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR.md) | Thrown when the upstream `/v1/embeddings` endpoint returns a non-2xx response (after retries are exhausted), or the transport throws. Non-fatal. Printf args: `[status, detail]` — `status` is `0` for a transport-level failure with no HTTP response. |\n| [E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE](variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE.md) | Thrown when a 2xx response body cannot be parsed into the expected `{ data: [{ embedding: number[] }] }` shape (malformed JSON, missing `data`, wrong vector count). Non-fatal. Printf arg: `[detail]`. |\n| [E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT](variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT.md) | Thrown when the request handshake does not complete before `requestTimeoutMs` (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS","title":"Variable: E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_INVALID_OPENAI_EMBEDDINGS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `openAIEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, or an unknown\n option key. Fatal: config bugs fail loud at construction time, not at embed\n time.\n---\n\n# Variable: E\\_INVALID\\_OPENAI\\_EMBEDDINGS\\_OPTIONS\n\n```ts\nconst E_INVALID_OPENAI_EMBEDDINGS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/openai/exceptions.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/exceptions.ts#L22)\n\nThrown when the resolved adapter options fail validation against\n`openAIEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, or an unknown option key.\nFatal: config bugs fail loud at construction time, not at embed time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR","title":"Variable: E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_HTTP_ERROR.md\ndescription: >-\n Thrown when the upstream `/v1/embeddings` endpoint returns a non-2xx response\n (after retries are exhausted), or the transport throws. Non-fatal. Printf\n args: `[status, detail]` — `status` is `0` for a transport-level failure with\n no HTTP response.\n---\n\n# Variable: E\\_OPENAI\\_EMBEDDINGS\\_HTTP\\_ERROR\n\n```ts\nconst E_OPENAI_EMBEDDINGS_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/embeddings/openai/exceptions.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/exceptions.ts#L35)\n\nThrown when the upstream `/v1/embeddings` endpoint returns a non-2xx response (after retries\nare exhausted), or the transport throws. Non-fatal. Printf args: `[status, detail]` — `status`\nis `0` for a transport-level failure with no HTTP response.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE","title":"Variable: E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE.md\ndescription: >-\n Thrown when a 2xx response body cannot be parsed into the expected `{ data: [{\n embedding: number[] }] }` shape (malformed JSON, missing `data`, wrong vector\n count). Non-fatal. Printf arg: `[detail]`.\n---\n\n# Variable: E\\_OPENAI\\_EMBEDDINGS\\_MALFORMED\\_RESPONSE\n\n```ts\nconst E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/openai/exceptions.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/exceptions.ts#L60)\n\nThrown when a 2xx response body cannot be parsed into the expected\n`{ data: [{ embedding: number[] }] }` shape (malformed JSON, missing `data`, wrong vector\ncount). Non-fatal. Printf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT","title":"Variable: E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/exceptions/variables/E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT.md\ndescription: >-\n Thrown when the request handshake does not complete before `requestTimeoutMs`\n (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n---\n\n# Variable: E\\_OPENAI\\_EMBEDDINGS\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/embeddings/openai/exceptions.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/exceptions.ts#L47)\n\nThrown when the request handshake does not complete before `requestTimeoutMs` (and retries are\nexhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/helpers","title":"@nhtio/adk/batteries/embeddings/openai/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/helpers.md'\ndescription: 'Shared, engine-agnostic helpers for the embeddings batteries.'\n---\n\n# @nhtio/adk/batteries/embeddings/openai/helpers\n\nShared, engine-agnostic helpers for the embeddings batteries.\n\n## Remarks\n\nOwned by the OpenAI Embeddings battery (the environment-neutral one) and re-used by the WebLLM\nEmbeddings battery, so query/document prefixing behaves identically across both — the engine is\nthe only difference between the batteries.\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| [applyEmbeddingPrefix](functions/applyEmbeddingPrefix.md) | Applies the configured query/document instruction prefix to a batch of inputs. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/helpers/functions/applyEmbeddingPrefix","title":"Function: applyEmbeddingPrefix()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/helpers/functions/applyEmbeddingPrefix.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/helpers/functions/applyEmbeddingPrefix","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/helpers/functions/applyEmbeddingPrefix.md\n---\n\n# Function: applyEmbeddingPrefix()\n\n```ts\nfunction applyEmbeddingPrefix(\n texts: readonly string[],\n kind: EmbeddingKind,\n options: Pick,\n): string[];\n```\n\nDefined in: [src/batteries/embeddings/openai/helpers.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/helpers.ts#L27)\n\nApplies the configured query/document instruction prefix to a batch of inputs.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |\n| `texts` | readonly `string`\\[] | The raw inputs to embed. |\n| `kind` | [`EmbeddingKind`](../../types/type-aliases/EmbeddingKind.md) | Whether these are queries or documents. |\n| `options` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<[`BaseEmbeddingsAdapterOptions`](../../types/interfaces/BaseEmbeddingsAdapterOptions.md), `\"queryPrefix\"` | `\"documentPrefix\"`> | Carries `queryPrefix` / `documentPrefix`. |\n\n## Returns\n\n`string`\\[]\n\nA new array with prefixes applied (never mutates the input).\n\n## Remarks\n\n`kind: 'query'` → prepend `queryPrefix` (if set); `kind: 'document'` → prepend `documentPrefix`\n(if set). When the relevant prefix is unset, inputs pass through verbatim. This is the single\nsource of truth for prefix handling shared by both batteries.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types","title":"@nhtio/adk/batteries/embeddings/openai/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types.md'\ndescription: >-\n Option and wire-shape types for the OpenAI Embeddings adapter, plus the shared\n embeddings battery base type both bundled embeddings batteries build on.\n---\n\n# @nhtio/adk/batteries/embeddings/openai/types\n\nOption and wire-shape types for the OpenAI Embeddings adapter, plus the shared embeddings\nbattery base type both bundled embeddings batteries build on.\n\n## Remarks\n\nThis module owns the **shared** embeddings option base ([BaseEmbeddingsAdapterOptions](interfaces/BaseEmbeddingsAdapterOptions.md))\nand the shared call shapes ([EmbeddingKind](type-aliases/EmbeddingKind.md), [EmbedOptions](interfaces/EmbedOptions.md)). The WebLLM Embeddings\nbattery re-exports and `extends` these rather than redefining them, so the two batteries differ\nonly in their engine — exactly how the WebLLM Chat Completions battery extends the OpenAI Chat\nCompletions option type.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [BaseEmbeddingsAdapterOptions](interfaces/BaseEmbeddingsAdapterOptions.md) | Options shared by **every** embeddings battery, regardless of engine. |\n| [EmbeddingsRetryConfig](interfaces/EmbeddingsRetryConfig.md) | Retry/backoff configuration for HTTP-backed embeddings batteries. Mirrors the chat battery's `ChatCompletionsRetryConfig` so behavior is consistent across the bundled batteries. |\n| [EmbedOptions](interfaces/EmbedOptions.md) | Per-call options accepted by `embed` / `embedMany`. Identical across both batteries. |\n| [OpenAIEmbeddingsAdapterOptions](interfaces/OpenAIEmbeddingsAdapterOptions.md) | Constructor options for [@nhtio/adk/batteries/embeddings/openai/adapter!OpenAIEmbeddingsAdapter](../adapter/classes/OpenAIEmbeddingsAdapter.md). |\n| [OpenAIEmbeddingsRequestBody](interfaces/OpenAIEmbeddingsRequestBody.md) | The JSON request body POSTed to `/v1/embeddings`. |\n| [OpenAIEmbeddingsResponseBody](interfaces/OpenAIEmbeddingsResponseBody.md) | The relevant subset of the `/v1/embeddings` JSON response shape. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| [EmbeddingKind](type-aliases/EmbeddingKind.md) | Whether a piece of text is being embedded as a search **query** or as a corpus **document**. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/BaseEmbeddingsAdapterOptions","title":"Interface: BaseEmbeddingsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/BaseEmbeddingsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/BaseEmbeddingsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/BaseEmbeddingsAdapterOptions.md\ndescription: 'Options shared by **every** embeddings battery, regardless of engine.'\n---\n\n# Interface: BaseEmbeddingsAdapterOptions\n\nDefined in: [src/batteries/embeddings/openai/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L61)\n\nOptions shared by **every** embeddings battery, regardless of engine.\n\n## Remarks\n\nEngine-specific batteries extend this with their own transport/engine fields. `model` is\n**required with no default** — naming the embedding model is the caller's responsibility, never\nthe battery's.\n\n## Extended by\n\n* [`WebLLMEmbeddingsAdapterOptions`](../../../webllm/types/interfaces/WebLLMEmbeddingsAdapterOptions.md)\n* [`TransformersJsEmbeddingsAdapterOptions`](../../../transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions.md)\n* [`OpenAIEmbeddingsAdapterOptions`](OpenAIEmbeddingsAdapterOptions.md)\n* [`OllamaEmbeddingsAdapterOptions`](../../../ollama/types/interfaces/OllamaEmbeddingsAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dimensions?` | `number` | Declared output dimensionality, surfaced via `adapter.dimensions`. Optional metadata for callers that pre-allocate buffers; the battery does not enforce it against responses. | [src/batteries/embeddings/openai/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L84) |\n| `documentPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'document'`. Unset → no prefix. Most asymmetric models (including Arctic) use no document prefix; exposed for symmetry and the models that do. | [src/batteries/embeddings/openai/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L79) |\n| `model` | `string` | Model id to embed with. **Required, no default.** For OpenAI this is e.g. `text-embedding-3-small`; for WebLLM it is an MLC embedding model id (e.g. `snowflake-arctic-embed-m-q0f32-MLC`). | [src/batteries/embeddings/openai/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L67) |\n| `queryPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'query'`. Unset → no prefix. For Snowflake Arctic Embed, the documented value is `'Represent this sentence for searching relevant passages: '`. | [src/batteries/embeddings/openai/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L73) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbeddingsRetryConfig","title":"Interface: EmbeddingsRetryConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbeddingsRetryConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbeddingsRetryConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbeddingsRetryConfig.md\ndescription: >-\n Retry/backoff configuration for HTTP-backed embeddings batteries. Mirrors the\n chat battery's `ChatCompletionsRetryConfig` so behavior is consistent across\n the bundled batteries.\n---\n\n# Interface: EmbeddingsRetryConfig\n\nDefined in: [src/batteries/embeddings/openai/types.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L40)\n\nRetry/backoff configuration for HTTP-backed embeddings batteries. Mirrors the chat battery's\n`ChatCompletionsRetryConfig` so behavior is consistent across the bundled batteries.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | ---------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `baseDelayMs?` | `number` | Base backoff delay in ms; doubled each attempt. Default `500`. | [src/batteries/embeddings/openai/types.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L44) |\n| `honorRetryAfter?` | `boolean` | Honor an upstream `Retry-After` header when present. Default `true`. | [src/batteries/embeddings/openai/types.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L50) |\n| `maxAttempts?` | `number` | Max total attempts (including the first). Default `1` (no retry). | [src/batteries/embeddings/openai/types.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L42) |\n| `maxDelayMs?` | `number` | Backoff ceiling in ms. Default `30_000`. | [src/batteries/embeddings/openai/types.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L46) |\n| `retriableStatuses?` | `number`\\[] | HTTP statuses eligible for retry. Default `[429, 500, 502, 503, 504]`. | [src/batteries/embeddings/openai/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L48) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbedOptions","title":"Interface: EmbedOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbedOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbedOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/EmbedOptions.md\ndescription: >-\n Per-call options accepted by `embed` / `embedMany`. Identical across both\n batteries.\n---\n\n# Interface: EmbedOptions\n\nDefined in: [src/batteries/embeddings/openai/types.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L31)\n\nPer-call options accepted by `embed` / `embedMany`. Identical across both batteries.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind?` | [`EmbeddingKind`](../type-aliases/EmbeddingKind.md) | Whether the input is a query or a document. Defaults to `'document'`. | [src/batteries/embeddings/openai/types.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L33) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsAdapterOptions","title":"Interface: OpenAIEmbeddingsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsAdapterOptions.md\ndescription: >-\n Constructor options for {@link\n @nhtio/adk/batteries/embeddings/openai/adapter!OpenAIEmbeddingsAdapter}.\n---\n\n# Interface: OpenAIEmbeddingsAdapterOptions\n\nDefined in: [src/batteries/embeddings/openai/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L95)\n\nConstructor options for [@nhtio/adk/batteries/embeddings/openai/adapter!OpenAIEmbeddingsAdapter](../../adapter/classes/OpenAIEmbeddingsAdapter.md).\n\n## Remarks\n\nExtends [BaseEmbeddingsAdapterOptions](BaseEmbeddingsAdapterOptions.md) with the HTTP transport fields the WebLLM battery\ndeliberately omits. Targets any OpenAI-`/v1/embeddings`-compatible endpoint (OpenAI proper,\nAzure-behind-proxy, vLLM, Together, a local gateway, etc.).\n\n## Extends\n\n* [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | Bearer token. Sent as `Authorization: Bearer ` unless overridden by `headers`. | - | [src/batteries/embeddings/openai/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L97) |\n| `baseURL?` | `string` | API base URL. Default `https://api.openai.com/v1`. A trailing slash is trimmed. | - | [src/batteries/embeddings/openai/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L99) |\n| `dimensions?` | `number` | Declared output dimensionality, surfaced via `adapter.dimensions`. Optional metadata for callers that pre-allocate buffers; the battery does not enforce it against responses. | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`dimensions`](BaseEmbeddingsAdapterOptions.md#property-dimensions) | [src/batteries/embeddings/openai/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L84) |\n| `documentPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'document'`. Unset → no prefix. Most asymmetric models (including Arctic) use no document prefix; exposed for symmetry and the models that do. | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`documentPrefix`](BaseEmbeddingsAdapterOptions.md#property-documentprefix) | [src/batteries/embeddings/openai/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L79) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Custom `fetch` implementation. Default `globalThis.fetch`. | - | [src/batteries/embeddings/openai/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L103) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Extra request headers. Override built defaults (including `Authorization`) key-by-key. | - | [src/batteries/embeddings/openai/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L101) |\n| `model` | `string` | Model id to embed with. **Required, no default.** For OpenAI this is e.g. `text-embedding-3-small`; for WebLLM it is an MLC embedding model id (e.g. `snowflake-arctic-embed-m-q0f32-MLC`). | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`model`](BaseEmbeddingsAdapterOptions.md#property-model) | [src/batteries/embeddings/openai/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L67) |\n| `queryPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'query'`. Unset → no prefix. For Snowflake Arctic Embed, the documented value is `'Represent this sentence for searching relevant passages: '`. | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`queryPrefix`](BaseEmbeddingsAdapterOptions.md#property-queryprefix) | [src/batteries/embeddings/openai/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L73) |\n| `requestTimeoutMs?` | `number` | Per-request handshake timeout in ms. `0`/unset disables the timeout. | - | [src/batteries/embeddings/openai/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L107) |\n| `retry?` | [`EmbeddingsRetryConfig`](EmbeddingsRetryConfig.md) | Retry/backoff configuration. Default: a single attempt (no retry). | - | [src/batteries/embeddings/openai/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L105) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsRequestBody","title":"Interface: OpenAIEmbeddingsRequestBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsRequestBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsRequestBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsRequestBody.md\ndescription: The JSON request body POSTed to `/v1/embeddings`.\n---\n\n# Interface: OpenAIEmbeddingsRequestBody\n\nDefined in: [src/batteries/embeddings/openai/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L113)\n\nThe JSON request body POSTed to `/v1/embeddings`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------- | ---------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dimensions?` | `number` | Optional output dimensionality for models that support truncation. | [src/batteries/embeddings/openai/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L121) |\n| `encoding_format` | `\"float\"` | Wire encoding for the returned vectors; always `'float'`. | [src/batteries/embeddings/openai/types.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L119) |\n| `input` | `string`\\[] | The batch of texts to embed. | [src/batteries/embeddings/openai/types.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L117) |\n| `model` | `string` | ID of the embedding model to use. | [src/batteries/embeddings/openai/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L115) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsResponseBody","title":"Interface: OpenAIEmbeddingsResponseBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsResponseBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsResponseBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsResponseBody.md\ndescription: The relevant subset of the `/v1/embeddings` JSON response shape.\n---\n\n# Interface: OpenAIEmbeddingsResponseBody\n\nDefined in: [src/batteries/embeddings/openai/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L127)\n\nThe relevant subset of the `/v1/embeddings` JSON response shape.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `data` | { `embedding`: `number`\\[]; `index`: `number`; }\\[] | The embedding vectors, each tagged with its input `index`. | [src/batteries/embeddings/openai/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L129) |\n| `model?` | `string` | Model that produced the embeddings. | [src/batteries/embeddings/openai/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L131) |\n| `object?` | `string` | Object type reported by the API (e.g. `'list'`). | [src/batteries/embeddings/openai/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L133) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/type-aliases/EmbeddingKind","title":"Type Alias: EmbeddingKind","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/type-aliases/EmbeddingKind.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/types/type-aliases/EmbeddingKind","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/type-aliases/EmbeddingKind.md\ndescription: >-\n Whether a piece of text is being embedded as a search **query** or as a corpus\n **document**.\n---\n\n# Type Alias: EmbeddingKind\n\n```ts\ntype EmbeddingKind = \"query\" | \"document\";\n```\n\nDefined in: [src/batteries/embeddings/openai/types.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L26)\n\nWhether a piece of text is being embedded as a search **query** or as a corpus **document**.\n\n## Remarks\n\nAsymmetric-embedding models (e.g. Snowflake Arctic Embed) expect a short instruction prefix on\nqueries but not on documents. The battery prepends [BaseEmbeddingsAdapterOptions.queryPrefix](../interfaces/BaseEmbeddingsAdapterOptions.md#property-queryprefix)\nwhen `kind === 'query'` and [BaseEmbeddingsAdapterOptions.documentPrefix](../interfaces/BaseEmbeddingsAdapterOptions.md#property-documentprefix) when\n`kind === 'document'` — each only if the corresponding prefix option is set. Defaults to\n`'document'`, so the neutral (un-prefixed, unless a document prefix is configured) path is taken\nwhen a caller does not specify.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation","title":"@nhtio/adk/batteries/embeddings/openai/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/validation.md'\ndescription: Runtime validation schema and wrapper for OpenAI Embeddings adapter options.\n---\n\n# @nhtio/adk/batteries/embeddings/openai/validation\n\nRuntime validation schema and wrapper for OpenAI Embeddings adapter options.\n\n## Remarks\n\nValidates `OpenAIEmbeddingsAdapterOptions` at construction time. Throws\n`E_INVALID_OPENAI_EMBEDDINGS_OPTIONS` on failure — the same hard-fail policy as every other ADK\ncontract. `model` is required; unknown top-level keys are rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| [openAIEmbeddingsOptionsSchema](variables/openAIEmbeddingsOptionsSchema.md) | Validator schema for `OpenAIEmbeddingsAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `openAIEmbeddingsOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_OPENAI_EMBEDDINGS_OPTIONS` (carrying the validator's report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): OpenAIEmbeddingsAdapterOptions;\n```\n\nDefined in: [src/batteries/embeddings/openai/validation.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/validation.ts#L61)\n\nValidates an arbitrary input against `openAIEmbeddingsOptionsSchema` and returns the resolved\noptions shape. Throws `E_INVALID_OPENAI_EMBEDDINGS_OPTIONS` (carrying the validator's report on\n`cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`OpenAIEmbeddingsAdapterOptions`](../../types/interfaces/OpenAIEmbeddingsAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation/variables/openAIEmbeddingsOptionsSchema","title":"Variable: openAIEmbeddingsOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation/variables/openAIEmbeddingsOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/openai/validation/variables/openAIEmbeddingsOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/validation/variables/openAIEmbeddingsOptionsSchema.md\ndescription: >-\n Validator schema for `OpenAIEmbeddingsAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: openAIEmbeddingsOptionsSchema\n\n```ts\nconst openAIEmbeddingsOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/embeddings/openai/validation.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/validation.ts#L33)\n\nValidator schema for `OpenAIEmbeddingsAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js","title":"@nhtio/adk/batteries/embeddings/transformers\\_js","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js.md'\ndescription: >-\n transformers.js Embeddings adapter battery — dual-environment ONNX\n feature-extraction.\n---\n\n# @nhtio/adk/batteries/embeddings/transformers\\_js\n\ntransformers.js Embeddings adapter battery — dual-environment ONNX feature-extraction.\n\n## Remarks\n\nEnvironment-neutral (Node + browser, ONNX Runtime auto-selected) — so, unlike the WebLLM embeddings\nbattery, it IS re-exported from the environment-neutral `@nhtio/adk/batteries/embeddings` barrel.\nRe-exports the adapter class, the validation schema + `validateOptions` wrapper, every option /\npipeline type alias (including the shared base shapes re-exported from the OpenAI battery), and the\nbattery-scoped exceptions.\n\n## References\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTransformersJsEmbeddingsPipeline\n\nRe-exports [CreateTransformersJsEmbeddingsPipeline](types/type-aliases/CreateTransformersJsEmbeddingsPipeline.md)\n\n***\n\n### defaultPoolAndNormalize\n\nRe-exports [defaultPoolAndNormalize](pooling/variables/defaultPoolAndNormalize.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS](exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR](exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](../openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](../openai/types/interfaces/EmbedOptions.md)\n\n***\n\n### l2Normalize\n\nRe-exports [l2Normalize](pooling/functions/l2Normalize.md)\n\n***\n\n### poolAndNormalize\n\nRe-exports [poolAndNormalize](pooling/functions/poolAndNormalize.md)\n\n***\n\n### Pooled2D\n\nRe-exports [Pooled2D](pooling/type-aliases/Pooled2D.md)\n\n***\n\n### TokenStates3D\n\nRe-exports [TokenStates3D](pooling/type-aliases/TokenStates3D.md)\n\n***\n\n### TransformersJsEmbeddingsAdapter\n\nRe-exports [TransformersJsEmbeddingsAdapter](adapter/classes/TransformersJsEmbeddingsAdapter.md)\n\n***\n\n### TransformersJsEmbeddingsAdapterOptions\n\nRe-exports [TransformersJsEmbeddingsAdapterOptions](types/interfaces/TransformersJsEmbeddingsAdapterOptions.md)\n\n***\n\n### TransformersJsEmbeddingsDataType\n\nRe-exports [TransformersJsEmbeddingsDataType](types/type-aliases/TransformersJsEmbeddingsDataType.md)\n\n***\n\n### TransformersJsEmbeddingsDeviceType\n\nRe-exports [TransformersJsEmbeddingsDeviceType](types/type-aliases/TransformersJsEmbeddingsDeviceType.md)\n\n***\n\n### TransformersJsEmbeddingsModelSource\n\nRe-exports [TransformersJsEmbeddingsModelSource](types/type-aliases/TransformersJsEmbeddingsModelSource.md)\n\n***\n\n### transformersJsEmbeddingsOptionsSchema\n\nRe-exports [transformersJsEmbeddingsOptionsSchema](validation/variables/transformersJsEmbeddingsOptionsSchema.md)\n\n***\n\n### TransformersJsEmbeddingsPipeline\n\nRe-exports [TransformersJsEmbeddingsPipeline](types/type-aliases/TransformersJsEmbeddingsPipeline.md)\n\n***\n\n### TransformersJsEmbeddingsProgressCallback\n\nRe-exports [TransformersJsEmbeddingsProgressCallback](types/type-aliases/TransformersJsEmbeddingsProgressCallback.md)\n\n***\n\n### TransformersJsPooling\n\nRe-exports [TransformersJsPooling](types/type-aliases/TransformersJsPooling.md)\n\n***\n\n### TransformersJsPoolingOwner\n\nRe-exports [TransformersJsPoolingOwner](types/type-aliases/TransformersJsPoolingOwner.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter","title":"@nhtio/adk/batteries/embeddings/transformers\\_js/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter.md\ndescription: 'transformers.js (ONNX, dual-environment) Embeddings adapter battery.'\n---\n\n# @nhtio/adk/batteries/embeddings/transformers\\_js/adapter\n\ntransformers.js (ONNX, dual-environment) Embeddings adapter battery.\n\n## Remarks\n\nEmbeddings battery backed by transformers.js's `feature-extraction` pipeline. **Environment-neutral**\n— runs in Node (via `onnxruntime-node`) and the browser (via `onnxruntime-web` / WebGPU), auto-\nselected by the package; there is no WebGPU requirement, so this battery is surfaced from the\nenvironment-neutral `@nhtio/adk/batteries/embeddings` barrel alongside the OpenAI one.\n\nSame user-facing surface as the OpenAI / WebLLM embeddings batteries (`isAvailable` / `dimensions` /\n`preload` / `reset` / `embed` / `embedMany`), same `number[]` return shape, same query/document\nprefix handling (the shared `applyEmbeddingPrefix`).\n\n`@huggingface/transformers` is an optional peer dependency, imported lazily.\n\n**Cross-runtime vector caveat:** embeddings produced here are not guaranteed bit-identical to those\nfrom a different runtime (WebLLM/MLC, or even node-ONNX vs web-ONNX for the same model). A vector\ncorpus must be embedded AND queried by one backend.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------------------------- | --------------------------------------------------------------------- |\n| [TransformersJsEmbeddingsAdapter](classes/TransformersJsEmbeddingsAdapter.md) | Embeddings adapter for transformers.js's feature-extraction pipeline. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter","title":"Class: TransformersJsEmbeddingsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter.md\ndescription: Embeddings adapter for transformers.js's feature-extraction pipeline.\n---\n\n# Class: TransformersJsEmbeddingsAdapter\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L65)\n\nEmbeddings adapter for transformers.js's feature-extraction pipeline.\n\n## Remarks\n\nReusable: construct once, call [TransformersJsEmbeddingsAdapter.embed](#embed) / [embedMany](#embedmany) as\nmany times as needed. The pipeline is resolved lazily on first use (or via [preload](#preload)) and\ncached with single-flight semantics so concurrent calls share one load.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew TransformersJsEmbeddingsAdapter(options: unknown): TransformersJsEmbeddingsAdapter;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L82)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`TransformersJsEmbeddingsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md) when invalid.\n\n## Accessors\n\n### dimensions\n\n#### Get Signature\n\n```ts\nget dimensions(): number | undefined;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L88)\n\nDeclared output dimensionality (from options), or `undefined` if not configured.\n\n##### Returns\n\n`number` | `undefined`\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L118)\n\nRelease the loaded model's ONNX sessions + GPU/wasm buffers, then drop the cached pipeline.\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\n`reset()` only nulls the JS reference; the native ONNX Runtime sessions and WebGPU/wasm device memory\nstay alive until GC. Loading many embedding models back-to-back in one browser session (e.g. a full\nmatrix run) accumulates those sessions until the heap is exhausted. `FeatureExtractionPipeline`\nextends `Pipeline`, which exposes `dispose()` — this awaits it so the memory is reclaimed between\nloads, swallows a disposal error (teardown must not throw), and finishes with `reset()`. Idempotent.\n\n***\n\n### embed()\n\n```ts\nembed(text: string, opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L189)\n\nEmbeds a single string.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------ | -------------------------- |\n| `text` | `string` | The input text. |\n| `opts?` | [`EmbedOptions`](../../../openai/types/interfaces/EmbedOptions.md) | Per-call options (`kind`). |\n\n#### Returns\n\n`Promise`<`number`\\[]>\n\nThe embedding vector as a plain `number[]`.\n\n***\n\n### embedMany()\n\n```ts\nembedMany(texts: string[], opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L203)\n\nEmbeds a batch of strings in a single pipeline call.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |\n| `texts` | `string`\\[] | The input texts. |\n| `opts?` | [`EmbedOptions`](../../../openai/types/interfaces/EmbedOptions.md) | Per-call options (`kind`). Defaults to `kind: 'document'`. |\n\n#### Returns\n\n`Promise`<`number`\\[]\\[]>\n\nOne embedding vector per input, in input order, each a plain `number[]`.\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR](../../exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR.md) when the call fails\nor returns a malformed result.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L93)\n\nInstance availability probe (honours an injected `isAvailable`).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L98)\n\nEagerly loads (and caches) the pipeline so the first `embed` call is fast. Idempotent.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L103)\n\nDrops the cached pipeline and in-flight load so the next call reloads.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/adapter.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/adapter.ts#L74)\n\nWhether this battery is available. transformers.js is environment-neutral (Node + browser), so\nthis is `true` whenever the runtime can import the peer — there is no WebGPU requirement.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions","title":"@nhtio/adk/batteries/embeddings/transformers\\_js/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions.md\ndescription: >-\n Battery-scoped exception constructors for the transformers.js Embeddings\n adapter.\n---\n\n# @nhtio/adk/batteries/embeddings/transformers\\_js/exceptions\n\nBattery-scoped exception constructors for the transformers.js Embeddings adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the transformers.js (`@huggingface/transformers`) Embeddings\nadapter, minted via `createException` from `@nhtio/adk/factories`. Categories mirror the OpenAI and\nWebLLM embeddings batteries one-to-one — only the engine-specific failure differs.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS](variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `transformersJsEmbeddingsOptionsSchema` — e.g. a missing/empty `model` or an unknown option key. Fatal: config bugs fail loud, not at embed time. |\n| [E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR](variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR.md) | Thrown when the transformers.js pipeline fails to load (e.g. the `@huggingface/transformers` peer is not installed) or the `feature-extraction` call throws/returns a malformed result. Non-fatal. Printf arg: `[detail]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS","title":"Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `transformersJsEmbeddingsOptionsSchema` — e.g. a missing/empty `model` or an\n unknown option key. Fatal: config bugs fail loud, not at embed time.\n---\n\n# Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS\n\n```ts\nconst E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/exceptions.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/exceptions.ts#L19)\n\nThrown when the resolved adapter options fail validation against\n`transformersJsEmbeddingsOptionsSchema` — e.g. a missing/empty `model` or an unknown option key.\nFatal: config bugs fail loud, not at embed time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR","title":"Variable: E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR.md\ndescription: >-\n Thrown when the transformers.js pipeline fails to load (e.g. the\n `@huggingface/transformers` peer is not installed) or the `feature-extraction`\n call throws/returns a malformed result. Non-fatal. Printf arg: `[detail]`.\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_ENGINE\\_ERROR\n\n```ts\nconst E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/exceptions.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/exceptions.ts#L32)\n\nThrown when the transformers.js pipeline fails to load (e.g. the `@huggingface/transformers` peer\nis not installed) or the `feature-extraction` call throws/returns a malformed result. Non-fatal.\nPrintf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling","title":"@nhtio/adk/batteries/embeddings/transformers\\_js/pooling","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling.md\ndescription: >-\n Deterministic, battery-owned pooling + L2-normalization for the\n transformers.js embeddings battery.\n---\n\n# @nhtio/adk/batteries/embeddings/transformers\\_js/pooling\n\nDeterministic, battery-owned pooling + L2-normalization for the transformers.js embeddings battery.\n\n## Remarks\n\nUsed when `poolingOwner: 'battery'`. The pipeline is asked for raw `pooling:'none'` token states —\na `[batch, seq, hidden]` tensor — and this module pools them into one vector per input in pure JS,\nidentically across Node and the browser. That removes the per-runtime post-processing variance that\nwidens the node↔browser cosine gap; only the irreducible ONNX-Runtime kernel floor remains.\n\nPooling strategies mirror the transformers.js feature-extraction options:\n\n* `mean` — attention-unaware mean over the sequence axis (matches the pipeline's `'mean'`, which\n also means over all positions for a single ungrouped sequence).\n* `cls` / `first_token` — the first token's hidden state.\n* `eos` / `last_token` — the last token's hidden state.\n* `none` — no pooling (caller already has the vector); returned unchanged per row.\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------- | ----------------------------------------------------------------------------------- |\n| [Pooled2D](type-aliases/Pooled2D.md) | A 2-D `[batch, hidden]` nested array (already-pooled vectors). |\n| [TokenStates3D](type-aliases/TokenStates3D.md) | A 3-D `[batch, seq, hidden]` nested array (raw token states from `pooling:'none'`). |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------- | ---------------------------------------------------------- |\n| [defaultPoolAndNormalize](variables/defaultPoolAndNormalize.md) | Default [poolAndNormalize](functions/poolAndNormalize.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [l2Normalize](functions/l2Normalize.md) | L2-normalize a vector in place-safe fashion (returns a new array). A zero vector is returned unchanged (no divide-by-zero). |\n| [poolAndNormalize](functions/poolAndNormalize.md) | Pool raw `[batch, seq, hidden]` token states into `[batch, hidden]` vectors and optionally L2-normalize — the deterministic battery-owned path (`poolingOwner: 'battery'`). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/l2Normalize","title":"Function: l2Normalize()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/l2Normalize.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/l2Normalize","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/l2Normalize.md\n---\n\n# Function: l2Normalize()\n\n```ts\nfunction l2Normalize(vec: number[]): number[];\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/pooling.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/pooling.ts#L48)\n\nL2-normalize a vector in place-safe fashion (returns a new array). A zero vector is returned\nunchanged (no divide-by-zero).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------- | ------------------------ |\n| `vec` | `number`\\[] | The vector to normalize. |\n\n## Returns\n\n`number`\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/poolAndNormalize","title":"Function: poolAndNormalize()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/poolAndNormalize.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/poolAndNormalize","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/poolAndNormalize.md\n---\n\n# Function: poolAndNormalize()\n\n```ts\nfunction poolAndNormalize(\n tokenStates: TokenStates3D,\n pooling: string,\n normalize: boolean,\n): Pooled2D;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/pooling.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/pooling.ts#L88)\n\nPool raw `[batch, seq, hidden]` token states into `[batch, hidden]` vectors and optionally\nL2-normalize — the deterministic battery-owned path (`poolingOwner: 'battery'`).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------- | --------------------------------------------------- | ------------------------------------------------------------ |\n| `tokenStates` | [`TokenStates3D`](../type-aliases/TokenStates3D.md) | The `[batch, seq, hidden]` raw states from `pooling:'none'`. |\n| `pooling` | `string` | The pooling strategy (`'mean'` default). |\n| `normalize` | `boolean` | Whether to L2-normalize each pooled vector (default `true`). |\n\n## Returns\n\n[`Pooled2D`](../type-aliases/Pooled2D.md)\n\nOne pooled (and optionally normalized) vector per batch row.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/Pooled2D","title":"Type Alias: Pooled2D","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/Pooled2D.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/Pooled2D","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/Pooled2D.md\ndescription: 'A 2-D `[batch, hidden]` nested array (already-pooled vectors).'\n---\n\n# Type Alias: Pooled2D\n\n```ts\ntype Pooled2D = number[][];\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/pooling.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/pooling.ts#L23)\n\nA 2-D `[batch, hidden]` nested array (already-pooled vectors).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/TokenStates3D","title":"Type Alias: TokenStates3D","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/TokenStates3D.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/TokenStates3D","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/type-aliases/TokenStates3D.md\ndescription: >-\n A 3-D `[batch, seq, hidden]` nested array (raw token states from\n `pooling:'none'`).\n---\n\n# Type Alias: TokenStates3D\n\n```ts\ntype TokenStates3D = number[][][];\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/pooling.ts:21](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/pooling.ts#L21)\n\nA 3-D `[batch, seq, hidden]` nested array (raw token states from `pooling:'none'`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/variables/defaultPoolAndNormalize","title":"Variable: defaultPoolAndNormalize","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/variables/defaultPoolAndNormalize.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/variables/defaultPoolAndNormalize","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/variables/defaultPoolAndNormalize.md\ndescription: 'Default [`poolAndNormalize`](https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/pooling/functions/poolAndNormalize).'\n---\n\n# Variable: defaultPoolAndNormalize\n\n```ts\nconst defaultPoolAndNormalize: (\n tokenStates: TokenStates3D,\n pooling: string,\n normalize: boolean,\n) => Pooled2D = poolAndNormalize;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/pooling.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/pooling.ts#L99)\n\nDefault [poolAndNormalize](../functions/poolAndNormalize.md).\n\nPool raw `[batch, seq, hidden]` token states into `[batch, hidden]` vectors and optionally\nL2-normalize — the deterministic battery-owned path (`poolingOwner: 'battery'`).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------- | --------------------------------------------------- | ------------------------------------------------------------ |\n| `tokenStates` | [`TokenStates3D`](../type-aliases/TokenStates3D.md) | The `[batch, seq, hidden]` raw states from `pooling:'none'`. |\n| `pooling` | `string` | The pooling strategy (`'mean'` default). |\n| `normalize` | `boolean` | Whether to L2-normalize each pooled vector (default `true`). |\n\n## Returns\n\n[`Pooled2D`](../type-aliases/Pooled2D.md)\n\nOne pooled (and optionally normalized) vector per batch row.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types","title":"@nhtio/adk/batteries/embeddings/transformers\\_js/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types.md\ndescription: Option and pipeline types for the transformers.js Embeddings adapter.\n---\n\n# @nhtio/adk/batteries/embeddings/transformers\\_js/types\n\nOption and pipeline types for the transformers.js Embeddings adapter.\n\n## Remarks\n\nBuilds on the **shared** embeddings option base owned by the OpenAI Embeddings battery\n([@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions](../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)). Adds the\ntransformers.js feature-extraction knobs. transformers.js is **environment-neutral** (Node +\nbrowser, ONNX Runtime auto-selected) — no WebGPU requirement.\n\nPipeline/dtype/device shapes are **local aliases** of `@huggingface/transformers` types, never\ndirect re-exports of the externalized peer.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| [TransformersJsEmbeddingsAdapterOptions](interfaces/TransformersJsEmbeddingsAdapterOptions.md) | Constructor options for the transformers.js Embeddings adapter. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | ----- | ----- | --- |\n| [CreateTransformersJsEmbeddingsPipeline](type-aliases/CreateTransformersJsEmbeddingsPipeline.md) | Factory for lazily creating a feature-extraction pipeline. Defaults to a dynamic import of `@huggingface/transformers` + `pipeline('feature-extraction', …)`; override to inject a pre-built pipeline or a test double. |\n| [TransformersJsEmbeddingsDataType](type-aliases/TransformersJsEmbeddingsDataType.md) | Quantization/precision dtype: `'auto' | 'fp32' | 'fp16' | 'q8' | 'q4' | …`. |\n| [TransformersJsEmbeddingsDeviceType](type-aliases/TransformersJsEmbeddingsDeviceType.md) | Inference device: `'auto' | 'webgpu' | 'wasm' | 'cpu' | 'gpu' | …`. |\n| [TransformersJsEmbeddingsModelSource](type-aliases/TransformersJsEmbeddingsModelSource.md) | Custom model-source resolver — the dual-environment seam for serving model files from OPFS, a different source, or bundled bytes (see the LLM battery's `model_source` module). Called once per file; return bytes / a path-or-URL string / a `Response`, or `undefined` to fall through to HF. |\n| [TransformersJsEmbeddingsPipeline](type-aliases/TransformersJsEmbeddingsPipeline.md) | The transformers.js feature-extraction pipeline this battery drives. |\n| [TransformersJsEmbeddingsProgressCallback](type-aliases/TransformersJsEmbeddingsProgressCallback.md) | Model-load progress callback. |\n| [TransformersJsPooling](type-aliases/TransformersJsPooling.md) | The pooling method applied to the model's per-token hidden states to produce one sentence vector. |\n| [TransformersJsPoolingOwner](type-aliases/TransformersJsPoolingOwner.md) | Who applies pooling + L2-normalization: - `'engine'` (default) — the transformers.js pipeline pools internally (today's exact behavior). Each runtime (node-ONNX vs web-ONNX/WebGPU) pools its own way, contributing to the node↔browser vector gap. - `'battery'` — request raw `pooling:'none'` token states and pool + normalize in deterministic shared JS (one implementation, identical across node + browser), removing post-processing variance and leaving only the irreducible ORT-kernel floor. `pooling`/`normalize` then take effect in OUR code. |\n\n## References\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](../../openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](../../openai/types/interfaces/EmbedOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions","title":"Interface: TransformersJsEmbeddingsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions.md\ndescription: Constructor options for the transformers.js Embeddings adapter.\n---\n\n# Interface: TransformersJsEmbeddingsAdapterOptions\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L96)\n\nConstructor options for the transformers.js Embeddings adapter.\n\n## Remarks\n\nExtends the shared [BaseEmbeddingsAdapterOptions](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md) (required `model` + prefix options) with\ntransformers.js pipeline fields. `model` accepts any ONNX feature-extraction model id (e.g.\n`onnx-community/all-MiniLM-L6-v2-ONNX`) — there is no default.\n\n## Extends\n\n* [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createPipeline?` | [`CreateTransformersJsEmbeddingsPipeline`](../type-aliases/CreateTransformersJsEmbeddingsPipeline.md) | Override the pipeline factory. Default: `pipeline('feature-extraction', …)` via dynamic import. | - | [src/batteries/embeddings/transformers\\_js/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L101) |\n| `device?` | | `\"auto\"` | `\"gpu\"` | `\"cpu\"` | `\"wasm\"` | `\"webgpu\"` | `\"cuda\"` | `\"dml\"` | `\"coreml\"` | `\"webnn\"` | `\"webnn-npu\"` | `\"webnn-gpu\"` | `\"webnn-cpu\"` | Inference device forwarded to `pipeline()`. Default: transformers.js environment default. | - | [src/batteries/embeddings/transformers\\_js/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L103) |\n| `dimensions?` | `number` | Declared output dimensionality, surfaced via `adapter.dimensions`. Optional metadata for callers that pre-allocate buffers; the battery does not enforce it against responses. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`dimensions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-dimensions) | [src/batteries/embeddings/openai/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L84) |\n| `documentPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'document'`. Unset → no prefix. Most asymmetric models (including Arctic) use no document prefix; exposed for symmetry and the models that do. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`documentPrefix`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-documentprefix) | [src/batteries/embeddings/openai/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L79) |\n| `dtype?` | | `\"auto\"` | `\"fp32\"` | `\"fp16\"` | `\"q8\"` | `\"int8\"` | `\"uint8\"` | `\"q4\"` | `\"bnb4\"` | `\"q4f16\"` | `\"q2\"` | `\"q2f16\"` | `\"q1\"` | `\"q1f16\"` | Quantization/precision dtype forwarded to `pipeline()`. | - | [src/batteries/embeddings/transformers\\_js/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L105) |\n| `isAvailable?` | () => `boolean` | Override the availability probe. Default: `true` whenever the peer is importable (env-neutral). | - | [src/batteries/embeddings/transformers\\_js/types.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L125) |\n| `model` | `string` | Model id to embed with. **Required, no default.** For OpenAI this is e.g. `text-embedding-3-small`; for WebLLM it is an MLC embedding model id (e.g. `snowflake-arctic-embed-m-q0f32-MLC`). | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`model`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-model) | [src/batteries/embeddings/openai/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L67) |\n| `modelSource?` | [`TransformersJsEmbeddingsModelSource`](../type-aliases/TransformersJsEmbeddingsModelSource.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 [TransformersJsEmbeddingsModelSource](../type-aliases/TransformersJsEmbeddingsModelSource.md). | - | [src/batteries/embeddings/transformers\\_js/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L121) |\n| `normalize?` | `boolean` | L2-normalise the embeddings (default `true`). | - | [src/batteries/embeddings/transformers\\_js/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L109) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `onInitProgress?` | `ProgressCallback` | Called with model-load progress reports while weights download/compile. | - | [src/batteries/embeddings/transformers\\_js/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L123) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `pipeline?` | `FeatureExtractionPipeline` | A pre-built pipeline. When provided, the battery uses it directly and skips lazy creation. | - | [src/batteries/embeddings/transformers\\_js/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L99) |\n| `pooling?` | [`TransformersJsPooling`](../type-aliases/TransformersJsPooling.md) | Pooling method (default `'mean'`). | - | [src/batteries/embeddings/transformers\\_js/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L107) |\n| `poolingOwner?` | [`TransformersJsPoolingOwner`](../type-aliases/TransformersJsPoolingOwner.md) | Who pools + normalizes (default `'engine'` — today's behavior, byte-identical). Set `'battery'` to pool + L2-normalize in deterministic shared JS for tighter node↔browser parity. See [TransformersJsPoolingOwner](../type-aliases/TransformersJsPoolingOwner.md). | - | [src/batteries/embeddings/transformers\\_js/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L115) |\n| `queryPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'query'`. Unset → no prefix. For Snowflake Arctic Embed, the documented value is `'Represent this sentence for searching relevant passages: '`. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`queryPrefix`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-queryprefix) | [src/batteries/embeddings/openai/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L73) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/CreateTransformersJsEmbeddingsPipeline","title":"Type Alias: CreateTransformersJsEmbeddingsPipeline","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/CreateTransformersJsEmbeddingsPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/CreateTransformersJsEmbeddingsPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/CreateTransformersJsEmbeddingsPipeline.md\ndescription: >-\n Factory for lazily creating a feature-extraction pipeline. Defaults to a\n dynamic import of `@huggingface/transformers` +\n `pipeline('feature-extraction', …)`; override to inject a pre-built pipeline\n or a test double.\n---\n\n# Type Alias: CreateTransformersJsEmbeddingsPipeline\n\n```ts\ntype CreateTransformersJsEmbeddingsPipeline = (input: {\n device?: TransformersJsEmbeddingsDeviceType;\n dtype?: TransformersJsEmbeddingsDataType;\n model: string;\n onInitProgress?: TransformersJsEmbeddingsProgressCallback;\n}) => Promise;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L81)\n\nFactory for lazily creating a feature-extraction pipeline. Defaults to a dynamic import of\n`@huggingface/transformers` + `pipeline('feature-extraction', …)`; override to inject a pre-built\npipeline or a test double.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `device?`: [`TransformersJsEmbeddingsDeviceType`](TransformersJsEmbeddingsDeviceType.md); `dtype?`: [`TransformersJsEmbeddingsDataType`](TransformersJsEmbeddingsDataType.md); `model`: `string`; `onInitProgress?`: [`TransformersJsEmbeddingsProgressCallback`](TransformersJsEmbeddingsProgressCallback.md); } |\n| `input.device?` | [`TransformersJsEmbeddingsDeviceType`](TransformersJsEmbeddingsDeviceType.md) |\n| `input.dtype?` | [`TransformersJsEmbeddingsDataType`](TransformersJsEmbeddingsDataType.md) |\n| `input.model` | `string` |\n| `input.onInitProgress?` | [`TransformersJsEmbeddingsProgressCallback`](TransformersJsEmbeddingsProgressCallback.md) |\n\n## Returns\n\n`Promise`<[`TransformersJsEmbeddingsPipeline`](TransformersJsEmbeddingsPipeline.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDataType","title":"Type Alias: TransformersJsEmbeddingsDataType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDataType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDataType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDataType.md\ndescription: 'Quantization/precision dtype: `''auto''|''fp32''|''fp16''|''q8''|''q4''|…`.'\n---\n\n# Type Alias: TransformersJsEmbeddingsDataType\n\n```ts\ntype TransformersJsEmbeddingsDataType = TransformersDataType;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L41)\n\nQuantization/precision dtype: `'auto'|'fp32'|'fp16'|'q8'|'q4'|…`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDeviceType","title":"Type Alias: TransformersJsEmbeddingsDeviceType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDeviceType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDeviceType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsDeviceType.md\ndescription: 'Inference device: `''auto''|''webgpu''|''wasm''|''cpu''|''gpu''|…`.'\n---\n\n# Type Alias: TransformersJsEmbeddingsDeviceType\n\n```ts\ntype TransformersJsEmbeddingsDeviceType = TransformersDeviceType;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L43)\n\nInference device: `'auto'|'webgpu'|'wasm'|'cpu'|'gpu'|…`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsModelSource","title":"Type Alias: TransformersJsEmbeddingsModelSource","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsModelSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsModelSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsModelSource.md\ndescription: >-\n Custom model-source resolver — the dual-environment seam for serving model\n files from OPFS, a different source, or bundled bytes (see the LLM battery's\n `model_source` module). Called once per file; return bytes / a path-or-URL\n string / a `Response`, or `undefined` to fall through to HF.\n---\n\n# Type Alias: TransformersJsEmbeddingsModelSource\n\n```ts\ntype TransformersJsEmbeddingsModelSource = (req: {\n filename: string;\n repo: string;\n}) =>\n | Promise\n | Uint8Array\n | string\n | Response\n | undefined;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L66)\n\nCustom model-source resolver — the dual-environment seam for serving model files from OPFS, a\ndifferent source, or bundled bytes (see the LLM battery's `model_source` module). Called once per\nfile; return bytes / a path-or-URL string / a `Response`, or `undefined` to fall through to HF.\n\n## Parameters\n\n| Parameter | Type |\n| -------------- | --------------------------------------------- |\n| `req` | { `filename`: `string`; `repo`: `string`; } |\n| `req.filename` | `string` |\n| `req.repo` | `string` |\n\n## Returns\n\n| `Promise`<`Uint8Array` | `string` | `Response` | `undefined`>\n| `Uint8Array`\n| `string`\n| `Response`\n| `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsPipeline","title":"Type Alias: TransformersJsEmbeddingsPipeline","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsPipeline.md\ndescription: The transformers.js feature-extraction pipeline this battery drives.\n---\n\n# Type Alias: TransformersJsEmbeddingsPipeline\n\n```ts\ntype TransformersJsEmbeddingsPipeline = FeatureExtractionPipeline;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L39)\n\nThe transformers.js feature-extraction pipeline this battery drives.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsProgressCallback","title":"Type Alias: TransformersJsEmbeddingsProgressCallback","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsProgressCallback.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsProgressCallback","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsEmbeddingsProgressCallback.md\ndescription: Model-load progress callback.\n---\n\n# Type Alias: TransformersJsEmbeddingsProgressCallback\n\n```ts\ntype TransformersJsEmbeddingsProgressCallback = ProgressCallback;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L45)\n\nModel-load progress callback.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPooling","title":"Type Alias: TransformersJsPooling","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPooling.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPooling","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPooling.md\ndescription: >-\n The pooling method applied to the model's per-token hidden states to produce\n one sentence vector.\n---\n\n# Type Alias: TransformersJsPooling\n\n```ts\ntype TransformersJsPooling =\n | \"none\"\n | \"mean\"\n | \"cls\"\n | \"first_token\"\n | \"eos\"\n | \"last_token\";\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L48)\n\nThe pooling method applied to the model's per-token hidden states to produce one sentence vector.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPoolingOwner","title":"Type Alias: TransformersJsPoolingOwner","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPoolingOwner.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPoolingOwner","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/types/type-aliases/TransformersJsPoolingOwner.md\ndescription: >-\n Who applies pooling + L2-normalization: - `'engine'` (default) — the\n transformers.js pipeline pools internally (today's exact behavior). Each\n runtime (node-ONNX vs web-ONNX/WebGPU) pools its own way, contributing to the\n node↔browser vector gap. - `'battery'` — request raw `pooling:'none'` token\n states and pool + normalize in deterministic shared JS (one implementation,\n identical across node + browser), removing post-processing variance and\n leaving only the irreducible ORT-kernel floor. `pooling`/`normalize` then take\n effect in OUR code.\n---\n\n# Type Alias: TransformersJsPoolingOwner\n\n```ts\ntype TransformersJsPoolingOwner = \"engine\" | \"battery\";\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/types.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/types.ts#L59)\n\nWho applies pooling + L2-normalization:\n\n* `'engine'` (default) — the transformers.js pipeline pools internally (today's exact behavior). Each\n runtime (node-ONNX vs web-ONNX/WebGPU) pools its own way, contributing to the node↔browser vector\n gap.\n* `'battery'` — request raw `pooling:'none'` token states and pool + normalize in deterministic shared\n JS (one implementation, identical across node + browser), removing post-processing variance and\n leaving only the irreducible ORT-kernel floor. `pooling`/`normalize` then take effect in OUR code.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation","title":"@nhtio/adk/batteries/embeddings/transformers\\_js/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/validation.md\ndescription: >-\n Runtime validation schema and wrapper for transformers.js Embeddings adapter\n options.\n---\n\n# @nhtio/adk/batteries/embeddings/transformers\\_js/validation\n\nRuntime validation schema and wrapper for transformers.js Embeddings adapter options.\n\n## Remarks\n\nValidates `TransformersJsEmbeddingsAdapterOptions` at construction time. Throws\n`E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS` on failure. `model` is required; unknown top-level\nkeys are rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |\n| [transformersJsEmbeddingsOptionsSchema](variables/transformersJsEmbeddingsOptionsSchema.md) | Validator schema for `TransformersJsEmbeddingsAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ----------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `transformersJsEmbeddingsOptionsSchema`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(\n input: unknown,\n): TransformersJsEmbeddingsAdapterOptions;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/validation.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/validation.ts#L65)\n\nValidates an arbitrary input against `transformersJsEmbeddingsOptionsSchema`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`TransformersJsEmbeddingsAdapterOptions`](../../types/interfaces/TransformersJsEmbeddingsAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_EMBEDDINGS\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS.md) when invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/variables/transformersJsEmbeddingsOptionsSchema","title":"Variable: transformersJsEmbeddingsOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/variables/transformersJsEmbeddingsOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/variables/transformersJsEmbeddingsOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/transformers_js/validation/variables/transformersJsEmbeddingsOptionsSchema.md\ndescription: >-\n Validator schema for `TransformersJsEmbeddingsAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: transformersJsEmbeddingsOptionsSchema\n\n```ts\nconst transformersJsEmbeddingsOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/embeddings/transformers\\_js/validation.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/transformers_js/validation.ts#L18)\n\nValidator schema for `TransformersJsEmbeddingsAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm","title":"@nhtio/adk/batteries/embeddings/webllm","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm.md'\ndescription: >-\n WebLLM Embeddings adapter battery — WebGPU/in-process embeddings via\n `@mlc-ai/web-llm`.\n---\n\n# @nhtio/adk/batteries/embeddings/webllm\n\nWebLLM Embeddings adapter battery — WebGPU/in-process embeddings via `@mlc-ai/web-llm`.\n\n## Remarks\n\nBrowser/WebGPU-only, so reachable solely through this subpath (never re-exported from the\nenvironment-neutral `@nhtio/adk/batteries/embeddings` barrel). Re-exports the adapter class, the\nvalidation schema + `validateOptions` wrapper, every option / engine type alias (including the\nshared base shapes re-exported from the OpenAI battery), and the battery-scoped exceptions.\n\n## References\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### CreateWebLLMEmbeddingsEngine\n\nRe-exports [CreateWebLLMEmbeddingsEngine](types/type-aliases/CreateWebLLMEmbeddingsEngine.md)\n\n***\n\n### E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS](exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS.md)\n\n***\n\n### E\\_WEBLLM\\_EMBEDDINGS\\_ENGINE\\_ERROR\n\nRe-exports [E\\_WEBLLM\\_EMBEDDINGS\\_ENGINE\\_ERROR](exceptions/variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](../openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](../openai/types/interfaces/EmbedOptions.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n\n***\n\n### WebLLMEmbeddingsAdapter\n\nRe-exports [WebLLMEmbeddingsAdapter](adapter/classes/WebLLMEmbeddingsAdapter.md)\n\n***\n\n### WebLLMEmbeddingsAdapterOptions\n\nRe-exports [WebLLMEmbeddingsAdapterOptions](types/interfaces/WebLLMEmbeddingsAdapterOptions.md)\n\n***\n\n### WebLLMEmbeddingsEngine\n\nRe-exports [WebLLMEmbeddingsEngine](types/type-aliases/WebLLMEmbeddingsEngine.md)\n\n***\n\n### WebLLMEmbeddingsInitProgressReport\n\nRe-exports [WebLLMEmbeddingsInitProgressReport](types/type-aliases/WebLLMEmbeddingsInitProgressReport.md)\n\n***\n\n### webLLMEmbeddingsOptionsSchema\n\nRe-exports [webLLMEmbeddingsOptionsSchema](validation/variables/webLLMEmbeddingsOptionsSchema.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/adapter","title":"@nhtio/adk/batteries/embeddings/webllm/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/adapter.md'\ndescription: 'WebLLM (WebGPU, in-process) Embeddings adapter battery.'\n---\n\n# @nhtio/adk/batteries/embeddings/webllm/adapter\n\nWebLLM (WebGPU, in-process) Embeddings adapter battery.\n\n## Remarks\n\nEmbeddings battery backed by WebLLM's in-process `engine.embeddings.create()` (the OpenAI-style\nembeddings API exposed by `@mlc-ai/web-llm`). Runs entirely in the browser on WebGPU — no\nnetwork round-trip, no API key.\n\nThis class is the **same battery** as [@nhtio/adk/batteries/embeddings/openai!OpenAIEmbeddingsAdapter](../../openai/adapter/classes/OpenAIEmbeddingsAdapter.md)\nin every user-facing respect — identical method surface (`isAvailable` / `dimensions` /\n`preload` / `reset` / `embed` / `embedMany`), identical `number[]` return shape, identical\nquery/document prefix handling (the shared `applyEmbeddingPrefix` helper) — differing only in\nthe engine. Construction validates eagerly and throws\n[@nhtio/adk/batteries/embeddings/webllm/exceptions!E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS](../exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS.md) on failure.\n\n`@mlc-ai/web-llm` is an optional peer dependency, imported lazily so non-WebGPU consumers pay\nnothing for it.\n\n## Classes\n\n| Class | Description |\n| ------------------------------------------------------------- | ---------------------------------------------------------- |\n| [WebLLMEmbeddingsAdapter](classes/WebLLMEmbeddingsAdapter.md) | Embeddings adapter for WebLLM's in-process embeddings API. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/adapter/classes/WebLLMEmbeddingsAdapter","title":"Class: WebLLMEmbeddingsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/adapter/classes/WebLLMEmbeddingsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/adapter/classes/WebLLMEmbeddingsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/adapter/classes/WebLLMEmbeddingsAdapter.md\ndescription: Embeddings adapter for WebLLM's in-process embeddings API.\n---\n\n# Class: WebLLMEmbeddingsAdapter\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L55)\n\nEmbeddings adapter for WebLLM's in-process embeddings API.\n\n## Remarks\n\nReusable: construct once, call [WebLLMEmbeddingsAdapter.embed](#embed) / [embedMany](#embedmany) as many\ntimes as needed. The engine is resolved lazily on first use (or via [preload](#preload)) and cached\nwith single-flight semantics so concurrent calls share one load.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew WebLLMEmbeddingsAdapter(options: unknown): WebLLMEmbeddingsAdapter;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L76)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`WebLLMEmbeddingsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/webllm/exceptions!E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS](../../exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS.md) when `options` does not satisfy\n[@nhtio/adk/batteries/embeddings/webllm/validation!webLLMEmbeddingsOptionsSchema](../../validation/variables/webLLMEmbeddingsOptionsSchema.md) (e.g. missing `model`).\n\n## Accessors\n\n### dimensions\n\n#### Get Signature\n\n```ts\nget dimensions(): number | undefined;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L82)\n\nDeclared output dimensionality (from options), or `undefined` if not configured.\n\n##### Returns\n\n`number` | `undefined`\n\n## Methods\n\n### embed()\n\n```ts\nembed(text: string, opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L142)\n\nEmbeds a single string.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------ | -------------------------- |\n| `text` | `string` | The input text. |\n| `opts?` | [`EmbedOptions`](../../../openai/types/interfaces/EmbedOptions.md) | Per-call options (`kind`). |\n\n#### Returns\n\n`Promise`<`number`\\[]>\n\nThe embedding vector as a plain `number[]`.\n\n***\n\n### embedMany()\n\n```ts\nembedMany(texts: string[], opts?: EmbedOptions): Promise;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L156)\n\nEmbeds a batch of strings in a single engine call.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------ | ---------------------------------------------------------- |\n| `texts` | `string`\\[] | The input texts. |\n| `opts?` | [`EmbedOptions`](../../../openai/types/interfaces/EmbedOptions.md) | Per-call options (`kind`). Defaults to `kind: 'document'`. |\n\n#### Returns\n\n`Promise`<`number`\\[]\\[]>\n\nOne embedding vector per input, in input order, each a plain `number[]`.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/webllm/exceptions!E\\_WEBLLM\\_EMBEDDINGS\\_ENGINE\\_ERROR](../../exceptions/variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR.md) when the engine call fails or returns a\nmalformed result.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L87)\n\nWhether WebGPU is available, honoring an injected `isWebGPUAvailable` probe.\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L98)\n\nEagerly loads (and caches) the engine so the first `embed` call is fast. Idempotent.\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/webllm/exceptions!E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS](../../exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS.md) when no WebGPU is available and no engine\nwas injected.\n\n#### Throws\n\n[@nhtio/adk/batteries/embeddings/webllm/exceptions!E\\_WEBLLM\\_EMBEDDINGS\\_ENGINE\\_ERROR](../../exceptions/variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR.md) when engine creation fails.\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L103)\n\nDrops the cached engine and in-flight load so the next call reloads.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/embeddings/webllm/adapter.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/adapter.ts#L63)\n\nWhether WebGPU — and therefore this battery — is available in the current runtime.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions","title":"@nhtio/adk/batteries/embeddings/webllm/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/exceptions.md'\ndescription: Battery-scoped exception constructors for WebLLM Embeddings adapter failures.\n---\n\n# @nhtio/adk/batteries/embeddings/webllm/exceptions\n\nBattery-scoped exception constructors for WebLLM Embeddings adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the WebLLM Embeddings adapter, minted via `createException`\nfrom `@nhtio/adk/factories`. The categories mirror the OpenAI Embeddings battery one-to-one —\nonly the engine-specific failure exception differs (engine error vs HTTP error).\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS](variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `webLLMEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, an unknown option key, or no WebGPU support in the current runtime. Fatal: config bugs fail loud, not at embed time. |\n| [E\\_WEBLLM\\_EMBEDDINGS\\_ENGINE\\_ERROR](variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR.md) | Thrown when the WebLLM engine fails to load or `engine.embeddings.create()` throws/returns a malformed result. Non-fatal. Printf arg: `[detail]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS","title":"Variable: E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `webLLMEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, an unknown\n option key, or no WebGPU support in the current runtime. Fatal: config bugs\n fail loud, not at embed time.\n---\n\n# Variable: E\\_INVALID\\_WEBLLM\\_EMBEDDINGS\\_OPTIONS\n\n```ts\nconst E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/webllm/exceptions.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/exceptions.ts#L19)\n\nThrown when the resolved adapter options fail validation against\n`webLLMEmbeddingsOptionsSchema` — e.g. a missing/empty `model`, an unknown option key, or no\nWebGPU support in the current runtime. Fatal: config bugs fail loud, not at embed time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR","title":"Variable: E\\_WEBLLM\\_EMBEDDINGS\\_ENGINE\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/exceptions/variables/E_WEBLLM_EMBEDDINGS_ENGINE_ERROR.md\ndescription: >-\n Thrown when the WebLLM engine fails to load or `engine.embeddings.create()`\n throws/returns a malformed result. Non-fatal. Printf arg: `[detail]`.\n---\n\n# Variable: E\\_WEBLLM\\_EMBEDDINGS\\_ENGINE\\_ERROR\n\n```ts\nconst E_WEBLLM_EMBEDDINGS_ENGINE_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/embeddings/webllm/exceptions.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/exceptions.ts#L31)\n\nThrown when the WebLLM engine fails to load or `engine.embeddings.create()` throws/returns a\nmalformed result. Non-fatal. Printf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types","title":"@nhtio/adk/batteries/embeddings/webllm/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/types.md'\ndescription: Option and engine types for the WebLLM Embeddings adapter.\n---\n\n# @nhtio/adk/batteries/embeddings/webllm/types\n\nOption and engine types for the WebLLM Embeddings adapter.\n\n## Remarks\n\nBuilds on the **shared** embeddings option base owned by the OpenAI Embeddings battery\n([@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions](../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)). The two\nbatteries differ only in their engine: this one `Omit`s nothing from the base (the base carries\nno HTTP fields) and adds the WebGPU/MLC engine knobs — exactly how the WebLLM Chat Completions\nbattery extends the OpenAI Chat Completions option type.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [WebLLMEmbeddingsAdapterOptions](interfaces/WebLLMEmbeddingsAdapterOptions.md) | Constructor options for [@nhtio/adk/batteries/embeddings/webllm/adapter!WebLLMEmbeddingsAdapter](../adapter/classes/WebLLMEmbeddingsAdapter.md). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CreateWebLLMEmbeddingsEngine](type-aliases/CreateWebLLMEmbeddingsEngine.md) | Factory for lazily creating a WebLLM engine. Defaults to `CreateMLCEngine` from `@mlc-ai/web-llm`; override to inject a pre-configured engine, a web-worker engine, or a test double. |\n| [WebLLMEmbeddingsEngine](type-aliases/WebLLMEmbeddingsEngine.md) | The WebLLM engine handle this battery drives. Alias of `MLCEngineInterface`. |\n| [WebLLMEmbeddingsInitProgressReport](type-aliases/WebLLMEmbeddingsInitProgressReport.md) | Progress report emitted while the engine loads weights. Alias of `InitProgressReport`. |\n\n## References\n\n### BaseEmbeddingsAdapterOptions\n\nRe-exports [BaseEmbeddingsAdapterOptions](../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n***\n\n### EmbeddingKind\n\nRe-exports [EmbeddingKind](../../openai/types/type-aliases/EmbeddingKind.md)\n\n***\n\n### EmbedOptions\n\nRe-exports [EmbedOptions](../../openai/types/interfaces/EmbedOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/interfaces/WebLLMEmbeddingsAdapterOptions","title":"Interface: WebLLMEmbeddingsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/interfaces/WebLLMEmbeddingsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/interfaces/WebLLMEmbeddingsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/types/interfaces/WebLLMEmbeddingsAdapterOptions.md\ndescription: >-\n Constructor options for {@link\n @nhtio/adk/batteries/embeddings/webllm/adapter!WebLLMEmbeddingsAdapter}.\n---\n\n# Interface: WebLLMEmbeddingsAdapterOptions\n\nDefined in: [src/batteries/embeddings/webllm/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L52)\n\nConstructor options for [@nhtio/adk/batteries/embeddings/webllm/adapter!WebLLMEmbeddingsAdapter](../../adapter/classes/WebLLMEmbeddingsAdapter.md).\n\n## Remarks\n\nExtends the shared [BaseEmbeddingsAdapterOptions](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md) (carrying the required `model` and the\nshared prefix options) with WebGPU/MLC engine fields. `model` accepts any MLC embedding model id\n(e.g. `snowflake-arctic-embed-m-q0f32-MLC`) — there is no default; the caller names it.\n\n## Extends\n\n* [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------------ | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `chatOptions?` | `ChatOptions` | `ChatOptions`\\[] | Passed to `CreateMLCEngine` as chat options (model-specific knobs). | - | [src/batteries/embeddings/webllm/types.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L60) |\n| `createEngine?` | [`CreateWebLLMEmbeddingsEngine`](../type-aliases/CreateWebLLMEmbeddingsEngine.md) | Override the engine factory. Default: `CreateMLCEngine` via a lazy dynamic import. | - | [src/batteries/embeddings/webllm/types.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L56) |\n| `dimensions?` | `number` | Declared output dimensionality, surfaced via `adapter.dimensions`. Optional metadata for callers that pre-allocate buffers; the battery does not enforce it against responses. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`dimensions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-dimensions) | [src/batteries/embeddings/openai/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L84) |\n| `documentPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'document'`. Unset → no prefix. Most asymmetric models (including Arctic) use no document prefix; exposed for symmetry and the models that do. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`documentPrefix`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-documentprefix) | [src/batteries/embeddings/openai/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L79) |\n| `engine?` | `MLCEngineInterface` | A pre-loaded engine. When provided, the battery uses it directly and skips lazy creation. | - | [src/batteries/embeddings/webllm/types.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L54) |\n| `engineConfig?` | `MLCEngineConfig` | Passed to `CreateMLCEngine` as the engine config (app config, cache, log level, etc.). | - | [src/batteries/embeddings/webllm/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L58) |\n| `isWebGPUAvailable?` | () => `boolean` | Override the WebGPU availability probe. Default: checks `navigator.gpu`. | - | [src/batteries/embeddings/webllm/types.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L64) |\n| `model` | `string` | Model id to embed with. **Required, no default.** For OpenAI this is e.g. `text-embedding-3-small`; for WebLLM it is an MLC embedding model id (e.g. `snowflake-arctic-embed-m-q0f32-MLC`). | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`model`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-model) | [src/batteries/embeddings/openai/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L67) |\n| `onInitProgress?` | (`report`: `InitProgressReport`) => `void` | Called with load-progress reports while weights download/compile. | - | [src/batteries/embeddings/webllm/types.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L62) |\n| `queryPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'query'`. Unset → no prefix. For Snowflake Arctic Embed, the documented value is `'Represent this sentence for searching relevant passages: '`. | [`BaseEmbeddingsAdapterOptions`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md).[`queryPrefix`](../../../openai/types/interfaces/BaseEmbeddingsAdapterOptions.md#property-queryprefix) | [src/batteries/embeddings/openai/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/openai/types.ts#L73) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/CreateWebLLMEmbeddingsEngine","title":"Type Alias: CreateWebLLMEmbeddingsEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/CreateWebLLMEmbeddingsEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/CreateWebLLMEmbeddingsEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/CreateWebLLMEmbeddingsEngine.md\ndescription: >-\n Factory for lazily creating a WebLLM engine. Defaults to `CreateMLCEngine`\n from `@mlc-ai/web-llm`; override to inject a pre-configured engine, a\n web-worker engine, or a test double.\n---\n\n# Type Alias: CreateWebLLMEmbeddingsEngine\n\n```ts\ntype CreateWebLLMEmbeddingsEngine = (input: {\n chatOptions?: ChatOptions | ChatOptions[];\n engineConfig?: MLCEngineConfig;\n model: string;\n onInitProgress?: (report: InitProgressReport) => void;\n}) => Promise;\n```\n\nDefined in: [src/batteries/embeddings/webllm/types.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L37)\n\nFactory for lazily creating a WebLLM engine. Defaults to `CreateMLCEngine` from\n`@mlc-ai/web-llm`; override to inject a pre-configured engine, a web-worker engine, or a test\ndouble.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `chatOptions?`: `ChatOptions` | `ChatOptions`\\[]; `engineConfig?`: `MLCEngineConfig`; `model`: `string`; `onInitProgress?`: (`report`: `InitProgressReport`) => `void`; } |\n| `input.chatOptions?` | `ChatOptions` | `ChatOptions`\\[] |\n| `input.engineConfig?` | `MLCEngineConfig` |\n| `input.model` | `string` |\n| `input.onInitProgress?` | (`report`: `InitProgressReport`) => `void` |\n\n## Returns\n\n`Promise`<[`WebLLMEmbeddingsEngine`](WebLLMEmbeddingsEngine.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsEngine","title":"Type Alias: WebLLMEmbeddingsEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsEngine.md\ndescription: The WebLLM engine handle this battery drives. Alias of `MLCEngineInterface`.\n---\n\n# Type Alias: WebLLMEmbeddingsEngine\n\n```ts\ntype WebLLMEmbeddingsEngine = MLCEngineInterface;\n```\n\nDefined in: [src/batteries/embeddings/webllm/types.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L27)\n\nThe WebLLM engine handle this battery drives. Alias of `MLCEngineInterface`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsInitProgressReport","title":"Type Alias: WebLLMEmbeddingsInitProgressReport","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsInitProgressReport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsInitProgressReport","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/types/type-aliases/WebLLMEmbeddingsInitProgressReport.md\ndescription: >-\n Progress report emitted while the engine loads weights. Alias of\n `InitProgressReport`.\n---\n\n# Type Alias: WebLLMEmbeddingsInitProgressReport\n\n```ts\ntype WebLLMEmbeddingsInitProgressReport = InitProgressReport;\n```\n\nDefined in: [src/batteries/embeddings/webllm/types.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/types.ts#L30)\n\nProgress report emitted while the engine loads weights. Alias of `InitProgressReport`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation","title":"@nhtio/adk/batteries/embeddings/webllm/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/validation.md'\ndescription: Runtime validation schema and wrapper for WebLLM Embeddings adapter options.\n---\n\n# @nhtio/adk/batteries/embeddings/webllm/validation\n\nRuntime validation schema and wrapper for WebLLM Embeddings adapter options.\n\n## Remarks\n\nValidates `WebLLMEmbeddingsAdapterOptions` at construction time. Throws\n`E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS` on failure. `model` is required; unknown top-level keys\nare rejected so typos fail loud. WebGPU availability is checked at engine-resolution time (not\nhere), since an `engine` may be injected for tests/non-WebGPU paths.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| [webLLMEmbeddingsOptionsSchema](variables/webLLMEmbeddingsOptionsSchema.md) | Validator schema for `WebLLMEmbeddingsAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `webLLMEmbeddingsOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS` (carrying the validator's report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): WebLLMEmbeddingsAdapterOptions;\n```\n\nDefined in: [src/batteries/embeddings/webllm/validation.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/validation.ts#L54)\n\nValidates an arbitrary input against `webLLMEmbeddingsOptionsSchema` and returns the resolved\noptions shape. Throws `E_INVALID_WEBLLM_EMBEDDINGS_OPTIONS` (carrying the validator's report on\n`cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`WebLLMEmbeddingsAdapterOptions`](../../types/interfaces/WebLLMEmbeddingsAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation/variables/webLLMEmbeddingsOptionsSchema","title":"Variable: webLLMEmbeddingsOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation/variables/webLLMEmbeddingsOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/embeddings/webllm/validation/variables/webLLMEmbeddingsOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/webllm/validation/variables/webLLMEmbeddingsOptionsSchema.md\ndescription: >-\n Validator schema for `WebLLMEmbeddingsAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: webLLMEmbeddingsOptionsSchema\n\n```ts\nconst webLLMEmbeddingsOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/embeddings/webllm/validation.ts:21](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/embeddings/webllm/validation.ts#L21)\n\nValidator schema for `WebLLMEmbeddingsAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/encoding","title":"@nhtio/adk/batteries/encoding","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/encoding.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/encoding","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/encoding.md'\ndescription: >-\n Opt-in serialization battery: make the ADK primitives round-trip through\n `@nhtio/encoder`.\n---\n\n# @nhtio/adk/batteries/encoding\n\nOpt-in serialization battery: make the ADK primitives round-trip through `@nhtio/encoder`.\n\n## Remarks\n\nThe ADK primitives already carry the `@nhtio/encoder` custom-class contract — they implement the\n`Symbol.for('@nhtio/encoder:toEncoded' | ':fromEncoded')` methods with **zero dependency** on the\nencoder. That half works whether or not `@nhtio/encoder` is installed. This battery wires up the\n*other* half — the part that genuinely needs the encoder — and nothing else imports it:\n\n1. `registerAdkEncodables()` — tells the decoder how to map each `custom:` wire tag back to\n its constructor. Call it **once, before your first `decode()`**. Without it, `encode()` still works\n but `decode()` throws on every ADK primitive.\n2. Auto-registers the **in-memory** and **fetch** reader resolvers (they carry no live binding, so they\n need nothing from you). Durable-store resolvers — flydrive `Disk`, OPFS root — you register yourself\n with [registerSpoolReaderResolver](../../common/functions/registerSpoolReaderResolver.md) / [registerMediaReaderResolver](../../common/functions/registerMediaReaderResolver.md), because only you hold\n the live binding the serialised locator cannot carry.\n\n::: what this battery does NOT do\nIt serialises the **conversation graph**, not your storage. It does not persist anything — it turns a\nlive object tree into a string and back. It does not conjure live bindings: a reader handle decodes to\na working reader only if you registered a resolver for its tag. It does not make closures portable: a\n[@nhtio/adk!Tool](../../forge/classes/Tool.md) handler serialises by source text only (see [@nhtio/adk!Tool](../../forge/classes/Tool.md)). And it\ncannot serialise a [@nhtio/adk!TurnGate](../../common/interfaces/TurnGate.md) — a live pending Promise has no serialised form.\n:::\n\n## Examples\n\n**Register once at startup, then encode/decode freely.**\n\n```typescript\nimport { encode, decode } from \"@nhtio/encoder\";\nimport { registerAdkEncodables } from \"@nhtio/adk/batteries/encoding\";\n\nregisterAdkEncodables();\n\nconst wire = encode(message); // a Message with nested Identity / Tokenizable / Media\nconst restored = decode(wire); // instanceof Message, nested primitives intact\n```\n\n**Durable-store media/artifacts need a resolver carrying the live binding.**\n\n```typescript\nimport { Disk } from \"flydrive\";\nimport { FlydriveSpoolReader } from \"@nhtio/adk/batteries/storage/flydrive\";\nimport {\n registerAdkEncodables,\n registerSpoolReaderResolver,\n} from \"@nhtio/adk/batteries/encoding\";\n\nregisterAdkEncodables();\nconst disk = new Disk(myDriver);\nregisterSpoolReaderResolver(\"spool:flydrive\", (locator) => {\n const { key, streamThresholdBytes } = locator as {\n key: string;\n streamThresholdBytes?: number;\n };\n return new FlydriveSpoolReader(disk, key, { streamThresholdBytes });\n});\n```\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [registerAdkEncodables](functions/registerAdkEncodables.md) | Register every ADK primitive with the `@nhtio/encoder` decoder, and auto-register the binding-free reader resolvers (in-memory, fetch). |\n\n## References\n\n### LocatorValue\n\nRe-exports [LocatorValue](../../common/type-aliases/LocatorValue.md)\n\n***\n\n### MediaReaderResolver\n\nRe-exports [MediaReaderResolver](../../common/type-aliases/MediaReaderResolver.md)\n\n***\n\n### ReaderDescriptor\n\nRe-exports [ReaderDescriptor](../../common/interfaces/ReaderDescriptor.md)\n\n***\n\n### registerMediaReaderResolver\n\nRe-exports [registerMediaReaderResolver](../../common/functions/registerMediaReaderResolver.md)\n\n***\n\n### registerSpoolReaderResolver\n\nRe-exports [registerSpoolReaderResolver](../../common/functions/registerSpoolReaderResolver.md)\n\n***\n\n### resolveMediaReader\n\nRe-exports [resolveMediaReader](../../common/functions/resolveMediaReader.md)\n\n***\n\n### resolveSpoolReader\n\nRe-exports [resolveSpoolReader](../../common/functions/resolveSpoolReader.md)\n\n***\n\n### SpoolReaderResolver\n\nRe-exports [SpoolReaderResolver](../../common/type-aliases/SpoolReaderResolver.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/encoding/functions/registerAdkEncodables","title":"Function: registerAdkEncodables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/encoding/functions/registerAdkEncodables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/encoding/functions/registerAdkEncodables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/encoding/functions/registerAdkEncodables.md\n---\n\n# Function: registerAdkEncodables()\n\n```ts\nfunction registerAdkEncodables(): void;\n```\n\nDefined in: [src/batteries/encoding/index.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/encoding/index.ts#L167)\n\nRegister every ADK primitive with the `@nhtio/encoder` decoder, and auto-register the binding-free\nreader resolvers (in-memory, fetch).\n\n## Returns\n\n`void`\n\n## Remarks\n\nIdempotent — safe to call more than once (re-registering a class is a no-op overwrite). Call it once at\napplication startup, before the first `decode()`. Encoding never needs this; only decoding does,\nbecause the decoder must map a `custom:` tag back to a constructor.\n\nDurable-store reader resolvers (flydrive, OPFS) are NOT registered here — they need the live `Disk` /\nOPFS root only you hold. Register them yourself with [registerSpoolReaderResolver](../../../common/functions/registerSpoolReaderResolver.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/createCrashPolicy","title":"Function: createCrashPolicy()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/createCrashPolicy.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/createCrashPolicy","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/createCrashPolicy.md'\n---\n\n# Function: createCrashPolicy()\n\n```ts\nfunction createCrashPolicy(options?: CrashPolicyOptions): CrashPolicy;\n```\n\nDefined in: [src/batteries/isolation/crash\\_policy.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L58)\n\nBuild a sliding-window crash-escalation policy: the first `maxCrashes - 1` crashes inside `windowMs`\neach return `'respawn'`; the `maxCrashes`-th (and every crash after it, while still inside the\nwindow) returns `'giveUp'`. Two crashes spaced further apart than `windowMs` are each treated as a\nfresh, first-in-window crash — an occasional isolated crash over a long-running session never\nescalates.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------- | -------------------------------------------------------------- |\n| `options` | [`CrashPolicyOptions`](../interfaces/CrashPolicyOptions.md) | See [CrashPolicyOptions](../interfaces/CrashPolicyOptions.md). |\n\n## Returns\n\n[`CrashPolicy`](../interfaces/CrashPolicy.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/createIsolatedService","title":"Function: createIsolatedService()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/createIsolatedService.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/createIsolatedService","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/createIsolatedService.md'\n---\n\n# Function: createIsolatedService()\n\n```ts\nfunction createIsolatedService(\n spec: S,\n transport: IsolationTransport,\n options?: IsolatedServiceOptions,\n): IsolatedService;\n```\n\nDefined in: [src/batteries/isolation/host.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L97)\n\nBuild an [IsolatedService](../interfaces/IsolatedService.md) over `transport` for `spec`. Connection + the first `ready` handshake\nbegin immediately (fire-and-forget internally); calls made before `ready` queue inside the underlying\n[HostEndpoint](../classes/HostEndpoint.md) and flush in order once it arrives.\n\n## Type Parameters\n\n| Type Parameter |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `S` *extends* [`IsolatedServiceSpec`](../interfaces/IsolatedServiceSpec.md)<[`MethodMap`](../type-aliases/MethodMap.md), [`StreamMap`](../type-aliases/StreamMap.md), [`EventMap`](../type-aliases/EventMap.md)> |\n\n## Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------------------------------------------- |\n| `spec` | `S` |\n| `transport` | [`IsolationTransport`](../interfaces/IsolationTransport.md) |\n| `options?` | [`IsolatedServiceOptions`](../interfaces/IsolatedServiceOptions.md) |\n\n## Returns\n\n[`IsolatedService`](../interfaces/IsolatedService.md)<`S`>\n\n## Throws\n\n@nhtio/adk/batteries/isolation!E\\_INVALID\\_ISOLATION\\_OPTIONS when `options` fails\nvalidation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/createWorkerTransport","title":"Function: createWorkerTransport()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/createWorkerTransport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/createWorkerTransport","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/createWorkerTransport.md'\n---\n\n# Function: createWorkerTransport()\n\n```ts\nfunction createWorkerTransport(\n spec: IsolatedServiceSpec,\n options: SpawnIsolatedOptions,\n): IsolationTransport;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L182)\n\nBuild an [IsolationTransport](../interfaces/IsolationTransport.md) that spawns/re-spawns a real browser `Worker` per [SpawnIsolatedOptions.worker](../interfaces/SpawnIsolatedOptions.md#property-worker).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------- |\n| `spec` | [`IsolatedServiceSpec`](../interfaces/IsolatedServiceSpec.md) |\n| `options` | [`SpawnIsolatedOptions`](../interfaces/SpawnIsolatedOptions.md) |\n\n## Returns\n\n[`IsolationTransport`](../interfaces/IsolationTransport.md)\n\n## Remarks\n\n`connect()` resolves the `Worker` (constructing it for a `string | URL` spec, or awaiting a [WorkerResolver](../type-aliases/WorkerResolver.md)), wraps it in a [PortLike](../interfaces/PortLike.md) (`post` → `postMessage` with any @nhtio/adk/batteries/isolation!transfer-marked values unwrapped into the transfer list; `onMessage` →\n`addEventListener('message', ...)`), and wires the worker's `'error'`/`'messageerror'` events to the\ntransport's `onCrash` handlers. `terminate()` calls `worker.terminate()`. `createIsolatedService`'s\n`recycle()` re-enters this SAME `connect()` — since a resolver is invoked fresh on every call, it is\nthe single source of Worker creation for the service's whole lifetime (every respawn goes through it,\nnever a cached instance).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/defineIsolatedService","title":"Function: defineIsolatedService()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/defineIsolatedService.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/defineIsolatedService","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/defineIsolatedService.md'\n---\n\n# Function: defineIsolatedService()\n\n```ts\nfunction defineIsolatedService(\n input: IsolatedServiceSpecInput,\n): IsolatedServiceSpec;\n```\n\nDefined in: [src/batteries/isolation/validation.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/validation.ts#L94)\n\nDefine an isolated service's spec — validates `input` eagerly (see\nvalidateIsolatedServiceSpecInput) then resolves it via\n@nhtio/adk/batteries/isolation!resolveIsolatedServiceSpec. This is the public entry point\nre-exported as `defineIsolatedService` from this battery's `index.ts` barrel.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| `M` *extends* [`MethodMap`](../type-aliases/MethodMap.md) | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`never`, `never`> |\n| `S` *extends* [`StreamMap`](../type-aliases/StreamMap.md) | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`never`, `never`> |\n| `E` *extends* [`EventMap`](../type-aliases/EventMap.md) | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`never`, `never`> |\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ---------------------------------------------------------------------------------------- |\n| `input` | [`IsolatedServiceSpecInput`](../interfaces/IsolatedServiceSpecInput.md)<`M`, `S`, `E`> |\n\n## Returns\n\n[`IsolatedServiceSpec`](../interfaces/IsolatedServiceSpec.md)<`M`, `S`, `E`>\n\n## Throws\n\n@nhtio/adk/batteries/isolation!E\\_INVALID\\_ISOLATION\\_OPTIONS when the spec fails\nvalidation (missing/empty `name`, unknown top-level key, or a name collision across\n`methods`/`streams`/`events`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/descriptionToChatCompletionsJsonSchema","title":"Function: descriptionToChatCompletionsJsonSchema()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/descriptionToChatCompletionsJsonSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/descriptionToChatCompletionsJsonSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/descriptionToChatCompletionsJsonSchema.md\n---\n\n# Function: descriptionToChatCompletionsJsonSchema()\n\n```ts\nfunction descriptionToChatCompletionsJsonSchema(d: DescriptionLike): JsonSchema;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L263)\n\nImplements [ChatHelpersCommon.descriptionToChatCompletionsJsonSchema](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------- |\n| `d` | [`DescriptionLike`](../interfaces/DescriptionLike.md) |\n\n## Returns\n\n[`JsonSchema`](../interfaces/JsonSchema.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/emitIsolationReport","title":"Function: emitIsolationReport()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/emitIsolationReport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/emitIsolationReport","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/emitIsolationReport.md'\n---\n\n# Function: emitIsolationReport()\n\n```ts\nfunction emitIsolationReport(\n hooks: IsolationObservabilityHooks | undefined,\n phase: IsolationReportPhase,\n base: {\n serviceName?: string;\n spawnCount: number;\n },\n extra?: Omit<\n Partial,\n \"at\" | \"phase\" | \"serviceName\" | \"spawnCount\"\n >,\n now?: () => string,\n): void;\n```\n\nDefined in: [src/batteries/isolation/observability.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L201)\n\nBuild an [IsolationReport](../interfaces/IsolationReport.md) (stamping `at`) and dispatch it to the firehose\n([IsolationObservabilityHooks.onIsolation](../interfaces/IsolationObservabilityHooks.md#property-onisolation)) AND the per-phase-group hook for `phase`. A no-op\nwhen `hooks` is undefined or carries no relevant callbacks — callers should additionally guard\nexpensive `extra` computation (e.g. `approxBytes` sizing) behind [hasIsolationHook](hasIsolationHook.md) so it is\nnever computed when unhooked. Each callback is invoked through safeInvoke, so a throwing\nconsumer never disrupts the battery.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |\n| `hooks` | | [`IsolationObservabilityHooks`](../interfaces/IsolationObservabilityHooks.md) | `undefined` | The isolation observability hooks (may be undefined). |\n| `phase` | [`IsolationReportPhase`](../type-aliases/IsolationReportPhase.md) | The phase being reported. |\n| `base` | { `serviceName?`: `string`; `spawnCount`: `number`; } | `serviceName` + `spawnCount`, common to every report. |\n| `base.serviceName?` | `string` | - |\n| `base.spawnCount?` | `number` | - |\n| `extra?` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`IsolationReport`](../interfaces/IsolationReport.md)>, `\"at\"` | `\"phase\"` | `\"serviceName\"` | `\"spawnCount\"`> | Phase-specific fields (see [IsolationReport](../interfaces/IsolationReport.md)). |\n| `now?` | () => `string` | Injectable clock for tests; defaults to `new Date().toISOString()`. |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/event","title":"Function: event()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/event.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/event","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/event.md'\n---\n\n# Function: event()\n\n```ts\nfunction event

(): EventDescriptor

;\n```\n\nDefined in: [src/batteries/isolation/types.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L141)\n\nDeclare an unsolicited event channel on an isolated service's spec — the guest-side implementation\nfactory receives an `emit(payload)` function for this channel; the host subscribes via\n`service.on(channel, fn)`. Events are never implemented by the guest's per-method object (there is no\n\"handler\" to provide) — they are purely an outbound notification channel.\n\n## Type Parameters\n\n| Type Parameter | Description |\n| -------------- | ----------------------- |\n| `P` | The event payload type. |\n\n## Returns\n\n[`EventDescriptor`](../interfaces/EventDescriptor.md)<`P`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/filterThoughts","title":"Function: filterThoughts()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/filterThoughts.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/filterThoughts","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/filterThoughts.md'\n---\n\n# Function: filterThoughts()\n\n```ts\nfunction filterThoughts(\n thoughts: Iterable,\n mode: \"all\" | \"all-self\" | \"latest-self\",\n selfIdentity: string,\n replayCompatibility: readonly string[],\n): Thought[];\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:795](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L795)\n\nImplements [ChatHelpersCommon.filterThoughts](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------- | ---------------------------------------------------------- |\n| `thoughts` | `Iterable`<[`Thought`](../../common/classes/Thought.md)> |\n| `mode` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` |\n| `selfIdentity` | `string` |\n| `replayCompatibility` | readonly `string`\\[] |\n\n## Returns\n\n[`Thought`](../../common/classes/Thought.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/floorTrustTier","title":"Function: floorTrustTier()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/floorTrustTier.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/floorTrustTier","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/floorTrustTier.md'\n---\n\n# Function: floorTrustTier()\n\n```ts\nfunction floorTrustTier(parent: T, entry: T): T;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:202](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L202)\n\nClamp a stash entry's trust tier to its containing media's tier as a FLOOR: a stash entry may render\nat the parent's tier or LOWER (less trusted), never HIGHER.\n\n## Type Parameters\n\n| Type Parameter |\n| ---------------------- |\n| `T` *extends* `string` |\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ---- |\n| `parent` | `T` |\n| `entry` | `T` |\n\n## Returns\n\n`T`\n\n## Remarks\n\nThe committee's #1-ranked escalation: a `third-party-private` Media carrying a stash entry tagged\n`first-party` would otherwise render its fallback text in a `` envelope (the\nmedia-fallback renderer keys the envelope off the entry's OWN tier). That lets untrusted content\nsmuggle itself into the trusted tier. Flooring to the parent closes it: a child can de-escalate but\nnever escalate above the asset it belongs to.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/hasIsolationHook","title":"Function: hasIsolationHook()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/hasIsolationHook.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/hasIsolationHook","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/hasIsolationHook.md'\n---\n\n# Function: hasIsolationHook()\n\n```ts\nfunction hasIsolationHook(\n hooks: IsolationObservabilityHooks | undefined,\n phase: IsolationReportPhase,\n): boolean;\n```\n\nDefined in: [src/batteries/isolation/observability.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L182)\n\nReturns `true` when at least one hook relevant to `phase` is registered — the guard\n[emitIsolationReport](emitIsolationReport.md) uses to skip assembling a report entirely (zero overhead when unhooked).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------------------------- |\n| `hooks` | | [`IsolationObservabilityHooks`](../interfaces/IsolationObservabilityHooks.md) | `undefined` |\n| `phase` | [`IsolationReportPhase`](../type-aliases/IsolationReportPhase.md) |\n\n## Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/isEncoderAvailable","title":"Function: isEncoderAvailable()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/isEncoderAvailable.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/isEncoderAvailable","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/isEncoderAvailable.md'\n---\n\n# Function: isEncoderAvailable()\n\n```ts\nfunction isEncoderAvailable(): Promise;\n```\n\nDefined in: [src/batteries/isolation/codec.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L100)\n\nWhether the encoder peer is currently available. Used to populate `ready.encoderAvailable`.\n\n## Returns\n\n`Promise`<`boolean`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/isolateFunction","title":"Function: isolateFunction()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/isolateFunction.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/isolateFunction","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/isolateFunction.md'\n---\n\n# Function: isolateFunction()\n\n```ts\nfunction isolateFunction(\n fn: (...args: A) => R | Promise,\n options: IsolateFunctionOptions,\n): IsolatedFunctionHandle;\n```\n\nDefined in: [src/batteries/isolation/isolate\\_function.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/isolate_function.ts#L224)\n\nRun `fn` inside a throwaway, source-rehydrated Worker. See this module's doc comment for the full\ndesign and the trust-boundary implications of `allowSourceRehydration`.\n\n## Type Parameters\n\n| Type Parameter |\n| ------------------------- |\n| `A` *extends* `unknown`\\[] |\n| `R` |\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `fn` | (...`args`: `A`) => `R` | `Promise`<`R`> |\n| `options` | [`IsolateFunctionOptions`](../interfaces/IsolateFunctionOptions.md) |\n\n## Returns\n\n[`IsolatedFunctionHandle`](../interfaces/IsolatedFunctionHandle.md)<`A`, `R`>\n\n## Throws\n\n[E\\_ISOLATE\\_FUNCTION\\_REQUIRES\\_SOURCE\\_REHYDRATION](../variables/E_ISOLATE_FUNCTION_REQUIRES_SOURCE_REHYDRATION.md) when `allowSourceRehydration` is not\nthe literal `true`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/method","title":"Function: method()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/method.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/method","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/method.md'\n---\n\n# Function: method()\n\n```ts\nfunction method(opts?: MethodOptions): MethodDescriptor;\n```\n\nDefined in: [src/batteries/isolation/types.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L108)\n\nDeclare a request/response method on an isolated service's spec — the host gets a\n`(...args) => Promise` facade method; the guest implementation returns (or resolves to) `R`\ndirectly (or throws/rejects, crossing back as a rejected promise on the host).\n\n## Type Parameters\n\n| Type Parameter | Description |\n| ------------------------- | ------------------------------------------------------------------- |\n| `A` *extends* `unknown`\\[] | The method's argument tuple, e.g. `[MyArgs]` or `[string, number]`. |\n| `R` | The method's resolved result type. |\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| `opts` | [`MethodOptions`](../interfaces/MethodOptions.md) | See [MethodOptions](../interfaces/MethodOptions.md). `opts.signal` opts this method into abort-signal plumbing. |\n\n## Returns\n\n[`MethodDescriptor`](../interfaces/MethodDescriptor.md)<`A`, `R`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/neutraliseDeveloperRulesTag","title":"Function: neutraliseDeveloperRulesTag()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/neutraliseDeveloperRulesTag.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/neutraliseDeveloperRulesTag","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/neutraliseDeveloperRulesTag.md\n---\n\n# Function: neutraliseDeveloperRulesTag()\n\n```ts\nfunction neutraliseDeveloperRulesTag(text: string): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L81)\n\nNeutralise the **no-nonce** `` / `` developer-rules tier\nif it appears inside model- or user-supplied BODY content.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `text` | `string` |\n\n## Returns\n\n`string`\n\n## Remarks\n\nEvery other trust tier (untrusted/trusted/peer/thought/memory/retrieved) carries an unguessable\nper-primitive nonce in its tag name, so a model that mirrors one cannot forge a sibling's closer. The\nstanding-instructions tier is the lone exception — [renderStandingInstructions](renderStandingInstructions.md) emits it WITHOUT\na nonce because it is the highest-authority block. That makes a model-mirrored copy textually\nidentical to the real tier. The legitimate tier is ALWAYS harness-injected (built by\n`renderStandingInstructions` and concatenated into the system prompt) and never flows through a\nmessage/thought body — so escaping the leading `<` of the literal token wherever it occurs in body\ncontent is always safe and renders the copy inert (visible, but unmistakably not a structural tag).\nMirrors how the nonce already neutralises the other tiers. See the envelope-mimicry threat model.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/nextCorrelationId","title":"Function: nextCorrelationId()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/nextCorrelationId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/nextCorrelationId","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/nextCorrelationId.md'\n---\n\n# Function: nextCorrelationId()\n\n```ts\nfunction nextCorrelationId(): string;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L82)\n\nMonotonic id generator shared by both endpoints (module-scoped counter — fine across many\ninstances in one realm since ids are only ever compared within a single connection).\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/registerEncodableClasses","title":"Function: registerEncodableClasses()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/registerEncodableClasses.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/registerEncodableClasses","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/registerEncodableClasses.md\n---\n\n# Function: registerEncodableClasses()\n\n```ts\nfunction registerEncodableClasses(\n encodables: readonly {\n name: string;\n }[],\n): Promise;\n```\n\nDefined in: [src/batteries/isolation/codec.ts:426](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L426)\n\nRegister classes for `@nhtio/encoder`'s custom-encodable round-trip (sugar over `registerClass`,\ncalled lazily once the encoder is loaded). Throws `E_ISOLATION_ENCODER_REQUIRED` when classes are\nlisted but the peer is not installed.\n\n## Parameters\n\n| Parameter | Type |\n| ------------ | ---------------------------------- |\n| `encodables` | readonly { `name`: `string`; }\\[] |\n\n## Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderChatCompletionsSystemPrompt","title":"Function: renderChatCompletionsSystemPrompt()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderChatCompletionsSystemPrompt.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderChatCompletionsSystemPrompt","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderChatCompletionsSystemPrompt.md\n---\n\n# Function: renderChatCompletionsSystemPrompt()\n\n```ts\nfunction renderChatCompletionsSystemPrompt(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string,\n ) => Promise;\n renderMemories: (\n items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>,\n ) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderFirstPartyRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string,\n ) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderThirdPartyPublicRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (\n items: Iterable,\n attrs?: StandingInstructionAttrs,\n ) => string;\n renderThirdPartyPrivateRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderThirdPartyPublicRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:868](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L868)\n\nImplements [ChatHelpersCommon.renderChatCompletionsSystemPrompt](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../common/classes/Tokenizable.md); } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.memories` | `Iterable`<[`Memory`](../../common/classes/Memory.md)> | - |\n| `input.renderCtx?` | `unknown` | Live dispatch context for resolving a DYNAMIC [Tokenizable](../../common/classes/Tokenizable.md) systemPrompt via `.render(ctx)`. Optional; a static systemPrompt ignores it. (standingInstructions/memories render through their own sub-helpers and remain static-string reads — the flagship's only dynamic content is a thought.) |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../common/classes/Retrievable.md)> | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../common/classes/Tokenizable.md) | - |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderFirstPartyRetrievables","title":"Function: renderFirstPartyRetrievables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderFirstPartyRetrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderFirstPartyRetrievables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderFirstPartyRetrievables.md\n---\n\n# Function: renderFirstPartyRetrievables()\n\n```ts\nfunction renderFirstPartyRetrievables(\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderHandle?:\n | ((input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string)\n | undefined,\n): Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:583](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L583)\n\nImplements [ChatHelpersCommon.renderFirstPartyRetrievables](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables).\n\n## Parameters\n\n| Parameter | Type | Default value |\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| `items` | `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }> | `undefined` |\n| `renderHandle` | | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined` | `defaultRenderRetrievableHandleBody` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderMemories","title":"Function: renderMemories()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderMemories.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderMemories","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderMemories.md'\n---\n\n# Function: renderMemories()\n\n```ts\nfunction renderMemories(\n items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>,\n): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:546](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L546)\n\nImplements [ChatHelpersCommon.renderMemories](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `items` | `Iterable`<{ `attrs`: [`MemoryAttrs`](../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../common/classes/Memory.md); }> |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderRetrievables","title":"Function: renderRetrievables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderRetrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderRetrievables","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderRetrievables.md'\n---\n\n# Function: renderRetrievables()\n\n```ts\nfunction renderRetrievables(\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderFirstPartyRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string,\n ) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderThirdPartyPublicRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n): Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:697](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L697)\n\nImplements [ChatHelpersCommon.renderRetrievables](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables).\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `items` | `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }> |\n| `deps` | { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; } |\n| `deps.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> |\n| `deps.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `deps.renderRetrievableSafetyDirective` | () => `string` |\n| `deps.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `deps.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `deps.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderRetrievableSafetyDirective","title":"Function: renderRetrievableSafetyDirective()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderRetrievableSafetyDirective.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderRetrievableSafetyDirective","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderRetrievableSafetyDirective.md\n---\n\n# Function: renderRetrievableSafetyDirective()\n\n```ts\nfunction renderRetrievableSafetyDirective(): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:575](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L575)\n\nImplements [ChatHelpersCommon.renderRetrievableSafetyDirective](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective).\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderStandingInstructions","title":"Function: renderStandingInstructions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderStandingInstructions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderStandingInstructions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderStandingInstructions.md\n---\n\n# Function: renderStandingInstructions()\n\n```ts\nfunction renderStandingInstructions(\n items: Iterable,\n attrs?: StandingInstructionAttrs,\n): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L522)\n\nImplements [ChatHelpersCommon.renderStandingInstructions](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------- |\n| `items` | `Iterable`<[`Tokenizable`](../../common/classes/Tokenizable.md)> |\n| `attrs?` | [`StandingInstructionAttrs`](../interfaces/StandingInstructionAttrs.md) |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThirdPartyPrivateRetrievables","title":"Function: renderThirdPartyPrivateRetrievables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThirdPartyPrivateRetrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThirdPartyPrivateRetrievables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderThirdPartyPrivateRetrievables.md\n---\n\n# Function: renderThirdPartyPrivateRetrievables()\n\n```ts\nfunction renderThirdPartyPrivateRetrievables(\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n): Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:662](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L662)\n\nImplements [ChatHelpersCommon.renderThirdPartyPrivateRetrievables](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables).\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `items` | `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }> |\n| `deps` | { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; } |\n| `deps.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `deps.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThirdPartyPublicRetrievables","title":"Function: renderThirdPartyPublicRetrievables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThirdPartyPublicRetrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThirdPartyPublicRetrievables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderThirdPartyPublicRetrievables.md\n---\n\n# Function: renderThirdPartyPublicRetrievables()\n\n```ts\nfunction renderThirdPartyPublicRetrievables(\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n): Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:627](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L627)\n\nImplements [ChatHelpersCommon.renderThirdPartyPublicRetrievables](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables).\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `items` | `Iterable`<{ `attrs`: [`RetrievableAttrs`](../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../common/classes/Retrievable.md); }> |\n| `deps` | { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string`; } |\n| `deps.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `deps.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md)) => `string` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThought","title":"Function: renderThought()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThought.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderThought","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderThought.md'\n---\n\n# Function: renderThought()\n\n```ts\nfunction renderThought(\n content: string,\n attrs: ThoughtAttrs,\n payload?: unknown,\n): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:750](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L750)\n\nImplements [ChatHelpersCommon.renderThought](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought).\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ----------------------------------------------- |\n| `content` | `string` |\n| `attrs` | [`ThoughtAttrs`](../interfaces/ThoughtAttrs.md) |\n| `payload?` | `unknown` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderTrustedContent","title":"Function: renderTrustedContent()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderTrustedContent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderTrustedContent","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderTrustedContent.md'\n---\n\n# Function: renderTrustedContent()\n\n```ts\nfunction renderTrustedContent(\n content: string,\n attrs: TrustedContentAttrs,\n): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:379](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L379)\n\nImplements [ChatHelpersCommon.renderTrustedContent](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------- |\n| `content` | `string` |\n| `attrs` | [`TrustedContentAttrs`](../interfaces/TrustedContentAttrs.md) |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/renderUntrustedContent","title":"Function: renderUntrustedContent()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderUntrustedContent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/renderUntrustedContent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/renderUntrustedContent.md\n---\n\n# Function: renderUntrustedContent()\n\n```ts\nfunction renderUntrustedContent(\n content: string,\n attrs: UntrustedContentAttrs,\n): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:368](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L368)\n\nImplements [ChatHelpersCommon.renderUntrustedContent](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------- |\n| `content` | `string` |\n| `attrs` | [`UntrustedContentAttrs`](../interfaces/UntrustedContentAttrs.md) |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/resolveIsolatedServiceSpec","title":"Function: resolveIsolatedServiceSpec()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/resolveIsolatedServiceSpec.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/resolveIsolatedServiceSpec","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/resolveIsolatedServiceSpec.md\n---\n\n# Function: resolveIsolatedServiceSpec()\n\n```ts\nfunction resolveIsolatedServiceSpec(\n input: IsolatedServiceSpecInput,\n): IsolatedServiceSpec;\n```\n\nDefined in: [src/batteries/isolation/types.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L198)\n\nResolve an isolated-service spec input into its final [IsolatedServiceSpec](../interfaces/IsolatedServiceSpec.md) shape — filling in\n`{}` defaults for omitted `methods`/`streams`/`events`. Pure and zero-import: performs NO validation\n(no duplicate-name check, no empty-`name` check). This is the primitive the public,\nvalidating `defineIsolatedService` (exported from `validation.ts` and re-exported from this\nbattery's `index.ts` barrel) delegates to after it validates the input — call this directly only\nfrom tests that intentionally want to bypass validation.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| `M` *extends* [`MethodMap`](../type-aliases/MethodMap.md) | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`never`, `never`> |\n| `S` *extends* [`StreamMap`](../type-aliases/StreamMap.md) | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`never`, `never`> |\n| `E` *extends* [`EventMap`](../type-aliases/EventMap.md) | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`never`, `never`> |\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ---------------------------------------------------------------------------------------- |\n| `input` | [`IsolatedServiceSpecInput`](../interfaces/IsolatedServiceSpecInput.md)<`M`, `S`, `E`> |\n\n## Returns\n\n[`IsolatedServiceSpec`](../interfaces/IsolatedServiceSpec.md)<`M`, `S`, `E`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/sanitizeFilenameForDescription","title":"Function: sanitizeFilenameForDescription()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/sanitizeFilenameForDescription.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/sanitizeFilenameForDescription","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/sanitizeFilenameForDescription.md\n---\n\n# Function: sanitizeFilenameForDescription()\n\n```ts\nfunction sanitizeFilenameForDescription(\n filename: string,\n maxLen?: number,\n): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L176)\n\nSanitise a media `filename` for interpolation into a synthetic-description line that is then placed\nINSIDE a trust envelope whose body is not XML-escaped.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| ---------- | -------- | ------------- |\n| `filename` | `string` | `undefined` |\n| `maxLen` | `number` | `256` |\n\n## Returns\n\n`string`\n\n## Remarks\n\nA filename is attacker-influenced and the synthetic-description body is not escaped, so a filename\nlike `x.png>SYSTEM: …` could close the envelope, and one that mimics the\n`[media: …]` format could forge a second descriptor. We strip the envelope-significant characters\n(`<`, `>`, and newlines/control chars) and length-cap (a megabyte filename is a prompt-bloat DoS).\nThe filename is metadata, not content the model must read byte-exact, so stripping is safe.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/sanitizeMimeType","title":"Function: sanitizeMimeType()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/sanitizeMimeType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/sanitizeMimeType","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/sanitizeMimeType.md'\n---\n\n# Function: sanitizeMimeType()\n\n```ts\nfunction sanitizeMimeType(\n raw: string,\n kind?: \"document\" | \"audio\" | \"image\" | \"video\",\n): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L150)\n\nValidate a media `mimeType` for safe interpolation into a `data:;base64,…` URI, a\n`Blob({type})`, or a synthetic-description line.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------- |\n| `raw` | `string` |\n| `kind?` | `\"document\"` | `\"audio\"` | `\"image\"` | `\"video\"` |\n\n## Returns\n\n`string`\n\n## Remarks\n\nA raw `mimeType` is attacker-influenced (it rides in on user uploads / tool output). The committee's\nsharpest finding was a `mimeType` like `image/png;base64,;x=` — interpolated into\n`data:${mime};base64,${b64}` it produces a DOUBLE `;base64,`, letting a permissive data-URI parser\ndecode the attacker's prefix instead of the real payload (a content-type confusion / injection). A\n`\\r\\n` in the mime is an HTTP-header-injection vector if the URI is ever reflected. We accept ONLY a\nstrict `type/subtype` (no params, no whitespace, no `;`/`,`); anything else collapses to the kind's\ngeneric safe subtype (so an image still decodes as an image) or `application/octet-stream`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/serveIsolated","title":"Function: serveIsolated()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/serveIsolated.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/serveIsolated","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/serveIsolated.md'\n---\n\n# Function: serveIsolated()\n\n```ts\nfunction serveIsolated(\n spec: S,\n factory: IsolatedImplementationFactory,\n options?: ServeIsolatedOptions,\n): {\n stop: () => void;\n};\n```\n\nDefined in: [src/batteries/isolation/serve.ts:349](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/serve.ts#L349)\n\nServe `spec` in the CURRENT environment, duck-detecting a Web Worker global scope\n(`globalThis.self.postMessage`) or a node child\\_process (`globalThis.process.send`) — in that\norder — and building the matching [PortLike](../interfaces/PortLike.md) automatically. This module never imports any\n`node:*` builtin, so it is safe to bundle for either target; the detection is a pure `globalThis`\nduck check.\n\n## Type Parameters\n\n| Type Parameter |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `S` *extends* [`IsolatedServiceSpec`](../interfaces/IsolatedServiceSpec.md)<[`MethodMap`](../type-aliases/MethodMap.md), [`StreamMap`](../type-aliases/StreamMap.md), [`EventMap`](../type-aliases/EventMap.md)> |\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------------------------------------------------------------------ |\n| `spec` | `S` |\n| `factory` | [`IsolatedImplementationFactory`](../type-aliases/IsolatedImplementationFactory.md)<`S`> |\n| `options?` | [`ServeIsolatedOptions`](../interfaces/ServeIsolatedOptions.md) |\n\n## Returns\n\n```ts\n{\n stop: () => void;\n}\n```\n\n| Name | Type | Defined in |\n| -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `stop()` | () => `void` | [src/batteries/isolation/serve.ts:353](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/serve.ts#L353) |\n\n## Throws\n\n@nhtio/adk/batteries/isolation!E\\_ISOLATION\\_UNSUPPORTED\\_ENV when neither environment\nis detected (e.g. called on a plain main-thread browser tab, or in a test with no fake `self`/\n`process.send`) — use [serveIsolatedOverPort](serveIsolatedOverPort.md) directly there instead.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/serveIsolatedOverPort","title":"Function: serveIsolatedOverPort()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/serveIsolatedOverPort.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/serveIsolatedOverPort","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/serveIsolatedOverPort.md'\n---\n\n# Function: serveIsolatedOverPort()\n\n```ts\nfunction serveIsolatedOverPort(\n spec: S,\n factory: IsolatedImplementationFactory,\n port: PortLike,\n options?: ServeIsolatedOptions,\n): {\n stop: () => void;\n};\n```\n\nDefined in: [src/batteries/isolation/serve.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/serve.ts#L92)\n\nServe `spec` over an already-constructed [PortLike](../interfaces/PortLike.md) — the environment-neutral primitive.\nBuilds the implementation via `factory`, wires a [GuestEndpoint](../classes/GuestEndpoint.md) to it, and announces\nreadiness (`ready` envelope) once the encoder-availability probe resolves.\n\n## Type Parameters\n\n| Type Parameter |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `S` *extends* [`IsolatedServiceSpec`](../interfaces/IsolatedServiceSpec.md)<[`MethodMap`](../type-aliases/MethodMap.md), [`StreamMap`](../type-aliases/StreamMap.md), [`EventMap`](../type-aliases/EventMap.md)> |\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------------------------------------------------------------------ |\n| `spec` | `S` |\n| `factory` | [`IsolatedImplementationFactory`](../type-aliases/IsolatedImplementationFactory.md)<`S`> |\n| `port` | [`PortLike`](../interfaces/PortLike.md) |\n| `options?` | [`ServeIsolatedOptions`](../interfaces/ServeIsolatedOptions.md) |\n\n## Returns\n\n```ts\n{\n stop: () => void;\n}\n```\n\nA `stop()` function that tears down the endpoint's port subscription. Does NOT itself close\nthe port — callers own the port's lifecycle.\n\n| Name | Type | Defined in |\n| -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------- |\n| `stop()` | () => `void` | [src/batteries/isolation/serve.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/serve.ts#L97) |\n\n## Throws\n\n@nhtio/adk/batteries/isolation!E\\_INVALID\\_ISOLATION\\_OPTIONS when `options` fails\nvalidation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/spawnIsolated","title":"Function: spawnIsolated()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/spawnIsolated.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/spawnIsolated","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/spawnIsolated.md'\n---\n\n# Function: spawnIsolated()\n\n```ts\nfunction spawnIsolated(\n spec: S,\n options: SpawnIsolatedOptions,\n): IsolatedService;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:285](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L285)\n\nSugar for `createIsolatedService(spec, createWorkerTransport(spec, options), options)` — spawn a\nreal Worker-backed [IsolatedService](../interfaces/IsolatedService.md) in one call.\n\n## Type Parameters\n\n| Type Parameter |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `S` *extends* [`IsolatedServiceSpec`](../interfaces/IsolatedServiceSpec.md)<[`MethodMap`](../type-aliases/MethodMap.md), [`StreamMap`](../type-aliases/StreamMap.md), [`EventMap`](../type-aliases/EventMap.md)> |\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------- |\n| `spec` | `S` |\n| `options` | [`SpawnIsolatedOptions`](../interfaces/SpawnIsolatedOptions.md) |\n\n## Returns\n\n[`IsolatedService`](../interfaces/IsolatedService.md)<`S`>\n\n## Remarks\n\nThe transport-only keys (`worker`/`workerOptions`) are stripped before the remaining options reach\n`createIsolatedService` — its validator is deliberately strict (unknown keys rejected), accepting\nonly the base [IsolatedServiceOptions](../interfaces/IsolatedServiceOptions.md) shape; the transport-only keys were already validated\n(and consumed) by [createWorkerTransport](createWorkerTransport.md).\n\n## Throws\n\n@nhtio/adk/batteries/isolation!E\\_ISOLATION\\_UNSUPPORTED\\_ENV when no browser `Worker`\nglobal is present.\n\n## Throws\n\n@nhtio/adk/batteries/isolation!E\\_INVALID\\_ISOLATION\\_OPTIONS when `options` fails\nvalidation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/stream","title":"Function: stream()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/stream.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/stream","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/stream.md'\n---\n\n# Function: stream()\n\n```ts\nfunction stream(opts?: StreamOptions): StreamDescriptor;\n```\n\nDefined in: [src/batteries/isolation/types.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L126)\n\nDeclare a fire-and-forward streaming method on an isolated service's spec — the host gets a\n`(...args) => ReadableStream` facade method (synchronous: the stream is returned immediately, fed\nby deltas as they cross the wire); the guest implementation returns (or is called to produce) a\n`ReadableStream` or `AsyncIterable`.\n\n## Type Parameters\n\n| Type Parameter | Description |\n| ------------------------- | -------------------------------------- |\n| `A` *extends* `unknown`\\[] | The stream's argument tuple. |\n| `D` | The type of each streamed delta/chunk. |\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------- | ---------------------------------------------------- |\n| `opts` | [`StreamOptions`](../interfaces/StreamOptions.md) | See [StreamOptions](../interfaces/StreamOptions.md). |\n\n## Returns\n\n[`StreamDescriptor`](../interfaces/StreamDescriptor.md)<`A`, `D`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/stripEnvelopeSpecialTokens","title":"Function: stripEnvelopeSpecialTokens()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/stripEnvelopeSpecialTokens.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/stripEnvelopeSpecialTokens","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/stripEnvelopeSpecialTokens.md\n---\n\n# Function: stripEnvelopeSpecialTokens()\n\n```ts\nfunction stripEnvelopeSpecialTokens(text: string): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L129)\n\nStrip the non-semantic envelope/turn-boundary special tokens (see ENVELOPE\\_SPECIAL\\_TOKEN\\_RE)\nfrom decoded model text before it reaches the parser layer.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `text` | `string` |\n\n## Returns\n\n`string`\n\n## Remarks\n\n**Why this exists.** The transformers.js streaming path decodes with `skip_special_tokens:false` (it\nmust — the live prose-stop gate watches for tool/think markers, which ARE special tokens). That leaves\nenvelope tokens like Llama's `<|python_tag|>{json}<|eom_id|>` or ChatML's trailing `<|im_end|>` in the\naccumulated text, so the JSON tool-call parsers see `<|python_tag|>{…}` and decline — even though the\nNON-streaming path (which decodes with `skip_special_tokens:true`) parses the identical call fine.\nNormalising here makes the stream and batch paths parse equivalent text. Surfaced by the deep model\nmatrix (Llama-3.2-1B + Qwen2.5-Coder tool calls passed on batch, failed on stream).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/toolsToChatCompletionsTools","title":"Function: toolsToChatCompletionsTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/toolsToChatCompletionsTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/toolsToChatCompletionsTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/toolsToChatCompletionsTools.md\n---\n\n# Function: toolsToChatCompletionsTools()\n\n```ts\nfunction toolsToChatCompletionsTools(\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n): ChatCompletionsTool[];\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:838](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L838)\n\nImplements [ChatHelpersCommon.toolsToChatCompletionsTools](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../forge/classes/Tool.md)<[`SpooledArtifact`](../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../interfaces/DescriptionLike.md)) => [`JsonSchema`](../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../interfaces/DescriptionLike.md)) => [`JsonSchema`](../interfaces/JsonSchema.md) |\n\n## Returns\n\n[`ChatCompletionsTool`](../interfaces/ChatCompletionsTool.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/transfer","title":"Function: transfer()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/transfer.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/transfer","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/transfer.md'\n---\n\n# Function: transfer()\n\n```ts\nfunction transfer(value: T, transferables: unknown[]): T;\n```\n\nDefined in: [src/batteries/isolation/codec.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L119)\n\nMark `value` for transfer (rather than clone) across a `postMessage`-based transport — the Web Worker\ntransport unwraps this into the message's transfer list. The codec passes marked values through as\n`raw` with `transferables` preserved on the [WireValue](../type-aliases/WireValue.md) envelope's `transfer` field. Node\ntransports ignore the marker entirely (structured-clone/pipe semantics don't have a transfer\nlist), so `transfer()` is safe to use in transport-agnostic code that may run over either.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `T` |\n\n## Parameters\n\n| Parameter | Type |\n| --------------- | ----------- |\n| `value` | `T` |\n| `transferables` | `unknown`\\[] |\n\n## Returns\n\n`T`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/validateTransformersJsSttOptions","title":"Function: validateTransformersJsSttOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/validateTransformersJsSttOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/validateTransformersJsSttOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/functions/validateTransformersJsSttOptions.md\n---\n\n# Function: validateTransformersJsSttOptions()\n\n```ts\nfunction validateTransformersJsSttOptions(\n input: unknown,\n): TransformersJsSttAdapterOptions;\n```\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/validation.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/validation.ts#L55)\n\nValidates an arbitrary input against `transformersJsSttAdapterOptionsSchema`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`TransformersJsSttAdapterOptions`](../interfaces/TransformersJsSttAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS](../variables/E_INVALID_TRANSFORMERS_JS_STT_OPTIONS.md) when invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/functions/wireErrorToError","title":"Function: wireErrorToError()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/wireErrorToError.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/functions/wireErrorToError","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/functions/wireErrorToError.md'\n---\n\n# Function: wireErrorToError()\n\n```ts\nfunction wireErrorToError(wireError: WireError): Error;\n```\n\nDefined in: [src/batteries/isolation/protocol.ts:397](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L397)\n\nReconstruct an `Error` from a [WireError](../interfaces/WireError.md) baseline (name/message/stack only — the `nhtio`-rich\npath is decoded separately by the caller when an encoder is available; see `host.ts`).\n\n## Parameters\n\n| Parameter | Type |\n| ----------- | ----------------------------------------- |\n| `wireError` | [`WireError`](../interfaces/WireError.md) |\n\n## Returns\n\n`Error`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation","title":"@nhtio/adk/batteries/generation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation.md'\ndescription: Environment-neutral aggregate barrel for bundled media generation batteries.\n---\n\n# @nhtio/adk/batteries/generation\n\nEnvironment-neutral aggregate barrel for bundled media generation batteries.\n\n## Remarks\n\nAggregate barrel for the generation domain: media generation (text→image + image editing)\nbatteries — adapter classes a consumer calls from their own BYO `Tool`. Mirrors\n`@nhtio/adk/batteries/embeddings` in shape: one shared option base\n([@nhtio/adk/batteries/generation/openai/types!BaseGenerationAdapterOptions](openai/types/interfaces/BaseGenerationAdapterOptions.md)) owned by the\nfirst engine battery, extended by every later one, plus an identical method surface\n(`generate`/`edit`/`isAvailable`/`preload`/`reset`) across engines.\n\nToday this barrel re-exports:\n\n* `@nhtio/adk/batteries/generation/openai` — the OpenAI `/v1/images/generations` +\n `/v1/images/edits` battery (raw `fetch`, runs anywhere), and owner of the shared option base.\n* `@nhtio/adk/batteries/generation/gemini` — the native Gemini `generativelanguage`\n `generateContent` battery (raw `fetch`, runs anywhere).\n* `@nhtio/adk/batteries/generation/transformers_js` — EXPERIMENTAL on-device text→image via\n transformers.js's DeepSeek Janus (`MultiModalityCausalLM.generate_images`) family. No\n WebGPU requirement (environment-neutral, ONNX Runtime auto-selected), but a ~2GB model and\n minutes-per-image on WASM/CPU — prefer the OpenAI/Gemini engines unless offline is the point.\n* `@nhtio/adk/batteries/generation/_shared` — the structural contracts and normalization helper\n (`GenerationMediaLike`, `GenerationImageInput`, `toBytes`) shared across every engine.\n\n`_shared`'s `toBytes` is re-exported under the domain-qualified name\n`toGenerationBytes` (not a bare `export *`) because `@nhtio/adk/batteries/specialists` already\nthreads its own structurally-identical `toBytes` helper through this same top-level\n`@nhtio/adk/batteries` aggregate — mirroring the `validateOptions` rename pattern every battery\nbarrel already uses to stay collision-free.\n\n## References\n\n### BaseGenerationAdapterOptions\n\nRe-exports [BaseGenerationAdapterOptions](openai/types/interfaces/BaseGenerationAdapterOptions.md)\n\n***\n\n### CreateTransformersJsGenerationModel\n\nRe-exports [CreateTransformersJsGenerationModel](transformers_js/types/type-aliases/CreateTransformersJsGenerationModel.md)\n\n***\n\n### CreateTransformersJsGenerationProcessor\n\nRe-exports [CreateTransformersJsGenerationProcessor](transformers_js/types/type-aliases/CreateTransformersJsGenerationProcessor.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR](gemini/exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE](gemini/exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT](gemini/exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS](gemini/exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS](openai/exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS](transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR](openai/exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE](openai/exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT](openai/exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md)\n\n***\n\n### EDIT\\_IMAGE\\_FIELD\\_NAME\n\nRe-exports [EDIT\\_IMAGE\\_FIELD\\_NAME](openai/adapter/variables/EDIT_IMAGE_FIELD_NAME.md)\n\n***\n\n### EditOptions\n\nRe-exports [EditOptions](openai/types/interfaces/EditOptions.md)\n\n***\n\n### EncodeRawImageFn\n\nRe-exports [EncodeRawImageFn](transformers_js/types/type-aliases/EncodeRawImageFn.md)\n\n***\n\n### GeminiContent\n\nRe-exports [GeminiContent](gemini/types/interfaces/GeminiContent.md)\n\n***\n\n### GeminiEditOptions\n\nRe-exports [GeminiEditOptions](gemini/types/interfaces/GeminiEditOptions.md)\n\n***\n\n### GeminiGenerateContentRequestBody\n\nRe-exports [GeminiGenerateContentRequestBody](gemini/types/interfaces/GeminiGenerateContentRequestBody.md)\n\n***\n\n### GeminiGenerateContentResponse\n\nRe-exports [GeminiGenerateContentResponse](gemini/types/interfaces/GeminiGenerateContentResponse.md)\n\n***\n\n### GeminiGenerateOptions\n\nRe-exports [GeminiGenerateOptions](gemini/types/interfaces/GeminiGenerateOptions.md)\n\n***\n\n### GeminiGenerationAdapter\n\nRe-exports [GeminiGenerationAdapter](gemini/adapter/classes/GeminiGenerationAdapter.md)\n\n***\n\n### GeminiGenerationAdapterOptions\n\nRe-exports [GeminiGenerationAdapterOptions](gemini/types/interfaces/GeminiGenerationAdapterOptions.md)\n\n***\n\n### GeminiGenerationConfig\n\nRe-exports [GeminiGenerationConfig](gemini/types/interfaces/GeminiGenerationConfig.md)\n\n***\n\n### geminiGenerationOptionsSchema\n\nRe-exports [geminiGenerationOptionsSchema](gemini/validation/variables/geminiGenerationOptionsSchema.md)\n\n***\n\n### GeminiRequestPart\n\nRe-exports [GeminiRequestPart](gemini/types/type-aliases/GeminiRequestPart.md)\n\n***\n\n### GeminiResponseModality\n\nRe-exports [GeminiResponseModality](gemini/types/type-aliases/GeminiResponseModality.md)\n\n***\n\n### GeminiResponsePart\n\nRe-exports [GeminiResponsePart](gemini/types/type-aliases/GeminiResponsePart.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GenerateOptions\n\nRe-exports [GenerateOptions](openai/types/interfaces/GenerateOptions.md)\n\n***\n\n### GenerationBytesInput\n\nRe-exports [GenerationBytesInput](_shared/interfaces/GenerationBytesInput.md)\n\n***\n\n### GenerationImageInput\n\nRe-exports [GenerationImageInput](_shared/type-aliases/GenerationImageInput.md)\n\n***\n\n### GenerationMediaLike\n\nRe-exports [GenerationMediaLike](_shared/interfaces/GenerationMediaLike.md)\n\n***\n\n### GenerationRetryConfig\n\nRe-exports [GenerationRetryConfig](openai/types/interfaces/GenerationRetryConfig.md)\n\n***\n\n### OpenAIEditOptions\n\nRe-exports [OpenAIEditOptions](openai/types/interfaces/OpenAIEditOptions.md)\n\n***\n\n### OpenAIGenerateOptions\n\nRe-exports [OpenAIGenerateOptions](openai/types/interfaces/OpenAIGenerateOptions.md)\n\n***\n\n### OpenAIGenerationAdapter\n\nRe-exports [OpenAIGenerationAdapter](openai/adapter/classes/OpenAIGenerationAdapter.md)\n\n***\n\n### OpenAIGenerationAdapterOptions\n\nRe-exports [OpenAIGenerationAdapterOptions](openai/types/interfaces/OpenAIGenerationAdapterOptions.md)\n\n***\n\n### openAIGenerationOptionsSchema\n\nRe-exports [openAIGenerationOptionsSchema](openai/validation/variables/openAIGenerationOptionsSchema.md)\n\n***\n\n### OpenAIImagesGenerationRequestBody\n\nRe-exports [OpenAIImagesGenerationRequestBody](openai/types/interfaces/OpenAIImagesGenerationRequestBody.md)\n\n***\n\n### OpenAIImagesResponse\n\nRe-exports [OpenAIImagesResponse](openai/types/interfaces/OpenAIImagesResponse.md)\n\n***\n\n### toGenerationBytes\n\nRenames and re-exports [toBytes](_shared/functions/toBytes.md)\n\n***\n\n### TransformersJsGenerateOptions\n\nRe-exports [TransformersJsGenerateOptions](transformers_js/types/interfaces/TransformersJsGenerateOptions.md)\n\n***\n\n### TransformersJsGenerationAdapter\n\nRe-exports [TransformersJsGenerationAdapter](transformers_js/adapter/classes/TransformersJsGenerationAdapter.md)\n\n***\n\n### TransformersJsGenerationAdapterOptions\n\nRe-exports [TransformersJsGenerationAdapterOptions](transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions.md)\n\n***\n\n### TransformersJsGenerationDataType\n\nRe-exports [TransformersJsGenerationDataType](transformers_js/types/type-aliases/TransformersJsGenerationDataType.md)\n\n***\n\n### TransformersJsGenerationDeviceType\n\nRe-exports [TransformersJsGenerationDeviceType](transformers_js/types/type-aliases/TransformersJsGenerationDeviceType.md)\n\n***\n\n### TransformersJsGenerationModel\n\nRe-exports [TransformersJsGenerationModel](transformers_js/types/interfaces/TransformersJsGenerationModel.md)\n\n***\n\n### TransformersJsGenerationModelSource\n\nRe-exports [TransformersJsGenerationModelSource](transformers_js/types/type-aliases/TransformersJsGenerationModelSource.md)\n\n***\n\n### transformersJsGenerationOptionsSchema\n\nRe-exports [transformersJsGenerationOptionsSchema](transformers_js/validation/variables/transformersJsGenerationOptionsSchema.md)\n\n***\n\n### TransformersJsGenerationProcessor\n\nRe-exports [TransformersJsGenerationProcessor](transformers_js/types/interfaces/TransformersJsGenerationProcessor.md)\n\n***\n\n### TransformersJsGenerationProgressCallback\n\nRe-exports [TransformersJsGenerationProgressCallback](transformers_js/types/type-aliases/TransformersJsGenerationProgressCallback.md)\n\n***\n\n### TransformersJsRawImageLike\n\nRe-exports [TransformersJsRawImageLike](transformers_js/types/interfaces/TransformersJsRawImageLike.md)\n\n***\n\n### validateGeminiGenerationOptions\n\nRenames and re-exports [validateOptions](gemini/validation/functions/validateOptions.md)\n\n***\n\n### validateOpenAIGenerationOptions\n\nRenames and re-exports [validateOptions](openai/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsGenerationOptions\n\nRenames and re-exports [validateOptions](transformers_js/validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared","title":"@nhtio/adk/batteries/generation/\\_shared","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/_shared.md'\ndescription: >-\n Structural contracts and normalization helpers shared by the media generation\n batteries (text→image + image editing).\n---\n\n# @nhtio/adk/batteries/generation/\\_shared\n\nStructural contracts and normalization helpers shared by the media generation batteries\n(text→image + image editing).\n\n## Remarks\n\nThis module imports **nothing** from `@nhtio/adk` core — not even a type-only import — per\nCONTRIBUTING.md → Design Decisions → #13 \"Battery design — no concrete core-class coupling\",\ntier 2 (locally-declared structural duck-types). A generation adapter is *handed* an image to\nedit at runtime (the source image, an optional mask) but never constructs a `Media` itself, so\nit has no genuine reason to import the class: [GenerationMediaLike](interfaces/GenerationMediaLike.md) declares the exact\nshape it reads (`mimeType` + `asBytes()`), and a real core `Media` instance satisfies it\nautomatically, with zero import edge between the generation domain and core.\n\nThis is the structural twin of `src/batteries/specialists/_shared/index.ts` restricted to the\nimage half (specialists' audio-specific `SpecialistPcmInput` / `DecodeAudioFn` machinery has no\ncounterpart here — generation batteries only ever consume images as input, never audio).\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [GenerationBytesInput](interfaces/GenerationBytesInput.md) | Raw bytes plus an optional MIME type — the plain-object form of image input. |\n| [GenerationMediaLike](interfaces/GenerationMediaLike.md) | Structural duck-type of core `Media`: the exact shape a generation adapter reads off a media value it was handed as edit input — its declared MIME type, and an async accessor for its raw bytes. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [GenerationImageInput](type-aliases/GenerationImageInput.md) | Any of the three forms a generation adapter accepts as image input (for edit calls, and for a future mask parameter): a bare `Uint8Array` (MIME type unknown), a [GenerationBytesInput](interfaces/GenerationBytesInput.md) record (bytes + declared MIME), or a [GenerationMediaLike](interfaces/GenerationMediaLike.md) (a real `Media` or any duck-typed equivalent). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [toBytes](functions/toBytes.md) | Normalizes any [GenerationImageInput](type-aliases/GenerationImageInput.md) form to plain bytes plus an optional MIME type. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/functions/toBytes","title":"Function: toBytes()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/functions/toBytes.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/functions/toBytes","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/_shared/functions/toBytes.md\n---\n\n# Function: toBytes()\n\n```ts\nfunction toBytes(input: GenerationImageInput): Promise<{\n bytes: Uint8Array;\n mimeType?: string;\n}>;\n```\n\nDefined in: [src/batteries/generation/\\_shared/index.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L69)\n\nNormalizes any [GenerationImageInput](../type-aliases/GenerationImageInput.md) form to plain bytes plus an optional MIME type.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------- | ------------------------------------- |\n| `input` | [`GenerationImageInput`](../type-aliases/GenerationImageInput.md) | The image input in any accepted form. |\n\n## Returns\n\n`Promise`<{\n`bytes`: `Uint8Array`;\n`mimeType?`: `string`;\n}>\n\nThe normalized bytes and MIME type (MIME `undefined` only for the bare-`Uint8Array` form).\n\n## Remarks\n\nA bare `Uint8Array` passes through with `mimeType: undefined` (the caller declared no MIME). A\n[GenerationBytesInput](../interfaces/GenerationBytesInput.md) passes its `bytes`/`mimeType` through unchanged. A\n[GenerationMediaLike](../interfaces/GenerationMediaLike.md) is resolved by awaiting `asBytes()` and reading `mimeType` off it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationBytesInput","title":"Interface: GenerationBytesInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationBytesInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationBytesInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationBytesInput.md\ndescription: Raw bytes plus an optional MIME type — the plain-object form of image input.\n---\n\n# Interface: GenerationBytesInput\n\nDefined in: [src/batteries/generation/\\_shared/index.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L43)\n\nRaw bytes plus an optional MIME type — the plain-object form of image input.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ------------ | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The raw encoded image bytes (e.g. a PNG/JPEG/WebP buffer). | [src/batteries/generation/\\_shared/index.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L45) |\n| `mimeType?` | `string` | The MIME type of `bytes`, when known. | [src/batteries/generation/\\_shared/index.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L47) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationMediaLike","title":"Interface: GenerationMediaLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationMediaLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationMediaLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationMediaLike.md\ndescription: >-\n Structural duck-type of core `Media`: the exact shape a generation adapter\n reads off a media value it was handed as edit input — its declared MIME type,\n and an async accessor for its raw bytes.\n---\n\n# Interface: GenerationMediaLike\n\nDefined in: [src/batteries/generation/\\_shared/index.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L35)\n\nStructural duck-type of core `Media`: the exact shape a generation adapter reads off a media\nvalue it was handed as edit input — its declared MIME type, and an async accessor for its raw\nbytes.\n\n## Remarks\n\nA real `@nhtio/adk` `Media` instance satisfies this interface structurally (it has both a\n`mimeType` string property and an `asBytes(): Promise` method), so callers can pass\na `Media` straight through without the generation domain ever importing the class. See the\nmodule remarks for why this is a deliberate decoupling choice (CONTRIBUTING.md Design Decision\n\\#13, tier 2).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | -------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `mimeType` | `string` | The media's declared MIME type, e.g. `'image/png'` or `'image/jpeg'`. | [src/batteries/generation/\\_shared/index.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L37) |\n\n## Methods\n\n### asBytes()\n\n```ts\nasBytes(): Promise>;\n```\n\nDefined in: [src/batteries/generation/\\_shared/index.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L39)\n\nResolves the media's raw bytes.\n\n#### Returns\n\n`Promise`<`Uint8Array`<`ArrayBufferLike`>>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/type-aliases/GenerationImageInput","title":"Type Alias: GenerationImageInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/type-aliases/GenerationImageInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/_shared/type-aliases/GenerationImageInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/_shared/type-aliases/GenerationImageInput.md\ndescription: >-\n Any of the three forms a generation adapter accepts as image input (for edit\n calls, and for a future mask parameter): a bare `Uint8Array` (MIME type\n unknown), a [`GenerationBytesInput`](https://adk.nht.io/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationBytesInput) record (bytes + declared MIME), or a\n [`GenerationMediaLike`](https://adk.nht.io/api/@nhtio/adk/batteries/generation/_shared/interfaces/GenerationMediaLike) (a real `Media` or any duck-typed equivalent).\n---\n\n# Type Alias: GenerationImageInput\n\n```ts\ntype GenerationImageInput =\n | Uint8Array\n | GenerationBytesInput\n | GenerationMediaLike;\n```\n\nDefined in: [src/batteries/generation/\\_shared/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/_shared/index.ts#L56)\n\nAny of the three forms a generation adapter accepts as image input (for edit calls, and for a\nfuture mask parameter): a bare `Uint8Array` (MIME type unknown), a [GenerationBytesInput](../interfaces/GenerationBytesInput.md)\nrecord (bytes + declared MIME), or a [GenerationMediaLike](../interfaces/GenerationMediaLike.md) (a real `Media` or any\nduck-typed equivalent).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini","title":"@nhtio/adk/batteries/generation/gemini","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini.md'\ndescription: Gemini media generation adapter battery.\n---\n\n# @nhtio/adk/batteries/generation/gemini\n\nGemini media generation adapter battery.\n\n## Remarks\n\nRe-exports the adapter class, every option / wire-shape type alias (including the shared\n[@nhtio/adk/batteries/generation/openai/types!BaseGenerationAdapterOptions](../openai/types/interfaces/BaseGenerationAdapterOptions.md),\n[@nhtio/adk/batteries/generation/openai/types!GenerateOptions](../openai/types/interfaces/GenerateOptions.md),\n[@nhtio/adk/batteries/generation/openai/types!EditOptions](../openai/types/interfaces/EditOptions.md), and\n[@nhtio/adk/batteries/generation/openai/types!GenerationRetryConfig](../openai/types/interfaces/GenerationRetryConfig.md) owned by the OpenAI\nGeneration battery), the validation schema + `validateOptions` wrapper, and the battery-scoped\nexceptions.\n\n## References\n\n### BaseGenerationAdapterOptions\n\nRe-exports [BaseGenerationAdapterOptions](../openai/types/interfaces/BaseGenerationAdapterOptions.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR](exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE](exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT](exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS](exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md)\n\n***\n\n### EditOptions\n\nRe-exports [EditOptions](../openai/types/interfaces/EditOptions.md)\n\n***\n\n### GeminiContent\n\nRe-exports [GeminiContent](types/interfaces/GeminiContent.md)\n\n***\n\n### GeminiEditOptions\n\nRe-exports [GeminiEditOptions](types/interfaces/GeminiEditOptions.md)\n\n***\n\n### GeminiGenerateContentRequestBody\n\nRe-exports [GeminiGenerateContentRequestBody](types/interfaces/GeminiGenerateContentRequestBody.md)\n\n***\n\n### GeminiGenerateContentResponse\n\nRe-exports [GeminiGenerateContentResponse](types/interfaces/GeminiGenerateContentResponse.md)\n\n***\n\n### GeminiGenerateOptions\n\nRe-exports [GeminiGenerateOptions](types/interfaces/GeminiGenerateOptions.md)\n\n***\n\n### GeminiGenerationAdapter\n\nRe-exports [GeminiGenerationAdapter](adapter/classes/GeminiGenerationAdapter.md)\n\n***\n\n### GeminiGenerationAdapterOptions\n\nRe-exports [GeminiGenerationAdapterOptions](types/interfaces/GeminiGenerationAdapterOptions.md)\n\n***\n\n### GeminiGenerationConfig\n\nRe-exports [GeminiGenerationConfig](types/interfaces/GeminiGenerationConfig.md)\n\n***\n\n### geminiGenerationOptionsSchema\n\nRe-exports [geminiGenerationOptionsSchema](validation/variables/geminiGenerationOptionsSchema.md)\n\n***\n\n### GeminiRequestPart\n\nRe-exports [GeminiRequestPart](types/type-aliases/GeminiRequestPart.md)\n\n***\n\n### GeminiResponseModality\n\nRe-exports [GeminiResponseModality](types/type-aliases/GeminiResponseModality.md)\n\n***\n\n### GeminiResponsePart\n\nRe-exports [GeminiResponsePart](types/type-aliases/GeminiResponsePart.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GenerateOptions\n\nRe-exports [GenerateOptions](../openai/types/interfaces/GenerateOptions.md)\n\n***\n\n### GenerationRetryConfig\n\nRe-exports [GenerationRetryConfig](../openai/types/interfaces/GenerationRetryConfig.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/adapter","title":"@nhtio/adk/batteries/generation/gemini/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/adapter.md'\ndescription: Cross-environment Gemini media generation adapter battery.\n---\n\n# @nhtio/adk/batteries/generation/gemini/adapter\n\nCross-environment Gemini media generation adapter battery.\n\n## Remarks\n\nOpinionated media-generation battery for the native Gemini `generativelanguage` REST surface —\n`POST /models/{model}:generateContent` — over raw `fetch`. No `@google/genai` SDK dependency, so\nit runs unchanged in Node, the browser, edge runtimes, and workers.\n\nConstruction validates options eagerly via\n[@nhtio/adk/batteries/generation/gemini/validation!validateOptions](../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS](../exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md) on\nfailure — config bugs fail loud, not at generate/edit time.\n\n## Classes\n\n| Class | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| [GeminiGenerationAdapter](classes/GeminiGenerationAdapter.md) | Media generation adapter for the native Gemini `generativelanguage` `generateContent` wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/adapter/classes/GeminiGenerationAdapter","title":"Class: GeminiGenerationAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/adapter/classes/GeminiGenerationAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/adapter/classes/GeminiGenerationAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/adapter/classes/GeminiGenerationAdapter.md\ndescription: >-\n Media generation adapter for the native Gemini `generativelanguage`\n `generateContent` wire shape.\n---\n\n# Class: GeminiGenerationAdapter\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L68)\n\nMedia generation adapter for the native Gemini `generativelanguage` `generateContent` wire\nshape.\n\n## Remarks\n\nReusable: construct once, call [GeminiGenerationAdapter.generate](#generate) /\n[GeminiGenerationAdapter.edit](#edit) as many times as needed.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew GeminiGenerationAdapter(options: unknown): GeminiGenerationAdapter;\n```\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L85)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`GeminiGenerationAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS](../../exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md) when `options` does not satisfy\n[@nhtio/adk/batteries/generation/gemini/validation!geminiGenerationOptionsSchema](../../validation/variables/geminiGenerationOptionsSchema.md) (e.g. missing `model`).\n\n## Methods\n\n### edit()\n\n```ts\nedit(\n inputs:\n | GenerationImageInput\n | GenerationImageInput[],\n prompt: string,\nopts?: GeminiEditOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L141)\n\nEdits one or more source images from a text prompt.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| `inputs` | | [`GenerationImageInput`](../../../_shared/type-aliases/GenerationImageInput.md) | [`GenerationImageInput`](../../../_shared/type-aliases/GenerationImageInput.md)\\[] | One image, or several images, in any [GenerationImageInput](../../../_shared/type-aliases/GenerationImageInput.md) form. |\n| `prompt` | `string` | The text prompt describing the desired edit. |\n| `opts?` | [`GeminiEditOptions`](../../types/interfaces/GeminiEditOptions.md) | Per-call options (`n`, `aspectRatio`), each falling back to the adapter's configured default when applicable. |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\nOne [GeneratedMediaOutput](../../../../interfaces/GeneratedMediaOutput.md) per edited image part in the response.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR](../../exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR.md) on a non-2xx response or transport failure.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT](../../exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md) when the handshake exceeds `requestTimeoutMs`.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE](../../exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md) when the 2xx body is not the expected shape, or contains zero image parts.\n\n***\n\n### generate()\n\n```ts\ngenerate(prompt: string, opts?: GeminiGenerateOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L120)\n\nGenerates one or more images from a text prompt.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| `prompt` | `string` | The text prompt describing the desired image(s). |\n| `opts?` | [`GeminiGenerateOptions`](../../types/interfaces/GeminiGenerateOptions.md) | Per-call options (`n`, `aspectRatio`), each falling back to the adapter's configured default when applicable. |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\nOne [GeneratedMediaOutput](../../../../interfaces/GeneratedMediaOutput.md) per generated image part in the response.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR](../../exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR.md) on a non-2xx response or transport failure.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT](../../exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md) when the handshake exceeds `requestTimeoutMs`.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/gemini/exceptions!E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE](../../exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md) when the 2xx body is not the expected shape, or contains zero image parts.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L90)\n\nSee [GeminiGenerationAdapter.isAvailable](#isavailable-1). Instance alias for surface-parity.\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L98)\n\nNo-op warm-up. The Gemini battery has no engine to preload; present for surface-parity with\non-device generation batteries so callers can treat them interchangeably.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L105)\n\nNo-op state reset. Present for surface-parity with on-device generation batteries.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/gemini/adapter.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/adapter.ts#L76)\n\nWhether this battery can run in the current environment. For the HTTP-backed Gemini battery\nthis is always `true` (a `fetch` is always resolvable); present for surface-parity with\nWebGPU-gated batteries.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions","title":"@nhtio/adk/batteries/generation/gemini/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/exceptions.md'\ndescription: >-\n Battery-scoped exception constructors for Gemini media generation adapter\n failures.\n---\n\n# @nhtio/adk/batteries/generation/gemini/exceptions\n\nBattery-scoped exception constructors for Gemini media generation adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the Gemini media generation adapter. These exceptions are\nowned by the battery (not the ADK core) and are minted via `createException` from\n`@nhtio/adk/factories`. Re-exported from the battery's barrel.\n\nThe categories mirror the OpenAI Generation battery one-to-one so batteries across engines fail\nwith parallel semantics — only the engine-specific transport exception differs.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR](variables/E_GEMINI_GENERATION_HTTP_ERROR.md) | Thrown when the upstream `/models/{model}:generateContent` endpoint returns a non-2xx response (after retries are exhausted), or the transport throws. Non-fatal. Printf args: `[status, detail]` — `status` is `0` for a transport-level failure with no HTTP response. |\n| [E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE](variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md) | Thrown when a 2xx response body cannot be parsed into the expected candidates/parts shape, or when it contains zero image parts (e.g. a safety refusal returning text only). In the zero-image case the detail string includes any text parts' content so refusals surface legibly. Non-fatal. Printf arg: `[detail]`. |\n| [E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT](variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md) | Thrown when the request handshake does not complete before `requestTimeoutMs` (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`. |\n| [E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS](variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `geminiGenerationOptionsSchema` — e.g. a missing/empty `model`, an unknown option key, or an invalid `responseModalities` entry. Fatal: config bugs fail loud at construction time, not at generate/edit time. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR","title":"Variable: E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_HTTP_ERROR.md\ndescription: >-\n Thrown when the upstream `/models/{model}:generateContent` endpoint returns a\n non-2xx response (after retries are exhausted), or the transport throws.\n Non-fatal. Printf args: `[status, detail]` — `status` is `0` for a\n transport-level failure with no HTTP response.\n---\n\n# Variable: E\\_GEMINI\\_GENERATION\\_HTTP\\_ERROR\n\n```ts\nconst E_GEMINI_GENERATION_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/generation/gemini/exceptions.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/exceptions.ts#L36)\n\nThrown when the upstream `/models/{model}:generateContent` endpoint returns a non-2xx response\n(after retries are exhausted), or the transport throws. Non-fatal. Printf args:\n`[status, detail]` — `status` is `0` for a transport-level failure with no HTTP response.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE","title":"Variable: E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_MALFORMED_RESPONSE.md\ndescription: >-\n Thrown when a 2xx response body cannot be parsed into the expected\n candidates/parts shape, or when it contains zero image parts (e.g. a safety\n refusal returning text only). In the zero-image case the detail string\n includes any text parts' content so refusals surface legibly. Non-fatal.\n Printf arg: `[detail]`.\n---\n\n# Variable: E\\_GEMINI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\n```ts\nconst E_GEMINI_GENERATION_MALFORMED_RESPONSE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/gemini/exceptions.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/exceptions.ts#L62)\n\nThrown when a 2xx response body cannot be parsed into the expected candidates/parts shape, or\nwhen it contains zero image parts (e.g. a safety refusal returning text only). In the\nzero-image case the detail string includes any text parts' content so refusals surface legibly.\nNon-fatal. Printf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT","title":"Variable: E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_GEMINI_GENERATION_REQUEST_TIMEOUT.md\ndescription: >-\n Thrown when the request handshake does not complete before `requestTimeoutMs`\n (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n---\n\n# Variable: E\\_GEMINI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_GEMINI_GENERATION_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/generation/gemini/exceptions.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/exceptions.ts#L48)\n\nThrown when the request handshake does not complete before `requestTimeoutMs` (and retries are\nexhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS","title":"Variable: E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/exceptions/variables/E_INVALID_GEMINI_GENERATION_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `geminiGenerationOptionsSchema` — e.g. a missing/empty `model`, an unknown\n option key, or an invalid `responseModalities` entry. Fatal: config bugs fail\n loud at construction time, not at generate/edit time.\n---\n\n# Variable: E\\_INVALID\\_GEMINI\\_GENERATION\\_OPTIONS\n\n```ts\nconst E_INVALID_GEMINI_GENERATION_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/gemini/exceptions.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/exceptions.ts#L23)\n\nThrown when the resolved adapter options fail validation against\n`geminiGenerationOptionsSchema` — e.g. a missing/empty `model`, an unknown option key, or an\ninvalid `responseModalities` entry. Fatal: config bugs fail loud at construction time, not at\ngenerate/edit time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types","title":"@nhtio/adk/batteries/generation/gemini/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types.md'\ndescription: Option and wire-shape types for the Gemini media generation adapter.\n---\n\n# @nhtio/adk/batteries/generation/gemini/types\n\nOption and wire-shape types for the Gemini media generation adapter.\n\n## Remarks\n\nBuilds on the **shared** generation option base owned by the OpenAI Generation battery\n([@nhtio/adk/batteries/generation/openai/types!BaseGenerationAdapterOptions](../../openai/types/interfaces/BaseGenerationAdapterOptions.md),\n[@nhtio/adk/batteries/generation/openai/types!GenerateOptions](../../openai/types/interfaces/GenerateOptions.md),\n[@nhtio/adk/batteries/generation/openai/types!EditOptions](../../openai/types/interfaces/EditOptions.md)). This battery re-exports those\nshared shapes and `extend`s them with the Gemini `generativelanguage` REST engine's own\ntransport/wire fields — exactly how the transformers.js Embeddings battery extends the OpenAI\nEmbeddings option type.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [GeminiContent](interfaces/GeminiContent.md) | A single entry in the `contents` array of a `generateContent` request. |\n| [GeminiEditOptions](interfaces/GeminiEditOptions.md) | Per-call options accepted by [@nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter.edit](../adapter/classes/GeminiGenerationAdapter.md#edit). |\n| [GeminiGenerateContentRequestBody](interfaces/GeminiGenerateContentRequestBody.md) | The JSON request body POSTed to `/models/{model}:generateContent`. |\n| [GeminiGenerateContentResponse](interfaces/GeminiGenerateContentResponse.md) | The relevant subset of the `/models/{model}:generateContent` JSON response shape. |\n| [GeminiGenerateOptions](interfaces/GeminiGenerateOptions.md) | Per-call options accepted by [@nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter.generate](../adapter/classes/GeminiGenerationAdapter.md#generate). |\n| [GeminiGenerationAdapterOptions](interfaces/GeminiGenerationAdapterOptions.md) | Constructor options for [@nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter](../adapter/classes/GeminiGenerationAdapter.md). |\n| [GeminiGenerationConfig](interfaces/GeminiGenerationConfig.md) | The `generationConfig` block of a `generateContent` request. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [GeminiRequestPart](type-aliases/GeminiRequestPart.md) | A single content part in a Gemini `generateContent` request. Requests always send **camelCase** `inlineData` — probe-confirmed to be accepted whether the request is routed through the LB or hits Google directly. |\n| [GeminiResponseModality](type-aliases/GeminiResponseModality.md) | The response modalities Gemini is asked to return. `'IMAGE'` is what actually yields generated media; `'TEXT'` is included by default alongside it so refusal/safety text (when present) arrives in the same response instead of a separate call. |\n| [GeminiResponsePart](type-aliases/GeminiResponsePart.md) | A single content part in a Gemini `generateContent` **response**. Tolerates both the canonical camelCase `inlineData` and a defensive snake\\_case `inline_data` — response-only tolerance; this battery's requests always send camelCase. |\n\n## References\n\n### BaseGenerationAdapterOptions\n\nRe-exports [BaseGenerationAdapterOptions](../../openai/types/interfaces/BaseGenerationAdapterOptions.md)\n\n***\n\n### EditOptions\n\nRe-exports [EditOptions](../../openai/types/interfaces/EditOptions.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GenerateOptions\n\nRe-exports [GenerateOptions](../../openai/types/interfaces/GenerateOptions.md)\n\n***\n\n### GenerationRetryConfig\n\nRe-exports [GenerationRetryConfig](../../openai/types/interfaces/GenerationRetryConfig.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiContent","title":"Interface: GeminiContent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiContent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiContent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiContent.md\ndescription: A single entry in the `contents` array of a `generateContent` request.\n---\n\n# Interface: GeminiContent\n\nDefined in: [src/batteries/generation/gemini/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L101)\n\nA single entry in the `contents` array of a `generateContent` request.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `parts` | [`GeminiRequestPart`](../type-aliases/GeminiRequestPart.md)\\[] | The ordered parts making up this content (image parts, if any, then the text prompt). | [src/batteries/generation/gemini/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L105) |\n| `role` | `\"user\"` | The role producing this content. Always `'user'` for this battery's requests. | [src/batteries/generation/gemini/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L103) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiEditOptions","title":"Interface: GeminiEditOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiEditOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiEditOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiEditOptions.md\ndescription: >-\n Per-call options accepted by {@link\n @nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter.edit}.\n---\n\n# Interface: GeminiEditOptions\n\nDefined in: [src/batteries/generation/gemini/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L84)\n\nPer-call options accepted by [@nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter.edit](../../adapter/classes/GeminiGenerationAdapter.md#edit).\n\n## Extends\n\n* [`EditOptions`](../../../openai/types/interfaces/EditOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------ | -------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `aspectRatio?` | `string` | Aspect ratio (e.g. `'16:9'`). Falls back to the adapter's configured default. | - | [src/batteries/generation/gemini/types.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L86) |\n| `n?` | `number` | Number of edited images to generate. Engine-defaulted when omitted. | [`EditOptions`](../../../openai/types/interfaces/EditOptions.md).[`n`](../../../openai/types/interfaces/EditOptions.md#property-n) | [src/batteries/generation/openai/types.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L55) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentRequestBody","title":"Interface: GeminiGenerateContentRequestBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentRequestBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentRequestBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentRequestBody.md\ndescription: 'The JSON request body POSTed to `/models/{model}:generateContent`.'\n---\n\n# Interface: GeminiGenerateContentRequestBody\n\nDefined in: [src/batteries/generation/gemini/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L123)\n\nThe JSON request body POSTed to `/models/{model}:generateContent`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `contents` | [`GeminiContent`](GeminiContent.md)\\[] | The conversation contents — for this battery, always a single user turn. | [src/batteries/generation/gemini/types.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L125) |\n| `generationConfig?` | [`GeminiGenerationConfig`](GeminiGenerationConfig.md) | Generation configuration (response modalities, candidate count, image config). | [src/batteries/generation/gemini/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L127) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentResponse","title":"Interface: GeminiGenerateContentResponse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentResponse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentResponse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateContentResponse.md\ndescription: >-\n The relevant subset of the `/models/{model}:generateContent` JSON response\n shape.\n---\n\n# Interface: GeminiGenerateContentResponse\n\nDefined in: [src/batteries/generation/gemini/types.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L143)\n\nThe relevant subset of the `/models/{model}:generateContent` JSON response shape.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `candidates?` | { `content?`: { `parts?`: [`GeminiResponsePart`](../type-aliases/GeminiResponsePart.md)\\[]; }; }\\[] | Generated candidates, each carrying its own content parts. | [src/batteries/generation/gemini/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L145) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateOptions","title":"Interface: GeminiGenerateOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerateOptions.md\ndescription: >-\n Per-call options accepted by {@link\n @nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter.generate}.\n---\n\n# Interface: GeminiGenerateOptions\n\nDefined in: [src/batteries/generation/gemini/types.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L76)\n\nPer-call options accepted by [@nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter.generate](../../adapter/classes/GeminiGenerationAdapter.md#generate).\n\n## Extends\n\n* [`GenerateOptions`](../../../openai/types/interfaces/GenerateOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------ | -------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `aspectRatio?` | `string` | Aspect ratio (e.g. `'16:9'`). Falls back to the adapter's configured default. | - | [src/batteries/generation/gemini/types.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L78) |\n| `n?` | `number` | Number of images to generate. Engine-defaulted when omitted. | [`GenerateOptions`](../../../openai/types/interfaces/GenerateOptions.md).[`n`](../../../openai/types/interfaces/GenerateOptions.md#property-n) | [src/batteries/generation/openai/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L47) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationAdapterOptions","title":"Interface: GeminiGenerationAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationAdapterOptions.md\ndescription: >-\n Constructor options for {@link\n @nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter}.\n---\n\n# Interface: GeminiGenerationAdapterOptions\n\nDefined in: [src/batteries/generation/gemini/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L48)\n\nConstructor options for [@nhtio/adk/batteries/generation/gemini/adapter!GeminiGenerationAdapter](../../adapter/classes/GeminiGenerationAdapter.md).\n\n## Remarks\n\nExtends [BaseGenerationAdapterOptions](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md) with the HTTP transport fields plus Gemini's\n`generateContent` knobs. Targets the native `generativelanguage.googleapis.com` REST surface\ndirectly over raw `fetch` — no `@google/genai` SDK dependency.\n\n## Extends\n\n* [`BaseGenerationAdapterOptions`](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | API key. Sent as `x-goog-api-key: ` unless overridden by `headers`. | - | [src/batteries/generation/gemini/types.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L50) |\n| `aspectRatio?` | `string` | Default aspect ratio (e.g. `'16:9'`), applied when a call omits its own `aspectRatio`. | - | [src/batteries/generation/gemini/types.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L70) |\n| `baseURL?` | `string` | API base URL. Default `https://generativelanguage.googleapis.com/v1beta`. A trailing slash is trimmed. | - | [src/batteries/generation/gemini/types.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L55) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Custom `fetch` implementation. Default `globalThis.fetch`. | - | [src/batteries/generation/gemini/types.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L59) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Extra request headers. Override built defaults (including `x-goog-api-key`) key-by-key. | - | [src/batteries/generation/gemini/types.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L57) |\n| `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.20260921.0/src/src/batteries/generation/openai/types.ts#L71) |\n| `requestTimeoutMs?` | `number` | Per-request handshake timeout in ms. `0`/unset disables the timeout. | - | [src/batteries/generation/gemini/types.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L63) |\n| `responseModalities?` | [`GeminiResponseModality`](../type-aliases/GeminiResponseModality.md)\\[] | Response modalities requested from `generateContent`. Default `['TEXT', 'IMAGE']` — probe- confirmed as the shape that reliably yields an `inlineData` image part. | - | [src/batteries/generation/gemini/types.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L68) |\n| `retry?` | [`GenerationRetryConfig`](../../../openai/types/interfaces/GenerationRetryConfig.md) | Retry/backoff configuration. Default: a single attempt (no retry). | - | [src/batteries/generation/gemini/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L61) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationConfig","title":"Interface: GeminiGenerationConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/interfaces/GeminiGenerationConfig.md\ndescription: The `generationConfig` block of a `generateContent` request.\n---\n\n# Interface: GeminiGenerationConfig\n\nDefined in: [src/batteries/generation/gemini/types.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L111)\n\nThe `generationConfig` block of a `generateContent` request.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `candidateCount?` | `number` | Best-effort requested candidate count — some models ignore this. | [src/batteries/generation/gemini/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L115) |\n| `imageConfig?` | { `aspectRatio?`: `string`; } | Image-specific generation knobs. | [src/batteries/generation/gemini/types.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L117) |\n| `imageConfig.aspectRatio?` | `string` | - | [src/batteries/generation/gemini/types.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L117) |\n| `responseModalities?` | [`GeminiResponseModality`](../type-aliases/GeminiResponseModality.md)\\[] | Requested response modalities. | [src/batteries/generation/gemini/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L113) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiRequestPart","title":"Type Alias: GeminiRequestPart","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiRequestPart.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiRequestPart","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiRequestPart.md\ndescription: >-\n A single content part in a Gemini `generateContent` request. Requests always\n send **camelCase** `inlineData` — probe-confirmed to be accepted whether the\n request is routed through the LB or hits Google directly.\n---\n\n# Type Alias: GeminiRequestPart\n\n```ts\ntype GeminiRequestPart =\n | {\n text: string;\n }\n | {\n inlineData: {\n data: string;\n mimeType: string;\n };\n };\n```\n\nDefined in: [src/batteries/generation/gemini/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L94)\n\nA single content part in a Gemini `generateContent` request. Requests always send **camelCase**\n`inlineData` — probe-confirmed to be accepted whether the request is routed through the LB or\nhits Google directly.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponseModality","title":"Type Alias: GeminiResponseModality","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponseModality.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponseModality","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponseModality.md\ndescription: >-\n The response modalities Gemini is asked to return. `'IMAGE'` is what actually\n yields generated media; `'TEXT'` is included by default alongside it so\n refusal/safety text (when present) arrives in the same response instead of a\n separate call.\n---\n\n# Type Alias: GeminiResponseModality\n\n```ts\ntype GeminiResponseModality = \"TEXT\" | \"IMAGE\";\n```\n\nDefined in: [src/batteries/generation/gemini/types.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L38)\n\nThe response modalities Gemini is asked to return. `'IMAGE'` is what actually yields generated\nmedia; `'TEXT'` is included by default alongside it so refusal/safety text (when present)\narrives in the same response instead of a separate call.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponsePart","title":"Type Alias: GeminiResponsePart","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponsePart.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponsePart","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/types/type-aliases/GeminiResponsePart.md\ndescription: >-\n A single content part in a Gemini `generateContent` **response**. Tolerates\n both the canonical camelCase `inlineData` and a defensive snake_case\n `inline_data` — response-only tolerance; this battery's requests always send\n camelCase.\n---\n\n# Type Alias: GeminiResponsePart\n\n```ts\ntype GeminiResponsePart =\n | {\n text: string;\n }\n | {\n inlineData: {\n data: string;\n mimeType?: string;\n };\n }\n | {\n inline_data: {\n data: string;\n mimeType?: string;\n };\n };\n```\n\nDefined in: [src/batteries/generation/gemini/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/types.ts#L135)\n\nA single content part in a Gemini `generateContent` **response**. Tolerates both the canonical\ncamelCase `inlineData` and a defensive snake\\_case `inline_data` — response-only tolerance; this\nbattery's requests always send camelCase.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation","title":"@nhtio/adk/batteries/generation/gemini/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/validation.md'\ndescription: >-\n Runtime validation schema and wrapper for Gemini media generation adapter\n options.\n---\n\n# @nhtio/adk/batteries/generation/gemini/validation\n\nRuntime validation schema and wrapper for Gemini media generation adapter options.\n\n## Remarks\n\nValidates `GeminiGenerationAdapterOptions` at construction time. Throws\n`E_INVALID_GEMINI_GENERATION_OPTIONS` on failure — the same hard-fail policy as every other ADK\ncontract. `model` is required; unknown top-level keys are rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| [geminiGenerationOptionsSchema](variables/geminiGenerationOptionsSchema.md) | Validator schema for `GeminiGenerationAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `geminiGenerationOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_GEMINI_GENERATION_OPTIONS` (carrying the validator's report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): GeminiGenerationAdapterOptions;\n```\n\nDefined in: [src/batteries/generation/gemini/validation.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/validation.ts#L64)\n\nValidates an arbitrary input against `geminiGenerationOptionsSchema` and returns the resolved\noptions shape. Throws `E_INVALID_GEMINI_GENERATION_OPTIONS` (carrying the validator's report on\n`cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`GeminiGenerationAdapterOptions`](../../types/interfaces/GeminiGenerationAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation/variables/geminiGenerationOptionsSchema","title":"Variable: geminiGenerationOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation/variables/geminiGenerationOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/gemini/validation/variables/geminiGenerationOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/gemini/validation/variables/geminiGenerationOptionsSchema.md\ndescription: >-\n Validator schema for `GeminiGenerationAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: geminiGenerationOptionsSchema\n\n```ts\nconst geminiGenerationOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/generation/gemini/validation.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/gemini/validation.ts#L33)\n\nValidator schema for `GeminiGenerationAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/adapter","title":"@nhtio/adk/batteries/generation/local\\_diffusion/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/adapter.md\ndescription: Node-only local diffusion generation adapter.\n---\n\n# @nhtio/adk/batteries/generation/local\\_diffusion/adapter\n\nNode-only local diffusion generation adapter.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------------------------- | ------------------------------------------------------------- |\n| [LocalDiffusionGenerationAdapter](classes/LocalDiffusionGenerationAdapter.md) | Local diffusion adapter backed by a line-protocol subprocess. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/adapter/classes/LocalDiffusionGenerationAdapter","title":"Class: LocalDiffusionGenerationAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/adapter/classes/LocalDiffusionGenerationAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/adapter/classes/LocalDiffusionGenerationAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/adapter/classes/LocalDiffusionGenerationAdapter.md\ndescription: Local diffusion adapter backed by a line-protocol subprocess.\n---\n\n# Class: LocalDiffusionGenerationAdapter\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L92)\n\nLocal diffusion adapter backed by a line-protocol subprocess.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew LocalDiffusionGenerationAdapter(options: unknown): LocalDiffusionGenerationAdapter;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L114)\n\nConstruct and validate an adapter.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `options` | `unknown` |\n\n#### Returns\n\n`LocalDiffusionGenerationAdapter`\n\n## Methods\n\n### \\[asyncDispose]\\()\n\n```ts\nasyncDispose: Promise;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L183)\n\nAsync-disposal protocol alias.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L150)\n\nGracefully stop the backend, then force terminate it. Terminal and idempotent.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### edit()\n\n```ts\nedit(\n inputs:\n | GenerationImageInput\n | GenerationImageInput[],\n prompt: string,\nopts?: LocalDiffusionCallOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L196)\n\nEdit images with text guidance.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `inputs` | | [`GenerationImageInput`](../../../_shared/type-aliases/GenerationImageInput.md) | [`GenerationImageInput`](../../../_shared/type-aliases/GenerationImageInput.md)\\[] |\n| `prompt` | `string` |\n| `opts?` | [`LocalDiffusionCallOptions`](../../types/interfaces/LocalDiffusionCallOptions.md) |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\n***\n\n### generate()\n\n```ts\ngenerate(prompt: string, opts?: LocalDiffusionCallOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L188)\n\nGenerate images from text.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------------------------------------------------------------------------------- |\n| `prompt` | `string` |\n| `opts?` | [`LocalDiffusionCallOptions`](../../types/interfaces/LocalDiffusionCallOptions.md) |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L119)\n\nWhether this instance can run, honoring its injected probe.\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L124)\n\nStart the backend and wait for its ready event.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L143)\n\nSynchronously terminate the current process and invalidate all continuations.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/adapter.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/adapter.ts#L109)\n\nWhether the current host exposes Node's process runtime.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions","title":"@nhtio/adk/batteries/generation/local\\_diffusion/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions.md\ndescription: Local diffusion battery exceptions.\n---\n\n# @nhtio/adk/batteries/generation/local\\_diffusion/exceptions\n\nLocal diffusion battery exceptions.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| [E\\_INVALID\\_LOCAL\\_DIFFUSION\\_OPTIONS](variables/E_INVALID_LOCAL_DIFFUSION_OPTIONS.md) | Invalid adapter configuration. |\n| [E\\_LOCAL\\_DIFFUSION\\_ABORTED](variables/E_LOCAL_DIFFUSION_ABORTED.md) | Request was cancelled. |\n| [E\\_LOCAL\\_DIFFUSION\\_BACKEND\\_ERROR](variables/E_LOCAL_DIFFUSION_BACKEND_ERROR.md) | Backend process failure. Optional printf args: `[detail, exitCode?, signal?]`. |\n| [E\\_LOCAL\\_DIFFUSION\\_BUSY](variables/E_LOCAL_DIFFUSION_BUSY.md) | Another request is active. |\n| [E\\_LOCAL\\_DIFFUSION\\_DISPOSED](variables/E_LOCAL_DIFFUSION_DISPOSED.md) | Adapter has been disposed. |\n| [E\\_LOCAL\\_DIFFUSION\\_MALFORMED\\_FRAME](variables/E_LOCAL_DIFFUSION_MALFORMED_FRAME.md) | Backend emitted malformed protocol data. |\n| [E\\_LOCAL\\_DIFFUSION\\_REQUEST\\_TIMEOUT](variables/E_LOCAL_DIFFUSION_REQUEST_TIMEOUT.md) | Request exceeded its deadline. |\n| [E\\_LOCAL\\_DIFFUSION\\_STARTUP\\_TIMEOUT](variables/E_LOCAL_DIFFUSION_STARTUP_TIMEOUT.md) | Startup exceeded its deadline. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_INVALID_LOCAL_DIFFUSION_OPTIONS","title":"Variable: E\\_INVALID\\_LOCAL\\_DIFFUSION\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_INVALID_LOCAL_DIFFUSION_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_INVALID_LOCAL_DIFFUSION_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_INVALID_LOCAL_DIFFUSION_OPTIONS.md\ndescription: Invalid adapter configuration.\n---\n\n# Variable: E\\_INVALID\\_LOCAL\\_DIFFUSION\\_OPTIONS\n\n```ts\nconst E_INVALID_LOCAL_DIFFUSION_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:7](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L7)\n\nInvalid adapter configuration.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_ABORTED","title":"Variable: E\\_LOCAL\\_DIFFUSION\\_ABORTED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_ABORTED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_ABORTED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_ABORTED.md\ndescription: Request was cancelled.\n---\n\n# Variable: E\\_LOCAL\\_DIFFUSION\\_ABORTED\n\n```ts\nconst E_LOCAL_DIFFUSION_ABORTED: CreatedException<[]>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L39)\n\nRequest was cancelled.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BACKEND_ERROR","title":"Variable: E\\_LOCAL\\_DIFFUSION\\_BACKEND\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BACKEND_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BACKEND_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BACKEND_ERROR.md\ndescription: 'Backend process failure. Optional printf args: `[detail, exitCode?, signal?]`.'\n---\n\n# Variable: E\\_LOCAL\\_DIFFUSION\\_BACKEND\\_ERROR\n\n```ts\nconst E_LOCAL_DIFFUSION_BACKEND_ERROR: CreatedException<\n [string, number?, string?]\n>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:15](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L15)\n\nBackend process failure. Optional printf args: `[detail, exitCode?, signal?]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BUSY","title":"Variable: E\\_LOCAL\\_DIFFUSION\\_BUSY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BUSY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BUSY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_BUSY.md\ndescription: Another request is active.\n---\n\n# Variable: E\\_LOCAL\\_DIFFUSION\\_BUSY\n\n```ts\nconst E_LOCAL_DIFFUSION_BUSY: CreatedException<[]>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L55)\n\nAnother request is active.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_DISPOSED","title":"Variable: E\\_LOCAL\\_DIFFUSION\\_DISPOSED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_DISPOSED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_DISPOSED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_DISPOSED.md\ndescription: Adapter has been disposed.\n---\n\n# Variable: E\\_LOCAL\\_DIFFUSION\\_DISPOSED\n\n```ts\nconst E_LOCAL_DIFFUSION_DISPOSED: CreatedException<[]>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L63)\n\nAdapter has been disposed.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_MALFORMED_FRAME","title":"Variable: E\\_LOCAL\\_DIFFUSION\\_MALFORMED\\_FRAME","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_MALFORMED_FRAME.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_MALFORMED_FRAME","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_MALFORMED_FRAME.md\ndescription: Backend emitted malformed protocol data.\n---\n\n# Variable: E\\_LOCAL\\_DIFFUSION\\_MALFORMED\\_FRAME\n\n```ts\nconst E_LOCAL_DIFFUSION_MALFORMED_FRAME: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L47)\n\nBackend emitted malformed protocol data.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_REQUEST_TIMEOUT","title":"Variable: E\\_LOCAL\\_DIFFUSION\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_REQUEST_TIMEOUT.md\ndescription: Request exceeded its deadline.\n---\n\n# Variable: E\\_LOCAL\\_DIFFUSION\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_LOCAL_DIFFUSION_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L31)\n\nRequest exceeded its deadline.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_STARTUP_TIMEOUT","title":"Variable: E\\_LOCAL\\_DIFFUSION\\_STARTUP\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_STARTUP_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_STARTUP_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/exceptions/variables/E_LOCAL_DIFFUSION_STARTUP_TIMEOUT.md\ndescription: Startup exceeded its deadline.\n---\n\n# Variable: E\\_LOCAL\\_DIFFUSION\\_STARTUP\\_TIMEOUT\n\n```ts\nconst E_LOCAL_DIFFUSION_STARTUP_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/exceptions.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/exceptions.ts#L23)\n\nStartup exceeded its deadline.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol","title":"@nhtio/adk/batteries/generation/local\\_diffusion/protocol","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol.md\ndescription: >-\n Pure protocol constants, frame parsing, and byte-safe line framing for local\n diffusion backends.\n---\n\n# @nhtio/adk/batteries/generation/local\\_diffusion/protocol\n\nPure protocol constants, frame parsing, and byte-safe line framing for local diffusion backends.\n\n## Remarks\n\nThe line framer is **byte-oriented**: it retains raw bytes (never a decoded string), enforces the\n`maxLineBytes` cap while consuming input (so an unbounded no-newline write cannot balloon memory),\ndiscards the remainder of an over-sized physical line up to its next newline before resuming, and\ndecodes each bounded, complete line with a fatal UTF-8 decoder (invalid encoding → a `malformed`\nframe, never a silent mis-parse). [parseFrame](functions/parseFrame.md) is total — it classifies every line as a typed\nframe and never throws.\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------- | ------------------------------------------------------------------------ |\n| [DoneFrame](type-aliases/DoneFrame.md) | A parsed request completion frame. |\n| [ErrorFrame](type-aliases/ErrorFrame.md) | A parsed request error frame. |\n| [ImageFrame](type-aliases/ImageFrame.md) | A parsed image result frame. |\n| [MalformedFrame](type-aliases/MalformedFrame.md) | A prefix-matched frame whose fields or JSON do not satisfy the protocol. |\n| [ModelLoadFrame](type-aliases/ModelLoadFrame.md) | A parsed startup model-loading progress frame. |\n| [ParsedFrame](type-aliases/ParsedFrame.md) | The total, discriminated result of parsing one backend stdout line. |\n| [ProgressFrame](type-aliases/ProgressFrame.md) | A parsed request progress frame. |\n| [ProtocolConfig](type-aliases/ProtocolConfig.md) | The configurable wire tags used by a local diffusion backend. |\n| [ProtocolErrorFrame](type-aliases/ProtocolErrorFrame.md) | A stream-level protocol problem, such as an over-sized line. |\n| [ReadyFrame](type-aliases/ReadyFrame.md) | A parsed backend-ready frame. |\n| [UnknownFrame](type-aliases/UnknownFrame.md) | A frame with a tag this protocol version does not understand. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------- | --------------------------------------------------------------------------- |\n| [DEFAULT\\_PROTOCOL](variables/DEFAULT_PROTOCOL.md) | The DiffusionBee-compatible default local diffusion protocol configuration. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [buildEditCommand](functions/buildEditCommand.md) | Build an edit command frame, including its terminating newline. |\n| [buildGenerateCommand](functions/buildGenerateCommand.md) | Build a generate command frame, including its terminating newline. |\n| [buildShutdownCommand](functions/buildShutdownCommand.md) | Build a backend shutdown command frame, including its terminating newline. |\n| [buildStopCommand](functions/buildStopCommand.md) | Build a best-effort stop command frame, including its terminating newline. |\n| [createFrameReader](functions/createFrameReader.md) | Create an incremental, **byte-oriented** line reader. Raw bytes are retained (never a decoded string), the `maxLineBytes` cap is enforced while consuming so an unbounded no-newline write cannot balloon memory, an over-sized physical line reports exactly one `protocolError` and is then discarded through its next newline (its continuation is NOT re-parsed as a fresh frame), and each bounded, complete line is decoded with a fatal UTF-8 decoder — invalid encoding yields a `malformed` frame. Malformed protocol lines are reported as `malformed` rather than thrown. |\n| [parseFrame](functions/parseFrame.md) | Parse one already-split backend stdout line into a typed [ParsedFrame](type-aliases/ParsedFrame.md). Total by contract — it never throws: malformed input yields a `malformed`/`unknown` frame, and a runtime-invalid or hostile `config` (null, partial, or a throwing accessor) is caught and reported as `malformed`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildEditCommand","title":"Function: buildEditCommand()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildEditCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildEditCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildEditCommand.md\n---\n\n# Function: buildEditCommand()\n\n```ts\nfunction buildEditCommand(\n rid: number,\n args: Record,\n config?: ProtocolConfig,\n): string;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L329)\n\nBuild an edit command frame, including its terminating newline.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | ------------------------------------------------------------------------------------------------------------------ | ------------------ |\n| `rid` | `number` | `undefined` |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | `undefined` |\n| `config` | [`ProtocolConfig`](../type-aliases/ProtocolConfig.md) | `DEFAULT_PROTOCOL` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildGenerateCommand","title":"Function: buildGenerateCommand()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildGenerateCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildGenerateCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildGenerateCommand.md\n---\n\n# Function: buildGenerateCommand()\n\n```ts\nfunction buildGenerateCommand(\n rid: number,\n args: Record,\n config?: ProtocolConfig,\n): string;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L320)\n\nBuild a generate command frame, including its terminating newline.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | ------------------------------------------------------------------------------------------------------------------ | ------------------ |\n| `rid` | `number` | `undefined` |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | `undefined` |\n| `config` | [`ProtocolConfig`](../type-aliases/ProtocolConfig.md) | `DEFAULT_PROTOCOL` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildShutdownCommand","title":"Function: buildShutdownCommand()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildShutdownCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildShutdownCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildShutdownCommand.md\n---\n\n# Function: buildShutdownCommand()\n\n```ts\nfunction buildShutdownCommand(config?: ProtocolConfig): string;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:346](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L346)\n\nBuild a backend shutdown command frame, including its terminating newline.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | ----------------------------------------------------- | ------------------ |\n| `config` | [`ProtocolConfig`](../type-aliases/ProtocolConfig.md) | `DEFAULT_PROTOCOL` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildStopCommand","title":"Function: buildStopCommand()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildStopCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildStopCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/buildStopCommand.md\n---\n\n# Function: buildStopCommand()\n\n```ts\nfunction buildStopCommand(rid: number, config?: ProtocolConfig): string;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:338](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L338)\n\nBuild a best-effort stop command frame, including its terminating newline.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | ----------------------------------------------------- | ------------------ |\n| `rid` | `number` | `undefined` |\n| `config` | [`ProtocolConfig`](../type-aliases/ProtocolConfig.md) | `DEFAULT_PROTOCOL` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/createFrameReader","title":"Function: createFrameReader()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/createFrameReader.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/createFrameReader","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/createFrameReader.md\n---\n\n# Function: createFrameReader()\n\n```ts\nfunction createFrameReader(opts: {\n config?: ProtocolConfig;\n maxLineBytes?: number;\n onFrame: void;\n}): {\n end: void;\n push: void;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L367)\n\nCreate an incremental, **byte-oriented** line reader. Raw bytes are retained (never a decoded\nstring), the `maxLineBytes` cap is enforced while consuming so an unbounded no-newline write cannot\nballoon memory, an over-sized physical line reports exactly one `protocolError` and is then discarded\nthrough its next newline (its continuation is NOT re-parsed as a fresh frame), and each bounded,\ncomplete line is decoded with a fatal UTF-8 decoder — invalid encoding yields a `malformed` frame.\nMalformed protocol lines are reported as `malformed` rather than thrown.\n\nPending bytes of an in-progress line are held as a queue of chunk SEGMENTS with a running byte\ncount, and concatenated exactly once when the line's terminator arrives — so many small fragments of\none line cost O(line length) total, not O(line length²) (terra v2 #4).\n\n## Parameters\n\n| Parameter | Type |\n| -------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `opts` | { `config?`: [`ProtocolConfig`](../type-aliases/ProtocolConfig.md); `maxLineBytes?`: `number`; `onFrame`: `void`; } |\n| `opts.config?` | [`ProtocolConfig`](../type-aliases/ProtocolConfig.md) |\n| `opts.maxLineBytes?` | `number` |\n| `opts.onFrame` |\n\n## Returns\n\n```ts\n{\n end: void;\n push: void;\n}\n```\n\n| Name | Type | Defined in |\n| -------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `end()` | () => `void` | [src/batteries/generation/local\\_diffusion/protocol.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L371) |\n| `push()` | (`chunk`: `Uint8Array`) => `void` | [src/batteries/generation/local\\_diffusion/protocol.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L371) |\n\n## Throws\n\nRangeError if `maxLineBytes` is provided but is not a positive, finite, safe integer — an\nunvalidated `Infinity`/`NaN`/negative would silently defeat the bounded-memory guarantee (terra v2 #3).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/parseFrame","title":"Function: parseFrame()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/parseFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/parseFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/functions/parseFrame.md\n---\n\n# Function: parseFrame()\n\n```ts\nfunction parseFrame(line: string, config?: ProtocolConfig): ParsedFrame;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:220](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L220)\n\nParse one already-split backend stdout line into a typed [ParsedFrame](../type-aliases/ParsedFrame.md). Total by contract —\nit never throws: malformed input yields a `malformed`/`unknown` frame, and a runtime-invalid or\nhostile `config` (null, partial, or a throwing accessor) is caught and reported as `malformed`.\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | ----------------------------------------------------- | ------------------ | --------------------------------------------------------------------------------------------- |\n| `line` | `string` | `undefined` | One already-newline-split backend stdout line. |\n| `config` | [`ProtocolConfig`](../type-aliases/ProtocolConfig.md) | `DEFAULT_PROTOCOL` | Protocol tag configuration; defaults to [DEFAULT\\_PROTOCOL](../variables/DEFAULT_PROTOCOL.md). |\n\n## Returns\n\n[`ParsedFrame`](../type-aliases/ParsedFrame.md)\n\nThe discriminated parse result.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/DoneFrame","title":"Type Alias: DoneFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/DoneFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/DoneFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/DoneFrame.md\ndescription: A parsed request completion frame.\n---\n\n# Type Alias: DoneFrame\n\n```ts\ntype DoneFrame = {\n kind: \"done\";\n rid: number;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L108)\n\nA parsed request completion frame.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `\"done\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L110) |\n| `rid` | `number` | The request id that completed. | [src/batteries/generation/local\\_diffusion/protocol.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L112) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ErrorFrame","title":"Type Alias: ErrorFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ErrorFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ErrorFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ErrorFrame.md\ndescription: A parsed request error frame.\n---\n\n# Type Alias: ErrorFrame\n\n```ts\ntype ErrorFrame = {\n kind: \"error\";\n message: string;\n rid: number;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L115)\n\nA parsed request error frame.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `\"error\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L117) |\n| `message` | `string` | The backend-reported error message. | [src/batteries/generation/local\\_diffusion/protocol.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L121) |\n| `rid` | `number` | The request id that errored. | [src/batteries/generation/local\\_diffusion/protocol.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L119) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ImageFrame","title":"Type Alias: ImageFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ImageFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ImageFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ImageFrame.md\ndescription: A parsed image result frame.\n---\n\n# Type Alias: ImageFrame\n\n```ts\ntype ImageFrame = {\n kind: \"image\";\n payload: {\n b64?: string;\n mimeType: string;\n path?: string;\n };\n rid: number;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L92)\n\nA parsed image result frame.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `\"image\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L94) |\n| `payload` | { `b64?`: `string`; `mimeType`: `string`; `path?`: `string`; } | The image payload: either an inline base64 blob or a backend-written file path, plus its MIME. | [src/batteries/generation/local\\_diffusion/protocol.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L98) |\n| `payload.b64?` | `string` | Inline base64-encoded image bytes (mutually exclusive with `path`). | [src/batteries/generation/local\\_diffusion/protocol.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L102) |\n| `payload.mimeType` | `string` | Concrete image MIME type, e.g. `image/png`. | [src/batteries/generation/local\\_diffusion/protocol.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L104) |\n| `payload.path?` | `string` | Backend-written output file path (mutually exclusive with `b64`). | [src/batteries/generation/local\\_diffusion/protocol.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L100) |\n| `rid` | `number` | The request id this image belongs to. | [src/batteries/generation/local\\_diffusion/protocol.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L96) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/MalformedFrame","title":"Type Alias: MalformedFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/MalformedFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/MalformedFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/MalformedFrame.md\ndescription: A prefix-matched frame whose fields or JSON do not satisfy the protocol.\n---\n\n# Type Alias: MalformedFrame\n\n```ts\ntype MalformedFrame = {\n detail: string;\n kind: \"malformed\";\n raw: string;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L131)\n\nA prefix-matched frame whose fields or JSON do not satisfy the protocol.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | ------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `detail` | `string` | Why the line was rejected. | [src/batteries/generation/local\\_diffusion/protocol.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L137) |\n| `kind` | `\"malformed\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L133) |\n| `raw` | `string` | The original line that failed validation (best-effort, lossy decode for invalid UTF-8). | [src/batteries/generation/local\\_diffusion/protocol.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L135) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ModelLoadFrame","title":"Type Alias: ModelLoadFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ModelLoadFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ModelLoadFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ModelLoadFrame.md\ndescription: A parsed startup model-loading progress frame.\n---\n\n# Type Alias: ModelLoadFrame\n\n```ts\ntype ModelLoadFrame = {\n kind: \"modelLoad\";\n progress: number;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L71)\n\nA parsed startup model-loading progress frame.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `\"modelLoad\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L73) |\n| `progress` | `number` | Normalized model-load progress in `0..1`. | [src/batteries/generation/local\\_diffusion/protocol.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L75) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ParsedFrame","title":"Type Alias: ParsedFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ParsedFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ParsedFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ParsedFrame.md\ndescription: 'The total, discriminated result of parsing one backend stdout line.'\n---\n\n# Type Alias: ParsedFrame\n\n```ts\ntype ParsedFrame =\n | ModelLoadFrame\n | ReadyFrame\n | ProgressFrame\n | ImageFrame\n | DoneFrame\n | ErrorFrame\n | UnknownFrame\n | MalformedFrame\n | ProtocolErrorFrame;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L148)\n\nThe total, discriminated result of parsing one backend stdout line.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProgressFrame","title":"Type Alias: ProgressFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProgressFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProgressFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProgressFrame.md\ndescription: A parsed request progress frame.\n---\n\n# Type Alias: ProgressFrame\n\n```ts\ntype ProgressFrame = {\n kind: \"progress\";\n progress: number;\n rid: number;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L83)\n\nA parsed request progress frame.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------ | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `\"progress\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L85) |\n| `progress` | `number` | Normalized per-step generation progress in `0..1`. | [src/batteries/generation/local\\_diffusion/protocol.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L89) |\n| `rid` | `number` | The request id this progress belongs to. | [src/batteries/generation/local\\_diffusion/protocol.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L87) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolConfig","title":"Type Alias: ProtocolConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolConfig.md\ndescription: The configurable wire tags used by a local diffusion backend.\n---\n\n# Type Alias: ProtocolConfig\n\n```ts\ntype ProtocolConfig = {\n commandPrefix: string;\n control: {\n shutdown: string;\n stop: string;\n };\n eventPrefix: string;\n events: {\n done: string;\n error: string;\n image: string;\n modelLoad: string;\n progress: string;\n ready: string;\n };\n ops: {\n edit: string;\n generate: string;\n };\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L18)\n\nThe configurable wire tags used by a local diffusion backend.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `commandPrefix` | `string` | Leading tag on every host→backend command line (DiffusionBee: `b2py`). | [src/batteries/generation/local\\_diffusion/protocol.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L20) |\n| `control` | { `shutdown`: `string`; `stop`: `string`; } | Control-command sub-tags (no request payload). | [src/batteries/generation/local\\_diffusion/protocol.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L31) |\n| `control.shutdown` | `string` | Graceful backend shutdown request (DiffusionBee: `__shutdown__`). | [src/batteries/generation/local\\_diffusion/protocol.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L35) |\n| `control.stop` | `string` | Advisory cancel of the current request (DiffusionBee: `__stop__`). | [src/batteries/generation/local\\_diffusion/protocol.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L33) |\n| `eventPrefix` | `string` | Leading tag on every backend→host event line (DiffusionBee: `sdbk`). | [src/batteries/generation/local\\_diffusion/protocol.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L22) |\n| `events` | { `done`: `string`; `error`: `string`; `image`: `string`; `modelLoad`: `string`; `progress`: `string`; `ready`: `string`; } | Backend→host event sub-tags. | [src/batteries/generation/local\\_diffusion/protocol.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L38) |\n| `events.done` | `string` | Request-complete terminal event (DiffusionBee: `done`). | [src/batteries/generation/local\\_diffusion/protocol.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L48) |\n| `events.error` | `string` | Request-error terminal event (DiffusionBee: `err`). | [src/batteries/generation/local\\_diffusion/protocol.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L50) |\n| `events.image` | `string` | One finished image result event (DiffusionBee: `nwim`). | [src/batteries/generation/local\\_diffusion/protocol.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L46) |\n| `events.modelLoad` | `string` | Startup model-load progress event (DiffusionBee: `mdld`). | [src/batteries/generation/local\\_diffusion/protocol.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L40) |\n| `events.progress` | `string` | Per-step generation progress event (DiffusionBee: `dnpr`). | [src/batteries/generation/local\\_diffusion/protocol.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L44) |\n| `events.ready` | `string` | Backend-ready event that resolves preload (DiffusionBee: `rdy`). | [src/batteries/generation/local\\_diffusion/protocol.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L42) |\n| `ops` | { `edit`: `string`; `generate`: `string`; } | Operation sub-tags for the two request commands. | [src/batteries/generation/local\\_diffusion/protocol.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L24) |\n| `ops.edit` | `string` | image+text→image edit op sub-tag (DiffusionBee: `im2im`). | [src/batteries/generation/local\\_diffusion/protocol.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L28) |\n| `ops.generate` | `string` | text→image generate op sub-tag (DiffusionBee: `t2im`). | [src/batteries/generation/local\\_diffusion/protocol.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L26) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolErrorFrame","title":"Type Alias: ProtocolErrorFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolErrorFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolErrorFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolErrorFrame.md\ndescription: 'A stream-level protocol problem, such as an over-sized line.'\n---\n\n# Type Alias: ProtocolErrorFrame\n\n```ts\ntype ProtocolErrorFrame = {\n detail: string;\n kind: \"protocolError\";\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L140)\n\nA stream-level protocol problem, such as an over-sized line.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | ----------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `detail` | `string` | Why the stream framing failed. | [src/batteries/generation/local\\_diffusion/protocol.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L144) |\n| `kind` | `\"protocolError\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L142) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ReadyFrame","title":"Type Alias: ReadyFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ReadyFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ReadyFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ReadyFrame.md\ndescription: A parsed backend-ready frame.\n---\n\n# Type Alias: ReadyFrame\n\n```ts\ntype ReadyFrame = {\n kind: \"ready\";\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L78)\n\nA parsed backend-ready frame.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | --------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `\"ready\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L80) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/UnknownFrame","title":"Type Alias: UnknownFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/UnknownFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/UnknownFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/UnknownFrame.md\ndescription: A frame with a tag this protocol version does not understand.\n---\n\n# Type Alias: UnknownFrame\n\n```ts\ntype UnknownFrame = {\n kind: \"unknown\";\n raw: string;\n};\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L124)\n\nA frame with a tag this protocol version does not understand.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ----------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `\"unknown\"` | Discriminant. | [src/batteries/generation/local\\_diffusion/protocol.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L126) |\n| `raw` | `string` | The original, unrecognized line. | [src/batteries/generation/local\\_diffusion/protocol.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L128) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/variables/DEFAULT_PROTOCOL","title":"Variable: DEFAULT\\_PROTOCOL","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/variables/DEFAULT_PROTOCOL.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/variables/DEFAULT_PROTOCOL","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/variables/DEFAULT_PROTOCOL.md\ndescription: The DiffusionBee-compatible default local diffusion protocol configuration.\n---\n\n# Variable: DEFAULT\\_PROTOCOL\n\n```ts\nconst DEFAULT_PROTOCOL: ProtocolConfig;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/protocol.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/protocol.ts#L55)\n\nThe DiffusionBee-compatible default local diffusion protocol configuration.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types","title":"@nhtio/adk/batteries/generation/local\\_diffusion/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/types.md\ndescription: Node-only option and process contracts for local diffusion generation.\n---\n\n# @nhtio/adk/batteries/generation/local\\_diffusion/types\n\nNode-only option and process contracts for local diffusion generation.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |\n| [DiffusionBackendProcess](interfaces/DiffusionBackendProcess.md) | The observable child-process surface required by the adapter. |\n| [DiffusionFsLike](interfaces/DiffusionFsLike.md) | Injectable filesystem operations used for backend-written images. |\n| [LocalDiffusionCallOptions](interfaces/LocalDiffusionCallOptions.md) | Per-call local diffusion controls. |\n| [LocalDiffusionGenerationAdapterOptions](interfaces/LocalDiffusionGenerationAdapterOptions.md) | Constructor options for LocalDiffusionGenerationAdapter. |\n| [ReadableLike](interfaces/ReadableLike.md) | A readable stream surface used by a diffusion backend. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------------ | ---------------------------------------------- |\n| [DiffusionBackendSpawner](type-aliases/DiffusionBackendSpawner.md) | Factory seam for starting one backend process. |\n\n## References\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../../interfaces/GeneratedMediaOutput.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionBackendProcess","title":"Interface: DiffusionBackendProcess","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionBackendProcess.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionBackendProcess","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionBackendProcess.md\ndescription: The observable child-process surface required by the adapter.\n---\n\n# Interface: DiffusionBackendProcess\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L28)\n\nThe observable child-process surface required by the adapter.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------- | ------------------------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `stderr?` | [`ReadableLike`](ReadableLike.md) | `null` | Diagnostic stderr, never parsed as protocol. | [src/batteries/generation/local\\_diffusion/types.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L34) |\n| `stdin` | | { `write`: `void`; } | `null` | Writable backend stdin, when available. | [src/batteries/generation/local\\_diffusion/types.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L30) |\n| `stdout` | [`ReadableLike`](ReadableLike.md) | `null` | Backend stdout, when available. | [src/batteries/generation/local\\_diffusion/types.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L32) |\n\n## Methods\n\n### kill()\n\n```ts\nkill(signal?: number | Signals): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L44)\n\nTerminate the backend.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------- |\n| `signal?` | `number` | `Signals` |\n\n#### Returns\n\n`void`\n\n***\n\n### off()\n\n```ts\noff(event: string, listener: (...args: any[]) => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L42)\n\nRemove a process listener.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------ |\n| `event` | `string` |\n| `listener` | (...`args`: `any`\\[]) => `void` |\n\n#### Returns\n\n`void`\n\n***\n\n### on()\n\n#### Call Signature\n\n```ts\non(event: \"error\", listener: (error: Error) => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L36)\n\nRegister a process listener.\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | ---------------------------- |\n| `event` | `\"error\"` |\n| `listener` | (`error`: `Error`) => `void` |\n\n##### Returns\n\n`void`\n\n#### Call Signature\n\n```ts\non(event: \"exit\", listener: (code: number | null, signal: Signals | null) => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L38)\n\nRegister an exit listener.\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | --------------------------------------------------------------------- |\n| `event` | `\"exit\"` |\n| `listener` | (`code`: `number` | `null`, `signal`: `Signals` | `null`) => `void` |\n\n##### Returns\n\n`void`\n\n#### Call Signature\n\n```ts\non(event: \"close\", listener: (code: number | null, signal: Signals | null) => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L40)\n\nRegister a close listener.\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | --------------------------------------------------------------------- |\n| `event` | `\"close\"` |\n| `listener` | (`code`: `number` | `null`, `signal`: `Signals` | `null`) => `void` |\n\n##### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionFsLike","title":"Interface: DiffusionFsLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionFsLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionFsLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/DiffusionFsLike.md\ndescription: Injectable filesystem operations used for backend-written images.\n---\n\n# Interface: DiffusionFsLike\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L58)\n\nInjectable filesystem operations used for backend-written images.\n\n## Methods\n\n### readFile()\n\n```ts\nreadFile(path: string): Promise>;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L60)\n\nRead an image before cleanup.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`Uint8Array`<`ArrayBufferLike`>>\n\n***\n\n### unlink()\n\n```ts\nunlink(path: string): Promise;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L62)\n\nRemove a backend-written image.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionCallOptions","title":"Interface: LocalDiffusionCallOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionCallOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionCallOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionCallOptions.md\ndescription: Per-call local diffusion controls.\n---\n\n# Interface: LocalDiffusionCallOptions\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L66)\n\nPer-call local diffusion controls.\n\n## Extends\n\n* [`GenerateOptions`](../../../openai/types/interfaces/GenerateOptions.md).[`EditOptions`](../../../openai/types/interfaces/EditOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------ | ------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cfgScale?` | `number` | Override classifier-free guidance scale. | - | [src/batteries/generation/local\\_diffusion/types.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L74) |\n| `height?` | `number` | Override output height. | - | [src/batteries/generation/local\\_diffusion/types.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L82) |\n| `n?` | `number` | Number of images to generate. Engine-defaulted when omitted. | [`GenerateOptions`](../../../openai/types/interfaces/GenerateOptions.md).[`n`](../../../openai/types/interfaces/GenerateOptions.md#property-n) | [src/batteries/generation/openai/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L47) |\n| `negativePrompt?` | `string` | Override negative prompt. | - | [src/batteries/generation/local\\_diffusion/types.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L70) |\n| `sampler?` | `string` | Override sampler. | - | [src/batteries/generation/local\\_diffusion/types.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L76) |\n| `seed?` | `number` | Override random seed. | - | [src/batteries/generation/local\\_diffusion/types.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L78) |\n| `signal?` | `AbortSignal` | Abort this request. | - | [src/batteries/generation/local\\_diffusion/types.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L68) |\n| `steps?` | `number` | Override denoising steps. | - | [src/batteries/generation/local\\_diffusion/types.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L72) |\n| `width?` | `number` | Override output width. | - | [src/batteries/generation/local\\_diffusion/types.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L80) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionGenerationAdapterOptions","title":"Interface: LocalDiffusionGenerationAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionGenerationAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionGenerationAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/LocalDiffusionGenerationAdapterOptions.md\ndescription: 'Constructor options for [`LocalDiffusionGenerationAdapter`](https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/adapter/classes/LocalDiffusionGenerationAdapter).'\n---\n\n# Interface: LocalDiffusionGenerationAdapterOptions\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L86)\n\nConstructor options for LocalDiffusionGenerationAdapter.\n\n## Extends\n\n* [`BaseGenerationAdapterOptions`](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md).[`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `abortGraceMs?` | `number` | Grace period after cancellation. | - | [src/batteries/generation/local\\_diffusion/types.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L119) |\n| `args?` | `string`\\[] | Backend arguments before the model context. | - | [src/batteries/generation/local\\_diffusion/types.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L91) |\n| `cfgScale?` | `number` | Default classifier-free guidance scale. | - | [src/batteries/generation/local\\_diffusion/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L127) |\n| `command` | `string` | Backend executable. | - | [src/batteries/generation/local\\_diffusion/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L89) |\n| `commandPrefix?` | `string` | Command prefix override. | - | [src/batteries/generation/local\\_diffusion/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L105) |\n| `control?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<{ `shutdown`: `string`; `stop`: `string`; }> | Control tag overrides. | - | [src/batteries/generation/local\\_diffusion/types.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L111) |\n| `disposeGraceMs?` | `number` | Grace period for graceful disposal. | - | [src/batteries/generation/local\\_diffusion/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L121) |\n| `eventPrefix?` | `string` | Event prefix override. | - | [src/batteries/generation/local\\_diffusion/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L107) |\n| `events?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<{ `done`: `string`; `error`: `string`; `image`: `string`; `modelLoad`: `string`; `progress`: `string`; `ready`: `string`; }> | Event tag overrides. | - | [src/batteries/generation/local\\_diffusion/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L113) |\n| `fs?` | [`DiffusionFsLike`](DiffusionFsLike.md) | Filesystem seam. | - | [src/batteries/generation/local\\_diffusion/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L95) |\n| `height?` | `number` | Default output height. | - | [src/batteries/generation/local\\_diffusion/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L135) |\n| `isAvailable?` | () => `boolean` | Runtime availability override. | - | [src/batteries/generation/local\\_diffusion/types.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L137) |\n| `maxDecodedBytes?` | `number` | Maximum decoded inline image size. | - | [src/batteries/generation/local\\_diffusion/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L99) |\n| `maxLineBytes?` | `number` | Maximum protocol line size. | - | [src/batteries/generation/local\\_diffusion/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L101) |\n| `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.20260921.0/src/src/batteries/generation/openai/types.ts#L71) |\n| `negativePrompt?` | `string` | Default negative prompt. | - | [src/batteries/generation/local\\_diffusion/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L123) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `ops?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<{ `edit`: `string`; `generate`: `string`; }> | Operation and event tag overrides. | - | [src/batteries/generation/local\\_diffusion/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L109) |\n| `outputDir?` | `string` | Directory within which backend output files may be deleted. | - | [src/batteries/generation/local\\_diffusion/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L97) |\n| `protocol?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`ProtocolConfig`](../../protocol/type-aliases/ProtocolConfig.md)> | Protocol tag overrides. | - | [src/batteries/generation/local\\_diffusion/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L103) |\n| `requestTimeoutMs?` | `number` | Request deadline in milliseconds; zero disables it. | - | [src/batteries/generation/local\\_diffusion/types.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L117) |\n| `sampler?` | `string` | Default sampler. | - | [src/batteries/generation/local\\_diffusion/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L129) |\n| `seed?` | `number` | Default random seed. | - | [src/batteries/generation/local\\_diffusion/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L131) |\n| `spawn?` | [`DiffusionBackendSpawner`](../type-aliases/DiffusionBackendSpawner.md) | Process factory seam. | - | [src/batteries/generation/local\\_diffusion/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L93) |\n| `startupTimeoutMs?` | `number` | Startup deadline in milliseconds. | - | [src/batteries/generation/local\\_diffusion/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L115) |\n| `steps?` | `number` | Default denoising steps. | - | [src/batteries/generation/local\\_diffusion/types.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L125) |\n| `width?` | `number` | Default output width. | - | [src/batteries/generation/local\\_diffusion/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L133) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/ReadableLike","title":"Interface: ReadableLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/ReadableLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/ReadableLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/types/interfaces/ReadableLike.md\ndescription: A readable stream surface used by a diffusion backend.\n---\n\n# Interface: ReadableLike\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:16](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L16)\n\nA readable stream surface used by a diffusion backend.\n\n## Methods\n\n### off()\n\n```ts\noff(event: string, listener: (...args: any[]) => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L24)\n\nRemove a previously registered listener.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------ |\n| `event` | `string` |\n| `listener` | (...`args`: `any`\\[]) => `void` |\n\n#### Returns\n\n`void`\n\n***\n\n### on()\n\n#### Call Signature\n\n```ts\non(event: \"data\", listener: (chunk: Uint8Array) => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L18)\n\nRegister a stream listener.\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | --------------------------------- |\n| `event` | `\"data\"` |\n| `listener` | (`chunk`: `Uint8Array`) => `void` |\n\n##### Returns\n\n`void`\n\n#### Call Signature\n\n```ts\non(event: \"end\", listener: () => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L20)\n\nRegister an end listener.\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | ------------ |\n| `event` | `\"end\"` |\n| `listener` | () => `void` |\n\n##### Returns\n\n`void`\n\n#### Call Signature\n\n```ts\non(event: \"error\", listener: (error: Error) => void): void;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L22)\n\nRegister an error listener.\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | ---------------------------- |\n| `event` | `\"error\"` |\n| `listener` | (`error`: `Error`) => `void` |\n\n##### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/type-aliases/DiffusionBackendSpawner","title":"Type Alias: DiffusionBackendSpawner","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/type-aliases/DiffusionBackendSpawner.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/types/type-aliases/DiffusionBackendSpawner","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/types/type-aliases/DiffusionBackendSpawner.md\ndescription: Factory seam for starting one backend process.\n---\n\n# Type Alias: DiffusionBackendSpawner\n\n```ts\ntype DiffusionBackendSpawner = (context: {\n args: string[];\n command: string;\n model: string;\n}) => DiffusionBackendProcess | Promise;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/types.ts#L48)\n\nFactory seam for starting one backend process.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------------- | ----------------------------------------------------------------- | ---------------------- |\n| `context` | { `args`: `string`\\[]; `command`: `string`; `model`: `string`; } | - |\n| `context.args` | `string`\\[] | Executable arguments. |\n| `context.command` | `string` | Executable to start. |\n| `context.model` | `string` | Configured checkpoint. |\n\n## Returns\n\n| [`DiffusionBackendProcess`](../interfaces/DiffusionBackendProcess.md)\n| `Promise`<[`DiffusionBackendProcess`](../interfaces/DiffusionBackendProcess.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation","title":"@nhtio/adk/batteries/generation/local\\_diffusion/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/validation.md\ndescription: Runtime validation for local diffusion options.\n---\n\n# @nhtio/adk/batteries/generation/local\\_diffusion/validation\n\nRuntime validation for local diffusion options.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------- | ----------------------------------------------------- |\n| [localDiffusionOptionsSchema](variables/localDiffusionOptionsSchema.md) | Validator schema for local diffusion adapter options. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validate and resolve adapter options. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(\n input: unknown,\n): LocalDiffusionGenerationAdapterOptions;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/validation.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/validation.ts#L65)\n\nValidate and resolve adapter options.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `input` | `unknown` |\n\n## Returns\n\n[`LocalDiffusionGenerationAdapterOptions`](../../types/interfaces/LocalDiffusionGenerationAdapterOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation/variables/localDiffusionOptionsSchema","title":"Variable: localDiffusionOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation/variables/localDiffusionOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/local_diffusion/validation/variables/localDiffusionOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/validation/variables/localDiffusionOptionsSchema.md\ndescription: Validator schema for local diffusion adapter options.\n---\n\n# Variable: localDiffusionOptionsSchema\n\n```ts\nconst localDiffusionOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/generation/local\\_diffusion/validation.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/local_diffusion/validation.ts#L9)\n\nValidator schema for local diffusion adapter options.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai","title":"@nhtio/adk/batteries/generation/openai","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai.md'\ndescription: >-\n OpenAI media generation adapter battery — the environment-neutral generation\n battery and owner of the shared generation option base.\n---\n\n# @nhtio/adk/batteries/generation/openai\n\nOpenAI media generation adapter battery — the environment-neutral generation battery and owner\nof the shared generation option base.\n\n## Remarks\n\nRe-exports the adapter class, the multipart edit-image field-name constant, every option /\nwire-shape type alias (including the shared [BaseGenerationAdapterOptions](types/interfaces/BaseGenerationAdapterOptions.md),\n[GenerateOptions](types/interfaces/GenerateOptions.md), [EditOptions](types/interfaces/EditOptions.md), and [GenerationRetryConfig](types/interfaces/GenerationRetryConfig.md) that future\ngeneration batteries build on), the validation schema + `validateOptions` wrapper, and the\nbattery-scoped exceptions.\n\n## References\n\n### BaseGenerationAdapterOptions\n\nRe-exports [BaseGenerationAdapterOptions](types/interfaces/BaseGenerationAdapterOptions.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS](exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR](exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE](exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md)\n\n***\n\n### E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT](exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md)\n\n***\n\n### EDIT\\_IMAGE\\_FIELD\\_NAME\n\nRe-exports [EDIT\\_IMAGE\\_FIELD\\_NAME](adapter/variables/EDIT_IMAGE_FIELD_NAME.md)\n\n***\n\n### EditOptions\n\nRe-exports [EditOptions](types/interfaces/EditOptions.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GenerateOptions\n\nRe-exports [GenerateOptions](types/interfaces/GenerateOptions.md)\n\n***\n\n### GenerationRetryConfig\n\nRe-exports [GenerationRetryConfig](types/interfaces/GenerationRetryConfig.md)\n\n***\n\n### OpenAIEditOptions\n\nRe-exports [OpenAIEditOptions](types/interfaces/OpenAIEditOptions.md)\n\n***\n\n### OpenAIGenerateOptions\n\nRe-exports [OpenAIGenerateOptions](types/interfaces/OpenAIGenerateOptions.md)\n\n***\n\n### OpenAIGenerationAdapter\n\nRe-exports [OpenAIGenerationAdapter](adapter/classes/OpenAIGenerationAdapter.md)\n\n***\n\n### OpenAIGenerationAdapterOptions\n\nRe-exports [OpenAIGenerationAdapterOptions](types/interfaces/OpenAIGenerationAdapterOptions.md)\n\n***\n\n### openAIGenerationOptionsSchema\n\nRe-exports [openAIGenerationOptionsSchema](validation/variables/openAIGenerationOptionsSchema.md)\n\n***\n\n### OpenAIImagesGenerationRequestBody\n\nRe-exports [OpenAIImagesGenerationRequestBody](types/interfaces/OpenAIImagesGenerationRequestBody.md)\n\n***\n\n### OpenAIImagesResponse\n\nRe-exports [OpenAIImagesResponse](types/interfaces/OpenAIImagesResponse.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter","title":"@nhtio/adk/batteries/generation/openai/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/adapter.md'\ndescription: Cross-environment OpenAI media generation adapter battery.\n---\n\n# @nhtio/adk/batteries/generation/openai/adapter\n\nCross-environment OpenAI media generation adapter battery.\n\n## Remarks\n\nOpinionated media-generation battery for the OpenAI `/v1/images/generations` and\n`/v1/images/edits` wire shapes. Ships an [OpenAIGenerationAdapter](classes/OpenAIGenerationAdapter.md) that targets any\nOpenAI-`/v1/images`-compatible endpoint (OpenAI proper, Azure-behind-proxy, a local gateway,\netc.) over raw `fetch` — no SDK dependency, so it runs unchanged in Node, the browser, edge\nruntimes, and workers.\n\nConstruction validates options eagerly via\n[@nhtio/adk/batteries/generation/openai/validation!validateOptions](../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS](../exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md) on\nfailure — config bugs fail loud, not at generate/edit time.\n\n## Classes\n\n| Class | Description |\n| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |\n| [OpenAIGenerationAdapter](classes/OpenAIGenerationAdapter.md) | Media generation adapter for the OpenAI `/v1/images/generations` and `/v1/images/edits` wire shapes. |\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------- | --------------------------------------------------------------------------------------- |\n| [EDIT\\_IMAGE\\_FIELD\\_NAME](variables/EDIT_IMAGE_FIELD_NAME.md) | The multipart field name used for each image appended to an `/v1/images/edits` request. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter/classes/OpenAIGenerationAdapter","title":"Class: OpenAIGenerationAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter/classes/OpenAIGenerationAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter/classes/OpenAIGenerationAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/adapter/classes/OpenAIGenerationAdapter.md\ndescription: >-\n Media generation adapter for the OpenAI `/v1/images/generations` and\n `/v1/images/edits` wire shapes.\n---\n\n# Class: OpenAIGenerationAdapter\n\nDefined in: [src/batteries/generation/openai/adapter.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L63)\n\nMedia generation adapter for the OpenAI `/v1/images/generations` and `/v1/images/edits` wire\nshapes.\n\n## Remarks\n\nReusable: construct once, call [OpenAIGenerationAdapter.generate](#generate) /\n[OpenAIGenerationAdapter.edit](#edit) as many times as needed.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OpenAIGenerationAdapter(options: unknown): OpenAIGenerationAdapter;\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L80)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`OpenAIGenerationAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS](../../exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md) when `options` does not satisfy\n[@nhtio/adk/batteries/generation/openai/validation!openAIGenerationOptionsSchema](../../validation/variables/openAIGenerationOptionsSchema.md) (e.g. missing `model`).\n\n## Methods\n\n### edit()\n\n```ts\nedit(\n inputs:\n | GenerationImageInput\n | GenerationImageInput[],\n prompt: string,\nopts?: OpenAIEditOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L156)\n\nEdits one or more source images from a text prompt, optionally constrained to a masked\nregion.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `inputs` | | [`GenerationImageInput`](../../../_shared/type-aliases/GenerationImageInput.md) | [`GenerationImageInput`](../../../_shared/type-aliases/GenerationImageInput.md)\\[] | One image, or several images, in any [GenerationImageInput](../../../_shared/type-aliases/GenerationImageInput.md) form. |\n| `prompt` | `string` | The text prompt describing the desired edit. |\n| `opts?` | [`OpenAIEditOptions`](../../types/interfaces/OpenAIEditOptions.md) | Per-call options (`n`, `size`, `quality`, `mask`), each falling back to the adapter's configured default when omitted (`mask` has no adapter-level default). |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\nOne [GeneratedMediaOutput](../../../../interfaces/GeneratedMediaOutput.md) per edited image.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR](../../exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR.md) on a non-2xx response or transport failure.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT](../../exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md) when the handshake exceeds `requestTimeoutMs`.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE](../../exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md) when the 2xx body is not the expected shape.\n\n***\n\n### generate()\n\n```ts\ngenerate(prompt: string, opts?: OpenAIGenerateOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L115)\n\nGenerates one or more images from a text prompt.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `prompt` | `string` | The text prompt describing the desired image(s). |\n| `opts?` | [`OpenAIGenerateOptions`](../../types/interfaces/OpenAIGenerateOptions.md) | Per-call options (`n`, `size`, `quality`, `outputFormat`, `background`), each falling back to the adapter's configured default when omitted. |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\nOne [GeneratedMediaOutput](../../../../interfaces/GeneratedMediaOutput.md) per generated image.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR](../../exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR.md) on a non-2xx response or transport failure.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT](../../exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md) when the handshake exceeds `requestTimeoutMs`.\n\n#### Throws\n\n[@nhtio/adk/batteries/generation/openai/exceptions!E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE](../../exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md) when the 2xx body is not the expected shape.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L85)\n\nSee [OpenAIGenerationAdapter.isAvailable](#isavailable-1). Instance alias for surface-parity.\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L93)\n\nNo-op warm-up. The OpenAI battery has no engine to preload; present for surface-parity with\non-device generation batteries so callers can treat them interchangeably.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L100)\n\nNo-op state reset. Present for surface-parity with on-device generation batteries.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L71)\n\nWhether this battery can run in the current environment. For the HTTP-backed OpenAI battery\nthis is always `true` (a `fetch` is always resolvable); present for surface-parity with\nWebGPU-gated batteries.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter/variables/EDIT_IMAGE_FIELD_NAME","title":"Variable: EDIT\\_IMAGE\\_FIELD\\_NAME","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter/variables/EDIT_IMAGE_FIELD_NAME.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/adapter/variables/EDIT_IMAGE_FIELD_NAME","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/adapter/variables/EDIT_IMAGE_FIELD_NAME.md\ndescription: >-\n The multipart field name used for each image appended to an `/v1/images/edits`\n request.\n---\n\n# Variable: EDIT\\_IMAGE\\_FIELD\\_NAME\n\n```ts\nconst EDIT_IMAGE_FIELD_NAME: \"image[]\" = \"image[]\";\n```\n\nDefined in: [src/batteries/generation/openai/adapter.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/adapter.ts#L51)\n\nThe multipart field name used for each image appended to an `/v1/images/edits` request.\n\n## Remarks\n\nDefined once, in this one place, so the WP-0 upstream-probe finding (whether the live API\nexpects the array-suffixed `'image[]'` form or the bare `'image'` form for multi-image edit\nrequests) can flip the wire behavior by changing a single constant, with every call site and\ntest following automatically.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions","title":"@nhtio/adk/batteries/generation/openai/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/exceptions.md'\ndescription: >-\n Battery-scoped exception constructors for OpenAI media generation adapter\n failures.\n---\n\n# @nhtio/adk/batteries/generation/openai/exceptions\n\nBattery-scoped exception constructors for OpenAI media generation adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the OpenAI media generation adapter. These exceptions are\nowned by the battery (not the ADK core) and are minted via `createException` from\n`@nhtio/adk/factories`. Re-exported from the battery's barrel.\n\nThe categories mirror the OpenAI Embeddings battery one-to-one so batteries across domains fail\nwith parallel semantics — only the engine-specific transport exception differs.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS](variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `openAIGenerationOptionsSchema` — e.g. a missing/empty `model`, an unknown option key, or an invalid enum value. Fatal: config bugs fail loud at construction time, not at generate/edit time. |\n| [E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR](variables/E_OPENAI_GENERATION_HTTP_ERROR.md) | Thrown when the upstream `/v1/images/generations` or `/v1/images/edits` endpoint returns a non-2xx response (after retries are exhausted), or the transport throws. Non-fatal. Printf args: `[status, detail]` — `status` is `0` for a transport-level failure with no HTTP response. |\n| [E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE](variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md) | Thrown when a 2xx response body cannot be parsed into the expected `{ data: [{ b64_json }] }` shape (malformed JSON, missing/empty `data`, or an entry missing `b64_json`). Non-fatal. Printf arg: `[detail]`. |\n| [E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT](variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md) | Thrown when the request handshake does not complete before `requestTimeoutMs` (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS","title":"Variable: E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_INVALID_OPENAI_GENERATION_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `openAIGenerationOptionsSchema` — e.g. a missing/empty `model`, an unknown\n option key, or an invalid enum value. Fatal: config bugs fail loud at\n construction time, not at generate/edit time.\n---\n\n# Variable: E\\_INVALID\\_OPENAI\\_GENERATION\\_OPTIONS\n\n```ts\nconst E_INVALID_OPENAI_GENERATION_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/openai/exceptions.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/exceptions.ts#L22)\n\nThrown when the resolved adapter options fail validation against\n`openAIGenerationOptionsSchema` — e.g. a missing/empty `model`, an unknown option key, or an\ninvalid enum value. Fatal: config bugs fail loud at construction time, not at generate/edit time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR","title":"Variable: E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_HTTP_ERROR.md\ndescription: >-\n Thrown when the upstream `/v1/images/generations` or `/v1/images/edits`\n endpoint returns a non-2xx response (after retries are exhausted), or the\n transport throws. Non-fatal. Printf args: `[status, detail]` — `status` is `0`\n for a transport-level failure with no HTTP response.\n---\n\n# Variable: E\\_OPENAI\\_GENERATION\\_HTTP\\_ERROR\n\n```ts\nconst E_OPENAI_GENERATION_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/generation/openai/exceptions.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/exceptions.ts#L35)\n\nThrown when the upstream `/v1/images/generations` or `/v1/images/edits` endpoint returns a\nnon-2xx response (after retries are exhausted), or the transport throws. Non-fatal. Printf args:\n`[status, detail]` — `status` is `0` for a transport-level failure with no HTTP response.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE","title":"Variable: E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_MALFORMED_RESPONSE.md\ndescription: >-\n Thrown when a 2xx response body cannot be parsed into the expected `{ data: [{\n b64_json }] }` shape (malformed JSON, missing/empty `data`, or an entry\n missing `b64_json`). Non-fatal. Printf arg: `[detail]`.\n---\n\n# Variable: E\\_OPENAI\\_GENERATION\\_MALFORMED\\_RESPONSE\n\n```ts\nconst E_OPENAI_GENERATION_MALFORMED_RESPONSE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/openai/exceptions.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/exceptions.ts#L60)\n\nThrown when a 2xx response body cannot be parsed into the expected `{ data: [{ b64_json }] }`\nshape (malformed JSON, missing/empty `data`, or an entry missing `b64_json`). Non-fatal. Printf\narg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT","title":"Variable: E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/exceptions/variables/E_OPENAI_GENERATION_REQUEST_TIMEOUT.md\ndescription: >-\n Thrown when the request handshake does not complete before `requestTimeoutMs`\n (and retries are exhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n---\n\n# Variable: E\\_OPENAI\\_GENERATION\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_OPENAI_GENERATION_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/generation/openai/exceptions.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/exceptions.ts#L47)\n\nThrown when the request handshake does not complete before `requestTimeoutMs` (and retries are\nexhausted). Non-fatal. Printf arg: `[requestTimeoutMs]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types","title":"@nhtio/adk/batteries/generation/openai/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types.md'\ndescription: >-\n Option and wire-shape types for the OpenAI media generation adapter, plus the\n shared generation battery base type both current and future generation\n batteries build on.\n---\n\n# @nhtio/adk/batteries/generation/openai/types\n\nOption and wire-shape types for the OpenAI media generation adapter, plus the shared generation\nbattery base type both current and future generation batteries build on.\n\n## Remarks\n\nThis module owns the **shared** generation option base ([BaseGenerationAdapterOptions](interfaces/BaseGenerationAdapterOptions.md))\nand the shared call shapes ([GenerateOptions](interfaces/GenerateOptions.md), [EditOptions](interfaces/EditOptions.md)). Future generation\nbatteries (Gemini, transformers.js) re-export and `extend` these rather than redefining them, so\nevery generation battery differs only in its engine — exactly how the WebLLM Embeddings battery\nextends the OpenAI Embeddings option type.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [BaseGenerationAdapterOptions](interfaces/BaseGenerationAdapterOptions.md) | Options shared by **every** generation battery, regardless of engine. |\n| [EditOptions](interfaces/EditOptions.md) | Options shared by **every** generation battery's `edit` call, regardless of engine. |\n| [GenerateOptions](interfaces/GenerateOptions.md) | Options shared by **every** generation battery's `generate` call, regardless of engine. |\n| [GenerationRetryConfig](interfaces/GenerationRetryConfig.md) | Retry/backoff configuration for HTTP-backed generation batteries. Mirrors the embeddings battery's `EmbeddingsRetryConfig` so behavior is consistent across the bundled batteries. |\n| [OpenAIEditOptions](interfaces/OpenAIEditOptions.md) | Per-call options accepted by [@nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter.edit](../adapter/classes/OpenAIGenerationAdapter.md#edit). |\n| [OpenAIGenerateOptions](interfaces/OpenAIGenerateOptions.md) | Per-call options accepted by [@nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter.generate](../adapter/classes/OpenAIGenerationAdapter.md#generate). |\n| [OpenAIGenerationAdapterOptions](interfaces/OpenAIGenerationAdapterOptions.md) | Constructor options for [@nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter](../adapter/classes/OpenAIGenerationAdapter.md). |\n| [OpenAIImagesGenerationRequestBody](interfaces/OpenAIImagesGenerationRequestBody.md) | The JSON request body POSTed to `/v1/images/generations`. |\n| [OpenAIImagesResponse](interfaces/OpenAIImagesResponse.md) | The relevant subset of the `/v1/images/generations` and `/v1/images/edits` JSON response shape. |\n\n## References\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../../interfaces/GeneratedMediaOutput.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/BaseGenerationAdapterOptions","title":"Interface: BaseGenerationAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/BaseGenerationAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/BaseGenerationAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/BaseGenerationAdapterOptions.md\ndescription: 'Options shared by **every** generation battery, regardless of engine.'\n---\n\n# Interface: BaseGenerationAdapterOptions\n\nDefined in: [src/batteries/generation/openai/types.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L66)\n\nOptions shared by **every** generation battery, regardless of engine.\n\n## Remarks\n\nEngine-specific batteries extend this with their own transport/engine fields. `model` is\n**required with no default** — naming the generation model is the caller's responsibility,\nnever the battery's.\n\n## Extended by\n\n* [`TransformersJsGenerationAdapterOptions`](../../../transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions.md)\n* [`OpenAIGenerationAdapterOptions`](OpenAIGenerationAdapterOptions.md)\n* [`LocalDiffusionGenerationAdapterOptions`](../../../local_diffusion/types/interfaces/LocalDiffusionGenerationAdapterOptions.md)\n* [`GeminiGenerationAdapterOptions`](../../../gemini/types/interfaces/GeminiGenerationAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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`. | [src/batteries/generation/openai/types.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L71) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/EditOptions","title":"Interface: EditOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/EditOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/EditOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/EditOptions.md\ndescription: >-\n Options shared by **every** generation battery's `edit` call, regardless of\n engine.\n---\n\n# Interface: EditOptions\n\nDefined in: [src/batteries/generation/openai/types.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L53)\n\nOptions shared by **every** generation battery's `edit` call, regardless of engine.\n\n## Extended by\n\n* [`OpenAIEditOptions`](OpenAIEditOptions.md)\n* [`LocalDiffusionCallOptions`](../../../local_diffusion/types/interfaces/LocalDiffusionCallOptions.md)\n* [`GeminiEditOptions`](../../../gemini/types/interfaces/GeminiEditOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------- | -------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `n?` | `number` | Number of edited images to generate. Engine-defaulted when omitted. | [src/batteries/generation/openai/types.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L55) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerateOptions","title":"Interface: GenerateOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerateOptions.md\ndescription: >-\n Options shared by **every** generation battery's `generate` call, regardless\n of engine.\n---\n\n# Interface: GenerateOptions\n\nDefined in: [src/batteries/generation/openai/types.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L45)\n\nOptions shared by **every** generation battery's `generate` call, regardless of engine.\n\n## Extended by\n\n* [`TransformersJsGenerateOptions`](../../../transformers_js/types/interfaces/TransformersJsGenerateOptions.md)\n* [`OpenAIGenerateOptions`](OpenAIGenerateOptions.md)\n* [`LocalDiffusionCallOptions`](../../../local_diffusion/types/interfaces/LocalDiffusionCallOptions.md)\n* [`GeminiGenerateOptions`](../../../gemini/types/interfaces/GeminiGenerateOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------- | -------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `n?` | `number` | Number of images to generate. Engine-defaulted when omitted. | [src/batteries/generation/openai/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L47) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerationRetryConfig","title":"Interface: GenerationRetryConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerationRetryConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerationRetryConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/GenerationRetryConfig.md\ndescription: >-\n Retry/backoff configuration for HTTP-backed generation batteries. Mirrors the\n embeddings battery's `EmbeddingsRetryConfig` so behavior is consistent across\n the bundled batteries.\n---\n\n# Interface: GenerationRetryConfig\n\nDefined in: [src/batteries/generation/openai/types.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L29)\n\nRetry/backoff configuration for HTTP-backed generation batteries. Mirrors the embeddings\nbattery's `EmbeddingsRetryConfig` so behavior is consistent across the bundled batteries.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | ---------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `baseDelayMs?` | `number` | Base backoff delay in ms; doubled each attempt. Default `500`. | [src/batteries/generation/openai/types.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L33) |\n| `honorRetryAfter?` | `boolean` | Honor an upstream `Retry-After` header when present. Default `true`. | [src/batteries/generation/openai/types.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L39) |\n| `maxAttempts?` | `number` | Max total attempts (including the first). Default `1` (no retry). | [src/batteries/generation/openai/types.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L31) |\n| `maxDelayMs?` | `number` | Backoff ceiling in ms. Default `30_000`. | [src/batteries/generation/openai/types.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L35) |\n| `retriableStatuses?` | `number`\\[] | HTTP statuses eligible for retry. Default `[429, 500, 502, 503, 504]`. | [src/batteries/generation/openai/types.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L37) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIEditOptions","title":"Interface: OpenAIEditOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIEditOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIEditOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIEditOptions.md\ndescription: >-\n Per-call options accepted by {@link\n @nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter.edit}.\n---\n\n# Interface: OpenAIEditOptions\n\nDefined in: [src/batteries/generation/openai/types.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L132)\n\nPer-call options accepted by [@nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter.edit](../../adapter/classes/OpenAIGenerationAdapter.md#edit).\n\n## Extends\n\n* [`EditOptions`](EditOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `mask?` | [`GenerationImageInput`](../../../_shared/type-aliases/GenerationImageInput.md) | Optional mask image marking the editable region; transparent pixels are edited. | - | [src/batteries/generation/openai/types.ts:134](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L134) |\n| `n?` | `number` | Number of edited images to generate. Engine-defaulted when omitted. | [`EditOptions`](EditOptions.md).[`n`](EditOptions.md#property-n) | [src/batteries/generation/openai/types.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L55) |\n| `quality?` | `\"auto\"` | `\"low\"` | `\"medium\"` | `\"high\"` | Rendering quality. Falls back to the adapter's configured default. | - | [src/batteries/generation/openai/types.ts:138](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L138) |\n| `size?` | `string` | Image size (e.g. `'1024x1024'`). Falls back to the adapter's configured default. | - | [src/batteries/generation/openai/types.ts:136](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L136) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerateOptions","title":"Interface: OpenAIGenerateOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerateOptions.md\ndescription: >-\n Per-call options accepted by {@link\n @nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter.generate}.\n---\n\n# Interface: OpenAIGenerateOptions\n\nDefined in: [src/batteries/generation/openai/types.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L118)\n\nPer-call options accepted by [@nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter.generate](../../adapter/classes/OpenAIGenerationAdapter.md#generate).\n\n## Extends\n\n* [`GenerateOptions`](GenerateOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `background?` | `\"auto\"` | `\"transparent\"` | `\"opaque\"` | Background handling. Falls back to the adapter's configured default. | - | [src/batteries/generation/openai/types.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L126) |\n| `n?` | `number` | Number of images to generate. Engine-defaulted when omitted. | [`GenerateOptions`](GenerateOptions.md).[`n`](GenerateOptions.md#property-n) | [src/batteries/generation/openai/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L47) |\n| `outputFormat?` | `\"png\"` | `\"jpeg\"` | `\"webp\"` | Output image format. Falls back to the adapter's configured default. | - | [src/batteries/generation/openai/types.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L124) |\n| `quality?` | `\"auto\"` | `\"low\"` | `\"medium\"` | `\"high\"` | Rendering quality. Falls back to the adapter's configured default. | - | [src/batteries/generation/openai/types.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L122) |\n| `size?` | `string` | Image size (e.g. `'1024x1024'`). Falls back to the adapter's configured default. | - | [src/batteries/generation/openai/types.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L120) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerationAdapterOptions","title":"Interface: OpenAIGenerationAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerationAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerationAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIGenerationAdapterOptions.md\ndescription: >-\n Constructor options for {@link\n @nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter}.\n---\n\n# Interface: OpenAIGenerationAdapterOptions\n\nDefined in: [src/batteries/generation/openai/types.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L81)\n\nConstructor options for [@nhtio/adk/batteries/generation/openai/adapter!OpenAIGenerationAdapter](../../adapter/classes/OpenAIGenerationAdapter.md).\n\n## Remarks\n\nExtends [BaseGenerationAdapterOptions](BaseGenerationAdapterOptions.md) with the HTTP transport fields plus OpenAI's\nimage-generation-specific knobs.\n\n## Extends\n\n* [`BaseGenerationAdapterOptions`](BaseGenerationAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | Bearer token. Sent as `Authorization: Bearer ` unless overridden by `headers`. | - | [src/batteries/generation/openai/types.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L83) |\n| `background?` | `\"auto\"` | `\"transparent\"` | `\"opaque\"` | Default background handling, applied when a call omits its own `background`. | - | [src/batteries/generation/openai/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L101) |\n| `baseURL?` | `string` | API base URL. Default `https://api.openai.com/v1`. A trailing slash is trimmed. | - | [src/batteries/generation/openai/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L85) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Custom `fetch` implementation. Default `globalThis.fetch`. | - | [src/batteries/generation/openai/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L89) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Extra request headers. Override built defaults (including `Authorization`) key-by-key. | - | [src/batteries/generation/openai/types.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L87) |\n| `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`](BaseGenerationAdapterOptions.md).[`model`](BaseGenerationAdapterOptions.md#property-model) | [src/batteries/generation/openai/types.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L71) |\n| `outputFormat?` | `\"png\"` | `\"jpeg\"` | `\"webp\"` | Default output image format, applied when a call omits its own `outputFormat`. | - | [src/batteries/generation/openai/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L99) |\n| `quality?` | `\"auto\"` | `\"low\"` | `\"medium\"` | `\"high\"` | Default rendering quality, applied when a call omits its own `quality`. | - | [src/batteries/generation/openai/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L97) |\n| `requestTimeoutMs?` | `number` | Per-request handshake timeout in ms. `0`/unset disables the timeout. | - | [src/batteries/generation/openai/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L93) |\n| `responseFormatMode?` | `\"auto\"` | `\"omit\"` | `\"send\"` | Controls whether the request body includes `response_format: 'b64_json'`. **Remarks** - `'auto'` (default) — include it only when `model` starts with `'dall-e'`. `dall-e-*` models default to returning a hosted URL unless told otherwise; `gpt-image-*` models always return base64 and reject the parameter. - `'send'` — always include it, regardless of model. - `'omit'` — never include it. | - | [src/batteries/generation/openai/types.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L112) |\n| `retry?` | [`GenerationRetryConfig`](GenerationRetryConfig.md) | Retry/backoff configuration. Default: a single attempt (no retry). | - | [src/batteries/generation/openai/types.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L91) |\n| `size?` | `string` | Default image size (e.g. `'1024x1024'`), applied when a call omits its own `size`. | - | [src/batteries/generation/openai/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L95) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesGenerationRequestBody","title":"Interface: OpenAIImagesGenerationRequestBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesGenerationRequestBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesGenerationRequestBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesGenerationRequestBody.md\ndescription: The JSON request body POSTed to `/v1/images/generations`.\n---\n\n# Interface: OpenAIImagesGenerationRequestBody\n\nDefined in: [src/batteries/generation/openai/types.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L144)\n\nThe JSON request body POSTed to `/v1/images/generations`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------- | -------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `background?` | `string` | Requested background handling. | [src/batteries/generation/openai/types.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L158) |\n| `model` | `string` | ID of the image generation model to use. | [src/batteries/generation/openai/types.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L146) |\n| `n?` | `number` | Number of images to generate. | [src/batteries/generation/openai/types.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L150) |\n| `output_format?` | `string` | Requested output image format. | [src/batteries/generation/openai/types.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L156) |\n| `prompt` | `string` | The text prompt describing the desired image(s). | [src/batteries/generation/openai/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L148) |\n| `quality?` | `string` | Requested rendering quality. | [src/batteries/generation/openai/types.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L154) |\n| `response_format?` | `string` | Requested response encoding; `'b64_json'` when present. | [src/batteries/generation/openai/types.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L160) |\n| `size?` | `string` | Requested image size (e.g. `'1024x1024'`). | [src/batteries/generation/openai/types.ts:152](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L152) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesResponse","title":"Interface: OpenAIImagesResponse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesResponse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesResponse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/types/interfaces/OpenAIImagesResponse.md\ndescription: >-\n The relevant subset of the `/v1/images/generations` and `/v1/images/edits`\n JSON response shape.\n---\n\n# Interface: OpenAIImagesResponse\n\nDefined in: [src/batteries/generation/openai/types.ts:166](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L166)\n\nThe relevant subset of the `/v1/images/generations` and `/v1/images/edits` JSON response shape.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ------------------------------ | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `data` | { `b64_json?`: `string`; }\\[] | The generated/edited images, each carrying a base64-encoded payload. | [src/batteries/generation/openai/types.ts:168](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L168) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation","title":"@nhtio/adk/batteries/generation/openai/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/validation.md'\ndescription: >-\n Runtime validation schema and wrapper for OpenAI media generation adapter\n options.\n---\n\n# @nhtio/adk/batteries/generation/openai/validation\n\nRuntime validation schema and wrapper for OpenAI media generation adapter options.\n\n## Remarks\n\nValidates `OpenAIGenerationAdapterOptions` at construction time. Throws\n`E_INVALID_OPENAI_GENERATION_OPTIONS` on failure — the same hard-fail policy as every other ADK\ncontract. `model` is required; unknown top-level keys are rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| [openAIGenerationOptionsSchema](variables/openAIGenerationOptionsSchema.md) | Validator schema for `OpenAIGenerationAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `openAIGenerationOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_OPENAI_GENERATION_OPTIONS` (carrying the validator's report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): OpenAIGenerationAdapterOptions;\n```\n\nDefined in: [src/batteries/generation/openai/validation.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/validation.ts#L64)\n\nValidates an arbitrary input against `openAIGenerationOptionsSchema` and returns the resolved\noptions shape. Throws `E_INVALID_OPENAI_GENERATION_OPTIONS` (carrying the validator's report on\n`cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`OpenAIGenerationAdapterOptions`](../../types/interfaces/OpenAIGenerationAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation/variables/openAIGenerationOptionsSchema","title":"Variable: openAIGenerationOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation/variables/openAIGenerationOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/openai/validation/variables/openAIGenerationOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/openai/validation/variables/openAIGenerationOptionsSchema.md\ndescription: >-\n Validator schema for `OpenAIGenerationAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: openAIGenerationOptionsSchema\n\n```ts\nconst openAIGenerationOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/generation/openai/validation.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/validation.ts#L33)\n\nValidator schema for `OpenAIGenerationAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js","title":"@nhtio/adk/batteries/generation/transformers\\_js","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js.md'\ndescription: >-\n transformers.js Generation battery — dual-environment, EXPERIMENTAL on-device\n Janus text→image.\n---\n\n# @nhtio/adk/batteries/generation/transformers\\_js\n\ntransformers.js Generation battery — dual-environment, EXPERIMENTAL on-device Janus text→image.\n\n## Remarks\n\nEnvironment-neutral (Node + browser, ONNX Runtime auto-selected). Re-exports the adapter class, the\nvalidation schema + `validateOptions` wrapper, every option / model / processor type alias, and the\nbattery-scoped exceptions.\n\n## References\n\n### BaseGenerationAdapterOptions\n\nRe-exports [BaseGenerationAdapterOptions](../openai/types/interfaces/BaseGenerationAdapterOptions.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTransformersJsGenerationModel\n\nRe-exports [CreateTransformersJsGenerationModel](types/type-aliases/CreateTransformersJsGenerationModel.md)\n\n***\n\n### CreateTransformersJsGenerationProcessor\n\nRe-exports [CreateTransformersJsGenerationProcessor](types/type-aliases/CreateTransformersJsGenerationProcessor.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS](exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR](exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION](exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md)\n\n***\n\n### EditOptions\n\nRe-exports [EditOptions](../openai/types/interfaces/EditOptions.md)\n\n***\n\n### EncodeRawImageFn\n\nRe-exports [EncodeRawImageFn](types/type-aliases/EncodeRawImageFn.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GenerateOptions\n\nRe-exports [GenerateOptions](../openai/types/interfaces/GenerateOptions.md)\n\n***\n\n### GenerationRetryConfig\n\nRe-exports [GenerationRetryConfig](../openai/types/interfaces/GenerationRetryConfig.md)\n\n***\n\n### TransformersJsGenerateOptions\n\nRe-exports [TransformersJsGenerateOptions](types/interfaces/TransformersJsGenerateOptions.md)\n\n***\n\n### TransformersJsGenerationAdapter\n\nRe-exports [TransformersJsGenerationAdapter](adapter/classes/TransformersJsGenerationAdapter.md)\n\n***\n\n### TransformersJsGenerationAdapterOptions\n\nRe-exports [TransformersJsGenerationAdapterOptions](types/interfaces/TransformersJsGenerationAdapterOptions.md)\n\n***\n\n### TransformersJsGenerationDataType\n\nRe-exports [TransformersJsGenerationDataType](types/type-aliases/TransformersJsGenerationDataType.md)\n\n***\n\n### TransformersJsGenerationDeviceType\n\nRe-exports [TransformersJsGenerationDeviceType](types/type-aliases/TransformersJsGenerationDeviceType.md)\n\n***\n\n### TransformersJsGenerationModel\n\nRe-exports [TransformersJsGenerationModel](types/interfaces/TransformersJsGenerationModel.md)\n\n***\n\n### TransformersJsGenerationModelSource\n\nRe-exports [TransformersJsGenerationModelSource](types/type-aliases/TransformersJsGenerationModelSource.md)\n\n***\n\n### transformersJsGenerationOptionsSchema\n\nRe-exports [transformersJsGenerationOptionsSchema](validation/variables/transformersJsGenerationOptionsSchema.md)\n\n***\n\n### TransformersJsGenerationProcessor\n\nRe-exports [TransformersJsGenerationProcessor](types/interfaces/TransformersJsGenerationProcessor.md)\n\n***\n\n### TransformersJsGenerationProgressCallback\n\nRe-exports [TransformersJsGenerationProgressCallback](types/type-aliases/TransformersJsGenerationProgressCallback.md)\n\n***\n\n### TransformersJsRawImageLike\n\nRe-exports [TransformersJsRawImageLike](types/interfaces/TransformersJsRawImageLike.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/adapter","title":"@nhtio/adk/batteries/generation/transformers\\_js/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/adapter.md\ndescription: >-\n transformers.js (on-device, EXPERIMENTAL) Generation adapter battery —\n DeepSeek Janus text→image.\n---\n\n# @nhtio/adk/batteries/generation/transformers\\_js/adapter\n\ntransformers.js (on-device, EXPERIMENTAL) Generation adapter battery — DeepSeek Janus text→image.\n\n## Remarks\n\nMedia-generation battery backed by transformers.js's Janus (`MultiModalityCausalLM`) model family\n(documented reference model: `onnx-community/Janus-Pro-1B-ONNX`). **Environment-neutral** — runs in\nNode (via `onnxruntime-node`) and the browser (via `onnxruntime-web` / WebGPU), auto-selected by the\npackage; there is no WebGPU requirement.\n\n**EXPERIMENTAL.** Janus is a ~2GB multimodal model; on WASM/CPU a single image can take minutes to\ngenerate. This battery exists for completeness of the on-device story, not as a fast path — prefer\nthe OpenAI/Gemini engines unless running fully offline is the point.\n\nThere is no `pipeline('text-to-image')` task in transformers.js (verified against the installed\n`@huggingface/transformers` source — no such task is registered in `src/pipelines.js`). The only\nimage-generation surface is `MultiModalityCausalLM.generate_images(options)`\n(`src/models/multi_modality/modeling_multi_modality.js`), fed by `VLChatProcessor`\n(`src/models/janus/processing_janus.js`) — both exported from the package root, per the official\n`onnx-community/Janus-Pro-1B-ONNX` model card:\n\n```javascript\nimport {\n AutoProcessor,\n MultiModalityCausalLM,\n} from \"@huggingface/transformers\";\nconst processor = await AutoProcessor.from_pretrained(model_id);\nconst model = await MultiModalityCausalLM.from_pretrained(model_id);\nconst inputs = await processor([{ role: \"<|User|>\", content: prompt }], {\n chat_template: \"text_to_image\",\n});\nconst outputs = await model.generate_images({\n ...inputs,\n min_new_tokens: processor.num_image_tokens,\n max_new_tokens: processor.num_image_tokens,\n do_sample: true,\n});\n```\n\nThis adapter mirrors that shape exactly, with every knob overridable per-call (see\n`./types` for the full source-verified knob provenance) and both the model and processor typed\n**structurally** (duck-typed local interfaces, never a hard import of the peer's classes) so\nfake-model/fake-processor unit tests never load the real peer.\n\n**`generate_images` returns `RawImage[]`** — raw decoded pixel data, not encoded bytes. Encoding to\nPNG is env-branched (browser `toBlob('image/png')` / Node `toSharp().png().toBuffer()`), handled by\n[@nhtio/adk/batteries/generation/transformers\\_js/helpers!rawImageToEncodedBytes](../helpers/functions/rawImageToEncodedBytes.md), which also\naccepts an injectable `encodeImage` override — the primary hermetic-test seam.\n\n**`edit()` is unsupported.** Janus's only generation entry point (`generate_images`) is\ntext-conditioned; there is no image-conditioned edit/inpaint surface in the installed\n`@huggingface/transformers` API. Calling `edit()` throws\n[@nhtio/adk/batteries/generation/transformers\\_js/exceptions!E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION](../exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md).\n\n`@huggingface/transformers` is an optional peer dependency, imported lazily (only inside the default\nmodel/processor factories, i.e. only when no `janusModel`/`processor`/`createModel`/`createProcessor`\noverride is supplied).\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |\n| [TransformersJsGenerationAdapter](classes/TransformersJsGenerationAdapter.md) | Media generation adapter for transformers.js's Janus (`MultiModalityCausalLM`) text→image model family. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/adapter/classes/TransformersJsGenerationAdapter","title":"Class: TransformersJsGenerationAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/adapter/classes/TransformersJsGenerationAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/adapter/classes/TransformersJsGenerationAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/adapter/classes/TransformersJsGenerationAdapter.md\ndescription: >-\n Media generation adapter for transformers.js's Janus (`MultiModalityCausalLM`)\n text→image model family.\n---\n\n# Class: TransformersJsGenerationAdapter\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L123)\n\nMedia generation adapter for transformers.js's Janus (`MultiModalityCausalLM`) text→image model\nfamily.\n\n## Remarks\n\nReusable: construct once, call [TransformersJsGenerationAdapter.generate](#generate) as many times as\nneeded. The model + processor are resolved lazily on first use (or via [preload](#preload)) and cached\nwith single-flight semantics so concurrent calls share one load. [edit](#edit) always throws — see\nthe module remarks.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew TransformersJsGenerationAdapter(options: unknown): TransformersJsGenerationAdapter;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L146)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`TransformersJsGenerationAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md) when invalid.\n\n## Methods\n\n### edit()\n\n```ts\nedit(\n _image: unknown,\n _prompt: string,\n_opts?: EditOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L326)\n\nUnsupported. Janus's only generation entry point (`generate_images`) is text-conditioned; there is\nno image-conditioned edit/inpaint surface in the installed `@huggingface/transformers` API.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------------------------------------------------------------- |\n| `_image` | `unknown` |\n| `_prompt` | `string` |\n| `_opts?` | [`EditOptions`](../../../openai/types/interfaces/EditOptions.md) |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION](../../exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md) always.\n\n***\n\n### generate()\n\n```ts\ngenerate(prompt: string, opts?: TransformersJsGenerateOptions): Promise;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:241](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L241)\n\nGenerates image(s) from a text prompt via Janus's `generate_images`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |\n| `prompt` | `string` | The text prompt describing the desired image. |\n| `opts?` | [`TransformersJsGenerateOptions`](../../types/interfaces/TransformersJsGenerateOptions.md) | Per-call knob overrides — see [TransformersJsGenerateOptions](../../types/interfaces/TransformersJsGenerateOptions.md). |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\nThe generated image(s), each PNG-encoded.\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR](../../exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR.md) when the call fails\nor returns no usable images.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L153)\n\nInstance availability probe (honours an injected `isAvailable`).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L158)\n\nEagerly loads (and caches) the model + processor so the first `generate` call is fast. Idempotent.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:163](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L163)\n\nDrops the cached model/processor and in-flight load so the next call reloads.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/adapter.ts:138](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/adapter.ts#L138)\n\nWhether this battery is available. transformers.js is environment-neutral (Node + browser), so\nthis is `true` whenever the runtime can import the peer — there is no WebGPU requirement.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions","title":"@nhtio/adk/batteries/generation/transformers\\_js/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/exceptions.md\ndescription: >-\n Battery-scoped exception constructors for the transformers.js Generation\n (on-device text→image) adapter.\n---\n\n# @nhtio/adk/batteries/generation/transformers\\_js/exceptions\n\nBattery-scoped exception constructors for the transformers.js Generation (on-device text→image)\nadapter.\n\n## Remarks\n\nBattery-scoped exception classes for the transformers.js (`@huggingface/transformers`) Generation\nadapter, minted via `createException` from `@nhtio/adk/factories`. Categories mirror the\nembeddings/caption transformers.js batteries' `E_INVALID_*`/`E_*_ENGINE_ERROR` pair, plus a third\n`E_*_UNSUPPORTED_OPERATION` exception (mirroring\n`@nhtio/adk/batteries/vector!E_VECTOR_STORE_UNSUPPORTED_OPERATION`'s `[operation, reason]` shape)\nfor `edit()`, which this engine cannot perform — Janus (DeepSeek `MultiModalityCausalLM`) only\nexposes text-conditioned `generate_images`, no image-conditioned edit/inpaint entry point.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS](variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `transformersJsGenerationOptionsSchema` — e.g. a missing/empty `model` or an unknown option key. Fatal: config bugs fail loud, not at generate time. |\n| [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR](variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR.md) | Thrown when the transformers.js model/processor fail to load (e.g. the `@huggingface/transformers` peer is not installed), the `generate_images` call throws, or the result is malformed/empty (no images returned is an engine failure, not a valid empty result). Non-fatal. Printf arg: `[detail]`. |\n| [E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION](variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md) | Thrown when a caller invokes an operation this engine does not support — today, only `edit()`. Janus (`MultiModalityCausalLM.generate_images`) is text-conditioned image generation only; there is no image-conditioned edit/inpaint entry point in the installed `@huggingface/transformers` API surface. Fatal: the caller must not retry an operation the engine structurally cannot perform. Printf args: `[operation, reason]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS","title":"Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `transformersJsGenerationOptionsSchema` — e.g. a missing/empty `model` or an\n unknown option key. Fatal: config bugs fail loud, not at generate time.\n---\n\n# Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS\n\n```ts\nconst E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/exceptions.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/exceptions.ts#L24)\n\nThrown when the resolved adapter options fail validation against\n`transformersJsGenerationOptionsSchema` — e.g. a missing/empty `model` or an unknown option key.\nFatal: config bugs fail loud, not at generate time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR","title":"Variable: E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR.md\ndescription: >-\n Thrown when the transformers.js model/processor fail to load (e.g. the\n `@huggingface/transformers` peer is not installed), the `generate_images` call\n throws, or the result is malformed/empty (no images returned is an engine\n failure, not a valid empty result). Non-fatal. Printf arg: `[detail]`.\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_GENERATION\\_ENGINE\\_ERROR\n\n```ts\nconst E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/exceptions.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/exceptions.ts#L37)\n\nThrown when the transformers.js model/processor fail to load (e.g. the `@huggingface/transformers`\npeer is not installed), the `generate_images` call throws, or the result is malformed/empty (no\nimages returned is an engine failure, not a valid empty result). Non-fatal. Printf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION","title":"Variable: E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION.md\ndescription: >-\n Thrown when a caller invokes an operation this engine does not support —\n today, only `edit()`. Janus (`MultiModalityCausalLM.generate_images`) is\n text-conditioned image generation only; there is no image-conditioned\n edit/inpaint entry point in the installed `@huggingface/transformers` API\n surface. Fatal: the caller must not retry an operation the engine structurally\n cannot perform. Printf args: `[operation, reason]`.\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_GENERATION\\_UNSUPPORTED\\_OPERATION\n\n```ts\nconst E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION: CreatedException<\n [string, string]\n>;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/exceptions.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/exceptions.ts#L52)\n\nThrown when a caller invokes an operation this engine does not support — today, only `edit()`.\nJanus (`MultiModalityCausalLM.generate_images`) is text-conditioned image generation only; there is\nno image-conditioned edit/inpaint entry point in the installed `@huggingface/transformers` API\nsurface. Fatal: the caller must not retry an operation the engine structurally cannot perform.\nPrintf args: `[operation, reason]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers","title":"@nhtio/adk/batteries/generation/transformers\\_js/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/helpers.md\ndescription: >-\n Env-branched PNG-encoding helper for transformers.js Generation's `RawImage`\n results.\n---\n\n# @nhtio/adk/batteries/generation/transformers\\_js/helpers\n\nEnv-branched PNG-encoding helper for transformers.js Generation's `RawImage` results.\n\n## Remarks\n\n`generate_images()` resolves an array of `RawImage` instances (raw decoded pixel data, not encoded\nbytes). Encoding those to PNG is environment-branched in the installed `@huggingface/transformers`\nsource (`src/utils/image.js`): browser/web-worker → `await img.toBlob('image/png')` (throws outside\na web env); Node/other → `img.toSharp().png().toBuffer()` (its `toSharp()` throws *inside* a web\nenv). Mirrors `RawImage.save()`'s own branch (`apis.IS_WEB_ENV` there) — but this module cannot\nimport `apis` itself: `@huggingface/transformers`'s package root only re-exports `env`/`LogLevel`\nfrom `env.js` (verified against `src/transformers.js`'s export list), not `apis`. A local,\nstructurally-equivalent environment check (`typeof window !== 'undefined' && typeof\nwindow.document !== 'undefined'`, matching `IS_BROWSER_ENV`'s own definition in `env.js`) stands in\nfor it, with a try/catch fallback to the other branch as a safety net for exotic runtimes (e.g. a\nweb worker, which has no `window` but is still a \"web env\" per `apis.IS_WEB_ENV`).\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------ | -------------------------------------------------------------------------------------------- |\n| [RawImageLike](interfaces/RawImageLike.md) | The exact `toBlob`/`toSharp` surface this helper reads off a resolved `RawImage`-like value. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------ |\n| [rawImageToEncodedBytes](functions/rawImageToEncodedBytes.md) | Encodes a resolved `RawImage`-like value to PNG bytes. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers/functions/rawImageToEncodedBytes","title":"Function: rawImageToEncodedBytes()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers/functions/rawImageToEncodedBytes.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers/functions/rawImageToEncodedBytes","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/helpers/functions/rawImageToEncodedBytes.md\n---\n\n# Function: rawImageToEncodedBytes()\n\n```ts\nfunction rawImageToEncodedBytes(\n image: RawImageLike,\n encodeImage?: (image: RawImageLike) => Promise>,\n): Promise>;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/helpers.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/helpers.ts#L57)\n\nEncodes a resolved `RawImage`-like value to PNG bytes.\n\n## Parameters\n\n| Parameter | Type | Description |\n| -------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |\n| `image` | [`RawImageLike`](../interfaces/RawImageLike.md) | The `RawImage`-like value to encode (one element of `generate_images()`'s result). |\n| `encodeImage?` | (`image`: [`RawImageLike`](../interfaces/RawImageLike.md)) => `Promise`<`Uint8Array`<`ArrayBufferLike`>> | Optional override that fully replaces the env-branch. |\n\n## Returns\n\n`Promise`<`Uint8Array`<`ArrayBufferLike`>>\n\nThe encoded PNG bytes.\n\n## Remarks\n\nWhen `encodeImage` is supplied it takes over entirely — the primary hermetic-test seam, since a\nfake `RawImage` double need not implement `toBlob`/`toSharp` at all. Otherwise this picks the\nbrowser (`toBlob`) or Node (`toSharp`) path by a local environment probe, falling back to whichever\nmethod is actually present on `image` if the probe disagrees with reality (e.g. a web worker with\nneither `window` nor `document`, but a `toBlob`-only `RawImage`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers/interfaces/RawImageLike","title":"Interface: RawImageLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers/interfaces/RawImageLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/helpers/interfaces/RawImageLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/helpers/interfaces/RawImageLike.md\ndescription: >-\n The exact `toBlob`/`toSharp` surface this helper reads off a resolved\n `RawImage`-like value.\n---\n\n# Interface: RawImageLike\n\nDefined in: [src/batteries/generation/transformers\\_js/helpers.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/helpers.ts#L25)\n\nThe exact `toBlob`/`toSharp` surface this helper reads off a resolved `RawImage`-like value.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `toBlob?` | (`type?`: `string`, `quality?`: `number`) => `Promise`<`Blob`> | Browser-only: encodes the image to a `Blob` of the given MIME type. Throws outside a web env. | [src/batteries/generation/transformers\\_js/helpers.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/helpers.ts#L27) |\n| `toSharp?` | () => { `png`: () => { `toBuffer`: () => `Promise`<`Buffer`<`ArrayBufferLike`>>; }; } | Node-only: wraps the raw pixel data in a `sharp.Sharp` instance. Throws inside a web env. | [src/batteries/generation/transformers\\_js/helpers.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/helpers.ts#L29) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types","title":"@nhtio/adk/batteries/generation/transformers\\_js/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types.md\ndescription: >-\n Option and model/processor seam types for the transformers.js (on-device\n Janus) Generation adapter.\n---\n\n# @nhtio/adk/batteries/generation/transformers\\_js/types\n\nOption and model/processor seam types for the transformers.js (on-device Janus) Generation\nadapter.\n\n## Remarks\n\nBuilds on the **shared** generation option base owned by the OpenAI Generation battery\n([@nhtio/adk/batteries/generation/openai/types!BaseGenerationAdapterOptions](../../openai/types/interfaces/BaseGenerationAdapterOptions.md)), mirroring the\ntransformers.js Embeddings/Caption batteries in shape: a lazily-imported, environment-neutral\n`@huggingface/transformers` peer, injectable model/processor factory seams, a `modelSource`\nresolver, and the shared lifecycle-hooks contract.\n\n**Engine (EXPERIMENTAL):** DeepSeek Janus (`onnx-community/Janus-Pro-1B-ONNX` et al.) via\n`MultiModalityCausalLM.generate_images()` — the *only* image-generation surface transformers.js\nexposes (there is no `pipeline('text-to-image')` task; verified against the installed\n`@huggingface/transformers` source, `src/models/multi_modality/modeling_multi_modality.js`).\n`MultiModalityCausalLM` and `VLChatProcessor` are both exported from the package root, but this\nmodule types them **structurally** (duck-typed local interfaces) rather than importing either as a\nvalue or a hard type — consistent with every other transformers.js battery in this codebase — so\nfake-model/fake-processor unit tests never load the real ~2GB peer.\n\n**Real, verified knobs only** (no invented options), cross-checked against three sources: the\ninstalled `GenerationConfig` defaults (`src/generation/configuration_utils.js`), the sampler's\nactual field reads (`src/generation/logits_sampler.js`, `_get_logits_processor` in\n`src/models/modeling_utils.js`), and the official `onnx-community/Janus-Pro-1B-ONNX` model-card\nusage example:\n\n* `doSample` → `do_sample` — gates greedy vs. multinomial sampling (`getSampler`); the model card's\n own example passes `do_sample: true` for image generation.\n* `temperature` → `temperature` — read by `TemperatureLogitsWarper` when `do_sample` is set\n (`modeling_utils.js` `_get_logits_processor`).\n* `topK` → `top_k` — read directly inside `MultinomialSampler.sample()` (`logits_sampler.js`), the\n sampler `generate_images` actually drives (top\\_p is NOT read there — the `TopPLogitsWarper` branch\n is dead/commented-out code in the installed build, so `top_p` is deliberately **not** exposed here).\n* `guidanceScale` → `guidance_scale` — read by `_get_logits_processor` to push a\n `ClassifierFreeGuidanceLogitsProcessor` (`generation_config.guidance_scale > 1`); Janus's own\n `prepare_inputs_for_generation` branches on it explicitly for the negative/unconditional prompt\n pass CFG requires.\n* `repetitionPenalty` → `repetition_penalty` — read by `_get_logits_processor`.\n* `numImageTokens`/`minNewTokens`/`maxNewTokens` → `min_new_tokens`/`max_new_tokens` — the model\n card's example passes both equal to `processor.num_image_tokens` (the fixed image-token budget);\n surfaced as an override so a caller need not special-case parsing `processor.num_image_tokens`.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [TransformersJsGenerateOptions](interfaces/TransformersJsGenerateOptions.md) | Per-call options accepted by [@nhtio/adk/batteries/generation/transformers\\_js/adapter!TransformersJsGenerationAdapter.generate](../adapter/classes/TransformersJsGenerationAdapter.md#generate). |\n| [TransformersJsGenerationAdapterOptions](interfaces/TransformersJsGenerationAdapterOptions.md) | Constructor options for [@nhtio/adk/batteries/generation/transformers\\_js/adapter!TransformersJsGenerationAdapter](../adapter/classes/TransformersJsGenerationAdapter.md). |\n| [TransformersJsGenerationModel](interfaces/TransformersJsGenerationModel.md) | Structural duck-type of `MultiModalityCausalLM` — exactly the one method this battery drives. Verified against the installed `@huggingface/transformers` source (`src/models/multi_modality/modeling_multi_modality.js`): `generate_images(options)` runs a normal causal-LM `generate()` internally, then decodes the newly generated image tokens into `RawImage[]` via the model's `image_decode` session. |\n| [TransformersJsGenerationProcessor](interfaces/TransformersJsGenerationProcessor.md) | Structural duck-type of `VLChatProcessor` (or `AutoProcessor.from_pretrained`'s resolved instance) — a callable that builds the `input_ids`/`attention_mask`/image-mask tensors `generate_images` expects, plus the model's fixed per-image token budget it exposes after construction. |\n| [TransformersJsRawImageLike](interfaces/TransformersJsRawImageLike.md) | Structural duck-type of the transformers.js `RawImage` values `generate_images()` resolves with: exactly what [@nhtio/adk/batteries/generation/transformers\\_js/helpers!rawImageToEncodedBytes](../helpers/functions/rawImageToEncodedBytes.md) reads off each result to encode PNG bytes (env-branched `toBlob`/`toSharp`). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CreateTransformersJsGenerationModel](type-aliases/CreateTransformersJsGenerationModel.md) | Factory for lazily creating the Janus model. Defaults to a dynamic import of `@huggingface/transformers` + `MultiModalityCausalLM.from_pretrained(model, …)`; override to inject a pre-built model or a test double. |\n| [CreateTransformersJsGenerationProcessor](type-aliases/CreateTransformersJsGenerationProcessor.md) | Factory for lazily creating the Janus chat/image processor. Defaults to a dynamic import of `@huggingface/transformers` + `AutoProcessor.from_pretrained(model, …)`; override to inject a pre-built processor or a test double. |\n| [EncodeRawImageFn](type-aliases/EncodeRawImageFn.md) | Test/runtime seam that overrides how a resolved `RawImage`-like value is encoded to PNG bytes, short-circuiting the env-branch (`toBlob`/`toSharp`) entirely. See [@nhtio/adk/batteries/generation/transformers\\_js/helpers!rawImageToEncodedBytes](../helpers/functions/rawImageToEncodedBytes.md). |\n| [TransformersJsGenerationDataType](type-aliases/TransformersJsGenerationDataType.md) | Quantization/precision dtype forwarded to `from_pretrained()` — a local alias, never a re-export of the externalized peer's `DataType`. |\n| [TransformersJsGenerationDeviceType](type-aliases/TransformersJsGenerationDeviceType.md) | Inference device forwarded to `from_pretrained()` — a local alias of the peer's `DeviceType`. |\n| [TransformersJsGenerationModelSource](type-aliases/TransformersJsGenerationModelSource.md) | Custom model-source resolver — the dual-environment seam for serving model files from OPFS, a different source, or bundled bytes (see the LLM battery's `model_source` module). Called once per file; return bytes / a path-or-URL string / a `Response`, or `undefined` to fall through to HF. |\n| [TransformersJsGenerationProgressCallback](type-aliases/TransformersJsGenerationProgressCallback.md) | Model-load progress callback — locally shaped, structurally compatible with the peer's `ProgressCallback`. |\n\n## References\n\n### BaseGenerationAdapterOptions\n\nRe-exports [BaseGenerationAdapterOptions](../../openai/types/interfaces/BaseGenerationAdapterOptions.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### EditOptions\n\nRe-exports [EditOptions](../../openai/types/interfaces/EditOptions.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GenerateOptions\n\nRe-exports [GenerateOptions](../../openai/types/interfaces/GenerateOptions.md)\n\n***\n\n### GenerationRetryConfig\n\nRe-exports [GenerationRetryConfig](../../openai/types/interfaces/GenerationRetryConfig.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerateOptions","title":"Interface: TransformersJsGenerateOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerateOptions.md\ndescription: >-\n Per-call options accepted by {@link\n @nhtio/adk/batteries/generation/transformers_js/adapter!TransformersJsGenerationAdapter.generate}.\n---\n\n# Interface: TransformersJsGenerateOptions\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:240](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L240)\n\nPer-call options accepted by\n[@nhtio/adk/batteries/generation/transformers\\_js/adapter!TransformersJsGenerationAdapter.generate](../../adapter/classes/TransformersJsGenerationAdapter.md#generate).\n\n## Remarks\n\nEvery field here overrides the adapter-level default of the same name when present. See the module\nremarks for the source-verified provenance of each knob (`do_sample`/`temperature`/`top_k`/\n`guidance_scale`/`repetition_penalty`/`min_new_tokens`/`max_new_tokens`).\n\n## Extends\n\n* [`GenerateOptions`](../../../openai/types/interfaces/GenerateOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `chatTemplate?` | `string` | Janus chat template name forwarded to the processor call (e.g. `'text_to_image'`). | - | [src/batteries/generation/transformers\\_js/types.ts:262](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L262) |\n| `doSample?` | `boolean` | Enables multinomial sampling (`do_sample`). The official model-card example sets this `true`. | - | [src/batteries/generation/transformers\\_js/types.ts:242](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L242) |\n| `guidanceScale?` | `number` | Classifier-free-guidance scale (`guidance_scale`); CFG activates when `> 1`. | - | [src/batteries/generation/transformers\\_js/types.ts:248](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L248) |\n| `maxNewTokens?` | `number` | Maximum new tokens (`max_new_tokens`). Defaults to the processor's `num_image_tokens` when omitted — mirroring the official model-card example. | - | [src/batteries/generation/transformers\\_js/types.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L260) |\n| `minNewTokens?` | `number` | Minimum new tokens (`min_new_tokens`). Defaults to the processor's `num_image_tokens` (the model's fixed per-image token budget) when omitted — mirroring the official model-card example. | - | [src/batteries/generation/transformers\\_js/types.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L255) |\n| `n?` | `number` | Number of images to generate. Engine-defaulted when omitted. | [`GenerateOptions`](../../../openai/types/interfaces/GenerateOptions.md).[`n`](../../../openai/types/interfaces/GenerateOptions.md#property-n) | [src/batteries/generation/openai/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/openai/types.ts#L47) |\n| `repetitionPenalty?` | `number` | Repetition penalty (`repetition_penalty`). | - | [src/batteries/generation/transformers\\_js/types.ts:250](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L250) |\n| `role?` | `string` | Conversation role used to build the single-turn prompt (Janus convention: `'< | User | >'`). | - | [src/batteries/generation/transformers\\_js/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L264) |\n| `temperature?` | `number` | Sampling temperature (`temperature`), applied only when `doSample` is truthy. | - | [src/batteries/generation/transformers\\_js/types.ts:244](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L244) |\n| `topK?` | `number` | Top-k cutoff (`top_k`), read directly by `MultinomialSampler.sample()`. | - | [src/batteries/generation/transformers\\_js/types.ts:246](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L246) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions","title":"Interface: TransformersJsGenerationAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions.md\ndescription: >-\n Constructor options for {@link\n @nhtio/adk/batteries/generation/transformers_js/adapter!TransformersJsGenerationAdapter}.\n---\n\n# Interface: TransformersJsGenerationAdapterOptions\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:178](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L178)\n\nConstructor options for [@nhtio/adk/batteries/generation/transformers\\_js/adapter!TransformersJsGenerationAdapter](../../adapter/classes/TransformersJsGenerationAdapter.md).\n\n## Remarks\n\nExtends [BaseGenerationAdapterOptions](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md) (required `model`, e.g.\n`onnx-community/Janus-Pro-1B-ONNX` — no default) with the transformers.js Janus knobs.\n\n**EXPERIMENTAL:** this engine downloads/runs a ~2GB multimodal model and takes minutes per image on\nWASM/CPU. There is no WebGPU requirement (transformers.js auto-selects the ONNX Runtime execution\nprovider), but expect this to be materially slower than the OpenAI/Gemini engines.\n\n## Extends\n\n* [`BaseGenerationAdapterOptions`](../../../openai/types/interfaces/BaseGenerationAdapterOptions.md).[`BatteryLifecycleHooks`](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L226) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L189) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L191) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L193) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L216) |\n| `dtype?` | `string` | Quantization/precision dtype forwarded to `from_pretrained()`. | - | [src/batteries/generation/transformers\\_js/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L195) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L211) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L222) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L205) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L185) |\n| `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.20260921.0/src/src/batteries/generation/openai/types.ts#L71) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L201) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L203) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L187) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L224) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L228) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L218) |\n| `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.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L220) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationModel","title":"Interface: TransformersJsGenerationModel","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationModel.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationModel","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationModel.md\ndescription: >-\n Structural duck-type of `MultiModalityCausalLM` — exactly the one method this\n battery drives. Verified against the installed `@huggingface/transformers`\n source (`src/models/multi_modality/modeling_multi_modality.js`):\n `generate_images(options)` runs a normal causal-LM `generate()` internally,\n then decodes the newly generated image tokens into `RawImage[]` via the\n model's `image_decode` session.\n---\n\n# Interface: TransformersJsGenerationModel\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L93)\n\nStructural duck-type of `MultiModalityCausalLM` — exactly the one method this battery drives.\nVerified against the installed `@huggingface/transformers` source\n(`src/models/multi_modality/modeling_multi_modality.js`): `generate_images(options)` runs a normal\ncausal-LM `generate()` internally, then decodes the newly generated image tokens into\n`RawImage[]` via the model's `image_decode` session.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `generate_images` | (`options`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>) => `Promise`<[`TransformersJsRawImageLike`](TransformersJsRawImageLike.md)\\[]> | Runs a normal causal-LM `generate()` internally, then decodes the newly generated image tokens into `RawImage[]` via the model's `image_decode` session. `options` is the merged processor-inputs + sampling-knobs bag this battery builds per call (see the adapter's `generate`). | [src/batteries/generation/transformers\\_js/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L99) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationProcessor","title":"Interface: TransformersJsGenerationProcessor()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationProcessor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationProcessor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsGenerationProcessor.md\ndescription: >-\n Structural duck-type of `VLChatProcessor` (or\n `AutoProcessor.from_pretrained`'s resolved instance) — a callable that builds\n the `input_ids`/`attention_mask`/image-mask tensors `generate_images` expects,\n plus the model's fixed per-image token budget it exposes after construction.\n---\n\n# Interface: TransformersJsGenerationProcessor()\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L114)\n\nStructural duck-type of `VLChatProcessor` (or `AutoProcessor.from_pretrained`'s resolved instance)\n— a callable that builds the `input_ids`/`attention_mask`/image-mask tensors `generate_images`\nexpects, plus the model's fixed per-image token budget it exposes after construction.\n\n## Remarks\n\nVerified against the installed `@huggingface/transformers` source\n(`src/models/janus/processing_janus.js`): `_call(conversation, { images, chat_template })` returns\n`{ input_ids, attention_mask, images_seq_mask, images_emb_mask, ... }`; `num_image_tokens` is read\noff `this.config.num_image_tokens` at construction (the fixed per-image token budget the official\nmodel-card example forwards as both `min_new_tokens` and `max_new_tokens`).\n\n```ts\nTransformersJsGenerationProcessor(conversation: {\n content: string;\n role: string;\n}[], options?: {\n chat_template?: string;\n}): Promise>;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L115)\n\nStructural duck-type of `VLChatProcessor` (or `AutoProcessor.from_pretrained`'s resolved instance)\n— a callable that builds the `input_ids`/`attention_mask`/image-mask tensors `generate_images`\nexpects, plus the model's fixed per-image token budget it exposes after construction.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------ | ---------------------------------------------- |\n| `conversation` | { `content`: `string`; `role`: `string`; }\\[] |\n| `options?` | { `chat_template?`: `string`; } |\n| `options.chat_template?` | `string` |\n\n## Returns\n\n`Promise`<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>>\n\n## Remarks\n\nVerified against the installed `@huggingface/transformers` source\n(`src/models/janus/processing_janus.js`): `_call(conversation, { images, chat_template })` returns\n`{ input_ids, attention_mask, images_seq_mask, images_emb_mask, ... }`; `num_image_tokens` is read\noff `this.config.num_image_tokens` at construction (the fixed per-image token budget the official\nmodel-card example forwards as both `min_new_tokens` and `max_new_tokens`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | -------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `num_image_tokens?` | `number` | The model's fixed per-image token budget (`config.num_image_tokens`). | [src/batteries/generation/transformers\\_js/types.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L120) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsRawImageLike","title":"Interface: TransformersJsRawImageLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsRawImageLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsRawImageLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/interfaces/TransformersJsRawImageLike.md\ndescription: >-\n Structural duck-type of the transformers.js `RawImage` values\n `generate_images()` resolves with: exactly what {@link\n @nhtio/adk/batteries/generation/transformers_js/helpers!rawImageToEncodedBytes}\n reads off each result to encode PNG bytes (env-branched `toBlob`/`toSharp`).\n---\n\n# Interface: TransformersJsRawImageLike\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L79)\n\nStructural duck-type of the transformers.js `RawImage` values `generate_images()` resolves with:\nexactly what [@nhtio/adk/batteries/generation/transformers\\_js/helpers!rawImageToEncodedBytes](../../helpers/functions/rawImageToEncodedBytes.md)\nreads off each result to encode PNG bytes (env-branched `toBlob`/`toSharp`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `toBlob?` | (`type?`: `string`, `quality?`: `number`) => `Promise`<`Blob`> | Browser-only: encodes the image to a `Blob` of the given MIME type. Throws outside a web env. | [src/batteries/generation/transformers\\_js/types.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L81) |\n| `toSharp?` | () => { `png`: () => { `toBuffer`: () => `Promise`<`Buffer`<`ArrayBufferLike`>>; }; } | Node-only: wraps the raw pixel data in a `sharp.Sharp` instance. Throws inside a web env. | [src/batteries/generation/transformers\\_js/types.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L83) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationModel","title":"Type Alias: CreateTransformersJsGenerationModel","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationModel.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationModel","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationModel.md\ndescription: >-\n Factory for lazily creating the Janus model. Defaults to a dynamic import of\n `@huggingface/transformers` + `MultiModalityCausalLM.from_pretrained(model,\n …)`; override to inject a pre-built model or a test double.\n---\n\n# Type Alias: CreateTransformersJsGenerationModel\n\n```ts\ntype CreateTransformersJsGenerationModel = (input: {\n device?: TransformersJsGenerationDeviceType;\n dtype?: TransformersJsGenerationDataType;\n model: string;\n onInitProgress?: TransformersJsGenerationProgressCallback;\n}) => Promise;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L143)\n\nFactory for lazily creating the Janus model. Defaults to a dynamic import of\n`@huggingface/transformers` + `MultiModalityCausalLM.from_pretrained(model, …)`; override to inject\na pre-built model or a test double.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `device?`: [`TransformersJsGenerationDeviceType`](TransformersJsGenerationDeviceType.md); `dtype?`: [`TransformersJsGenerationDataType`](TransformersJsGenerationDataType.md); `model`: `string`; `onInitProgress?`: [`TransformersJsGenerationProgressCallback`](TransformersJsGenerationProgressCallback.md); } |\n| `input.device?` | [`TransformersJsGenerationDeviceType`](TransformersJsGenerationDeviceType.md) |\n| `input.dtype?` | [`TransformersJsGenerationDataType`](TransformersJsGenerationDataType.md) |\n| `input.model` | `string` |\n| `input.onInitProgress?` | [`TransformersJsGenerationProgressCallback`](TransformersJsGenerationProgressCallback.md) |\n\n## Returns\n\n`Promise`<[`TransformersJsGenerationModel`](../interfaces/TransformersJsGenerationModel.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationProcessor","title":"Type Alias: CreateTransformersJsGenerationProcessor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationProcessor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationProcessor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/CreateTransformersJsGenerationProcessor.md\ndescription: >-\n Factory for lazily creating the Janus chat/image processor. Defaults to a\n dynamic import of `@huggingface/transformers` +\n `AutoProcessor.from_pretrained(model, …)`; override to inject a pre-built\n processor or a test double.\n---\n\n# Type Alias: CreateTransformersJsGenerationProcessor\n\n```ts\ntype CreateTransformersJsGenerationProcessor = (input: {\n model: string;\n onInitProgress?: TransformersJsGenerationProgressCallback;\n}) => Promise;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L155)\n\nFactory for lazily creating the Janus chat/image processor. Defaults to a dynamic import of\n`@huggingface/transformers` + `AutoProcessor.from_pretrained(model, …)`; override to inject a\npre-built processor or a test double.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `model`: `string`; `onInitProgress?`: [`TransformersJsGenerationProgressCallback`](TransformersJsGenerationProgressCallback.md); } |\n| `input.model` | `string` |\n| `input.onInitProgress?` | [`TransformersJsGenerationProgressCallback`](TransformersJsGenerationProgressCallback.md) |\n\n## Returns\n\n`Promise`<[`TransformersJsGenerationProcessor`](../interfaces/TransformersJsGenerationProcessor.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/EncodeRawImageFn","title":"Type Alias: EncodeRawImageFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/EncodeRawImageFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/EncodeRawImageFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/EncodeRawImageFn.md\ndescription: >-\n Test/runtime seam that overrides how a resolved `RawImage`-like value is\n encoded to PNG bytes, short-circuiting the env-branch (`toBlob`/`toSharp`)\n entirely. See {@link\n @nhtio/adk/batteries/generation/transformers_js/helpers!rawImageToEncodedBytes}.\n---\n\n# Type Alias: EncodeRawImageFn\n\n```ts\ntype EncodeRawImageFn = (\n image: TransformersJsRawImageLike,\n) => Promise;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L165)\n\nTest/runtime seam that overrides how a resolved `RawImage`-like value is encoded to PNG bytes,\nshort-circuiting the env-branch (`toBlob`/`toSharp`) entirely. See\n[@nhtio/adk/batteries/generation/transformers\\_js/helpers!rawImageToEncodedBytes](../../helpers/functions/rawImageToEncodedBytes.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------- |\n| `image` | [`TransformersJsRawImageLike`](../interfaces/TransformersJsRawImageLike.md) |\n\n## Returns\n\n`Promise`<`Uint8Array`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDataType","title":"Type Alias: TransformersJsGenerationDataType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDataType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDataType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDataType.md\ndescription: >-\n Quantization/precision dtype forwarded to `from_pretrained()` — a local alias,\n never a re-export of the externalized peer's `DataType`.\n---\n\n# Type Alias: TransformersJsGenerationDataType\n\n```ts\ntype TransformersJsGenerationDataType = string;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L68)\n\nQuantization/precision dtype forwarded to `from_pretrained()` — a local alias, never a re-export of the externalized peer's `DataType`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDeviceType","title":"Type Alias: TransformersJsGenerationDeviceType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDeviceType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDeviceType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationDeviceType.md\ndescription: >-\n Inference device forwarded to `from_pretrained()` — a local alias of the\n peer's `DeviceType`.\n---\n\n# Type Alias: TransformersJsGenerationDeviceType\n\n```ts\ntype TransformersJsGenerationDeviceType = string;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L70)\n\nInference device forwarded to `from_pretrained()` — a local alias of the peer's `DeviceType`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationModelSource","title":"Type Alias: TransformersJsGenerationModelSource","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationModelSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationModelSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationModelSource.md\ndescription: >-\n Custom model-source resolver — the dual-environment seam for serving model\n files from OPFS, a different source, or bundled bytes (see the LLM battery's\n `model_source` module). Called once per file; return bytes / a path-or-URL\n string / a `Response`, or `undefined` to fall through to HF.\n---\n\n# Type Alias: TransformersJsGenerationModelSource\n\n```ts\ntype TransformersJsGenerationModelSource = (req: {\n filename: string;\n repo: string;\n}) =>\n | Promise\n | Uint8Array\n | string\n | Response\n | undefined;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L128)\n\nCustom model-source resolver — the dual-environment seam for serving model files from OPFS, a\ndifferent source, or bundled bytes (see the LLM battery's `model_source` module). Called once per\nfile; return bytes / a path-or-URL string / a `Response`, or `undefined` to fall through to HF.\n\n## Parameters\n\n| Parameter | Type |\n| -------------- | --------------------------------------------- |\n| `req` | { `filename`: `string`; `repo`: `string`; } |\n| `req.filename` | `string` |\n| `req.repo` | `string` |\n\n## Returns\n\n| `Promise`<`Uint8Array` | `string` | `Response` | `undefined`>\n| `Uint8Array`\n| `string`\n| `Response`\n| `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationProgressCallback","title":"Type Alias: TransformersJsGenerationProgressCallback","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationProgressCallback.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationProgressCallback","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/types/type-aliases/TransformersJsGenerationProgressCallback.md\ndescription: >-\n Model-load progress callback — locally shaped, structurally compatible with\n the peer's `ProgressCallback`.\n---\n\n# Type Alias: TransformersJsGenerationProgressCallback\n\n```ts\ntype TransformersJsGenerationProgressCallback = (info: unknown) => void;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/types.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/types.ts#L72)\n\nModel-load progress callback — locally shaped, structurally compatible with the peer's `ProgressCallback`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `info` | `unknown` |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation","title":"@nhtio/adk/batteries/generation/transformers\\_js/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/validation.md\ndescription: >-\n Runtime validation schema and wrapper for transformers.js Generation adapter\n options.\n---\n\n# @nhtio/adk/batteries/generation/transformers\\_js/validation\n\nRuntime validation schema and wrapper for transformers.js Generation adapter options.\n\n## Remarks\n\nValidates `TransformersJsGenerationAdapterOptions` at construction time. Throws\n`E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS` on failure. `model` is required; unknown top-level\nkeys are rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |\n| [transformersJsGenerationOptionsSchema](variables/transformersJsGenerationOptionsSchema.md) | Validator schema for `TransformersJsGenerationAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ----------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `transformersJsGenerationOptionsSchema`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(\n input: unknown,\n): TransformersJsGenerationAdapterOptions;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/validation.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/validation.ts#L66)\n\nValidates an arbitrary input against `transformersJsGenerationOptionsSchema`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`TransformersJsGenerationAdapterOptions`](../../types/interfaces/TransformersJsGenerationAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_GENERATION\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS.md) when invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation/variables/transformersJsGenerationOptionsSchema","title":"Variable: transformersJsGenerationOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation/variables/transformersJsGenerationOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/generation/transformers_js/validation/variables/transformersJsGenerationOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/generation/transformers_js/validation/variables/transformersJsGenerationOptionsSchema.md\ndescription: >-\n Validator schema for `TransformersJsGenerationAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: transformersJsGenerationOptionsSchema\n\n```ts\nconst transformersJsGenerationOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/generation/transformers\\_js/validation.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/generation/transformers_js/validation.ts#L18)\n\nValidator schema for `TransformersJsGenerationAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserErrorEvent","title":"Interface: BrowserErrorEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserErrorEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserErrorEvent","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/BrowserErrorEvent.md'\ndescription: >-\n Minimal subset of the DOM `ErrorEvent` interface this module touches — fired\n on a `Worker` instance when an uncaught error escapes the worker's top-level\n scope.\n---\n\n# Interface: BrowserErrorEvent\n\nDefined in: [src/batteries/isolation/browser.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L36)\n\nMinimal subset of the DOM `ErrorEvent` interface this module touches — fired on a `Worker` instance\nwhen an uncaught error escapes the worker's top-level scope.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------------- | ---------- | -------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `message` | `readonly` | `string` | Human-readable error message. | [src/batteries/isolation/browser.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L38) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserMessageEvent","title":"Interface: BrowserMessageEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserMessageEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserMessageEvent","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/BrowserMessageEvent.md'\ndescription: Minimal subset of the DOM `MessageEvent` interface this module touches.\n---\n\n# Interface: BrowserMessageEvent\n\nDefined in: [src/batteries/isolation/browser.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L29)\n\nMinimal subset of the DOM `MessageEvent` interface this module touches.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------- | ---------- | --------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `data` | `readonly` | `unknown` | The message payload delivered via `postMessage`. | [src/batteries/isolation/browser.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L31) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserWorker","title":"Interface: BrowserWorker","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserWorker.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserWorker","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/BrowserWorker.md'\ndescription: >-\n Minimal subset of the DOM `Worker` interface this module touches. Structurally\n compatible with the real DOM `Worker` — callers (and [`WorkerResolver`](https://adk.nht.io/api/@nhtio/adk/batteries/type-aliases/WorkerResolver)\n implementations) pass/construct real `Worker` instances directly.\n---\n\n# Interface: BrowserWorker\n\nDefined in: [src/batteries/isolation/browser.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L60)\n\nMinimal subset of the DOM `Worker` interface this module touches. Structurally compatible with the\nreal DOM `Worker` — callers (and [WorkerResolver](../type-aliases/WorkerResolver.md) implementations) pass/construct real `Worker`\ninstances directly.\n\n## Methods\n\n### addEventListener()\n\n#### Call Signature\n\n```ts\naddEventListener(type: \"message\", listener: (ev: BrowserMessageEvent) => void): void;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L64)\n\nSubscribe to the worker's `'message'` event (fired on every `postMessage` received from the guest).\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | ----------------------------------------------------------------- |\n| `type` | `\"message\"` |\n| `listener` | (`ev`: [`BrowserMessageEvent`](BrowserMessageEvent.md)) => `void` |\n\n##### Returns\n\n`void`\n\n#### Call Signature\n\n```ts\naddEventListener(type: \"error\", listener: (ev: BrowserErrorEvent) => void): void;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L67)\n\nSubscribe to the worker's `'error'` event (fired when an uncaught error escapes the guest's\ntop-level scope).\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------------------------------------- |\n| `type` | `\"error\"` |\n| `listener` | (`ev`: [`BrowserErrorEvent`](BrowserErrorEvent.md)) => `void` |\n\n##### Returns\n\n`void`\n\n#### Call Signature\n\n```ts\naddEventListener(type: \"messageerror\", listener: (ev: BrowserMessageEvent) => void): void;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L70)\n\nSubscribe to the worker's `'messageerror'` event (fired when a received message could not be\ndeserialized).\n\n##### Parameters\n\n| Parameter | Type |\n| ---------- | ----------------------------------------------------------------- |\n| `type` | `\"messageerror\"` |\n| `listener` | (`ev`: [`BrowserMessageEvent`](BrowserMessageEvent.md)) => `void` |\n\n##### Returns\n\n`void`\n\n***\n\n### postMessage()\n\n```ts\npostMessage(message: unknown, transfer?: unknown[]): void;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L62)\n\nPost a message to the worker, optionally transferring ownership of listed transferables.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ----------- |\n| `message` | `unknown` |\n| `transfer?` | `unknown`\\[] |\n\n#### Returns\n\n`void`\n\n***\n\n### removeEventListener()\n\n```ts\nremoveEventListener(type: \"error\" | \"message\" | \"messageerror\", listener: (ev: never) => void): void;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L72)\n\nUnsubscribe a previously-added listener.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | -------------------------------------------- |\n| `type` | `\"error\"` | `\"message\"` | `\"messageerror\"` |\n| `listener` | (`ev`: `never`) => `void` |\n\n#### Returns\n\n`void`\n\n***\n\n### terminate()\n\n```ts\nterminate(): void;\n```\n\nDefined in: [src/batteries/isolation/browser.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L77)\n\nTerminate the worker immediately — no further events, no graceful shutdown at this layer.\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserWorkerOptions","title":"Interface: BrowserWorkerOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserWorkerOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/BrowserWorkerOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/BrowserWorkerOptions.md'\ndescription: >-\n Minimal subset of the DOM `WorkerOptions` dictionary this module forwards\n verbatim to\n---\n\n# Interface: BrowserWorkerOptions\n\nDefined in: [src/batteries/isolation/browser.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L48)\n\nMinimal subset of the DOM `WorkerOptions` dictionary this module forwards verbatim to `new\n Worker(url, options)` — used ONLY for the `string | URL` spawn form (a caller-supplied\n[WorkerResolver](../type-aliases/WorkerResolver.md) constructs its own `Worker` however it likes, this dictionary never applies\nthere). Classic scripts are the default (`type` omitted) — matching this repo's own LiteRT-LM Worker\nprototype (`docs/.vitepress/theme/components/agent/litert_lm_worker_proxy.ts`), which deliberately\navoids `{ type: 'module' }` because Emscripten-style glue calls `importScripts()`, illegal in a module\nworker. Pass `{ type: 'module' }` explicitly when the guest script is an ES module.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | ------------------------------------------ | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `credentials?` | `\"omit\"` | `\"include\"` | `\"same-origin\"` | Worker credentials mode, forwarded verbatim. | [src/batteries/isolation/browser.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L52) |\n| `name?` | `string` | A developer-facing name for the worker (surfaced in devtools). | [src/batteries/isolation/browser.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L54) |\n| `type?` | `\"classic\"` | `\"module\"` | `'classic'` (default when omitted) or `'module'`. | [src/batteries/isolation/browser.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L50) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ChatCompletionsRetryConfig","title":"Interface: ChatCompletionsRetryConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ChatCompletionsRetryConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ChatCompletionsRetryConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/ChatCompletionsRetryConfig.md\ndescription: Retry/backoff configuration for a Chat-family battery's HTTP requests.\n---\n\n# Interface: ChatCompletionsRetryConfig\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:481](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L481)\n\nRetry/backoff configuration for a Chat-family battery's HTTP requests.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | ---------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `baseDelayMs?` | `number` | Base delay in milliseconds for the first retry; doubles each attempt. | [src/batteries/llm/chat\\_common/types.ts:485](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L485) |\n| `honorRetryAfter?` | `boolean` | Whether to honour a server `Retry-After` header in place of computed backoff. | [src/batteries/llm/chat\\_common/types.ts:491](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L491) |\n| `maxAttempts?` | `number` | Maximum number of attempts (including the first) before giving up. | [src/batteries/llm/chat\\_common/types.ts:483](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L483) |\n| `maxDelayMs?` | `number` | Upper bound in milliseconds on any single backoff delay. | [src/batteries/llm/chat\\_common/types.ts:487](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L487) |\n| `retriableStatuses?` | `number`\\[] | HTTP status codes that trigger a retry. | [src/batteries/llm/chat\\_common/types.ts:489](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L489) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ChatCompletionsTool","title":"Interface: ChatCompletionsTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ChatCompletionsTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ChatCompletionsTool","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/ChatCompletionsTool.md'\ndescription: >-\n Wire shape of a single function tool advertised to the model — identical for\n OpenAI Chat Completions and Ollama.\n---\n\n# Interface: ChatCompletionsTool\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L251)\n\nWire shape of a single function tool advertised to the model — identical for OpenAI Chat\nCompletions and Ollama.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `function` | { `description?`: `string`; `name`: `string`; `parameters?`: [`JsonSchema`](JsonSchema.md); } | The function declaration: its name, description, and JSON-Schema parameters. | [src/batteries/llm/chat\\_common/types.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L255) |\n| `function.description?` | `string` | - | [src/batteries/llm/chat\\_common/types.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L257) |\n| `function.name` | `string` | - | [src/batteries/llm/chat\\_common/types.ts:256](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L256) |\n| `function.parameters?` | [`JsonSchema`](JsonSchema.md) | - | [src/batteries/llm/chat\\_common/types.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L258) |\n| `type` | `\"function\"` | Tool kind; always `'function'` for the bundled batteries. | [src/batteries/llm/chat\\_common/types.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L253) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashInfo","title":"Interface: CrashInfo","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashInfo.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashInfo","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/CrashInfo.md'\ndescription: >-\n Information about a crashed isolated guest, reported via\n `IsolationTransport.onCrash`.\n---\n\n# Interface: CrashInfo\n\nDefined in: [src/batteries/isolation/types.ts:321](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L321)\n\nInformation about a crashed isolated guest, reported via `IsolationTransport.onCrash`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------- | ------------------ | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `code?` | `number` | `null` | Process exit code, when known (child\\_process transports). | [src/batteries/isolation/types.ts:325](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L325) |\n| `reason` | `string` | Human-readable crash reason (exit signal, uncaught exception message, etc.). | [src/batteries/isolation/types.ts:323](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L323) |\n| `signal?` | `string` | `null` | Process exit signal, when known (child\\_process transports). | [src/batteries/isolation/types.ts:327](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L327) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashPolicy","title":"Interface: CrashPolicy","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashPolicy.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashPolicy","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/CrashPolicy.md'\ndescription: >-\n A sliding-window crash-escalation decider, as returned by {@link\n createCrashPolicy}.\n---\n\n# Interface: CrashPolicy\n\nDefined in: [src/batteries/isolation/crash\\_policy.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L35)\n\nA sliding-window crash-escalation decider, as returned by [createCrashPolicy](../functions/createCrashPolicy.md).\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | -------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `recentCount` | `readonly` | `number` | Number of crashes currently inside the window (observability/tests). | [src/batteries/isolation/crash\\_policy.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L44) |\n\n## Methods\n\n### record()\n\n```ts\nrecord(): CrashVerdict;\n```\n\nDefined in: [src/batteries/isolation/crash\\_policy.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L42)\n\nRecord a crash event and return the escalation verdict: `'respawn'` while the number of crashes\ninside the current window (including this one) is still under `maxCrashes`, `'giveUp'` once it\nreaches `maxCrashes`. Prunes crashes older than the window before deciding, so a crash burst that\ncools off resets the count.\n\n#### Returns\n\n[`CrashVerdict`](../type-aliases/CrashVerdict.md)\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/isolation/crash\\_policy.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L46)\n\nClear the crash history (e.g. after a clean recovery + a settled session).\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashPolicyOptions","title":"Interface: CrashPolicyOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashPolicyOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/CrashPolicyOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/CrashPolicyOptions.md'\ndescription: 'Options accepted by [`createCrashPolicy`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/createCrashPolicy).'\n---\n\n# Interface: CrashPolicyOptions\n\nDefined in: [src/batteries/isolation/crash\\_policy.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L25)\n\nOptions accepted by [createCrashPolicy](../functions/createCrashPolicy.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `maxCrashes?` | `number` | Crashes tolerated inside the window (inclusive) before `record()` returns `'giveUp'`. Default 3. | [src/batteries/isolation/crash\\_policy.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L29) |\n| `now?` | () => `number` | Injectable clock (for tests). Default `Date.now`. | [src/batteries/isolation/crash\\_policy.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L31) |\n| `windowMs?` | `number` | Sliding window, in ms; a crash older than this no longer counts toward escalation. Default 120\\_000. | [src/batteries/isolation/crash\\_policy.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/crash_policy.ts#L27) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/DescriptionLike","title":"Interface: DescriptionLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/DescriptionLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/DescriptionLike","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/DescriptionLike.md'\ndescription: >-\n Structural shape of a validator/Joi `describe()` output, as consumed by the\n JSON-Schema renderer. A loose superset — only the fields the renderer reads\n are typed; the index signature carries everything else through untouched.\n---\n\n# Interface: DescriptionLike\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L39)\n\nStructural shape of a validator/Joi `describe()` output, as consumed by the JSON-Schema\nrenderer. A loose superset — only the fields the renderer reads are typed; the index signature\ncarries everything else through untouched.\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\nPass-through for any other validator metadata the renderer does not read.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `default?` | `unknown` | Default value supplied when the field is absent. | [src/batteries/llm/chat\\_common/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L47) |\n| `description?` | `string` | Human-readable description of the field. | [src/batteries/llm/chat\\_common/types.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L43) |\n| `enum?` | `unknown`\\[] | Permitted values declared via an enum/valid set. | [src/batteries/llm/chat\\_common/types.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L49) |\n| `examples?` | `unknown`\\[] | Example values for the field. | [src/batteries/llm/chat\\_common/types.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L53) |\n| `flags?` | { `default?`: `unknown`; `description?`: `string`; `presence?`: `string`; } | Validator flags bag carrying presence, description, and default. | [src/batteries/llm/chat\\_common/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L61) |\n| `flags.default?` | `unknown` | - | [src/batteries/llm/chat\\_common/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L61) |\n| `flags.description?` | `string` | - | [src/batteries/llm/chat\\_common/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L61) |\n| `flags.presence?` | `string` | - | [src/batteries/llm/chat\\_common/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L61) |\n| `items?` | `DescriptionLike` | `DescriptionLike`\\[] | Element description(s) for array types. | [src/batteries/llm/chat\\_common/types.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L57) |\n| `presence?` | `string` | Presence flag (`'optional'`, `'required'`, or `'forbidden'`) at the top level. | [src/batteries/llm/chat\\_common/types.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L45) |\n| `properties?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `DescriptionLike`> | Nested property descriptions, keyed by property name (for object types). | [src/batteries/llm/chat\\_common/types.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L55) |\n| `required?` | `string`\\[] | Names of required properties (for object types). | [src/batteries/llm/chat\\_common/types.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L59) |\n| `type?` | `string` | Validator type name (e.g. `'string'`, `'object'`, `'array'`). | [src/batteries/llm/chat\\_common/types.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L41) |\n| `valids?` | `unknown`\\[] | Permitted values declared via the validator's `valid()` rule. | [src/batteries/llm/chat\\_common/types.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L51) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/EncoderModule","title":"Interface: EncoderModule","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/EncoderModule.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/EncoderModule","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/EncoderModule.md'\ndescription: >-\n The slice of `@nhtio/encoder`'s API surface this codec uses. Deliberately\n non-generic (`unknown` in, `unknown` out) — this codec always encodes/decodes\n values whose shape it cannot statically know, so the real encoder's ``-constrained signature is narrowed away via {@link\n defaultEncoderLoader}'s adapter rather than reflected here.\n---\n\n# Interface: EncoderModule\n\nDefined in: [src/batteries/isolation/codec.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L44)\n\nThe slice of `@nhtio/encoder`'s API surface this codec uses. Deliberately non-generic (`unknown` in,\n`unknown` out) — this codec always encodes/decodes values whose shape it cannot statically know, so\nthe real encoder's ``-constrained signature is narrowed away via\ndefaultEncoderLoader's adapter rather than reflected here.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `decode` | (`encoded`: `string`) => `unknown` | Decode a `@nhtio/encoder` wire string back into the original value. | [src/batteries/isolation/codec.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L48) |\n| `encode` | (`value`: `unknown`) => `string` | Encode an arbitrary value to its `@nhtio/encoder` wire string. | [src/batteries/isolation/codec.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L46) |\n| `isCustomEncodable` | (`value`: `unknown`) => `boolean` | Whether `value` is an instance of a class previously passed to `registerClass`. | [src/batteries/isolation/codec.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L52) |\n| `isError` | (`value`: `unknown`) => `boolean` | Whether `value` is an `Error` (or subclass), per the encoder's own classification. | [src/batteries/isolation/codec.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L54) |\n| `registerClass` | (`ctor`: { `name`: `string`; }) => `void` | Register a class as custom-encodable so `encode`/`decode` round-trip its instances. | [src/batteries/isolation/codec.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/codec.ts#L50) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/EventDescriptor","title":"Interface: EventDescriptor\\

","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/EventDescriptor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/EventDescriptor","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/EventDescriptor.md'\ndescription: >-\n An event descriptor produced by [`event`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/event). Phantom-typed like {@link\n MethodDescriptor}.\n---\n\n# Interface: EventDescriptor\\

\n\nDefined in: [src/batteries/isolation/types.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L92)\n\nAn event descriptor produced by [event](../functions/event.md). Phantom-typed like [MethodDescriptor](MethodDescriptor.md).\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| -------------- | ------------ |\n| `P` | `unknown` |\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| -------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |\n| `__payload?` | `readonly` | `P` | Phantom-only: never assigned a real value. Pins the event payload type. | [src/batteries/isolation/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L96) |\n| `kind` | `readonly` | `\"event\"` | Discriminant identifying this descriptor as an event (vs. a method or stream). | [src/batteries/isolation/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L94) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/GeneratedMediaOutput","title":"Interface: GeneratedMediaOutput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/GeneratedMediaOutput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/GeneratedMediaOutput","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/GeneratedMediaOutput.md'\ndescription: >-\n One piece of media a model GENERATED as turn output — the descriptor a {@link\n MediaOutputExtractorFn} returns for the adapter to persist + attach to the\n assistant {@link @nhtio/adk!Message}.\n---\n\n# Interface: GeneratedMediaOutput\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:304](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L304)\n\nOne piece of media a model GENERATED as turn output — the descriptor a\n[MediaOutputExtractorFn](../llm/transformers_js/type-aliases/MediaOutputExtractorFn.md) returns for the adapter to persist + attach to the assistant\n[@nhtio/adk!Message](../../common/classes/Message.md).\n\n## Remarks\n\nThe LLM batteries are multimodal-IN, text-OUT by default: the tested open-weight chat checkpoints\nemit only text, so no media output is produced unless a consumer wraps a media-emitting model AND\nsupplies an extractor. The framework contract already supports the output direction —\n`Message.attachments` is symmetric across roles and `ctx.storeMediaBytes` persists generated bytes —\nso this descriptor is all the adapter needs: it calls `storeMediaBytes` with `bytes`, builds a\n`Media.toolGenerated({ kind, mimeType, filename, reader })` from the returned reader, and attaches it.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | --------------------------------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The generated media bytes. | [src/batteries/llm/chat\\_common/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L310) |\n| `filename?` | `string` | Optional filename for the attachment; the adapter supplies a default when omitted. | [src/batteries/llm/chat\\_common/types.ts:312](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L312) |\n| `kind` | `\"document\"` | `\"audio\"` | `\"image\"` | `\"video\"` | Media modality (`'image'`/`'audio'`/`'video'`/`'document'`). | [src/batteries/llm/chat\\_common/types.ts:306](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L306) |\n| `mimeType` | `string` | Concrete MIME type of the generated bytes (e.g. `'audio/wav'`, `'image/png'`). | [src/batteries/llm/chat\\_common/types.ts:308](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L308) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/GuestEndpointHooks","title":"Interface: GuestEndpointHooks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/GuestEndpointHooks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/GuestEndpointHooks","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/GuestEndpointHooks.md'\ndescription: >-\n Hooks [`GuestEndpoint`](https://adk.nht.io/api/@nhtio/adk/batteries/classes/GuestEndpoint) invokes for the guest server (`serve.ts`) to react\n to.\n---\n\n# Interface: GuestEndpointHooks\n\nDefined in: [src/batteries/isolation/protocol.ts:407](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L407)\n\nHooks [GuestEndpoint](../classes/GuestEndpoint.md) invokes for the guest server (`serve.ts`) to react to.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `onCall?` | (`id`: `string`, `method`: `string`, `args`: [`WireValue`](../type-aliases/WireValue.md)\\[], `signal`: `AbortSignal`) => `void` | A `call` envelope arrived — resolve/reject `settle` with the method's outcome. | [src/batteries/isolation/protocol.ts:409](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L409) |\n| `onEnvelope?` | (`dir`: `\"in\"` | `\"out\"`, `envelope`: [`WireEnvelope`](../type-aliases/WireEnvelope.md)) => `void` | Any envelope was sent (`dir: 'out'`) or received (`dir: 'in'`) — for wire tracing. | [src/batteries/isolation/protocol.ts:424](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L424) |\n| `onHostResult?` | (`id`: `string`, `result`: | { `ok`: `true`; `value`: `string` | [`WireValue`](../type-aliases/WireValue.md); } | { `error?`: [`WireError`](WireError.md); `ok`: `false`; `value?`: `string`; }) => `void` | A host capability result arrived. | [src/batteries/isolation/protocol.ts:411](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L411) |\n| `onShutdown?` | () => `void` | A `shutdown` envelope arrived. | [src/batteries/isolation/protocol.ts:422](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L422) |\n| `onStreamCancel?` | (`id`: `string`, `reason?`: [`WireValue`](../type-aliases/WireValue.md)) => `void` | A `stream:cancel` envelope arrived for an open stream id. | [src/batteries/isolation/protocol.ts:420](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L420) |\n| `onStreamStart?` | (`id`: `string`, `stream`: `string`, `args`: [`WireValue`](../type-aliases/WireValue.md)\\[], `signal`: `AbortSignal`) => `void` | A `stream:start` envelope arrived — the handler pushes deltas via the returned sink. | [src/batteries/isolation/protocol.ts:418](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L418) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/HostEndpointHooks","title":"Interface: HostEndpointHooks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/HostEndpointHooks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/HostEndpointHooks","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/HostEndpointHooks.md'\ndescription: >-\n Callback surface for observing host-endpoint lifecycle and guest-originated\n events.\n---\n\n# Interface: HostEndpointHooks\n\nDefined in: [src/batteries/isolation/protocol.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L125)\n\nCallback surface for observing host-endpoint lifecycle and guest-originated events.\n\n## Remarks\n\nHooks are notifications only; dispatch and correlation remain owned by the endpoint.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `onEnvelope?` | (`dir`: `\"in\"` | `\"out\"`, `envelope`: [`WireEnvelope`](../type-aliases/WireEnvelope.md)) => `void` | Any envelope was sent (`dir: 'out'`) or received (`dir: 'in'`) — for wire tracing. | [src/batteries/isolation/protocol.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L133) |\n| `onEvent?` | (`channel`: `string`, `payload`: [`WireValue`](../type-aliases/WireValue.md)) => `void` | An `event` envelope arrived for `channel`. | [src/batteries/isolation/protocol.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L129) |\n| `onHostcall?` | (`id`: `string`, `method`: `string`, `args`: [`WireValue`](../type-aliases/WireValue.md)\\[]) => `void` | A guest-to-host capability request arrived. It is deliberately independent of `call`. | [src/batteries/isolation/protocol.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L131) |\n| `onReady?` | (`info`: { `encoderAvailable`: `boolean`; }) => `void` | The guest's `ready` envelope arrived. | [src/batteries/isolation/protocol.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L127) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedFunctionHandle","title":"Interface: IsolatedFunctionHandle\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedFunctionHandle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedFunctionHandle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolatedFunctionHandle.md\ndescription: 'The live handle returned by [`isolateFunction`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/isolateFunction).'\n---\n\n# Interface: IsolatedFunctionHandle\\\n\nDefined in: [src/batteries/isolation/isolate\\_function.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/isolate_function.ts#L133)\n\nThe live handle returned by [isolateFunction](../functions/isolateFunction.md).\n\n## Type Parameters\n\n| Type Parameter |\n| ------------------------- |\n| `A` *extends* `unknown`\\[] |\n| `R` |\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dispose` | () => `void` | Terminate the guest Worker and revoke its Blob URL. Every in-flight (and future) `invoke()` call rejects with @nhtio/adk/batteries/isolation!E\\_ISOLATED\\_TERMINATED. Idempotent. | [src/batteries/isolation/isolate\\_function.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/isolate_function.ts#L148) |\n| `invoke` | (...`args`: `A`) => `Promise`<`R`> | Invoke the isolated function with `args`, returning its result (or rejecting with whatever it threw/rejected with, reconstructed as a plain `Error`). Lazily spawns the guest Worker on the first call; subsequent calls reuse it. **Throws** [E\\_ISOLATE\\_FUNCTION\\_ARG\\_UNSUPPORTED](../variables/E_ISOLATE_FUNCTION_ARG_UNSUPPORTED.md) when an argument cannot cross into the guest. **Throws** @nhtio/adk/batteries/isolation!E\\_ISOLATION\\_UNSUPPORTED\\_ENV when no browser `Worker` global is present. **Throws** @nhtio/adk/batteries/isolation!E\\_ISOLATED\\_CRASHED when the guest has crashed. **Throws** @nhtio/adk/batteries/isolation!E\\_ISOLATED\\_TERMINATED after `dispose()`. | [src/batteries/isolation/isolate\\_function.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/isolate_function.ts#L145) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedService","title":"Interface: IsolatedService\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedService.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedService","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolatedService.md'\ndescription: The host-side handle `createIsolatedService` returns.\n---\n\n# Interface: IsolatedService\\\n\nDefined in: [src/batteries/isolation/host.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L69)\n\nThe host-side handle `createIsolatedService` returns.\n\n## Type Parameters\n\n| Type Parameter |\n| ------------------------------------------------------------- |\n| `S` *extends* [`IsolatedServiceSpec`](IsolatedServiceSpec.md) |\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------- | ---------- | ----------------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `api` | `readonly` | [`IsolatedFacade`](../type-aliases/IsolatedFacade.md)<`S`> | The callable facade — one function per declared method/stream. | [src/batteries/isolation/host.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L71) |\n| `state` | `readonly` | [`IsolatedServiceState`](../type-aliases/IsolatedServiceState.md) | Current lifecycle state. | [src/batteries/isolation/host.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L78) |\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/isolation/host.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L81)\n\nSend `shutdown`, wait up to `disposeGraceMs` for the guest to exit on its own, then force\n`transport.terminate()` regardless. Idempotent past the first call.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### on()\n\n```ts\non(channel: K, fn: IsolatedEventListener): () => void;\n```\n\nDefined in: [src/batteries/isolation/host.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L74)\n\nSubscribe to a declared event channel. Returns an unsubscribe function. Subscriptions survive\n`recycle()` (the same underlying map is reused across guest respawns).\n\n#### Type Parameters\n\n| Type Parameter |\n| ---------------------- |\n| `K` *extends* `string` |\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------------------- |\n| `channel` | `K` |\n| `fn` | [`IsolatedEventListener`](../type-aliases/IsolatedEventListener.md)<`S`, `K`> |\n\n#### Returns\n\n() => `void`\n\n***\n\n### onCrash()\n\n```ts\nonCrash(fn: (info: CrashInfo) => void): () => void;\n```\n\nDefined in: [src/batteries/isolation/host.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L76)\n\nSubscribe to crash notifications. Returns an unsubscribe function.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------- |\n| `fn` | (`info`: [`CrashInfo`](CrashInfo.md)) => `void` |\n\n#### Returns\n\n() => `void`\n\n***\n\n### recycle()\n\n```ts\nrecycle(): Promise;\n```\n\nDefined in: [src/batteries/isolation/host.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L84)\n\nTerminate the current guest and reconnect through the same `transport.connect()`. Object identity\nand `.on(...)` subscriptions survive; in-flight calls/streams reject with `E_ISOLATED_TERMINATED`.\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceOptions","title":"Interface: IsolatedServiceOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolatedServiceOptions.md\ndescription: 'Options accepted by [`createIsolatedService`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/createIsolatedService).'\n---\n\n# Interface: IsolatedServiceOptions\n\nDefined in: [src/batteries/isolation/host.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L45)\n\nOptions accepted by [createIsolatedService](../functions/createIsolatedService.md).\n\n## Extends\n\n* [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md)\n\n## Extended by\n\n* [`SpawnIsolatedOptions`](SpawnIsolatedOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `autoRespawn?` | { `policy`: [`CrashPolicy`](CrashPolicy.md); } | Opt-in automatic recovery: on a transport-reported crash, consult `policy.record()` and `recycle()` automatically when it returns `'respawn'`. Default: not set (crashes are surfaced, never auto-healed). | - | [src/batteries/isolation/host.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L54) |\n| `autoRespawn.policy` | [`CrashPolicy`](CrashPolicy.md) | - | - | [src/batteries/isolation/host.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L54) |\n| `debugPayloads?` | `boolean` | Include payload bodies on `call:*`/`wire:*` reports (see [IsolationReport.payload](IsolationReport.md#property-payload)). Default `false` — payloads may be large/sensitive, so this is opt-in even when hooks are wired. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`debugPayloads`](IsolationObservabilityHooks.md#property-debugpayloads) | [src/batteries/isolation/observability.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L135) |\n| `disposeGraceMs?` | `number` | Grace period `dispose()` gives the guest to exit cleanly after `shutdown` before forcing `transport.terminate()`. Default `2000`. | - | [src/batteries/isolation/host.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L51) |\n| `encodables?` | readonly { `name`: `string`; }\\[] | Classes to register with `@nhtio/encoder`'s custom-encodable round-trip on this side. | - | [src/batteries/isolation/host.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L56) |\n| `hostcallHandlers?` | `ReadonlyMap`<`string`, `HostcallHandler`> | Permitted guest-to-host capability handlers. | - | [src/batteries/isolation/host.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L58) |\n| `hostcallQuotas?` | `HostcallQuotas` | Resolved quotas enforced for guest-to-host calls. | - | [src/batteries/isolation/host.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L60) |\n| `maxHostcallBytes?` | `number` | Producer-side argument/result byte cap. | - | [src/batteries/isolation/host.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L62) |\n| `onAbort?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `abort:sent` — the host sent an `abort` envelope for an in-flight call. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onAbort`](IsolationObservabilityHooks.md#property-onabort) | [src/batteries/isolation/observability.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L128) |\n| `onCall?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `call:start` / `call:settle` — a single request/response method call. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onCall`](IsolationObservabilityHooks.md#property-oncall) | [src/batteries/isolation/observability.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L124) |\n| `onCodecEscalate?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `codec:escalate` — the codec escalated an argument past the `'raw'` tier. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onCodecEscalate`](IsolationObservabilityHooks.md#property-oncodecescalate) | [src/batteries/isolation/observability.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L132) |\n| `onCrashReport?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `crash` — the transport reported an unexpected guest exit/termination. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onCrashReport`](IsolationObservabilityHooks.md#property-oncrashreport) | [src/batteries/isolation/observability.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L120) |\n| `onDispose?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `dispose:start` / `dispose:done` — graceful-then-forced teardown. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onDispose`](IsolationObservabilityHooks.md#property-ondispose) | [src/batteries/isolation/observability.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L116) |\n| `onIsolation?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | Fires on EVERY report (the firehose). | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onIsolation`](IsolationObservabilityHooks.md#property-onisolation) | [src/batteries/isolation/observability.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L112) |\n| `onRecycle?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `recycle:start` / `recycle:done` — terminate + reconnect through the same transport. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onRecycle`](IsolationObservabilityHooks.md#property-onrecycle) | [src/batteries/isolation/observability.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L118) |\n| `onRespawnAuto?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `respawn:auto` — an `autoRespawn` crash-policy verdict was consulted and acted on. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onRespawnAuto`](IsolationObservabilityHooks.md#property-onrespawnauto) | [src/batteries/isolation/observability.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L122) |\n| `onSpawn?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `spawn:start` / `spawn:ready` / `spawn:error` — guest connect lifecycle. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onSpawn`](IsolationObservabilityHooks.md#property-onspawn) | [src/batteries/isolation/observability.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L114) |\n| `onStream?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `stream:start` / `stream:end` / `stream:error` / `stream:cancel` — a streaming method call. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onStream`](IsolationObservabilityHooks.md#property-onstream) | [src/batteries/isolation/observability.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L126) |\n| `onWire?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `wire:out` / `wire:in` — every envelope crossing the wire (verbose; opt in deliberately). | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onWire`](IsolationObservabilityHooks.md#property-onwire) | [src/batteries/isolation/observability.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L130) |\n| `readyTimeoutMs?` | `number` | Max time to wait for the guest's `ready` envelope after `transport.connect()` resolves. Default `30_000`. Rejects the pending `connect`/first call with `E_ISOLATION_READY_TIMEOUT`. | - | [src/batteries/isolation/host.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L48) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpec","title":"Interface: IsolatedServiceSpec\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpec.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpec","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpec.md'\ndescription: >-\n A fully-resolved isolated-service spec, as returned by {@link\n defineIsolatedService}. Consumed by both `createIsolatedService` (host.ts) and\n `serveIsolated` (serve.ts) to type-check the facade / implementation\n respectively, and read at runtime for wire validation (method/stream/event\n name lookups).\n---\n\n# Interface: IsolatedServiceSpec\\\n\nDefined in: [src/batteries/isolation/types.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L175)\n\nA fully-resolved isolated-service spec, as returned by [defineIsolatedService](../functions/defineIsolatedService.md). Consumed by\nboth `createIsolatedService` (host.ts) and `serveIsolated` (serve.ts) to type-check the facade /\nimplementation respectively, and read at runtime for wire validation (method/stream/event name\nlookups).\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| --------------------------------------------------------- | ------------------------------------------- |\n| `M` *extends* [`MethodMap`](../type-aliases/MethodMap.md) | [`MethodMap`](../type-aliases/MethodMap.md) |\n| `S` *extends* [`StreamMap`](../type-aliases/StreamMap.md) | [`StreamMap`](../type-aliases/StreamMap.md) |\n| `E` *extends* [`EventMap`](../type-aliases/EventMap.md) | [`EventMap`](../type-aliases/EventMap.md) |\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------------- | ---------- | -------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `events` | `readonly` | `E` | Unsolicited event-channel descriptors, keyed by name. | [src/batteries/isolation/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L187) |\n| `methods` | `readonly` | `M` | Request/response method descriptors, keyed by name. | [src/batteries/isolation/types.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L183) |\n| `name` | `readonly` | `string` | Identifies this service in error messages and observability reports. | [src/batteries/isolation/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L181) |\n| `streams` | `readonly` | `S` | Fire-and-forward streaming descriptors, keyed by name. | [src/batteries/isolation/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L185) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpecInput","title":"Interface: IsolatedServiceSpecInput\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpecInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpecInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolatedServiceSpecInput.md\ndescription: 'Input shape accepted by [`defineIsolatedService`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/defineIsolatedService).'\n---\n\n# Interface: IsolatedServiceSpecInput\\\n\nDefined in: [src/batteries/isolation/types.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L154)\n\nInput shape accepted by [defineIsolatedService](../functions/defineIsolatedService.md).\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| --------------------------------------------------------- | ------------------------------------------- |\n| `M` *extends* [`MethodMap`](../type-aliases/MethodMap.md) | [`MethodMap`](../type-aliases/MethodMap.md) |\n| `S` *extends* [`StreamMap`](../type-aliases/StreamMap.md) | [`StreamMap`](../type-aliases/StreamMap.md) |\n| `E` *extends* [`EventMap`](../type-aliases/EventMap.md) | [`EventMap`](../type-aliases/EventMap.md) |\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | -------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `events?` | `E` | Unsolicited event channels, keyed by name. Default `{}`. | [src/batteries/isolation/types.ts:166](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L166) |\n| `methods?` | `M` | Request/response methods, keyed by name. Default `{}`. | [src/batteries/isolation/types.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L162) |\n| `name` | `string` | Used in error messages and observability reports to identify this service. | [src/batteries/isolation/types.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L160) |\n| `streams?` | `S` | Fire-and-forward streaming methods, keyed by name. Default `{}`. | [src/batteries/isolation/types.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L164) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolateFunctionOptions","title":"Interface: IsolateFunctionOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolateFunctionOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolateFunctionOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolateFunctionOptions.md\ndescription: 'Options accepted by [`isolateFunction`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/isolateFunction).'\n---\n\n# Interface: IsolateFunctionOptions\n\nDefined in: [src/batteries/isolation/isolate\\_function.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/isolate_function.ts#L123)\n\nOptions accepted by [isolateFunction](../functions/isolateFunction.md).\n\n## Remarks\n\n`allowSourceRehydration` MUST be the literal `true` — both at the type level (a widened `boolean`\nfails to type-check) and at runtime (checked explicitly, so an untyped/`as any` call site cannot skip\nthe acknowledgement). See this module's doc comment for what that acknowledgement means.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `allowSourceRehydration` | `true` | Explicit, non-optional acknowledgement that this function's source will be rehydrated via `new Function` inside a Worker — an eval-equivalent trust surface. Must be the literal `true`. | [src/batteries/isolation/isolate\\_function.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/isolate_function.ts#L126) |\n| `name?` | `string` | A developer-facing name, used in thrown exception messages and the Worker's `name` option. Defaults to `fn.name` (or `'anonymous'` when the function itself has no name). | [src/batteries/isolation/isolate\\_function.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/isolate_function.ts#L129) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationCallContext","title":"Interface: IsolationCallContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationCallContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationCallContext","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolationCallContext.md'\ndescription: >-\n Trailing parameter a guest method implementation receives when its descriptor\n declared `{ signal: true }`. Carries the {@link AbortSignal} the host aborts\n to cancel this in-flight call.\n---\n\n# Interface: IsolationCallContext\n\nDefined in: [src/batteries/isolation/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L217)\n\nTrailing parameter a guest method implementation receives when its descriptor declared\n`{ signal: true }`. Carries the AbortSignal the host aborts to cancel this in-flight call.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | ------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `signal` | `AbortSignal` | Aborts when the host sends an `abort` envelope for this call's id. | [src/batteries/isolation/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L219) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationObservabilityHooks","title":"Interface: IsolationObservabilityHooks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationObservabilityHooks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationObservabilityHooks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolationObservabilityHooks.md\ndescription: >-\n The opt-in observability option block mixed into\n `createIsolatedService`/`serveIsolated` options. Every reported phase fires\n {@link onIsolation} (the firehose) AND its matching per-phase-group hook;\n subscribe to either or both. All optional — omitting them leaves behavior\n byte-for-byte unchanged.\n---\n\n# Interface: IsolationObservabilityHooks\n\nDefined in: [src/batteries/isolation/observability.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L110)\n\nThe opt-in observability option block mixed into `createIsolatedService`/`serveIsolated` options.\nEvery reported phase fires [onIsolation](#property-onisolation) (the firehose) AND its matching per-phase-group hook;\nsubscribe to either or both. All optional — omitting them leaves behavior byte-for-byte unchanged.\n\n## Extended by\n\n* [`ServeIsolatedOptions`](ServeIsolatedOptions.md)\n* [`IsolatedServiceOptions`](IsolatedServiceOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `debugPayloads?` | `boolean` | Include payload bodies on `call:*`/`wire:*` reports (see [IsolationReport.payload](IsolationReport.md#property-payload)). Default `false` — payloads may be large/sensitive, so this is opt-in even when hooks are wired. | [src/batteries/isolation/observability.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L135) |\n| `onAbort?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `abort:sent` — the host sent an `abort` envelope for an in-flight call. | [src/batteries/isolation/observability.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L128) |\n| `onCall?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `call:start` / `call:settle` — a single request/response method call. | [src/batteries/isolation/observability.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L124) |\n| `onCodecEscalate?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `codec:escalate` — the codec escalated an argument past the `'raw'` tier. | [src/batteries/isolation/observability.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L132) |\n| `onCrashReport?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `crash` — the transport reported an unexpected guest exit/termination. | [src/batteries/isolation/observability.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L120) |\n| `onDispose?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `dispose:start` / `dispose:done` — graceful-then-forced teardown. | [src/batteries/isolation/observability.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L116) |\n| `onIsolation?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | Fires on EVERY report (the firehose). | [src/batteries/isolation/observability.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L112) |\n| `onRecycle?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `recycle:start` / `recycle:done` — terminate + reconnect through the same transport. | [src/batteries/isolation/observability.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L118) |\n| `onRespawnAuto?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `respawn:auto` — an `autoRespawn` crash-policy verdict was consulted and acted on. | [src/batteries/isolation/observability.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L122) |\n| `onSpawn?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `spawn:start` / `spawn:ready` / `spawn:error` — guest connect lifecycle. | [src/batteries/isolation/observability.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L114) |\n| `onStream?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `stream:start` / `stream:end` / `stream:error` / `stream:cancel` — a streaming method call. | [src/batteries/isolation/observability.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L126) |\n| `onWire?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `wire:out` / `wire:in` — every envelope crossing the wire (verbose; opt in deliberately). | [src/batteries/isolation/observability.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L130) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationReport","title":"Interface: IsolationReport","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationReport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationReport","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolationReport.md'\ndescription: >-\n A single normalized isolation observability report. Every phase stamps\n `phase`/`at`/`spawnCount` plus its own extra fields (see the per-phase hook\n docs on [`IsolationObservabilityHooks`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolationObservabilityHooks) for which extra fields a given\n `phase` populates).\n---\n\n# Interface: IsolationReport\n\nDefined in: [src/batteries/isolation/observability.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L44)\n\nA single normalized isolation observability report. Every phase stamps `phase`/`at`/`spawnCount` plus\nits own extra fields (see the per-phase hook docs on [IsolationObservabilityHooks](IsolationObservabilityHooks.md) for which\nextra fields a given `phase` populates).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `approxBytes?` | `number` | `wire:out` / `wire:in` — a cheap `JSON.stringify(...).length`-style size estimate; computed ONLY when a wire hook is registered (see [emitIsolationReport](../functions/emitIsolationReport.md)). | [src/batteries/isolation/observability.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L93) |\n| `argPath?` | `string` | `codec:escalate` — the argument path that needed to escalate past the `'raw'` tier. | [src/batteries/isolation/observability.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L95) |\n| `at` | `string` | ISO-8601 timestamp stamped when the report was emitted. | [src/batteries/isolation/observability.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L48) |\n| `bootMs?` | `number` | `spawn:ready` — time from `connect()` call to the `ready` envelope, in ms. | [src/batteries/isolation/observability.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L54) |\n| `code?` | `number` | `null` | `crash` — process exit code, when known. | [src/batteries/isolation/observability.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L62) |\n| `deltaCount?` | `number` | `stream:end` / `stream:cancel` — total deltas observed before end/cancel. | [src/batteries/isolation/observability.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L82) |\n| `durationMs?` | `number` | `call:settle` — wall-clock duration of the call, in ms. | [src/batteries/isolation/observability.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L74) |\n| `error?` | `unknown` | `spawn:error` / `crash` — the underlying error/reason. | [src/batteries/isolation/observability.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L56) |\n| `errorMessage?` | `string` | `call:settle` (when `ok` is `false`) — the rejection's message. | [src/batteries/isolation/observability.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L78) |\n| `escalateReason?` | `string` | `codec:escalate` — why it escalated (e.g. `'function'`, `'error'`, `'custom-encodable'`). | [src/batteries/isolation/observability.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L97) |\n| `firstDeltaMs?` | `number` | `stream:end` — ms from `stream:start` to the first delta (`undefined` if none arrived). | [src/batteries/isolation/observability.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L84) |\n| `forced?` | `boolean` | `dispose:done` — `true` when the grace period elapsed and `transport.terminate()` was forced. | [src/batteries/isolation/observability.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L58) |\n| `id?` | `string` | `call:start` / `call:settle` — the correlation id. | [src/batteries/isolation/observability.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L72) |\n| `inFlight?` | `number` | `crash` — number of calls that were in flight (and rejected) at the moment of the crash. | [src/batteries/isolation/observability.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L66) |\n| `kind?` | `string` | `wire:out` / `wire:in` — the envelope's discriminant (`'call'`, `'result'`, `'stream:delta'`, …). | [src/batteries/isolation/observability.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L88) |\n| `method?` | `string` | `call:start` / `call:settle` — the method name. | [src/batteries/isolation/observability.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L70) |\n| `ok?` | `boolean` | `call:settle` — `true` when the call resolved; `false` when it rejected. | [src/batteries/isolation/observability.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L76) |\n| `payload?` | `unknown` | With `debugPayloads: true` on a `call:*`/`wire:*` report — the raw payload body. | [src/batteries/isolation/observability.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L99) |\n| `phase` | [`IsolationReportPhase`](../type-aliases/IsolationReportPhase.md) | The phase this report describes. | [src/batteries/isolation/observability.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L46) |\n| `reason?` | `string` | `crash` — the transport-reported crash reason. | [src/batteries/isolation/observability.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L60) |\n| `serviceName?` | `string` | The service's `name` (from its spec), when available. | [src/batteries/isolation/observability.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L50) |\n| `signal?` | `string` | `null` | `crash` — process exit signal, when known. | [src/batteries/isolation/observability.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L64) |\n| `spawnCount` | `number` | How many times this service's guest has been (re)spawned, including the current spawn. | [src/batteries/isolation/observability.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L52) |\n| `streamError?` | `unknown` | `stream:error` — the stream's terminal error. | [src/batteries/isolation/observability.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L86) |\n| `streamName?` | `string` | `stream:start` / `stream:end` / `stream:error` / `stream:cancel` — the stream name. | [src/batteries/isolation/observability.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L80) |\n| `tier?` | `string` | `wire:out` / `wire:in` — which codec tier carried the payload (`'raw'` or `'nhtio'`), when known. | [src/batteries/isolation/observability.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L90) |\n| `verdict?` | `\"respawn\"` | `\"giveUp\"` | `respawn:auto` — the crash-policy verdict that was consulted. | [src/batteries/isolation/observability.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L68) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationTransport","title":"Interface: IsolationTransport","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationTransport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/IsolationTransport","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolationTransport.md'\ndescription: >-\n The environment-specific spawn/lifecycle duck a host-side transport implements\n — the Web Worker and Node child_process transports each provide one;\n `createIsolatedService` (host.ts) drives only this interface, never a concrete\n Worker/ChildProcess type.\n---\n\n# Interface: IsolationTransport\n\nDefined in: [src/batteries/isolation/types.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L335)\n\nThe environment-specific spawn/lifecycle duck a host-side transport implements — the Web Worker\nand Node child\\_process transports each provide one; `createIsolatedService` (host.ts) drives only this\ninterface, never a concrete Worker/ChildProcess type.\n\n## Methods\n\n### connect()\n\n```ts\nconnect(): Promise;\n```\n\nDefined in: [src/batteries/isolation/types.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L337)\n\nSpawn (or reuse) the guest and resolve once a [PortLike](PortLike.md) is ready to exchange envelopes.\n\n#### Returns\n\n`Promise`<[`PortLike`](PortLike.md)>\n\n***\n\n### onCrash()\n\n```ts\nonCrash(fn: (info: CrashInfo) => void): () => void;\n```\n\nDefined in: [src/batteries/isolation/types.ts:341](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L341)\n\nSubscribe to crash notifications (unexpected exit/termination). Returns an unsubscribe function.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------- |\n| `fn` | (`info`: [`CrashInfo`](CrashInfo.md)) => `void` |\n\n#### Returns\n\n() => `void`\n\n***\n\n### terminate()\n\n```ts\nterminate(): void | Promise;\n```\n\nDefined in: [src/batteries/isolation/types.ts:339](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L339)\n\nTear down the guest unconditionally (kill/terminate). May be sync or async.\n\n#### Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/JsonSchema","title":"Interface: JsonSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/JsonSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/JsonSchema","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/JsonSchema.md'\ndescription: >-\n The subset of JSON Schema that Chat-family tool/function `parameters` accept,\n as emitted by {@link\n ChatHelpersCommon.descriptionToChatCompletionsJsonSchema}. The index signature\n allows extra keywords to pass through to the wire.\n---\n\n# Interface: JsonSchema\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L73)\n\nThe subset of JSON Schema that Chat-family tool/function `parameters` accept, as emitted by\n[ChatHelpersCommon.descriptionToChatCompletionsJsonSchema](../llm/openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema). The index signature allows\nextra keywords to pass through to the wire.\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\nPass-through for any other JSON Schema keyword.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `additionalProperties?` | `boolean` | `JsonSchema` | Whether (or what schema) additional, undeclared properties are permitted. | [src/batteries/llm/chat\\_common/types.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L91) |\n| `default?` | `unknown` | Default value for the node. | [src/batteries/llm/chat\\_common/types.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L81) |\n| `description?` | `string` | Human-readable description of the schema node. | [src/batteries/llm/chat\\_common/types.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L77) |\n| `enum?` | `unknown`\\[] | Permitted values for the node. | [src/batteries/llm/chat\\_common/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L79) |\n| `examples?` | `unknown`\\[] | Example values for the node. | [src/batteries/llm/chat\\_common/types.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L83) |\n| `items?` | `JsonSchema` | `JsonSchema`\\[] | Element schema(s) for `array` types. | [src/batteries/llm/chat\\_common/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L89) |\n| `properties?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `JsonSchema`> | Property schemas keyed by property name (for `object` types). | [src/batteries/llm/chat\\_common/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L85) |\n| `required?` | `string`\\[] | Names of required properties (for `object` types). | [src/batteries/llm/chat\\_common/types.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L87) |\n| `type?` | `\"string\"` | `\"number\"` | `\"boolean\"` | `\"object\"` | `\"array\"` | `\"integer\"` | `\"null\"` | JSON Schema primitive/compound type. | [src/batteries/llm/chat\\_common/types.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L75) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MemoryAttrs","title":"Interface: MemoryAttrs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MemoryAttrs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MemoryAttrs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/MemoryAttrs.md'\ndescription: Attribute bag rendered onto a memory block.\n---\n\n# Interface: MemoryAttrs\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L159)\n\nAttribute bag rendered onto a memory block.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAt?` | `string` | ISO-8601 creation timestamp of the memory. | [src/batteries/llm/chat\\_common/types.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L173) |\n| `kind?` | `string` | Memory classifier. | [src/batteries/llm/chat\\_common/types.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L175) |\n| `nonce` | `string` | Nonce binding the block's open and close markers together — it becomes part of the tag NAME (`<..._>`) so a model mirroring the block cannot forge a sibling's closer. FOOTGUN: this nonce MUST be unguessable AND non-path-shaped. It is typically the source record's id; a path-shaped id (e.g. `chunk-assembly-events-9`) is copied by small models as a CITATION (`/assembly/events-9`), which a doc-path validator then rejects → re-cite loop. Mint record ids with `crypto.randomUUID()`; carry page/human provenance in `source=` (rendered before `nonce=`), never in the id. | [src/batteries/llm/chat\\_common/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L169) |\n| `score?` | `number` | Relevance/recall score, when the memory was retrieved by similarity. | [src/batteries/llm/chat\\_common/types.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L177) |\n| `source?` | `string` | Origin of the memory (e.g. the producing subsystem). | [src/batteries/llm/chat\\_common/types.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L171) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MethodDescriptor","title":"Interface: MethodDescriptor\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MethodDescriptor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MethodDescriptor","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/MethodDescriptor.md'\ndescription: >-\n A method descriptor produced by [`method`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/method). Carries the declared runtime\n options plus phantom (never-constructed) fields that pin down the argument\n tuple and return type for the mapped types below — reading\n `descriptor.__args`/`descriptor.__result` at the TYPE level only, never at\n runtime.\n---\n\n# Interface: MethodDescriptor\\\n\nDefined in: [src/batteries/isolation/types.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L66)\n\nA method descriptor produced by [method](../functions/method.md). Carries the declared runtime options plus phantom\n(never-constructed) fields that pin down the argument tuple and return type for the mapped types\nbelow — reading `descriptor.__args`/`descriptor.__result` at the TYPE level only, never at runtime.\n\n## Extends\n\n* [`MethodOptions`](MethodOptions.md)\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ------------------------- | ------------ |\n| `A` *extends* `unknown`\\[] | `unknown`\\[] |\n| `R` | `unknown` |\n\n## Properties\n\n| Property | Modifier | Type | Description | Inherited from | Defined in |\n| ------------------------------------------ | ---------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `__args?` | `readonly` | `A` | Phantom-only: never assigned a real value. Pins the argument tuple type. | - | [src/batteries/isolation/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L73) |\n| `__result?` | `readonly` | `R` | Phantom-only: never assigned a real value. Pins the resolved result type. | - | [src/batteries/isolation/types.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L75) |\n| `codec?` | `public` | [`CodecMode`](../type-aliases/CodecMode.md) | Override the codec tier for this method's arguments and return value. Default: `'auto'`. | [`MethodOptions`](MethodOptions.md).[`codec`](MethodOptions.md#property-codec) | [src/batteries/isolation/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L52) |\n| `kind` | `readonly` | `\"method\"` | Discriminant identifying this descriptor as a method (vs. a stream or event). | - | [src/batteries/isolation/types.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L71) |\n| `signal?` | `public` | `boolean` | When `true`, the facade's generated method accepts a trailing `AbortSignal` and the guest implementation receives a trailing [IsolationCallContext](IsolationCallContext.md) carrying that signal. When omitted/`false`, a trailing signal argument is still accepted on the facade (for call-site uniformity) but is not forwarded anywhere meaningful — the implementation is never given a context parameter. | [`MethodOptions`](MethodOptions.md).[`signal`](MethodOptions.md#property-signal) | [src/batteries/isolation/types.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L50) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MethodOptions","title":"Interface: MethodOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MethodOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/MethodOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/MethodOptions.md'\ndescription: 'Runtime options accepted by [`method`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/method).'\n---\n\n# Interface: MethodOptions\n\nDefined in: [src/batteries/isolation/types.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L42)\n\nRuntime options accepted by [method](../functions/method.md).\n\n## Extended by\n\n* [`MethodDescriptor`](MethodDescriptor.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `codec?` | [`CodecMode`](../type-aliases/CodecMode.md) | Override the codec tier for this method's arguments and return value. Default: `'auto'`. | [src/batteries/isolation/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L52) |\n| `signal?` | `boolean` | When `true`, the facade's generated method accepts a trailing `AbortSignal` and the guest implementation receives a trailing [IsolationCallContext](IsolationCallContext.md) carrying that signal. When omitted/`false`, a trailing signal argument is still accepted on the facade (for call-site uniformity) but is not forwarded anywhere meaningful — the implementation is never given a context parameter. | [src/batteries/isolation/types.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L50) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/PortLike","title":"Interface: PortLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/PortLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/PortLike","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/PortLike.md'\ndescription: >-\n The minimal message-passing duck the wire protocol (`protocol.ts`) is built\n over. A `Worker` / `MessagePort` (`post` = `postMessage`, `onMessage` wraps\n `addEventListener('message', ...)`) and a Node `ChildProcess` / `process`\n (`post` = `.send`, `onMessage` wraps `.on('message', ...)`) both satisfy this\n structurally — the shared protocol is exercised against linked in-memory fake\n ports; the browser and Node transports wire it to the real transports.\n---\n\n# Interface: PortLike\n\nDefined in: [src/batteries/isolation/types.ts:313](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L313)\n\nThe minimal message-passing duck the wire protocol (`protocol.ts`) is built over. A `Worker` /\n`MessagePort` (`post` = `postMessage`, `onMessage` wraps `addEventListener('message', ...)`) and a\nNode `ChildProcess` / `process` (`post` = `.send`, `onMessage` wraps `.on('message', ...)`) both\nsatisfy this structurally — the shared protocol is exercised against linked in-memory fake ports; the\nbrowser and Node transports wire it to the real transports.\n\n## Methods\n\n### onMessage()\n\n```ts\nonMessage(fn: (msg: unknown) => void): () => void;\n```\n\nDefined in: [src/batteries/isolation/types.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L317)\n\nSubscribe to inbound messages. Returns an unsubscribe function.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------------------------- |\n| `fn` | (`msg`: `unknown`) => `void` |\n\n#### Returns\n\n() => `void`\n\n***\n\n### post()\n\n```ts\npost(msg: unknown): void;\n```\n\nDefined in: [src/batteries/isolation/types.ts:315](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L315)\n\nSend a message across the port. Fire-and-forget — no delivery confirmation at this layer.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `msg` | `unknown` |\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/PromptAssembledObservation","title":"Interface: PromptAssembledObservation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/PromptAssembledObservation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/PromptAssembledObservation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/PromptAssembledObservation.md\ndescription: >-\n One observation of the fully-assembled request a battery is about to send TO\n the model, fired the instant assembly completes and BEFORE the engine/HTTP\n dispatch. It is the mirror of [`RawGenerationObservation`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/RawGenerationObservation): that seam\n exposes the raw text coming back FROM the model; this one exposes the raw\n request going TO it. Together they let you read ground truth at both ends of\n the wire — e.g. to settle whether a \"smart quote\" in a rendered answer came\n from the model itself or from a downstream markdown renderer, you inspect the\n bytes here, not the DOM.\n---\n\n# Interface: PromptAssembledObservation\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:401](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L401)\n\nOne observation of the fully-assembled request a battery is about to send TO the model, fired the\ninstant assembly completes and BEFORE the engine/HTTP dispatch. It is the mirror of\n[RawGenerationObservation](RawGenerationObservation.md): that seam exposes the raw text coming back FROM the model; this one\nexposes the raw request going TO it. Together they let you read ground truth at both ends of the wire —\ne.g. to settle whether a \"smart quote\" in a rendered answer came from the model itself or from a\ndownstream markdown renderer, you inspect the bytes here, not the DOM.\n\n## Remarks\n\nThis is a pure observability tap — it returns `void`, never mutates the request, and never throws into\nthe generation path (the adapter swallows callback errors). It fires once per terminal generation\n(one per non-streamed turn; one per stream, at dispatch), across ALL five LLM batteries.\n\n**Handed back AS-IS — no redaction.** The observation carries the request exactly as assembled. The ADK\ndoes not scrub credentials, headers, or any other field for you: what you put on the request is what you\nsee here, and if you route this to a persistent sink (a log, `localStorage`, a file) you may persist\nsecrets that rode the request (an `apiKey`, `Authorization` header, etc.). That is your responsibility to\nhandle, not the battery's — the ADK surfaces the truth and lets you decide what to do with it. (In\npractice the API batteries strip ADK-control keys like `apiKey` out of the wire body before this fires,\nbut that is incidental to how the body is built, not a guarantee.)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `battery` | `string` | Which battery assembled this request (e.g. `'litert_lm'`, `'openai_chat_completions'`). | [src/batteries/llm/chat\\_common/types.ts:403](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L403) |\n| `kind` | `\"rendered-prompt\"` | `\"request-body\"` | The shape of the assembled request. `'rendered-prompt'` for the on-device batteries (transformers.js, LiteRT-LM), which render a preface string + a messages array for the engine; `'request-body'` for the API batteries (OpenAI-compatible, Ollama, WebLLM), which POST a JSON body. | [src/batteries/llm/chat\\_common/types.ts:409](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L409) |\n| `messages` | `unknown` | The per-turn messages exactly as handed to the engine (on-device) or placed on the wire (API): the engine's message array, or the request body's `messages`. | [src/batteries/llm/chat\\_common/types.ts:420](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L420) |\n| `preface?` | `unknown` | On-device leading/system content rendered ahead of the timeline (e.g. the LiteRT `preface` object, which carries the assembled system message text and — for native tool delivery — the tool list), when applicable. Its concrete shape is battery-specific; captured verbatim. Absent for the API batteries. | [src/batteries/llm/chat\\_common/types.ts:415](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L415) |\n| `requestBody?` | `unknown` | API batteries only: the complete assembled request body, exactly as it will be sent (see the AS-IS / no-redaction note above). Absent for the on-device batteries. | [src/batteries/llm/chat\\_common/types.ts:430](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L430) |\n| `streamed` | `boolean` | Whether this generation streams its response (vs. a single batch call). | [src/batteries/llm/chat\\_common/types.ts:432](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L432) |\n| `streamId` | `string` | The adapter's stream/message id for this generation, for correlating with other telemetry. | [src/batteries/llm/chat\\_common/types.ts:434](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L434) |\n| `tools?` | `unknown` | The tool declarations exactly as dispatched: the rendered `` prompt text (on-device prompt-delivery) or the wire `tools` array (API / native tool delivery). Absent when no tools are sent. | [src/batteries/llm/chat\\_common/types.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L425) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/RawGenerationObservation","title":"Interface: RawGenerationObservation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/RawGenerationObservation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/RawGenerationObservation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/RawGenerationObservation.md\ndescription: >-\n One observation of a battery's raw model output for a single completed\n generation, fired the instant the full text is in hand — AFTER envelope-token\n stripping + reasoning/tool-call parsing, but BEFORE the parsed result is\n persisted. The whole point is to expose the gap between what the model\n literally emitted (`rawText`) and what the battery managed to extract\n (`cleanedText` / `toolCalls` / `reasoning`): when a small on-device model\n emits a tool call in a shape no parser matches, the call silently leaks into\n `cleanedText` as prose, and this is the ONLY seam where that is visible.\n---\n\n# Interface: RawGenerationObservation\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:348](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L348)\n\nOne observation of a battery's raw model output for a single completed generation, fired the instant\nthe full text is in hand — AFTER envelope-token stripping + reasoning/tool-call parsing, but BEFORE\nthe parsed result is persisted. The whole point is to expose the gap between what the model literally\nemitted (`rawText`) and what the battery managed to extract (`cleanedText` / `toolCalls` /\n`reasoning`): when a small on-device model emits a tool call in a shape no parser matches, the call\nsilently leaks into `cleanedText` as prose, and this is the ONLY seam where that is visible.\n\n## Remarks\n\nThis is a pure observability tap — it returns `void`, never mutates the result, and never throws into\nthe generation path (the adapter swallows callback errors). It fires once per terminal generation\n(one per non-streamed turn; one per stream at stream end), for BOTH the transformers.js and LiteRT-LM\non-device batteries, at the identical point in each. Use it for parser bring-up against a new model,\nlive debugging (\"why did the agent abstain?\"), or capturing ground-truth fixtures — exactly the job\nthat previously required patching a temporary hook into the adapter.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cleanedText` | `string` | The residual prose after reasoning + tool-call extraction — what becomes the assistant message `content`. If a tool call failed to parse, its source text is still here (the leak). | [src/batteries/llm/chat\\_common/types.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L359) |\n| `rawText` | `string` | The model's complete decoded output for this generation, with non-semantic envelope/turn-boundary special tokens already stripped (the same text handed to the parsers) — i.e. what the parsers actually saw. This is the field to inspect when a tool call did not parse. | [src/batteries/llm/chat\\_common/types.ts:354](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L354) |\n| `reasoning` | readonly `string`\\[] | The reasoning/thinking traces the reasoning parser extracted (empty when none / not applicable). | [src/batteries/llm/chat\\_common/types.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L361) |\n| `streamed` | `boolean` | Whether this generation streamed its prose to the consumer (vs. a single batch decode). | [src/batteries/llm/chat\\_common/types.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L365) |\n| `streamId` | `string` | The adapter's stream/message id for this generation, for correlating with other telemetry. | [src/batteries/llm/chat\\_common/types.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L367) |\n| `toolCalls` | readonly [`ParsedToolCall`](../llm/transformers_js/helpers/interfaces/ParsedToolCall.md)\\[] | The tool calls the tool-call parser extracted (empty when the model emitted none, or none parsed). | [src/batteries/llm/chat\\_common/types.ts:363](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L363) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/RetrievableAttrs","title":"Interface: RetrievableAttrs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/RetrievableAttrs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/RetrievableAttrs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/RetrievableAttrs.md'\ndescription: Attribute bag rendered onto a retrievable block.\n---\n\n# Interface: RetrievableAttrs\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L183)\n\nAttribute bag rendered onto a retrievable block.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAt?` | `string` | ISO-8601 creation timestamp of the retrievable. | [src/batteries/llm/chat\\_common/types.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L197) |\n| `kind?` | `string` | Retrievable classifier. | [src/batteries/llm/chat\\_common/types.ts:199](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L199) |\n| `nonce` | `string` | Nonce binding the block's open and close markers together — it becomes part of the tag NAME (`<..._>`) so a model mirroring the block cannot forge a sibling's closer. FOOTGUN: this nonce MUST be unguessable AND non-path-shaped. It is typically the source record's id; a path-shaped id (e.g. `chunk-assembly-events-9`) is copied by small models as a CITATION (`/assembly/events-9`), which a doc-path validator then rejects → re-cite loop. Mint record ids with `crypto.randomUUID()`; carry page/human provenance in `source=` (rendered before `nonce=`), never in the id. | [src/batteries/llm/chat\\_common/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L193) |\n| `score?` | `number` | Relevance score from the retrieval query. | [src/batteries/llm/chat\\_common/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L201) |\n| `source?` | `string` | Origin of the retrievable (e.g. the source document or system). | [src/batteries/llm/chat\\_common/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L195) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperBaseConfig","title":"Interface: ScrapperBaseConfig\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperBaseConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperBaseConfig","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/ScrapperBaseConfig.md'\ndescription: >-\n Configuration common to every Scrapper factory. `A` is the accepted `artifact`\n resolver type.\n---\n\n# Interface: ScrapperBaseConfig\\\n\nDefined in: [src/batteries/tools/scrapper/shared.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L179)\n\nConfiguration common to every Scrapper factory. `A` is the accepted `artifact` resolver type.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `P` |\n| `R` |\n| `A` |\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `artifact?` | `A` | Spool-artifact resolver for the output. Default `() => SpooledJsonArtifact`. | [src/batteries/tools/scrapper/shared.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L189) |\n| `defaults?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`P`> | Model-overridable default param values. | [src/batteries/tools/scrapper/shared.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L197) |\n| `description?` | `string` | Tool description override. | [src/batteries/tools/scrapper/shared.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L193) |\n| `fixed?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`P`> | Pinned params — sent always, removed from the model schema. | [src/batteries/tools/scrapper/shared.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L195) |\n| `fixedQuery?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Raw, un-modeled wire params (kebab keys) — always sent, never model-visible. Keeps the battery generic. | [src/batteries/tools/scrapper/shared.ts:199](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L199) |\n| `gate?` | [`ToolGateFn`](../tools/_shared/type-aliases/ToolGateFn.md) | Optional per-call gate run before the HTTP request — the seam for human-approval/RBAC flows built on `ctx.waitFor` (the ADK gates primitive). Throwing aborts the call through the standard tool-error path. Scraping reaches the network on the agent's behalf, which makes every call a candidate for gating. | [src/batteries/tools/scrapper/shared.ts:206](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L206) |\n| `headers?` | | [`ToolHeadersResolver`](../tools/_shared/type-aliases/ToolHeadersResolver.md) | [`ToolHeaders`](../tools/_shared/type-aliases/ToolHeaders.md) | Headers sent to the Scrapper INSTANCE for auth (X-API-Key / Basic) — static or resolver. | [src/batteries/tools/scrapper/shared.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L183) |\n| `inputPipeline?` | [`ScrapperInputMiddlewareFn`](../type-aliases/ScrapperInputMiddlewareFn.md)\\[] | Stages run before the HTTP request. See [ScrapperRequestContext](ScrapperRequestContext.md). | [src/batteries/tools/scrapper/shared.ts:208](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L208) |\n| `instanceUrl` | `string` | Base URL of the Scrapper instance, e.g. `https://scrapper.example.org`. Required. | [src/batteries/tools/scrapper/shared.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L181) |\n| `name?` | `string` | Tool name override. | [src/batteries/tools/scrapper/shared.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L191) |\n| `outputPipeline?` | [`ScrapperOutputMiddlewareFn`](../type-aliases/ScrapperOutputMiddlewareFn.md)<`R`>\\[] | Stages run after the response is parsed. See [ScrapperResponseContext](ScrapperResponseContext.md). | [src/batteries/tools/scrapper/shared.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L210) |\n| `requestTimeoutMs?` | `number` | The tool's own `fetch` AbortController timeout in ms. Default `65_000` (> Scrapper's 60s browser default). | [src/batteries/tools/scrapper/shared.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L185) |\n| `resultFormat?` | `\"raw\"` | `\"normalized\"` | `\"either\"` | Output shape. `normalized`/`raw` pin it; `either` (default) exposes a `format` arg to the model. | [src/batteries/tools/scrapper/shared.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L187) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperRequestContext","title":"Interface: ScrapperRequestContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperRequestContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperRequestContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/ScrapperRequestContext.md\ndescription: >-\n Mutable context handed to each input-pipeline stage **before** the HTTP\n request is sent. Identical for both verbs.\n---\n\n# Interface: ScrapperRequestContext\n\nDefined in: [src/batteries/tools/scrapper/shared.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L125)\n\nMutable context handed to each input-pipeline stage **before** the HTTP request is sent.\nIdentical for both verbs.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `headers` | `public` | [`ToolHeaders`](../tools/_shared/type-aliases/ToolHeaders.md) | Resolved request headers sent to the SCRAPPER INSTANCE (auth). Mutable. | [src/batteries/tools/scrapper/shared.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L133) |\n| `instanceUrl` | `readonly` | `string` | The Scrapper instance base URL (read-only). | [src/batteries/tools/scrapper/shared.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L135) |\n| `params` | `public` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Wire-kebab query params (everything except `url`). Mutable. | [src/batteries/tools/scrapper/shared.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L131) |\n| `stash` | `readonly` | `Map`<`string`, `unknown`> | Cross-stage scratch space; also carried onto the response context. | [src/batteries/tools/scrapper/shared.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L137) |\n| `toolName` | `readonly` | `string` | The tool's name (read-only). | [src/batteries/tools/scrapper/shared.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L127) |\n| `url` | `public` | `string` | The target page URL (the `url` argument). Mutable. | [src/batteries/tools/scrapper/shared.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L129) |\n\n## Methods\n\n### shortCircuit()\n\n```ts\nshortCircuit(result: string): void;\n```\n\nDefined in: [src/batteries/tools/scrapper/shared.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L139)\n\nSkip the fetch and return `result` verbatim as the tool's output (e.g. a cache hit).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `result` | `string` |\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperResponseContext","title":"Interface: ScrapperResponseContext\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperResponseContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ScrapperResponseContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/ScrapperResponseContext.md\ndescription: >-\n Mutable context handed to each output-pipeline stage **after** the response\n JSON is parsed.\n---\n\n# Interface: ScrapperResponseContext\\\n\nDefined in: [src/batteries/tools/scrapper/shared.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L147)\n\nMutable context handed to each output-pipeline stage **after** the response JSON is parsed.\n\n## Type Parameters\n\n| Type Parameter | Description |\n| -------------- | -------------------------------------------------------------------- |\n| `R` | The verb's normalised result type (article object or links payload). |\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------- | ---------- | ----------------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `format` | `public` | `\"raw\"` | `\"normalized\"` | The effective payload shape for this call. | [src/batteries/tools/scrapper/shared.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L157) |\n| `output?` | `public` | `string` | When set, used verbatim as the tool's output (overrides serialisation). | [src/batteries/tools/scrapper/shared.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L159) |\n| `raw` | `public` | `unknown` | The parsed Scrapper JSON body. Mutable (used when `format` is `raw`). | [src/batteries/tools/scrapper/shared.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L153) |\n| `request` | `readonly` | [`ScrapperRequestContext`](ScrapperRequestContext.md) | The request context as it was sent (post-input-pipeline). | [src/batteries/tools/scrapper/shared.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L151) |\n| `result` | `public` | `R` | The normalised result. Mutable — reshape, redact, enrich. | [src/batteries/tools/scrapper/shared.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L155) |\n| `stash` | `readonly` | `Map`<`string`, `unknown`> | Cross-stage scratch space; carried over from the request context. | [src/batteries/tools/scrapper/shared.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L161) |\n| `toolName` | `readonly` | `string` | The tool's name (read-only). | [src/batteries/tools/scrapper/shared.ts:149](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/shared.ts#L149) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ServeIsolatedOptions","title":"Interface: ServeIsolatedOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ServeIsolatedOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ServeIsolatedOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/ServeIsolatedOptions.md'\ndescription: 'Options accepted by [`serveIsolated`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/serveIsolated)/[`serveIsolatedOverPort`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/serveIsolatedOverPort).'\n---\n\n# Interface: ServeIsolatedOptions\n\nDefined in: [src/batteries/isolation/serve.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/serve.ts#L43)\n\nOptions accepted by [serveIsolated](../functions/serveIsolated.md)/[serveIsolatedOverPort](../functions/serveIsolatedOverPort.md).\n\n## Extends\n\n* [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `debugPayloads?` | `boolean` | Include payload bodies on `call:*`/`wire:*` reports (see [IsolationReport.payload](IsolationReport.md#property-payload)). Default `false` — payloads may be large/sensitive, so this is opt-in even when hooks are wired. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`debugPayloads`](IsolationObservabilityHooks.md#property-debugpayloads) | [src/batteries/isolation/observability.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L135) |\n| `encodables?` | readonly { `name`: `string`; }\\[] | Classes to register with `@nhtio/encoder`'s custom-encodable round-trip on this side (sugar over `registerClass`; lazy — only touches the encoder peer when this array is non-empty). | - | [src/batteries/isolation/serve.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/serve.ts#L46) |\n| `onAbort?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `abort:sent` — the host sent an `abort` envelope for an in-flight call. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onAbort`](IsolationObservabilityHooks.md#property-onabort) | [src/batteries/isolation/observability.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L128) |\n| `onCall?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `call:start` / `call:settle` — a single request/response method call. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onCall`](IsolationObservabilityHooks.md#property-oncall) | [src/batteries/isolation/observability.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L124) |\n| `onCodecEscalate?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `codec:escalate` — the codec escalated an argument past the `'raw'` tier. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onCodecEscalate`](IsolationObservabilityHooks.md#property-oncodecescalate) | [src/batteries/isolation/observability.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L132) |\n| `onCrashReport?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `crash` — the transport reported an unexpected guest exit/termination. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onCrashReport`](IsolationObservabilityHooks.md#property-oncrashreport) | [src/batteries/isolation/observability.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L120) |\n| `onDispose?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `dispose:start` / `dispose:done` — graceful-then-forced teardown. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onDispose`](IsolationObservabilityHooks.md#property-ondispose) | [src/batteries/isolation/observability.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L116) |\n| `onIsolation?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | Fires on EVERY report (the firehose). | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onIsolation`](IsolationObservabilityHooks.md#property-onisolation) | [src/batteries/isolation/observability.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L112) |\n| `onRecycle?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `recycle:start` / `recycle:done` — terminate + reconnect through the same transport. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onRecycle`](IsolationObservabilityHooks.md#property-onrecycle) | [src/batteries/isolation/observability.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L118) |\n| `onRespawnAuto?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `respawn:auto` — an `autoRespawn` crash-policy verdict was consulted and acted on. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onRespawnAuto`](IsolationObservabilityHooks.md#property-onrespawnauto) | [src/batteries/isolation/observability.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L122) |\n| `onSpawn?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `spawn:start` / `spawn:ready` / `spawn:error` — guest connect lifecycle. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onSpawn`](IsolationObservabilityHooks.md#property-onspawn) | [src/batteries/isolation/observability.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L114) |\n| `onStream?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `stream:start` / `stream:end` / `stream:error` / `stream:cancel` — a streaming method call. | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onStream`](IsolationObservabilityHooks.md#property-onstream) | [src/batteries/isolation/observability.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L126) |\n| `onWire?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `wire:out` / `wire:in` — every envelope crossing the wire (verbose; opt in deliberately). | [`IsolationObservabilityHooks`](IsolationObservabilityHooks.md).[`onWire`](IsolationObservabilityHooks.md#property-onwire) | [src/batteries/isolation/observability.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L130) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/SpawnIsolatedOptions","title":"Interface: SpawnIsolatedOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/SpawnIsolatedOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/SpawnIsolatedOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/SpawnIsolatedOptions.md'\ndescription: >-\n Options accepted by [`spawnIsolated`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/spawnIsolated)/[`createWorkerTransport`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/createWorkerTransport),\n layered on top of [`IsolatedServiceOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/IsolatedServiceOptions).\n---\n\n# Interface: SpawnIsolatedOptions\n\nDefined in: [src/batteries/isolation/browser.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L104)\n\nOptions accepted by [spawnIsolated](../functions/spawnIsolated.md)/[createWorkerTransport](../functions/createWorkerTransport.md), layered on top of [IsolatedServiceOptions](IsolatedServiceOptions.md).\n\n## Extends\n\n* [`IsolatedServiceOptions`](IsolatedServiceOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `autoRespawn?` | { `policy`: [`CrashPolicy`](CrashPolicy.md); } | Opt-in automatic recovery: on a transport-reported crash, consult `policy.record()` and `recycle()` automatically when it returns `'respawn'`. Default: not set (crashes are surfaced, never auto-healed). | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`autoRespawn`](IsolatedServiceOptions.md#property-autorespawn) | [src/batteries/isolation/host.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L54) |\n| `autoRespawn.policy` | [`CrashPolicy`](CrashPolicy.md) | - | - | [src/batteries/isolation/host.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L54) |\n| `debugPayloads?` | `boolean` | Include payload bodies on `call:*`/`wire:*` reports (see [IsolationReport.payload](IsolationReport.md#property-payload)). Default `false` — payloads may be large/sensitive, so this is opt-in even when hooks are wired. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`debugPayloads`](IsolatedServiceOptions.md#property-debugpayloads) | [src/batteries/isolation/observability.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L135) |\n| `disposeGraceMs?` | `number` | Grace period `dispose()` gives the guest to exit cleanly after `shutdown` before forcing `transport.terminate()`. Default `2000`. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`disposeGraceMs`](IsolatedServiceOptions.md#property-disposegracems) | [src/batteries/isolation/host.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L51) |\n| `encodables?` | readonly { `name`: `string`; }\\[] | Classes to register with `@nhtio/encoder`'s custom-encodable round-trip on this side. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`encodables`](IsolatedServiceOptions.md#property-encodables) | [src/batteries/isolation/host.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L56) |\n| `hostcallHandlers?` | `ReadonlyMap`<`string`, `HostcallHandler`> | Permitted guest-to-host capability handlers. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`hostcallHandlers`](IsolatedServiceOptions.md#property-hostcallhandlers) | [src/batteries/isolation/host.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L58) |\n| `hostcallQuotas?` | `HostcallQuotas` | Resolved quotas enforced for guest-to-host calls. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`hostcallQuotas`](IsolatedServiceOptions.md#property-hostcallquotas) | [src/batteries/isolation/host.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L60) |\n| `maxHostcallBytes?` | `number` | Producer-side argument/result byte cap. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`maxHostcallBytes`](IsolatedServiceOptions.md#property-maxhostcallbytes) | [src/batteries/isolation/host.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L62) |\n| `onAbort?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `abort:sent` — the host sent an `abort` envelope for an in-flight call. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onAbort`](IsolatedServiceOptions.md#property-onabort) | [src/batteries/isolation/observability.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L128) |\n| `onCall?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `call:start` / `call:settle` — a single request/response method call. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onCall`](IsolatedServiceOptions.md#property-oncall) | [src/batteries/isolation/observability.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L124) |\n| `onCodecEscalate?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `codec:escalate` — the codec escalated an argument past the `'raw'` tier. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onCodecEscalate`](IsolatedServiceOptions.md#property-oncodecescalate) | [src/batteries/isolation/observability.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L132) |\n| `onCrashReport?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `crash` — the transport reported an unexpected guest exit/termination. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onCrashReport`](IsolatedServiceOptions.md#property-oncrashreport) | [src/batteries/isolation/observability.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L120) |\n| `onDispose?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `dispose:start` / `dispose:done` — graceful-then-forced teardown. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onDispose`](IsolatedServiceOptions.md#property-ondispose) | [src/batteries/isolation/observability.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L116) |\n| `onIsolation?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | Fires on EVERY report (the firehose). | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onIsolation`](IsolatedServiceOptions.md#property-onisolation) | [src/batteries/isolation/observability.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L112) |\n| `onRecycle?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `recycle:start` / `recycle:done` — terminate + reconnect through the same transport. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onRecycle`](IsolatedServiceOptions.md#property-onrecycle) | [src/batteries/isolation/observability.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L118) |\n| `onRespawnAuto?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `respawn:auto` — an `autoRespawn` crash-policy verdict was consulted and acted on. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onRespawnAuto`](IsolatedServiceOptions.md#property-onrespawnauto) | [src/batteries/isolation/observability.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L122) |\n| `onSpawn?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `spawn:start` / `spawn:ready` / `spawn:error` — guest connect lifecycle. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onSpawn`](IsolatedServiceOptions.md#property-onspawn) | [src/batteries/isolation/observability.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L114) |\n| `onStream?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `stream:start` / `stream:end` / `stream:error` / `stream:cancel` — a streaming method call. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onStream`](IsolatedServiceOptions.md#property-onstream) | [src/batteries/isolation/observability.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L126) |\n| `onWire?` | [`IsolationReportCallback`](../type-aliases/IsolationReportCallback.md) | `wire:out` / `wire:in` — every envelope crossing the wire (verbose; opt in deliberately). | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`onWire`](IsolatedServiceOptions.md#property-onwire) | [src/batteries/isolation/observability.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/observability.ts#L130) |\n| `readyTimeoutMs?` | `number` | Max time to wait for the guest's `ready` envelope after `transport.connect()` resolves. Default `30_000`. Rejects the pending `connect`/first call with `E_ISOLATION_READY_TIMEOUT`. | [`IsolatedServiceOptions`](IsolatedServiceOptions.md).[`readyTimeoutMs`](IsolatedServiceOptions.md#property-readytimeoutms) | [src/batteries/isolation/host.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/host.ts#L48) |\n| `worker` | `string` | `URL` | [`WorkerResolver`](../type-aliases/WorkerResolver.md) | How to obtain the guest `Worker`: - A `string | URL`— the guest script's URL;`createWorkerTransport`constructs`new Worker(url, workerOptions)`itself on every`connect()`. - A [WorkerResolver](../type-aliases/WorkerResolver.md) — full control: bring a `Worker`from any bundler pattern or pool. Invoked with`{ spec }`and may return a`Worker`synchronously or via a`Promise`. | - | [src/batteries/isolation/browser.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L113) |\n| `workerOptions?` | [`BrowserWorkerOptions`](BrowserWorkerOptions.md) | Forwarded verbatim to `new Worker(url, workerOptions)` — used ONLY for the `string | URL`spawn form (ignored when`worker`is a [WorkerResolver](../type-aliases/WorkerResolver.md), which constructs its own`Worker`). Default: classic script (no `type`) — see [BrowserWorkerOptions](BrowserWorkerOptions.md)'s doc for why. | - | [src/batteries/isolation/browser.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/browser.ts#L117) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StandingInstructionAttrs","title":"Interface: StandingInstructionAttrs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StandingInstructionAttrs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StandingInstructionAttrs","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/StandingInstructionAttrs.md\ndescription: Attribute bag rendered onto a standing-instruction block.\n---\n\n# Interface: StandingInstructionAttrs\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L151)\n\nAttribute bag rendered onto a standing-instruction block.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | -------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `version?` | `string` | Optional version label for the standing instruction. | [src/batteries/llm/chat\\_common/types.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L153) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamDescriptor","title":"Interface: StreamDescriptor\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamDescriptor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamDescriptor","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/StreamDescriptor.md'\ndescription: >-\n A stream descriptor produced by [`stream`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/stream). Phantom-typed like {@link\n MethodDescriptor}.\n---\n\n# Interface: StreamDescriptor\\\n\nDefined in: [src/batteries/isolation/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L79)\n\nA stream descriptor produced by [stream](../functions/stream.md). Phantom-typed like [MethodDescriptor](MethodDescriptor.md).\n\n## Extends\n\n* [`StreamOptions`](StreamOptions.md)\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| ------------------------- | ------------ |\n| `A` *extends* `unknown`\\[] | `unknown`\\[] |\n| `D` | `unknown` |\n\n## Properties\n\n| Property | Modifier | Type | Description | Inherited from | Defined in |\n| ---------------------------------------- | ---------- | ------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |\n| `__args?` | `readonly` | `A` | Phantom-only: never assigned a real value. Pins the argument tuple type. | - | [src/batteries/isolation/types.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L86) |\n| `__delta?` | `readonly` | `D` | Phantom-only: never assigned a real value. Pins the per-chunk delta type. | - | [src/batteries/isolation/types.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L88) |\n| `codec?` | `public` | [`CodecMode`](../type-aliases/CodecMode.md) | Override the codec tier for this stream's arguments and deltas. Default: `'auto'`. | [`StreamOptions`](StreamOptions.md).[`codec`](StreamOptions.md#property-codec) | [src/batteries/isolation/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L58) |\n| `kind` | `readonly` | `\"stream\"` | Discriminant identifying this descriptor as a stream (vs. a method or event). | - | [src/batteries/isolation/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L84) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamHandle","title":"Interface: StreamHandle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamHandle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamHandle","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/StreamHandle.md'\ndescription: >-\n Trailing parameter every guest stream implementation receives (regardless of\n declared options). Carries the {@link AbortSignal} the host aborts (via\n `stream:cancel`) when the reader cancels the host-side `ReadableStream`.\n---\n\n# Interface: StreamHandle\n\nDefined in: [src/batteries/isolation/types.ts:227](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L227)\n\nTrailing parameter every guest stream implementation receives (regardless of declared options).\nCarries the AbortSignal the host aborts (via `stream:cancel`) when the reader cancels the\nhost-side `ReadableStream`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | ------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `signal` | `AbortSignal` | Aborts when the host sends a `stream:cancel` envelope for this stream's id. | [src/batteries/isolation/types.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L229) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamOptions","title":"Interface: StreamOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/StreamOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/StreamOptions.md'\ndescription: 'Runtime options accepted by [`stream`](https://adk.nht.io/api/@nhtio/adk/batteries/functions/stream).'\n---\n\n# Interface: StreamOptions\n\nDefined in: [src/batteries/isolation/types.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L56)\n\nRuntime options accepted by [stream](../functions/stream.md).\n\n## Extended by\n\n* [`StreamDescriptor`](StreamDescriptor.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | ------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `codec?` | [`CodecMode`](../type-aliases/CodecMode.md) | Override the codec tier for this stream's arguments and deltas. Default: `'auto'`. | [src/batteries/isolation/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/types.ts#L58) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/SttSegment","title":"Interface: SttSegment","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/SttSegment.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/SttSegment","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/SttSegment.md'\ndescription: A single recognized speech segment with its time bounds and text.\n---\n\n# Interface: SttSegment\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/types.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L34)\n\nA single recognized speech segment with its time bounds and text.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | ------------------ | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `end` | `number` | `null` | The segment's end time, in seconds, or `null` when the engine did not report one. | [src/batteries/specialists/stt/transformers\\_js/types.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L38) |\n| `start` | `number` | The segment's start time, in seconds. | [src/batteries/specialists/stt/transformers\\_js/types.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L36) |\n| `text` | `string` | The segment's recognized text. | [src/batteries/specialists/stt/transformers\\_js/types.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L40) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ThoughtAttrs","title":"Interface: ThoughtAttrs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ThoughtAttrs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/ThoughtAttrs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/ThoughtAttrs.md'\ndescription: Attribute bag rendered onto a thought block.\n---\n\n# Interface: ThoughtAttrs\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L207)\n\nAttribute bag rendered onto a thought block.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAt?` | `string` | ISO-8601 creation timestamp of the thought. | [src/batteries/llm/chat\\_common/types.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L223) |\n| `from` | `string` | Identity of the agent the thought originated from. | [src/batteries/llm/chat\\_common/types.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L221) |\n| `kind` | `\"self-reasoning\"` | `\"peer-reasoning\"` | `\"opaque-reasoning\"` | Whether the thought is the model's own, a peer's, or opaque vendor reasoning. | [src/batteries/llm/chat\\_common/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L219) |\n| `nonce` | `string` | Nonce binding the block's open and close markers together — it becomes part of the tag NAME (`<..._>`) so a model mirroring the block cannot forge a sibling's closer. FOOTGUN: this nonce MUST be unguessable AND non-path-shaped. It is typically the source record's id; a path-shaped id (e.g. `chunk-assembly-events-9`) is copied by small models as a CITATION (`/assembly/events-9`), which a doc-path validator then rejects → re-cite loop. Mint record ids with `crypto.randomUUID()`; carry page/human provenance in `source=` (rendered before `nonce=`), never in the id. | [src/batteries/llm/chat\\_common/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L217) |\n| `replayCompatibility?` | `string` | Replay-compatibility label gating whether the thought is surfaced on replay. | [src/batteries/llm/chat\\_common/types.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L225) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TranscribeOptions","title":"Interface: TranscribeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TranscribeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TranscribeOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/TranscribeOptions.md'\ndescription: 'Per-call options for [`TransformersJsSttAdapter.transcribe`](https://adk.nht.io/api/@nhtio/adk/batteries/classes/TransformersJsSttAdapter#transcribe).'\n---\n\n# Interface: TranscribeOptions\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L52)\n\nPer-call options for [TransformersJsSttAdapter.transcribe](../classes/TransformersJsSttAdapter.md#transcribe).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `language?` | `string` | The source language (e.g. `'english'`), improving accuracy when known. Default: auto-detect. | [src/batteries/specialists/stt/transformers\\_js/types.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L54) |\n| `timestamps?` | `boolean` | Request per-segment timestamps, populating [TranscribeResult.segments](TranscribeResult.md#property-segments). Default: `false`. | [src/batteries/specialists/stt/transformers\\_js/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L58) |\n| `translate?` | `boolean` | Translate the recognized speech to English rather than transcribing it verbatim. Default: `false`. | [src/batteries/specialists/stt/transformers\\_js/types.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L56) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TranscribeResult","title":"Interface: TranscribeResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TranscribeResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TranscribeResult","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/TranscribeResult.md'\ndescription: 'The result of a {@link transcribe} call.'\n---\n\n# Interface: TranscribeResult\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/types.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L44)\n\nThe result of a [transcribe](TranscribeOptions.md) call.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `segments?` | [`SttSegment`](SttSegment.md)\\[] | Per-segment timing breakdown, present only when [TranscribeOptions.timestamps](TranscribeOptions.md#property-timestamps) was set. | [src/batteries/specialists/stt/transformers\\_js/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L48) |\n| `text` | `string` | The full recognized transcript. | [src/batteries/specialists/stt/transformers\\_js/types.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L46) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TransformersJsSttAdapterOptions","title":"Interface: TransformersJsSttAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TransformersJsSttAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TransformersJsSttAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/TransformersJsSttAdapterOptions.md\ndescription: Constructor options for the transformers.js STT adapter.\n---\n\n# Interface: TransformersJsSttAdapterOptions\n\nDefined in: [src/batteries/specialists/stt/transformers\\_js/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L105)\n\nConstructor options for the transformers.js STT adapter.\n\n## Remarks\n\n`model` is required — no default, since Whisper-family models are multi-hundred-megabyte downloads\nand this battery never triggers one silently (the loud-config rule shared with every on-device\nbattery).\n\n## Extends\n\n* [`BatteryLifecycleHooks`](../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `chunkLengthS?` | `number` | The length of audio chunks to process, in seconds, forwarded to the pipeline call. Default `30`. | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L120) |\n| `createPipeline?` | [`CreateTransformersJsSttPipeline`](../type-aliases/CreateTransformersJsSttPipeline.md) | Override the pipeline factory. Default: `pipeline('automatic-speech-recognition', …)` via dynamic import. | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L114) |\n| `decodeAudio?` | [`DecodeAudioFn`](../specialists/_shared/type-aliases/DecodeAudioFn.md) | Override the audio-decode step (encoded container bytes → mono PCM). Default: [@nhtio/adk/batteries/specialists/\\_shared!defaultDecodeAudio](../specialists/_shared/variables/defaultDecodeAudio.md). | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L125) |\n| `device?` | | `\"auto\"` | `\"gpu\"` | `\"cpu\"` | `\"wasm\"` | `\"webgpu\"` | `\"cuda\"` | `\"dml\"` | `\"coreml\"` | `\"webnn\"` | `\"webnn-npu\"` | `\"webnn-gpu\"` | `\"webnn-cpu\"` | Inference device forwarded to `pipeline()`. Default: transformers.js environment default. | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L116) |\n| `dtype?` | | `\"auto\"` | `\"fp32\"` | `\"fp16\"` | `\"q8\"` | `\"int8\"` | `\"uint8\"` | `\"q4\"` | `\"bnb4\"` | `\"q4f16\"` | `\"q2\"` | `\"q2f16\"` | `\"q1\"` | `\"q1f16\"` | Quantization/precision dtype forwarded to `pipeline()`. | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L118) |\n| `isAvailable?` | () => `boolean` | Override the availability probe. Default: `true` whenever the peer is importable (env-neutral). | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L135) |\n| `model` | `string` | The Whisper (or compatible) ASR model id, e.g. `onnx-community/whisper-base`. Required. | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L107) |\n| `modelSource?` | [`TransformersJsSttModelSource`](../type-aliases/TransformersJsSttModelSource.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 [TransformersJsSttModelSource](../type-aliases/TransformersJsSttModelSource.md). | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L131) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `onInitProgress?` | `ProgressCallback` | Called with model-load progress reports while weights download/compile. | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L133) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `pipeline?` | `AutomaticSpeechRecognitionPipeline` | A pre-built pipeline. When provided, the battery uses it directly and skips lazy creation. | - | [src/batteries/specialists/stt/transformers\\_js/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/stt/transformers_js/types.ts#L109) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TrustedContentAttrs","title":"Interface: TrustedContentAttrs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TrustedContentAttrs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/TrustedContentAttrs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/TrustedContentAttrs.md'\ndescription: >-\n Attribute bag rendered onto the trust envelope that wraps trusted\n (first-party) content.\n---\n\n# Interface: TrustedContentAttrs\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L127)\n\nAttribute bag rendered onto the trust envelope that wraps trusted (first-party) content.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `string` | Content classifier rendered on the envelope. | [src/batteries/llm/chat\\_common/types.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L139) |\n| `modality?` | `\"opaque\"` | `\"inert\"` | `\"extractable\"` | Same semantics as [UntrustedContentAttrs.modality](UntrustedContentAttrs.md#property-modality). | [src/batteries/llm/chat\\_common/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L145) |\n| `nonce` | `string` | Nonce binding the envelope's open and close markers together — it becomes part of the tag NAME (`<..._>`) so a model mirroring the fence cannot forge a sibling's closer. FOOTGUN: this nonce MUST be unguessable AND non-path-shaped. It is typically the source record's id; a path-shaped id (e.g. `chunk-assembly-events-9`) is copied by small models as a CITATION (`/assembly/events-9`), which a doc-path validator then rejects → re-cite loop. Mint record ids with `crypto.randomUUID()`; carry page/human provenance in `source=` (rendered before `nonce=`), never in the id. | [src/batteries/llm/chat\\_common/types.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L137) |\n| `tool?` | `string` | Name of the tool that produced the content, when applicable. | [src/batteries/llm/chat\\_common/types.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L141) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/UntrustedContentAttrs","title":"Interface: UntrustedContentAttrs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/UntrustedContentAttrs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/UntrustedContentAttrs","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/UntrustedContentAttrs.md\ndescription: >-\n Attribute bag rendered onto the trust envelope that wraps untrusted\n (third-party) content.\n---\n\n# Interface: UntrustedContentAttrs\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L101)\n\nAttribute bag rendered onto the trust envelope that wraps untrusted (third-party) content.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `string` | Content classifier rendered on the envelope. | [src/batteries/llm/chat\\_common/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L113) |\n| `modality?` | `\"opaque\"` | `\"inert\"` | `\"extractable\"` | When wrapping a [@nhtio/adk!Media](../../common/classes/Media.md)-derived text marker, the modality hazard axis derived from `media.modalityHazard`: `'inert'`, `'extractable'` (from `'extractable-instructions'`), or `'opaque'` (from `'opaque-perceptual'`). Omitted for non-media envelopes. | [src/batteries/llm/chat\\_common/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L121) |\n| `nonce` | `string` | Nonce binding the envelope's open and close markers together — it becomes part of the tag NAME (`<..._>`) so a model mirroring the fence cannot forge a sibling's closer. FOOTGUN: this nonce MUST be unguessable AND non-path-shaped. It is typically the source record's id; a path-shaped id (e.g. `chunk-assembly-events-9`) is copied by small models as a CITATION (`/assembly/events-9`), which a doc-path validator then rejects → re-cite loop. Mint record ids with `crypto.randomUUID()`; carry page/human provenance in `source=` (rendered before `nonce=`), never in the id. | [src/batteries/llm/chat\\_common/types.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L111) |\n| `tool?` | `string` | Name of the tool that produced the content, when applicable. | [src/batteries/llm/chat\\_common/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L115) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/WebLLMChatCompletionsAdapterOptions","title":"Interface: WebLLMChatCompletionsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/WebLLMChatCompletionsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/WebLLMChatCompletionsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/WebLLMChatCompletionsAdapterOptions.md\ndescription: >-\n Configuration options for the in-browser WebLLM Chat Completions adapter — the\n OpenAI options minus the network-transport fields (no HTTP is involved), plus\n WebLLM-specific engine controls.\n---\n\n# Interface: WebLLMChatCompletionsAdapterOptions\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/types.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L76)\n\nConfiguration options for the in-browser WebLLM Chat Completions adapter — the OpenAI options\nminus the network-transport fields (no HTTP is involved), plus WebLLM-specific engine controls.\n\n## Extends\n\n* [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)<[`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md), `\"apiKey\"` | `\"baseURL\"` | `\"headers\"` | `\"fetch\"` | `\"retry\"` | `\"requestTimeoutMs\"`>.[`BatteryLifecycleHooks`](../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Default value | Description | Inherited from | Defined in |\n| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `audio?` | { `format`: `\"wav\"` | `\"mp3\"` | `\"flac\"` | `\"opus\"` | `\"pcm16\"`; `voice`: `string`; } | `undefined` | Parameters for audio output if requested. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`audio`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-audio) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L614) |\n| `audio.format` | `\"wav\"` | `\"mp3\"` | `\"flac\"` | `\"opus\"` | `\"pcm16\"` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L614) |\n| `audio.voice` | `string` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L614) |\n| `autoAck?` | `boolean` | `false` | Whether the executor should call [ctx.ack()](../../types/interfaces/DispatchContext.md#ack) itself when a generation completes with no tool calls (a terminal text answer). **Remarks** `ack()` is terminal and one-shot: once called, the dispatch loop exits after the current iteration. When the executor acks automatically, it seizes turn-completion control from the implementor — a `dispatchOutputPipeline` quality gate can never run, because the signal is already set before the output pipeline executes. This option therefore defaults to **`false`** (opt-in). With `autoAck: false`, a tool-call-free response leaves the context unsignalled and the executor returns; the implementor's output pipeline (or a later iteration) is responsible for calling `ctx.ack()` / `ctx.nack()`. This is the seam that makes output-side quality gates (citation enforcement, schema validation, regenerate-on-reject) possible. Set `autoAck: true` to restore single-shot behavior: the executor acks the moment a tool-call-free answer finishes, terminating the turn without giving the output pipeline a vote. The tool-call path is unaffected by this flag — it always withholds ack so the runner can iterate and execute the calls. Error paths always [nack](../../types/interfaces/DispatchContext.md#nack) regardless of this flag. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`autoAck`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-autoack) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:608](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L608) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../type-aliases/ChatCompletionsBucketOrder.md) | `undefined` | Determines order of memory and retrievable buckets in history assembly. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`bucketOrder`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-bucketorder) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:505](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L505) |\n| `chatOptions?` | `ChatOptions` | `ChatOptions`\\[] | `undefined` | MLC chat option(s) applied to the loaded model. | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L94) |\n| `contextWindow?` | `number` | `undefined` | Size of the model's token context window. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`contextWindow`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-contextwindow) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:507](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L507) |\n| `createEngine?` | (`input`: { `chatOptions?`: `ChatOptions` | `ChatOptions`\\[]; `engineConfig?`: `MLCEngineConfig`; `model`: `string`; `onInitProgress?`: (`report`: `InitProgressReport`) => `void`; }) => `Promise`<`MLCEngineInterface`> | `undefined` | Custom engine factory; overrides the default WebLLM engine loader. | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L96) |\n| `enableThinking?` | `boolean` | `undefined` | Whether to enable the model's \"thinking\"/reasoning mode, threaded EXPLICITLY into the request as `extra_body.enable_thinking`. Defaults to `false` — many reasoning chat templates (Qwen3, DeepSeek-R1) default thinking ON, which silently burns the token budget inside ``. Pinned off unless you opt in. (Independent of `reasoningFieldPrecedence`/parsing, which only handle thinking that IS emitted.) | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L113) |\n| `engine?` | `MLCEngineInterface` | `undefined` | A pre-constructed engine to drive; mutually exclusive with [WebLLMChatCompletionsAdapterOptions.createEngine](#property-createengine). | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L90) |\n| `engineConfig?` | `MLCEngineConfig` | `undefined` | MLC engine configuration used when the adapter creates the engine itself. | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L92) |\n| `extra_body?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | `undefined` | Additional WebLLM/MLC request fields passed through verbatim. | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L88) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../forge/classes/ToolRegistry.md) | `undefined` | OPTIONAL hook to SHAPE the artifact-query tools forged from prior-turn SpooledArtifact results, before they merge into the visible tool set. Receives the merged forged registry + dispatch context; returns a (possibly narrowed) registry, applied BEFORE the merge with `ctx.tools`. Lets the assembler keep only the core readers on a tight window (the rest reachable via tool\\_catalog/call\\_a\\_tool). Default absent = identity (all forged tools) = backward-compatible. The battery stays budget-agnostic (per the CONTRIBUTING size-threshold rule) — it applies the supplied filter without measuring context; budget logic lives in the caller's filter. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`forgeToolsFilter`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-forgetoolsfilter) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:763](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L763) |\n| `frequency_penalty?` | `number` | `undefined` | Frequency penalty wire field to discourage repeating words. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`frequency_penalty`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-frequency_penalty) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:616](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L616) |\n| `function_call?` | | `\"auto\"` | `\"none\"` | { `name`: `string`; } | `undefined` | Deprecated wire field to control which function is called. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`function_call`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-function_call) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:618](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L618) |\n| `functions?` | { `description?`: `string`; `name`: `string`; `parameters?`: [`JsonSchema`](JsonSchema.md); }\\[] | `undefined` | Deprecated list of functions available to the model. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`functions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-functions) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:620](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L620) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`ChatCompletionsHelpers`](../llm/openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)> | `undefined` | Optional overrides for OpenAI chat completions helpers. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`helpers`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-helpers) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:536](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L536) |\n| `ignore_eos?` | `boolean` | `undefined` | When `true`, the model ignores end-of-sequence tokens and keeps generating. | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L86) |\n| `isWebGPUAvailable?` | () => `boolean` | `undefined` | Override for the WebGPU-availability probe (defaults to a real `navigator.gpu` check). | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L105) |\n| `localToolCallParser?` | | [`ToolCallParserName`](../llm/transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../llm/transformers_js/helpers/type-aliases/ToolCallParserFn.md) | `undefined` | OPTIONAL fallback parser for tool calls the provider did NOT return structurally. **Remarks** The Chat Completions `message.tool_calls` array is authoritative: when the provider returns tool calls, those are used and this option is never consulted. But some models — especially small local ones served through an OpenAI-compatible endpoint — emit a tool call in a surface form the endpoint does not lift into `tool_calls`: ``, or bare `name\\nkey: value`. Those land as plain assistant `content`with`tool_calls`empty, silently dropping the call. This is a cross-model, cross-weight reality, not a single-endpoint quirk. Set this to a parser family name (e.g.`'gemma'`), `'auto'`(try every bundled parser in priority order), or a custom [ToolCallParserFn](../llm/transformers_js/helpers/type-aliases/ToolCallParserFn.md) to recover such calls from`content`ONLY when the provider returned none. Recovered calls execute exactly like native ones. Default absent = disabled = today's native-only behaviour (fully backward-compatible). Mirrors the on-device batteries'`toolCallParser`, which parse from text unconditionally because those runtimes never return structured calls. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`localToolCallParser`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-localtoolcallparser) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:751](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L751) |\n| `logit_bias?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `number`> | `undefined` | Bias logits to control token generation likelihood. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`logit_bias`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-logit_bias) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:622](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L622) |\n| `logprobs?` | `boolean` | `undefined` | Request log probabilities for generated tokens. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`logprobs`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-logprobs) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:624](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L624) |\n| `max_completion_tokens?` | `number` | `undefined` | Hard limit on token count for model reasoning/completion. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`max_completion_tokens`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-max_completion_tokens) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:626](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L626) |\n| `max_tokens?` | `number` | `undefined` | Maximum number of generated tokens. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`max_tokens`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-max_tokens) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:628](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L628) |\n| `metadata?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | `undefined` | Metadata key-value pairs forwarded to the provider. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`metadata`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-metadata) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:630](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L630) |\n| `modalities?` | (`\"text\"` | `\"audio\"`)\\[] | `undefined` | Desired modalities for model output, such as text and audio. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`modalities`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-modalities) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:632](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L632) |\n| `model` | `string` | `undefined` | Name of the model to use for completion. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`model`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-model) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:612](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L612) |\n| `n?` | `number` | `undefined` | Number of completions to generate for each request. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`n`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-n) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:634](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L634) |\n| `onCompiling?` | [`BatteryLifecycleCallback`](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | `undefined` | 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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `onComplete?` | [`BatteryLifecycleCallback`](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | `undefined` | 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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `onError?` | [`BatteryLifecycleCallback`](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | `undefined` | 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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `onGenerating?` | [`BatteryLifecycleCallback`](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | `undefined` | 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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `onInitProgress?` | (`report`: `InitProgressReport`) => `void` | `undefined` | Callback invoked with model-load progress reports. | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L103) |\n| `onLifecycle?` | [`BatteryLifecycleCallback`](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | `undefined` | 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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `onLoading?` | [`BatteryLifecycleCallback`](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | `undefined` | 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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../type-aliases/PromptAssembledObserverFn.md) | `undefined` | Observe the fully-assembled request this battery is about to POST TO the provider — fired once per terminal generation, the instant the body is built and BEFORE the fetch, with the wire `messages`, `tools`, and the complete `requestBody`. The mirror of [onRawGeneration](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-onrawgeneration). Purely observational (return value ignored, errors swallowed). Default absent. An ADK-control key — stripped from the wire request body, never sent to the provider. The request is handed back AS-IS — no redaction — so treat it as potentially sensitive (it may contain auth material that rode the body) if you persist it. See [PromptAssembledObserverFn](../type-aliases/PromptAssembledObserverFn.md). | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`onPromptAssembled`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-onpromptassembled) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:732](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L732) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../type-aliases/RawGenerationObserverFn.md) | `undefined` | Observe the model's RAW response for each completed generation — fired once per terminal generation, after the provider's reply is parsed but before the result is persisted, with the returned assistant content (`rawText`), the residual `cleanedText`, and the extracted `reasoning` / `toolCalls`. Purely observational (return value ignored, errors swallowed). Default absent. An ADK-control key — stripped from the wire request body, never sent to the provider. See [RawGenerationObserverFn](../type-aliases/RawGenerationObserverFn.md). | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`onRawGeneration`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-onrawgeneration) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:722](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L722) |\n| `onReady?` | [`BatteryLifecycleCallback`](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | `undefined` | 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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `parallel_tool_calls?` | `boolean` | `undefined` | Allow the model to emit multiple tool calls in one turn. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`parallel_tool_calls`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-parallel_tool_calls) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:636](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L636) |\n| `prediction?` | { `content`: | `string` | { `text`: `string`; `type`: `\"text\"`; }\\[]; `type`: `\"content\"`; } | `undefined` | Prediction helper to accelerate latency of known content. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`prediction`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-prediction) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:638](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L638) |\n| `prediction.content` | | `string` | { `text`: `string`; `type`: `\"text\"`; }\\[] | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:640](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L640) |\n| `prediction.type` | `\"content\"` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:639](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L639) |\n| `presence_penalty?` | `number` | `undefined` | Presence penalty wire field to encourage new topics. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`presence_penalty`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-presence_penalty) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:643](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L643) |\n| `prompt_cache_key?` | `string` | `undefined` | Vendor cache key for caching system prompts. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`prompt_cache_key`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-prompt_cache_key) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:645](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L645) |\n| `prompt_cache_retention?` | `\"in_memory\"` | `\"24h\"` | `undefined` | Cache retention strategy for cached system prompts. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`prompt_cache_retention`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-prompt_cache_retention) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:647](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L647) |\n| `reasoning_effort?` | `\"none\"` | `\"minimal\"` | `\"low\"` | `\"medium\"` | `\"high\"` | `undefined` | Target reasoning depth/effort for reasoning models. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`reasoning_effort`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-reasoning_effort) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:649](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L649) |\n| `reasoningFieldPrecedence?` | [`ReasoningFieldPrecedence`](../llm/openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md) | `['reasoning', 'reasoning_content']` | Ordered precedence of the wire fields the adapter reads for model reasoning/thinking output. **Remarks** Reasoning is not part of OpenAI's official Chat Completions spec, so OpenAI-compatible providers disagree on the field name: Ollama's `/v1` and current vLLM emit `reasoning`, while legacy vLLM (≤0.8) and the DeepSeek API emit `reasoning_content`. The adapter reads every field in this list that is present on the response. Precedence governs two things. When more than one listed field is present with **identical** content (or only one is present), the adapter emits a single thought attributed to the highest-precedence field. When listed fields are present with **divergent** content, each surfaces as its own thought (ordered by precedence) rather than silently dropping one — a thought stream is the wrong place to lose data. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`reasoningFieldPrecedence`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-reasoningfieldprecedence) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:534](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L534) |\n| `repetition_penalty?` | `number` | `undefined` | Penalty applied to repeated tokens (WebLLM/MLC sampling parameter). | - | [src/batteries/llm/webllm\\_chat\\_completions/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L84) |\n| `replayCompatibility?` | readonly `string`\\[] | `undefined` | List of replay labels supported by the assistant. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`replayCompatibility`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-replaycompatibility) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L515) |\n| `response_format?` | | { `type`: `\"text\"`; } | { `type`: `\"json_object\"`; } | { `json_schema`: { `description?`: `string`; `name`: `string`; `schema`: [`JsonSchema`](JsonSchema.md); `strict?`: `boolean`; }; `type`: `\"json_schema\"`; } | `undefined` | Enforces a specific output format, e.g. JSON schema. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`response_format`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-response_format) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:651](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L651) |\n| `safety_identifier?` | `string` | `undefined` | Unique safety system identifier or configuration ID. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`safety_identifier`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-safety_identifier) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:664](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L664) |\n| `seed?` | `number` | `undefined` | Deterministic random seed for generation. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`seed`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-seed) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:666](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L666) |\n| `selfIdentity?` | `string` | `undefined` | Unique identity label for the assistant instance. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`selfIdentity`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-selfidentity) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:509](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L509) |\n| `service_tier?` | `\"default\"` | `\"auto\"` | `\"flex\"` | `\"scale\"` | `\"priority\"` | `undefined` | Service reliability tier for processing the request. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`service_tier`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-service_tier) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:668](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L668) |\n| `spoolStore?` | [`SpoolStore`](../../common/type-aliases/SpoolStore.md) | a new `InMemorySpoolStore` per dispatch | Backing store for `string` / `Uint8Array` tool returns. Tool output bytes are written under the tool call's id; the resulting [@nhtio/adk!SpooledArtifact](../../spooled_artifact/classes/SpooledArtifact.md) (or the tool's configured subclass) is the model-visible handle for the rest of the turn. **Remarks** Defaults to a fresh, ephemeral per-dispatch [@nhtio/adk/batteries/storage/in\\_memory!InMemorySpoolStore](../storage/in_memory/classes/InMemorySpoolStore.md). Inject an [@nhtio/adk/batteries/storage/opfs!OpfsSpoolStore](../storage/opfs/classes/OpfsSpoolStore.md) or a Flydrive-backed store to persist artifacts to durable storage (and to stream large/binary tool output to disk rather than buffering it in memory). **Lifetime / namespacing:** the default store is per-dispatch, so tool-call ids only need to be unique within a dispatch. An injected durable store persists across turns and dispatches, so the tool-call ids used as keys must be globally unique for that store (or the store must apply its own `keyPrefix`); the adapter does not namespace keys for you, and it does not delete entries — lifetime and cleanup of an injected store are the consumer's responsibility. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`spoolStore`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-spoolstore) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:557](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L557) |\n| `stop?` | `string` | `string`\\[] | `undefined` | Custom stop sequence strings. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`stop`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-stop) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:670](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L670) |\n| `store?` | `boolean` | `undefined` | Request the provider to store the completed trace. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`store`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-store) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:672](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L672) |\n| `stream?` | `boolean` | `undefined` | Whether to stream the completion response chunk by chunk. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`stream`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-stream) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:495](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L495) |\n| `stream_options?` | { `include_obfuscation?`: `boolean`; `include_usage?`: `boolean`; } | `undefined` | Configuration options for response streaming. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`stream_options`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-stream_options) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:674](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L674) |\n| `stream_options.include_obfuscation?` | `boolean` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:674](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L674) |\n| `stream_options.include_usage?` | `boolean` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:674](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L674) |\n| `streamIdleTimeoutMs?` | `number` | `undefined` | Idle timeout in milliseconds for the stream before aborting. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`streamIdleTimeoutMs`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-streamidletimeoutms) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:497](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L497) |\n| `strictToolChoice?` | `boolean` | `false` | When `tool_choice` (or the `allowed_tools` variant) forces the model onto a specific tool name, and that name resolves to an ephemeral, forged artifact-query tool (one produced by `.forgeTools(ctx)` — i.e. `tool.ephemeral === true`), this flag controls how the adapter reacts: - `false` (default): emit a single `helpers.log.warn({ kind: 'tool-choice-forged-artifact', ... })` record and continue. Forging an artifact-query tool by name is almost always a misconfiguration — the tool may not exist in the next iteration once the artifact ages out — but the call still goes through. - `true`: hard-fail with `E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS`. Use this in production deployments where forcing a forged tool indicates a real bug. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`strictToolChoice`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-stricttoolchoice) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:573](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L573) |\n| `temperature?` | `number` | `undefined` | Sampling temperature control. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`temperature`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-temperature) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:676](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L676) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | `undefined` | Determines which thoughts are surfaced back to the model. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`thoughtSurfacing`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-thoughtsurfacing) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L511) |\n| `tokenEncoding?` | [`TokenEncodingId`](../../type-aliases/TokenEncodingId.md) | `null` | `undefined` | Tokenizer encoding configuration for token counting. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`tokenEncoding`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-tokenencoding) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L513) |\n| `tool_choice?` | | `\"required\"` | `\"auto\"` | `\"none\"` | { `function`: { `name`: `string`; }; `type`: `\"function\"`; } | { `custom`: { `name`: `string`; }; `type`: `\"custom\"`; } | { `allowed_tools`: { `mode`: `\"required\"` | `\"auto\"`; `tools`: ( | { `function`: { `name`: `string`; }; `type`: `\"function\"`; } | { `custom`: { `name`: `string`; }; `type`: `\"custom\"`; })\\[]; }; `type`: `\"allowed_tools\"`; } | `undefined` | Enforce or disable tool execution selection. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`tool_choice`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-tool_choice) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:678](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L678) |\n| `toolCallIdFilter?` | [`ToolCallIdFilterFn`](../type-aliases/ToolCallIdFilterFn.md) | `undefined` | Optional ingress hook for adapting provider tool-call ids; absent preserves the vendor id. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`toolCallIdFilter`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-toolcallidfilter) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:753](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L753) |\n| `top_logprobs?` | `number` | `undefined` | Top log probability tokens limit. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`top_logprobs`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-top_logprobs) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:695](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L695) |\n| `top_p?` | `number` | `undefined` | Nucleus sampling probability threshold. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`top_p`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-top_p) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:697](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L697) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../llm/transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `'throw'` | Policy for how the adapter handles a [@nhtio/adk!Media](../../common/classes/Media.md) instance whose modality the OpenAI Chat Completions wire format does not natively support (today: video). See [UnsupportedMediaPolicy](../llm/transformers_js/type-aliases/UnsupportedMediaPolicy.md). | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`unsupportedMediaPolicy`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-unsupportedmediapolicy) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:582](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L582) |\n| `user?` | `string` | `undefined` | End-user identifier for abuse monitoring. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`user`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-user) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:699](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L699) |\n| `verbosity?` | `\"low\"` | `\"medium\"` | `\"high\"` | `undefined` | Diagnostics verbosity level. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`verbosity`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-verbosity) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:701](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L701) |\n| `web_search_options?` | { `search_context_size?`: `\"low\"` | `\"medium\"` | `\"high\"`; `user_location?`: { `approximate`: { `city?`: `string`; `country?`: `string`; `region?`: `string`; `timezone?`: `string`; }; `type`: `\"approximate\"`; }; } | `undefined` | Configuration for built-in web search. | [`OpenAIChatCompletionsAdapterOptions`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md).[`web_search_options`](../llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md#property-web_search_options) | [src/batteries/llm/openai\\_chat\\_completions/types.ts:703](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L703) |\n| `web_search_options.search_context_size?` | `\"low\"` | `\"medium\"` | `\"high\"` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:704](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L704) |\n| `web_search_options.user_location?` | { `approximate`: { `city?`: `string`; `country?`: `string`; `region?`: `string`; `timezone?`: `string`; }; `type`: `\"approximate\"`; } | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:705](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L705) |\n| `web_search_options.user_location.approximate` | { `city?`: `string`; `country?`: `string`; `region?`: `string`; `timezone?`: `string`; } | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:707](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L707) |\n| `web_search_options.user_location.approximate.city?` | `string` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:708](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L708) |\n| `web_search_options.user_location.approximate.country?` | `string` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:709](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L709) |\n| `web_search_options.user_location.approximate.region?` | `string` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:710](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L710) |\n| `web_search_options.user_location.approximate.timezone?` | `string` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:711](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L711) |\n| `web_search_options.user_location.type` | `\"approximate\"` | `undefined` | - | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:706](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L706) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/interfaces/WireError","title":"Interface: WireError","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/WireError.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/interfaces/WireError","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/WireError.md'\ndescription: >-\n An error as it crosses the wire. `message`/`name`/`stack` are ALWAYS present\n baseline string fields (never omitted, regardless of encoder availability) so\n error-classification-by-message-signature always works even when the encoder\n is unavailable or fails to decode. `nhtio` carries the\n `@nhtio/encoder`-encoded original `Error` instance when BOTH sides advertised\n `encoderAvailable` on `ready` — the receiving side decodes it for full\n fidelity (custom error subclasses, extra properties) and falls back silently\n to the baseline fields on any decode failure.\n---\n\n# Interface: WireError\n\nDefined in: [src/batteries/isolation/protocol.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L42)\n\nAn error as it crosses the wire. `message`/`name`/`stack` are ALWAYS present baseline string fields\n(never omitted, regardless of encoder availability) so error-classification-by-message-signature\nalways works even when the encoder is unavailable or fails to decode. `nhtio` carries the\n`@nhtio/encoder`-encoded original `Error` instance when BOTH sides advertised `encoderAvailable` on\n`ready` — the receiving side decodes it for full fidelity (custom error subclasses, extra\nproperties) and falls back silently to the baseline fields on any decode failure.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | -------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `message` | `string` | Baseline error message — always populated, even when `nhtio` is absent or fails to decode. | [src/batteries/isolation/protocol.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L44) |\n| `name` | `string` | Baseline error name (e.g. `'TypeError'`) — always populated. | [src/batteries/isolation/protocol.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L46) |\n| `nhtio?` | `string` | `@nhtio/encoder`-encoded original `Error`, when both sides have the encoder. | [src/batteries/isolation/protocol.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L50) |\n| `stack?` | `string` | Baseline stack trace, when the original error had one — always forwarded as-is (never re-derived). | [src/batteries/isolation/protocol.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/isolation/protocol.ts#L48) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm","title":"@nhtio/adk/batteries/llm","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm.md'\ndescription: >-\n Aggregate barrel for bundled LLM adapters and their helper, option, and\n exception exports.\n---\n\n# @nhtio/adk/batteries/llm\n\nAggregate barrel for bundled LLM adapters and their helper, option, and exception exports.\n\n## References\n\n### AnthropicCacheBreakpoints\n\nRe-exports [AnthropicCacheBreakpoints](anthropic_messages/types/type-aliases/AnthropicCacheBreakpoints.md)\n\n***\n\n### AnthropicCacheControlEphemeral\n\nRe-exports [AnthropicCacheControlEphemeral](anthropic_messages/types/type-aliases/AnthropicCacheControlEphemeral.md)\n\n***\n\n### AnthropicCacheTtl\n\nRe-exports [AnthropicCacheTtl](anthropic_messages/types/type-aliases/AnthropicCacheTtl.md)\n\n***\n\n### AnthropicContentBlock\n\nRe-exports [AnthropicContentBlock](anthropic_messages/types/type-aliases/AnthropicContentBlock.md)\n\n***\n\n### AnthropicContentBlockParam\n\nRe-exports [AnthropicContentBlockParam](anthropic_messages/types/type-aliases/AnthropicContentBlockParam.md)\n\n***\n\n### AnthropicDocumentBlockParam\n\nRe-exports [AnthropicDocumentBlockParam](anthropic_messages/types/type-aliases/AnthropicDocumentBlockParam.md)\n\n***\n\n### AnthropicImageBlockParam\n\nRe-exports [AnthropicImageBlockParam](anthropic_messages/types/type-aliases/AnthropicImageBlockParam.md)\n\n***\n\n### AnthropicJSONOutputFormat\n\nRe-exports [AnthropicJSONOutputFormat](anthropic_messages/types/type-aliases/AnthropicJSONOutputFormat.md)\n\n***\n\n### AnthropicMessage\n\nRe-exports [AnthropicMessage](anthropic_messages/types/type-aliases/AnthropicMessage.md)\n\n***\n\n### AnthropicMessageCountTokensParams\n\nRe-exports [AnthropicMessageCountTokensParams](anthropic_messages/types/type-aliases/AnthropicMessageCountTokensParams.md)\n\n***\n\n### AnthropicMessageCreateParams\n\nRe-exports [AnthropicMessageCreateParams](anthropic_messages/types/type-aliases/AnthropicMessageCreateParams.md)\n\n***\n\n### AnthropicMessageCreateParamsBase\n\nRe-exports [AnthropicMessageCreateParamsBase](anthropic_messages/types/type-aliases/AnthropicMessageCreateParamsBase.md)\n\n***\n\n### AnthropicMessageDeltaUsage\n\nRe-exports [AnthropicMessageDeltaUsage](anthropic_messages/types/type-aliases/AnthropicMessageDeltaUsage.md)\n\n***\n\n### AnthropicMessageParam\n\nRe-exports [AnthropicMessageParam](anthropic_messages/types/type-aliases/AnthropicMessageParam.md)\n\n***\n\n### AnthropicMessagesAdapter\n\nRe-exports [AnthropicMessagesAdapter](anthropic_messages/adapter/classes/AnthropicMessagesAdapter.md)\n\n***\n\n### AnthropicMessagesAdapterOptions\n\nRe-exports [AnthropicMessagesAdapterOptions](anthropic_messages/types/interfaces/AnthropicMessagesAdapterOptions.md)\n\n***\n\n### AnthropicMessagesCountTokensDeps\n\nRe-exports [AnthropicMessagesCountTokensDeps](anthropic_messages/count_tokens/interfaces/AnthropicMessagesCountTokensDeps.md)\n\n***\n\n### AnthropicMessagesCountTokensInput\n\nRe-exports [AnthropicMessagesCountTokensInput](anthropic_messages/types/interfaces/AnthropicMessagesCountTokensInput.md)\n\n***\n\n### AnthropicMessagesCountTokensRequestInput\n\nRe-exports [AnthropicMessagesCountTokensRequestInput](anthropic_messages/count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput.md)\n\n***\n\n### AnthropicMessagesHelpers\n\nRe-exports [AnthropicMessagesHelpers](anthropic_messages/types/interfaces/AnthropicMessagesHelpers.md)\n\n***\n\n### anthropicMessagesOptionsSchema\n\nRe-exports [anthropicMessagesOptionsSchema](anthropic_messages/validation/variables/anthropicMessagesOptionsSchema.md)\n\n***\n\n### AnthropicMessageTokensCount\n\nRe-exports [AnthropicMessageTokensCount](anthropic_messages/types/type-aliases/AnthropicMessageTokensCount.md)\n\n***\n\n### AnthropicModel\n\nRe-exports [AnthropicModel](anthropic_messages/types/type-aliases/AnthropicModel.md)\n\n***\n\n### AnthropicOutputConfig\n\nRe-exports [AnthropicOutputConfig](anthropic_messages/types/type-aliases/AnthropicOutputConfig.md)\n\n***\n\n### AnthropicRawContentBlockDelta\n\nRe-exports [AnthropicRawContentBlockDelta](anthropic_messages/types/type-aliases/AnthropicRawContentBlockDelta.md)\n\n***\n\n### AnthropicRawContentBlockDeltaEvent\n\nRe-exports [AnthropicRawContentBlockDeltaEvent](anthropic_messages/types/type-aliases/AnthropicRawContentBlockDeltaEvent.md)\n\n***\n\n### AnthropicRawContentBlockStartEvent\n\nRe-exports [AnthropicRawContentBlockStartEvent](anthropic_messages/types/type-aliases/AnthropicRawContentBlockStartEvent.md)\n\n***\n\n### AnthropicRawContentBlockStopEvent\n\nRe-exports [AnthropicRawContentBlockStopEvent](anthropic_messages/types/type-aliases/AnthropicRawContentBlockStopEvent.md)\n\n***\n\n### AnthropicRawMessageDeltaEvent\n\nRe-exports [AnthropicRawMessageDeltaEvent](anthropic_messages/types/type-aliases/AnthropicRawMessageDeltaEvent.md)\n\n***\n\n### AnthropicRawMessageStartEvent\n\nRe-exports [AnthropicRawMessageStartEvent](anthropic_messages/types/type-aliases/AnthropicRawMessageStartEvent.md)\n\n***\n\n### AnthropicRawMessageStopEvent\n\nRe-exports [AnthropicRawMessageStopEvent](anthropic_messages/types/type-aliases/AnthropicRawMessageStopEvent.md)\n\n***\n\n### AnthropicRawMessageStreamEvent\n\nRe-exports [AnthropicRawMessageStreamEvent](anthropic_messages/types/type-aliases/AnthropicRawMessageStreamEvent.md)\n\n***\n\n### AnthropicRedactedThinkingBlock\n\nRe-exports [AnthropicRedactedThinkingBlock](anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlock.md)\n\n***\n\n### AnthropicRedactedThinkingBlockParam\n\nRe-exports [AnthropicRedactedThinkingBlockParam](anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlockParam.md)\n\n***\n\n### AnthropicRefusalStopDetails\n\nRe-exports [AnthropicRefusalStopDetails](anthropic_messages/types/type-aliases/AnthropicRefusalStopDetails.md)\n\n***\n\n### AnthropicStopReason\n\nRe-exports [AnthropicStopReason](anthropic_messages/types/type-aliases/AnthropicStopReason.md)\n\n***\n\n### AnthropicTextBlockParam\n\nRe-exports [AnthropicTextBlockParam](anthropic_messages/types/type-aliases/AnthropicTextBlockParam.md)\n\n***\n\n### AnthropicThinkingBlock\n\nRe-exports [AnthropicThinkingBlock](anthropic_messages/types/type-aliases/AnthropicThinkingBlock.md)\n\n***\n\n### AnthropicThinkingBlockParam\n\nRe-exports [AnthropicThinkingBlockParam](anthropic_messages/types/type-aliases/AnthropicThinkingBlockParam.md)\n\n***\n\n### AnthropicThinkingConfigParam\n\nRe-exports [AnthropicThinkingConfigParam](anthropic_messages/types/type-aliases/AnthropicThinkingConfigParam.md)\n\n***\n\n### AnthropicThinkingReplayPayload\n\nRe-exports [AnthropicThinkingReplayPayload](anthropic_messages/types/type-aliases/AnthropicThinkingReplayPayload.md)\n\n***\n\n### AnthropicTool\n\nRe-exports [AnthropicTool](anthropic_messages/types/type-aliases/AnthropicTool.md)\n\n***\n\n### AnthropicToolChoice\n\nRe-exports [AnthropicToolChoice](anthropic_messages/types/type-aliases/AnthropicToolChoice.md)\n\n***\n\n### AnthropicToolResultBlockParam\n\nRe-exports [AnthropicToolResultBlockParam](anthropic_messages/types/type-aliases/AnthropicToolResultBlockParam.md)\n\n***\n\n### AnthropicToolUseBlock\n\nRe-exports [AnthropicToolUseBlock](anthropic_messages/types/type-aliases/AnthropicToolUseBlock.md)\n\n***\n\n### AnthropicToolUseBlockParam\n\nRe-exports [AnthropicToolUseBlockParam](anthropic_messages/types/type-aliases/AnthropicToolUseBlockParam.md)\n\n***\n\n### AnthropicUsage\n\nRe-exports [AnthropicUsage](anthropic_messages/types/type-aliases/AnthropicUsage.md)\n\n***\n\n### AssembledToolCall\n\nRe-exports [AssembledToolCall](openai_chat_completions/types/interfaces/AssembledToolCall.md)\n\n***\n\n### buildChatCompletionsHistory\n\nRe-exports [buildChatCompletionsHistory](openai_chat_completions/helpers/functions/buildChatCompletionsHistory.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsChunk\n\nRe-exports [ChatCompletionsChunk](openai_chat_completions/types/interfaces/ChatCompletionsChunk.md)\n\n***\n\n### ChatCompletionsHelpers\n\nRe-exports [ChatCompletionsHelpers](openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### ChatCompletionsMessage\n\nRe-exports [ChatCompletionsMessage](openai_chat_completions/types/interfaces/ChatCompletionsMessage.md)\n\n***\n\n### ChatCompletionsResponse\n\nRe-exports [ChatCompletionsResponse](openai_chat_completions/types/interfaces/ChatCompletionsResponse.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../interfaces/ChatCompletionsTool.md)\n\n***\n\n### ChatCompletionsToolCallDelta\n\nRe-exports [ChatCompletionsToolCallDelta](openai_chat_completions/types/interfaces/ChatCompletionsToolCallDelta.md)\n\n***\n\n### ChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [ChatCompletionsToolCallDeltaAccumulator](openai_chat_completions/types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### ClaudeCodeCliAdapter\n\nRe-exports [ClaudeCodeCliAdapter](claude_code_cli/adapter/classes/ClaudeCodeCliAdapter.md)\n\n***\n\n### ClaudeCodeCliAdapterOptions\n\nRe-exports [ClaudeCodeCliAdapterOptions](claude_code_cli/types/interfaces/ClaudeCodeCliAdapterOptions.md)\n\n***\n\n### ClaudeCodeCliExtraArg\n\nRe-exports [ClaudeCodeCliExtraArg](claude_code_cli/wire/interfaces/ClaudeCodeCliExtraArg.md)\n\n***\n\n### ClaudeCodeCliHelpers\n\nRe-exports [ClaudeCodeCliHelpers](claude_code_cli/types/interfaces/ClaudeCodeCliHelpers.md)\n\n***\n\n### claudeCodeCliOptionsSchema\n\nRe-exports [claudeCodeCliOptionsSchema](claude_code_cli/validation/variables/claudeCodeCliOptionsSchema.md)\n\n***\n\n### createChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [createChatCompletionsToolCallDeltaAccumulator](openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### deCollideToolCallIds\n\nRe-exports [deCollideToolCallIds](../variables/deCollideToolCallIds.md)\n\n***\n\n### defaultBuildChatCompletionsHistory\n\nRe-exports [defaultBuildChatCompletionsHistory](openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory.md)\n\n***\n\n### defaultCreateChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [defaultCreateChatCompletionsToolCallDeltaAccumulator](openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderChatCompletionsToolCallResult\n\nRe-exports [defaultRenderChatCompletionsToolCallResult](openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTimelineMessage\n\nRe-exports [defaultRenderTimelineMessage](openai_chat_completions/helpers/variables/defaultRenderTimelineMessage.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW](anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR](anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS](anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT](anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR](anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED](anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_ERROR.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_STALLED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_TURN_FAILED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR](claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR.md)\n\n***\n\n### E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS](anthropic_messages/exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS](claude_code_cli/exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_LITERT\\_LM\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_LITERT\\_LM\\_OPTIONS](litert_lm/exceptions/variables/E_INVALID_LITERT_LM_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OLLAMA\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OLLAMA\\_OPTIONS](ollama/exceptions/variables/E_INVALID_OLLAMA_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS](openai_chat_completions/exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS](openai_responses/exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS](transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS](webllm_chat_completions/exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md)\n\n***\n\n### E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW](litert_lm/exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS](litert_lm/exceptions/variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_LITERT\\_LM\\_STREAM\\_ERROR\n\nRe-exports [E\\_LITERT\\_LM\\_STREAM\\_ERROR](litert_lm/exceptions/variables/E_LITERT_LM_STREAM_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OLLAMA\\_CONTEXT\\_OVERFLOW](ollama/exceptions/variables/E_OLLAMA_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OLLAMA\\_HTTP\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_HTTP\\_ERROR](ollama/exceptions/variables/E_OLLAMA_HTTP_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS](ollama/exceptions/variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OLLAMA\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OLLAMA\\_REQUEST\\_TIMEOUT](ollama/exceptions/variables/E_OLLAMA_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OLLAMA\\_STREAM\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_STREAM\\_ERROR](ollama/exceptions/variables/E_OLLAMA_STREAM_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_STREAM\\_STALLED\n\nRe-exports [E\\_OLLAMA\\_STREAM\\_STALLED](ollama/exceptions/variables/E_OLLAMA_STREAM_STALLED.md)\n\n***\n\n### E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY](ollama/exceptions/variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR](openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT](openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED](openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_STALLED.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](openai_responses/exceptions/variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_STREAM_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../functions/filterThoughts.md)\n\n***\n\n### floorTrustTier\n\nRe-exports [floorTrustTier](../functions/floorTrustTier.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../interfaces/JsonSchema.md)\n\n***\n\n### LiteRtLmAdapter\n\nRe-exports [LiteRtLmAdapter](litert_lm/adapter/classes/LiteRtLmAdapter.md)\n\n***\n\n### LiteRtLmAdapterOptions\n\nRe-exports [LiteRtLmAdapterOptions](litert_lm/types/interfaces/LiteRtLmAdapterOptions.md)\n\n***\n\n### LiteRtLmConversation\n\nRe-exports [LiteRtLmConversation](litert_lm/types/type-aliases/LiteRtLmConversation.md)\n\n***\n\n### LiteRtLmEngine\n\nRe-exports [LiteRtLmEngine](litert_lm/types/type-aliases/LiteRtLmEngine.md)\n\n***\n\n### liteRtLmOptionsSchema\n\nRe-exports [liteRtLmOptionsSchema](litert_lm/validation/variables/liteRtLmOptionsSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../interfaces/MemoryAttrs.md)\n\n***\n\n### neutraliseDeveloperRulesTag\n\nRe-exports [neutraliseDeveloperRulesTag](../functions/neutraliseDeveloperRulesTag.md)\n\n***\n\n### OllamaAdapter\n\nRe-exports [OllamaAdapter](ollama/adapter/classes/OllamaAdapter.md)\n\n***\n\n### OllamaAdapterOptions\n\nRe-exports [OllamaAdapterOptions](ollama/types/interfaces/OllamaAdapterOptions.md)\n\n***\n\n### OllamaChatRequestBody\n\nRe-exports [OllamaChatRequestBody](ollama/types/interfaces/OllamaChatRequestBody.md)\n\n***\n\n### OllamaChatResponse\n\nRe-exports [OllamaChatResponse](ollama/types/interfaces/OllamaChatResponse.md)\n\n***\n\n### OllamaChatStreamChunk\n\nRe-exports [OllamaChatStreamChunk](ollama/types/interfaces/OllamaChatStreamChunk.md)\n\n***\n\n### OllamaFormat\n\nRe-exports [OllamaFormat](ollama/types/type-aliases/OllamaFormat.md)\n\n***\n\n### OllamaHelpers\n\nRe-exports [OllamaHelpers](ollama/types/interfaces/OllamaHelpers.md)\n\n***\n\n### OllamaMessage\n\nRe-exports [OllamaMessage](ollama/types/interfaces/OllamaMessage.md)\n\n***\n\n### ollamaOptionsSchema\n\nRe-exports [ollamaOptionsSchema](ollama/validation/variables/ollamaOptionsSchema.md)\n\n***\n\n### OllamaRuntimeOptions\n\nRe-exports [OllamaRuntimeOptions](ollama/types/interfaces/OllamaRuntimeOptions.md)\n\n***\n\n### OllamaThink\n\nRe-exports [OllamaThink](ollama/types/type-aliases/OllamaThink.md)\n\n***\n\n### OllamaTool\n\nRe-exports [OllamaTool](ollama/types/type-aliases/OllamaTool.md)\n\n***\n\n### OllamaToolCall\n\nRe-exports [OllamaToolCall](ollama/types/interfaces/OllamaToolCall.md)\n\n***\n\n### OpenAIChatCompletionsAdapter\n\nRe-exports [OpenAIChatCompletionsAdapter](openai_chat_completions/adapter/classes/OpenAIChatCompletionsAdapter.md)\n\n***\n\n### OpenAIChatCompletionsAdapterOptions\n\nRe-exports [OpenAIChatCompletionsAdapterOptions](openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md)\n\n***\n\n### openAIChatCompletionsOptionsSchema\n\nRe-exports [openAIChatCompletionsOptionsSchema](openai_chat_completions/validation/variables/openAIChatCompletionsOptionsSchema.md)\n\n***\n\n### OpenAIChatCompletionsRequestBody\n\nRe-exports [OpenAIChatCompletionsRequestBody](openai_chat_completions/types/interfaces/OpenAIChatCompletionsRequestBody.md)\n\n***\n\n### OpenAIResponsesAdapter\n\nRe-exports [OpenAIResponsesAdapter](openai_responses/adapter/classes/OpenAIResponsesAdapter.md)\n\n***\n\n### OpenAIResponsesAdapterOptions\n\nRe-exports [OpenAIResponsesAdapterOptions](openai_responses/types/interfaces/OpenAIResponsesAdapterOptions.md)\n\n***\n\n### OpenAIResponsesCompletedEvent\n\nRe-exports [OpenAIResponsesCompletedEvent](openai_responses/types/interfaces/OpenAIResponsesCompletedEvent.md)\n\n***\n\n### OpenAIResponsesErrorEvent\n\nRe-exports [OpenAIResponsesErrorEvent](openai_responses/types/interfaces/OpenAIResponsesErrorEvent.md)\n\n***\n\n### OpenAIResponsesFailedEvent\n\nRe-exports [OpenAIResponsesFailedEvent](openai_responses/types/interfaces/OpenAIResponsesFailedEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallArgumentsDeltaEvent\n\nRe-exports [OpenAIResponsesFunctionCallArgumentsDeltaEvent](openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallArgumentsDoneEvent\n\nRe-exports [OpenAIResponsesFunctionCallArgumentsDoneEvent](openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallItem\n\nRe-exports [OpenAIResponsesFunctionCallItem](openai_responses/types/interfaces/OpenAIResponsesFunctionCallItem.md)\n\n***\n\n### OpenAIResponsesFunctionCallOutputItem\n\nRe-exports [OpenAIResponsesFunctionCallOutputItem](openai_responses/types/interfaces/OpenAIResponsesFunctionCallOutputItem.md)\n\n***\n\n### OpenAIResponsesHelpers\n\nRe-exports [OpenAIResponsesHelpers](openai_responses/types/interfaces/OpenAIResponsesHelpers.md)\n\n***\n\n### OpenAIResponsesIncludable\n\nRe-exports [OpenAIResponsesIncludable](openai_responses/types/type-aliases/OpenAIResponsesIncludable.md)\n\n***\n\n### OpenAIResponsesIncompleteEvent\n\nRe-exports [OpenAIResponsesIncompleteEvent](openai_responses/types/interfaces/OpenAIResponsesIncompleteEvent.md)\n\n***\n\n### OpenAIResponsesInputContentBlock\n\nRe-exports [OpenAIResponsesInputContentBlock](openai_responses/types/type-aliases/OpenAIResponsesInputContentBlock.md)\n\n***\n\n### OpenAIResponsesInputItem\n\nRe-exports [OpenAIResponsesInputItem](openai_responses/types/type-aliases/OpenAIResponsesInputItem.md)\n\n***\n\n### OpenAIResponsesMessageItem\n\nRe-exports [OpenAIResponsesMessageItem](openai_responses/types/interfaces/OpenAIResponsesMessageItem.md)\n\n***\n\n### OpenAIResponsesOpaqueOutputItem\n\nRe-exports [OpenAIResponsesOpaqueOutputItem](openai_responses/types/interfaces/OpenAIResponsesOpaqueOutputItem.md)\n\n***\n\n### openAIResponsesOptionsSchema\n\nRe-exports [openAIResponsesOptionsSchema](openai_responses/validation/variables/openAIResponsesOptionsSchema.md)\n\n***\n\n### OpenAIResponsesOutputItem\n\nRe-exports [OpenAIResponsesOutputItem](openai_responses/types/type-aliases/OpenAIResponsesOutputItem.md)\n\n***\n\n### OpenAIResponsesOutputItemAddedEvent\n\nRe-exports [OpenAIResponsesOutputItemAddedEvent](openai_responses/types/interfaces/OpenAIResponsesOutputItemAddedEvent.md)\n\n***\n\n### OpenAIResponsesOutputItemDoneEvent\n\nRe-exports [OpenAIResponsesOutputItemDoneEvent](openai_responses/types/interfaces/OpenAIResponsesOutputItemDoneEvent.md)\n\n***\n\n### OpenAIResponsesOutputMessageContentPart\n\nRe-exports [OpenAIResponsesOutputMessageContentPart](openai_responses/types/type-aliases/OpenAIResponsesOutputMessageContentPart.md)\n\n***\n\n### OpenAIResponsesOutputMessageItem\n\nRe-exports [OpenAIResponsesOutputMessageItem](openai_responses/types/interfaces/OpenAIResponsesOutputMessageItem.md)\n\n***\n\n### OpenAIResponsesOutputTextDeltaEvent\n\nRe-exports [OpenAIResponsesOutputTextDeltaEvent](openai_responses/types/interfaces/OpenAIResponsesOutputTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesOutputTextDoneEvent\n\nRe-exports [OpenAIResponsesOutputTextDoneEvent](openai_responses/types/interfaces/OpenAIResponsesOutputTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesReasoningContentPart\n\nRe-exports [OpenAIResponsesReasoningContentPart](openai_responses/types/interfaces/OpenAIResponsesReasoningContentPart.md)\n\n***\n\n### OpenAIResponsesReasoningItem\n\nRe-exports [OpenAIResponsesReasoningItem](openai_responses/types/interfaces/OpenAIResponsesReasoningItem.md)\n\n***\n\n### OpenAIResponsesReasoningReplayPayload\n\nRe-exports [OpenAIResponsesReasoningReplayPayload](openai_responses/types/interfaces/OpenAIResponsesReasoningReplayPayload.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryPart\n\nRe-exports [OpenAIResponsesReasoningSummaryPart](openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryPart.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryTextDeltaEvent\n\nRe-exports [OpenAIResponsesReasoningSummaryTextDeltaEvent](openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryTextDoneEvent\n\nRe-exports [OpenAIResponsesReasoningSummaryTextDoneEvent](openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesReasoningTextDeltaEvent\n\nRe-exports [OpenAIResponsesReasoningTextDeltaEvent](openai_responses/types/interfaces/OpenAIResponsesReasoningTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesReasoningTextDoneEvent\n\nRe-exports [OpenAIResponsesReasoningTextDoneEvent](openai_responses/types/interfaces/OpenAIResponsesReasoningTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesRefusalDeltaEvent\n\nRe-exports [OpenAIResponsesRefusalDeltaEvent](openai_responses/types/interfaces/OpenAIResponsesRefusalDeltaEvent.md)\n\n***\n\n### OpenAIResponsesRefusalDoneEvent\n\nRe-exports [OpenAIResponsesRefusalDoneEvent](openai_responses/types/interfaces/OpenAIResponsesRefusalDoneEvent.md)\n\n***\n\n### OpenAIResponsesRequestBody\n\nRe-exports [OpenAIResponsesRequestBody](openai_responses/types/interfaces/OpenAIResponsesRequestBody.md)\n\n***\n\n### OpenAIResponsesResponseObject\n\nRe-exports [OpenAIResponsesResponseObject](openai_responses/types/interfaces/OpenAIResponsesResponseObject.md)\n\n***\n\n### OpenAIResponsesStreamEvent\n\nRe-exports [OpenAIResponsesStreamEvent](openai_responses/types/type-aliases/OpenAIResponsesStreamEvent.md)\n\n***\n\n### OpenAIResponsesTool\n\nRe-exports [OpenAIResponsesTool](openai_responses/types/type-aliases/OpenAIResponsesTool.md)\n\n***\n\n### OpenAIResponsesToolChoice\n\nRe-exports [OpenAIResponsesToolChoice](openai_responses/types/type-aliases/OpenAIResponsesToolChoice.md)\n\n***\n\n### OpenAIResponsesUsage\n\nRe-exports [OpenAIResponsesUsage](openai_responses/types/interfaces/OpenAIResponsesUsage.md)\n\n***\n\n### PromptAssembledObservation\n\nRe-exports [PromptAssembledObservation](../interfaces/PromptAssembledObservation.md)\n\n***\n\n### PromptAssembledObserverFn\n\nRe-exports [PromptAssembledObserverFn](../type-aliases/PromptAssembledObserverFn.md)\n\n***\n\n### RawGenerationObservation\n\nRe-exports [RawGenerationObservation](../interfaces/RawGenerationObservation.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### ReasoningExtract\n\nRe-exports [ReasoningExtract](openai_chat_completions/types/interfaces/ReasoningExtract.md)\n\n***\n\n### ReasoningField\n\nRe-exports [ReasoningField](openai_chat_completions/types/type-aliases/ReasoningField.md)\n\n***\n\n### ReasoningFieldPrecedence\n\nRe-exports [ReasoningFieldPrecedence](openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md)\n\n***\n\n### ReasoningParserFn\n\nRe-exports [ReasoningParserFn](transformers_js/helpers/type-aliases/ReasoningParserFn.md)\n\n***\n\n### ReasoningParserName\n\nRe-exports [ReasoningParserName](transformers_js/helpers/type-aliases/ReasoningParserName.md)\n\n***\n\n### ReasoningReplayMode\n\nRe-exports [ReasoningReplayMode](openai_responses/types/type-aliases/ReasoningReplayMode.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderChatCompletionsToolCallResult\n\nRe-exports [renderChatCompletionsToolCallResult](openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../functions/renderMemories.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../functions/renderThought.md)\n\n***\n\n### renderTimelineMessage\n\nRe-exports [renderTimelineMessage](openai_chat_completions/helpers/functions/renderTimelineMessage.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../functions/renderUntrustedContent.md)\n\n***\n\n### ResponsesOutputSlot\n\nRe-exports [ResponsesOutputSlot](openai_responses/types/type-aliases/ResponsesOutputSlot.md)\n\n***\n\n### ResponsesOutputSlotMachine\n\nRe-exports [ResponsesOutputSlotMachine](openai_responses/types/interfaces/ResponsesOutputSlotMachine.md)\n\n***\n\n### ResponsesTextSlot\n\nRe-exports [ResponsesTextSlot](openai_responses/types/interfaces/ResponsesTextSlot.md)\n\n***\n\n### ResponsesThinkingSlot\n\nRe-exports [ResponsesThinkingSlot](openai_responses/types/interfaces/ResponsesThinkingSlot.md)\n\n***\n\n### ResponsesToolCallSlot\n\nRe-exports [ResponsesToolCallSlot](openai_responses/types/interfaces/ResponsesToolCallSlot.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../interfaces/RetrievableAttrs.md)\n\n***\n\n### sanitizeFilenameForDescription\n\nRe-exports [sanitizeFilenameForDescription](../functions/sanitizeFilenameForDescription.md)\n\n***\n\n### sanitizeMimeType\n\nRe-exports [sanitizeMimeType](../functions/sanitizeMimeType.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### stripEnvelopeSpecialTokens\n\nRe-exports [stripEnvelopeSpecialTokens](../functions/stripEnvelopeSpecialTokens.md)\n\n***\n\n### SystemPromptChannel\n\nRe-exports [SystemPromptChannel](openai_responses/types/type-aliases/SystemPromptChannel.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../functions/toolsToChatCompletionsTools.md)\n\n***\n\n### TransformersJsAdapter\n\nRe-exports [TransformersJsAdapter](transformers_js/adapter/classes/TransformersJsAdapter.md)\n\n***\n\n### TransformersJsAdapterOptions\n\nRe-exports [TransformersJsAdapterOptions](transformers_js/types/interfaces/TransformersJsAdapterOptions.md)\n\n***\n\n### TransformersJsMessage\n\nRe-exports [TransformersJsMessage](transformers_js/types/type-aliases/TransformersJsMessage.md)\n\n***\n\n### transformersJsOptionsSchema\n\nRe-exports [transformersJsOptionsSchema](transformers_js/validation/variables/transformersJsOptionsSchema.md)\n\n***\n\n### TransformersJsPipeline\n\nRe-exports [TransformersJsPipeline](transformers_js/types/type-aliases/TransformersJsPipeline.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateAnthropicMessagesOptions\n\nRenames and re-exports [validateOptions](anthropic_messages/validation/functions/validateOptions.md)\n\n***\n\n### validateClaudeCodeCliOptions\n\nRenames and re-exports [validateOptions](claude_code_cli/validation/functions/validateOptions.md)\n\n***\n\n### validateLiteRtLmOptions\n\nRenames and re-exports [validateOptions](litert_lm/validation/functions/validateOptions.md)\n\n***\n\n### validateOllamaOptions\n\nRenames and re-exports [validateOptions](ollama/validation/functions/validateOptions.md)\n\n***\n\n### validateOpenAIResponsesOptions\n\nRenames and re-exports [validateOptions](openai_responses/validation/functions/validateOptions.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](openai_chat_completions/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsOptions\n\nRenames and re-exports [validateOptions](transformers_js/validation/functions/validateOptions.md)\n\n***\n\n### validateWebLLMChatCompletionsOptions\n\nRenames and re-exports [validateOptions](webllm_chat_completions/validation/functions/validateOptions.md)\n\n***\n\n### WebLLMChatCompletionsAdapter\n\nRe-exports [WebLLMChatCompletionsAdapter](webllm_chat_completions/adapter/classes/WebLLMChatCompletionsAdapter.md)\n\n***\n\n### WebLLMChatCompletionsAdapterOptions\n\nRe-exports [WebLLMChatCompletionsAdapterOptions](../interfaces/WebLLMChatCompletionsAdapterOptions.md)\n\n***\n\n### webLLMChatCompletionsOptionsSchema\n\nRe-exports [webLLMChatCompletionsOptionsSchema](webllm_chat_completions/validation/variables/webLLMChatCompletionsOptionsSchema.md)\n\n***\n\n### WebLLMChatCompletionsRequestBody\n\nRe-exports [WebLLMChatCompletionsRequestBody](../type-aliases/WebLLMChatCompletionsRequestBody.md)\n\n***\n\n### WebLLMEngine\n\nRe-exports [WebLLMEngine](../type-aliases/WebLLMEngine.md)\n\n***\n\n### WebLLMInitProgressReport\n\nRe-exports [WebLLMInitProgressReport](../type-aliases/WebLLMInitProgressReport.md)\n\n***\n\n### WrapperAuth\n\nRe-exports [WrapperAuth](claude_code_cli/wire/interfaces/WrapperAuth.md)\n\n***\n\n### WrapperBridgedTool\n\nRe-exports [WrapperBridgedTool](claude_code_cli/wire/interfaces/WrapperBridgedTool.md)\n\n***\n\n### WrapperCommand\n\nRe-exports [WrapperCommand](claude_code_cli/wire/type-aliases/WrapperCommand.md)\n\n***\n\n### WrapperErrorEvent\n\nRe-exports [WrapperErrorEvent](claude_code_cli/wire/interfaces/WrapperErrorEvent.md)\n\n***\n\n### WrapperEvent\n\nRe-exports [WrapperEvent](claude_code_cli/wire/type-aliases/WrapperEvent.md)\n\n***\n\n### WrapperInitEvent\n\nRe-exports [WrapperInitEvent](claude_code_cli/wire/interfaces/WrapperInitEvent.md)\n\n***\n\n### WrapperLogEvent\n\nRe-exports [WrapperLogEvent](claude_code_cli/wire/interfaces/WrapperLogEvent.md)\n\n***\n\n### WrapperMessageDeltaEvent\n\nRe-exports [WrapperMessageDeltaEvent](claude_code_cli/wire/interfaces/WrapperMessageDeltaEvent.md)\n\n***\n\n### WrapperReadyEvent\n\nRe-exports [WrapperReadyEvent](claude_code_cli/wire/interfaces/WrapperReadyEvent.md)\n\n***\n\n### WrapperResultEvent\n\nRe-exports [WrapperResultEvent](claude_code_cli/wire/interfaces/WrapperResultEvent.md)\n\n***\n\n### WrapperRetryEvent\n\nRe-exports [WrapperRetryEvent](claude_code_cli/wire/interfaces/WrapperRetryEvent.md)\n\n***\n\n### WrapperRunCommand\n\nRe-exports [WrapperRunCommand](claude_code_cli/wire/interfaces/WrapperRunCommand.md)\n\n***\n\n### WrapperShutdownCommand\n\nRe-exports [WrapperShutdownCommand](claude_code_cli/wire/interfaces/WrapperShutdownCommand.md)\n\n***\n\n### WrapperShutdownCompleteEvent\n\nRe-exports [WrapperShutdownCompleteEvent](claude_code_cli/wire/interfaces/WrapperShutdownCompleteEvent.md)\n\n***\n\n### WrapperThoughtDeltaEvent\n\nRe-exports [WrapperThoughtDeltaEvent](claude_code_cli/wire/interfaces/WrapperThoughtDeltaEvent.md)\n\n***\n\n### WrapperToolCallRequestEvent\n\nRe-exports [WrapperToolCallRequestEvent](claude_code_cli/wire/interfaces/WrapperToolCallRequestEvent.md)\n\n***\n\n### WrapperToolCallResponseCommand\n\nRe-exports [WrapperToolCallResponseCommand](claude_code_cli/wire/interfaces/WrapperToolCallResponseCommand.md)\n\n***\n\n### WrapperToolResultContentBlock\n\nRe-exports [WrapperToolResultContentBlock](claude_code_cli/wire/type-aliases/WrapperToolResultContentBlock.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages","title":"@nhtio/adk/batteries/llm/anthropic\\_messages","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages.md'\ndescription: >-\n Native Anthropic Messages API adapter battery with swappable translation\n helpers and wire types.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages\n\nNative Anthropic Messages API adapter battery with swappable translation helpers and wire types.\n\n## Remarks\n\nOpinionated native Anthropic Messages battery. Ships an `AnthropicMessagesAdapter` that targets\n`client.messages.create` from `@anthropic-ai/sdk` (a hard static dependency of this battery).\nNode-first: an Anthropic API key in a browser bundle is unacceptably exposed, so browser is\ndeliberately not a target for this adapter — `dangerouslyAllowBrowser` exists only for the\ncaller who accepts that risk knowingly.\n\nUnlocks capabilities the OpenAI-compat wire cannot express: native extended thinking (signed\n`thinking`/`redacted_thinking` blocks with replay-safe signature verification), prompt caching\nvia `cache_control` breakpoints, the native four-shape `tool_choice`, and native stop-reason\nfidelity (`pause_turn`, `refusal`, `model_context_window_exceeded`).\n\nRe-exports the adapter class, every translation helper (wire-shape-agnostic helpers are shared\nwith the sibling Chat-family batteries via the internal `chat_common` submodule and re-exported\nhere under their original names, each with a `default*` alias, plus this battery's own\nAnthropic-specific helpers), the option / wire-shape types, the validation schema +\n`validateOptions` wrapper, and the battery-scoped exception classes.\n\n## References\n\n### AnthropicCacheBreakpoints\n\nRe-exports [AnthropicCacheBreakpoints](types/type-aliases/AnthropicCacheBreakpoints.md)\n\n***\n\n### AnthropicCacheControlEphemeral\n\nRe-exports [AnthropicCacheControlEphemeral](types/type-aliases/AnthropicCacheControlEphemeral.md)\n\n***\n\n### AnthropicCacheTtl\n\nRe-exports [AnthropicCacheTtl](types/type-aliases/AnthropicCacheTtl.md)\n\n***\n\n### AnthropicContentBlock\n\nRe-exports [AnthropicContentBlock](types/type-aliases/AnthropicContentBlock.md)\n\n***\n\n### AnthropicContentBlockParam\n\nRe-exports [AnthropicContentBlockParam](types/type-aliases/AnthropicContentBlockParam.md)\n\n***\n\n### AnthropicDocumentBlockParam\n\nRe-exports [AnthropicDocumentBlockParam](types/type-aliases/AnthropicDocumentBlockParam.md)\n\n***\n\n### AnthropicErrorClassification\n\nRe-exports [AnthropicErrorClassification](error_translation/type-aliases/AnthropicErrorClassification.md)\n\n***\n\n### AnthropicImageBlockParam\n\nRe-exports [AnthropicImageBlockParam](types/type-aliases/AnthropicImageBlockParam.md)\n\n***\n\n### AnthropicJSONOutputFormat\n\nRe-exports [AnthropicJSONOutputFormat](types/type-aliases/AnthropicJSONOutputFormat.md)\n\n***\n\n### AnthropicMessage\n\nRe-exports [AnthropicMessage](types/type-aliases/AnthropicMessage.md)\n\n***\n\n### AnthropicMessageCountTokensParams\n\nRe-exports [AnthropicMessageCountTokensParams](types/type-aliases/AnthropicMessageCountTokensParams.md)\n\n***\n\n### AnthropicMessageCreateParams\n\nRe-exports [AnthropicMessageCreateParams](types/type-aliases/AnthropicMessageCreateParams.md)\n\n***\n\n### AnthropicMessageCreateParamsBase\n\nRe-exports [AnthropicMessageCreateParamsBase](types/type-aliases/AnthropicMessageCreateParamsBase.md)\n\n***\n\n### AnthropicMessageDeltaUsage\n\nRe-exports [AnthropicMessageDeltaUsage](types/type-aliases/AnthropicMessageDeltaUsage.md)\n\n***\n\n### AnthropicMessageParam\n\nRe-exports [AnthropicMessageParam](types/type-aliases/AnthropicMessageParam.md)\n\n***\n\n### AnthropicMessagesAdapter\n\nRe-exports [AnthropicMessagesAdapter](adapter/classes/AnthropicMessagesAdapter.md)\n\n***\n\n### AnthropicMessagesAdapterOptions\n\nRe-exports [AnthropicMessagesAdapterOptions](types/interfaces/AnthropicMessagesAdapterOptions.md)\n\n***\n\n### AnthropicMessagesCountTokensDeps\n\nRe-exports [AnthropicMessagesCountTokensDeps](count_tokens/interfaces/AnthropicMessagesCountTokensDeps.md)\n\n***\n\n### AnthropicMessagesCountTokensInput\n\nRe-exports [AnthropicMessagesCountTokensInput](types/interfaces/AnthropicMessagesCountTokensInput.md)\n\n***\n\n### AnthropicMessagesCountTokensRequestInput\n\nRe-exports [AnthropicMessagesCountTokensRequestInput](count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput.md)\n\n***\n\n### AnthropicMessagesErrorStatusInput\n\nRe-exports [AnthropicMessagesErrorStatusInput](types/interfaces/AnthropicMessagesErrorStatusInput.md)\n\n***\n\n### AnthropicMessagesErrorStatusResolver\n\nRe-exports [AnthropicMessagesErrorStatusResolver](types/type-aliases/AnthropicMessagesErrorStatusResolver.md)\n\n***\n\n### AnthropicMessagesHelpers\n\nRe-exports [AnthropicMessagesHelpers](types/interfaces/AnthropicMessagesHelpers.md)\n\n***\n\n### anthropicMessagesOptionsSchema\n\nRe-exports [anthropicMessagesOptionsSchema](validation/variables/anthropicMessagesOptionsSchema.md)\n\n***\n\n### AnthropicMessageTokensCount\n\nRe-exports [AnthropicMessageTokensCount](types/type-aliases/AnthropicMessageTokensCount.md)\n\n***\n\n### AnthropicModel\n\nRe-exports [AnthropicModel](types/type-aliases/AnthropicModel.md)\n\n***\n\n### AnthropicOutputConfig\n\nRe-exports [AnthropicOutputConfig](types/type-aliases/AnthropicOutputConfig.md)\n\n***\n\n### AnthropicRawContentBlockDelta\n\nRe-exports [AnthropicRawContentBlockDelta](types/type-aliases/AnthropicRawContentBlockDelta.md)\n\n***\n\n### AnthropicRawContentBlockDeltaEvent\n\nRe-exports [AnthropicRawContentBlockDeltaEvent](types/type-aliases/AnthropicRawContentBlockDeltaEvent.md)\n\n***\n\n### AnthropicRawContentBlockStartEvent\n\nRe-exports [AnthropicRawContentBlockStartEvent](types/type-aliases/AnthropicRawContentBlockStartEvent.md)\n\n***\n\n### AnthropicRawContentBlockStopEvent\n\nRe-exports [AnthropicRawContentBlockStopEvent](types/type-aliases/AnthropicRawContentBlockStopEvent.md)\n\n***\n\n### AnthropicRawMessageDeltaEvent\n\nRe-exports [AnthropicRawMessageDeltaEvent](types/type-aliases/AnthropicRawMessageDeltaEvent.md)\n\n***\n\n### AnthropicRawMessageStartEvent\n\nRe-exports [AnthropicRawMessageStartEvent](types/type-aliases/AnthropicRawMessageStartEvent.md)\n\n***\n\n### AnthropicRawMessageStopEvent\n\nRe-exports [AnthropicRawMessageStopEvent](types/type-aliases/AnthropicRawMessageStopEvent.md)\n\n***\n\n### AnthropicRawMessageStreamEvent\n\nRe-exports [AnthropicRawMessageStreamEvent](types/type-aliases/AnthropicRawMessageStreamEvent.md)\n\n***\n\n### AnthropicRedactedThinkingBlock\n\nRe-exports [AnthropicRedactedThinkingBlock](types/type-aliases/AnthropicRedactedThinkingBlock.md)\n\n***\n\n### AnthropicRedactedThinkingBlockParam\n\nRe-exports [AnthropicRedactedThinkingBlockParam](types/type-aliases/AnthropicRedactedThinkingBlockParam.md)\n\n***\n\n### AnthropicRefusalStopDetails\n\nRe-exports [AnthropicRefusalStopDetails](types/type-aliases/AnthropicRefusalStopDetails.md)\n\n***\n\n### AnthropicStopReason\n\nRe-exports [AnthropicStopReason](types/type-aliases/AnthropicStopReason.md)\n\n***\n\n### AnthropicTextBlockParam\n\nRe-exports [AnthropicTextBlockParam](types/type-aliases/AnthropicTextBlockParam.md)\n\n***\n\n### AnthropicThinkingBlock\n\nRe-exports [AnthropicThinkingBlock](types/type-aliases/AnthropicThinkingBlock.md)\n\n***\n\n### AnthropicThinkingBlockParam\n\nRe-exports [AnthropicThinkingBlockParam](types/type-aliases/AnthropicThinkingBlockParam.md)\n\n***\n\n### AnthropicThinkingConfigParam\n\nRe-exports [AnthropicThinkingConfigParam](types/type-aliases/AnthropicThinkingConfigParam.md)\n\n***\n\n### AnthropicThinkingReplayPayload\n\nRe-exports [AnthropicThinkingReplayPayload](types/type-aliases/AnthropicThinkingReplayPayload.md)\n\n***\n\n### AnthropicTool\n\nRe-exports [AnthropicTool](types/type-aliases/AnthropicTool.md)\n\n***\n\n### AnthropicToolChoice\n\nRe-exports [AnthropicToolChoice](types/type-aliases/AnthropicToolChoice.md)\n\n***\n\n### AnthropicToolResultBlockParam\n\nRe-exports [AnthropicToolResultBlockParam](types/type-aliases/AnthropicToolResultBlockParam.md)\n\n***\n\n### anthropicToolsFromTools\n\nRe-exports [anthropicToolsFromTools](helpers/functions/anthropicToolsFromTools.md)\n\n***\n\n### AnthropicToolUseBlock\n\nRe-exports [AnthropicToolUseBlock](types/type-aliases/AnthropicToolUseBlock.md)\n\n***\n\n### AnthropicToolUseBlockParam\n\nRe-exports [AnthropicToolUseBlockParam](types/type-aliases/AnthropicToolUseBlockParam.md)\n\n***\n\n### AnthropicUsage\n\nRe-exports [AnthropicUsage](types/type-aliases/AnthropicUsage.md)\n\n***\n\n### buildAnthropicMessagesHistory\n\nRe-exports [buildAnthropicMessagesHistory](helpers/functions/buildAnthropicMessagesHistory.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### CONTEXT\\_OVERFLOW\\_PHRASE\n\nRe-exports [CONTEXT\\_OVERFLOW\\_PHRASE](error_translation/variables/CONTEXT_OVERFLOW_PHRASE.md)\n\n***\n\n### countAnthropicMessagesTokens\n\nRe-exports [countAnthropicMessagesTokens](count_tokens/functions/countAnthropicMessagesTokens.md)\n\n***\n\n### countAnthropicMessagesTokensWithResolvedOptions\n\nRe-exports [countAnthropicMessagesTokensWithResolvedOptions](count_tokens/functions/countAnthropicMessagesTokensWithResolvedOptions.md)\n\n***\n\n### deCollideToolCallIds\n\nRe-exports [deCollideToolCallIds](../../variables/deCollideToolCallIds.md)\n\n***\n\n### defaultAnthropicToolsFromTools\n\nRe-exports [defaultAnthropicToolsFromTools](helpers/variables/defaultAnthropicToolsFromTools.md)\n\n***\n\n### defaultBuildAnthropicMessagesHistory\n\nRe-exports [defaultBuildAnthropicMessagesHistory](helpers/variables/defaultBuildAnthropicMessagesHistory.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderAnthropicMediaBlocks\n\nRe-exports [defaultRenderAnthropicMediaBlocks](helpers/variables/defaultRenderAnthropicMediaBlocks.md)\n\n***\n\n### defaultRenderAnthropicSegmentedSystemPrompt\n\nRe-exports [defaultRenderAnthropicSegmentedSystemPrompt](helpers/variables/defaultRenderAnthropicSegmentedSystemPrompt.md)\n\n***\n\n### defaultRenderAnthropicThinkingBlocks\n\nRe-exports [defaultRenderAnthropicThinkingBlocks](helpers/variables/defaultRenderAnthropicThinkingBlocks.md)\n\n***\n\n### defaultRenderAnthropicTimelineMessage\n\nRe-exports [defaultRenderAnthropicTimelineMessage](helpers/variables/defaultRenderAnthropicTimelineMessage.md)\n\n***\n\n### defaultRenderAnthropicToolCallResult\n\nRe-exports [defaultRenderAnthropicToolCallResult](helpers/variables/defaultRenderAnthropicToolCallResult.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR](exceptions/variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT](exceptions/variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR](exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED](exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED.md)\n\n***\n\n### E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](exceptions/variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS](exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### fingerprintAnthropicMessagesPrefix\n\nRe-exports [fingerprintAnthropicMessagesPrefix](helpers/functions/fingerprintAnthropicMessagesPrefix.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### renderAnthropicMediaBlocks\n\nRe-exports [renderAnthropicMediaBlocks](helpers/functions/renderAnthropicMediaBlocks.md)\n\n***\n\n### renderAnthropicSegmentedSystemPrompt\n\nRe-exports [renderAnthropicSegmentedSystemPrompt](helpers/functions/renderAnthropicSegmentedSystemPrompt.md)\n\n***\n\n### renderAnthropicThinkingBlocks\n\nRe-exports [renderAnthropicThinkingBlocks](helpers/functions/renderAnthropicThinkingBlocks.md)\n\n***\n\n### renderAnthropicTimelineMessage\n\nRe-exports [renderAnthropicTimelineMessage](helpers/functions/renderAnthropicTimelineMessage.md)\n\n***\n\n### renderAnthropicToolCallResult\n\nRe-exports [renderAnthropicToolCallResult](helpers/functions/renderAnthropicToolCallResult.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../functions/toolsToChatCompletionsTools.md)\n\n***\n\n### translateAnthropicError\n\nRe-exports [translateAnthropicError](error_translation/functions/translateAnthropicError.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter","title":"@nhtio/adk/batteries/llm/anthropic\\_messages/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter.md'\ndescription: Cross-environment executor adapter for the Anthropic Messages API.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages/adapter\n\nCross-environment executor adapter for the Anthropic Messages API.\n\n## Remarks\n\nNative Anthropic Messages adapter targeting `client.messages.create` from `@anthropic-ai/sdk`\n(a hard static dependency of this battery). Node-first: an Anthropic API key in a browser\nbundle is unacceptably exposed, so browser is deliberately not a target or gate for this\nadapter — `dangerouslyAllowBrowser` exists only for the caller who accepts that risk knowingly.\n\nStructurally a sibling of the native Ollama and OpenAI Chat Completions adapters, with the\nAnthropic-wire divergences:\n\n* Transport: the Anthropic SDK owns the HTTP call (`client.messages.create`), not raw `fetch`.\n ADK owns retry (`maxRetries: 0` on the client) and timeout (`requestTimeoutMs` fences an\n internal `AbortController` linked with `ctx.abortSignal`; when `requestTimeoutMs` is `0` a\n large explicit sentinel is set on the SDK client so the SDK's own silent 10-minute default is\n never silently inherited).\n* Streaming: `Stream` — an `AsyncIterable` the SDK already filters `ping`\n frames out of; a mid-stream provider error surfaces as a **thrown `APIError`** from `for\n await` iteration, not a discriminated event variant, so the consumption loop is wrapped in a\n `try`/`catch`.\n* Content-block state machine keyed by `index`: `content_block_start` carries the ONLY\n occurrence of a `tool_use` block's `id`/`name` and a `redacted_thinking` block's `data`;\n `content_block_delta` carries five delta variants (`text_delta`, `thinking_delta`,\n `signature_delta`, `input_json_delta`, `citations_delta` — the last is out of scope for v1 and\n is a no-op); `content_block_stop` finalizes only that index. `message_stop` is not trusted to\n arrive; finalization is reachable from stream EOF too.\n* Stop reasons: all seven (`end_turn`, `max_tokens`, `stop_sequence`, `tool_use`, `pause_turn`,\n `refusal`, `model_context_window_exceeded`) are handled explicitly — `refusal` is a real\n terminal HTTP-200 outcome (never mistaken for an error), `model_context_window_exceeded` maps\n to `E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW`.\n* Error translation: typed SDK error classes (`BadRequestError`, `AuthenticationError`,\n `PermissionDeniedError`, `NotFoundError`, `ConflictError`, `UnprocessableEntityError`,\n `RateLimitError`, `InternalServerError`, `APIConnectionTimeoutError`, `APIConnectionError`,\n `APIUserAbortError`, generic `APIError`) are narrowed and mapped to ADK exceptions. Context\n overflow arrives as a 400 `BadRequestError` and is detected from body text (`prompt is too\n long`), not status. A real upstream 529 `overloaded_error` is retriable\n (`E_ANTHROPIC_MESSAGES_HTTP_ERROR`) — never routed into the fatal same-numbered\n adapter-side exceptions, which use 529 as their own unrelated status code.\n* Thinking persistence: signed `thinking` blocks persist as a `Thought` carrying a\n `{variant:'thinking', thinking, signature, prefixFingerprint}` payload; `redacted_thinking`\n blocks carry `{variant:'redacted_thinking', data, prefixFingerprint}`. The fingerprint is\n computed via the exported `fingerprintAnthropicMessagesPrefix` helper — never reimplemented.\n* No request repair: a `tool_choice` that appears not to have been honored (forces a name the\n response never calls) only warns via `helpers.log.warn` — `AnthropicMessagesAdapterOptions`\n has no `strictToolChoice` escape hatch, consistent with the \"warn loudly, send anyway\" ethos.\n\nPer-iteration flow (steps 1–9 of the plan):\n\n1. Merge constructor / executor / stash options and re-validate.\n2. Resolve helpers, falling back to bundled `default*` for each unset field.\n3. Artifact-reader tools: pre-forged onto `ctx.tools` by the DispatchRunner core; read as-is.\n4. Pre-render every persisted tool-call result into an Anthropic tool-result content block.\n5. When `tokenEncoding !== null`, sum the token weight of every persisted bucket and throw\n [@nhtio/adk/batteries!E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW](../exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW.md) when the total exceeds `contextWindow`.\n6. Build the request via `buildAnthropicMessagesHistory`.\n7. Call `client.messages.create` with retry/timeout ownership; classify and translate errors.\n8. Streaming path: content-block state machine + usage latching + stop-reason handling.\n9. Non-streaming path: same persistence + tool-execution loop, from a single `Message`.\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| [AnthropicMessagesAdapter](classes/AnthropicMessagesAdapter.md) | Opinionated cross-environment LLM adapter for the Anthropic Messages wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter/classes/AnthropicMessagesAdapter","title":"Class: AnthropicMessagesAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter/classes/AnthropicMessagesAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter/classes/AnthropicMessagesAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/adapter/classes/AnthropicMessagesAdapter.md\ndescription: >-\n Opinionated cross-environment LLM adapter for the Anthropic Messages wire\n shape.\n---\n\n# Class: AnthropicMessagesAdapter\n\nDefined in: [src/batteries/llm/anthropic\\_messages/adapter.ts:433](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/adapter.ts#L433)\n\nOpinionated cross-environment LLM adapter for the Anthropic Messages wire shape.\n\n## Remarks\n\nConstruction validates options eagerly via [validateOptions](../../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries/llm/anthropic\\_messages!E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS](../../exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md) on\nfailure. The returned instance is reusable: call [AnthropicMessagesAdapter.executor](#executor) once\nper `DispatchRunner` configuration to obtain a [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to\nthe baseline plus optional executor-scope overrides. Per-iteration overrides live on\n`ctx.stash.anthropicMessages` and take highest precedence; `headers`, `helpers`, and `retry`\nmerge key-by-key across all three layers, every other field is replaced wholesale at the\nhighest layer that sets it. Node-first: browser is explicitly not a target — an Anthropic API\nkey in a browser bundle is unacceptably exposed.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew AnthropicMessagesAdapter(options: unknown): AnthropicMessagesAdapter;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/adapter.ts:444](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/adapter.ts#L444)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options. Re-validated on every iteration after per-dispatch and per-iteration overrides are layered in. |\n\n#### Returns\n\n`AnthropicMessagesAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/llm/anthropic\\_messages!E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS](../../exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md) when `options` does not satisfy `anthropicMessagesOptionsSchema`.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | --------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"anthropicMessages\"` | Customary key for per-iteration overrides on `ctx.stash`. | [src/batteries/llm/anthropic\\_messages/adapter.ts:435](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/adapter.ts#L435) |\n\n## Methods\n\n### countTokens()\n\n```ts\ncountTokens(input:\n | AnthropicMessagesCountTokensRequestInput\n | AnthropicMessagesCountTokensInput, overrides?: Partial): Promise<{\n inputTokens: number;\n raw: unknown;\n}>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/adapter.ts:1524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/adapter.ts#L1524)\n\nCounts the input tokens a request would consume, without generating.\n\nUses Anthropic's dedicated count-tokens surface (a distinct parameter shape from a create\nrequest, and one that takes no `maxTokens`), and returns a named field plus the raw upstream\nbody rather than leaking the vendor type through this battery's public API.\n\n`input` accepts either a dispatch context — whose prompt is assembled with the same helpers the\nexecutor uses — or a pre-built Anthropic-shaped request. Option precedence, revalidation,\ntimeout ownership, and error translation all match [AnthropicMessagesAdapter.executor](#executor).\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | | [`AnthropicMessagesCountTokensRequestInput`](../../count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput.md) | [`AnthropicMessagesCountTokensInput`](../../types/interfaces/AnthropicMessagesCountTokensInput.md) |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`AnthropicMessagesAdapterOptions`](../../types/interfaces/AnthropicMessagesAdapterOptions.md)> |\n\n#### Returns\n\n`Promise`<{\n`inputTokens`: `number`;\n`raw`: `unknown`;\n}>\n\n***\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/adapter.ts:455](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/adapter.ts#L455)\n\nReturns a [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to this adapter's baseline plus optional\nexecutor-scope overrides.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`AnthropicMessagesAdapterOptions`](../../types/interfaces/AnthropicMessagesAdapterOptions.md)> | Optional executor-scope overrides. Higher precedence than the baseline, lower precedence than `ctx.stash[STASH_KEY]`. |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### isAnthropicMessagesAdapter()\n\n```ts\nstatic isAnthropicMessagesAdapter(value: unknown): value is AnthropicMessagesAdapter;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/adapter.ts:1534](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/adapter.ts#L1534)\n\nReturns `true` when `value` is an AnthropicMessagesAdapter instance.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n#### Returns\n\n`value is AnthropicMessagesAdapter`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens","title":"@nhtio/adk/batteries/llm/anthropic\\_messages/count\\_tokens","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens.md\ndescription: Token-count helpers for the Anthropic Messages battery.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages/count\\_tokens\n\nToken-count helpers for the Anthropic Messages battery.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------- | -------------------------------------------------- |\n| [AnthropicMessagesCountTokensDeps](interfaces/AnthropicMessagesCountTokensDeps.md) | Optional dependencies for the count-token helpers. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |\n| [AnthropicMessagesCountTokensRequestInput](type-aliases/AnthropicMessagesCountTokensRequestInput.md) | Public count-token input shape accepted by the exported helpers. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| [countAnthropicMessagesTokens](functions/countAnthropicMessagesTokens.md) | Counts tokens using constructor-baseline options plus executor-style overrides and stash. |\n| [countAnthropicMessagesTokensWithResolvedOptions](functions/countAnthropicMessagesTokensWithResolvedOptions.md) | Counts tokens using already-resolved Anthropic adapter options. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokens","title":"Function: countAnthropicMessagesTokens()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokens.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokens","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokens.md\n---\n\n# Function: countAnthropicMessagesTokens()\n\n```ts\nfunction countAnthropicMessagesTokens(\n baseline: AnthropicMessagesAdapterOptions,\n input:\n | AnthropicMessagesCountTokensRequestInput\n | AnthropicMessagesCountTokensInput,\n overrides?: Partial,\n deps?: AnthropicMessagesCountTokensDeps,\n): Promise<{\n inputTokens: number;\n raw: unknown;\n}>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:509](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L509)\n\nCounts tokens using constructor-baseline options plus executor-style overrides and stash.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |\n| `baseline` | [`AnthropicMessagesAdapterOptions`](../../types/interfaces/AnthropicMessagesAdapterOptions.md) | Constructor-baseline adapter options. |\n| `input` | | [`AnthropicMessagesCountTokensRequestInput`](../type-aliases/AnthropicMessagesCountTokensRequestInput.md) | [`AnthropicMessagesCountTokensInput`](../../types/interfaces/AnthropicMessagesCountTokensInput.md) | Either a `DispatchContext` or a pre-built Anthropic-shaped input object. |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`AnthropicMessagesAdapterOptions`](../../types/interfaces/AnthropicMessagesAdapterOptions.md)> | Optional executor-scope overrides with lower precedence than stash. |\n| `deps?` | [`AnthropicMessagesCountTokensDeps`](../interfaces/AnthropicMessagesCountTokensDeps.md) | Optional helper dependencies, including the structured log channel. |\n\n## Returns\n\n`Promise`<{\n`inputTokens`: `number`;\n`raw`: `unknown`;\n}>\n\nThe named token-count field plus the raw SDK response.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokensWithResolvedOptions","title":"Function: countAnthropicMessagesTokensWithResolvedOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokensWithResolvedOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokensWithResolvedOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/functions/countAnthropicMessagesTokensWithResolvedOptions.md\n---\n\n# Function: countAnthropicMessagesTokensWithResolvedOptions()\n\n```ts\nfunction countAnthropicMessagesTokensWithResolvedOptions(\n resolved: AnthropicMessagesAdapterOptions,\n input:\n | AnthropicMessagesCountTokensRequestInput\n | AnthropicMessagesCountTokensInput,\n deps?: AnthropicMessagesCountTokensDeps,\n): Promise<{\n inputTokens: number;\n raw: unknown;\n}>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:348](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L348)\n\nCounts tokens using already-resolved Anthropic adapter options.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |\n| `resolved` | [`AnthropicMessagesAdapterOptions`](../../types/interfaces/AnthropicMessagesAdapterOptions.md) | Fully merged and validated adapter options. |\n| `input` | | [`AnthropicMessagesCountTokensRequestInput`](../type-aliases/AnthropicMessagesCountTokensRequestInput.md) | [`AnthropicMessagesCountTokensInput`](../../types/interfaces/AnthropicMessagesCountTokensInput.md) | Either a `DispatchContext` or a pre-built Anthropic-shaped input object. |\n| `deps?` | [`AnthropicMessagesCountTokensDeps`](../interfaces/AnthropicMessagesCountTokensDeps.md) | Optional helper dependencies, including the structured log channel. |\n\n## Returns\n\n`Promise`<{\n`inputTokens`: `number`;\n`raw`: `unknown`;\n}>\n\nThe named token-count field plus the raw SDK response.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/interfaces/AnthropicMessagesCountTokensDeps","title":"Interface: AnthropicMessagesCountTokensDeps","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/interfaces/AnthropicMessagesCountTokensDeps.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/interfaces/AnthropicMessagesCountTokensDeps","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/interfaces/AnthropicMessagesCountTokensDeps.md\ndescription: Optional dependencies for the count-token helpers.\n---\n\n# Interface: AnthropicMessagesCountTokensDeps\n\nDefined in: [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L93)\n\nOptional dependencies for the count-token helpers.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `log?` | [`DispatchExecutorLogChannel`](../../../../../dispatch_runner/interfaces/DispatchExecutorLogChannel.md) | Structured log channel used for warn-and-send diagnostics. | [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L95) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput","title":"Type Alias: AnthropicMessagesCountTokensRequestInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/count_tokens/type-aliases/AnthropicMessagesCountTokensRequestInput.md\ndescription: Public count-token input shape accepted by the exported helpers.\n---\n\n# Type Alias: AnthropicMessagesCountTokensRequestInput\n\n```ts\ntype AnthropicMessagesCountTokensRequestInput =\n | DispatchContext\n | {\n messages: AnthropicMessageParam[];\n system?: string | AnthropicTextBlockParam[];\n tools?: AnthropicTool[];\n };\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L79)\n\nPublic count-token input shape accepted by the exported helpers.\n\n## Union Members\n\n[`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)\n\n***\n\n### Type Literal\n\n```ts\n{\n messages: AnthropicMessageParam[];\n system?: | string\n | AnthropicTextBlockParam[];\n tools?: AnthropicTool[];\n}\n```\n\n| Name | Type | Description | Defined in |\n| ---------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `messages` | [`AnthropicMessageParam`](../../types/type-aliases/AnthropicMessageParam.md)\\[] | Pre-built Anthropic messages to count. | [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L83) |\n| `system?` | | `string` | [`AnthropicTextBlockParam`](../../types/type-aliases/AnthropicTextBlockParam.md)\\[] | Optional pre-built Anthropic system prompt to count. | [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L85) |\n| `tools?` | [`AnthropicTool`](../../types/type-aliases/AnthropicTool.md)\\[] | Optional pre-built Anthropic tool definitions to count. | [src/batteries/llm/anthropic\\_messages/count\\_tokens.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/count_tokens.ts#L87) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation","title":"@nhtio/adk/batteries/llm/anthropic\\_messages/error\\_translation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation.md\ndescription: SDK error → ADK classification for the Anthropic Messages battery.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages/error\\_translation\n\nSDK error → ADK classification for the Anthropic Messages battery.\n\n## Remarks\n\nExtracted so the dispatch path (`adapter.ts`) and the token-count path (`count_tokens.ts`) share\nONE classifier. They previously carried byte-identical private copies, which meant a fix to one\nsilently left the other wrong — exactly what happened with the statusless-`APIError` bug this\nmodule's [AnthropicMessagesErrorStatusResolver](../types/type-aliases/AnthropicMessagesErrorStatusResolver.md) seam addresses.\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------------- | ---------------------------------------- |\n| [AnthropicErrorClassification](type-aliases/AnthropicErrorClassification.md) | The outcome of classifying an SDK error. |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------- | --------------------------------------------------------------------- |\n| [CONTEXT\\_OVERFLOW\\_PHRASE](variables/CONTEXT_OVERFLOW_PHRASE.md) | Body-text marker identifying an Anthropic context-overflow rejection. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------- | ---------------------------------------------------------------------- |\n| [translateAnthropicError](functions/translateAnthropicError.md) | Classify an error thrown by the Anthropic SDK into an ADK disposition. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/functions/translateAnthropicError","title":"Function: translateAnthropicError()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/functions/translateAnthropicError.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/functions/translateAnthropicError","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/functions/translateAnthropicError.md\n---\n\n# Function: translateAnthropicError()\n\n```ts\nfunction translateAnthropicError(\n err: unknown,\n retriableStatuses: readonly number[],\n opts?: {\n resolveErrorStatus?: AnthropicMessagesErrorStatusResolver;\n warn?: (msg: string) => void;\n },\n): AnthropicErrorClassification;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/error\\_translation.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/error_translation.ts#L120)\n\nClassify an error thrown by the Anthropic SDK into an ADK disposition.\n\n## Parameters\n\n| Parameter | Type | Description |\n| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ |\n| `err` | `unknown` | The thrown value. |\n| `retriableStatuses` | readonly `number`\\[] | Status codes configured as retriable. |\n| `opts?` | { `resolveErrorStatus?`: [`AnthropicMessagesErrorStatusResolver`](../../types/type-aliases/AnthropicMessagesErrorStatusResolver.md); `warn?`: (`msg`: `string`) => `void`; } | Optional status resolver and warning sink. |\n| `opts.resolveErrorStatus?` | [`AnthropicMessagesErrorStatusResolver`](../../types/type-aliases/AnthropicMessagesErrorStatusResolver.md) | - |\n| `opts.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n[`AnthropicErrorClassification`](../type-aliases/AnthropicErrorClassification.md)\n\nThe classification.\n\n## Remarks\n\nOrdering is deliberate. Abort and timeout are checked first because they are control-flow\noutcomes rather than failures. `APIConnectionError` is retriable at status `0` — a transport\nfault has no HTTP status and never will, and that branch establishes the convention that a\nstatusless error can still be retriable.\n\nFor an `APIError`, the consumer's `resolveErrorStatus` hook (when configured) runs BEFORE both\nthe context-overflow check and retriable classification, so a recovered status participates in\nevery downstream decision and is what gets reported — a recovered `529` surfaces as `529`, not\n`0`. Without a resolver the behaviour is unchanged from before the hook existed: a statusless\n`APIError` coerces to `0`, matches no retriable status, and is fatal.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/type-aliases/AnthropicErrorClassification","title":"Type Alias: AnthropicErrorClassification","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/type-aliases/AnthropicErrorClassification.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/type-aliases/AnthropicErrorClassification","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/type-aliases/AnthropicErrorClassification.md\ndescription: The outcome of classifying an SDK error.\n---\n\n# Type Alias: AnthropicErrorClassification\n\n```ts\ntype AnthropicErrorClassification =\n | {\n kind: \"abort\";\n }\n | {\n kind: \"timeout\";\n }\n | {\n kind: \"context-overflow\";\n message: string;\n }\n | {\n kind: \"retriable\";\n message: string;\n status: number;\n }\n | {\n kind: \"fatal\";\n message: string;\n status: number;\n };\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/error\\_translation.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/error_translation.ts#L35)\n\nThe outcome of classifying an SDK error.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/variables/CONTEXT_OVERFLOW_PHRASE","title":"Variable: CONTEXT\\_OVERFLOW\\_PHRASE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/variables/CONTEXT_OVERFLOW_PHRASE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/variables/CONTEXT_OVERFLOW_PHRASE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/error_translation/variables/CONTEXT_OVERFLOW_PHRASE.md\ndescription: Body-text marker identifying an Anthropic context-overflow rejection.\n---\n\n# Variable: CONTEXT\\_OVERFLOW\\_PHRASE\n\n```ts\nconst CONTEXT_OVERFLOW_PHRASE: \"prompt is too long\" = \"prompt is too long\";\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/error\\_translation.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/error_translation.ts#L30)\n\nBody-text marker identifying an Anthropic context-overflow rejection.\n\n## Remarks\n\nContext overflow arrives as a 400 `BadRequestError` and is detected from body TEXT, not status —\nthe status alone cannot distinguish it from any other bad request.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions","title":"@nhtio/adk/batteries/llm/anthropic\\_messages/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions.md\ndescription: Battery-scoped exception constructors for the Anthropic Messages adapter.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages/exceptions\n\nBattery-scoped exception constructors for the Anthropic Messages adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the Anthropic Messages adapter. These exceptions are owned\nby the battery, not the ADK core, and are minted via `createException` from\n`@nhtio/adk/factories`. The status codes and fatal split mirror the pure HTTP Ollama battery.\n\nImportant provenance rule: ADK convention uses status 529 on fatal option and context-overflow\nexceptions raised by the adapter itself. Anthropic also returns a real upstream HTTP 529\n`overloaded_error`, which is transient and retriable. An upstream 529 must be classified by\nprovenance as `E_ANTHROPIC_MESSAGES_HTTP_ERROR`, with retry eligibility decided by the retry\nconfig. Never route a provider 529 into the fatal same-numbered ADK-side exceptions.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| [E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW](variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW.md) | Thrown when the total token weight of the resolved request exceeds `contextWindow`. |\n| [E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR](variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR.md) | Thrown when the upstream Messages endpoint returns an API error. |\n| [E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS.md) | Instantiated for invalid model-emitted tool arguments and persisted as an error `ToolCall`. |\n| [E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT](variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT.md) | Thrown when the request does not complete before `requestTimeoutMs`. |\n| [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR](variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR.md) | Thrown when a streaming Messages request emits a provider or transport failure mid-stream. |\n| [E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED](variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED.md) | Thrown when the Messages stream goes silent for longer than `streamIdleTimeoutMs`. |\n| [E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY.md) | Raised when an ADK media instance cannot be represented by the Anthropic Messages wire. |\n| [E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS](variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md) | Thrown when resolved Anthropic Messages adapter options fail validation. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW","title":"Variable: E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the total token weight of the resolved request exceeds\n `contextWindow`.\n---\n\n# Variable: E\\_ANTHROPIC\\_MESSAGES\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_ANTHROPIC_MESSAGES_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L34)\n\nThrown when the total token weight of the resolved request exceeds `contextWindow`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR","title":"Variable: E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_HTTP_ERROR.md\ndescription: Thrown when the upstream Messages endpoint returns an API error.\n---\n\n# Variable: E\\_ANTHROPIC\\_MESSAGES\\_HTTP\\_ERROR\n\n```ts\nconst E_ANTHROPIC_MESSAGES_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L47)\n\nThrown when the upstream Messages endpoint returns an API error.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS.md\ndescription: >-\n Instantiated for invalid model-emitted tool arguments and persisted as an\n error `ToolCall`.\n---\n\n# Variable: E\\_ANTHROPIC\\_MESSAGES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_ANTHROPIC_MESSAGES_INVALID_TOOL_CALL_ARGS: CreatedException<\n [string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L96)\n\nInstantiated for invalid model-emitted tool arguments and persisted as an error `ToolCall`.\n\n## Remarks\n\nThe adapter must not throw this exception. It creates the exception, copies the message into a\ntool-result payload, and persists a failed `ToolCall` so the model can self-correct on the next\niteration.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT","title":"Variable: E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT.md\ndescription: Thrown when the request does not complete before `requestTimeoutMs`.\n---\n\n# Variable: E\\_ANTHROPIC\\_MESSAGES\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_ANTHROPIC_MESSAGES_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L80)\n\nThrown when the request does not complete before `requestTimeoutMs`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR","title":"Variable: E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_ERROR.md\ndescription: >-\n Thrown when a streaming Messages request emits a provider or transport failure\n mid-stream.\n---\n\n# Variable: E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_ERROR\n\n```ts\nconst E_ANTHROPIC_MESSAGES_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L58)\n\nThrown when a streaming Messages request emits a provider or transport failure mid-stream.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED","title":"Variable: E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_STREAM_STALLED.md\ndescription: >-\n Thrown when the Messages stream goes silent for longer than\n `streamIdleTimeoutMs`.\n---\n\n# Variable: E\\_ANTHROPIC\\_MESSAGES\\_STREAM\\_STALLED\n\n```ts\nconst E_ANTHROPIC_MESSAGES_STREAM_STALLED: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L69)\n\nThrown when the Messages stream goes silent for longer than `streamIdleTimeoutMs`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Raised when an ADK media instance cannot be represented by the Anthropic\n Messages wire.\n---\n\n# Variable: E\\_ANTHROPIC\\_MESSAGES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_ANTHROPIC_MESSAGES_UNSUPPORTED_MEDIA_MODALITY: CreatedException<\n [string, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L107)\n\nRaised when an ADK media instance cannot be represented by the Anthropic Messages wire.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS","title":"Variable: E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/exceptions/variables/E_INVALID_ANTHROPIC_MESSAGES_OPTIONS.md\ndescription: Thrown when resolved Anthropic Messages adapter options fail validation.\n---\n\n# Variable: E\\_INVALID\\_ANTHROPIC\\_MESSAGES\\_OPTIONS\n\n```ts\nconst E_INVALID_ANTHROPIC_MESSAGES_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/exceptions.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/exceptions.ts#L23)\n\nThrown when resolved Anthropic Messages adapter options fail validation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers","title":"@nhtio/adk/batteries/llm/anthropic\\_messages/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers.md'\ndescription: Anthropic Messages translation helpers.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages/helpers\n\nAnthropic Messages translation helpers.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------------------------- | --------------------------------------- |\n| [defaultAnthropicToolsFromTools](variables/defaultAnthropicToolsFromTools.md) | Default Anthropic tool translator. |\n| [defaultBuildAnthropicMessagesHistory](variables/defaultBuildAnthropicMessagesHistory.md) | Default history assembler. |\n| [defaultRenderAnthropicMediaBlocks](variables/defaultRenderAnthropicMediaBlocks.md) | Default Anthropic media renderer. |\n| [defaultRenderAnthropicSegmentedSystemPrompt](variables/defaultRenderAnthropicSegmentedSystemPrompt.md) | Default segmented system renderer. |\n| [defaultRenderAnthropicThinkingBlocks](variables/defaultRenderAnthropicThinkingBlocks.md) | Default thinking replay renderer. |\n| [defaultRenderAnthropicTimelineMessage](variables/defaultRenderAnthropicTimelineMessage.md) | Default timeline renderer. |\n| [defaultRenderAnthropicToolCallResult](variables/defaultRenderAnthropicToolCallResult.md) | Default Anthropic tool-result renderer. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| [anthropicToolsFromTools](functions/anthropicToolsFromTools.md) | Converts ADK tools to Anthropic's flat custom-tool definition. |\n| [buildAnthropicMessagesHistory](functions/buildAnthropicMessagesHistory.md) | Assembles Anthropic system content, messages, tools, and safely replayable thinking. |\n| [fingerprintAnthropicMessagesPrefix](functions/fingerprintAnthropicMessagesPrefix.md) | Computes the SHA-256 fingerprint used for Anthropic thinking replay. |\n| [renderAnthropicMediaBlocks](functions/renderAnthropicMediaBlocks.md) | Renders image, document, and policy-routed unsupported media blocks. |\n| [renderAnthropicSegmentedSystemPrompt](functions/renderAnthropicSegmentedSystemPrompt.md) | Renders system buckets as separate text blocks and places up to three cache breakpoints. |\n| [renderAnthropicThinkingBlocks](functions/renderAnthropicThinkingBlocks.md) | Converts an eligible stored Anthropic thinking payload into byte-exact wire blocks. |\n| [renderAnthropicTimelineMessage](functions/renderAnthropicTimelineMessage.md) | Renders one ADK timeline message using an identity-bearing content envelope. |\n| [renderAnthropicToolCallResult](functions/renderAnthropicToolCallResult.md) | Renders a tool result as Anthropic tool-result content, preserving media blocks. |\n\n## References\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### looksLikeSpooledArtifact\n\nRe-exports [looksLikeSpooledArtifact](../../transformers_js/helpers/functions/looksLikeSpooledArtifact.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../../functions/toolsToChatCompletionsTools.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/anthropicToolsFromTools","title":"Function: anthropicToolsFromTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/anthropicToolsFromTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/anthropicToolsFromTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/anthropicToolsFromTools.md\n---\n\n# Function: anthropicToolsFromTools()\n\n```ts\nfunction anthropicToolsFromTools(\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: unknown) => JsonSchema;\n },\n): Tool[];\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L94)\n\nConverts ADK tools to Anthropic's flat custom-tool definition.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n`Tool`\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/buildAnthropicMessagesHistory","title":"Function: buildAnthropicMessagesHistory()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/buildAnthropicMessagesHistory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/buildAnthropicMessagesHistory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/buildAnthropicMessagesHistory.md\n---\n\n# Function: buildAnthropicMessagesHistory()\n\n```ts\nfunction buildAnthropicMessagesHistory(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n cacheBreakpoints: AnthropicCacheBreakpoints;\n cacheTtl?: AnthropicCacheTtl;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n model: string;\n renderAnthropicSegmentedSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n cacheBreakpoints: AnthropicCacheBreakpoints;\n cacheTtl?: AnthropicCacheTtl;\n memories: Iterable;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n warn?: (msg: string) => void;\n }) => Promise;\n renderAnthropicThinkingBlocks: (input: {\n model: string;\n prefixFingerprint: string;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n }) => ContentBlockParam[];\n renderAnthropicTimelineMessage: (input: {\n message: Message;\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderAnthropicToolCallResult: (input: {\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise<{\n messages: MessageParam[];\n system?: string | TextBlockParam[];\n tools?: Tool[];\n}>;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:521](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L521)\n\nAssembles Anthropic system content, messages, tools, and safely replayable thinking.\n\n## Parameters\n\n| Parameter | Type | Description |\n| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `model`: `string`; `renderAnthropicSegmentedSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`TextBlockParam`\\[]>; `renderAnthropicThinkingBlocks`: (`input`: { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => `ContentBlockParam`\\[]; `renderAnthropicTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageParam` | `null`>; `renderAnthropicToolCallResult`: (`input`: { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ToolResultBlockParam`>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `ToolResultBlockParam`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.cacheBreakpoints` | [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md) | - |\n| `input.cacheTtl?` | [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.model` | `string` | - |\n| `input.renderAnthropicSegmentedSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`TextBlockParam`\\[]> | - |\n| `input.renderAnthropicThinkingBlocks` | (`input`: { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => `ContentBlockParam`\\[] | - |\n| `input.renderAnthropicTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageParam` | `null`> | - |\n| `input.renderAnthropicToolCallResult` | (`input`: { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ToolResultBlockParam`> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `ToolResultBlockParam`> | Pre-rendered results keyed by the live ToolCall instances used during assembly. |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`messages`: `MessageParam`\\[];\n`system?`: `string` | `TextBlockParam`\\[];\n`tools?`: `Tool`\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/fingerprintAnthropicMessagesPrefix","title":"Function: fingerprintAnthropicMessagesPrefix()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/fingerprintAnthropicMessagesPrefix.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/fingerprintAnthropicMessagesPrefix","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/fingerprintAnthropicMessagesPrefix.md\n---\n\n# Function: fingerprintAnthropicMessagesPrefix()\n\n```ts\nfunction fingerprintAnthropicMessagesPrefix(input: {\n messages: MessageParam[];\n model: string;\n system?: string | TextBlockParam[];\n throughBlock?: {\n contentIndex: number;\n messageIndex: number;\n };\n tools?: Tool[];\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:422](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L422)\n\nComputes the SHA-256 fingerprint used for Anthropic thinking replay.\n\nThe input is the exact assembled request prefix: model, resolved system, tools, and messages\nthrough the content block immediately before the thinking block. Assembles the Anthropic-shaped\nprefix object and delegates the canonicalisation + hashing to the shared, wire-agnostic\n[canonicalFingerprint](../../../openai_responses/helpers/functions/canonicalFingerprint.md) primitive: object keys are recursively sorted; array order and block\nboundaries are preserved.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `messages`: `MessageParam`\\[]; `model`: `string`; `system?`: `string` | `TextBlockParam`\\[]; `throughBlock?`: { `contentIndex`: `number`; `messageIndex`: `number`; }; `tools?`: `Tool`\\[]; } |\n| `input.messages` | `MessageParam`\\[] |\n| `input.model` | `string` |\n| `input.system?` | `string` | `TextBlockParam`\\[] |\n| `input.throughBlock?` | { `contentIndex`: `number`; `messageIndex`: `number`; } |\n| `input.throughBlock.contentIndex` | `number` |\n| `input.throughBlock.messageIndex` | `number` |\n| `input.tools?` | `Tool`\\[] |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicMediaBlocks","title":"Function: renderAnthropicMediaBlocks()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicMediaBlocks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicMediaBlocks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicMediaBlocks.md\n---\n\n# Function: renderAnthropicMediaBlocks()\n\n```ts\nfunction renderAnthropicMediaBlocks(input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L185)\n\nRenders image, document, and policy-routed unsupported media blocks.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.media` | [`Media`](../../../../../common/classes/Media.md) |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`ContentBlockParam`\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicSegmentedSystemPrompt","title":"Function: renderAnthropicSegmentedSystemPrompt()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicSegmentedSystemPrompt.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicSegmentedSystemPrompt","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicSegmentedSystemPrompt.md\n---\n\n# Function: renderAnthropicSegmentedSystemPrompt()\n\n```ts\nfunction renderAnthropicSegmentedSystemPrompt(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n cacheBreakpoints: AnthropicCacheBreakpoints;\n cacheTtl?: \"5m\" | \"1h\";\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string,\n ) => Promise;\n renderMemories: (\n items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>,\n ) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderFirstPartyRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string,\n ) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderThirdPartyPublicRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (\n items: Iterable,\n attrs?: StandingInstructionAttrs,\n ) => string;\n renderThirdPartyPrivateRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderThirdPartyPublicRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:340](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L340)\n\nRenders system buckets as separate text blocks and places up to three cache breakpoints.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: `\"5m\"` | `\"1h\"`; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) |\n| `input.cacheBreakpoints` | [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md) |\n| `input.cacheTtl?` | `\"5m\"` | `\"1h\"` |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> |\n| `input.renderCtx?` | `unknown` |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderRetrievableSafetyDirective` | () => `string` |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`TextBlockParam`\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicThinkingBlocks","title":"Function: renderAnthropicThinkingBlocks()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicThinkingBlocks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicThinkingBlocks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicThinkingBlocks.md\n---\n\n# Function: renderAnthropicThinkingBlocks()\n\n```ts\nfunction renderAnthropicThinkingBlocks(input: {\n model: string;\n prefixFingerprint: string;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n}): ContentBlockParam[];\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L448)\n\nConverts an eligible stored Anthropic thinking payload into byte-exact wire blocks.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.model` | `string` |\n| `input.prefixFingerprint` | `string` |\n| `input.replayCompatibility` | readonly `string`\\[] |\n| `input.thought` | [`Thought`](../../../../../common/classes/Thought.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`ContentBlockParam`\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicTimelineMessage","title":"Function: renderAnthropicTimelineMessage()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicTimelineMessage.md\n---\n\n# Function: renderAnthropicTimelineMessage()\n\n```ts\nfunction renderAnthropicTimelineMessage(input: {\n message: Message;\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:481](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L481)\n\nRenders one ADK timeline message using an identity-bearing content envelope.\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.renderAnthropicMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]> |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`MessageParam` | `null`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicToolCallResult","title":"Function: renderAnthropicToolCallResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/functions/renderAnthropicToolCallResult.md\n---\n\n# Function: renderAnthropicToolCallResult()\n\n```ts\nfunction renderAnthropicToolCallResult(input: {\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:234](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L234)\n\nRenders a tool result as Anthropic tool-result content, preserving media blocks.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderAnthropicMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]> |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`ToolResultBlockParam`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultAnthropicToolsFromTools","title":"Variable: defaultAnthropicToolsFromTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultAnthropicToolsFromTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultAnthropicToolsFromTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultAnthropicToolsFromTools.md\ndescription: Default Anthropic tool translator.\n---\n\n# Variable: defaultAnthropicToolsFromTools\n\n```ts\nconst defaultAnthropicToolsFromTools: (\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: unknown) => JsonSchema;\n },\n) => Tool[] = anthropicToolsFromTools;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L110)\n\nDefault Anthropic tool translator.\n\nConverts ADK tools to Anthropic's flat custom-tool definition.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n`Tool`\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultBuildAnthropicMessagesHistory","title":"Variable: defaultBuildAnthropicMessagesHistory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultBuildAnthropicMessagesHistory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultBuildAnthropicMessagesHistory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultBuildAnthropicMessagesHistory.md\ndescription: Default history assembler.\n---\n\n# Variable: defaultBuildAnthropicMessagesHistory\n\n```ts\nconst defaultBuildAnthropicMessagesHistory: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n cacheBreakpoints: AnthropicCacheBreakpoints;\n cacheTtl?: AnthropicCacheTtl;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n model: string;\n renderAnthropicSegmentedSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n cacheBreakpoints: AnthropicCacheBreakpoints;\n cacheTtl?: AnthropicCacheTtl;\n memories: Iterable;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n warn?: (msg: string) => void;\n }) => Promise;\n renderAnthropicThinkingBlocks: (input: {\n model: string;\n prefixFingerprint: string;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n }) => ContentBlockParam[];\n renderAnthropicTimelineMessage: (input: {\n message: Message;\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderAnthropicToolCallResult: (input: {\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise<{\n messages: MessageParam[];\n system?: string | TextBlockParam[];\n tools?: Tool[];\n}> = buildAnthropicMessagesHistory;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:801](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L801)\n\nDefault history assembler.\n\nAssembles Anthropic system content, messages, tools, and safely replayable thinking.\n\n## Parameters\n\n| Parameter | Type | Description |\n| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `model`: `string`; `renderAnthropicSegmentedSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`TextBlockParam`\\[]>; `renderAnthropicThinkingBlocks`: (`input`: { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => `ContentBlockParam`\\[]; `renderAnthropicTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageParam` | `null`>; `renderAnthropicToolCallResult`: (`input`: { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ToolResultBlockParam`>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `ToolResultBlockParam`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.cacheBreakpoints` | [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md) | - |\n| `input.cacheTtl?` | [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.model` | `string` | - |\n| `input.renderAnthropicSegmentedSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../../types/type-aliases/AnthropicCacheTtl.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`TextBlockParam`\\[]> | - |\n| `input.renderAnthropicThinkingBlocks` | (`input`: { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => `ContentBlockParam`\\[] | - |\n| `input.renderAnthropicTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageParam` | `null`> | - |\n| `input.renderAnthropicToolCallResult` | (`input`: { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ToolResultBlockParam`> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `ToolResultBlockParam`> | Pre-rendered results keyed by the live ToolCall instances used during assembly. |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`messages`: `MessageParam`\\[];\n`system?`: `string` | `TextBlockParam`\\[];\n`tools?`: `Tool`\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicMediaBlocks","title":"Variable: defaultRenderAnthropicMediaBlocks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicMediaBlocks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicMediaBlocks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicMediaBlocks.md\ndescription: Default Anthropic media renderer.\n---\n\n# Variable: defaultRenderAnthropicMediaBlocks\n\n```ts\nconst defaultRenderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderAnthropicMediaBlocks;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L231)\n\nDefault Anthropic media renderer.\n\nRenders image, document, and policy-routed unsupported media blocks.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.media` | [`Media`](../../../../../common/classes/Media.md) |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`ContentBlockParam`\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicSegmentedSystemPrompt","title":"Variable: defaultRenderAnthropicSegmentedSystemPrompt","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicSegmentedSystemPrompt.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicSegmentedSystemPrompt","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicSegmentedSystemPrompt.md\ndescription: Default segmented system renderer.\n---\n\n# Variable: defaultRenderAnthropicSegmentedSystemPrompt\n\n```ts\nconst defaultRenderAnthropicSegmentedSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n cacheBreakpoints: AnthropicCacheBreakpoints;\n cacheTtl?: \"5m\" | \"1h\";\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string,\n ) => Promise;\n renderMemories: (\n items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>,\n ) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderFirstPartyRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string,\n ) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderThirdPartyPublicRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (\n items: Iterable,\n attrs?: StandingInstructionAttrs,\n ) => string;\n renderThirdPartyPrivateRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderThirdPartyPublicRetrievables: (\n items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>,\n deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n },\n ) => Promise;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n warn?: (msg: string) => void;\n}) => Promise = renderAnthropicSegmentedSystemPrompt;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:411](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L411)\n\nDefault segmented system renderer.\n\nRenders system buckets as separate text blocks and places up to three cache breakpoints.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: `\"5m\"` | `\"1h\"`; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) |\n| `input.cacheBreakpoints` | [`AnthropicCacheBreakpoints`](../../types/type-aliases/AnthropicCacheBreakpoints.md) |\n| `input.cacheTtl?` | `\"5m\"` | `\"1h\"` |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> |\n| `input.renderCtx?` | `unknown` |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderRetrievableSafetyDirective` | () => `string` |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`TextBlockParam`\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicThinkingBlocks","title":"Variable: defaultRenderAnthropicThinkingBlocks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicThinkingBlocks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicThinkingBlocks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicThinkingBlocks.md\ndescription: Default thinking replay renderer.\n---\n\n# Variable: defaultRenderAnthropicThinkingBlocks\n\n```ts\nconst defaultRenderAnthropicThinkingBlocks: (input: {\n model: string;\n prefixFingerprint: string;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n}) => ContentBlockParam[] = renderAnthropicThinkingBlocks;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:478](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L478)\n\nDefault thinking replay renderer.\n\nConverts an eligible stored Anthropic thinking payload into byte-exact wire blocks.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.model` | `string` |\n| `input.prefixFingerprint` | `string` |\n| `input.replayCompatibility` | readonly `string`\\[] |\n| `input.thought` | [`Thought`](../../../../../common/classes/Thought.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`ContentBlockParam`\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicTimelineMessage","title":"Variable: defaultRenderAnthropicTimelineMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicTimelineMessage.md\ndescription: Default timeline renderer.\n---\n\n# Variable: defaultRenderAnthropicTimelineMessage\n\n```ts\nconst defaultRenderAnthropicTimelineMessage: (input: {\n message: Message;\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderAnthropicTimelineMessage;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:518](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L518)\n\nDefault timeline renderer.\n\nRenders one ADK timeline message using an identity-bearing content envelope.\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.renderAnthropicMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]> |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`MessageParam` | `null`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicToolCallResult","title":"Variable: defaultRenderAnthropicToolCallResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/helpers/variables/defaultRenderAnthropicToolCallResult.md\ndescription: Default Anthropic tool-result renderer.\n---\n\n# Variable: defaultRenderAnthropicToolCallResult\n\n```ts\nconst defaultRenderAnthropicToolCallResult: (input: {\n renderAnthropicMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderAnthropicToolCallResult;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/helpers.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/helpers.ts#L337)\n\nDefault Anthropic tool-result renderer.\n\nRenders a tool result as Anthropic tool-result content, preserving media blocks.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderAnthropicMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]> |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`ToolResultBlockParam`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types","title":"@nhtio/adk/batteries/llm/anthropic\\_messages/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types.md'\ndescription: >-\n TypeScript wire shapes, helper contracts, and option types for the Anthropic\n Messages battery.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages/types\n\nTypeScript wire shapes, helper contracts, and option types for the Anthropic Messages battery.\n\n## Remarks\n\nType aliases for the Anthropic Messages adapter, the adapter's options shape, and the\n[AnthropicMessagesHelpers](interfaces/AnthropicMessagesHelpers.md) contract. Runtime validation lives in `validation.ts`.\n\nSDK-owned wire shapes are surfaced as local aliases only. Do not replace these with named\nre-exports from `@anthropic-ai/sdk`: the package is an external optional peer, and direct named\nre-exports through it fail the generated package build even when TypeScript type-checking passes.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |\n| [AnthropicMessagesAdapterOptions](interfaces/AnthropicMessagesAdapterOptions.md) | Configuration options for the Anthropic Messages adapter. |\n| [AnthropicMessagesCountTokensInput](interfaces/AnthropicMessagesCountTokensInput.md) | Constructor-compatible shape for future count-token helpers. |\n| [AnthropicMessagesErrorStatusInput](interfaces/AnthropicMessagesErrorStatusInput.md) | Input handed to an [AnthropicMessagesErrorStatusResolver](type-aliases/AnthropicMessagesErrorStatusResolver.md). |\n| [AnthropicMessagesHelpers](interfaces/AnthropicMessagesHelpers.md) | Full translation-helper contract for the Anthropic Messages battery. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| [AnthropicCacheBreakpoints](type-aliases/AnthropicCacheBreakpoints.md) | Cache-breakpoint placement mode for Anthropic prompt caching. |\n| [AnthropicCacheControlEphemeral](type-aliases/AnthropicCacheControlEphemeral.md) | Anthropic SDK cache-control breakpoint shape. |\n| [AnthropicCacheTtl](type-aliases/AnthropicCacheTtl.md) | Optional TTL value for Anthropic prompt-cache breakpoints. |\n| [AnthropicContentBlock](type-aliases/AnthropicContentBlock.md) | Anthropic SDK content block union returned by the model. |\n| [AnthropicContentBlockParam](type-aliases/AnthropicContentBlockParam.md) | Anthropic SDK input content block union. |\n| [AnthropicDocumentBlockParam](type-aliases/AnthropicDocumentBlockParam.md) | Anthropic SDK document block input shape. |\n| [AnthropicImageBlockParam](type-aliases/AnthropicImageBlockParam.md) | Anthropic SDK image block input shape. |\n| [AnthropicJSONOutputFormat](type-aliases/AnthropicJSONOutputFormat.md) | Anthropic SDK JSON structured-output format shape. |\n| [AnthropicMessage](type-aliases/AnthropicMessage.md) | Anthropic SDK response message shape. |\n| [AnthropicMessageCountTokensParams](type-aliases/AnthropicMessageCountTokensParams.md) | Anthropic SDK token-count request shape. |\n| [AnthropicMessageCreateParams](type-aliases/AnthropicMessageCreateParams.md) | Anthropic SDK create-request union. |\n| [AnthropicMessageCreateParamsBase](type-aliases/AnthropicMessageCreateParamsBase.md) | Anthropic SDK create-request base shape. |\n| [AnthropicMessageDeltaUsage](type-aliases/AnthropicMessageDeltaUsage.md) | Anthropic SDK streaming usage snapshot shape. |\n| [AnthropicMessageParam](type-aliases/AnthropicMessageParam.md) | Anthropic SDK input message shape. |\n| [AnthropicMessagesErrorStatusResolver](type-aliases/AnthropicMessagesErrorStatusResolver.md) | Recovers an HTTP status the Anthropic SDK could not observe. |\n| [AnthropicMessageTokensCount](type-aliases/AnthropicMessageTokensCount.md) | Anthropic SDK token-count response shape. |\n| [AnthropicModel](type-aliases/AnthropicModel.md) | Anthropic SDK model identifier type. |\n| [AnthropicOutputConfig](type-aliases/AnthropicOutputConfig.md) | Anthropic SDK output-configuration shape. |\n| [AnthropicRawContentBlockDelta](type-aliases/AnthropicRawContentBlockDelta.md) | Anthropic SDK content-block delta union. |\n| [AnthropicRawContentBlockDeltaEvent](type-aliases/AnthropicRawContentBlockDeltaEvent.md) | Anthropic SDK content-block-delta stream event. |\n| [AnthropicRawContentBlockStartEvent](type-aliases/AnthropicRawContentBlockStartEvent.md) | Anthropic SDK content-block-start stream event. |\n| [AnthropicRawContentBlockStopEvent](type-aliases/AnthropicRawContentBlockStopEvent.md) | Anthropic SDK content-block-stop stream event. |\n| [AnthropicRawMessageDeltaEvent](type-aliases/AnthropicRawMessageDeltaEvent.md) | Anthropic SDK message-delta stream event. |\n| [AnthropicRawMessageStartEvent](type-aliases/AnthropicRawMessageStartEvent.md) | Anthropic SDK message-start stream event. |\n| [AnthropicRawMessageStopEvent](type-aliases/AnthropicRawMessageStopEvent.md) | Anthropic SDK message-stop stream event. |\n| [AnthropicRawMessageStreamEvent](type-aliases/AnthropicRawMessageStreamEvent.md) | Anthropic SDK stream-event union. |\n| [AnthropicRedactedThinkingBlock](type-aliases/AnthropicRedactedThinkingBlock.md) | Anthropic SDK redacted thinking block response shape. |\n| [AnthropicRedactedThinkingBlockParam](type-aliases/AnthropicRedactedThinkingBlockParam.md) | Anthropic SDK redacted thinking block input shape. |\n| [AnthropicRefusalStopDetails](type-aliases/AnthropicRefusalStopDetails.md) | Anthropic SDK refusal details shape. |\n| [AnthropicStopReason](type-aliases/AnthropicStopReason.md) | Anthropic SDK stop-reason union. |\n| [AnthropicTextBlockParam](type-aliases/AnthropicTextBlockParam.md) | Anthropic SDK text block input shape. |\n| [AnthropicThinkingBlock](type-aliases/AnthropicThinkingBlock.md) | Anthropic SDK signed thinking block response shape. |\n| [AnthropicThinkingBlockParam](type-aliases/AnthropicThinkingBlockParam.md) | Anthropic SDK signed thinking block input shape. |\n| [AnthropicThinkingConfigParam](type-aliases/AnthropicThinkingConfigParam.md) | Anthropic SDK thinking configuration union. |\n| [AnthropicThinkingReplayPayload](type-aliases/AnthropicThinkingReplayPayload.md) | Opaque payload stored on a replayable Anthropic thinking `Thought`. |\n| [AnthropicTool](type-aliases/AnthropicTool.md) | Anthropic SDK client tool definition shape. |\n| [AnthropicToolChoice](type-aliases/AnthropicToolChoice.md) | Anthropic SDK tool-choice union. |\n| [AnthropicToolResultBlockParam](type-aliases/AnthropicToolResultBlockParam.md) | Anthropic SDK tool-result block input shape. |\n| [AnthropicToolUseBlock](type-aliases/AnthropicToolUseBlock.md) | Anthropic SDK tool-use block response shape. |\n| [AnthropicToolUseBlockParam](type-aliases/AnthropicToolUseBlockParam.md) | Anthropic SDK tool-use block input shape. |\n| [AnthropicUsage](type-aliases/AnthropicUsage.md) | Anthropic SDK usage shape for completed messages. |\n\n## References\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../../interfaces/MemoryAttrs.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../../interfaces/UntrustedContentAttrs.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesAdapterOptions","title":"Interface: AnthropicMessagesAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesAdapterOptions.md\ndescription: Configuration options for the Anthropic Messages adapter.\n---\n\n# Interface: AnthropicMessagesAdapterOptions\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L359)\n\nConfiguration options for the Anthropic Messages adapter.\n\n## Properties\n\n| Property | Type | Default value | Description | Defined in |\n| ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | `undefined` | API key used by the Anthropic SDK. Omit only when another SDK credential source is intended. | [src/batteries/llm/anthropic\\_messages/types.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L361) |\n| `autoAck?` | `boolean` | `undefined` | Whether the executor acks automatically on a tool-call-free terminal answer. | [src/batteries/llm/anthropic\\_messages/types.ts:437](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L437) |\n| `baseURL?` | `string` | `undefined` | Endpoint base URL. Defaults to the Anthropic SDK default unless overridden. | [src/batteries/llm/anthropic\\_messages/types.ts:363](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L363) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | `undefined` | Determines order of system-prompt content buckets in history assembly. | [src/batteries/llm/anthropic\\_messages/types.ts:421](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L421) |\n| `cacheBreakpoints?` | [`AnthropicCacheBreakpoints`](../type-aliases/AnthropicCacheBreakpoints.md) | `undefined` | Prompt-cache breakpoint placement mode. | [src/batteries/llm/anthropic\\_messages/types.ts:455](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L455) |\n| `cacheTtl?` | [`AnthropicCacheTtl`](../type-aliases/AnthropicCacheTtl.md) | `undefined` | Optional TTL applied to emitted prompt-cache breakpoints. | [src/batteries/llm/anthropic\\_messages/types.ts:457](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L457) |\n| `container?` | `string` | `null` | `undefined` | Anthropic container identifier for container-capable tools. | [src/batteries/llm/anthropic\\_messages/types.ts:463](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L463) |\n| `contextWindow?` | `number` | `undefined` | Size of the model's token context window for the ADK guard. | [src/batteries/llm/anthropic\\_messages/types.ts:423](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L423) |\n| `dangerouslyAllowBrowser?` | `boolean` | `undefined` | Allows Anthropic SDK use in browser-like runtimes despite API-key exposure risk. | [src/batteries/llm/anthropic\\_messages/types.ts:453](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L453) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | `undefined` | Custom fetch implementation, used for tests, proxies, or custom transports. | [src/batteries/llm/anthropic\\_messages/types.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L367) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | `undefined` | Custom HTTP headers sent with every request. | [src/batteries/llm/anthropic\\_messages/types.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L365) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`AnthropicMessagesHelpers`](AnthropicMessagesHelpers.md)> | `undefined` | Optional overrides for Anthropic translation helpers. | [src/batteries/llm/anthropic\\_messages/types.ts:433](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L433) |\n| `inferenceGeo?` | `string` | `null` | `undefined` | Anthropic inference geography selector. | [src/batteries/llm/anthropic\\_messages/types.ts:465](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L465) |\n| `localToolCallParser?` | | [`ToolCallParserName`](../../../transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) | `undefined` | Optional fallback parser for non-structural local tool-call text. | [src/batteries/llm/anthropic\\_messages/types.ts:494](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L494) |\n| `maxTokens` | `number` | `undefined` | Required maximum number of output tokens to request from Anthropic. | [src/batteries/llm/anthropic\\_messages/types.ts:443](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L443) |\n| `metadata?` | `Metadata` | `undefined` | Anthropic request metadata. | [src/batteries/llm/anthropic\\_messages/types.ts:459](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L459) |\n| `model` | `Model` | `undefined` | Required Anthropic model identifier. | [src/batteries/llm/anthropic\\_messages/types.ts:441](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L441) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | `undefined` | Observe the fully assembled Anthropic request before dispatch. | [src/batteries/llm/anthropic\\_messages/types.ts:492](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L492) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | `undefined` | Observe the model's raw response for each completed generation. | [src/batteries/llm/anthropic\\_messages/types.ts:490](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L490) |\n| `outputConfig?` | `OutputConfig` | `undefined` | Structured-output and effort configuration sent to Anthropic. | [src/batteries/llm/anthropic\\_messages/types.ts:449](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L449) |\n| `replayCompatibility?` | readonly `string`\\[] | `undefined` | List of replay labels supported by this adapter. | [src/batteries/llm/anthropic\\_messages/types.ts:431](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L431) |\n| `requestTimeoutMs?` | `number` | `undefined` | Request timeout in milliseconds for API calls. | [src/batteries/llm/anthropic\\_messages/types.ts:373](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L373) |\n| `resolveErrorStatus?` | [`AnthropicMessagesErrorStatusResolver`](../type-aliases/AnthropicMessagesErrorStatusResolver.md) | `undefined` — no recovery; a statusless `APIError` stays fatal, preserving the behaviour of adapters built before this hook existed. | Recovers an HTTP status the Anthropic SDK could not observe, so retry classification can see it. **Remarks** Unlike the Ollama and OpenAI batteries — which read `response.status` off a raw `fetch` and therefore always see the real code — this battery classifies from the SDK's `APIError`. When a gateway terminates the HTTP request itself and reports the upstream failure *inside the response body*, `err.status` is absent, is coerced to `0`, matches nothing in @nhtio/adk/batteries/llm/chat\\_common!ChatCompletionsRetryConfig.retriableStatuses, and the error is classified fatal — so a transient upstream `529 overloaded_error` fails on first occurrence with retry never consulted. The ADK deliberately ships **no** body parser: the shape of a gateway's error envelope is the consumer's knowledge, not the ADK's, and guessing it with a built-in regex risks reading a three-digit request id — or a genuine deterministic `4xx` — as a retriable status. This hook is the seam for a consumer who *does* know their gateway. Called only for SDK `APIError`s, before retriable/fatal classification and before the context-overflow body-text check. Return an HTTP status to classify against, or `undefined` to decline — declining leaves `sdkStatus` in force, so a resolver that does not recognise a body is a no-op rather than a hazard. A returned value outside 100–599 is ignored with a warning. The resolved status is what reaches `retriableStatuses`, the `E_ANTHROPIC_MESSAGES_HTTP_ERROR` payload, and the log line — so a recovered `529` is reported as `529`, not `0`. Must not throw; a throwing resolver is caught, warned about, and treated as declining. **Example** `new AnthropicMessagesAdapter({ model, maxTokens, retry: { maxAttempts: 4 }, // This gateway reports the upstream status in the body and nowhere else. resolveErrorStatus: ({ bodyText, sdkStatus }) => { if (sdkStatus !== 0) return undefined const m = /upstream returned (\\d{3})/.exec(bodyText) return m ? Number(m[1]) : undefined }, })` | [src/batteries/llm/anthropic\\_messages/types.ts:419](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L419) |\n| `retry?` | [`ChatCompletionsRetryConfig`](../../../../interfaces/ChatCompletionsRetryConfig.md) | `undefined` | Configures ADK-owned request retry behavior. | [src/batteries/llm/anthropic\\_messages/types.ts:375](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L375) |\n| `selfIdentity?` | `string` | `undefined` | Unique identity label for the assistant instance. | [src/batteries/llm/anthropic\\_messages/types.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L425) |\n| `serviceTier?` | `\"auto\"` | `\"standard_only\"` | `undefined` | Anthropic service-tier selector. | [src/batteries/llm/anthropic\\_messages/types.ts:461](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L461) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | `undefined` | Backing store for string or bytes tool returns. | [src/batteries/llm/anthropic\\_messages/types.ts:435](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L435) |\n| `stopSequences?` | `string`\\[] | `undefined` | Custom stop sequences sent as `stop_sequences`. | [src/batteries/llm/anthropic\\_messages/types.ts:445](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L445) |\n| `stream?` | `boolean` | `undefined` | Whether to stream the response as Anthropic stream events. | [src/batteries/llm/anthropic\\_messages/types.ts:369](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L369) |\n| `streamIdleTimeoutMs?` | `number` | `undefined` | Idle timeout in milliseconds for the stream before aborting. | [src/batteries/llm/anthropic\\_messages/types.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L371) |\n| ~~`temperature?`~~ | `number` | `undefined` | Deprecated Anthropic temperature sampling parameter. **Deprecated** Models released after Claude Opus 4.6 reject most values with a 400. The adapter never supplies this unless the caller sets it. | [src/batteries/llm/anthropic\\_messages/types.ts:474](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L474) |\n| `thinking?` | `ThinkingConfigParam` | `undefined` | Extended or adaptive thinking configuration sent to Anthropic. | [src/batteries/llm/anthropic\\_messages/types.ts:447](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L447) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | `undefined` | Determines which thoughts are surfaced back to the model. | [src/batteries/llm/anthropic\\_messages/types.ts:427](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L427) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | `undefined` | Tokenizer encoding configuration for token counting. | [src/batteries/llm/anthropic\\_messages/types.ts:429](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L429) |\n| `toolCallIdFilter?` | [`ToolCallIdFilterFn`](../../../../type-aliases/ToolCallIdFilterFn.md) | `undefined` | Optional ingress hook for adapting provider tool-call ids; absent preserves the vendor id. | [src/batteries/llm/anthropic\\_messages/types.ts:496](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L496) |\n| `toolChoice?` | `ToolChoice` | `undefined` | Tool-choice directive sent to Anthropic. | [src/batteries/llm/anthropic\\_messages/types.ts:451](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L451) |\n| ~~`topK?`~~ | `number` | `undefined` | Deprecated Anthropic top-k sampling parameter. **Deprecated** Models released after Claude Opus 4.6 reject every value with a 400. The adapter never supplies this unless the caller sets it. | [src/batteries/llm/anthropic\\_messages/types.ts:488](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L488) |\n| ~~`topP?`~~ | `number` | `undefined` | Deprecated Anthropic nucleus-sampling parameter. **Deprecated** Models released after Claude Opus 4.6 reject lower values with a 400. The adapter never supplies this unless the caller sets it. | [src/batteries/llm/anthropic\\_messages/types.ts:481](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L481) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined` | Policy for media whose modality the Anthropic Messages wire cannot represent. | [src/batteries/llm/anthropic\\_messages/types.ts:439](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L439) |\n| `userProfileId?` | `string` | `undefined` | Anthropic user-profile request parameter (SDK maps this header param on the wire). | [src/batteries/llm/anthropic\\_messages/types.ts:467](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L467) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesCountTokensInput","title":"Interface: AnthropicMessagesCountTokensInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesCountTokensInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesCountTokensInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesCountTokensInput.md\ndescription: Constructor-compatible shape for future count-token helpers.\n---\n\n# Interface: AnthropicMessagesCountTokensInput\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:502](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L502)\n\nConstructor-compatible shape for future count-token helpers.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ----------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `context?` | [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md) | Optional dispatch context whose prompt should be assembled before counting. | [src/batteries/llm/anthropic\\_messages/types.ts:504](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L504) |\n| `messages?` | `MessageParam`\\[] | Optional pre-built Anthropic input messages to count. | [src/batteries/llm/anthropic\\_messages/types.ts:506](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L506) |\n| `system?` | `string` | `TextBlockParam`\\[] | Optional pre-built Anthropic system prompt to count. | [src/batteries/llm/anthropic\\_messages/types.ts:508](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L508) |\n| `tools?` | `Tool`\\[] | Optional pre-built Anthropic tools to count. | [src/batteries/llm/anthropic\\_messages/types.ts:510](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L510) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesErrorStatusInput","title":"Interface: AnthropicMessagesErrorStatusInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesErrorStatusInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesErrorStatusInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesErrorStatusInput.md\ndescription: 'Input handed to an [`AnthropicMessagesErrorStatusResolver`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessagesErrorStatusResolver).'\n---\n\n# Interface: AnthropicMessagesErrorStatusInput\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L326)\n\nInput handed to an [AnthropicMessagesErrorStatusResolver](../type-aliases/AnthropicMessagesErrorStatusResolver.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `bodyText` | `string` | The error body as text: `JSON.stringify(err.error)` when the SDK parsed an object, else its string form. Empty string when the SDK captured no body. | [src/batteries/llm/anthropic\\_messages/types.ts:333](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L333) |\n| `error` | `unknown` | The raw SDK error being classified — an `APIError` instance. | [src/batteries/llm/anthropic\\_messages/types.ts:328](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L328) |\n| `sdkStatus` | `number` | The status the SDK reported, already coerced: `err.status` when numeric, otherwise `0`. A resolver typically returns `undefined` immediately unless this is `0`. | [src/batteries/llm/anthropic\\_messages/types.ts:338](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L338) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesHelpers","title":"Interface: AnthropicMessagesHelpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesHelpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesHelpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/interfaces/AnthropicMessagesHelpers.md\ndescription: Full translation-helper contract for the Anthropic Messages battery.\n---\n\n# Interface: AnthropicMessagesHelpers\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L209)\n\nFull translation-helper contract for the Anthropic Messages battery.\n\n## Extends\n\n* [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `anthropicToolsFromTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `Tool`\\[] | Translates the ADK tool registry into Anthropic client-tool definitions. | - | - | [src/batteries/llm/anthropic\\_messages/types.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L211) |\n| `buildAnthropicMessagesHistory` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../type-aliases/AnthropicCacheTtl.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `model`: `string`; `renderAnthropicSegmentedSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../type-aliases/AnthropicCacheTtl.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`TextBlockParam`\\[]>; `renderAnthropicThinkingBlocks`: (`input`: { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => `ContentBlockParam`\\[]; `renderAnthropicTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageParam` | `null`>; `renderAnthropicToolCallResult`: (`input`: { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ToolResultBlockParam`>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `ToolResultBlockParam`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<{ `messages`: `MessageParam`\\[]; `system?`: `string` | `TextBlockParam`\\[]; `tools?`: `Tool`\\[]; }> | Assembles the full Anthropic Messages history, system prompt, tools, and thinking replay. | - | - | [src/batteries/llm/anthropic\\_messages/types.ts:279](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L279) |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`descriptionToChatCompletionsJsonSchema`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema) | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`filterThoughts`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts) | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `renderAnthropicMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]> | Renders one ADK media value into Anthropic content blocks. | - | - | [src/batteries/llm/anthropic\\_messages/types.ts:226](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L226) |\n| `renderAnthropicSegmentedSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `cacheBreakpoints`: [`AnthropicCacheBreakpoints`](../type-aliases/AnthropicCacheBreakpoints.md); `cacheTtl?`: [`AnthropicCacheTtl`](../type-aliases/AnthropicCacheTtl.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`TextBlockParam`\\[]> | Renders the system prompt as segmented Anthropic text blocks for cache breakpoints. | - | - | [src/batteries/llm/anthropic\\_messages/types.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L251) |\n| `renderAnthropicThinkingBlocks` | (`input`: { `model`: `string`; `prefixFingerprint`: `string`; `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => `ContentBlockParam`\\[] | Converts a replayable Anthropic thinking `Thought` into wire content blocks. | - | - | [src/batteries/llm/anthropic\\_messages/types.ts:271](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L271) |\n| `renderAnthropicTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageParam` | `null`> | Renders an ADK timeline message into an Anthropic input message. | - | - | [src/batteries/llm/anthropic\\_messages/types.ts:218](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L218) |\n| `renderAnthropicToolCallResult` | (`input`: { `renderAnthropicMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ContentBlockParam`\\[]>; `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`ToolResultBlockParam`> | Renders a tool call's result into Anthropic tool-result content blocks. | - | - | [src/batteries/llm/anthropic\\_messages/types.ts:238](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L238) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing handle body for a non-inlined spooled artifact. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderArtifactHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody) | - | [src/batteries/llm/anthropic\\_messages/types.ts:234](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L234) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderChatCompletionsSystemPrompt`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt) | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderFirstPartyRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables) | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderMemories`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories) | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing handle body for a non-inlined retrievable's spooled artifact content. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablehandlebody) | - | [src/batteries/llm/anthropic\\_messages/types.ts:236](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L236) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables) | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableSafetyDirective`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective) | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderStandingInstructions`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions) | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPrivateRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables) | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPublicRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables) | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThought`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought) | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderTrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderUntrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | - | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`toolsToChatCompletionsTools`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools) | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheBreakpoints","title":"Type Alias: AnthropicCacheBreakpoints","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheBreakpoints.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheBreakpoints","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheBreakpoints.md\ndescription: Cache-breakpoint placement mode for Anthropic prompt caching.\n---\n\n# Type Alias: AnthropicCacheBreakpoints\n\n```ts\ntype AnthropicCacheBreakpoints = \"auto\" | \"system-only\" | \"off\";\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L201)\n\nCache-breakpoint placement mode for Anthropic prompt caching.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheControlEphemeral","title":"Type Alias: AnthropicCacheControlEphemeral","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheControlEphemeral.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheControlEphemeral","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheControlEphemeral.md\ndescription: Anthropic SDK cache-control breakpoint shape.\n---\n\n# Type Alias: AnthropicCacheControlEphemeral\n\n```ts\ntype AnthropicCacheControlEphemeral = CacheControlEphemeral;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L169)\n\nAnthropic SDK cache-control breakpoint shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheTtl","title":"Type Alias: AnthropicCacheTtl","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheTtl.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheTtl","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicCacheTtl.md\ndescription: Optional TTL value for Anthropic prompt-cache breakpoints.\n---\n\n# Type Alias: AnthropicCacheTtl\n\n```ts\ntype AnthropicCacheTtl = \"5m\" | \"1h\";\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:204](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L204)\n\nOptional TTL value for Anthropic prompt-cache breakpoints.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlock","title":"Type Alias: AnthropicContentBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlock.md\ndescription: Anthropic SDK content block union returned by the model.\n---\n\n# Type Alias: AnthropicContentBlock\n\n```ts\ntype AnthropicContentBlock = ContentBlock;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L111)\n\nAnthropic SDK content block union returned by the model.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlockParam","title":"Type Alias: AnthropicContentBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicContentBlockParam.md\ndescription: Anthropic SDK input content block union.\n---\n\n# Type Alias: AnthropicContentBlockParam\n\n```ts\ntype AnthropicContentBlockParam = ContentBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L113)\n\nAnthropic SDK input content block union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicDocumentBlockParam","title":"Type Alias: AnthropicDocumentBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicDocumentBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicDocumentBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicDocumentBlockParam.md\ndescription: Anthropic SDK document block input shape.\n---\n\n# Type Alias: AnthropicDocumentBlockParam\n\n```ts\ntype AnthropicDocumentBlockParam = DocumentBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L119)\n\nAnthropic SDK document block input shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicImageBlockParam","title":"Type Alias: AnthropicImageBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicImageBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicImageBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicImageBlockParam.md\ndescription: Anthropic SDK image block input shape.\n---\n\n# Type Alias: AnthropicImageBlockParam\n\n```ts\ntype AnthropicImageBlockParam = ImageBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L117)\n\nAnthropic SDK image block input shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicJSONOutputFormat","title":"Type Alias: AnthropicJSONOutputFormat","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicJSONOutputFormat.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicJSONOutputFormat","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicJSONOutputFormat.md\ndescription: Anthropic SDK JSON structured-output format shape.\n---\n\n# Type Alias: AnthropicJSONOutputFormat\n\n```ts\ntype AnthropicJSONOutputFormat = JSONOutputFormat;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L167)\n\nAnthropic SDK JSON structured-output format shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessage","title":"Type Alias: AnthropicMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessage.md\ndescription: Anthropic SDK response message shape.\n---\n\n# Type Alias: AnthropicMessage\n\n```ts\ntype AnthropicMessage = SdkMessage;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L109)\n\nAnthropic SDK response message shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCountTokensParams","title":"Type Alias: AnthropicMessageCountTokensParams","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCountTokensParams.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCountTokensParams","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCountTokensParams.md\ndescription: Anthropic SDK token-count request shape.\n---\n\n# Type Alias: AnthropicMessageCountTokensParams\n\n```ts\ntype AnthropicMessageCountTokensParams = MessageCountTokensParams;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L171)\n\nAnthropic SDK token-count request shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParams","title":"Type Alias: AnthropicMessageCreateParams","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParams.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParams","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParams.md\ndescription: Anthropic SDK create-request union.\n---\n\n# Type Alias: AnthropicMessageCreateParams\n\n```ts\ntype AnthropicMessageCreateParams = MessageCreateParams;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L103)\n\nAnthropic SDK create-request union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParamsBase","title":"Type Alias: AnthropicMessageCreateParamsBase","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParamsBase.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParamsBase","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageCreateParamsBase.md\ndescription: Anthropic SDK create-request base shape.\n---\n\n# Type Alias: AnthropicMessageCreateParamsBase\n\n```ts\ntype AnthropicMessageCreateParamsBase = MessageCreateParamsBase;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L105)\n\nAnthropic SDK create-request base shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageDeltaUsage","title":"Type Alias: AnthropicMessageDeltaUsage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageDeltaUsage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageDeltaUsage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageDeltaUsage.md\ndescription: Anthropic SDK streaming usage snapshot shape.\n---\n\n# Type Alias: AnthropicMessageDeltaUsage\n\n```ts\ntype AnthropicMessageDeltaUsage = MessageDeltaUsage;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L159)\n\nAnthropic SDK streaming usage snapshot shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageParam","title":"Type Alias: AnthropicMessageParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageParam.md\ndescription: Anthropic SDK input message shape.\n---\n\n# Type Alias: AnthropicMessageParam\n\n```ts\ntype AnthropicMessageParam = MessageParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L107)\n\nAnthropic SDK input message shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessagesErrorStatusResolver","title":"Type Alias: AnthropicMessagesErrorStatusResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessagesErrorStatusResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessagesErrorStatusResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessagesErrorStatusResolver.md\ndescription: Recovers an HTTP status the Anthropic SDK could not observe.\n---\n\n# Type Alias: AnthropicMessagesErrorStatusResolver\n\n```ts\ntype AnthropicMessagesErrorStatusResolver = (\n input: AnthropicMessagesErrorStatusInput,\n) => number | undefined;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:352](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L352)\n\nRecovers an HTTP status the Anthropic SDK could not observe.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------ |\n| `input` | [`AnthropicMessagesErrorStatusInput`](../interfaces/AnthropicMessagesErrorStatusInput.md) | The error, its body text, and the SDK-reported status. |\n\n## Returns\n\n`number` | `undefined`\n\nAn HTTP status to classify against, or `undefined` to decline.\n\n## Remarks\n\nSee [AnthropicMessagesAdapterOptions.resolveErrorStatus](../interfaces/AnthropicMessagesAdapterOptions.md#property-resolveerrorstatus) for when this is called, why the\nADK ships no default implementation, and the contract for declining. Return an HTTP status\n(100–599) to classify against, or `undefined` to leave `sdkStatus` in force.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageTokensCount","title":"Type Alias: AnthropicMessageTokensCount","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageTokensCount.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageTokensCount","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicMessageTokensCount.md\ndescription: Anthropic SDK token-count response shape.\n---\n\n# Type Alias: AnthropicMessageTokensCount\n\n```ts\ntype AnthropicMessageTokensCount = MessageTokensCount;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L173)\n\nAnthropic SDK token-count response shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicModel","title":"Type Alias: AnthropicModel","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicModel.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicModel","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicModel.md\ndescription: Anthropic SDK model identifier type.\n---\n\n# Type Alias: AnthropicModel\n\n```ts\ntype AnthropicModel = Model;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L101)\n\nAnthropic SDK model identifier type.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicOutputConfig","title":"Type Alias: AnthropicOutputConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicOutputConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicOutputConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicOutputConfig.md\ndescription: Anthropic SDK output-configuration shape.\n---\n\n# Type Alias: AnthropicOutputConfig\n\n```ts\ntype AnthropicOutputConfig = OutputConfig;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L165)\n\nAnthropic SDK output-configuration shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDelta","title":"Type Alias: AnthropicRawContentBlockDelta","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDelta.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDelta","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDelta.md\ndescription: Anthropic SDK content-block delta union.\n---\n\n# Type Alias: AnthropicRawContentBlockDelta\n\n```ts\ntype AnthropicRawContentBlockDelta = RawContentBlockDelta;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L155)\n\nAnthropic SDK content-block delta union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDeltaEvent","title":"Type Alias: AnthropicRawContentBlockDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockDeltaEvent.md\ndescription: Anthropic SDK content-block-delta stream event.\n---\n\n# Type Alias: AnthropicRawContentBlockDeltaEvent\n\n```ts\ntype AnthropicRawContentBlockDeltaEvent = RawContentBlockDeltaEvent;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L151)\n\nAnthropic SDK content-block-delta stream event.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStartEvent","title":"Type Alias: AnthropicRawContentBlockStartEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStartEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStartEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStartEvent.md\ndescription: Anthropic SDK content-block-start stream event.\n---\n\n# Type Alias: AnthropicRawContentBlockStartEvent\n\n```ts\ntype AnthropicRawContentBlockStartEvent = RawContentBlockStartEvent;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:149](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L149)\n\nAnthropic SDK content-block-start stream event.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStopEvent","title":"Type Alias: AnthropicRawContentBlockStopEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStopEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStopEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawContentBlockStopEvent.md\ndescription: Anthropic SDK content-block-stop stream event.\n---\n\n# Type Alias: AnthropicRawContentBlockStopEvent\n\n```ts\ntype AnthropicRawContentBlockStopEvent = RawContentBlockStopEvent;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L153)\n\nAnthropic SDK content-block-stop stream event.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageDeltaEvent","title":"Type Alias: AnthropicRawMessageDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageDeltaEvent.md\ndescription: Anthropic SDK message-delta stream event.\n---\n\n# Type Alias: AnthropicRawMessageDeltaEvent\n\n```ts\ntype AnthropicRawMessageDeltaEvent = RawMessageDeltaEvent;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L145)\n\nAnthropic SDK message-delta stream event.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStartEvent","title":"Type Alias: AnthropicRawMessageStartEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStartEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStartEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStartEvent.md\ndescription: Anthropic SDK message-start stream event.\n---\n\n# Type Alias: AnthropicRawMessageStartEvent\n\n```ts\ntype AnthropicRawMessageStartEvent = RawMessageStartEvent;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L143)\n\nAnthropic SDK message-start stream event.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStopEvent","title":"Type Alias: AnthropicRawMessageStopEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStopEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStopEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStopEvent.md\ndescription: Anthropic SDK message-stop stream event.\n---\n\n# Type Alias: AnthropicRawMessageStopEvent\n\n```ts\ntype AnthropicRawMessageStopEvent = RawMessageStopEvent;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L147)\n\nAnthropic SDK message-stop stream event.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStreamEvent","title":"Type Alias: AnthropicRawMessageStreamEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStreamEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStreamEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRawMessageStreamEvent.md\ndescription: Anthropic SDK stream-event union.\n---\n\n# Type Alias: AnthropicRawMessageStreamEvent\n\n```ts\ntype AnthropicRawMessageStreamEvent = RawMessageStreamEvent;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L141)\n\nAnthropic SDK stream-event union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlock","title":"Type Alias: AnthropicRedactedThinkingBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlock.md\ndescription: Anthropic SDK redacted thinking block response shape.\n---\n\n# Type Alias: AnthropicRedactedThinkingBlock\n\n```ts\ntype AnthropicRedactedThinkingBlock = RedactedThinkingBlock;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L137)\n\nAnthropic SDK redacted thinking block response shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlockParam","title":"Type Alias: AnthropicRedactedThinkingBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRedactedThinkingBlockParam.md\ndescription: Anthropic SDK redacted thinking block input shape.\n---\n\n# Type Alias: AnthropicRedactedThinkingBlockParam\n\n```ts\ntype AnthropicRedactedThinkingBlockParam = RedactedThinkingBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L139)\n\nAnthropic SDK redacted thinking block input shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRefusalStopDetails","title":"Type Alias: AnthropicRefusalStopDetails","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRefusalStopDetails.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRefusalStopDetails","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicRefusalStopDetails.md\ndescription: Anthropic SDK refusal details shape.\n---\n\n# Type Alias: AnthropicRefusalStopDetails\n\n```ts\ntype AnthropicRefusalStopDetails = RefusalStopDetails;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:163](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L163)\n\nAnthropic SDK refusal details shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicStopReason","title":"Type Alias: AnthropicStopReason","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicStopReason.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicStopReason","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicStopReason.md\ndescription: Anthropic SDK stop-reason union.\n---\n\n# Type Alias: AnthropicStopReason\n\n```ts\ntype AnthropicStopReason = StopReason;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L161)\n\nAnthropic SDK stop-reason union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTextBlockParam","title":"Type Alias: AnthropicTextBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTextBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTextBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTextBlockParam.md\ndescription: Anthropic SDK text block input shape.\n---\n\n# Type Alias: AnthropicTextBlockParam\n\n```ts\ntype AnthropicTextBlockParam = TextBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L115)\n\nAnthropic SDK text block input shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlock","title":"Type Alias: AnthropicThinkingBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlock.md\ndescription: Anthropic SDK signed thinking block response shape.\n---\n\n# Type Alias: AnthropicThinkingBlock\n\n```ts\ntype AnthropicThinkingBlock = ThinkingBlock;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L133)\n\nAnthropic SDK signed thinking block response shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlockParam","title":"Type Alias: AnthropicThinkingBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingBlockParam.md\ndescription: Anthropic SDK signed thinking block input shape.\n---\n\n# Type Alias: AnthropicThinkingBlockParam\n\n```ts\ntype AnthropicThinkingBlockParam = ThinkingBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L135)\n\nAnthropic SDK signed thinking block input shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingConfigParam","title":"Type Alias: AnthropicThinkingConfigParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingConfigParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingConfigParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingConfigParam.md\ndescription: Anthropic SDK thinking configuration union.\n---\n\n# Type Alias: AnthropicThinkingConfigParam\n\n```ts\ntype AnthropicThinkingConfigParam = ThinkingConfigParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L131)\n\nAnthropic SDK thinking configuration union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingReplayPayload","title":"Type Alias: AnthropicThinkingReplayPayload","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingReplayPayload.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingReplayPayload","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicThinkingReplayPayload.md\ndescription: Opaque payload stored on a replayable Anthropic thinking `Thought`.\n---\n\n# Type Alias: AnthropicThinkingReplayPayload\n\n```ts\ntype AnthropicThinkingReplayPayload =\n | {\n prefixFingerprint: string;\n signature: string;\n thinking: string;\n variant: \"thinking\";\n }\n | {\n data: string;\n prefixFingerprint: string;\n variant: \"redacted_thinking\";\n };\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:180](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L180)\n\nOpaque payload stored on a replayable Anthropic thinking `Thought`.\n\n## Union Members\n\n### Type Literal\n\n```ts\n{\n prefixFingerprint: string;\n signature: string;\n thinking: string;\n variant: \"thinking\";\n}\n```\n\n| Name | Type | Description | Defined in |\n| ------------------- | ------------ | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `prefixFingerprint` | `string` | Stable fingerprint of the signed conversation prefix. | [src/batteries/llm/anthropic\\_messages/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L189) |\n| `signature` | `string` | Signature exactly as emitted by Anthropic. | [src/batteries/llm/anthropic\\_messages/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L187) |\n| `thinking` | `string` | Thinking text exactly as emitted by Anthropic. | [src/batteries/llm/anthropic\\_messages/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L185) |\n| `variant` | `\"thinking\"` | Payload variant for a signed thinking block. | [src/batteries/llm/anthropic\\_messages/types.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L183) |\n\n***\n\n### Type Literal\n\n```ts\n{\n data: string;\n prefixFingerprint: string;\n variant: \"redacted_thinking\";\n}\n```\n\n| Name | Type | Description | Defined in |\n| ------------------- | --------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `data` | `string` | Redacted thinking data exactly as emitted by Anthropic. | [src/batteries/llm/anthropic\\_messages/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L195) |\n| `prefixFingerprint` | `string` | Stable fingerprint of the signed conversation prefix. | [src/batteries/llm/anthropic\\_messages/types.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L197) |\n| `variant` | `\"redacted_thinking\"` | Payload variant for a redacted thinking block. | [src/batteries/llm/anthropic\\_messages/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L193) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTool","title":"Type Alias: AnthropicTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicTool.md\ndescription: Anthropic SDK client tool definition shape.\n---\n\n# Type Alias: AnthropicTool\n\n```ts\ntype AnthropicTool = SdkTool;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L127)\n\nAnthropic SDK client tool definition shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolChoice","title":"Type Alias: AnthropicToolChoice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolChoice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolChoice","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolChoice.md\ndescription: Anthropic SDK tool-choice union.\n---\n\n# Type Alias: AnthropicToolChoice\n\n```ts\ntype AnthropicToolChoice = ToolChoice;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L129)\n\nAnthropic SDK tool-choice union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolResultBlockParam","title":"Type Alias: AnthropicToolResultBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolResultBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolResultBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolResultBlockParam.md\ndescription: Anthropic SDK tool-result block input shape.\n---\n\n# Type Alias: AnthropicToolResultBlockParam\n\n```ts\ntype AnthropicToolResultBlockParam = ToolResultBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L121)\n\nAnthropic SDK tool-result block input shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlock","title":"Type Alias: AnthropicToolUseBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlock.md\ndescription: Anthropic SDK tool-use block response shape.\n---\n\n# Type Alias: AnthropicToolUseBlock\n\n```ts\ntype AnthropicToolUseBlock = ToolUseBlock;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L123)\n\nAnthropic SDK tool-use block response shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlockParam","title":"Type Alias: AnthropicToolUseBlockParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlockParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlockParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicToolUseBlockParam.md\ndescription: Anthropic SDK tool-use block input shape.\n---\n\n# Type Alias: AnthropicToolUseBlockParam\n\n```ts\ntype AnthropicToolUseBlockParam = ToolUseBlockParam;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L125)\n\nAnthropic SDK tool-use block input shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicUsage","title":"Type Alias: AnthropicUsage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicUsage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicUsage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/types/type-aliases/AnthropicUsage.md\ndescription: Anthropic SDK usage shape for completed messages.\n---\n\n# Type Alias: AnthropicUsage\n\n```ts\ntype AnthropicUsage = Usage;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/types.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/types.ts#L157)\n\nAnthropic SDK usage shape for completed messages.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation","title":"@nhtio/adk/batteries/llm/anthropic\\_messages/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/validation.md\ndescription: Runtime validation schema and wrapper for Anthropic Messages adapter options.\n---\n\n# @nhtio/adk/batteries/llm/anthropic\\_messages/validation\n\nRuntime validation schema and wrapper for Anthropic Messages adapter options.\n\n## Remarks\n\nSchema and call-site wrapper for validating `AnthropicMessagesAdapterOptions`. Used at\nconstruction time and at the start of every iteration against the merged options shape. Throws\n`E_INVALID_ANTHROPIC_MESSAGES_OPTIONS` on failure, matching the hard-fail policy of the sibling\nHTTP batteries.\n\nNote the deliberate `.unknown(...)` asymmetry: the top level is `.unknown(false)` so option typos\nfail loud, but provider-owned passthrough blocks are `.unknown(true)` so SDK-supported additions\ncan pass through without a library bump.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [anthropicMessagesOptionsSchema](variables/anthropicMessagesOptionsSchema.md) | Validator schema for `AnthropicMessagesAdapterOptions`. Used by `validateOptions` at construction time and again at the start of every iteration after options have been merged. Rejects unknown top-level keys so typos fail loud. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates arbitrary input against `anthropicMessagesOptionsSchema` and returns resolved options. Throws `E_INVALID_ANTHROPIC_MESSAGES_OPTIONS` with validator details on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): AnthropicMessagesAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/validation.ts:269](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/validation.ts#L269)\n\nValidates arbitrary input against `anthropicMessagesOptionsSchema` and returns resolved options.\nThrows `E_INVALID_ANTHROPIC_MESSAGES_OPTIONS` with validator details on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`AnthropicMessagesAdapterOptions`](../../types/interfaces/AnthropicMessagesAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/variables/anthropicMessagesOptionsSchema","title":"Variable: anthropicMessagesOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/variables/anthropicMessagesOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/variables/anthropicMessagesOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/anthropic_messages/validation/variables/anthropicMessagesOptionsSchema.md\ndescription: >-\n Validator schema for `AnthropicMessagesAdapterOptions`. Used by\n `validateOptions` at construction time and again at the start of every\n iteration after options have been merged. Rejects unknown top-level keys so\n typos fail loud.\n---\n\n# Variable: anthropicMessagesOptionsSchema\n\n```ts\nconst anthropicMessagesOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/anthropic\\_messages/validation.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/anthropic_messages/validation.ts#L201)\n\nValidator schema for `AnthropicMessagesAdapterOptions`. Used by `validateOptions` at construction\ntime and again at the start of every iteration after options have been merged. Rejects unknown\ntop-level keys so typos fail loud.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse","title":"@nhtio/adk/batteries/llm/bedrock\\_converse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse.md'\ndescription: >-\n Native AWS Bedrock Converse adapter battery with swappable translation helpers\n and wire types.\n---\n\n# @nhtio/adk/batteries/llm/bedrock\\_converse\n\nNative AWS Bedrock Converse adapter battery with swappable translation helpers and wire types.\n\n## Remarks\n\nTargets Bedrock's NATIVE `POST {baseURL}/model/{modelId}/converse` surface over plain HTTPS with\na Bedrock API key (`Authorization: Bearer ABSK…`) — no AWS SDK, no SigV4 signer, so the battery\nstays cross-environment and dependency-light.\n\nConverse is a content-BLOCK protocol and differs from Chat Completions structurally: a turn's\npayload is a typed `content[]` (`{text}`, `{image}`, `{toolUse}`, `{toolResult}`) so one\nassistant turn can carry prose and a tool call together; a tool result rides a **`user`** turn;\nsystem text is a top-level `system[]`; roles must strictly alternate; and `toolConfig` is\nREQUIRED whenever any tool block appears, including pure history replay.\n\nThat last pair is why this battery exists. A gateway fronting Converse has to repair\nnon-alternating history on your behalf — typically by merging consecutive same-role turns — and\nthat repair is invisible in the response, which makes a gateway's fix indistinguishable from\nvendor tolerance. [BedrockConverseAdapterOptions.alternationPolicy](types/interfaces/BedrockConverseAdapterOptions.md#property-alternationpolicy) exposes the choice:\n`'merge'` (default, lossless), `'filler'`, or `'reject'` to let Converse's own error surface when\nyou are auditing what the vendor actually enforces. See the validation battery's \"Which API\nsurface a rule applies to\" guide.\n\n## References\n\n### BedrockConverseAdapter\n\nRe-exports [BedrockConverseAdapter](adapter/classes/BedrockConverseAdapter.md)\n\n***\n\n### BedrockConverseAdapterOptions\n\nRe-exports [BedrockConverseAdapterOptions](types/interfaces/BedrockConverseAdapterOptions.md)\n\n***\n\n### BedrockConverseHelpers\n\nRe-exports [BedrockConverseHelpers](types/interfaces/BedrockConverseHelpers.md)\n\n***\n\n### bedrockConverseOptionsSchema\n\nRe-exports [bedrockConverseOptionsSchema](validation/variables/bedrockConverseOptionsSchema.md)\n\n***\n\n### buildConverseRequest\n\nRe-exports [buildConverseRequest](helpers/functions/buildConverseRequest.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### ConverseContentBlock\n\nRe-exports [ConverseContentBlock](types/interfaces/ConverseContentBlock.md)\n\n***\n\n### ConverseImageBlock\n\nRe-exports [ConverseImageBlock](types/interfaces/ConverseImageBlock.md)\n\n***\n\n### ConverseInferenceConfig\n\nRe-exports [ConverseInferenceConfig](types/interfaces/ConverseInferenceConfig.md)\n\n***\n\n### ConverseMessage\n\nRe-exports [ConverseMessage](types/interfaces/ConverseMessage.md)\n\n***\n\n### ConverseRequest\n\nRe-exports [ConverseRequest](types/interfaces/ConverseRequest.md)\n\n***\n\n### ConverseRequestBuildInput\n\nRe-exports [ConverseRequestBuildInput](types/interfaces/ConverseRequestBuildInput.md)\n\n***\n\n### ConverseResponse\n\nRe-exports [ConverseResponse](types/interfaces/ConverseResponse.md)\n\n***\n\n### ConverseRole\n\nRe-exports [ConverseRole](types/type-aliases/ConverseRole.md)\n\n***\n\n### ConverseSystemBlock\n\nRe-exports [ConverseSystemBlock](types/interfaces/ConverseSystemBlock.md)\n\n***\n\n### ConverseToolChoice\n\nRe-exports [ConverseToolChoice](types/type-aliases/ConverseToolChoice.md)\n\n***\n\n### ConverseToolConfig\n\nRe-exports [ConverseToolConfig](types/interfaces/ConverseToolConfig.md)\n\n***\n\n### ConverseToolResult\n\nRe-exports [ConverseToolResult](types/interfaces/ConverseToolResult.md)\n\n***\n\n### ConverseToolSpec\n\nRe-exports [ConverseToolSpec](types/interfaces/ConverseToolSpec.md)\n\n***\n\n### ConverseToolUse\n\nRe-exports [ConverseToolUse](types/interfaces/ConverseToolUse.md)\n\n***\n\n### ConverseUsage\n\nRe-exports [ConverseUsage](types/interfaces/ConverseUsage.md)\n\n***\n\n### deCollideToolCallIds\n\nRe-exports [deCollideToolCallIds](../../variables/deCollideToolCallIds.md)\n\n***\n\n### DEFAULT\\_CONVERSE\\_BUCKET\\_ORDER\n\nRe-exports [DEFAULT\\_CONVERSE\\_BUCKET\\_ORDER](helpers/variables/DEFAULT_CONVERSE_BUCKET_ORDER.md)\n\n***\n\n### defaultBuildConverseRequest\n\nRe-exports [defaultBuildConverseRequest](helpers/variables/defaultBuildConverseRequest.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultEnforceConverseAlternation\n\nRe-exports [defaultEnforceConverseAlternation](helpers/variables/defaultEnforceConverseAlternation.md)\n\n***\n\n### defaultExtractConverseGeneration\n\nRe-exports [defaultExtractConverseGeneration](helpers/variables/defaultExtractConverseGeneration.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultMediaToConverseImage\n\nRe-exports [defaultMediaToConverseImage](helpers/variables/defaultMediaToConverseImage.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderConverseToolResult\n\nRe-exports [defaultRenderConverseToolResult](helpers/variables/defaultRenderConverseToolResult.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultSanitizeConverseSchema\n\nRe-exports [defaultSanitizeConverseSchema](helpers/variables/defaultSanitizeConverseSchema.md)\n\n***\n\n### defaultSanitizeToolUseId\n\nRe-exports [defaultSanitizeToolUseId](helpers/variables/defaultSanitizeToolUseId.md)\n\n***\n\n### defaultToolsToConverseTools\n\nRe-exports [defaultToolsToConverseTools](helpers/variables/defaultToolsToConverseTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_CONVERSE\\_ALTERNATION\\_VIOLATION\n\nRe-exports [E\\_CONVERSE\\_ALTERNATION\\_VIOLATION](exceptions/variables/E_CONVERSE_ALTERNATION_VIOLATION.md)\n\n***\n\n### E\\_CONVERSE\\_INVALID\\_TOOL\\_INPUT\n\nRe-exports [E\\_CONVERSE\\_INVALID\\_TOOL\\_INPUT](exceptions/variables/E_CONVERSE_INVALID_TOOL_INPUT.md)\n\n***\n\n### E\\_CONVERSE\\_MISSING\\_TOOL\\_CONFIG\n\nRe-exports [E\\_CONVERSE\\_MISSING\\_TOOL\\_CONFIG](exceptions/variables/E_CONVERSE_MISSING_TOOL_CONFIG.md)\n\n***\n\n### E\\_CONVERSE\\_REQUEST\\_FAILED\n\nRe-exports [E\\_CONVERSE\\_REQUEST\\_FAILED](exceptions/variables/E_CONVERSE_REQUEST_FAILED.md)\n\n***\n\n### E\\_CONVERSE\\_STREAM\\_ERROR\n\nRe-exports [E\\_CONVERSE\\_STREAM\\_ERROR](exceptions/variables/E_CONVERSE_STREAM_ERROR.md)\n\n***\n\n### E\\_INVALID\\_BEDROCK\\_CONVERSE\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_BEDROCK\\_CONVERSE\\_OPTIONS](exceptions/variables/E_INVALID_BEDROCK_CONVERSE_OPTIONS.md)\n\n***\n\n### enforceConverseAlternation\n\nRe-exports [enforceConverseAlternation](helpers/functions/enforceConverseAlternation.md)\n\n***\n\n### extractConverseGeneration\n\nRe-exports [extractConverseGeneration](helpers/functions/extractConverseGeneration.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### mediaToConverseImage\n\nRe-exports [mediaToConverseImage](helpers/functions/mediaToConverseImage.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### PromptAssembledObserverFn\n\nRe-exports [PromptAssembledObserverFn](../../type-aliases/PromptAssembledObserverFn.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderConverseToolResult\n\nRe-exports [renderConverseToolResult](helpers/functions/renderConverseToolResult.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### sanitizeConverseSchema\n\nRe-exports [sanitizeConverseSchema](helpers/functions/sanitizeConverseSchema.md)\n\n***\n\n### sanitizeToolUseId\n\nRe-exports [sanitizeToolUseId](helpers/functions/sanitizeToolUseId.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### toolsToConverseTools\n\nRe-exports [toolsToConverseTools](helpers/functions/toolsToConverseTools.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter","title":"@nhtio/adk/batteries/llm/bedrock\\_converse/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter.md'\ndescription: Cross-environment executor adapter for AWS Bedrock's native Converse API.\n---\n\n# @nhtio/adk/batteries/llm/bedrock\\_converse/adapter\n\nCross-environment executor adapter for AWS Bedrock's native Converse API.\n\n## Remarks\n\nTargets `POST {baseURL}/model/{modelId}/converse` (and `/converse-stream` when `stream` is set)\nover plain HTTPS with a Bedrock API key (`Authorization: Bearer ABSK…`). Deliberately NO AWS SDK\nand no SigV4 signer: the battery must stay cross-environment and dependency-light, and a bearer\nkey removes the only reason to pull in a signer.\n\nWhy a native battery rather than pointing `openai_chat_completions` at a Converse-backed gateway:\nConverse is a content-BLOCK protocol with strict role alternation, a required `toolConfig`\nwhenever tool blocks appear, and tool results carried on `user` turns. A gateway must repair all\nof that on your behalf — most notably by MERGING consecutive same-role turns — and that repair is\ninvisible in the response. For ordinary use it is fine; for anything that needs to know what the\nVENDOR received it is fatal, because a gateway's fix is indistinguishable from vendor tolerance.\nSee the validation battery's \"Which API surface a rule applies to\" guide, and\n[BedrockConverseAdapterOptions.alternationPolicy](../types/interfaces/BedrockConverseAdapterOptions.md#property-alternationpolicy) for the `'reject'` escape hatch that lets\nConverse's own error surface.\n\nOptions layer as in every other battery: constructor baseline → `executor()` overrides →\nper-iteration `ctx.stash.bedrockConverse`, re-validated each iteration.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------- | ----------------------------------------- |\n| [BedrockConverseAdapter](classes/BedrockConverseAdapter.md) | Native Bedrock Converse executor adapter. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter/classes/BedrockConverseAdapter","title":"Class: BedrockConverseAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter/classes/BedrockConverseAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter/classes/BedrockConverseAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/adapter/classes/BedrockConverseAdapter.md\ndescription: Native Bedrock Converse executor adapter.\n---\n\n# Class: BedrockConverseAdapter\n\nDefined in: [src/batteries/llm/bedrock\\_converse/adapter.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/adapter.ts#L158)\n\nNative Bedrock Converse executor adapter.\n\n## Example\n\n```ts\nconst adapter = new BedrockConverseAdapter({\n model: 'us.amazon.nova-2-lite-v1:0',\n apiKey: process.env.AWS_BEARER_TOKEN_BEDROCK,\n region: 'us-east-1',\n})\nconst runner = new TurnRunner({ executorCallback: adapter.executor(), ... })\n```\n\n## Constructors\n\n### Constructor\n\n```ts\nnew BedrockConverseAdapter(options: unknown): BedrockConverseAdapter;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/adapter.ts:168](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/adapter.ts#L168)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | -------------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options, re-validated each iteration after overrides merge. |\n\n#### Returns\n\n`BedrockConverseAdapter`\n\n#### Throws\n\nE\\_INVALID\\_BEDROCK\\_CONVERSE\\_OPTIONS when `options` is invalid.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"bedrockConverse\"` | Per-iteration override key on `ctx.stash`. | [src/batteries/llm/bedrock\\_converse/adapter.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/adapter.ts#L160) |\n\n## Methods\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/adapter.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/adapter.ts#L182)\n\nBuild a [DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to the baseline plus optional executor-scope overrides.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`BedrockConverseAdapterOptions`](../../types/interfaces/BedrockConverseAdapterOptions.md)> | Higher precedence than the baseline, lower than `ctx.stash`. |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### isBedrockConverseAdapter()\n\n```ts\nstatic isBedrockConverseAdapter(value: unknown): value is BedrockConverseAdapter;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/adapter.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/adapter.ts#L173)\n\nNarrowing guard for cross-realm instances.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n#### Returns\n\n`value is BedrockConverseAdapter`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions","title":"@nhtio/adk/batteries/llm/bedrock\\_converse/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions.md'\ndescription: Battery-scoped exception constructors for the native Bedrock Converse adapter.\n---\n\n# @nhtio/adk/batteries/llm/bedrock\\_converse/exceptions\n\nBattery-scoped exception constructors for the native Bedrock Converse adapter.\n\n## Remarks\n\nTwo Converse-specific classifications earn their own exceptions because both are ACTIONABLE and\nboth arrive as a generic validation error otherwise:\n[E\\_CONVERSE\\_MISSING\\_TOOL\\_CONFIG](variables/E_CONVERSE_MISSING_TOOL_CONFIG.md) and [E\\_CONVERSE\\_ALTERNATION\\_VIOLATION](variables/E_CONVERSE_ALTERNATION_VIOLATION.md).\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |\n| [E\\_BEDROCK\\_CONVERSE\\_CONTEXT\\_OVERFLOW](variables/E_BEDROCK_CONVERSE_CONTEXT_OVERFLOW.md) | Context token weight exceeded the configured window. |\n| [E\\_CONVERSE\\_ALTERNATION\\_VIOLATION](variables/E_CONVERSE_ALTERNATION_VIOLATION.md) | Converse rejected the request for non-alternating roles. |\n| [E\\_CONVERSE\\_INVALID\\_TOOL\\_INPUT](variables/E_CONVERSE_INVALID_TOOL_INPUT.md) | A `toolUse` block carried an `input` value that is not a plain object. |\n| [E\\_CONVERSE\\_MISSING\\_TOOL\\_CONFIG](variables/E_CONVERSE_MISSING_TOOL_CONFIG.md) | Converse rejected the request because `toolUse`/`toolResult` blocks appeared with no `toolConfig`. |\n| [E\\_CONVERSE\\_REQUEST\\_FAILED](variables/E_CONVERSE_REQUEST_FAILED.md) | The provider returned a non-2xx status. |\n| [E\\_CONVERSE\\_STREAM\\_ERROR](variables/E_CONVERSE_STREAM_ERROR.md) | A transport error or malformed frame killed the stream. |\n| [E\\_INVALID\\_BEDROCK\\_CONVERSE\\_OPTIONS](variables/E_INVALID_BEDROCK_CONVERSE_OPTIONS.md) | Resolved options failed validation. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_BEDROCK_CONVERSE_CONTEXT_OVERFLOW","title":"Variable: E\\_BEDROCK\\_CONVERSE\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_BEDROCK_CONVERSE_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_BEDROCK_CONVERSE_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_BEDROCK_CONVERSE_CONTEXT_OVERFLOW.md\ndescription: Context token weight exceeded the configured window.\n---\n\n# Variable: E\\_BEDROCK\\_CONVERSE\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_BEDROCK_CONVERSE_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string]\n>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/exceptions.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/exceptions.ts#L24)\n\nContext token weight exceeded the configured window.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_ALTERNATION_VIOLATION","title":"Variable: E\\_CONVERSE\\_ALTERNATION\\_VIOLATION","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_ALTERNATION_VIOLATION.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_ALTERNATION_VIOLATION","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_ALTERNATION_VIOLATION.md\ndescription: Converse rejected the request for non-alternating roles.\n---\n\n# Variable: E\\_CONVERSE\\_ALTERNATION\\_VIOLATION\n\n```ts\nconst E_CONVERSE_ALTERNATION_VIOLATION: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/exceptions.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/exceptions.ts#L66)\n\nConverse rejected the request for non-alternating roles.\n\n## Remarks\n\nOnly reachable under `alternationPolicy: 'reject'`, which exists precisely so this error can be\nOBSERVED rather than silently repaired — a repair applied before dispatch is invisible in the\nresponse, which makes a client-side fix indistinguishable from vendor tolerance.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_INVALID_TOOL_INPUT","title":"Variable: E\\_CONVERSE\\_INVALID\\_TOOL\\_INPUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_INVALID_TOOL_INPUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_INVALID_TOOL_INPUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_INVALID_TOOL_INPUT.md\ndescription: A `toolUse` block carried an `input` value that is not a plain object.\n---\n\n# Variable: E\\_CONVERSE\\_INVALID\\_TOOL\\_INPUT\n\n```ts\nconst E_CONVERSE_INVALID_TOOL_INPUT: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/exceptions.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/exceptions.ts#L84)\n\nA `toolUse` block carried an `input` value that is not a plain object.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_MISSING_TOOL_CONFIG","title":"Variable: E\\_CONVERSE\\_MISSING\\_TOOL\\_CONFIG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_MISSING_TOOL_CONFIG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_MISSING_TOOL_CONFIG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_MISSING_TOOL_CONFIG.md\ndescription: >-\n Converse rejected the request because `toolUse`/`toolResult` blocks appeared\n with no `toolConfig`.\n---\n\n# Variable: E\\_CONVERSE\\_MISSING\\_TOOL\\_CONFIG\n\n```ts\nconst E_CONVERSE_MISSING_TOOL_CONFIG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/exceptions.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/exceptions.ts#L50)\n\nConverse rejected the request because `toolUse`/`toolResult` blocks appeared with no `toolConfig`.\n\n## Remarks\n\nClassified separately because the fix is specific and non-obvious: `toolConfig` must be present\nwhenever the TRANSCRIPT contains a tool block, even when no tools are offered for this turn and\nthe calls are pure history. The battery declares it automatically; this fires when a custom\n`buildConverseRequest` omits it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_REQUEST_FAILED","title":"Variable: E\\_CONVERSE\\_REQUEST\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_REQUEST_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_REQUEST_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_REQUEST_FAILED.md\ndescription: The provider returned a non-2xx status.\n---\n\n# Variable: E\\_CONVERSE\\_REQUEST\\_FAILED\n\n```ts\nconst E_CONVERSE_REQUEST_FAILED: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/exceptions.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/exceptions.ts#L33)\n\nThe provider returned a non-2xx status.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_STREAM_ERROR","title":"Variable: E\\_CONVERSE\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_CONVERSE_STREAM_ERROR.md\ndescription: A transport error or malformed frame killed the stream.\n---\n\n# Variable: E\\_CONVERSE\\_STREAM\\_ERROR\n\n```ts\nconst E_CONVERSE_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/exceptions.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/exceptions.ts#L75)\n\nA transport error or malformed frame killed the stream.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_INVALID_BEDROCK_CONVERSE_OPTIONS","title":"Variable: E\\_INVALID\\_BEDROCK\\_CONVERSE\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_INVALID_BEDROCK_CONVERSE_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_INVALID_BEDROCK_CONVERSE_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/exceptions/variables/E_INVALID_BEDROCK_CONVERSE_OPTIONS.md\ndescription: Resolved options failed validation.\n---\n\n# Variable: E\\_INVALID\\_BEDROCK\\_CONVERSE\\_OPTIONS\n\n```ts\nconst E_INVALID_BEDROCK_CONVERSE_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/exceptions.ts:15](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/exceptions.ts#L15)\n\nResolved options failed validation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers","title":"@nhtio/adk/batteries/llm/bedrock\\_converse/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers.md'\ndescription: Translation helpers for the native Bedrock Converse battery.\n---\n\n# @nhtio/adk/batteries/llm/bedrock\\_converse/helpers\n\nTranslation helpers for the native Bedrock Converse battery.\n\n## Remarks\n\nEvery function is injectable via BedrockConverseAdapterOptions.helpers and has a\n`default*` alias. Wire-agnostic renderers are re-exported unchanged from `../chat_common/helpers`;\nonly genuinely Converse-shaped logic lives here.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |\n| [DEFAULT\\_CONVERSE\\_BUCKET\\_ORDER](variables/DEFAULT_CONVERSE_BUCKET_ORDER.md) | Default context-bucket order for the system blocks; matches the other chat batteries. |\n| [defaultBuildConverseRequest](variables/defaultBuildConverseRequest.md) | Default implementation; alias of [buildConverseRequest](functions/buildConverseRequest.md). |\n| [defaultEnforceConverseAlternation](variables/defaultEnforceConverseAlternation.md) | Default implementation; alias of [enforceConverseAlternation](functions/enforceConverseAlternation.md). |\n| [defaultExtractConverseGeneration](variables/defaultExtractConverseGeneration.md) | Default implementation; alias of [extractConverseGeneration](functions/extractConverseGeneration.md). |\n| [defaultMediaToConverseImage](variables/defaultMediaToConverseImage.md) | Default implementation; alias of [mediaToConverseImage](functions/mediaToConverseImage.md). |\n| [defaultRenderConverseToolResult](variables/defaultRenderConverseToolResult.md) | Default implementation; alias of [renderConverseToolResult](functions/renderConverseToolResult.md). |\n| [defaultSanitizeConverseSchema](variables/defaultSanitizeConverseSchema.md) | Default implementation; alias of [sanitizeConverseSchema](functions/sanitizeConverseSchema.md). |\n| [defaultSanitizeToolUseId](variables/defaultSanitizeToolUseId.md) | Default implementation; alias of [sanitizeToolUseId](functions/sanitizeToolUseId.md). |\n| [defaultToolsToConverseTools](variables/defaultToolsToConverseTools.md) | Default implementation; alias of [toolsToConverseTools](functions/toolsToConverseTools.md). |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| [buildConverseRequest](functions/buildConverseRequest.md) | Assemble the native Converse request from ADK turn state. THE ordering seam. |\n| [enforceConverseAlternation](functions/enforceConverseAlternation.md) | Apply Converse's strict `user` ↔ `assistant` alternation to an already-ordered turn list. |\n| [extractConverseGeneration](functions/extractConverseGeneration.md) | Extract text, reasoning, and tool uses from a Converse response. |\n| [mediaToConverseImage](functions/mediaToConverseImage.md) | Decode an ADK Media into a Converse image block. |\n| [renderConverseToolResult](functions/renderConverseToolResult.md) | Render one tool result into `toolResult.content[]`. |\n| [sanitizeConverseSchema](functions/sanitizeConverseSchema.md) | Recursively strip schema keywords Converse rejects. |\n| [sanitizeToolUseId](functions/sanitizeToolUseId.md) | Converse rejects a `toolUseId` outside `[A-Za-z0-9_-]{1,64}`. |\n| [toolsToConverseTools](functions/toolsToConverseTools.md) | ADK tools → native `toolConfig.tools`. |\n\n## References\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/buildConverseRequest","title":"Function: buildConverseRequest()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/buildConverseRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/buildConverseRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/buildConverseRequest.md\n---\n\n# Function: buildConverseRequest()\n\n```ts\nfunction buildConverseRequest(\n input: ConverseRequestBuildInput,\n): Promise;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:305](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L305)\n\nAssemble the native Converse request from ADK turn state. THE ordering seam.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ---------------------------------------------------------------------------------- |\n| `input` | [`ConverseRequestBuildInput`](../../types/interfaces/ConverseRequestBuildInput.md) |\n\n## Returns\n\n`Promise`<[`ConverseRequest`](../../types/interfaces/ConverseRequest.md)>\n\n## Remarks\n\nThe translation that makes this battery different from pointing `openai_chat_completions` at a\nConverse-backed gateway:\n\n* System text becomes a top-level `system[]`, never a turn.\n* A `ToolCall` becomes an `assistant` turn with a `{toolUse}` block, then a **`user`** turn with\n a `{toolResult}` block — Converse has no `tool` role.\n* Blocks accumulate on the CURRENT turn where possible, so prose and a tool call emitted in the\n same assistant turn stay in one turn (the shape Converse is designed around).\n* Alternation is applied last, under [ConverseRequestBuildInput.alternationPolicy](../../types/interfaces/ConverseRequestBuildInput.md#property-alternationpolicy).\n* Timeline order is `createdAt`, matching the ordering guard's view, so what the guard validated\n is what gets dispatched.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/enforceConverseAlternation","title":"Function: enforceConverseAlternation()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/enforceConverseAlternation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/enforceConverseAlternation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/enforceConverseAlternation.md\n---\n\n# Function: enforceConverseAlternation()\n\n```ts\nfunction enforceConverseAlternation(\n messages: ConverseMessage[],\n policy?: \"merge\" | \"filler\" | \"reject\",\n): ConverseMessage[];\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:254](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L254)\n\nApply Converse's strict `user` ↔ `assistant` alternation to an already-ordered turn list.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| ---------- | ---------------------------------------------------------------- | ------------- |\n| `messages` | [`ConverseMessage`](../../types/interfaces/ConverseMessage.md)\\[] | `undefined` |\n| `policy` | `\"merge\"` | `\"filler\"` | `\"reject\"` | `'merge'` |\n\n## Returns\n\n[`ConverseMessage`](../../types/interfaces/ConverseMessage.md)\\[]\n\n## Remarks\n\nExported and separately testable because it is the single most consequential transformation in\nthis battery, and the one a gateway would otherwise perform invisibly.\n\n* `'merge'` concatenates consecutive same-role turns' content blocks. Lossless: the same blocks\n in the same order, in one turn — exactly what Converse would have accepted had the caller\n written it that way.\n* `'filler'` inserts a placeholder opposite-role turn. LOSSIER — it fabricates model output that\n never existed — and offered only for callers who need positional stability across turns.\n* `'reject'` returns the list untouched so Converse's own error surfaces. Use this when\n AUDITING: a repair applied before dispatch is invisible in the response, which makes a\n gateway's fix indistinguishable from a vendor's tolerance.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/extractConverseGeneration","title":"Function: extractConverseGeneration()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/extractConverseGeneration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/extractConverseGeneration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/extractConverseGeneration.md\n---\n\n# Function: extractConverseGeneration()\n\n```ts\nfunction extractConverseGeneration(\n response: ConverseResponseLike | undefined,\n): {\n reasoning: string;\n stopReason: string | undefined;\n text: string;\n toolUses: {\n input: Record;\n name: string;\n toolUseId: string;\n }[];\n};\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:469](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L469)\n\nExtract text, reasoning, and tool uses from a Converse response.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------------- |\n| `response` | `ConverseResponseLike` | `undefined` |\n\n## Returns\n\n```ts\n{\n reasoning: string;\n stopReason: string | undefined;\n text: string;\n toolUses: {\n input: Record;\n name: string;\n toolUseId: string;\n }\n [];\n}\n```\n\n| Name | Type | Defined in |\n| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `reasoning` | `string` | [src/batteries/llm/bedrock\\_converse/helpers.ts:473](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L473) |\n| `stopReason` | `string` | `undefined` | [src/batteries/llm/bedrock\\_converse/helpers.ts:475](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L475) |\n| `text` | `string` | [src/batteries/llm/bedrock\\_converse/helpers.ts:472](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L472) |\n| `toolUses` | { `input`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `name`: `string`; `toolUseId`: `string`; }\\[] | [src/batteries/llm/bedrock\\_converse/helpers.ts:474](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L474) |\n\n## Remarks\n\n`reasoningContent` blocks are NOT concatenated into visible text — doing so leaks the model's\nscratchpad into the answer.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/mediaToConverseImage","title":"Function: mediaToConverseImage()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/mediaToConverseImage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/mediaToConverseImage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/mediaToConverseImage.md\n---\n\n# Function: mediaToConverseImage()\n\n```ts\nfunction mediaToConverseImage(media: Media): Promise;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L216)\n\nDecode an ADK Media into a Converse image block.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------- |\n| `media` | [`Media`](../../../../../common/classes/Media.md) |\n\n## Returns\n\n`Promise`<[`ConverseImageBlock`](../../types/interfaces/ConverseImageBlock.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/renderConverseToolResult","title":"Function: renderConverseToolResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/renderConverseToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/renderConverseToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/renderConverseToolResult.md\n---\n\n# Function: renderConverseToolResult()\n\n```ts\nfunction renderConverseToolResult(input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy | undefined;\n warn?: (message: string) => void;\n}): Promise<\n {\n json?: Record;\n text?: string;\n }[]\n>;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L187)\n\nRender one tool result into `toolResult.content[]`.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined`; `warn?`: (`message`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined` |\n| `input.warn?` | (`message`: `string`) => `void` |\n\n## Returns\n\n`Promise`<{\n`json?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>;\n`text?`: `string`;\n}\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeConverseSchema","title":"Function: sanitizeConverseSchema()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeConverseSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeConverseSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeConverseSchema.md\n---\n\n# Function: sanitizeConverseSchema()\n\n```ts\nfunction sanitizeConverseSchema(schema: unknown): JsonSchema;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L127)\n\nRecursively strip schema keywords Converse rejects.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `schema` | `unknown` |\n\n## Returns\n\n[`JsonSchema`](../../../../interfaces/JsonSchema.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeToolUseId","title":"Function: sanitizeToolUseId()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeToolUseId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeToolUseId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeToolUseId.md\n---\n\n# Function: sanitizeToolUseId()\n\n```ts\nfunction sanitizeToolUseId(id: string): string;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L148)\n\nConverse rejects a `toolUseId` outside `[A-Za-z0-9_-]{1,64}`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `id` | `string` |\n\n## Returns\n\n`string`\n\n## Remarks\n\nADK ids are UUIDv6, which is already in-charset, but a caller-supplied id may not be — and the\nrejection names neither the field nor the offending character.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/toolsToConverseTools","title":"Function: toolsToConverseTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/toolsToConverseTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/toolsToConverseTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/toolsToConverseTools.md\n---\n\n# Function: toolsToConverseTools()\n\n```ts\nfunction toolsToConverseTools(\n tools: Iterable | ArtifactTool>,\n): ConverseToolSpec[];\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L157)\n\nADK tools → native `toolConfig.tools`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | `Iterable`< | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md)> |\n\n## Returns\n\n[`ConverseToolSpec`](../../types/interfaces/ConverseToolSpec.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/DEFAULT_CONVERSE_BUCKET_ORDER","title":"Variable: DEFAULT\\_CONVERSE\\_BUCKET\\_ORDER","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/DEFAULT_CONVERSE_BUCKET_ORDER.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/DEFAULT_CONVERSE_BUCKET_ORDER","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/DEFAULT_CONVERSE_BUCKET_ORDER.md\ndescription: >-\n Default context-bucket order for the system blocks; matches the other chat\n batteries.\n---\n\n# Variable: DEFAULT\\_CONVERSE\\_BUCKET\\_ORDER\n\n```ts\nconst DEFAULT_CONVERSE_BUCKET_ORDER: readonly [\n \"standingInstructions\",\n \"memories\",\n \"retrievables\",\n \"timeline\",\n];\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L88)\n\nDefault context-bucket order for the system blocks; matches the other chat batteries.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultBuildConverseRequest","title":"Variable: defaultBuildConverseRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultBuildConverseRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultBuildConverseRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultBuildConverseRequest.md\ndescription: 'Default implementation; alias of [`buildConverseRequest`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/buildConverseRequest).'\n---\n\n# Variable: defaultBuildConverseRequest\n\n```ts\nconst defaultBuildConverseRequest: (\n input: ConverseRequestBuildInput,\n) => Promise = buildConverseRequest;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:460](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L460)\n\nDefault implementation; alias of [buildConverseRequest](../functions/buildConverseRequest.md).\n\nAssemble the native Converse request from ADK turn state. THE ordering seam.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ---------------------------------------------------------------------------------- |\n| `input` | [`ConverseRequestBuildInput`](../../types/interfaces/ConverseRequestBuildInput.md) |\n\n## Returns\n\n`Promise`<[`ConverseRequest`](../../types/interfaces/ConverseRequest.md)>\n\n## Remarks\n\nThe translation that makes this battery different from pointing `openai_chat_completions` at a\nConverse-backed gateway:\n\n* System text becomes a top-level `system[]`, never a turn.\n* A `ToolCall` becomes an `assistant` turn with a `{toolUse}` block, then a **`user`** turn with\n a `{toolResult}` block — Converse has no `tool` role.\n* Blocks accumulate on the CURRENT turn where possible, so prose and a tool call emitted in the\n same assistant turn stay in one turn (the shape Converse is designed around).\n* Alternation is applied last, under [ConverseRequestBuildInput.alternationPolicy](../../types/interfaces/ConverseRequestBuildInput.md#property-alternationpolicy).\n* Timeline order is `createdAt`, matching the ordering guard's view, so what the guard validated\n is what gets dispatched.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultEnforceConverseAlternation","title":"Variable: defaultEnforceConverseAlternation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultEnforceConverseAlternation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultEnforceConverseAlternation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultEnforceConverseAlternation.md\ndescription: 'Default implementation; alias of [`enforceConverseAlternation`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/enforceConverseAlternation).'\n---\n\n# Variable: defaultEnforceConverseAlternation\n\n```ts\nconst defaultEnforceConverseAlternation: (\n messages: ConverseMessage[],\n policy: \"merge\" | \"filler\" | \"reject\",\n) => ConverseMessage[] = enforceConverseAlternation;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:287](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L287)\n\nDefault implementation; alias of [enforceConverseAlternation](../functions/enforceConverseAlternation.md).\n\nApply Converse's strict `user` ↔ `assistant` alternation to an already-ordered turn list.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| ---------- | ---------------------------------------------------------------- | ------------- |\n| `messages` | [`ConverseMessage`](../../types/interfaces/ConverseMessage.md)\\[] | `undefined` |\n| `policy` | `\"merge\"` | `\"filler\"` | `\"reject\"` | `'merge'` |\n\n## Returns\n\n[`ConverseMessage`](../../types/interfaces/ConverseMessage.md)\\[]\n\n## Remarks\n\nExported and separately testable because it is the single most consequential transformation in\nthis battery, and the one a gateway would otherwise perform invisibly.\n\n* `'merge'` concatenates consecutive same-role turns' content blocks. Lossless: the same blocks\n in the same order, in one turn — exactly what Converse would have accepted had the caller\n written it that way.\n* `'filler'` inserts a placeholder opposite-role turn. LOSSIER — it fabricates model output that\n never existed — and offered only for callers who need positional stability across turns.\n* `'reject'` returns the list untouched so Converse's own error surfaces. Use this when\n AUDITING: a repair applied before dispatch is invisible in the response, which makes a\n gateway's fix indistinguishable from a vendor's tolerance.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultExtractConverseGeneration","title":"Variable: defaultExtractConverseGeneration","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultExtractConverseGeneration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultExtractConverseGeneration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultExtractConverseGeneration.md\ndescription: 'Default implementation; alias of [`extractConverseGeneration`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/extractConverseGeneration).'\n---\n\n# Variable: defaultExtractConverseGeneration\n\n```ts\nconst defaultExtractConverseGeneration: (\n response: ConverseResponseLike | undefined,\n) => {\n reasoning: string;\n stopReason: string | undefined;\n text: string;\n toolUses: {\n input: Record;\n name: string;\n toolUseId: string;\n }[];\n} = extractConverseGeneration;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:506](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L506)\n\nDefault implementation; alias of [extractConverseGeneration](../functions/extractConverseGeneration.md).\n\nExtract text, reasoning, and tool uses from a Converse response.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------------- |\n| `response` | `ConverseResponseLike` | `undefined` |\n\n## Returns\n\n```ts\n{\n reasoning: string;\n stopReason: string | undefined;\n text: string;\n toolUses: {\n input: Record;\n name: string;\n toolUseId: string;\n }\n [];\n}\n```\n\n| Name | Type | Defined in |\n| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `reasoning` | `string` | [src/batteries/llm/bedrock\\_converse/helpers.ts:473](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L473) |\n| `stopReason` | `string` | `undefined` | [src/batteries/llm/bedrock\\_converse/helpers.ts:475](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L475) |\n| `text` | `string` | [src/batteries/llm/bedrock\\_converse/helpers.ts:472](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L472) |\n| `toolUses` | { `input`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `name`: `string`; `toolUseId`: `string`; }\\[] | [src/batteries/llm/bedrock\\_converse/helpers.ts:474](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L474) |\n\n## Remarks\n\n`reasoningContent` blocks are NOT concatenated into visible text — doing so leaks the model's\nscratchpad into the answer.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultMediaToConverseImage","title":"Variable: defaultMediaToConverseImage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultMediaToConverseImage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultMediaToConverseImage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultMediaToConverseImage.md\ndescription: 'Default implementation; alias of [`mediaToConverseImage`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/mediaToConverseImage).'\n---\n\n# Variable: defaultMediaToConverseImage\n\n```ts\nconst defaultMediaToConverseImage: (\n media: Media,\n) => Promise = mediaToConverseImage;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:236](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L236)\n\nDefault implementation; alias of [mediaToConverseImage](../functions/mediaToConverseImage.md).\n\nDecode an ADK Media into a Converse image block.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------- |\n| `media` | [`Media`](../../../../../common/classes/Media.md) |\n\n## Returns\n\n`Promise`<[`ConverseImageBlock`](../../types/interfaces/ConverseImageBlock.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultRenderConverseToolResult","title":"Variable: defaultRenderConverseToolResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultRenderConverseToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultRenderConverseToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultRenderConverseToolResult.md\ndescription: 'Default implementation; alias of [`renderConverseToolResult`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/renderConverseToolResult).'\n---\n\n# Variable: defaultRenderConverseToolResult\n\n```ts\nconst defaultRenderConverseToolResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy | undefined;\n warn?: (message: string) => void;\n}) => Promise<\n {\n json?: Record;\n text?: string;\n }[]\n> = renderConverseToolResult;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L213)\n\nDefault implementation; alias of [renderConverseToolResult](../functions/renderConverseToolResult.md).\n\nRender one tool result into `toolResult.content[]`.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined`; `warn?`: (`message`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined` |\n| `input.warn?` | (`message`: `string`) => `void` |\n\n## Returns\n\n`Promise`<{\n`json?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>;\n`text?`: `string`;\n}\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeConverseSchema","title":"Variable: defaultSanitizeConverseSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeConverseSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeConverseSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeConverseSchema.md\ndescription: 'Default implementation; alias of [`sanitizeConverseSchema`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeConverseSchema).'\n---\n\n# Variable: defaultSanitizeConverseSchema\n\n```ts\nconst defaultSanitizeConverseSchema: (schema: unknown) => JsonSchema =\n sanitizeConverseSchema;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L139)\n\nDefault implementation; alias of [sanitizeConverseSchema](../functions/sanitizeConverseSchema.md).\n\nRecursively strip schema keywords Converse rejects.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `schema` | `unknown` |\n\n## Returns\n\n[`JsonSchema`](../../../../interfaces/JsonSchema.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeToolUseId","title":"Variable: defaultSanitizeToolUseId","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeToolUseId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeToolUseId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultSanitizeToolUseId.md\ndescription: 'Default implementation; alias of [`sanitizeToolUseId`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/sanitizeToolUseId).'\n---\n\n# Variable: defaultSanitizeToolUseId\n\n```ts\nconst defaultSanitizeToolUseId: (id: string) => string = sanitizeToolUseId;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L154)\n\nDefault implementation; alias of [sanitizeToolUseId](../functions/sanitizeToolUseId.md).\n\nConverse rejects a `toolUseId` outside `[A-Za-z0-9_-]{1,64}`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `id` | `string` |\n\n## Returns\n\n`string`\n\n## Remarks\n\nADK ids are UUIDv6, which is already in-charset, but a caller-supplied id may not be — and the\nrejection names neither the field nor the offending character.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultToolsToConverseTools","title":"Variable: defaultToolsToConverseTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultToolsToConverseTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultToolsToConverseTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/variables/defaultToolsToConverseTools.md\ndescription: 'Default implementation; alias of [`toolsToConverseTools`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/helpers/functions/toolsToConverseTools).'\n---\n\n# Variable: defaultToolsToConverseTools\n\n```ts\nconst defaultToolsToConverseTools: (\n tools: Iterable | ArtifactTool>,\n) => ConverseToolSpec[] = toolsToConverseTools;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/helpers.ts:184](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/helpers.ts#L184)\n\nDefault implementation; alias of [toolsToConverseTools](../functions/toolsToConverseTools.md).\n\nADK tools → native `toolConfig.tools`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | `Iterable`< | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md)> |\n\n## Returns\n\n[`ConverseToolSpec`](../../types/interfaces/ConverseToolSpec.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types","title":"@nhtio/adk/batteries/llm/bedrock\\_converse/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types.md'\ndescription: >-\n Wire shapes, helper contracts, and option types for the native Bedrock\n Converse battery.\n---\n\n# @nhtio/adk/batteries/llm/bedrock\\_converse/types\n\nWire shapes, helper contracts, and option types for the native Bedrock Converse battery.\n\n## Remarks\n\nAWS Bedrock's Converse API is a content-BLOCK protocol, which is what separates it from Chat\nCompletions in ways a gateway has to paper over:\n\n* A turn's payload is `content[]` — an array of typed blocks (`{text}`, `{image}`, `{toolUse}`,\n `{toolResult}`) — so ONE assistant turn can carry prose and a tool call together. In the\n OpenAI shape those are separate fields on separate messages.\n* A tool result is a **`user`** turn carrying a `{toolResult}` block, not a `tool`-role message.\n* System text is a top-level `system[]` array, not a message in the conversation.\n* Converse requires **strict `user` ↔ `assistant` alternation** and rejects consecutive\n same-role turns outright. This is the constraint most gateways silently repair by merging.\n* `toolConfig` MUST be present whenever any `toolUse` / `toolResult` block appears — omitting it\n is a hard rejection (\"The toolConfig field must be defined when using toolUse and toolResult\n content blocks.\"), even when the history is only replaying past calls.\n* Tool input schemas go under `inputSchema.json` and must survive Converse's schema dialect,\n which rejects several JSON-Schema keywords.\n\nAuth is Bearer-token (`Authorization: Bearer `) against\n`bedrock-runtime..amazonaws.com`, so no SigV4 signer or AWS SDK dependency is required —\ndeliberately, since this battery must stay cross-environment and dependency-light.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| [BedrockConverseAdapterOptions](interfaces/BedrockConverseAdapterOptions.md) | Constructor and per-dispatch options. |\n| [BedrockConverseHelpers](interfaces/BedrockConverseHelpers.md) | The injectable translation seam. Every function has a `default*` implementation. |\n| [ConverseContentBlock](interfaces/ConverseContentBlock.md) | One typed content block. Exactly one field is set per block. |\n| [ConverseImageBlock](interfaces/ConverseImageBlock.md) | An image block. `bytes` is base64 on the wire despite the SDK's Uint8Array typing. |\n| [ConverseInferenceConfig](interfaces/ConverseInferenceConfig.md) | Sampling and output controls. |\n| [ConverseMessage](interfaces/ConverseMessage.md) | One conversation turn. |\n| [ConverseRequest](interfaces/ConverseRequest.md) | The complete Converse request body. |\n| [ConverseRequestBuildInput](interfaces/ConverseRequestBuildInput.md) | Everything `buildConverseRequest` needs. |\n| [ConverseResponse](interfaces/ConverseResponse.md) | The Converse response body. |\n| [ConverseSystemBlock](interfaces/ConverseSystemBlock.md) | A system-text block. Top-level, never part of `messages[]`. |\n| [ConverseToolConfig](interfaces/ConverseToolConfig.md) | Tool configuration. |\n| [ConverseToolResult](interfaces/ConverseToolResult.md) | A tool result, carried on a **user** turn. |\n| [ConverseToolSpec](interfaces/ConverseToolSpec.md) | A tool declaration. |\n| [ConverseToolUse](interfaces/ConverseToolUse.md) | A model-emitted tool invocation. |\n| [ConverseUsage](interfaces/ConverseUsage.md) | Token accounting. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------- | ------------------------------------------------------------------------------------ |\n| [ConverseRole](type-aliases/ConverseRole.md) | Conversation role. Converse has no `system` or `tool` role — see the module remarks. |\n| [ConverseToolChoice](type-aliases/ConverseToolChoice.md) | Forces, permits, or forbids tool use. |\n\n## References\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../../interfaces/MemoryAttrs.md)\n\n***\n\n### PromptAssembledObserverFn\n\nRe-exports [PromptAssembledObserverFn](../../../type-aliases/PromptAssembledObserverFn.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../../../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../../interfaces/UntrustedContentAttrs.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseAdapterOptions","title":"Interface: BedrockConverseAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseAdapterOptions.md\ndescription: Constructor and per-dispatch options.\n---\n\n# Interface: BedrockConverseAdapterOptions\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:304](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L304)\n\nConstructor and per-dispatch options.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `additionalModelRequestFields?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Model-specific fields Converse does not expose. | [src/batteries/llm/bedrock\\_converse/types.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L326) |\n| `alternationPolicy?` | `\"merge\"` | `\"filler\"` | `\"reject\"` | See [ConverseRequestBuildInput.alternationPolicy](ConverseRequestBuildInput.md#property-alternationpolicy). Defaults to `'merge'`. **Remarks** Set `'reject'` when you need to observe what Converse itself does with non-alternating history — a repair that happens before dispatch is invisible in the response, which makes it easy to mistake a gateway's fix for a vendor's tolerance. | [src/batteries/llm/bedrock\\_converse/types.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L335) |\n| `apiKey?` | `string` | Bedrock API key (`ABSK…`), sent as `Authorization: Bearer`. | [src/batteries/llm/bedrock\\_converse/types.ts:308](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L308) |\n| `autoAck?` | `boolean` | Whether to acknowledge tool-call-free generations; defaults to true. | [src/batteries/llm/bedrock\\_converse/types.ts:347](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L347) |\n| `baseURL?` | `string` | Full override, e.g. a gateway. Defaults to `https://bedrock-runtime..amazonaws.com`. | [src/batteries/llm/bedrock\\_converse/types.ts:312](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L312) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Order of context buckets in the system blocks. | [src/batteries/llm/bedrock\\_converse/types.ts:351](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L351) |\n| `contextWindow?` | `number` | Maximum token weight allowed for the assembled context. | [src/batteries/llm/bedrock\\_converse/types.ts:345](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L345) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Injectable `fetch`, for tests or a custom transport. | [src/batteries/llm/bedrock\\_converse/types.ts:341](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L341) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | Narrow the artifact-reader tools forged from prior-turn results. | [src/batteries/llm/bedrock\\_converse/types.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L367) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`BedrockConverseHelpers`](BedrockConverseHelpers.md)> | Override any translation helper. | [src/batteries/llm/bedrock\\_converse/types.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L365) |\n| `localToolCallParser?` | | [`ToolCallParserName`](../../../transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) | Recover tool calls the provider returned as prose. | [src/batteries/llm/bedrock\\_converse/types.ts:357](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L357) |\n| `maxTokens?` | `number` | Upper bound on generated tokens. | [src/batteries/llm/bedrock\\_converse/types.ts:316](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L316) |\n| `model` | `string` | Bedrock model id, e.g. `us.amazon.nova-2-lite-v1:0`. | [src/batteries/llm/bedrock\\_converse/types.ts:306](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L306) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | Observe the assembled request immediately before dispatch. An ADK-control key. | [src/batteries/llm/bedrock\\_converse/types.ts:363](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L363) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | Observe the raw generation. Purely observational. | [src/batteries/llm/bedrock\\_converse/types.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L361) |\n| `region?` | `string` | AWS region. Ignored when [baseURL](#property-baseurl) is set. Defaults to `us-east-1`. | [src/batteries/llm/bedrock\\_converse/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L310) |\n| `retry?` | [`ChatCompletionsRetryConfig`](../../../../interfaces/ChatCompletionsRetryConfig.md) | Retry/backoff policy for transport failures. | [src/batteries/llm/bedrock\\_converse/types.ts:339](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L339) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | Spool store backing artifact-handle results. | [src/batteries/llm/bedrock\\_converse/types.ts:349](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L349) |\n| `stopSequences?` | `string`\\[] | Sequences that halt generation. | [src/batteries/llm/bedrock\\_converse/types.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L322) |\n| `stream?` | `boolean` | Use `/converse-stream` instead of `/converse`. | [src/batteries/llm/bedrock\\_converse/types.ts:314](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L314) |\n| `temperature?` | `number` | Sampling temperature. | [src/batteries/llm/bedrock\\_converse/types.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L318) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Which reasoning to replay. | [src/batteries/llm/bedrock\\_converse/types.ts:353](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L353) |\n| `timeoutMs?` | `number` | Per-request timeout; falls back to the dispatch abort signal. | [src/batteries/llm/bedrock\\_converse/types.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L337) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | Encoding used for token accounting. | [src/batteries/llm/bedrock\\_converse/types.ts:343](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L343) |\n| `toolCallIdFilter?` | [`ToolCallIdFilterFn`](../../../../type-aliases/ToolCallIdFilterFn.md) | Optional ingress hook for adapting provider tool-call ids; absent preserves the vendor id. | [src/batteries/llm/bedrock\\_converse/types.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L359) |\n| `toolChoice?` | [`ConverseToolChoice`](../type-aliases/ConverseToolChoice.md) | Force, permit, or forbid tool use. | [src/batteries/llm/bedrock\\_converse/types.ts:324](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L324) |\n| `topP?` | `number` | Nucleus-sampling threshold. | [src/batteries/llm/bedrock\\_converse/types.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L320) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | What to do with a modality Converse cannot accept. | [src/batteries/llm/bedrock\\_converse/types.ts:355](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L355) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseHelpers","title":"Interface: BedrockConverseHelpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseHelpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseHelpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseHelpers.md\ndescription: >-\n The injectable translation seam. Every function has a `default*`\n implementation.\n---\n\n# Interface: BedrockConverseHelpers\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:234](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L234)\n\nThe injectable translation seam. Every function has a `default*` implementation.\n\n## Remarks\n\n`buildConverseRequest` is the ordering seam — it is where ADK primitives become `messages[]`,\nincluding the alternation repair Converse requires. A consumer needing different behaviour\noverrides it rather than forking.\n\n## Extends\n\n* [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buildConverseRequest` | (`input`: [`ConverseRequestBuildInput`](ConverseRequestBuildInput.md)) => `Promise`<[`ConverseRequest`](ConverseRequest.md)> | Assemble the full request from turn state. The primary ordering seam. | - | [src/batteries/llm/bedrock\\_converse/types.ts:248](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L248) |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`descriptionToChatCompletionsJsonSchema`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema) | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`filterThoughts`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts) | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) tool result: metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam. When omitted the battery uses the shared defaultRenderArtifactHandleBody. A consumer overrides it to change WHICH reader the model is steered toward first — e.g. promoting the JSON content-readers (`artifact_json_get` / `artifact_json_keys`) ahead of the metadata-only `artifact_json_type` for a small model that grabs the first listed tool. The tool list itself comes from the artifact's `constructor.toolMethods`; an override typically reorders or re-annotates that list before delegating to the default renderer. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderArtifactHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody) | [src/batteries/llm/chat\\_common/types.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L571) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderChatCompletionsSystemPrompt`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt) | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderConverseToolResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined`; `warn?`: (`message`: `string`) => `void`; }) => `Promise`<{ `json?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `text?`: `string`; }\\[]> | Render one tool result into `toolResult.content[]`. | - | [src/batteries/llm/bedrock\\_converse/types.ts:238](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L238) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderFirstPartyRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables) | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderMemories`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories) | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md) whose content is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam, the retrievable-side counterpart to [renderArtifactHandleBody](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody). When omitted the battery uses the shared defaultRenderRetrievableHandleBody. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablehandlebody) | [src/batteries/llm/chat\\_common/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L588) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables) | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableSafetyDirective`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective) | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderStandingInstructions`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions) | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPrivateRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables) | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPublicRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables) | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThought`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought) | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderTrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderUntrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`toolsToChatCompletionsTools`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools) | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n| `toolsToConverseTools` | (`tools`: `Iterable`< | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md)>) => [`ConverseToolSpec`](ConverseToolSpec.md)\\[] | ADK tools → native `toolConfig.tools`. | - | [src/batteries/llm/bedrock\\_converse/types.ts:236](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L236) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseContentBlock","title":"Interface: ConverseContentBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseContentBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseContentBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseContentBlock.md\ndescription: One typed content block. Exactly one field is set per block.\n---\n\n# Interface: ConverseContentBlock\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L114)\n\nOne typed content block. Exactly one field is set per block.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `image?` | [`ConverseImageBlock`](ConverseImageBlock.md) | Inline image payload. | [src/batteries/llm/bedrock\\_converse/types.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L118) |\n| `reasoningContent?` | { `reasoningText?`: { `signature?`: `string`; `text`: `string`; }; } | Extended-reasoning block, on models that support it. | [src/batteries/llm/bedrock\\_converse/types.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L124) |\n| `reasoningContent.reasoningText?` | { `signature?`: `string`; `text`: `string`; } | - | [src/batteries/llm/bedrock\\_converse/types.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L124) |\n| `reasoningContent.reasoningText.signature?` | `string` | - | [src/batteries/llm/bedrock\\_converse/types.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L124) |\n| `reasoningContent.reasoningText.text` | `string` | - | [src/batteries/llm/bedrock\\_converse/types.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L124) |\n| `text?` | `string` | Plain text. | [src/batteries/llm/bedrock\\_converse/types.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L116) |\n| `toolResult?` | [`ConverseToolResult`](ConverseToolResult.md) | A tool result, on a `user` turn. | [src/batteries/llm/bedrock\\_converse/types.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L122) |\n| `toolUse?` | [`ConverseToolUse`](ConverseToolUse.md) | A model-emitted tool invocation. | [src/batteries/llm/bedrock\\_converse/types.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L120) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseImageBlock","title":"Interface: ConverseImageBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseImageBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseImageBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseImageBlock.md\ndescription: >-\n An image block. `bytes` is base64 on the wire despite the SDK's Uint8Array\n typing.\n---\n\n# Interface: ConverseImageBlock\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L81)\n\nAn image block. `bytes` is base64 on the wire despite the SDK's Uint8Array typing.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | ------------------------------------------ | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `format` | `\"png\"` | `\"jpeg\"` | `\"gif\"` | `\"webp\"` | Image encoding Converse accepts. | [src/batteries/llm/bedrock\\_converse/types.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L83) |\n| `source` | { `bytes`: `string`; } | Base64 payload wrapper. | [src/batteries/llm/bedrock\\_converse/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L85) |\n| `source.bytes` | `string` | - | [src/batteries/llm/bedrock\\_converse/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L85) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseInferenceConfig","title":"Interface: ConverseInferenceConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseInferenceConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseInferenceConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseInferenceConfig.md\ndescription: Sampling and output controls.\n---\n\n# Interface: ConverseInferenceConfig\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L173)\n\nSampling and output controls.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | ---------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `maxTokens?` | `number` | Upper bound on generated tokens. | [src/batteries/llm/bedrock\\_converse/types.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L175) |\n| `stopSequences?` | `string`\\[] | Sequences that halt generation. | [src/batteries/llm/bedrock\\_converse/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L181) |\n| `temperature?` | `number` | Sampling temperature. | [src/batteries/llm/bedrock\\_converse/types.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L177) |\n| `topP?` | `number` | Nucleus-sampling threshold. | [src/batteries/llm/bedrock\\_converse/types.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L179) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseMessage","title":"Interface: ConverseMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseMessage.md\ndescription: One conversation turn.\n---\n\n# Interface: ConverseMessage\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L128)\n\nOne conversation turn.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | [`ConverseContentBlock`](ConverseContentBlock.md)\\[] | Typed blocks; one turn may mix prose and a tool call. | [src/batteries/llm/bedrock\\_converse/types.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L132) |\n| `role` | [`ConverseRole`](../type-aliases/ConverseRole.md) | `'user'` or `'assistant'` — Converse has no `system` or `tool` role. | [src/batteries/llm/bedrock\\_converse/types.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L130) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequest","title":"Interface: ConverseRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequest.md\ndescription: The complete Converse request body.\n---\n\n# Interface: ConverseRequest\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L185)\n\nThe complete Converse request body.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `additionalModelRequestFields?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Model-specific fields Converse does not expose directly. | [src/batteries/llm/bedrock\\_converse/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L195) |\n| `inferenceConfig?` | [`ConverseInferenceConfig`](ConverseInferenceConfig.md) | Sampling and output controls. | [src/batteries/llm/bedrock\\_converse/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L193) |\n| `messages` | [`ConverseMessage`](ConverseMessage.md)\\[] | The conversation, in order. Roles must strictly alternate. | [src/batteries/llm/bedrock\\_converse/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L187) |\n| `system?` | [`ConverseSystemBlock`](ConverseSystemBlock.md)\\[] | Top-level; there is no system role in `messages`. | [src/batteries/llm/bedrock\\_converse/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L189) |\n| `toolConfig?` | [`ConverseToolConfig`](ConverseToolConfig.md) | REQUIRED whenever any tool block appears, including pure history replay. | [src/batteries/llm/bedrock\\_converse/types.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L191) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequestBuildInput","title":"Interface: ConverseRequestBuildInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequestBuildInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequestBuildInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseRequestBuildInput.md\ndescription: Everything `buildConverseRequest` needs.\n---\n\n# Interface: ConverseRequestBuildInput\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:252](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L252)\n\nEverything `buildConverseRequest` needs.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `alternationPolicy?` | `\"merge\"` | `\"filler\"` | `\"reject\"` | How to handle turn state that breaks Converse's strict alternation. **Remarks** `'merge'` (default) folds consecutive same-role turns into one, concatenating their content blocks — lossless, and what Converse itself would have accepted had the caller written it that way. `'reject'` sends the history untouched so Converse's own error surfaces, which is what you want when you are AUDITING whether the vendor really enforces alternation rather than relying on a repair. `'filler'` inserts a placeholder turn instead of merging; it is lossier (it puts words in the model's mouth) and is offered only because some callers need positional stability. | [src/batteries/llm/bedrock\\_converse/types.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L290) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Order of context buckets in the system blocks. | [src/batteries/llm/bedrock\\_converse/types.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L272) |\n| `decodeMedia?` | (`media`: [`Media`](../../../../../common/classes/Media.md)) => `Promise`<[`ConverseImageBlock`](ConverseImageBlock.md)> | Decode an attachment into an image block. | [src/batteries/llm/bedrock\\_converse/types.ts:294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L294) |\n| `helpers` | [`BedrockConverseHelpers`](BedrockConverseHelpers.md) | Resolved helper set. | [src/batteries/llm/bedrock\\_converse/types.ts:292](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L292) |\n| `memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | Rendered into the system blocks. | [src/batteries/llm/bedrock\\_converse/types.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L258) |\n| `messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | Conversation messages. | [src/batteries/llm/bedrock\\_converse/types.ts:262](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L262) |\n| `renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), { `json?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `text?`: `string`; }\\[]> | Pre-rendered result blocks, keyed by ToolCall instance to keep colliding ids distinct. | [src/batteries/llm/bedrock\\_converse/types.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L270) |\n| `replayCompatibility` | readonly `string`\\[] | Replay tags whose opaque payloads may be resent. | [src/batteries/llm/bedrock\\_converse/types.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L278) |\n| `retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | Rendered into the system blocks. | [src/batteries/llm/bedrock\\_converse/types.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L260) |\n| `selfIdentity` | `string` | Identity attributed to this agent's own thoughts. | [src/batteries/llm/bedrock\\_converse/types.ts:274](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L274) |\n| `standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | Rendered into the system blocks. | [src/batteries/llm/bedrock\\_converse/types.ts:256](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L256) |\n| `systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | Base system text; becomes `system[]`. | [src/batteries/llm/bedrock\\_converse/types.ts:254](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L254) |\n| `thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | Reasoning to replay. | [src/batteries/llm/bedrock\\_converse/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L264) |\n| `thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Which reasoning to replay. | [src/batteries/llm/bedrock\\_converse/types.ts:276](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L276) |\n| `toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | Tool calls to replay as toolUse/toolResult pairs. | [src/batteries/llm/bedrock\\_converse/types.ts:266](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L266) |\n| `tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | Tools offered this turn. | [src/batteries/llm/bedrock\\_converse/types.ts:268](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L268) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | What to do with a modality Converse cannot accept. | [src/batteries/llm/bedrock\\_converse/types.ts:296](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L296) |\n| `warn?` | (`message`: `string`) => `void` | Non-fatal diagnostics sink. | [src/batteries/llm/bedrock\\_converse/types.ts:298](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L298) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseResponse","title":"Interface: ConverseResponse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseResponse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseResponse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseResponse.md\ndescription: The Converse response body.\n---\n\n# Interface: ConverseResponse\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L213)\n\nThe Converse response body.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `metrics?` | { `latencyMs?`: `number`; } | Server-side latency. | [src/batteries/llm/bedrock\\_converse/types.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L221) |\n| `metrics.latencyMs?` | `number` | - | [src/batteries/llm/bedrock\\_converse/types.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L221) |\n| `output?` | { `message?`: [`ConverseMessage`](ConverseMessage.md); } | The generated turn. | [src/batteries/llm/bedrock\\_converse/types.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L215) |\n| `output.message?` | [`ConverseMessage`](ConverseMessage.md) | - | [src/batteries/llm/bedrock\\_converse/types.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L215) |\n| `stopReason?` | `string` | `end_turn`, `tool_use`, `max_tokens`, `stop_sequence`, `guardrail_intervened`, `content_filtered` | [src/batteries/llm/bedrock\\_converse/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L217) |\n| `usage?` | [`ConverseUsage`](ConverseUsage.md) | Token accounting. | [src/batteries/llm/bedrock\\_converse/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L219) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseSystemBlock","title":"Interface: ConverseSystemBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseSystemBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseSystemBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseSystemBlock.md\ndescription: 'A system-text block. Top-level, never part of `messages[]`.'\n---\n\n# Interface: ConverseSystemBlock\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:136](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L136)\n\nA system-text block. Top-level, never part of `messages[]`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | -------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `text` | `string` | System text. Top-level, never part of `messages[]`. | [src/batteries/llm/bedrock\\_converse/types.ts:138](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L138) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolConfig","title":"Interface: ConverseToolConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolConfig.md\ndescription: Tool configuration.\n---\n\n# Interface: ConverseToolConfig\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L165)\n\nTool configuration.\n\n## Remarks\n\nREQUIRED whenever any `toolUse`/`toolResult` block appears anywhere in `messages`, including\npure history replay. Omitting it is a hard rejection.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `toolChoice?` | [`ConverseToolChoice`](../type-aliases/ConverseToolChoice.md) | Force, permit, or forbid tool use. | [src/batteries/llm/bedrock\\_converse/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L169) |\n| `tools` | [`ConverseToolSpec`](ConverseToolSpec.md)\\[] | Declared tools. Must be NON-EMPTY when present; an empty array is rejected. | [src/batteries/llm/bedrock\\_converse/types.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L167) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolResult","title":"Interface: ConverseToolResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolResult.md\ndescription: 'A tool result, carried on a **user** turn.'\n---\n\n# Interface: ConverseToolResult\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L104)\n\nA tool result, carried on a **user** turn.\n\n## Remarks\n\n`toolUseId` must match the `toolUse` that requested it; an unmatched id is rejected.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | { `json?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `text?`: `string`; }\\[] | Result blocks; `text` or `json`. | [src/batteries/llm/bedrock\\_converse/types.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L108) |\n| `status?` | `\"error\"` | `\"success\"` | Whether the tool succeeded; `'error'` lets the model react to a failure. | [src/batteries/llm/bedrock\\_converse/types.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L110) |\n| `toolUseId` | `string` | Must match the `toolUse` that requested it; an unmatched id is rejected. | [src/batteries/llm/bedrock\\_converse/types.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L106) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolSpec","title":"Interface: ConverseToolSpec","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolSpec.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolSpec","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolSpec.md\ndescription: A tool declaration.\n---\n\n# Interface: ConverseToolSpec\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L142)\n\nA tool declaration.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `toolSpec` | { `description?`: `string`; `inputSchema`: { `json`: [`JsonSchema`](../../../../interfaces/JsonSchema.md); }; `name`: `string`; } | The declaration body. | [src/batteries/llm/bedrock\\_converse/types.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L144) |\n| `toolSpec.description?` | `string` | - | [src/batteries/llm/bedrock\\_converse/types.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L146) |\n| `toolSpec.inputSchema` | { `json`: [`JsonSchema`](../../../../interfaces/JsonSchema.md); } | Converse rejects several JSON-Schema keywords; see `helpers.ts`. | [src/batteries/llm/bedrock\\_converse/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L148) |\n| `toolSpec.inputSchema.json` | [`JsonSchema`](../../../../interfaces/JsonSchema.md) | - | [src/batteries/llm/bedrock\\_converse/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L148) |\n| `toolSpec.name` | `string` | - | [src/batteries/llm/bedrock\\_converse/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L145) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolUse","title":"Interface: ConverseToolUse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolUse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolUse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseToolUse.md\ndescription: A model-emitted tool invocation.\n---\n\n# Interface: ConverseToolUse\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L89)\n\nA model-emitted tool invocation.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Arguments the model chose. | [src/batteries/llm/bedrock\\_converse/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L95) |\n| `name` | `string` | Declared tool name being invoked. | [src/batteries/llm/bedrock\\_converse/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L93) |\n| `toolUseId` | `string` | Correlates with the matching `toolResult`. Converse rejects a null id. | [src/batteries/llm/bedrock\\_converse/types.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L91) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseUsage","title":"Interface: ConverseUsage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseUsage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseUsage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/ConverseUsage.md\ndescription: Token accounting.\n---\n\n# Interface: ConverseUsage\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:199](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L199)\n\nToken accounting.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------------------- | -------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cacheReadInputTokens?` | `number` | Tokens served from cache. | [src/batteries/llm/bedrock\\_converse/types.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L207) |\n| `cacheWriteInputTokens?` | `number` | Tokens written to cache. | [src/batteries/llm/bedrock\\_converse/types.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L209) |\n| `inputTokens?` | `number` | Input tokens billed. | [src/batteries/llm/bedrock\\_converse/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L201) |\n| `outputTokens?` | `number` | Generated tokens. | [src/batteries/llm/bedrock\\_converse/types.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L203) |\n| `totalTokens?` | `number` | Input + output. | [src/batteries/llm/bedrock\\_converse/types.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L205) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseRole","title":"Type Alias: ConverseRole","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseRole.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseRole","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseRole.md\ndescription: >-\n Conversation role. Converse has no `system` or `tool` role — see the module\n remarks.\n---\n\n# Type Alias: ConverseRole\n\n```ts\ntype ConverseRole = \"user\" | \"assistant\";\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L78)\n\nConversation role. Converse has no `system` or `tool` role — see the module remarks.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseToolChoice","title":"Type Alias: ConverseToolChoice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseToolChoice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseToolChoice","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/type-aliases/ConverseToolChoice.md\ndescription: 'Forces, permits, or forbids tool use.'\n---\n\n# Type Alias: ConverseToolChoice\n\n```ts\ntype ConverseToolChoice =\n | {\n auto: Record;\n }\n | {\n any: Record;\n }\n | {\n tool: {\n name: string;\n };\n };\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/types.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/types.ts#L153)\n\nForces, permits, or forbids tool use.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation","title":"@nhtio/adk/batteries/llm/bedrock\\_converse/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/validation.md'\ndescription: Runtime option validation for the native Bedrock Converse battery.\n---\n\n# @nhtio/adk/batteries/llm/bedrock\\_converse/validation\n\nRuntime option validation for the native Bedrock Converse battery.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| [bedrockConverseOptionsSchema](variables/bedrockConverseOptionsSchema.md) | Schema for [BedrockConverseAdapterOptions](../types/interfaces/BedrockConverseAdapterOptions.md). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | --------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validate and normalise adapter options. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): BedrockConverseAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/validation.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/validation.ts#L72)\n\nValidate and normalise adapter options.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `input` | `unknown` |\n\n## Returns\n\n[`BedrockConverseAdapterOptions`](../../types/interfaces/BedrockConverseAdapterOptions.md)\n\n## Throws\n\nE\\_INVALID\\_BEDROCK\\_CONVERSE\\_OPTIONS when validation fails.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/variables/bedrockConverseOptionsSchema","title":"Variable: bedrockConverseOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/variables/bedrockConverseOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/variables/bedrockConverseOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/validation/variables/bedrockConverseOptionsSchema.md\ndescription: 'Schema for [`BedrockConverseAdapterOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/bedrock_converse/types/interfaces/BedrockConverseAdapterOptions).'\n---\n\n# Variable: bedrockConverseOptionsSchema\n\n```ts\nconst bedrockConverseOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/bedrock\\_converse/validation.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/bedrock_converse/validation.ts#L28)\n\nSchema for [BedrockConverseAdapterOptions](../../types/interfaces/BedrockConverseAdapterOptions.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/chat_common/exceptions","title":"@nhtio/adk/batteries/llm/chat\\_common/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/chat_common/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/chat_common/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/chat_common/exceptions.md'\ndescription: 'Shared, wire-shape-agnostic exceptions for the on-device LLM batteries.'\n---\n\n# @nhtio/adk/batteries/llm/chat\\_common/exceptions\n\nShared, wire-shape-agnostic exceptions for the on-device LLM batteries.\n\n## Remarks\n\nINTERNAL to the bundled LLM batteries (no public subpath of its own) — re-exported from each\non-device battery's public barrel. Holds exceptions that are NOT specific to one battery's wire\nshape; today, the WebGPU out-of-memory signal that both transformers.js and LiteRT-LM can hit on the\nONNX Runtime Web / WebGPU execution provider.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |\n| [E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY](variables/E_LLM_GPU_OUT_OF_MEMORY.md) | Raised when the WebGPU execution provider exhausts the device's GPU memory budget during generation. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/chat_common/exceptions/variables/E_LLM_GPU_OUT_OF_MEMORY","title":"Variable: E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/chat_common/exceptions/variables/E_LLM_GPU_OUT_OF_MEMORY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/chat_common/exceptions/variables/E_LLM_GPU_OUT_OF_MEMORY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/chat_common/exceptions/variables/E_LLM_GPU_OUT_OF_MEMORY.md\ndescription: >-\n Raised when the WebGPU execution provider exhausts the device's GPU memory\n budget during generation.\n---\n\n# Variable: E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY\n\n```ts\nconst E_LLM_GPU_OUT_OF_MEMORY: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/exceptions.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/exceptions.ts#L33)\n\nRaised when the WebGPU execution provider exhausts the device's GPU memory budget during generation.\n\n## Remarks\n\nThe ADK stance is **surface, don't impose** — rather than silently capping the caller's context\nwindow, the on-device batteries translate ORT-web's cryptic, location-dependent GPU-exhaustion throws\n(`Failed to allocate memory for buffer mapping`, `device is lost`, `operation does not support\nunaligned accesses`, …) into THIS single typed error, so an application can `catch` it structurally\n— `if (isInstanceOf(err, 'E_LLM_GPU_OUT_OF_MEMORY')) …` — instead of string-matching runtime\ninternals, and react however it wants (warn + retry with a smaller window, `recycle()` the adapter to\nflush the WebGPU buffer freelist, switch to a smaller model, …).\n\nNon-fatal: the adapter surfaces it via `ctx.nack(...)` (not a throw), exactly like the generic stream\nerror, so the turn ends cleanly and the application can offer a retry. The matcher behind the\ntranslation is `isGpuOutOfMemoryError` in `./gpu_budget`. Printf args:\n`[providerMessage, contextWindowSummary]` — the raw provider message and a short budget/window note\nthe application can show the user verbatim.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli","title":"@nhtio/adk/batteries/llm/claude\\_code\\_cli","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli.md'\ndescription: >-\n Claude Code CLI battery — the first in the \"CLI harness\" LLM-battery family,\n wrapping the `claude` CLI binary as a `DispatchExecutorFn` destination.\n---\n\n# @nhtio/adk/batteries/llm/claude\\_code\\_cli\n\nClaude Code CLI battery — the first in the \"CLI harness\" LLM-battery family, wrapping the\n`claude` CLI binary as a `DispatchExecutorFn` destination.\n\n## Remarks\n\nA fundamentally different kind of \"model call\" than the other bundled LLM batteries: the CLI is\nitself a complete agent loop (its own tool use, its own context management, its own\nretry/backoff), not a stateless completion endpoint. Since a subprocess must be spawned anyway,\nALL Claude-Code-specific complexity — spawning the real `claude` binary, hosting an MCP bridge\nserver, translating its stream-json — lives in a dedicated wrapper process shipped as a sibling\ndist asset; the adapter only ever spawns and drives that wrapper over a small, harness-agnostic\nprotocol (`./wire`), reusable by future CLI harnesses (Codex CLI, the Pi coding agent).\n\nKey design decisions: history is ADK-owned and each dispatch is a stateless `claude --bare -p`\ninvocation (no `--resume`/`--session-id` reliance); Claude Code's own built-in tools are fully\ndisabled via `--tools \"\"`; real ADK tools are bridged into the CLI's tool loop via an injected\nMCP server, but actual execution always happens on the ADK side via `tool.executor(ctx)(args)`;\npermissions are bypassed wholesale (`--dangerously-skip-permissions`) since the bridge itself —\nnot a CLI allow-flag — is what enforces which bridged tools are callable; and context usage is\nchecked client-side when `tokenEncoding` and `contextWindow` are configured.\n\n## References\n\n### buildClaudeCodeCliPrompt\n\nRe-exports [buildClaudeCodeCliPrompt](helpers/functions/buildClaudeCodeCliPrompt.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### ClaudeCodeCliAdapter\n\nRe-exports [ClaudeCodeCliAdapter](adapter/classes/ClaudeCodeCliAdapter.md)\n\n***\n\n### ClaudeCodeCliAdapterOptions\n\nRe-exports [ClaudeCodeCliAdapterOptions](types/interfaces/ClaudeCodeCliAdapterOptions.md)\n\n***\n\n### ClaudeCodeCliExtraArg\n\nRe-exports [ClaudeCodeCliExtraArg](wire/interfaces/ClaudeCodeCliExtraArg.md)\n\n***\n\n### ClaudeCodeCliHelpers\n\nRe-exports [ClaudeCodeCliHelpers](types/interfaces/ClaudeCodeCliHelpers.md)\n\n***\n\n### claudeCodeCliOptionsSchema\n\nRe-exports [claudeCodeCliOptionsSchema](validation/variables/claudeCodeCliOptionsSchema.md)\n\n***\n\n### defaultBuildClaudeCodeCliPrompt\n\nRe-exports [defaultBuildClaudeCodeCliPrompt](helpers/variables/defaultBuildClaudeCodeCliPrompt.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderClaudeCodeCliTimelineMessage\n\nRe-exports [defaultRenderClaudeCodeCliTimelineMessage](helpers/variables/defaultRenderClaudeCodeCliTimelineMessage.md)\n\n***\n\n### defaultRenderClaudeCodeCliToolCallResult\n\nRe-exports [defaultRenderClaudeCodeCliToolCallResult](helpers/variables/defaultRenderClaudeCodeCliToolCallResult.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND](exceptions/variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED](exceptions/variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO](exceptions/variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT](exceptions/variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR](exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_ERROR.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED](exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_STALLED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED](exceptions/variables/E_CLAUDE_CODE_CLI_TURN_FAILED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY](exceptions/variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED](exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED.md)\n\n***\n\n### E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR\n\nRe-exports [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR](exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR.md)\n\n***\n\n### E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS](exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md)\n\n***\n\n### ExecaLike\n\nRe-exports [ExecaLike](types/interfaces/ExecaLike.md)\n\n***\n\n### ExecaResolver\n\nRe-exports [ExecaResolver](types/type-aliases/ExecaResolver.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderClaudeCodeCliTimelineMessage\n\nRe-exports [renderClaudeCodeCliTimelineMessage](helpers/functions/renderClaudeCodeCliTimelineMessage.md)\n\n***\n\n### renderClaudeCodeCliToolCallResult\n\nRe-exports [renderClaudeCodeCliToolCallResult](helpers/functions/renderClaudeCodeCliToolCallResult.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### resolveDefaultWrapperPath\n\nRe-exports [resolveDefaultWrapperPath](adapter/functions/resolveDefaultWrapperPath.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../functions/toolsToChatCompletionsTools.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n\n***\n\n### WrapperAuth\n\nRe-exports [WrapperAuth](wire/interfaces/WrapperAuth.md)\n\n***\n\n### WrapperBridgedTool\n\nRe-exports [WrapperBridgedTool](wire/interfaces/WrapperBridgedTool.md)\n\n***\n\n### WrapperCommand\n\nRe-exports [WrapperCommand](wire/type-aliases/WrapperCommand.md)\n\n***\n\n### WrapperErrorEvent\n\nRe-exports [WrapperErrorEvent](wire/interfaces/WrapperErrorEvent.md)\n\n***\n\n### WrapperEvent\n\nRe-exports [WrapperEvent](wire/type-aliases/WrapperEvent.md)\n\n***\n\n### WrapperInitEvent\n\nRe-exports [WrapperInitEvent](wire/interfaces/WrapperInitEvent.md)\n\n***\n\n### WrapperLogEvent\n\nRe-exports [WrapperLogEvent](wire/interfaces/WrapperLogEvent.md)\n\n***\n\n### WrapperMessageDeltaEvent\n\nRe-exports [WrapperMessageDeltaEvent](wire/interfaces/WrapperMessageDeltaEvent.md)\n\n***\n\n### WrapperReadyEvent\n\nRe-exports [WrapperReadyEvent](wire/interfaces/WrapperReadyEvent.md)\n\n***\n\n### WrapperResultEvent\n\nRe-exports [WrapperResultEvent](wire/interfaces/WrapperResultEvent.md)\n\n***\n\n### WrapperRetryEvent\n\nRe-exports [WrapperRetryEvent](wire/interfaces/WrapperRetryEvent.md)\n\n***\n\n### WrapperRunCommand\n\nRe-exports [WrapperRunCommand](wire/interfaces/WrapperRunCommand.md)\n\n***\n\n### WrapperShutdownCommand\n\nRe-exports [WrapperShutdownCommand](wire/interfaces/WrapperShutdownCommand.md)\n\n***\n\n### WrapperShutdownCompleteEvent\n\nRe-exports [WrapperShutdownCompleteEvent](wire/interfaces/WrapperShutdownCompleteEvent.md)\n\n***\n\n### WrapperThoughtDeltaEvent\n\nRe-exports [WrapperThoughtDeltaEvent](wire/interfaces/WrapperThoughtDeltaEvent.md)\n\n***\n\n### WrapperToolCallRequestEvent\n\nRe-exports [WrapperToolCallRequestEvent](wire/interfaces/WrapperToolCallRequestEvent.md)\n\n***\n\n### WrapperToolCallResponseCommand\n\nRe-exports [WrapperToolCallResponseCommand](wire/interfaces/WrapperToolCallResponseCommand.md)\n\n***\n\n### WrapperToolResultContentBlock\n\nRe-exports [WrapperToolResultContentBlock](wire/type-aliases/WrapperToolResultContentBlock.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter","title":"@nhtio/adk/batteries/llm/claude\\_code\\_cli/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter.md'\ndescription: >-\n Cross-environment executor adapter that wraps the Claude Code CLI as a\n `DispatchExecutorFn` destination.\n---\n\n# @nhtio/adk/batteries/llm/claude\\_code\\_cli/adapter\n\nCross-environment executor adapter that wraps the Claude Code CLI as a `DispatchExecutorFn`\ndestination.\n\n## Remarks\n\nThe first battery in the \"CLI harness\" family: rather than a direct wire-format provider, this\nadapter drives an external coding-agent CLI binary that is itself a complete agent loop. Since a\nsubprocess must be spawned anyway, ALL Claude-Code-specific complexity — spawning the real\n`claude` binary, hosting an MCP bridge server, translating its stream-json — lives in a\ndedicated wrapper process (`wrapper.ts`, shipped as a sibling dist asset); this adapter only\never spawns and drives that wrapper over the small, harness-agnostic protocol in `./wire`.\n\nEvery dispatch iteration is stateless and self-contained: the full accumulated history renders\ninto one `-p` prompt string (`buildClaudeCodeCliPrompt`), a fresh wrapper is spawned, and real\nADK tools are bridged into the CLI's own tool loop via MCP — but actual execution always happens\non the ADK side, through `tool.executor(ctx)(args)`, exactly like every other LLM battery.\n\n## Classes\n\n| Class | Description |\n| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |\n| [ClaudeCodeCliAdapter](classes/ClaudeCodeCliAdapter.md) | Opinionated CLI-harness LLM adapter that drives the Claude Code CLI as a `DispatchExecutorFn` destination. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [resolveDefaultWrapperPath](functions/resolveDefaultWrapperPath.md) | Resolve the built wrapper asset's on-disk path relative to this module's own compiled location. `adapter.ts` carries its own `@module` tag (per the per-file tagging convention every other multi-file battery uses), so it compiles to `dist/batteries/llm/claude_code_cli/adapter.mjs` — three directories below the package root, where the wrapper (an explicit, un-tagged `vite.config.mts` entry key) compiles to `dist/claude-code-cli-wrapper.mjs`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/classes/ClaudeCodeCliAdapter","title":"Class: ClaudeCodeCliAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/classes/ClaudeCodeCliAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/classes/ClaudeCodeCliAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/classes/ClaudeCodeCliAdapter.md\ndescription: >-\n Opinionated CLI-harness LLM adapter that drives the Claude Code CLI as a\n `DispatchExecutorFn` destination.\n---\n\n# Class: ClaudeCodeCliAdapter\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/adapter.ts:327](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/adapter.ts#L327)\n\nOpinionated CLI-harness LLM adapter that drives the Claude Code CLI as a `DispatchExecutorFn`\ndestination.\n\n## Remarks\n\nConstruction validates options eagerly via [validateOptions](../../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries/llm/claude\\_code\\_cli!E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS](../../exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md) on failure\n(including the POSIX-only platform guard and the `apiKey`/`authToken` XOR check). The returned\ninstance is reusable: call [ClaudeCodeCliAdapter.executor](#executor) once per `DispatchRunner`\nconfiguration.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew ClaudeCodeCliAdapter(options: unknown): ClaudeCodeCliAdapter;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/adapter.ts:339](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/adapter.ts#L339)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options. Re-validated on every iteration after per-dispatch and per-iteration overrides are layered in. |\n\n#### Returns\n\n`ClaudeCodeCliAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/llm/claude\\_code\\_cli!E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS](../../exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md) when\n`options` does not satisfy `claudeCodeCliOptionsSchema`.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ----------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"claudeCodeCli\"` | Customary key for per-iteration overrides on `ctx.stash`. | [src/batteries/llm/claude\\_code\\_cli/adapter.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/adapter.ts#L329) |\n\n## Methods\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/adapter.ts:347](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/adapter.ts#L347)\n\nReturns a [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to this adapter's baseline plus optional\nexecutor-scope overrides.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`ClaudeCodeCliAdapterOptions`](../../types/interfaces/ClaudeCodeCliAdapterOptions.md)> |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### isClaudeCodeCliAdapter()\n\n```ts\nstatic isClaudeCodeCliAdapter(value: unknown): value is ClaudeCodeCliAdapter;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/adapter.ts:987](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/adapter.ts#L987)\n\nReturns `true` when `value` is a ClaudeCodeCliAdapter instance.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n#### Returns\n\n`value is ClaudeCodeCliAdapter`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/functions/resolveDefaultWrapperPath","title":"Function: resolveDefaultWrapperPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/functions/resolveDefaultWrapperPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/functions/resolveDefaultWrapperPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/adapter/functions/resolveDefaultWrapperPath.md\n---\n\n# Function: resolveDefaultWrapperPath()\n\n```ts\nfunction resolveDefaultWrapperPath(): string;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/adapter.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/adapter.ts#L96)\n\nResolve the built wrapper asset's on-disk path relative to this module's own compiled location.\n`adapter.ts` carries its own `@module` tag (per the per-file tagging convention every other\nmulti-file battery uses), so it compiles to `dist/batteries/llm/claude_code_cli/adapter.mjs` —\nthree directories below the package root, where the wrapper (an explicit, un-tagged\n`vite.config.mts` entry key) compiles to `dist/claude-code-cli-wrapper.mjs`.\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions","title":"@nhtio/adk/batteries/llm/claude\\_code\\_cli/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions.md'\ndescription: Battery-scoped exception constructors for the Claude Code CLI adapter.\n---\n\n# @nhtio/adk/batteries/llm/claude\\_code\\_cli/exceptions\n\nBattery-scoped exception constructors for the Claude Code CLI adapter.\n\n## Remarks\n\nBattery-scoped exception classes minted via `createException` from `@nhtio/adk/factories`.\nMalformed NDJSON frames (either the wrapper's own inbound-command reader, or its translation of\nClaude's stream-json) are explicitly NOT a distinct exception — they are swallowed and surfaced\nvia `helpers.log.trace`, matching the Ollama battery's malformed-line policy.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND](variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND.md) | Thrown when the `claude` binary cannot be located/spawned. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW](variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW.md) | Thrown when the assembled request exceeds the configured `contextWindow` during the pre-flight context-window guard. Only raised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in the message so middleware can target shedding. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED](variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED.md) | Thrown when the wrapper's own MCP bridge server fails to start, OR Claude's `system/init` reports an `mcp_server_errors` entry naming the bridge, OR the `@modelcontextprotocol/sdk` optional peer is missing at wrapper startup. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO](variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO.md) | Thrown when the wrapper process exits with no terminal `result`/`error` event observed. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT](variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT.md) | Thrown when the wrapper does not signal `ready` and Claude's `system/init` within `startupTimeoutMs`. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR](variables/E_CLAUDE_CODE_CLI_STREAM_ERROR.md) | Thrown on a transport-level stream failure between the adapter and the wrapper. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED](variables/E_CLAUDE_CODE_CLI_STREAM_STALLED.md) | Thrown when the wrapper's stdout goes idle for longer than `streamIdleTimeoutMs`. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED](variables/E_CLAUDE_CODE_CLI_TURN_FAILED.md) | Thrown when Claude's terminal `result` reports `isError: true` for a terminal error subtype other than `error_max_turns`, notably CLI-native budget exhaustion from `--max-budget-usd`. The `error_max_turns` subtype is the normal successful completion signal for this adapter's fixed single-turn dispatch contract. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY.md) | Thrown when a [@nhtio/adk!Media](../../../../common/classes/Media.md) whose modality cannot be represented reaches either direction of this battery under the corresponding `unsupportedMediaPolicy`/ `unsupportedResultMediaPolicy: 'throw'` — bidirectional: inbound prompt media (a `-p` string has no native image channel) and outbound tool-result media (only text/image MCP content blocks are supported). |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED](variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED.md) | Thrown when the wrapper process crashes or exits abnormally mid-dispatch. |\n| [E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR](variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR.md) | Thrown when the wrapper process itself fails to spawn. |\n| [E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS](variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md) | Thrown when the resolved adapter options (constructor, executor overrides, or per-dispatch `stash.claudeCodeCli`) fail validation — including `extraArgs` security-flag rejection, the `apiKey`/`authToken` XOR violation, and the POSIX-only platform guard. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND.md\ndescription: Thrown when the `claude` binary cannot be located/spawned.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_BINARY\\_NOT\\_FOUND\n\n```ts\nconst E_CLAUDE_CODE_CLI_BINARY_NOT_FOUND: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L29)\n\nThrown when the `claude` binary cannot be located/spawned.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the assembled request exceeds the configured `contextWindow`\n during the pre-flight context-window guard. Only raised when `tokenEncoding`\n is non-null. Carries\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_CLAUDE_CODE_CLI_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L115)\n\nThrown when the assembled request exceeds the configured `contextWindow` during the pre-flight\ncontext-window guard. Only raised when `tokenEncoding` is non-null. Carries `{ total,\ncontextWindow, tokenEncoding, perBucket }` in the message so middleware can target shedding.\n\n## Remarks\n\nThis is the ADK-side token-budget guard and refuses the request before the Claude Code CLI\nwrapper is spawned. The rendered prompt and append-system prompt are measured exactly; it is\nan honest floor only because Claude Code injects additional vendor-owned content (the Agent SDK\npreamble, CWD/Date, billing header, built-in tool schemas, and MCP declaration envelope).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED.md\ndescription: >-\n Thrown when the wrapper's own MCP bridge server fails to start, OR Claude's\n `system/init` reports an `mcp_server_errors` entry naming the bridge, OR the\n `@modelcontextprotocol/sdk` optional peer is missing at wrapper startup.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_MCP\\_BRIDGE\\_STARTUP\\_FAILED\n\n```ts\nconst E_CLAUDE_CODE_CLI_MCP_BRIDGE_STARTUP_FAILED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L96)\n\nThrown when the wrapper's own MCP bridge server fails to start, OR Claude's `system/init`\nreports an `mcp_server_errors` entry naming the bridge, OR the `@modelcontextprotocol/sdk`\noptional peer is missing at wrapper startup.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO.md\ndescription: >-\n Thrown when the wrapper process exits with no terminal `result`/`error` event\n observed.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_PROCESS\\_EXITED\\_NONZERO\n\n```ts\nconst E_CLAUDE_CODE_CLI_PROCESS_EXITED_NONZERO: CreatedException<\n [number, string]\n>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L56)\n\nThrown when the wrapper process exits with no terminal `result`/`error` event observed.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT.md\ndescription: >-\n Thrown when the wrapper does not signal `ready` and Claude's `system/init`\n within `startupTimeoutMs`.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_STARTUP\\_TIMEOUT\n\n```ts\nconst E_CLAUDE_CODE_CLI_STARTUP_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L83)\n\nThrown when the wrapper does not signal `ready` and Claude's `system/init` within `startupTimeoutMs`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_ERROR","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_ERROR.md\ndescription: >-\n Thrown on a transport-level stream failure between the adapter and the\n wrapper.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_ERROR\n\n```ts\nconst E_CLAUDE_CODE_CLI_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L65)\n\nThrown on a transport-level stream failure between the adapter and the wrapper.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_STALLED","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_STALLED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_STALLED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_STREAM_STALLED.md\ndescription: >-\n Thrown when the wrapper's stdout goes idle for longer than\n `streamIdleTimeoutMs`.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_STREAM\\_STALLED\n\n```ts\nconst E_CLAUDE_CODE_CLI_STREAM_STALLED: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L74)\n\nThrown when the wrapper's stdout goes idle for longer than `streamIdleTimeoutMs`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_TURN_FAILED","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_TURN_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_TURN_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_TURN_FAILED.md\ndescription: >-\n Thrown when Claude's terminal `result` reports `isError: true` for a terminal\n error subtype other than `error_max_turns`, notably CLI-native budget\n exhaustion from `--max-budget-usd`. The `error_max_turns` subtype is the\n normal successful completion signal for this adapter's fixed single-turn\n dispatch contract.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_TURN\\_FAILED\n\n```ts\nconst E_CLAUDE_CODE_CLI_TURN_FAILED: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L129)\n\nThrown when Claude's terminal `result` reports `isError: true` for a terminal error subtype\nother than `error_max_turns`, notably CLI-native budget exhaustion from `--max-budget-usd`.\nThe `error_max_turns` subtype is the normal successful completion signal for this adapter's\nfixed single-turn dispatch contract.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Thrown when a {@link @nhtio/adk!Media} whose modality cannot be represented\n reaches either direction of this battery under the corresponding\n `unsupportedMediaPolicy`/ `unsupportedResultMediaPolicy: 'throw'` —\n bidirectional: inbound prompt media (a `-p` string has no native image\n channel) and outbound tool-result media (only text/image MCP content blocks\n are supported).\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_CLAUDE_CODE_CLI_UNSUPPORTED_MEDIA_MODALITY: CreatedException<\n [string, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L144)\n\nThrown when a [@nhtio/adk!Media](../../../../../common/classes/Media.md) whose modality cannot be represented reaches either\ndirection of this battery under the corresponding `unsupportedMediaPolicy`/\n`unsupportedResultMediaPolicy: 'throw'` — bidirectional: inbound prompt media (a `-p` string has\nno native image channel) and outbound tool-result media (only text/image MCP content blocks are\nsupported).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_CRASHED.md\ndescription: Thrown when the wrapper process crashes or exits abnormally mid-dispatch.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_CRASHED\n\n```ts\nconst E_CLAUDE_CODE_CLI_WRAPPER_CRASHED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L47)\n\nThrown when the wrapper process crashes or exits abnormally mid-dispatch.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR","title":"Variable: E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR.md\ndescription: Thrown when the wrapper process itself fails to spawn.\n---\n\n# Variable: E\\_CLAUDE\\_CODE\\_CLI\\_WRAPPER\\_SPAWN\\_ERROR\n\n```ts\nconst E_CLAUDE_CODE_CLI_WRAPPER_SPAWN_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L38)\n\nThrown when the wrapper process itself fails to spawn.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS","title":"Variable: E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/exceptions/variables/E_INVALID_CLAUDE_CODE_CLI_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options (constructor, executor overrides, or\n per-dispatch `stash.claudeCodeCli`) fail validation — including `extraArgs`\n security-flag rejection, the `apiKey`/`authToken` XOR violation, and the\n POSIX-only platform guard.\n---\n\n# Variable: E\\_INVALID\\_CLAUDE\\_CODE\\_CLI\\_OPTIONS\n\n```ts\nconst E_INVALID_CLAUDE_CODE_CLI_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/exceptions.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/exceptions.ts#L20)\n\nThrown when the resolved adapter options (constructor, executor overrides, or per-dispatch\n`stash.claudeCodeCli`) fail validation — including `extraArgs` security-flag rejection, the\n`apiKey`/`authToken` XOR violation, and the POSIX-only platform guard.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers","title":"@nhtio/adk/batteries/llm/claude\\_code\\_cli/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers.md'\ndescription: >-\n Swappable translation helpers for rendering ADK state into the Claude Code\n CLI's `-p` prompt string and MCP tool-result content.\n---\n\n# @nhtio/adk/batteries/llm/claude\\_code\\_cli/helpers\n\nSwappable translation helpers for rendering ADK state into the Claude Code CLI's `-p` prompt\nstring and MCP tool-result content.\n\n## Remarks\n\nThe wire-shape-agnostic helpers (`renderUntrustedContent`, `renderMemories`,\n`renderChatCompletionsSystemPrompt`, `toolsToChatCompletionsTools`, …) are shared with every\nother Chat-family battery via `../chat_common/helpers` and re-exported here under their\noriginal names. Only the battery-specific helpers are defined here:\n`renderClaudeCodeCliTimelineMessage` (plain text — no native image side-channel, unlike\nOllama's `images[]`), `renderClaudeCodeCliToolCallResult` (the inbound-history counterpart to\nthe outbound MCP-result rendering `adapter.ts` performs directly), and\n`buildClaudeCodeCliPrompt` (the top-level history-to-prompt assembler — a direct structural\nport of `buildOllamaHistory`'s ordering, collapsed to a single joined string).\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| [defaultBuildClaudeCodeCliPrompt](variables/defaultBuildClaudeCodeCliPrompt.md) | Default history assembler; alias of [buildClaudeCodeCliPrompt](functions/buildClaudeCodeCliPrompt.md). |\n| [defaultRenderClaudeCodeCliTimelineMessage](variables/defaultRenderClaudeCodeCliTimelineMessage.md) | Default timeline-message renderer; alias of [renderClaudeCodeCliTimelineMessage](functions/renderClaudeCodeCliTimelineMessage.md). |\n| [defaultRenderClaudeCodeCliToolCallResult](variables/defaultRenderClaudeCodeCliToolCallResult.md) | Default tool-call-result renderer; alias of [renderClaudeCodeCliToolCallResult](functions/renderClaudeCodeCliToolCallResult.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [buildClaudeCodeCliPrompt](functions/buildClaudeCodeCliPrompt.md) | Assembles the complete history for a dispatch into ONE joined prompt string — a direct structural port of `buildOllamaHistory`'s ordering (leading system-prompt block, then the timestamp-sorted timeline of messages/thoughts/tool-calls, then any trailing buckets after `'timeline'` in `bucketOrder`), with the target shape collapsed from a message array to a single string, since this wire has one `-p` positional argument. |\n| [renderClaudeCodeCliTimelineMessage](functions/renderClaudeCodeCliTimelineMessage.md) | Renders a single timeline [@nhtio/adk!Message](../../../../common/classes/Message.md) into plain text for the `-p` prompt string — structurally identical to `renderOllamaTimelineMessage`'s trust-envelope/identity logic, except every attachment routes through `unsupportedMediaPolicy` and is appended as text (the \"v1 prompt is text-only\" limitation). |\n| [renderClaudeCodeCliToolCallResult](functions/renderClaudeCodeCliToolCallResult.md) | Render a completed [@nhtio/adk!ToolCall](../../../../forge/classes/ToolCall.md)'s result to plain text for the INBOUND history direction (how a past tool call reads back into a subsequent dispatch's rendered prompt) — always a string, since the `-p` prompt has no structured-content channel. Media results are routed through the same text-only media renderer used by the timeline path. |\n\n## References\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### looksLikeSpooledArtifact\n\nRe-exports [looksLikeSpooledArtifact](../../transformers_js/helpers/functions/looksLikeSpooledArtifact.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../../functions/toolsToChatCompletionsTools.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/buildClaudeCodeCliPrompt","title":"Function: buildClaudeCodeCliPrompt()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/buildClaudeCodeCliPrompt.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/buildClaudeCodeCliPrompt","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/buildClaudeCodeCliPrompt.md\n---\n\n# Function: buildClaudeCodeCliPrompt()\n\n```ts\nfunction buildClaudeCodeCliPrompt(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderClaudeCodeCliTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderClaudeCodeCliToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderCtx?: unknown;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise<{\n prompt: string;\n reasoningPayloads: {\n id: string;\n payload: unknown;\n replayCompatibility: string;\n }[];\n}>;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/helpers.ts:447](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/helpers.ts#L447)\n\nAssembles the complete history for a dispatch into ONE joined prompt string — a direct\nstructural port of `buildOllamaHistory`'s ordering (leading system-prompt block, then the\ntimestamp-sorted timeline of messages/thoughts/tool-calls, then any trailing buckets after\n`'timeline'` in `bucketOrder`), with the target shape collapsed from a message array to a\nsingle string, since this wire has one `-p` positional argument.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderClaudeCodeCliTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderClaudeCodeCliToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderClaudeCodeCliTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | - |\n| `input.renderClaudeCodeCliToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | - |\n| `input.renderCtx?` | `unknown` | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`> | Pre-rendered results keyed by the same live ToolCall instances iterated below. |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`prompt`: `string`;\n`reasoningPayloads`: {\n`id`: `string`;\n`payload`: `unknown`;\n`replayCompatibility`: `string`;\n}\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliTimelineMessage","title":"Function: renderClaudeCodeCliTimelineMessage()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliTimelineMessage.md\n---\n\n# Function: renderClaudeCodeCliTimelineMessage()\n\n```ts\nfunction renderClaudeCodeCliTimelineMessage(input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/helpers.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/helpers.ts#L245)\n\nRenders a single timeline [@nhtio/adk!Message](../../../../../common/classes/Message.md) into plain text for the `-p` prompt\nstring — structurally identical to `renderOllamaTimelineMessage`'s trust-envelope/identity\nlogic, except every attachment routes through `unsupportedMediaPolicy` and is appended as text\n(the \"v1 prompt is text-only\" limitation).\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliToolCallResult","title":"Function: renderClaudeCodeCliToolCallResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/renderClaudeCodeCliToolCallResult.md\n---\n\n# Function: renderClaudeCodeCliToolCallResult()\n\n```ts\nfunction renderClaudeCodeCliToolCallResult(input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/helpers.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/helpers.ts#L329)\n\nRender a completed [@nhtio/adk!ToolCall](../../../../../forge/classes/ToolCall.md)'s result to plain text for the INBOUND history\ndirection (how a past tool call reads back into a subsequent dispatch's rendered prompt) —\nalways a string, since the `-p` prompt has no structured-content channel. Media results are\nrouted through the same text-only media renderer used by the timeline path.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultBuildClaudeCodeCliPrompt","title":"Variable: defaultBuildClaudeCodeCliPrompt","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultBuildClaudeCodeCliPrompt.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultBuildClaudeCodeCliPrompt","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultBuildClaudeCodeCliPrompt.md\ndescription: 'Default history assembler; alias of [`buildClaudeCodeCliPrompt`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/functions/buildClaudeCodeCliPrompt).'\n---\n\n# Variable: defaultBuildClaudeCodeCliPrompt\n\n```ts\nconst defaultBuildClaudeCodeCliPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderClaudeCodeCliTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderClaudeCodeCliToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderCtx?: unknown;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise<{\n prompt: string;\n reasoningPayloads: {\n id: string;\n payload: unknown;\n replayCompatibility: string;\n }[];\n}> = buildClaudeCodeCliPrompt;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/helpers.ts:640](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/helpers.ts#L640)\n\nDefault history assembler; alias of [buildClaudeCodeCliPrompt](../functions/buildClaudeCodeCliPrompt.md).\n\nAssembles the complete history for a dispatch into ONE joined prompt string — a direct\nstructural port of `buildOllamaHistory`'s ordering (leading system-prompt block, then the\ntimestamp-sorted timeline of messages/thoughts/tool-calls, then any trailing buckets after\n`'timeline'` in `bucketOrder`), with the target shape collapsed from a message array to a\nsingle string, since this wire has one `-p` positional argument.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderClaudeCodeCliTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderClaudeCodeCliToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderClaudeCodeCliTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | - |\n| `input.renderClaudeCodeCliToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | - |\n| `input.renderCtx?` | `unknown` | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`> | Pre-rendered results keyed by the same live ToolCall instances iterated below. |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`prompt`: `string`;\n`reasoningPayloads`: {\n`id`: `string`;\n`payload`: `unknown`;\n`replayCompatibility`: `string`;\n}\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliTimelineMessage","title":"Variable: defaultRenderClaudeCodeCliTimelineMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliTimelineMessage.md\ndescription: >-\n Default timeline-message renderer; alias of {@link\n renderClaudeCodeCliTimelineMessage}.\n---\n\n# Variable: defaultRenderClaudeCodeCliTimelineMessage\n\n```ts\nconst defaultRenderClaudeCodeCliTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderClaudeCodeCliTimelineMessage;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/helpers.ts:306](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/helpers.ts#L306)\n\nDefault timeline-message renderer; alias of [renderClaudeCodeCliTimelineMessage](../functions/renderClaudeCodeCliTimelineMessage.md).\n\nRenders a single timeline [@nhtio/adk!Message](../../../../../common/classes/Message.md) into plain text for the `-p` prompt\nstring — structurally identical to `renderOllamaTimelineMessage`'s trust-envelope/identity\nlogic, except every attachment routes through `unsupportedMediaPolicy` and is appended as text\n(the \"v1 prompt is text-only\" limitation).\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliToolCallResult","title":"Variable: defaultRenderClaudeCodeCliToolCallResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/helpers/variables/defaultRenderClaudeCodeCliToolCallResult.md\ndescription: >-\n Default tool-call-result renderer; alias of {@link\n renderClaudeCodeCliToolCallResult}.\n---\n\n# Variable: defaultRenderClaudeCodeCliToolCallResult\n\n```ts\nconst defaultRenderClaudeCodeCliToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderClaudeCodeCliToolCallResult;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/helpers.ts:431](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/helpers.ts#L431)\n\nDefault tool-call-result renderer; alias of [renderClaudeCodeCliToolCallResult](../functions/renderClaudeCodeCliToolCallResult.md).\n\nRender a completed [@nhtio/adk!ToolCall](../../../../../forge/classes/ToolCall.md)'s result to plain text for the INBOUND history\ndirection (how a past tool call reads back into a subsequent dispatch's rendered prompt) —\nalways a string, since the `-p` prompt has no structured-content channel. Media results are\nrouted through the same text-only media renderer used by the timeline path.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types","title":"@nhtio/adk/batteries/llm/claude\\_code\\_cli/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/types.md'\ndescription: >-\n TypeScript wire shapes, helper contracts, and option types for the Claude Code\n CLI battery.\n---\n\n# @nhtio/adk/batteries/llm/claude\\_code\\_cli/types\n\nTypeScript wire shapes, helper contracts, and option types for the Claude Code CLI battery.\n\n## Remarks\n\nType aliases for the `ClaudeCodeCliAdapter` — the public options shape, the\n[ClaudeCodeCliHelpers](interfaces/ClaudeCodeCliHelpers.md) contract (extends the wire-shape-agnostic [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md)\nwith the battery's own history-rendering and outbound tool-result-rendering members), and\nre-exports of the wire-shape-agnostic types consumers of this battery need. The\nadapter↔wrapper protocol itself lives in `./wire` (zero imports, shared across future CLI\nharnesses) and is re-exported here for convenience.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [ClaudeCodeCliAdapterOptions](interfaces/ClaudeCodeCliAdapterOptions.md) | Configuration options for the [@nhtio/adk/batteries/llm/claude\\_code\\_cli!ClaudeCodeCliAdapter](../adapter/classes/ClaudeCodeCliAdapter.md). |\n| [ClaudeCodeCliHelpers](interfaces/ClaudeCodeCliHelpers.md) | Full translation-helper contract for the Claude Code CLI battery. Extends the wire-shape- agnostic [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md) (shared with every other Chat-family battery) and adds the battery-specific members: a plain-text-only timeline-message renderer (a `-p` prompt string has no native image side-channel, unlike Ollama's `images[]`), a plain-text-only tool-call-result renderer for the *inbound* history direction, and the top-level history-to-prompt assembler. |\n| [ExecaLike](interfaces/ExecaLike.md) | The slice of execa this adapter uses to spawn the wrapper. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------- | ------------------------------------------------------------------------------------------------ |\n| [ExecaResolver](type-aliases/ExecaResolver.md) | Resolver forms accepted for the `execa` module — mirrors `ExecaResolver` in `execa_executor.ts`. |\n\n## References\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### ClaudeCodeCliExtraArg\n\nRe-exports [ClaudeCodeCliExtraArg](../wire/interfaces/ClaudeCodeCliExtraArg.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../../interfaces/MemoryAttrs.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../../interfaces/ThoughtAttrs.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### WrapperAuth\n\nRe-exports [WrapperAuth](../wire/interfaces/WrapperAuth.md)\n\n***\n\n### WrapperBridgedTool\n\nRe-exports [WrapperBridgedTool](../wire/interfaces/WrapperBridgedTool.md)\n\n***\n\n### WrapperCommand\n\nRe-exports [WrapperCommand](../wire/type-aliases/WrapperCommand.md)\n\n***\n\n### WrapperErrorEvent\n\nRe-exports [WrapperErrorEvent](../wire/interfaces/WrapperErrorEvent.md)\n\n***\n\n### WrapperEvent\n\nRe-exports [WrapperEvent](../wire/type-aliases/WrapperEvent.md)\n\n***\n\n### WrapperInitEvent\n\nRe-exports [WrapperInitEvent](../wire/interfaces/WrapperInitEvent.md)\n\n***\n\n### WrapperLogEvent\n\nRe-exports [WrapperLogEvent](../wire/interfaces/WrapperLogEvent.md)\n\n***\n\n### WrapperMessageDeltaEvent\n\nRe-exports [WrapperMessageDeltaEvent](../wire/interfaces/WrapperMessageDeltaEvent.md)\n\n***\n\n### WrapperReadyEvent\n\nRe-exports [WrapperReadyEvent](../wire/interfaces/WrapperReadyEvent.md)\n\n***\n\n### WrapperResultEvent\n\nRe-exports [WrapperResultEvent](../wire/interfaces/WrapperResultEvent.md)\n\n***\n\n### WrapperRetryEvent\n\nRe-exports [WrapperRetryEvent](../wire/interfaces/WrapperRetryEvent.md)\n\n***\n\n### WrapperRunCommand\n\nRe-exports [WrapperRunCommand](../wire/interfaces/WrapperRunCommand.md)\n\n***\n\n### WrapperShutdownCommand\n\nRe-exports [WrapperShutdownCommand](../wire/interfaces/WrapperShutdownCommand.md)\n\n***\n\n### WrapperShutdownCompleteEvent\n\nRe-exports [WrapperShutdownCompleteEvent](../wire/interfaces/WrapperShutdownCompleteEvent.md)\n\n***\n\n### WrapperThoughtDeltaEvent\n\nRe-exports [WrapperThoughtDeltaEvent](../wire/interfaces/WrapperThoughtDeltaEvent.md)\n\n***\n\n### WrapperToolCallRequestEvent\n\nRe-exports [WrapperToolCallRequestEvent](../wire/interfaces/WrapperToolCallRequestEvent.md)\n\n***\n\n### WrapperToolCallResponseCommand\n\nRe-exports [WrapperToolCallResponseCommand](../wire/interfaces/WrapperToolCallResponseCommand.md)\n\n***\n\n### WrapperToolResultContentBlock\n\nRe-exports [WrapperToolResultContentBlock](../wire/type-aliases/WrapperToolResultContentBlock.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliAdapterOptions","title":"Interface: ClaudeCodeCliAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliAdapterOptions.md\ndescription: >-\n Configuration options for the {@link\n @nhtio/adk/batteries/llm/claude_code_cli!ClaudeCodeCliAdapter}.\n---\n\n# Interface: ClaudeCodeCliAdapterOptions\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/types.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L197)\n\nConfiguration options for the [@nhtio/adk/batteries/llm/claude\\_code\\_cli!ClaudeCodeCliAdapter](../../adapter/classes/ClaudeCodeCliAdapter.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `addDir?` | `string`\\[] | Additional directories to allow tool access to, forwarded to `--add-dir`. | [src/batteries/llm/claude\\_code\\_cli/types.ts:220](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L220) |\n| `apiKey?` | `string` | Forwarded as `ANTHROPIC_API_KEY`. Exactly one of `apiKey`/`authToken` must be set. | [src/batteries/llm/claude\\_code\\_cli/types.ts:212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L212) |\n| `appendSystemPrompt?` | `string` | Forwarded verbatim to `--append-system-prompt`, appending to Claude Code's OWN system prompt — a wholly separate channel from this battery's rendered `-p` history prompt. No merge/concatenation logic against the history prompt itself. | [src/batteries/llm/claude\\_code\\_cli/types.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L210) |\n| `authToken?` | `string` | Forwarded as `ANTHROPIC_AUTH_TOKEN`. Exactly one of `apiKey`/`authToken` must be set. Empirically confirmed to work under `--bare`. | [src/batteries/llm/claude\\_code\\_cli/types.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L214) |\n| `autoAck?` | `boolean` | Whether the executor acks automatically on a tool-call-free terminal answer. | [src/batteries/llm/claude\\_code\\_cli/types.ts:262](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L262) |\n| `baseURL?` | `string` | Forwarded as `ANTHROPIC_BASE_URL`. Valid with either auth mechanism. | [src/batteries/llm/claude\\_code\\_cli/types.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L216) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Determines order of the system-prompt content buckets in history assembly. | [src/batteries/llm/claude\\_code\\_cli/types.ts:266](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L266) |\n| `claudeBin?` | `string` | Path to the `claude` binary. Defaults to `'claude'` (resolved via `PATH`). | [src/batteries/llm/claude\\_code\\_cli/types.ts:204](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L204) |\n| `contextWindow?` | `number` | Size of the model's token context window for the ADK pre-flight guard. | [src/batteries/llm/claude\\_code\\_cli/types.ts:228](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L228) |\n| `cwd?` | `string` | Working directory for the grandchild `claude` process. | [src/batteries/llm/claude\\_code\\_cli/types.ts:218](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L218) |\n| `disableErrorReporting?` | `boolean` | Mapped to `DISABLE_ERROR_REPORTING` on the grandchild's env, never a CLI flag. | [src/batteries/llm/claude\\_code\\_cli/types.ts:256](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L256) |\n| `disableNonessentialTraffic?` | `boolean` | Mapped to `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` on the grandchild's env, never a CLI flag. | [src/batteries/llm/claude\\_code\\_cli/types.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L258) |\n| `disableTelemetry?` | `boolean` | Mapped to `DISABLE_TELEMETRY` on the grandchild's env, never a CLI flag. | [src/batteries/llm/claude\\_code\\_cli/types.ts:254](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L254) |\n| `disallowedTools?` | `string`\\[] | Tool names to exclude from the bridged MCP tool set BEFORE it ever reaches the wrapper — the real enforcement point (see the battery's design notes on why `--allowedTools` cannot do this once `--dangerously-skip-permissions` is set). Never emitted as its own CLI flag. | [src/batteries/llm/claude\\_code\\_cli/types.ts:226](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L226) |\n| `disposeGraceMs?` | `number` | Grace period (ms) the graceful-shutdown sequence waits for the wrapper/grandchild to exit before escalating. Default 2000. | [src/batteries/llm/claude\\_code\\_cli/types.ts:250](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L250) |\n| `execa?` | [`ExecaResolver`](../type-aliases/ExecaResolver.md) | The `execa` function or an async resolver for it. Defaults to a lazy dynamic import of the `execa` package (optional peer). | [src/batteries/llm/claude\\_code\\_cli/types.ts:200](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L200) |\n| `extraArgs?` | [`ClaudeCodeCliExtraArg`](../../wire/interfaces/ClaudeCodeCliExtraArg.md)\\[] | A strict, structured allowlist escape hatch for genuinely orthogonal CLI flags (`--effort`/`--agent`/`--betas`/`--json-schema`/`--name`/`--prompt-suggestions`). Validated at options-construction time; never accepts a flag capable of touching tool/permission/MCP/ session-state configuration, and never accepts a value string starting with `-`. | [src/batteries/llm/claude\\_code\\_cli/types.ts:289](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L289) |\n| `fallbackModel?` | `string`\\[] | Forwarded to `--fallback-model` as one comma-joined value. | [src/batteries/llm/claude\\_code\\_cli/types.ts:239](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L239) |\n| `forwardSubagentText?` | `boolean` | Forwarded to `--forward-subagent-text` when true. Default false — subagent text is invisible by default (documented v1 limitation). | [src/batteries/llm/claude\\_code\\_cli/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L264) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`ClaudeCodeCliHelpers`](ClaudeCodeCliHelpers.md)> | Optional overrides for the translation helpers. | [src/batteries/llm/claude\\_code\\_cli/types.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L272) |\n| `maxBudgetUsd?` | `number` | Forwarded to `--max-budget-usd`. Always available. | [src/batteries/llm/claude\\_code\\_cli/types.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L237) |\n| ~~`maxTurns?`~~ | `number` | **Deprecated** Single-turn dispatch is the fixed battery contract. Only `1` is accepted; the option is ignored because argv always carries `--max-turns 1`. | [src/batteries/llm/claude\\_code\\_cli/types.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L235) |\n| `mcpToolIdleTimeoutMs?` | `number` | Mapped to `CLAUDE_CODE_MCP_TOOL_IDLE_TIMEOUT` on the grandchild's env, never a CLI flag. Default unset (falls through to the CLI's own 5-minute default). | [src/batteries/llm/claude\\_code\\_cli/types.ts:252](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L252) |\n| `model` | `string` | Required. The Claude model identifier, forwarded to `--model`. | [src/batteries/llm/claude\\_code\\_cli/types.ts:241](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L241) |\n| `replayCompatibility?` | readonly `string`\\[] | List of replay labels supported by the assistant. | [src/batteries/llm/claude\\_code\\_cli/types.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L270) |\n| `selfIdentity?` | `string` | Unique identity label for the assistant instance. | [src/batteries/llm/claude\\_code\\_cli/types.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L260) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | Backing store for spooled tool results; defaults to a per-dispatch in-memory store. | [src/batteries/llm/claude\\_code\\_cli/types.ts:274](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L274) |\n| `startupTimeoutMs?` | `number` | Adapter-side startup watchdog (ms), spanning from the wrapper's spawn through BOTH the wrapper's own `ready` event AND Claude's `system/init` stream-json event. Default 45\\_000. | [src/batteries/llm/claude\\_code\\_cli/types.ts:248](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L248) |\n| `streamIdleTimeoutMs?` | `number` | Adapter-side, ADK-owned stream-idle watchdog (ms). Reset on every raw stdout byte from the wrapper. Default 60\\_000. | [src/batteries/llm/claude\\_code\\_cli/types.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L243) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Determines which thoughts are surfaced back to the model. | [src/batteries/llm/claude\\_code\\_cli/types.ts:268](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L268) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | Tokenizer encoding configuration for token counting. | [src/batteries/llm/claude\\_code\\_cli/types.ts:230](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L230) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | Policy for handling a [@nhtio/adk!Media](../../../../../common/classes/Media.md) whose modality cannot be represented in the INBOUND (`-p` prompt) direction. | [src/batteries/llm/claude\\_code\\_cli/types.ts:276](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L276) |\n| `unsupportedResultMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | Policy for handling a [@nhtio/adk!Media](../../../../../common/classes/Media.md) whose modality cannot be represented in the OUTBOUND (MCP tool-result) direction. A real, independently-settable branch — defaults to the same value as `unsupportedMediaPolicy` when omitted, but can diverge. | [src/batteries/llm/claude\\_code\\_cli/types.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L282) |\n| `wrapperPath?` | `string` | Overridable path to the built wrapper asset. Defaults to `resolveDefaultWrapperPath()`. | [src/batteries/llm/claude\\_code\\_cli/types.ts:202](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L202) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliHelpers","title":"Interface: ClaudeCodeCliHelpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliHelpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliHelpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ClaudeCodeCliHelpers.md\ndescription: >-\n Full translation-helper contract for the Claude Code CLI battery. Extends the\n wire-shape- agnostic [`ChatHelpersCommon`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ChatHelpersCommon) (shared with every other\n Chat-family battery) and adds the battery-specific members: a plain-text-only\n timeline-message renderer (a `-p` prompt string has no native image\n side-channel, unlike Ollama's `images[]`), a plain-text-only tool-call-result\n renderer for the *inbound* history direction, and the top-level\n history-to-prompt assembler.\n---\n\n# Interface: ClaudeCodeCliHelpers\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/types.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L87)\n\nFull translation-helper contract for the Claude Code CLI battery. Extends the wire-shape-\nagnostic [ChatHelpersCommon](../../../openai_responses/types/interfaces/ChatHelpersCommon.md) (shared with every other Chat-family battery) and adds the\nbattery-specific members: a plain-text-only timeline-message renderer (a `-p` prompt string has\nno native image side-channel, unlike Ollama's `images[]`), a plain-text-only tool-call-result\nrenderer for the *inbound* history direction, and the top-level history-to-prompt assembler.\n\n## Extends\n\n* [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buildClaudeCodeCliPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderClaudeCodeCliTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderClaudeCodeCliToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<{ `prompt`: `string`; `reasoningPayloads`: { `id`: `string`; `payload`: `unknown`; `replayCompatibility`: `string`; }\\[]; }> | Assembles the full history into a single joined prompt string: the leading system-prompt block, the timestamp-sorted timeline (messages/thoughts/tool-calls), and any trailing buckets after `'timeline'` in `bucketOrder` — a direct structural port of `buildOllamaHistory`'s ordering, with the target shape collapsed from a message array to one string (this wire has one `-p` positional argument, not a message array). | - | [src/batteries/llm/claude\\_code\\_cli/types.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L122) |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`descriptionToChatCompletionsJsonSchema`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema) | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`filterThoughts`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts) | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) tool result: metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam. When omitted the battery uses the shared defaultRenderArtifactHandleBody. A consumer overrides it to change WHICH reader the model is steered toward first — e.g. promoting the JSON content-readers (`artifact_json_get` / `artifact_json_keys`) ahead of the metadata-only `artifact_json_type` for a small model that grabs the first listed tool. The tool list itself comes from the artifact's `constructor.toolMethods`; an override typically reorders or re-annotates that list before delegating to the default renderer. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderArtifactHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody) | [src/batteries/llm/chat\\_common/types.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L571) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderChatCompletionsSystemPrompt`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt) | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderClaudeCodeCliTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | Renders a single timeline [@nhtio/adk!Message](../../../../../common/classes/Message.md) into plain text for the `-p` prompt string. Structurally identical to `renderOllamaTimelineMessage`'s trust-envelope/identity logic, except every attachment (image or otherwise) routes through `unsupportedMediaPolicy` and renders as text, since there is no native image channel to push into. | - | [src/batteries/llm/claude\\_code\\_cli/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L94) |\n| `renderClaudeCodeCliToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | Renders a completed [@nhtio/adk!ToolCall](../../../../../forge/classes/ToolCall.md)'s result into plain text for the *inbound* history direction (i.e. how a past tool call reads back into a subsequent dispatch's rendered prompt) — the counterpart to the *outbound* MCP `CallToolResult` rendering the adapter performs directly when a tool call happens mid-turn (see `wire.ts`'s `WrapperToolCallResponseCommand`). | - | [src/batteries/llm/claude\\_code\\_cli/types.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L106) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderFirstPartyRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables) | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderMemories`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories) | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md) whose content is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam, the retrievable-side counterpart to [renderArtifactHandleBody](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody). When omitted the battery uses the shared defaultRenderRetrievableHandleBody. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablehandlebody) | [src/batteries/llm/chat\\_common/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L588) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables) | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableSafetyDirective`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective) | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderStandingInstructions`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions) | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPrivateRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables) | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPublicRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables) | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThought`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought) | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderTrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderUntrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`toolsToChatCompletionsTools`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools) | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ExecaLike","title":"Interface: ExecaLike()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ExecaLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ExecaLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/types/interfaces/ExecaLike.md\ndescription: The slice of execa this adapter uses to spawn the wrapper.\n---\n\n# Interface: ExecaLike()\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/types.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L165)\n\nThe slice of execa this adapter uses to spawn the wrapper.\n\n```ts\nExecaLike(\n cmd: string,\n args: readonly string[],\n options: {\n cleanup?: boolean;\n cwd?: string;\n env?: Record;\n}): {\n catch: (onrejected?: ((reason: any) => TResult | PromiseLike) | null) => Promise<\n | {\n exitCode: number | null;\n }\n | TResult>;\n exitCode: number | null;\n stdin: | {\n end: void;\n write: void;\n }\n | null;\n stdout: | {\n on: void;\n }\n | null;\n then: (onfulfilled?:\n | ((value: {\n exitCode: number | null;\n }) => TResult1 | PromiseLike)\n | null, onrejected?: ((reason: any) => TResult2 | PromiseLike) | null) => Promise;\n kill: boolean;\n};\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/types.ts:166](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L166)\n\nThe slice of execa this adapter uses to spawn the wrapper.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cmd` | `string` |\n| `args` | readonly `string`\\[] |\n| `options` | { `cleanup?`: `boolean`; `cwd?`: `string`; `env?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string` | `undefined`>; } |\n| `options.cleanup?` | `boolean` |\n| `options.cwd?` | `string` |\n| `options.env?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string` | `undefined`> |\n\n## Returns\n\n| Name | Type | Defined in |\n| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `catch()` | <`TResult`>(`onrejected?`: ((`reason`: `any`) => `TResult` | `PromiseLike`<`TResult`>) | `null`) => `Promise`< | { `exitCode`: `number` | `null`; } | `TResult`> | [src/batteries/llm/claude\\_code\\_cli/types.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L183) |\n| `exitCode` | `number` | `null` | [src/batteries/llm/claude\\_code\\_cli/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L181) |\n| `stdin` | | { `end`: `void`; `write`: `void`; } | `null` | [src/batteries/llm/claude\\_code\\_cli/types.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L175) |\n| `stdout` | | { `on`: `void`; } | `null` | [src/batteries/llm/claude\\_code\\_cli/types.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L176) |\n| `then()` | <`TResult1`, `TResult2`>(`onfulfilled?`: | ((`value`: { `exitCode`: `number` | `null`; }) => `TResult1` | `PromiseLike`<`TResult1`>) | `null`, `onrejected?`: ((`reason`: `any`) => `TResult2` | `PromiseLike`<`TResult2`>) | `null`) => `Promise`<`TResult1` | `TResult2`> | [src/batteries/llm/claude\\_code\\_cli/types.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L182) |\n| `kill()` | (`signal?`: `string`) => `boolean` | [src/batteries/llm/claude\\_code\\_cli/types.ts:180](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L180) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/type-aliases/ExecaResolver","title":"Type Alias: ExecaResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/type-aliases/ExecaResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/types/type-aliases/ExecaResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/types/type-aliases/ExecaResolver.md\ndescription: >-\n Resolver forms accepted for the `execa` module — mirrors `ExecaResolver` in\n `execa_executor.ts`.\n---\n\n# Type Alias: ExecaResolver\n\n```ts\ntype ExecaResolver =\n | ExecaLike\n | (() =>\n | ExecaLike\n | {\n execa: ExecaLike;\n }\n | Promise<\n | ExecaLike\n | {\n execa: ExecaLike;\n }\n >);\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/types.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/types.ts#L188)\n\nResolver forms accepted for the `execa` module — mirrors `ExecaResolver` in `execa_executor.ts`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation","title":"@nhtio/adk/batteries/llm/claude\\_code\\_cli/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/validation.md'\ndescription: Runtime validation schema and wrapper for Claude Code CLI adapter options.\n---\n\n# @nhtio/adk/batteries/llm/claude\\_code\\_cli/validation\n\nRuntime validation schema and wrapper for Claude Code CLI adapter options.\n\n## Remarks\n\nSchema and call-site wrapper for validating `ClaudeCodeCliAdapterOptions`. Used at construction\ntime and at the start of every iteration against the merged options shape (stash > executor >\nconstructor). Throws `E_INVALID_CLAUDE_CODE_CLI_OPTIONS` on failure — same hard-fail policy as\nevery other ADK contract.\n\nThree invariants enforced here that have no equivalent in the other LLM batteries:\n\n* `apiKey`/`authToken` are mutually exclusive AND at least one is required (`.xor`).\n* `extraArgs` entries are validated against a strict six-flag allowlist, with per-flag value\n arity, and every value string is rejected if it starts with `-` — the fix for the `--betas`\n variadic-value injection hazard (a value string spelling another flag would otherwise reach\n the CLI's own argv parser as a distinct token).\n* `process.platform` is checked at validation time: this battery is POSIX-only in v1 (reliable\n process-group control requires POSIX process groups), mirroring\n `src/batteries/sandbox/node/srt_enforcer.ts`'s own platform-boundary precedent.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [claudeCodeCliOptionsSchema](variables/claudeCodeCliOptionsSchema.md) | Validator schema for `ClaudeCodeCliAdapterOptions`. Used by `validateOptions` at construction time and again at the start of every iteration after options have been merged (stash > executor > constructor). Rejects unknown top-level keys so typos fail loud. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `claudeCodeCliOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_CLAUDE_CODE_CLI_OPTIONS` (carrying the validator's error report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): ClaudeCodeCliAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/validation.ts:220](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/validation.ts#L220)\n\nValidates an arbitrary input against `claudeCodeCliOptionsSchema` and returns the resolved\noptions shape. Throws `E_INVALID_CLAUDE_CODE_CLI_OPTIONS` (carrying the validator's error\nreport on `cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`ClaudeCodeCliAdapterOptions`](../../types/interfaces/ClaudeCodeCliAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/variables/claudeCodeCliOptionsSchema","title":"Variable: claudeCodeCliOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/variables/claudeCodeCliOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/variables/claudeCodeCliOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/validation/variables/claudeCodeCliOptionsSchema.md\ndescription: >-\n Validator schema for `ClaudeCodeCliAdapterOptions`. Used by `validateOptions`\n at construction time and again at the start of every iteration after options\n have been merged (stash > executor > constructor). Rejects unknown top-level\n keys so typos fail loud.\n---\n\n# Variable: claudeCodeCliOptionsSchema\n\n```ts\nconst claudeCodeCliOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/validation.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/validation.ts#L137)\n\nValidator schema for `ClaudeCodeCliAdapterOptions`. Used by `validateOptions` at construction\ntime and again at the start of every iteration after options have been merged (stash > executor\n\n> constructor). Rejects unknown top-level keys so typos fail loud.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire","title":"@nhtio/adk/batteries/llm/claude\\_code\\_cli/wire","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire.md'\ndescription: >-\n The normalized adapter↔wrapper protocol shared by every CLI-harness LLM\n battery.\n---\n\n# @nhtio/adk/batteries/llm/claude\\_code\\_cli/wire\n\nThe normalized adapter↔wrapper protocol shared by every CLI-harness LLM battery.\n\n## Remarks\n\nZero imports by design: this module is the seam between `adapter.ts` (which runs in the ADK\nprocess and imports ADK barrels freely) and `wrapper.ts` (which runs as a separate spawned\nprocess and must import nothing from `@nhtio/adk/*`). Depending on either side would break the\nboundary, so this file depends on neither.\n\nThe wrapper↔adapter protocol itself is deliberately harness-agnostic — `WrapperRunCommand` /\n`WrapperEvent` name no Claude-Code-specific concept — so a future Codex-CLI or Pi-agent battery\ncan reuse this exact module, writing only its own wrapper.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ClaudeCodeCliExtraArg](interfaces/ClaudeCodeCliExtraArg.md) | One entry in a `--json-schema`/`--effort`-style `extraArgs` escape hatch. |\n| [WrapperAuth](interfaces/WrapperAuth.md) | Explicit auth credential to forward to the grandchild's environment. Exactly one of the two fields is set. |\n| [WrapperBridgedTool](interfaces/WrapperBridgedTool.md) | A bridged ADK tool's JSON-Schema-rendered description, as exposed to the CLI over MCP. |\n| [WrapperErrorEvent](interfaces/WrapperErrorEvent.md) | A wrapper-level failure (spawn error, unexpected exit, MCP bridge startup failure). |\n| [WrapperInitEvent](interfaces/WrapperInitEvent.md) | Mirrors Claude's own `system/init` stream-json event. |\n| [WrapperLogEvent](interfaces/WrapperLogEvent.md) | A generic diagnostic passthrough, never fatal. |\n| [WrapperMessageDeltaEvent](interfaces/WrapperMessageDeltaEvent.md) | A streamed chunk of assistant text or reasoning. |\n| [WrapperReadyEvent](interfaces/WrapperReadyEvent.md) | The bridge's HTTP listener is bound and the wrapper is about to spawn `claude`. |\n| [WrapperResultEvent](interfaces/WrapperResultEvent.md) | The terminal event for a dispatch iteration. |\n| [WrapperRetryEvent](interfaces/WrapperRetryEvent.md) | Mirrors Claude's own `system/api_retry` stream-json event. Observability only. |\n| [WrapperRunCommand](interfaces/WrapperRunCommand.md) | The one command `adapter.ts` sends per dispatch iteration, immediately after the wrapper's `ready` event arrives. Exactly one `run` command is accepted per wrapper process lifetime — the wrapper is spawned fresh per dispatch iteration, so there is no multi-run session. |\n| [WrapperShutdownCommand](interfaces/WrapperShutdownCommand.md) | Graceful-stop advisory sent to the wrapper (e.g. on `ctx.abortSignal` firing). |\n| [WrapperShutdownCompleteEvent](interfaces/WrapperShutdownCompleteEvent.md) | The wrapper's bridge HTTP listener and `claude` grandchild have both been torn down and the wrapper is about to exit. |\n| [WrapperThoughtDeltaEvent](interfaces/WrapperThoughtDeltaEvent.md) | A streamed chunk of reasoning/thinking text. |\n| [WrapperToolCallRequestEvent](interfaces/WrapperToolCallRequestEvent.md) | A real ADK tool the wrapper's MCP bridge is asking the adapter to execute. |\n| [WrapperToolCallResponseCommand](interfaces/WrapperToolCallResponseCommand.md) | The adapter's answer to a `tool_call_request` — a finished `CallToolResult`-shaped payload the wrapper hands straight to the CLI's MCP bridge with no further interpretation. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------------------------ | ----------------------------------------------------- |\n| [WrapperCommand](type-aliases/WrapperCommand.md) | The full adapter→wrapper command union. |\n| [WrapperEvent](type-aliases/WrapperEvent.md) | The full wrapper→adapter event union. |\n| [WrapperToolResultContentBlock](type-aliases/WrapperToolResultContentBlock.md) | One MCP content block a tool-call response may carry. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [createNdjsonLineReader](functions/createNdjsonLineReader.md) | Create an incremental, byte-oriented NDJSON line reader. Generalizes `local_diffusion/protocol.ts`'s `createFrameReader` discipline (bounded memory via a hard `maxLineBytes` cap enforced while consuming, fatal-UTF8-decode, malformed-line-is-non-fatal) for pure JSON-per-line framing with no tag-prefixed grammar. `onLine` receives each decoded line and returns the parsed value, or `undefined` for a line that failed to parse — the reader itself never throws and never classifies content, it only frames bytes into lines. |\n| [encodeWrapperCommand](functions/encodeWrapperCommand.md) | Encode a `WrapperCommand` as one NDJSON line, including its terminating newline. |\n| [encodeWrapperEvent](functions/encodeWrapperEvent.md) | Encode a `WrapperEvent` as one NDJSON line, including its terminating newline. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/createNdjsonLineReader","title":"Function: createNdjsonLineReader()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/createNdjsonLineReader.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/createNdjsonLineReader","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/createNdjsonLineReader.md\n---\n\n# Function: createNdjsonLineReader()\n\n```ts\nfunction createNdjsonLineReader(\n onLine: (raw: string) => T | undefined,\n opts?: {\n maxLineBytes?: number;\n },\n): {\n end: void;\n push: void;\n};\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:308](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L308)\n\nCreate an incremental, byte-oriented NDJSON line reader. Generalizes\n`local_diffusion/protocol.ts`'s `createFrameReader` discipline (bounded memory via a hard\n`maxLineBytes` cap enforced while consuming, fatal-UTF8-decode, malformed-line-is-non-fatal) for\npure JSON-per-line framing with no tag-prefixed grammar. `onLine` receives each decoded line and\nreturns the parsed value, or `undefined` for a line that failed to parse — the reader itself\nnever throws and never classifies content, it only frames bytes into lines.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `T` |\n\n## Parameters\n\n| Parameter | Type |\n| -------------------- | --------------------------------------- |\n| `onLine` | (`raw`: `string`) => `T` | `undefined` |\n| `opts?` | { `maxLineBytes?`: `number`; } |\n| `opts.maxLineBytes?` | `number` |\n\n## Returns\n\n```ts\n{\n end: void;\n push: void;\n}\n```\n\n| Name | Type | Defined in |\n| -------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `end()` | () => `void` | [src/batteries/llm/claude\\_code\\_cli/wire.ts:311](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L311) |\n| `push()` | (`chunk`: `Uint8Array`) => `void` | [src/batteries/llm/claude\\_code\\_cli/wire.ts:311](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L311) |\n\n## Throws\n\nRangeError if `maxLineBytes` is provided but is not a positive, finite, safe integer.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperCommand","title":"Function: encodeWrapperCommand()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperCommand.md\n---\n\n# Function: encodeWrapperCommand()\n\n```ts\nfunction encodeWrapperCommand(command: WrapperCommand): string;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:287](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L287)\n\nEncode a `WrapperCommand` as one NDJSON line, including its terminating newline.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------- |\n| `command` | [`WrapperCommand`](../type-aliases/WrapperCommand.md) |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperEvent","title":"Function: encodeWrapperEvent()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/functions/encodeWrapperEvent.md\n---\n\n# Function: encodeWrapperEvent()\n\n```ts\nfunction encodeWrapperEvent(event: WrapperEvent): string;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:291](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L291)\n\nEncode a `WrapperEvent` as one NDJSON line, including its terminating newline.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------- |\n| `event` | [`WrapperEvent`](../type-aliases/WrapperEvent.md) |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/ClaudeCodeCliExtraArg","title":"Interface: ClaudeCodeCliExtraArg","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/ClaudeCodeCliExtraArg.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/ClaudeCodeCliExtraArg","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/ClaudeCodeCliExtraArg.md\ndescription: One entry in a `--json-schema`/`--effort`-style `extraArgs` escape hatch.\n---\n\n# Interface: ClaudeCodeCliExtraArg\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L18)\n\nOne entry in a `--json-schema`/`--effort`-style `extraArgs` escape hatch.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `flag` | | `\"--betas\"` | `\"--prompt-suggestions\"` | `\"--effort\"` | `\"--agent\"` | `\"--json-schema\"` | `\"--name\"` | The exact CLI flag spelling. Restricted to a small, deliberately-chosen allowlist. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L20) |\n| `value?` | `string` | `string`\\[] | The flag's value. Required for every flag except `--prompt-suggestions` (optional, matching the CLI's own `[value]` bracket syntax). A plain `string` for every flag except `--betas`, which accepts `string[]` (matching its own `` variadic arity). Every individual value string, in every position, must not start with `-` — this is what makes it structurally impossible for a value to be interpreted by the CLI's own parser as a separate flag. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L28) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperAuth","title":"Interface: WrapperAuth","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperAuth.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperAuth","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperAuth.md\ndescription: >-\n Explicit auth credential to forward to the grandchild's environment. Exactly\n one of the two fields is set.\n---\n\n# Interface: WrapperAuth\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L42)\n\nExplicit auth credential to forward to the grandchild's environment. Exactly one of the two fields is set.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | -------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | Forwarded as `ANTHROPIC_API_KEY`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L44) |\n| `authToken?` | `string` | Forwarded as `ANTHROPIC_AUTH_TOKEN`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L46) |\n| `baseUrl?` | `string` | Forwarded as `ANTHROPIC_BASE_URL`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L48) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperBridgedTool","title":"Interface: WrapperBridgedTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperBridgedTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperBridgedTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperBridgedTool.md\ndescription: >-\n A bridged ADK tool's JSON-Schema-rendered description, as exposed to the CLI\n over MCP.\n---\n\n# Interface: WrapperBridgedTool\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L32)\n\nA bridged ADK tool's JSON-Schema-rendered description, as exposed to the CLI over MCP.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `description` | `string` | Human/model-facing description. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L36) |\n| `inputSchema` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Plain JSON-Schema-shaped input schema (never a Zod schema — see Decision F in the design). | [src/batteries/llm/claude\\_code\\_cli/wire.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L38) |\n| `name` | `string` | The tool's raw name — matches `ctx.tools.visible()`, NOT the `mcp____` permission spelling. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L34) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperErrorEvent","title":"Interface: WrapperErrorEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperErrorEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperErrorEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperErrorEvent.md\ndescription: >-\n A wrapper-level failure (spawn error, unexpected exit, MCP bridge startup\n failure).\n---\n\n# Interface: WrapperErrorEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:239](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L239)\n\nA wrapper-level failure (spawn error, unexpected exit, MCP bridge startup failure).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | --------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `detail?` | `string` | Additional detail, when available (e.g. the underlying error's message). | [src/batteries/llm/claude\\_code\\_cli/wire.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L245) |\n| `message` | `string` | Human-readable summary of the failure. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L243) |\n| `type` | `\"error\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:241](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L241) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperInitEvent","title":"Interface: WrapperInitEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperInitEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperInitEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperInitEvent.md\ndescription: Mirrors Claude's own `system/init` stream-json event.\n---\n\n# Interface: WrapperInitEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L151)\n\nMirrors Claude's own `system/init` stream-json event.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `mcpServerErrors?` | `string`\\[] | Any MCP server connection errors Claude reported during its own startup handshake. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L159) |\n| `model?` | `string` | The model Claude reports it initialized with. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L155) |\n| `raw?` | `unknown` | The original, unmodified `system/init` stream-json line. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L161) |\n| `tools?` | `string`\\[] | The built-in tool names Claude reports as available (expected empty under `--tools \"\"`). | [src/batteries/llm/claude\\_code\\_cli/wire.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L157) |\n| `type` | `\"init\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L153) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperLogEvent","title":"Interface: WrapperLogEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperLogEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperLogEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperLogEvent.md\ndescription: 'A generic diagnostic passthrough, never fatal.'\n---\n\n# Interface: WrapperLogEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L249)\n\nA generic diagnostic passthrough, never fatal.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `string` | A short machine-readable category for the diagnostic (e.g. `'malformed-stream-json'`). | [src/batteries/llm/claude\\_code\\_cli/wire.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L255) |\n| `level` | `\"error\"` | `\"warn\"` | `\"trace\"` | `\"debug\"` | `\"info\"` | Severity of the diagnostic. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L253) |\n| `message` | `string` | Human-readable message. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L257) |\n| `payload?` | `unknown` | Additional structured detail, when available. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L259) |\n| `type` | `\"log\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L251) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperMessageDeltaEvent","title":"Interface: WrapperMessageDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperMessageDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperMessageDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperMessageDeltaEvent.md\ndescription: A streamed chunk of assistant text or reasoning.\n---\n\n# Interface: WrapperMessageDeltaEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L165)\n\nA streamed chunk of assistant text or reasoning.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ----------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `delta` | `string` | The incremental text chunk. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L171) |\n| `id` | `string` | Identifier correlating deltas belonging to the same in-progress message. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L169) |\n| `isComplete?` | `boolean` | Set on the final delta for this message id. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L173) |\n| `type` | `\"message_delta\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L167) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperReadyEvent","title":"Interface: WrapperReadyEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperReadyEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperReadyEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperReadyEvent.md\ndescription: >-\n The bridge's HTTP listener is bound and the wrapper is about to spawn\n `claude`.\n---\n\n# Interface: WrapperReadyEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L145)\n\nThe bridge's HTTP listener is bound and the wrapper is about to spawn `claude`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | --------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `type` | `\"ready\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L147) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperResultEvent","title":"Interface: WrapperResultEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperResultEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperResultEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperResultEvent.md\ndescription: The terminal event for a dispatch iteration.\n---\n\n# Interface: WrapperResultEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L217)\n\nThe terminal event for a dispatch iteration.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `isError` | `boolean` | Whether this turn ended in an error (e.g. `--max-turns`/`--max-budget-usd` exhaustion). | [src/batteries/llm/claude\\_code\\_cli/wire.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L229) |\n| `raw?` | `unknown` | The original, unmodified terminal `result` stream-json line. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L235) |\n| `resultText?` | `string` | The final assistant-facing result text, when present. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L221) |\n| `sessionId?` | `string` | Claude's own session identifier for this turn. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L223) |\n| `stopReason?` | `string` | Claude's own stated reason the turn stopped. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:233](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L233) |\n| `subtype?` | `string` | Claude's machine-readable reason the turn stopped. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L231) |\n| `totalCostUsd?` | `number` | Total cost, in USD, Claude reports for this turn. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L225) |\n| `type` | `\"result\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L219) |\n| `usage?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Token/usage accounting Claude reports for this turn. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:227](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L227) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRetryEvent","title":"Interface: WrapperRetryEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRetryEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRetryEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRetryEvent.md\ndescription: Mirrors Claude's own `system/api_retry` stream-json event. Observability only.\n---\n\n# Interface: WrapperRetryEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L201)\n\nMirrors Claude's own `system/api_retry` stream-json event. Observability only.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------- | --------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `attempt` | `number` | The retry attempt number. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L205) |\n| `error?` | `string` | The error message associated with the retry. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L213) |\n| `errorStatus?` | `number` | The HTTP status code that triggered the retry. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L211) |\n| `maxRetries?` | `number` | The maximum number of retries Claude will attempt. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L207) |\n| `retryDelayMs?` | `number` | The delay, in milliseconds, before the next retry. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L209) |\n| `type` | `\"retry\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L203) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRunCommand","title":"Interface: WrapperRunCommand","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRunCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRunCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperRunCommand.md\ndescription: >-\n The one command `adapter.ts` sends per dispatch iteration, immediately after\n the wrapper's `ready` event arrives. Exactly one `run` command is accepted per\n wrapper process lifetime — the wrapper is spawned fresh per dispatch\n iteration, so there is no multi-run session.\n---\n\n# Interface: WrapperRunCommand\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L56)\n\nThe one command `adapter.ts` sends per dispatch iteration, immediately after the wrapper's\n`ready` event arrives. Exactly one `run` command is accepted per wrapper process lifetime — the\nwrapper is spawned fresh per dispatch iteration, so there is no multi-run session.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `addDir?` | `string`\\[] | Additional directories to allow tool access to, forwarded to `--add-dir`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L68) |\n| `allowedTools` | `string`\\[] | The exact MCP-bridged tool names the grandchild is allowed to call, ALREADY filtered by the adapter to exclude `disallowedTools`. Always sent, never omitted at this layer — the wrapper itself decides whether to emit `--allowedTools` (omitted entirely when this array is empty, since the flag is variadic and a bare `--allowedTools` with nothing after it would swallow the next argv token). | [src/batteries/llm/claude\\_code\\_cli/wire.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L76) |\n| `appendSystemPrompt?` | `string` | Forwarded verbatim to `--append-system-prompt`, when set. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L62) |\n| `auth?` | [`WrapperAuth`](WrapperAuth.md) | Explicit auth credential(s) for the grandchild's environment. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L82) |\n| `bridgedTools` | [`WrapperBridgedTool`](WrapperBridgedTool.md)\\[] | The JSON-Schema-rendered subset of `ctx.tools.visible()` the wrapper exposes over MCP, already pre-filtered to exclude `disallowedTools`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L102) |\n| `claudeBin` | `string` | Path to the `claude` binary to spawn. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L92) |\n| `cwd?` | `string` | Working directory for the grandchild, forwarded to `--cwd`-equivalent spawn option. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L66) |\n| `disableErrorReporting?` | `boolean` | Mapped to `DISABLE_ERROR_REPORTING` on the grandchild's env, never a CLI flag. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L86) |\n| `disableNonessentialTraffic?` | `boolean` | Mapped to `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` on the grandchild's env, never a CLI flag. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L88) |\n| `disableTelemetry?` | `boolean` | Mapped to `DISABLE_TELEMETRY` on the grandchild's env, never a CLI flag. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L84) |\n| `extraArgs?` | [`ClaudeCodeCliExtraArg`](ClaudeCodeCliExtraArg.md)\\[] | Pre-validated additional argv entries, appended after every constructed flag and before the `--` prompt separator. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L104) |\n| `fallbackModel?` | `string`\\[] | Forwarded to `--fallback-model` as one comma-joined value, never as separate argv tokens. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L80) |\n| `forwardSubagentText?` | `boolean` | Forwarded to `--forward-subagent-text` when true. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L94) |\n| `maxBudgetUsd?` | `number` | Forwarded to `--max-budget-usd`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L78) |\n| `mcpToolIdleTimeoutMs?` | `number` | Mapped to `CLAUDE_CODE_MCP_TOOL_IDLE_TIMEOUT` on the grandchild's env, never a CLI flag. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L90) |\n| `model?` | `string` | The model identifier, forwarded to `--model`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L64) |\n| `prompt` | `string` | The fully-rendered history, as one `-p` positional prompt string. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L60) |\n| `type` | `\"run\"` | Discriminant for the [WrapperCommand](../type-aliases/WrapperCommand.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L58) |\n| `unsupportedResultMediaPolicy` | `string` | Governs how the adapter rendered an ADK tool-result's unsupported `Media` kind (or oversized inline `SpooledArtifact`) into the outbound `WrapperToolCallResponseCommand` — informational only, since the adapter has already applied the policy before this command is sent. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L100) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCommand","title":"Interface: WrapperShutdownCommand","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCommand.md\ndescription: Graceful-stop advisory sent to the wrapper (e.g. on `ctx.abortSignal` firing).\n---\n\n# Interface: WrapperShutdownCommand\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L131)\n\nGraceful-stop advisory sent to the wrapper (e.g. on `ctx.abortSignal` firing).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ------------ | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `type` | `\"shutdown\"` | Discriminant for the [WrapperCommand](../type-aliases/WrapperCommand.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L133) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCompleteEvent","title":"Interface: WrapperShutdownCompleteEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCompleteEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCompleteEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperShutdownCompleteEvent.md\ndescription: >-\n The wrapper's bridge HTTP listener and `claude` grandchild have both been torn\n down and the wrapper is about to exit.\n---\n\n# Interface: WrapperShutdownCompleteEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:266](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L266)\n\nThe wrapper's bridge HTTP listener and `claude` grandchild have both been torn down and the\nwrapper is about to exit.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | --------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `type` | `\"shutdown_complete\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:268](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L268) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperThoughtDeltaEvent","title":"Interface: WrapperThoughtDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperThoughtDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperThoughtDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperThoughtDeltaEvent.md\ndescription: A streamed chunk of reasoning/thinking text.\n---\n\n# Interface: WrapperThoughtDeltaEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L177)\n\nA streamed chunk of reasoning/thinking text.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ----------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `delta` | `string` | The incremental text chunk. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L183) |\n| `id` | `string` | Identifier correlating deltas belonging to the same in-progress thought. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L181) |\n| `isComplete?` | `boolean` | Set on the final delta for this thought id. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L185) |\n| `type` | `\"thought_delta\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L179) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallRequestEvent","title":"Interface: WrapperToolCallRequestEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallRequestEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallRequestEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallRequestEvent.md\ndescription: A real ADK tool the wrapper's MCP bridge is asking the adapter to execute.\n---\n\n# Interface: WrapperToolCallRequestEvent\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L189)\n\nA real ADK tool the wrapper's MCP bridge is asking the adapter to execute.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | `unknown` | The call arguments Claude supplied, as received from the MCP `CallTool` request. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L197) |\n| `requestId` | `string` | Correlates with the `requestId` the adapter must echo back on its `tool_call_response`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L193) |\n| `tool` | `string` | The bridged tool's raw name, matching `ctx.tools.visible()`. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L195) |\n| `type` | `\"tool_call_request\"` | Discriminant for the [WrapperEvent](../type-aliases/WrapperEvent.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L191) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallResponseCommand","title":"Interface: WrapperToolCallResponseCommand","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallResponseCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallResponseCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/interfaces/WrapperToolCallResponseCommand.md\ndescription: >-\n The adapter's answer to a `tool_call_request` — a finished\n `CallToolResult`-shaped payload the wrapper hands straight to the CLI's MCP\n bridge with no further interpretation.\n---\n\n# Interface: WrapperToolCallResponseCommand\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L116)\n\nThe adapter's answer to a `tool_call_request` — a finished `CallToolResult`-shaped payload the\nwrapper hands straight to the CLI's MCP bridge with no further interpretation.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `requestId` | `string` | Correlates with the `requestId` on the originating `tool_call_request` event. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L120) |\n| `results` | { `content`: [`WrapperToolResultContentBlock`](../type-aliases/WrapperToolResultContentBlock.md)\\[]; `isError?`: `boolean`; } | A finished `CallToolResult`-shaped payload, handed straight to the CLI's MCP bridge. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L122) |\n| `results.content` | [`WrapperToolResultContentBlock`](../type-aliases/WrapperToolResultContentBlock.md)\\[] | MCP content blocks to return for the call. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L124) |\n| `results.isError?` | `boolean` | Whether the tool call itself failed (as opposed to the wrapper/transport). | [src/batteries/llm/claude\\_code\\_cli/wire.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L126) |\n| `type` | `\"tool_call_response\"` | Discriminant for the [WrapperCommand](../type-aliases/WrapperCommand.md) union. | [src/batteries/llm/claude\\_code\\_cli/wire.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L118) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperCommand","title":"Type Alias: WrapperCommand","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperCommand.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperCommand","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperCommand.md\ndescription: The full adapter→wrapper command union.\n---\n\n# Type Alias: WrapperCommand\n\n```ts\ntype WrapperCommand =\n | WrapperRunCommand\n | WrapperToolCallResponseCommand\n | WrapperShutdownCommand;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L137)\n\nThe full adapter→wrapper command union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperEvent","title":"Type Alias: WrapperEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperEvent.md\ndescription: The full wrapper→adapter event union.\n---\n\n# Type Alias: WrapperEvent\n\n```ts\ntype WrapperEvent =\n | WrapperReadyEvent\n | WrapperInitEvent\n | WrapperMessageDeltaEvent\n | WrapperThoughtDeltaEvent\n | WrapperToolCallRequestEvent\n | WrapperRetryEvent\n | WrapperResultEvent\n | WrapperErrorEvent\n | WrapperLogEvent\n | WrapperShutdownCompleteEvent;\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L272)\n\nThe full wrapper→adapter event union.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperToolResultContentBlock","title":"Type Alias: WrapperToolResultContentBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperToolResultContentBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperToolResultContentBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/claude_code_cli/wire/type-aliases/WrapperToolResultContentBlock.md\ndescription: One MCP content block a tool-call response may carry.\n---\n\n# Type Alias: WrapperToolResultContentBlock\n\n```ts\ntype WrapperToolResultContentBlock =\n | {\n text: string;\n type: \"text\";\n }\n | {\n data: string;\n mimeType: string;\n type: \"image\";\n };\n```\n\nDefined in: [src/batteries/llm/claude\\_code\\_cli/wire.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/claude_code_cli/wire.ts#L108)\n\nOne MCP content block a tool-call response may carry.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content","title":"@nhtio/adk/batteries/llm/gemini\\_generate\\_content","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content.md'\ndescription: >-\n Native Gemini `generateContent` adapter battery with swappable translation\n helpers and wire types.\n---\n\n# @nhtio/adk/batteries/llm/gemini\\_generate\\_content\n\nNative Gemini `generateContent` adapter battery with swappable translation helpers and wire types.\n\n## Remarks\n\nTargets Google's NATIVE `POST {baseURL}/models/{model}:generateContent` surface — not an\nOpenAI-compatible façade in front of it. For that, point `openai_chat_completions` at the\ngateway's `/v1`.\n\nThe native surface differs from Chat Completions structurally, not cosmetically: turns are\n`contents[]` with role `model` (never `assistant`), there is no `system` role (system text goes\nto a top-level `systemInstruction`), a turn's payload is a heterogeneous `parts[]`, a tool call\nis a `functionCall` part on a `model` turn whose result comes back as a `functionResponse` part\non a **`user`** turn, correlation is by DECLARED TOOL NAME rather than a call id, and Gemini 3+\nhard-rejects a historical `functionCall` that carries no `thoughtSignature`.\n\nSpeaking it natively matters whenever you need to reason about what the VENDOR received rather\nthan what a translator sent on your behalf — an ordering guard, a wire-shape audit, a bug report\nagainst Google. See the validation battery's \"Which API surface a rule applies to\" guide.\n\nRe-exports the adapter, every translation helper (with `default*` aliases), the option and wire\ntypes, the validation schema plus `validateOptions`, and the battery-scoped exceptions.\n\n## References\n\n### buildGeminiRequest\n\nRe-exports [buildGeminiRequest](helpers/functions/buildGeminiRequest.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### DEFAULT\\_GEMINI\\_BUCKET\\_ORDER\n\nRe-exports [DEFAULT\\_GEMINI\\_BUCKET\\_ORDER](helpers/variables/DEFAULT_GEMINI_BUCKET_ORDER.md)\n\n***\n\n### defaultBuildGeminiRequest\n\nRe-exports [defaultBuildGeminiRequest](helpers/variables/defaultBuildGeminiRequest.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultExtractGeminiGeneration\n\nRe-exports [defaultExtractGeminiGeneration](helpers/variables/defaultExtractGeminiGeneration.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultMediaToGeminiInlineData\n\nRe-exports [defaultMediaToGeminiInlineData](helpers/variables/defaultMediaToGeminiInlineData.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderGeminiToolResult\n\nRe-exports [defaultRenderGeminiToolResult](helpers/variables/defaultRenderGeminiToolResult.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultSanitizeGeminiSchema\n\nRe-exports [defaultSanitizeGeminiSchema](helpers/variables/defaultSanitizeGeminiSchema.md)\n\n***\n\n### defaultToolsToGeminiTools\n\nRe-exports [defaultToolsToGeminiTools](helpers/variables/defaultToolsToGeminiTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_GEMINI\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_GEMINI\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_GEMINI_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_GEMINI\\_MISSING\\_THOUGHT\\_SIGNATURE\n\nRe-exports [E\\_GEMINI\\_MISSING\\_THOUGHT\\_SIGNATURE](exceptions/variables/E_GEMINI_MISSING_THOUGHT_SIGNATURE.md)\n\n***\n\n### E\\_GEMINI\\_REQUEST\\_FAILED\n\nRe-exports [E\\_GEMINI\\_REQUEST\\_FAILED](exceptions/variables/E_GEMINI_REQUEST_FAILED.md)\n\n***\n\n### E\\_GEMINI\\_STREAM\\_ERROR\n\nRe-exports [E\\_GEMINI\\_STREAM\\_ERROR](exceptions/variables/E_GEMINI_STREAM_ERROR.md)\n\n***\n\n### E\\_INVALID\\_GEMINI\\_GENERATE\\_CONTENT\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_GEMINI\\_GENERATE\\_CONTENT\\_OPTIONS](exceptions/variables/E_INVALID_GEMINI_GENERATE_CONTENT_OPTIONS.md)\n\n***\n\n### extractGeminiGeneration\n\nRe-exports [extractGeminiGeneration](helpers/functions/extractGeminiGeneration.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### GeminiCandidate\n\nRe-exports [GeminiCandidate](types/interfaces/GeminiCandidate.md)\n\n***\n\n### GeminiContent\n\nRe-exports [GeminiContent](types/interfaces/GeminiContent.md)\n\n***\n\n### GeminiFunctionCall\n\nRe-exports [GeminiFunctionCall](types/interfaces/GeminiFunctionCall.md)\n\n***\n\n### GeminiFunctionDeclaration\n\nRe-exports [GeminiFunctionDeclaration](types/interfaces/GeminiFunctionDeclaration.md)\n\n***\n\n### GeminiFunctionResponse\n\nRe-exports [GeminiFunctionResponse](types/interfaces/GeminiFunctionResponse.md)\n\n***\n\n### GeminiGenerateContentAdapter\n\nRe-exports [GeminiGenerateContentAdapter](adapter/classes/GeminiGenerateContentAdapter.md)\n\n***\n\n### GeminiGenerateContentAdapterOptions\n\nRe-exports [GeminiGenerateContentAdapterOptions](types/interfaces/GeminiGenerateContentAdapterOptions.md)\n\n***\n\n### GeminiGenerateContentHelpers\n\nRe-exports [GeminiGenerateContentHelpers](types/interfaces/GeminiGenerateContentHelpers.md)\n\n***\n\n### geminiGenerateContentOptionsSchema\n\nRe-exports [geminiGenerateContentOptionsSchema](validation/variables/geminiGenerateContentOptionsSchema.md)\n\n***\n\n### GeminiGenerateContentRequest\n\nRe-exports [GeminiGenerateContentRequest](types/interfaces/GeminiGenerateContentRequest.md)\n\n***\n\n### GeminiGenerateContentResponse\n\nRe-exports [GeminiGenerateContentResponse](types/interfaces/GeminiGenerateContentResponse.md)\n\n***\n\n### GeminiGenerationConfig\n\nRe-exports [GeminiGenerationConfig](types/interfaces/GeminiGenerationConfig.md)\n\n***\n\n### GeminiInlineData\n\nRe-exports [GeminiInlineData](types/interfaces/GeminiInlineData.md)\n\n***\n\n### GeminiPart\n\nRe-exports [GeminiPart](types/interfaces/GeminiPart.md)\n\n***\n\n### GeminiRequestBuildInput\n\nRe-exports [GeminiRequestBuildInput](types/interfaces/GeminiRequestBuildInput.md)\n\n***\n\n### GeminiRole\n\nRe-exports [GeminiRole](types/type-aliases/GeminiRole.md)\n\n***\n\n### GeminiSafetySetting\n\nRe-exports [GeminiSafetySetting](types/interfaces/GeminiSafetySetting.md)\n\n***\n\n### GeminiThinkingConfig\n\nRe-exports [GeminiThinkingConfig](types/interfaces/GeminiThinkingConfig.md)\n\n***\n\n### GeminiTool\n\nRe-exports [GeminiTool](types/interfaces/GeminiTool.md)\n\n***\n\n### GeminiToolConfig\n\nRe-exports [GeminiToolConfig](types/interfaces/GeminiToolConfig.md)\n\n***\n\n### GeminiUsageMetadata\n\nRe-exports [GeminiUsageMetadata](types/interfaces/GeminiUsageMetadata.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### mediaToGeminiInlineData\n\nRe-exports [mediaToGeminiInlineData](helpers/functions/mediaToGeminiInlineData.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### PromptAssembledObserverFn\n\nRe-exports [PromptAssembledObserverFn](../../type-aliases/PromptAssembledObserverFn.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderGeminiToolResult\n\nRe-exports [renderGeminiToolResult](helpers/functions/renderGeminiToolResult.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### sanitizeGeminiSchema\n\nRe-exports [sanitizeGeminiSchema](helpers/functions/sanitizeGeminiSchema.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### toolsToGeminiTools\n\nRe-exports [toolsToGeminiTools](helpers/functions/toolsToGeminiTools.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter","title":"@nhtio/adk/batteries/llm/gemini\\_generate\\_content/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter.md\ndescription: >-\n Cross-environment executor adapter for Google's native Gemini\n `generateContent` endpoint.\n---\n\n# @nhtio/adk/batteries/llm/gemini\\_generate\\_content/adapter\n\nCross-environment executor adapter for Google's native Gemini `generateContent` endpoint.\n\n## Remarks\n\nTargets `POST {baseURL}/models/{model}:generateContent` (and `:streamGenerateContent` when\n`stream` is set) — Gemini's OWN wire format, not an OpenAI-compatible façade in front of it.\n\nThat distinction is the reason this battery exists. Pointing `openai_chat_completions` at a\nGemini-compatible gateway means some translator, not the ADK, decides how your primitives become\n`contents[]` — including whether a `thoughtSignature` is stamped, whether consecutive same-role\nturns get merged, and how a tool result is correlated to its call. For ordinary use that is fine.\nFor anything that needs to reason about what the VENDOR actually received — an ordering guard, a\nwire-shape audit, a bug report against Google — the translation has to be ours and observable.\nSee the validation battery's \"Which API surface a rule applies to\" guide.\n\nOptions layer exactly as the other batteries: constructor baseline → `executor()` overrides →\nper-iteration `ctx.stash.geminiGenerateContent`, re-validated each iteration.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------- |\n| [GeminiGenerateContentAdapter](classes/GeminiGenerateContentAdapter.md) | Native Gemini `generateContent` executor adapter. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter/classes/GeminiGenerateContentAdapter","title":"Class: GeminiGenerateContentAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter/classes/GeminiGenerateContentAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter/classes/GeminiGenerateContentAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/adapter/classes/GeminiGenerateContentAdapter.md\ndescription: Native Gemini `generateContent` executor adapter.\n---\n\n# Class: GeminiGenerateContentAdapter\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/adapter.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/adapter.ts#L157)\n\nNative Gemini `generateContent` executor adapter.\n\n## Example\n\n```ts\nconst adapter = new GeminiGenerateContentAdapter({\n model: 'gemini-2.5-flash-lite',\n apiKey: process.env.GEMINI_API_KEY,\n})\nconst runner = new TurnRunner({ executorCallback: adapter.executor(), ... })\n```\n\n## Constructors\n\n### Constructor\n\n```ts\nnew GeminiGenerateContentAdapter(options: unknown): GeminiGenerateContentAdapter;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/adapter.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/adapter.ts#L167)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options, re-validated每 iteration after overrides merge. |\n\n#### Returns\n\n`GeminiGenerateContentAdapter`\n\n#### Throws\n\nE\\_INVALID\\_GEMINI\\_GENERATE\\_CONTENT\\_OPTIONS when `options` is invalid.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"geminiGenerateContent\"` | Per-iteration override key on `ctx.stash`. | [src/batteries/llm/gemini\\_generate\\_content/adapter.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/adapter.ts#L159) |\n\n## Methods\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/adapter.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/adapter.ts#L183)\n\nBuild a [DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to the baseline plus optional executor-scope overrides.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`GeminiGenerateContentAdapterOptions`](../../types/interfaces/GeminiGenerateContentAdapterOptions.md)> | Higher precedence than the baseline, lower than `ctx.stash`. |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### isGeminiGenerateContentAdapter()\n\n```ts\nstatic isGeminiGenerateContentAdapter(value: unknown): value is GeminiGenerateContentAdapter;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/adapter.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/adapter.ts#L172)\n\nNarrowing guard for cross-realm instances.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n#### Returns\n\n`value is GeminiGenerateContentAdapter`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions","title":"@nhtio/adk/batteries/llm/gemini\\_generate\\_content/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions.md\ndescription: >-\n Battery-scoped exception constructors for the native Gemini `generateContent`\n adapter.\n---\n\n# @nhtio/adk/batteries/llm/gemini\\_generate\\_content/exceptions\n\nBattery-scoped exception constructors for the native Gemini `generateContent` adapter.\n\n## Remarks\n\nOwned by the battery, not the ADK core, and minted via `createException` from\n`@nhtio/adk/factories`. The set mirrors the other chat batteries with one Gemini-specific\naddition: [E\\_GEMINI\\_MISSING\\_THOUGHT\\_SIGNATURE](variables/E_GEMINI_MISSING_THOUGHT_SIGNATURE.md), which classifies the vendor's own hard\nrejection of unsigned historical function calls so a caller can tell it apart from a generic\ninvalid-request — Gemini's error body is otherwise an opaque `INVALID_ARGUMENT`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |\n| [E\\_GEMINI\\_GENERATE\\_CONTENT\\_CONTEXT\\_OVERFLOW](variables/E_GEMINI_GENERATE_CONTENT_CONTEXT_OVERFLOW.md) | Context token weight exceeded the configured window. |\n| [E\\_GEMINI\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_GEMINI_INVALID_TOOL_CALL_ARGS.md) | A `functionCall` part carried an `args` value that is not a plain object. |\n| [E\\_GEMINI\\_MISSING\\_THOUGHT\\_SIGNATURE](variables/E_GEMINI_MISSING_THOUGHT_SIGNATURE.md) | Gemini rejected the request because a historical `functionCall` part carried no `thoughtSignature`. |\n| [E\\_GEMINI\\_REQUEST\\_FAILED](variables/E_GEMINI_REQUEST_FAILED.md) | The provider returned a non-2xx status. |\n| [E\\_GEMINI\\_STREAM\\_ERROR](variables/E_GEMINI_STREAM_ERROR.md) | A transport error or malformed frame killed the stream mid-generation. |\n| [E\\_INVALID\\_GEMINI\\_GENERATE\\_CONTENT\\_OPTIONS](variables/E_INVALID_GEMINI_GENERATE_CONTENT_OPTIONS.md) | Resolved options (constructor, executor overrides, or `stash.geminiGenerateContent`) failed validation. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_GENERATE_CONTENT_CONTEXT_OVERFLOW","title":"Variable: E\\_GEMINI\\_GENERATE\\_CONTENT\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_GENERATE_CONTENT_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_GENERATE_CONTENT_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_GENERATE_CONTENT_CONTEXT_OVERFLOW.md\ndescription: Context token weight exceeded the configured window.\n---\n\n# Variable: E\\_GEMINI\\_GENERATE\\_CONTENT\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_GEMINI_GENERATE_CONTENT_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string]\n>;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/exceptions.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/exceptions.ts#L26)\n\nContext token weight exceeded the configured window.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_GEMINI\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_INVALID_TOOL_CALL_ARGS.md\ndescription: A `functionCall` part carried an `args` value that is not a plain object.\n---\n\n# Variable: E\\_GEMINI\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_GEMINI_INVALID_TOOL_CALL_ARGS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/exceptions.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/exceptions.ts#L70)\n\nA `functionCall` part carried an `args` value that is not a plain object.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_MISSING_THOUGHT_SIGNATURE","title":"Variable: E\\_GEMINI\\_MISSING\\_THOUGHT\\_SIGNATURE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_MISSING_THOUGHT_SIGNATURE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_MISSING_THOUGHT_SIGNATURE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_MISSING_THOUGHT_SIGNATURE.md\ndescription: >-\n Gemini rejected the request because a historical `functionCall` part carried\n no `thoughtSignature`.\n---\n\n# Variable: E\\_GEMINI\\_MISSING\\_THOUGHT\\_SIGNATURE\n\n```ts\nconst E_GEMINI_MISSING_THOUGHT_SIGNATURE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/exceptions.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/exceptions.ts#L52)\n\nGemini rejected the request because a historical `functionCall` part carried no\n`thoughtSignature`.\n\n## Remarks\n\nDistinguished from a generic invalid-request because it is ACTIONABLE: the caller either replays\na genuine signature, or opts into the documented sentinel via\n`thoughtSignatureSentinel`. Gemini 3+ enforces this; 2.5 treats it as advisory.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_REQUEST_FAILED","title":"Variable: E\\_GEMINI\\_REQUEST\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_REQUEST_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_REQUEST_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_REQUEST_FAILED.md\ndescription: The provider returned a non-2xx status.\n---\n\n# Variable: E\\_GEMINI\\_REQUEST\\_FAILED\n\n```ts\nconst E_GEMINI_REQUEST_FAILED: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/exceptions.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/exceptions.ts#L35)\n\nThe provider returned a non-2xx status.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_STREAM_ERROR","title":"Variable: E\\_GEMINI\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_GEMINI_STREAM_ERROR.md\ndescription: A transport error or malformed frame killed the stream mid-generation.\n---\n\n# Variable: E\\_GEMINI\\_STREAM\\_ERROR\n\n```ts\nconst E_GEMINI_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/exceptions.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/exceptions.ts#L61)\n\nA transport error or malformed frame killed the stream mid-generation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_INVALID_GEMINI_GENERATE_CONTENT_OPTIONS","title":"Variable: E\\_INVALID\\_GEMINI\\_GENERATE\\_CONTENT\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_INVALID_GEMINI_GENERATE_CONTENT_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_INVALID_GEMINI_GENERATE_CONTENT_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/exceptions/variables/E_INVALID_GEMINI_GENERATE_CONTENT_OPTIONS.md\ndescription: >-\n Resolved options (constructor, executor overrides, or\n `stash.geminiGenerateContent`) failed validation.\n---\n\n# Variable: E\\_INVALID\\_GEMINI\\_GENERATE\\_CONTENT\\_OPTIONS\n\n```ts\nconst E_INVALID_GEMINI_GENERATE_CONTENT_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/exceptions.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/exceptions.ts#L17)\n\nResolved options (constructor, executor overrides, or `stash.geminiGenerateContent`) failed validation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers","title":"@nhtio/adk/batteries/llm/gemini\\_generate\\_content/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers.md\ndescription: Translation helpers for the native Gemini `generateContent` battery.\n---\n\n# @nhtio/adk/batteries/llm/gemini\\_generate\\_content/helpers\n\nTranslation helpers for the native Gemini `generateContent` battery.\n\n## Remarks\n\nEvery function is injectable via GeminiGenerateContentAdapterOptions.helpers and has a\n`default*` alias. The wire-shape-agnostic renderers (untrusted/trusted envelopes, memories,\nretrievables, thought envelopes, the system-prompt assembler) are re-exported unchanged from the\nshared internal `../chat_common/helpers`; only the parts that are genuinely Gemini-shaped live\nhere.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| [DEFAULT\\_GEMINI\\_BUCKET\\_ORDER](variables/DEFAULT_GEMINI_BUCKET_ORDER.md) | Default context-bucket order for the system instruction. |\n| [defaultBuildGeminiRequest](variables/defaultBuildGeminiRequest.md) | Default implementation; alias of [buildGeminiRequest](functions/buildGeminiRequest.md). |\n| [defaultExtractGeminiGeneration](variables/defaultExtractGeminiGeneration.md) | Default implementation; alias of [extractGeminiGeneration](functions/extractGeminiGeneration.md). |\n| [defaultMediaToGeminiInlineData](variables/defaultMediaToGeminiInlineData.md) | Default implementation; alias of [mediaToGeminiInlineData](functions/mediaToGeminiInlineData.md). |\n| [defaultRenderGeminiToolResult](variables/defaultRenderGeminiToolResult.md) | Default implementation; alias of [renderGeminiToolResult](functions/renderGeminiToolResult.md). |\n| [defaultSanitizeGeminiSchema](variables/defaultSanitizeGeminiSchema.md) | Default implementation; alias of [sanitizeGeminiSchema](functions/sanitizeGeminiSchema.md). |\n| [defaultToolsToGeminiTools](variables/defaultToolsToGeminiTools.md) | Default implementation; alias of [toolsToGeminiTools](functions/toolsToGeminiTools.md). |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------- | ------------------------------------------------------------------- |\n| [buildGeminiRequest](functions/buildGeminiRequest.md) | Assemble the native request from ADK turn state. THE ordering seam. |\n| [extractGeminiGeneration](functions/extractGeminiGeneration.md) | Extract text, reasoning, and function calls from a response. |\n| [mediaToGeminiInlineData](functions/mediaToGeminiInlineData.md) | Decode an ADK Media into Gemini's `inlineData`. |\n| [renderGeminiToolResult](functions/renderGeminiToolResult.md) | Render one tool result into a `functionResponse.response` object. |\n| [sanitizeGeminiSchema](functions/sanitizeGeminiSchema.md) | Recursively strip schema keywords Gemini rejects. |\n| [toolsToGeminiTools](functions/toolsToGeminiTools.md) | ADK tools → native `functionDeclarations`. |\n\n## References\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/buildGeminiRequest","title":"Function: buildGeminiRequest()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/buildGeminiRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/buildGeminiRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/buildGeminiRequest.md\n---\n\n# Function: buildGeminiRequest()\n\n```ts\nfunction buildGeminiRequest(\n input: GeminiRequestBuildInput,\n): Promise;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L257)\n\nAssemble the native request from ADK turn state. THE ordering seam.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------------------ |\n| `input` | [`GeminiRequestBuildInput`](../../types/interfaces/GeminiRequestBuildInput.md) |\n\n## Returns\n\n`Promise`<[`GeminiGenerateContentRequest`](../../types/interfaces/GeminiGenerateContentRequest.md)>\n\n## Remarks\n\nThe translation that makes this battery different from pointing `openai_chat_completions` at a\nGemini gateway:\n\n* System text goes to `systemInstruction`, not a `contents[]` turn.\n* `Message.role: 'assistant'` becomes `role: 'model'`.\n* A `ToolCall` becomes TWO turns: a `model` turn with a `functionCall` part, then a `user` turn\n with a `functionResponse` part. `functionResponse.name` carries the DECLARED tool name,\n because Gemini has no call-id correlation.\n* Timeline order is `createdAt`, matching the ordering guard's own view, so what the guard\n validates is what gets dispatched.\n* The thought-signature sentinel is stamped on the FIRST `functionCall` only when no part\n already carries a real signature and the caller has not opted out. Preserving a genuine\n signature matters: it is prefix-bound, and replacing one invalidates it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/extractGeminiGeneration","title":"Function: extractGeminiGeneration()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/extractGeminiGeneration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/extractGeminiGeneration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/extractGeminiGeneration.md\n---\n\n# Function: extractGeminiGeneration()\n\n```ts\nfunction extractGeminiGeneration(\n response:\n | {\n candidates?: {\n content?: GeminiContent;\n finishReason?: string;\n }[];\n }\n | undefined,\n): {\n finishReason: string | undefined;\n functionCalls: {\n args: Record;\n name: string;\n thoughtSignature?: string;\n }[];\n reasoning: string;\n text: string;\n};\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:395](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L395)\n\nExtract text, reasoning, and function calls from a response.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `response` | | { `candidates?`: { `content?`: [`GeminiContent`](../../types/interfaces/GeminiContent.md); `finishReason?`: `string`; }\\[]; } | `undefined` |\n\n## Returns\n\n```ts\n{\n finishReason: string | undefined;\n functionCalls: {\n args: Record;\n name: string;\n thoughtSignature?: string;\n }[];\n reasoning: string;\n text: string;\n}\n```\n\n| Name | Type | Defined in |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `finishReason` | `string` | `undefined` | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:401](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L401) |\n| `functionCalls` | { `args`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `name`: `string`; `thoughtSignature?`: `string`; }\\[] | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:400](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L400) |\n| `reasoning` | `string` | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:399](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L399) |\n| `text` | `string` | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:398](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L398) |\n\n## Remarks\n\n`thought: true` parts are reasoning and must NOT be concatenated into user-visible text — doing\nso leaks the model's scratchpad into the answer.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/mediaToGeminiInlineData","title":"Function: mediaToGeminiInlineData()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/mediaToGeminiInlineData.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/mediaToGeminiInlineData","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/mediaToGeminiInlineData.md\n---\n\n# Function: mediaToGeminiInlineData()\n\n```ts\nfunction mediaToGeminiInlineData(media: Media): Promise;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L222)\n\nDecode an ADK Media into Gemini's `inlineData`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------- |\n| `media` | [`Media`](../../../../../common/classes/Media.md) |\n\n## Returns\n\n`Promise`<[`GeminiInlineData`](../../types/interfaces/GeminiInlineData.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/renderGeminiToolResult","title":"Function: renderGeminiToolResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/renderGeminiToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/renderGeminiToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/renderGeminiToolResult.md\n---\n\n# Function: renderGeminiToolResult()\n\n```ts\nfunction renderGeminiToolResult(input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy | undefined;\n warn?: (message: string) => void;\n}): Promise>;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:194](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L194)\n\nRender one tool result into a `functionResponse.response` object.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined`; `warn?`: (`message`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined` |\n| `input.warn?` | (`message`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>>\n\n## Remarks\n\nGemini requires an OBJECT here, not a bare string — a string is rejected. Text is therefore\nwrapped as `{ result: }`, keeping the untrusted-content envelope the other batteries use\nso a tool result cannot impersonate a system directive.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/sanitizeGeminiSchema","title":"Function: sanitizeGeminiSchema()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/sanitizeGeminiSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/sanitizeGeminiSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/sanitizeGeminiSchema.md\n---\n\n# Function: sanitizeGeminiSchema()\n\n```ts\nfunction sanitizeGeminiSchema(schema: unknown): JsonSchema;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L142)\n\nRecursively strip schema keywords Gemini rejects.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------- |\n| `schema` | `unknown` | Any JSON-Schema-shaped value. |\n\n## Returns\n\n[`JsonSchema`](../../../../interfaces/JsonSchema.md)\n\nThe same shape with unsupported keywords removed.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/toolsToGeminiTools","title":"Function: toolsToGeminiTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/toolsToGeminiTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/toolsToGeminiTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/toolsToGeminiTools.md\n---\n\n# Function: toolsToGeminiTools()\n\n```ts\nfunction toolsToGeminiTools(\n tools: Iterable | ArtifactTool>,\n): GeminiTool[];\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L164)\n\nADK tools → native `functionDeclarations`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | `Iterable`< | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md)> |\n\n## Returns\n\n[`GeminiTool`](../../types/interfaces/GeminiTool.md)\\[]\n\n## Remarks\n\nNames are normalised through the shared `normalizeToolName` so a tool whose ADK name contains\ncharacters Gemini rejects still resolves; `functionResponse.name` must later match whatever this\nproduced, which is why both sides call the same normaliser.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/DEFAULT_GEMINI_BUCKET_ORDER","title":"Variable: DEFAULT\\_GEMINI\\_BUCKET\\_ORDER","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/DEFAULT_GEMINI_BUCKET_ORDER.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/DEFAULT_GEMINI_BUCKET_ORDER","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/DEFAULT_GEMINI_BUCKET_ORDER.md\ndescription: Default context-bucket order for the system instruction.\n---\n\n# Variable: DEFAULT\\_GEMINI\\_BUCKET\\_ORDER\n\n```ts\nconst DEFAULT_GEMINI_BUCKET_ORDER: readonly [\n \"standingInstructions\",\n \"memories\",\n \"retrievables\",\n \"timeline\",\n];\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L98)\n\nDefault context-bucket order for the system instruction.\n\n## Remarks\n\nMatches the other chat batteries so a consumer switching batteries gets the same system-prompt\nlayout. Exported so a caller can reorder without reconstructing the whole list.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultBuildGeminiRequest","title":"Variable: defaultBuildGeminiRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultBuildGeminiRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultBuildGeminiRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultBuildGeminiRequest.md\ndescription: 'Default implementation; alias of [`buildGeminiRequest`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/buildGeminiRequest).'\n---\n\n# Variable: defaultBuildGeminiRequest\n\n```ts\nconst defaultBuildGeminiRequest: (\n input: GeminiRequestBuildInput,\n) => Promise = buildGeminiRequest;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:386](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L386)\n\nDefault implementation; alias of [buildGeminiRequest](../functions/buildGeminiRequest.md).\n\nAssemble the native request from ADK turn state. THE ordering seam.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------------------ |\n| `input` | [`GeminiRequestBuildInput`](../../types/interfaces/GeminiRequestBuildInput.md) |\n\n## Returns\n\n`Promise`<[`GeminiGenerateContentRequest`](../../types/interfaces/GeminiGenerateContentRequest.md)>\n\n## Remarks\n\nThe translation that makes this battery different from pointing `openai_chat_completions` at a\nGemini gateway:\n\n* System text goes to `systemInstruction`, not a `contents[]` turn.\n* `Message.role: 'assistant'` becomes `role: 'model'`.\n* A `ToolCall` becomes TWO turns: a `model` turn with a `functionCall` part, then a `user` turn\n with a `functionResponse` part. `functionResponse.name` carries the DECLARED tool name,\n because Gemini has no call-id correlation.\n* Timeline order is `createdAt`, matching the ordering guard's own view, so what the guard\n validates is what gets dispatched.\n* The thought-signature sentinel is stamped on the FIRST `functionCall` only when no part\n already carries a real signature and the caller has not opted out. Preserving a genuine\n signature matters: it is prefix-bound, and replacing one invalidates it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultExtractGeminiGeneration","title":"Variable: defaultExtractGeminiGeneration","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultExtractGeminiGeneration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultExtractGeminiGeneration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultExtractGeminiGeneration.md\ndescription: 'Default implementation; alias of [`extractGeminiGeneration`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/extractGeminiGeneration).'\n---\n\n# Variable: defaultExtractGeminiGeneration\n\n```ts\nconst defaultExtractGeminiGeneration: (\n response:\n | {\n candidates?: {\n content?: GeminiContent;\n finishReason?: string;\n }[];\n }\n | undefined,\n) => {\n finishReason: string | undefined;\n functionCalls: {\n args: Record;\n name: string;\n thoughtSignature?: string;\n }[];\n reasoning: string;\n text: string;\n} = extractGeminiGeneration;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:429](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L429)\n\nDefault implementation; alias of [extractGeminiGeneration](../functions/extractGeminiGeneration.md).\n\nExtract text, reasoning, and function calls from a response.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `response` | | { `candidates?`: { `content?`: [`GeminiContent`](../../types/interfaces/GeminiContent.md); `finishReason?`: `string`; }\\[]; } | `undefined` |\n\n## Returns\n\n```ts\n{\n finishReason: string | undefined;\n functionCalls: {\n args: Record;\n name: string;\n thoughtSignature?: string;\n }[];\n reasoning: string;\n text: string;\n}\n```\n\n| Name | Type | Defined in |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `finishReason` | `string` | `undefined` | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:401](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L401) |\n| `functionCalls` | { `args`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `name`: `string`; `thoughtSignature?`: `string`; }\\[] | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:400](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L400) |\n| `reasoning` | `string` | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:399](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L399) |\n| `text` | `string` | [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:398](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L398) |\n\n## Remarks\n\n`thought: true` parts are reasoning and must NOT be concatenated into user-visible text — doing\nso leaks the model's scratchpad into the answer.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultMediaToGeminiInlineData","title":"Variable: defaultMediaToGeminiInlineData","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultMediaToGeminiInlineData.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultMediaToGeminiInlineData","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultMediaToGeminiInlineData.md\ndescription: 'Default implementation; alias of [`mediaToGeminiInlineData`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/mediaToGeminiInlineData).'\n---\n\n# Variable: defaultMediaToGeminiInlineData\n\n```ts\nconst defaultMediaToGeminiInlineData: (\n media: Media,\n) => Promise = mediaToGeminiInlineData;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L237)\n\nDefault implementation; alias of [mediaToGeminiInlineData](../functions/mediaToGeminiInlineData.md).\n\nDecode an ADK Media into Gemini's `inlineData`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------- |\n| `media` | [`Media`](../../../../../common/classes/Media.md) |\n\n## Returns\n\n`Promise`<[`GeminiInlineData`](../../types/interfaces/GeminiInlineData.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultRenderGeminiToolResult","title":"Variable: defaultRenderGeminiToolResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultRenderGeminiToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultRenderGeminiToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultRenderGeminiToolResult.md\ndescription: 'Default implementation; alias of [`renderGeminiToolResult`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/renderGeminiToolResult).'\n---\n\n# Variable: defaultRenderGeminiToolResult\n\n```ts\nconst defaultRenderGeminiToolResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy | undefined;\n warn?: (message: string) => void;\n}) => Promise> = renderGeminiToolResult;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L219)\n\nDefault implementation; alias of [renderGeminiToolResult](../functions/renderGeminiToolResult.md).\n\nRender one tool result into a `functionResponse.response` object.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined`; `warn?`: (`message`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined` |\n| `input.warn?` | (`message`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>>\n\n## Remarks\n\nGemini requires an OBJECT here, not a bare string — a string is rejected. Text is therefore\nwrapped as `{ result: }`, keeping the untrusted-content envelope the other batteries use\nso a tool result cannot impersonate a system directive.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultSanitizeGeminiSchema","title":"Variable: defaultSanitizeGeminiSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultSanitizeGeminiSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultSanitizeGeminiSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultSanitizeGeminiSchema.md\ndescription: 'Default implementation; alias of [`sanitizeGeminiSchema`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/sanitizeGeminiSchema).'\n---\n\n# Variable: defaultSanitizeGeminiSchema\n\n```ts\nconst defaultSanitizeGeminiSchema: (schema: unknown) => JsonSchema =\n sanitizeGeminiSchema;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L154)\n\nDefault implementation; alias of [sanitizeGeminiSchema](../functions/sanitizeGeminiSchema.md).\n\nRecursively strip schema keywords Gemini rejects.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------- |\n| `schema` | `unknown` | Any JSON-Schema-shaped value. |\n\n## Returns\n\n[`JsonSchema`](../../../../interfaces/JsonSchema.md)\n\nThe same shape with unsupported keywords removed.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultToolsToGeminiTools","title":"Variable: defaultToolsToGeminiTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultToolsToGeminiTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultToolsToGeminiTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/variables/defaultToolsToGeminiTools.md\ndescription: 'Default implementation; alias of [`toolsToGeminiTools`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/helpers/functions/toolsToGeminiTools).'\n---\n\n# Variable: defaultToolsToGeminiTools\n\n```ts\nconst defaultToolsToGeminiTools: (\n tools: Iterable | ArtifactTool>,\n) => GeminiTool[] = toolsToGeminiTools;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/helpers.ts:184](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/helpers.ts#L184)\n\nDefault implementation; alias of [toolsToGeminiTools](../functions/toolsToGeminiTools.md).\n\nADK tools → native `functionDeclarations`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | `Iterable`< | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md)> |\n\n## Returns\n\n[`GeminiTool`](../../types/interfaces/GeminiTool.md)\\[]\n\n## Remarks\n\nNames are normalised through the shared `normalizeToolName` so a tool whose ADK name contains\ncharacters Gemini rejects still resolves; `functionResponse.name` must later match whatever this\nproduced, which is why both sides call the same normaliser.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types","title":"@nhtio/adk/batteries/llm/gemini\\_generate\\_content/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types.md\ndescription: >-\n Wire shapes, helper contracts, and option types for the native Gemini\n `generateContent` battery.\n---\n\n# @nhtio/adk/batteries/llm/gemini\\_generate\\_content/types\n\nWire shapes, helper contracts, and option types for the native Gemini `generateContent` battery.\n\n## Remarks\n\nGemini's native surface differs from OpenAI Chat Completions in every structural respect, which\nis why pointing the `openai_chat_completions` battery at a Gemini-compatible gateway is not\nequivalent to speaking `generateContent`:\n\n* Turns are `contents[]`, not `messages[]`, and the assistant role is **`model`**, not\n `assistant`. There is no `system` role: system text goes in a separate top-level\n `systemInstruction`.\n* A turn's payload is `parts[]` — a heterogeneous array. A tool call is a `functionCall` part on\n a `model` turn; its result is a `functionResponse` part on a **`user`** turn. So the\n OpenAI-shaped \"assistant with tool\\_calls, then a tool-role message\" becomes\n \"model turn with a functionCall part, then a user turn with a functionResponse part\".\n* `functionResponse.name` must match the DECLARED tool name, not a call id. Gemini has no\n `tool_call_id` concept, so correlation is positional/by-name.\n* Gemini 3+ rejects a historical `functionCall` part that carries no `thoughtSignature`. Google\n documents two portable sentinels for replaying traces that did not originate from Gemini; see\n [GeminiGenerateContentAdapterOptions.thoughtSignatureSentinel](interfaces/GeminiGenerateContentAdapterOptions.md#property-thoughtsignaturesentinel).\n* Generation settings live under `generationConfig` (`maxOutputTokens`, `temperature`, `topP`,\n `topK`, `stopSequences`, `thinkingConfig`), and tools under `tools[].functionDeclarations[]`.\n\nWire-shape-agnostic types (`JsonSchema`, the attribute envelopes, `UnsupportedMediaPolicy`, the\nbucket order, the retry config, the observability taps) come from the shared internal\n`../chat_common/types` submodule and are re-exported so consumers of this battery get a\nself-contained type surface.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |\n| [GeminiCandidate](interfaces/GeminiCandidate.md) | One generation candidate. |\n| [GeminiContent](interfaces/GeminiContent.md) | One conversation turn. |\n| [GeminiFunctionCall](interfaces/GeminiFunctionCall.md) | A model-emitted request to invoke a declared function. |\n| [GeminiFunctionDeclaration](interfaces/GeminiFunctionDeclaration.md) | A tool Gemini may call, in its native declaration shape. |\n| [GeminiFunctionResponse](interfaces/GeminiFunctionResponse.md) | The result of a function invocation, sent back on a `user` turn. |\n| [GeminiGenerateContentAdapterOptions](interfaces/GeminiGenerateContentAdapterOptions.md) | Constructor and per-dispatch options. |\n| [GeminiGenerateContentHelpers](interfaces/GeminiGenerateContentHelpers.md) | The injectable translation seam. |\n| [GeminiGenerateContentRequest](interfaces/GeminiGenerateContentRequest.md) | The complete `:generateContent` request body. |\n| [GeminiGenerateContentResponse](interfaces/GeminiGenerateContentResponse.md) | The `:generateContent` response body (also each SSE frame of `:streamGenerateContent`). |\n| [GeminiGenerationConfig](interfaces/GeminiGenerationConfig.md) | Sampling and output controls. |\n| [GeminiInlineData](interfaces/GeminiInlineData.md) | Inline binary data (image/audio/etc.) as Gemini carries it. |\n| [GeminiPart](interfaces/GeminiPart.md) | One element of a turn's `parts[]`. |\n| [GeminiRequestBuildInput](interfaces/GeminiRequestBuildInput.md) | Everything `buildGeminiRequest` needs to assemble a request. |\n| [GeminiSafetySetting](interfaces/GeminiSafetySetting.md) | One safety-filter setting. |\n| [GeminiThinkingConfig](interfaces/GeminiThinkingConfig.md) | Reasoning-budget controls. |\n| [GeminiTool](interfaces/GeminiTool.md) | The `tools[]` entry wrapping function declarations. |\n| [GeminiToolConfig](interfaces/GeminiToolConfig.md) | Forces, permits, or forbids function calling. |\n| [GeminiUsageMetadata](interfaces/GeminiUsageMetadata.md) | Per-candidate token accounting. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------- | -------------------------------------------------- |\n| [GeminiRole](type-aliases/GeminiRole.md) | A conversation role on the `generateContent` wire. |\n\n## References\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../../interfaces/MemoryAttrs.md)\n\n***\n\n### PromptAssembledObserverFn\n\nRe-exports [PromptAssembledObserverFn](../../../type-aliases/PromptAssembledObserverFn.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../../../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../../interfaces/UntrustedContentAttrs.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiCandidate","title":"Interface: GeminiCandidate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiCandidate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiCandidate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiCandidate.md\ndescription: One generation candidate.\n---\n\n# Interface: GeminiCandidate\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L243)\n\nOne generation candidate.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | [`GeminiContent`](GeminiContent.md) | The generated turn. Absent when the candidate was filtered. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L245) |\n| `finishReason?` | `string` | `STOP`, `MAX_TOKENS`, `SAFETY`, `RECITATION`, `OTHER`, … | [src/batteries/llm/gemini\\_generate\\_content/types.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L247) |\n| `index?` | `number` | Candidate ordinal when more than one was requested. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L249) |\n| `safetyRatings?` | { `category`: `string`; `probability`: `string`; }\\[] | Per-category safety scores for this candidate. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L251) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiContent","title":"Interface: GeminiContent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiContent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiContent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiContent.md\ndescription: One conversation turn.\n---\n\n# Interface: GeminiContent\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L143)\n\nOne conversation turn.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | --------------------------------------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `parts` | [`GeminiPart`](GeminiPart.md)\\[] | Heterogeneous payload; one turn may mix text, calls, and results. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L147) |\n| `role` | [`GeminiRole`](../type-aliases/GeminiRole.md) | `'user'` or `'model'` — never `'assistant'`, never `'system'`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L145) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionCall","title":"Interface: GeminiFunctionCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionCall.md\ndescription: A model-emitted request to invoke a declared function.\n---\n\n# Interface: GeminiFunctionCall\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L98)\n\nA model-emitted request to invoke a declared function.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `args?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Arguments the model chose. Absent for a zero-arg call. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L102) |\n| `name` | `string` | Must match a declared `functionDeclarations[].name`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L100) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionDeclaration","title":"Interface: GeminiFunctionDeclaration","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionDeclaration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionDeclaration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionDeclaration.md\ndescription: 'A tool Gemini may call, in its native declaration shape.'\n---\n\n# Interface: GeminiFunctionDeclaration\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L151)\n\nA tool Gemini may call, in its native declaration shape.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `description?` | `string` | What the tool does; the model's only guidance for choosing it. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L155) |\n| `name` | `string` | Name the model must use in `functionCall.name`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L153) |\n| `parameters?` | [`JsonSchema`](../../../../interfaces/JsonSchema.md) | OpenAPI-subset schema. Gemini rejects several JSON-Schema keywords; see `helpers.ts`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L157) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionResponse","title":"Interface: GeminiFunctionResponse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionResponse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionResponse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiFunctionResponse.md\ndescription: 'The result of a function invocation, sent back on a `user` turn.'\n---\n\n# Interface: GeminiFunctionResponse\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L112)\n\nThe result of a function invocation, sent back on a `user` turn.\n\n## Remarks\n\n`name` is the DECLARED FUNCTION NAME, not a call id — Gemini has no `tool_call_id`. A mismatched\nname is a common source of opaque `INVALID_ARGUMENT` rejections.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `name` | `string` | The DECLARED function name — not a call id. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L114) |\n| `response` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Result payload. Gemini requires an OBJECT here; a bare string is rejected. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L116) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentAdapterOptions","title":"Interface: GeminiGenerateContentAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentAdapterOptions.md\ndescription: Constructor and per-dispatch options.\n---\n\n# Interface: GeminiGenerateContentAdapterOptions\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:343](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L343)\n\nConstructor and per-dispatch options.\n\n## Remarks\n\nLayered exactly like the other batteries: constructor baseline, then executor-scope overrides,\nthen per-iteration `ctx.stash` overrides, re-validated each iteration.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | API key. Sent as `x-goog-api-key` unless [useBearerAuth](#property-usebearerauth) is set. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:347](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L347) |\n| `autoAck?` | `boolean` | Whether to acknowledge tool-call-free generations; defaults to true. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:404](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L404) |\n| `baseURL?` | `string` | Defaults to `https://generativelanguage.googleapis.com/v1beta`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:357](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L357) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Order of context buckets in the system instruction. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L408) |\n| `contextWindow?` | `number` | Maximum token weight allowed for the assembled context. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:402](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L402) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Injectable `fetch`, for tests or a custom transport. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:398](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L398) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | Narrow the artifact-reader tools forged from prior-turn results before they merge in. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:428](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L428) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`GeminiGenerateContentHelpers`](GeminiGenerateContentHelpers.md)> | Override any translation helper; unset entries fall back to the `default*` implementation. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:426](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L426) |\n| `localToolCallParser?` | | [`ToolCallParserName`](../../../transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) | Recover tool calls the provider returned as prose rather than `functionCall` parts. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:414](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L414) |\n| `maxOutputTokens?` | `number` | Upper bound on generated tokens. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L361) |\n| `model` | `string` | Model id, e.g. `gemini-2.5-flash-lite`. Prefer a CONCRETE id over a floating alias. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:345](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L345) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | Observe the assembled request the instant before dispatch. **Remarks** The honest way to check what a vendor actually received — see the validation battery's \"Which API surface a rule applies to\" guide. An ADK-control key: stripped from the wire body. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:424](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L424) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | Observe the raw generation. Purely observational; errors swallowed. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:416](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L416) |\n| `retry?` | [`ChatCompletionsRetryConfig`](../../../../interfaces/ChatCompletionsRetryConfig.md) | Retry/backoff policy for transport failures. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:396](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L396) |\n| `safetySettings?` | [`GeminiSafetySetting`](GeminiSafetySetting.md)\\[] | Per-category safety-filter overrides. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:373](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L373) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | Spool store backing artifact-handle results. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:406](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L406) |\n| `stopSequences?` | `string`\\[] | Sequences that halt generation. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:369](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L369) |\n| `stream?` | `boolean` | Use `:streamGenerateContent` (SSE) instead of `:generateContent`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L359) |\n| `temperature?` | `number` | Sampling temperature. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:363](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L363) |\n| `thinkingConfig?` | [`GeminiThinkingConfig`](GeminiThinkingConfig.md) | Reasoning-budget controls. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L371) |\n| `thoughtSignatureSentinel?` | `string` | `false` | Sentinel to stamp on the first historical `functionCall` part that carries no `thoughtSignature`, or `false` to send history untouched. **Remarks** Gemini 3+ REJECTS a historical `functionCall` with no signature. When history did not originate from Gemini (a replay, a model switch, a cross-vendor panel) there is no genuine signature to send, and Google documents two portable sentinels for exactly that case — `'skip_thought_signature_validator'` (Gemini API and Vertex) and `'context_engineering_is_the_way_to_go'` (Gemini API only). Defaults to `'skip_thought_signature_validator'` because the alternative is a hard 400 on any non-Gemini-originated tool history. It is nonetheless a PROVENANCE CLAIM about reasoning the model did not produce, and Google cautions it may degrade quality relative to a real signature — set `false` to opt out and surface the vendor's own error instead. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:392](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L392) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Which reasoning to replay. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:410](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L410) |\n| `timeoutMs?` | `number` | Per-request timeout. Falls back to the dispatch abort signal when absent. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:394](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L394) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | Encoding used for token accounting; `null` explicitly disables token accounting. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:400](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L400) |\n| `toolConfig?` | [`GeminiToolConfig`](GeminiToolConfig.md) | Force, permit, or forbid function calling. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:375](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L375) |\n| `topK?` | `number` | Top-k sampling cutoff. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L367) |\n| `topP?` | `number` | Nucleus-sampling threshold. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L365) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | What to do with a modality Gemini cannot accept. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:412](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L412) |\n| `useBearerAuth?` | `boolean` | Send the key as `Authorization: Bearer` instead of `x-goog-api-key`. **Remarks** Google's own endpoint wants `x-goog-api-key`; several gateways in front of it accept only `Authorization`. Default `false`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:355](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L355) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentHelpers","title":"Interface: GeminiGenerateContentHelpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentHelpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentHelpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentHelpers.md\ndescription: The injectable translation seam.\n---\n\n# Interface: GeminiGenerateContentHelpers\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:277](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L277)\n\nThe injectable translation seam.\n\n## Remarks\n\nMirrors the other batteries: every function here has a `default*` implementation and can be\nreplaced per-adapter. `buildGeminiRequest` is the one that matters for ordering work — it is\nwhere ADK primitives become `contents[]`, so a consumer whose vendor needs a different shape\noverrides it rather than forking the battery.\n\n## Extends\n\n* [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buildGeminiRequest` | (`input`: [`GeminiRequestBuildInput`](GeminiRequestBuildInput.md)) => `Promise`<[`GeminiGenerateContentRequest`](GeminiGenerateContentRequest.md)> | Assemble the full request from turn state. The primary ordering seam. | - | [src/batteries/llm/gemini\\_generate\\_content/types.ts:291](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L291) |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`descriptionToChatCompletionsJsonSchema`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema) | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`filterThoughts`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts) | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) tool result: metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam. When omitted the battery uses the shared defaultRenderArtifactHandleBody. A consumer overrides it to change WHICH reader the model is steered toward first — e.g. promoting the JSON content-readers (`artifact_json_get` / `artifact_json_keys`) ahead of the metadata-only `artifact_json_type` for a small model that grabs the first listed tool. The tool list itself comes from the artifact's `constructor.toolMethods`; an override typically reorders or re-annotates that list before delegating to the default renderer. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderArtifactHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody) | [src/batteries/llm/chat\\_common/types.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L571) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderChatCompletionsSystemPrompt`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt) | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderFirstPartyRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables) | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderGeminiToolResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined`; `warn?`: (`message`: `string`) => `void`; }) => `Promise`<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>> | Render one tool result into a `functionResponse.response` object. | - | [src/batteries/llm/gemini\\_generate\\_content/types.ts:281](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L281) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderMemories`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories) | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md) whose content is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam, the retrievable-side counterpart to [renderArtifactHandleBody](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody). When omitted the battery uses the shared defaultRenderRetrievableHandleBody. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablehandlebody) | [src/batteries/llm/chat\\_common/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L588) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables) | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableSafetyDirective`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective) | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderStandingInstructions`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions) | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPrivateRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables) | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPublicRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables) | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThought`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought) | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderTrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderUntrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`toolsToChatCompletionsTools`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools) | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n| `toolsToGeminiTools` | (`tools`: `Iterable`< | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md)>) => [`GeminiTool`](GeminiTool.md)\\[] | ADK tools → native `functionDeclarations`. | - | [src/batteries/llm/gemini\\_generate\\_content/types.ts:279](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L279) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentRequest","title":"Interface: GeminiGenerateContentRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentRequest.md\ndescription: 'The complete `:generateContent` request body.'\n---\n\n# Interface: GeminiGenerateContentRequest\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L213)\n\nThe complete `:generateContent` request body.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | ----------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `contents` | [`GeminiContent`](GeminiContent.md)\\[] | The conversation, in order. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L215) |\n| `generationConfig?` | [`GeminiGenerationConfig`](GeminiGenerationConfig.md) | Sampling and output controls. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L223) |\n| `safetySettings?` | [`GeminiSafetySetting`](GeminiSafetySetting.md)\\[] | Per-category safety-filter overrides. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L225) |\n| `systemInstruction?` | { `parts`: [`GeminiPart`](GeminiPart.md)\\[]; } | System text — there is no `system` role in `contents`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L217) |\n| `systemInstruction.parts` | [`GeminiPart`](GeminiPart.md)\\[] | - | [src/batteries/llm/gemini\\_generate\\_content/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L217) |\n| `toolConfig?` | [`GeminiToolConfig`](GeminiToolConfig.md) | Whether function calling is forced, permitted, or forbidden. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L221) |\n| `tools?` | [`GeminiTool`](GeminiTool.md)\\[] | Callable function declarations. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L219) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentResponse","title":"Interface: GeminiGenerateContentResponse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentResponse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentResponse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentResponse.md\ndescription: >-\n The `:generateContent` response body (also each SSE frame of\n `:streamGenerateContent`).\n---\n\n# Interface: GeminiGenerateContentResponse\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L255)\n\nThe `:generateContent` response body (also each SSE frame of `:streamGenerateContent`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------ | ----------------------------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `candidates?` | [`GeminiCandidate`](GeminiCandidate.md)\\[] | Generations. Absent or empty when the prompt itself was blocked. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L257) |\n| `modelVersion?` | `string` | The concrete model version that served the request — pin this when an alias was requested. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L263) |\n| `promptFeedback?` | { `blockReason?`: `string`; } | Why the PROMPT was rejected, when it was. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L261) |\n| `promptFeedback.blockReason?` | `string` | - | [src/batteries/llm/gemini\\_generate\\_content/types.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L261) |\n| `usageMetadata?` | [`GeminiUsageMetadata`](GeminiUsageMetadata.md) | Token accounting for the call. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L259) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerationConfig","title":"Interface: GeminiGenerationConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerationConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerationConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerationConfig.md\ndescription: Sampling and output controls.\n---\n\n# Interface: GeminiGenerationConfig\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L185)\n\nSampling and output controls.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ---------------------------------------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `maxOutputTokens?` | `number` | Upper bound on generated tokens. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L187) |\n| `responseMimeType?` | `string` | Forces a response media type, e.g. `application/json`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L197) |\n| `responseSchema?` | [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Schema the response must conform to, for structured output. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:199](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L199) |\n| `stopSequences?` | `string`\\[] | Sequences that halt generation when produced. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L195) |\n| `temperature?` | `number` | Sampling temperature. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L189) |\n| `thinkingConfig?` | [`GeminiThinkingConfig`](GeminiThinkingConfig.md) | Reasoning-budget controls. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L201) |\n| `topK?` | `number` | Top-k sampling cutoff. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L193) |\n| `topP?` | `number` | Nucleus-sampling threshold. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L191) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiInlineData","title":"Interface: GeminiInlineData","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiInlineData.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiInlineData","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiInlineData.md\ndescription: Inline binary data (image/audio/etc.) as Gemini carries it.\n---\n\n# Interface: GeminiInlineData\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L90)\n\nInline binary data (image/audio/etc.) as Gemini carries it.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | -------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `data` | `string` | Base64, no data-URL prefix. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L94) |\n| `mimeType` | `string` | IANA media type, e.g. `image/png`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L92) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiPart","title":"Interface: GeminiPart","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiPart.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiPart","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiPart.md\ndescription: 'One element of a turn''s `parts[]`.'\n---\n\n# Interface: GeminiPart\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L127)\n\nOne element of a turn's `parts[]`.\n\n## Remarks\n\nExactly one of the payload fields is normally set. `thought` marks a part as reasoning;\n`thoughtSignature` is the opaque provenance token Gemini 3+ requires on historical\n`functionCall` parts.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `functionCall?` | [`GeminiFunctionCall`](GeminiFunctionCall.md) | A model-emitted request to invoke a declared function. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L133) |\n| `functionResponse?` | [`GeminiFunctionResponse`](GeminiFunctionResponse.md) | The result of a function invocation, on a `user` turn. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L135) |\n| `inlineData?` | [`GeminiInlineData`](GeminiInlineData.md) | Inline binary payload (image/audio). | [src/batteries/llm/gemini\\_generate\\_content/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L131) |\n| `text?` | `string` | Plain text. Reasoning text sets [GeminiPart.thought](#property-thought) too. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L129) |\n| `thought?` | `boolean` | True when this part is model reasoning rather than user-visible output. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L137) |\n| `thoughtSignature?` | `string` | Opaque reasoning-provenance token; required by Gemini 3+ on historical function calls. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L139) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiRequestBuildInput","title":"Interface: GeminiRequestBuildInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiRequestBuildInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiRequestBuildInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiRequestBuildInput.md\ndescription: Everything `buildGeminiRequest` needs to assemble a request.\n---\n\n# Interface: GeminiRequestBuildInput\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:295](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L295)\n\nEverything `buildGeminiRequest` needs to assemble a request.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Optional; `buildGeminiRequest` falls back to DEFAULT\\_GEMINI\\_BUCKET\\_ORDER. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:315](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L315) |\n| `decodeMedia?` | (`media`: [`Media`](../../../../../common/classes/Media.md)) => `Promise`<[`GeminiInlineData`](GeminiInlineData.md)> | Decode an attachment into `inlineData`. Attachments are skipped when absent. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:327](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L327) |\n| `helpers` | [`GeminiGenerateContentHelpers`](GeminiGenerateContentHelpers.md) | Resolved helper set; the assembler calls these rather than module globals. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:325](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L325) |\n| `memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | Memories, rendered into the system instruction. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:301](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L301) |\n| `messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | Conversation messages; `role: 'assistant'` maps to `'model'`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:305](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L305) |\n| `renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>> | Pre-rendered tool results, keyed by the live ToolCall instance. Gemini requires objects, not strings. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:313](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L313) |\n| `replayCompatibility` | readonly `string`\\[] | Replay tags whose opaque payloads may be sent back to this model. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:321](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L321) |\n| `retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | Retrievables, rendered into the system instruction. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:303](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L303) |\n| `selfIdentity` | `string` | Identity attributed to this agent's own thoughts. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L317) |\n| `standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | Standing instructions, rendered into the system instruction. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:299](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L299) |\n| `systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | Base system text; becomes `systemInstruction`, never a `contents[]` turn. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:297](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L297) |\n| `thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | Reasoning to replay, subject to [GeminiRequestBuildInput.thoughtSurfacing](#property-thoughtsurfacing). | [src/batteries/llm/gemini\\_generate\\_content/types.ts:307](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L307) |\n| `thoughtSignatureSentinel` | `string` | `false` | Sentinel stamped on the first historical `functionCall` when none carries a signature. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:323](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L323) |\n| `thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Which reasoning to replay. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:319](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L319) |\n| `toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | Tool calls to replay; each becomes a `functionCall` + `functionResponse` pair. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L309) |\n| `tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | Tools offered this turn, rendered into `functionDeclarations`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:311](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L311) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | What to do with a modality Gemini cannot accept. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L329) |\n| `warn?` | (`message`: `string`) => `void` | Non-fatal diagnostics sink. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:331](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L331) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiSafetySetting","title":"Interface: GeminiSafetySetting","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiSafetySetting.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiSafetySetting","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiSafetySetting.md\ndescription: One safety-filter setting.\n---\n\n# Interface: GeminiSafetySetting\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L205)\n\nOne safety-filter setting.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | -------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `category` | `string` | Harm category, e.g. `HARM_CATEGORY_HARASSMENT`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L207) |\n| `threshold` | `string` | Blocking threshold, e.g. `BLOCK_NONE`. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L209) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiThinkingConfig","title":"Interface: GeminiThinkingConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiThinkingConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiThinkingConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiThinkingConfig.md\ndescription: Reasoning-budget controls.\n---\n\n# Interface: GeminiThinkingConfig\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L177)\n\nReasoning-budget controls.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------- | --------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `includeThoughts?` | `boolean` | Whether reasoning parts are returned (as `thought: true` parts). | [src/batteries/llm/gemini\\_generate\\_content/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L181) |\n| `thinkingBudget?` | `number` | Token budget for reasoning; `0` disables, `-1` lets the model decide. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L179) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiTool","title":"Interface: GeminiTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiTool.md\ndescription: 'The `tools[]` entry wrapping function declarations.'\n---\n\n# Interface: GeminiTool\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L161)\n\nThe `tools[]` entry wrapping function declarations.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `functionDeclarations` | [`GeminiFunctionDeclaration`](GeminiFunctionDeclaration.md)\\[] | The callable functions this entry declares. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:163](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L163) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiToolConfig","title":"Interface: GeminiToolConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiToolConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiToolConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiToolConfig.md\ndescription: 'Forces, permits, or forbids function calling.'\n---\n\n# Interface: GeminiToolConfig\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L167)\n\nForces, permits, or forbids function calling.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `functionCallingConfig` | { `allowedFunctionNames?`: `string`\\[]; `mode`: `\"AUTO\"` | `\"ANY\"` | `\"NONE\"`; } | The calling mode and its optional allow-list. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L169) |\n| `functionCallingConfig.allowedFunctionNames?` | `string`\\[] | - | [src/batteries/llm/gemini\\_generate\\_content/types.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L172) |\n| `functionCallingConfig.mode` | `\"AUTO\"` | `\"ANY\"` | `\"NONE\"` | `AUTO` lets the model choose; `ANY` forces a call; `NONE` forbids one. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L171) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiUsageMetadata","title":"Interface: GeminiUsageMetadata","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiUsageMetadata.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiUsageMetadata","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiUsageMetadata.md\ndescription: Per-candidate token accounting.\n---\n\n# Interface: GeminiUsageMetadata\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L229)\n\nPer-candidate token accounting.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------------ | -------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cachedContentTokenCount?` | `number` | Tokens served from context cache rather than re-billed. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:239](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L239) |\n| `candidatesTokenCount?` | `number` | Output tokens across all candidates. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:233](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L233) |\n| `promptTokenCount?` | `number` | Input tokens billed for the prompt. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L231) |\n| `thoughtsTokenCount?` | `number` | Reasoning tokens, when `includeThoughts` is on. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L237) |\n| `totalTokenCount?` | `number` | Prompt + candidates. | [src/batteries/llm/gemini\\_generate\\_content/types.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L235) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/type-aliases/GeminiRole","title":"Type Alias: GeminiRole","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/type-aliases/GeminiRole.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/type-aliases/GeminiRole","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/type-aliases/GeminiRole.md\ndescription: A conversation role on the `generateContent` wire.\n---\n\n# Type Alias: GeminiRole\n\n```ts\ntype GeminiRole = \"user\" | \"model\";\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/types.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/types.ts#L87)\n\nA conversation role on the `generateContent` wire.\n\n## Remarks\n\nNote `'model'` where OpenAI says `'assistant'`, and the ABSENCE of a system role — system text is\ncarried out-of-band in `systemInstruction`. A tool RESULT is a `user` turn carrying a\n`functionResponse` part, which is the single most surprising difference from the OpenAI shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation","title":"@nhtio/adk/batteries/llm/gemini\\_generate\\_content/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation.md\ndescription: Runtime option validation for the native Gemini `generateContent` battery.\n---\n\n# @nhtio/adk/batteries/llm/gemini\\_generate\\_content/validation\n\nRuntime option validation for the native Gemini `generateContent` battery.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| [geminiGenerateContentOptionsSchema](variables/geminiGenerateContentOptionsSchema.md) | Schema for [GeminiGenerateContentAdapterOptions](../types/interfaces/GeminiGenerateContentAdapterOptions.md). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | --------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validate and normalise adapter options. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): GeminiGenerateContentAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/validation.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/validation.ts#L108)\n\nValidate and normalise adapter options.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `input` | `unknown` |\n\n## Returns\n\n[`GeminiGenerateContentAdapterOptions`](../../types/interfaces/GeminiGenerateContentAdapterOptions.md)\n\n## Throws\n\nE\\_INVALID\\_GEMINI\\_GENERATE\\_CONTENT\\_OPTIONS when validation fails.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/variables/geminiGenerateContentOptionsSchema","title":"Variable: geminiGenerateContentOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/variables/geminiGenerateContentOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/variables/geminiGenerateContentOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/validation/variables/geminiGenerateContentOptionsSchema.md\ndescription: 'Schema for [`GeminiGenerateContentAdapterOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/gemini_generate_content/types/interfaces/GeminiGenerateContentAdapterOptions).'\n---\n\n# Variable: geminiGenerateContentOptionsSchema\n\n```ts\nconst geminiGenerateContentOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/gemini\\_generate\\_content/validation.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/gemini_generate_content/validation.ts#L28)\n\nSchema for [GeminiGenerateContentAdapterOptions](../../types/interfaces/GeminiGenerateContentAdapterOptions.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm","title":"@nhtio/adk/batteries/llm/litert\\_lm","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm.md'\ndescription: >-\n LiteRT-LM adapter battery — browser/WebGPU on-device inference with swappable\n translation helpers.\n---\n\n# @nhtio/adk/batteries/llm/litert\\_lm\n\nLiteRT-LM adapter battery — browser/WebGPU on-device inference with swappable translation helpers.\n\n## Remarks\n\nOpinionated LLM battery wrapping Google's `@litert-lm/core` — on-device inference in the browser via\nWebGPU + a bundled wasm runtime, driving `.litertlm` models. Ships a `LiteRtLmAdapter` that targets\nLiteRT-LM's native `Engine → Conversation` API and translates the ADK's primitives into LiteRT's\n`Message` / `Tool` / `tool_response` / `Preface` wire shapes.\n\nUnlike the WebLLM battery (a thin extension of the OpenAI Chat Completions wire shape), this is a\n**standalone** battery: it reuses the format-agnostic render helpers but maps history, tools, and\nresults to LiteRT's own shapes, where tool-call `arguments` arrive as a parsed object (not a JSON\nstring) and \"thinking\" surfaces via `Message.channels`.\n\n**The published `@litert-lm/core` docs lag the library.** Every wire field here is mapped against the\ninstalled package's type declarations — the source of truth. The dependency is young (pinned exact);\nre-verify on upgrade.\n\nRe-exports the adapter class, every translation helper (each under its unprefixed name AND a\n`default*`-prefixed alias so consumers can compose partial overrides against the bundled defaults),\nthe LiteRT-native mappers, every option / wire-shape type alias, the validation schema +\n`validateOptions` wrapper, and the five battery-scoped exception classes.\n\n## References\n\n### Backend\n\nRe-exports [Backend](types/type-aliases/Backend.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### buildBundledReasoningParsers\n\nRe-exports [buildBundledReasoningParsers](../transformers_js/helpers/functions/buildBundledReasoningParsers.md)\n\n***\n\n### buildLiteRtConversationInput\n\nRe-exports [buildLiteRtConversationInput](helpers/functions/buildLiteRtConversationInput.md)\n\n***\n\n### BUNDLED\\_REASONING\\_PARSERS\n\nRe-exports [BUNDLED\\_REASONING\\_PARSERS](../transformers_js/helpers/variables/BUNDLED_REASONING_PARSERS.md)\n\n***\n\n### BUNDLED\\_TOOL\\_CALL\\_PARSERS\n\nRe-exports [BUNDLED\\_TOOL\\_CALL\\_PARSERS](../transformers_js/helpers/variables/BUNDLED_TOOL_CALL_PARSERS.md)\n\n***\n\n### ChatGenerationOptions\n\nRe-exports [ChatGenerationOptions](../transformers_js/helpers/interfaces/ChatGenerationOptions.md)\n\n***\n\n### ChatSampler\n\nRe-exports [ChatSampler](../transformers_js/helpers/type-aliases/ChatSampler.md)\n\n***\n\n### createAutoReasoningParser\n\nRe-exports [createAutoReasoningParser](../transformers_js/helpers/functions/createAutoReasoningParser.md)\n\n***\n\n### createAutoToolCallParser\n\nRe-exports [createAutoToolCallParser](../transformers_js/helpers/functions/createAutoToolCallParser.md)\n\n***\n\n### CreateLiteRtLmEngine\n\nRe-exports [CreateLiteRtLmEngine](types/type-aliases/CreateLiteRtLmEngine.md)\n\n***\n\n### createLiteRtStreamAccumulator\n\nRe-exports [createLiteRtStreamAccumulator](helpers/functions/createLiteRtStreamAccumulator.md)\n\n***\n\n### DEFAULT\\_REASONING\\_PARSER\\_ORDER\n\nRe-exports [DEFAULT\\_REASONING\\_PARSER\\_ORDER](../transformers_js/helpers/variables/DEFAULT_REASONING_PARSER_ORDER.md)\n\n***\n\n### DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER\n\nRe-exports [DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER](../transformers_js/helpers/variables/DEFAULT_TOOL_CALL_PARSER_ORDER.md)\n\n***\n\n### defaultBuildLiteRtConversationInput\n\nRe-exports [defaultBuildLiteRtConversationInput](helpers/variables/defaultBuildLiteRtConversationInput.md)\n\n***\n\n### defaultCreateLiteRtStreamAccumulator\n\nRe-exports [defaultCreateLiteRtStreamAccumulator](helpers/variables/defaultCreateLiteRtStreamAccumulator.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultEmitLifecycle\n\nRe-exports [defaultEmitLifecycle](../transformers_js/helpers/variables/defaultEmitLifecycle.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderLiteRtToolResult\n\nRe-exports [defaultRenderLiteRtToolResult](helpers/variables/defaultRenderLiteRtToolResult.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderToolsAsPromptText\n\nRe-exports [defaultRenderToolsAsPromptText](helpers/variables/defaultRenderToolsAsPromptText.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultResolveGenerationOptions\n\nRe-exports [defaultResolveGenerationOptions](../transformers_js/helpers/variables/defaultResolveGenerationOptions.md)\n\n***\n\n### defaultToolsToLiteRtTools\n\nRe-exports [defaultToolsToLiteRtTools](helpers/variables/defaultToolsToLiteRtTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_INVALID\\_LITERT\\_LM\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_LITERT\\_LM\\_OPTIONS](exceptions/variables/E_INVALID_LITERT_LM_OPTIONS.md)\n\n***\n\n### E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_LITERT\\_LM\\_STREAM\\_ERROR\n\nRe-exports [E\\_LITERT\\_LM\\_STREAM\\_ERROR](exceptions/variables/E_LITERT_LM_STREAM_ERROR.md)\n\n***\n\n### E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY\n\nRe-exports [E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY](../chat_common/exceptions/variables/E_LLM_GPU_OUT_OF_MEMORY.md)\n\n***\n\n### E\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_UNSUPPORTED\\_MEDIA\\_MODALITY](exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### emitLifecycle\n\nRe-exports [emitLifecycle](../transformers_js/helpers/functions/emitLifecycle.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](../openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### gemmaChannelReasoningParser\n\nRe-exports [gemmaChannelReasoningParser](../transformers_js/helpers/variables/gemmaChannelReasoningParser.md)\n\n***\n\n### gemmaToolCallParser\n\nRe-exports [gemmaToolCallParser](../transformers_js/helpers/variables/gemmaToolCallParser.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GENERATION\\_DEFAULTS\n\nRe-exports [GENERATION\\_DEFAULTS](../transformers_js/helpers/variables/GENERATION_DEFAULTS.md)\n\n***\n\n### gptOssToolCallParser\n\nRe-exports [gptOssToolCallParser](../transformers_js/helpers/variables/gptOssToolCallParser.md)\n\n***\n\n### GpuBudget\n\nRe-exports [GpuBudget](../transformers_js/helpers/interfaces/GpuBudget.md)\n\n***\n\n### GpuBufferInstrument\n\nRe-exports [GpuBufferInstrument](../transformers_js/helpers/interfaces/GpuBufferInstrument.md)\n\n***\n\n### GpuBufferSample\n\nRe-exports [GpuBufferSample](../transformers_js/helpers/interfaces/GpuBufferSample.md)\n\n***\n\n### harmonyAnalysisReasoningParser\n\nRe-exports [harmonyAnalysisReasoningParser](../transformers_js/helpers/variables/harmonyAnalysisReasoningParser.md)\n\n***\n\n### hermesToolCallParser\n\nRe-exports [hermesToolCallParser](../transformers_js/helpers/variables/hermesToolCallParser.md)\n\n***\n\n### instrumentGpuBuffers\n\nRe-exports [instrumentGpuBuffers](../transformers_js/helpers/functions/instrumentGpuBuffers.md)\n\n***\n\n### isEngineContextOverflowMessage\n\nRe-exports [isEngineContextOverflowMessage](adapter/functions/isEngineContextOverflowMessage.md)\n\n***\n\n### isGpuOutOfMemoryError\n\nRe-exports [isGpuOutOfMemoryError](../transformers_js/helpers/functions/isGpuOutOfMemoryError.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### LiteRtConversationConfig\n\nRe-exports [LiteRtConversationConfig](types/type-aliases/LiteRtConversationConfig.md)\n\n***\n\n### LiteRtEngineSettings\n\nRe-exports [LiteRtEngineSettings](types/type-aliases/LiteRtEngineSettings.md)\n\n***\n\n### LiteRtLlmExecutorSettings\n\nRe-exports [LiteRtLlmExecutorSettings](types/type-aliases/LiteRtLlmExecutorSettings.md)\n\n***\n\n### LiteRtLmAdapter\n\nRe-exports [LiteRtLmAdapter](adapter/classes/LiteRtLmAdapter.md)\n\n***\n\n### LiteRtLmAdapterOptions\n\nRe-exports [LiteRtLmAdapterOptions](types/interfaces/LiteRtLmAdapterOptions.md)\n\n***\n\n### LiteRtLmBucketOrder\n\nRenames and re-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### LiteRtLmChatEngine\n\nRe-exports [LiteRtLmChatEngine](types/type-aliases/LiteRtLmChatEngine.md)\n\n***\n\n### LiteRtLmConversation\n\nRe-exports [LiteRtLmConversation](types/type-aliases/LiteRtLmConversation.md)\n\n***\n\n### LiteRtLmDescriptionLike\n\nRe-exports [LiteRtLmDescriptionLike](types/type-aliases/LiteRtLmDescriptionLike.md)\n\n***\n\n### LiteRtLmEngine\n\nRe-exports [LiteRtLmEngine](types/type-aliases/LiteRtLmEngine.md)\n\n***\n\n### LiteRtLmHelpers\n\nRenames and re-exports [ChatCompletionsHelpers](../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### LiteRtLmInitProgressReport\n\nRe-exports [LiteRtLmInitProgressReport](types/type-aliases/LiteRtLmInitProgressReport.md)\n\n***\n\n### LiteRtLmJsonSchema\n\nRe-exports [LiteRtLmJsonSchema](types/type-aliases/LiteRtLmJsonSchema.md)\n\n***\n\n### liteRtLmOptionsSchema\n\nRe-exports [liteRtLmOptionsSchema](validation/variables/liteRtLmOptionsSchema.md)\n\n***\n\n### LiteRtMessage\n\nRe-exports [LiteRtMessage](types/type-aliases/LiteRtMessage.md)\n\n***\n\n### LiteRtMessageContentItem\n\nRe-exports [LiteRtMessageContentItem](types/type-aliases/LiteRtMessageContentItem.md)\n\n***\n\n### LiteRtMessageLike\n\nRe-exports [LiteRtMessageLike](types/type-aliases/LiteRtMessageLike.md)\n\n***\n\n### LiteRtPreface\n\nRe-exports [LiteRtPreface](types/type-aliases/LiteRtPreface.md)\n\n***\n\n### LiteRtSamplerParameters\n\nRe-exports [LiteRtSamplerParameters](types/type-aliases/LiteRtSamplerParameters.md)\n\n***\n\n### LiteRtSamplerParametersOption\n\nRe-exports [LiteRtSamplerParametersOption](types/interfaces/LiteRtSamplerParametersOption.md)\n\n***\n\n### LiteRtSessionConfig\n\nRe-exports [LiteRtSessionConfig](types/type-aliases/LiteRtSessionConfig.md)\n\n***\n\n### LiteRtStreamAccumulator\n\nRe-exports [LiteRtStreamAccumulator](helpers/interfaces/LiteRtStreamAccumulator.md)\n\n***\n\n### LiteRtTool\n\nRe-exports [LiteRtTool](types/type-aliases/LiteRtTool.md)\n\n***\n\n### LiteRtToolCall\n\nRe-exports [LiteRtToolCall](types/type-aliases/LiteRtToolCall.md)\n\n***\n\n### LiteRtToolCallFunction\n\nRe-exports [LiteRtToolCallFunction](types/type-aliases/LiteRtToolCallFunction.md)\n\n***\n\n### LiteRtToolParameters\n\nRe-exports [LiteRtToolParameters](types/type-aliases/LiteRtToolParameters.md)\n\n***\n\n### LiteRtToolResponseValue\n\nRe-exports [LiteRtToolResponseValue](types/type-aliases/LiteRtToolResponseValue.md)\n\n***\n\n### llama3JsonToolCallParser\n\nRe-exports [llama3JsonToolCallParser](../transformers_js/helpers/variables/llama3JsonToolCallParser.md)\n\n***\n\n### looksLikeSpooledArtifact\n\nRe-exports [looksLikeSpooledArtifact](../transformers_js/helpers/functions/looksLikeSpooledArtifact.md)\n\n***\n\n### makeGemmaChannelReasoningParser\n\nRe-exports [makeGemmaChannelReasoningParser](../transformers_js/helpers/functions/makeGemmaChannelReasoningParser.md)\n\n***\n\n### makeHarmonyAnalysisReasoningParser\n\nRe-exports [makeHarmonyAnalysisReasoningParser](../transformers_js/helpers/functions/makeHarmonyAnalysisReasoningParser.md)\n\n***\n\n### makeThinkTagReasoningParser\n\nRe-exports [makeThinkTagReasoningParser](../transformers_js/helpers/functions/makeThinkTagReasoningParser.md)\n\n***\n\n### MediaOutputExtractorFn\n\nRe-exports [MediaOutputExtractorFn](../transformers_js/type-aliases/MediaOutputExtractorFn.md)\n\n***\n\n### mistralToolCallParser\n\nRe-exports [mistralToolCallParser](../transformers_js/helpers/variables/mistralToolCallParser.md)\n\n***\n\n### noneReasoningParser\n\nRe-exports [noneReasoningParser](../transformers_js/helpers/variables/noneReasoningParser.md)\n\n***\n\n### noneToolCallParser\n\nRe-exports [noneToolCallParser](../transformers_js/helpers/variables/noneToolCallParser.md)\n\n***\n\n### ParsedToolCall\n\nRe-exports [ParsedToolCall](../transformers_js/helpers/interfaces/ParsedToolCall.md)\n\n***\n\n### phiToolCallParser\n\nRe-exports [phiToolCallParser](../transformers_js/helpers/variables/phiToolCallParser.md)\n\n***\n\n### probeGpuBudget\n\nRe-exports [probeGpuBudget](../transformers_js/helpers/functions/probeGpuBudget.md)\n\n***\n\n### PromptAssembledObservation\n\nRe-exports [PromptAssembledObservation](../../interfaces/PromptAssembledObservation.md)\n\n***\n\n### PromptAssembledObserverFn\n\nRe-exports [PromptAssembledObserverFn](../../type-aliases/PromptAssembledObserverFn.md)\n\n***\n\n### pythonicToolCallParser\n\nRe-exports [pythonicToolCallParser](../transformers_js/helpers/variables/pythonicToolCallParser.md)\n\n***\n\n### qwen3CoderToolCallParser\n\nRe-exports [qwen3CoderToolCallParser](../transformers_js/helpers/variables/qwen3CoderToolCallParser.md)\n\n***\n\n### RawGenerationObservation\n\nRe-exports [RawGenerationObservation](../../interfaces/RawGenerationObservation.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### ReasoningParseResult\n\nRe-exports [ReasoningParseResult](../transformers_js/helpers/interfaces/ReasoningParseResult.md)\n\n***\n\n### ReasoningParserFn\n\nRe-exports [ReasoningParserFn](../transformers_js/helpers/type-aliases/ReasoningParserFn.md)\n\n***\n\n### ReasoningParserName\n\nRe-exports [ReasoningParserName](../transformers_js/helpers/type-aliases/ReasoningParserName.md)\n\n***\n\n### ReasoningParserOptions\n\nRe-exports [ReasoningParserOptions](../transformers_js/helpers/interfaces/ReasoningParserOptions.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderLiteRtToolResult\n\nRe-exports [renderLiteRtToolResult](helpers/functions/renderLiteRtToolResult.md)\n\n***\n\n### renderMediaToLiteRtContent\n\nRe-exports [renderMediaToLiteRtContent](helpers/functions/renderMediaToLiteRtContent.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderToolsAsPromptText\n\nRe-exports [renderToolsAsPromptText](helpers/functions/renderToolsAsPromptText.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### ResolvedGenerationOptions\n\nRe-exports [ResolvedGenerationOptions](../transformers_js/helpers/interfaces/ResolvedGenerationOptions.md)\n\n***\n\n### resolveGenerationOptions\n\nRe-exports [resolveGenerationOptions](../transformers_js/helpers/functions/resolveGenerationOptions.md)\n\n***\n\n### resolveReasoningParser\n\nRe-exports [resolveReasoningParser](../transformers_js/helpers/functions/resolveReasoningParser.md)\n\n***\n\n### resolveToolCallParser\n\nRe-exports [resolveToolCallParser](../transformers_js/helpers/functions/resolveToolCallParser.md)\n\n***\n\n### SamplerType\n\nRe-exports [SamplerType](types/type-aliases/SamplerType.md)\n\n***\n\n### thinkTagReasoningParser\n\nRe-exports [thinkTagReasoningParser](../transformers_js/helpers/variables/thinkTagReasoningParser.md)\n\n***\n\n### ToolCallParserContext\n\nRe-exports [ToolCallParserContext](../transformers_js/helpers/interfaces/ToolCallParserContext.md)\n\n***\n\n### ToolCallParseResult\n\nRe-exports [ToolCallParseResult](../transformers_js/helpers/interfaces/ToolCallParseResult.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### toolsToLiteRtTools\n\nRe-exports [toolsToLiteRtTools](helpers/functions/toolsToLiteRtTools.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter","title":"@nhtio/adk/batteries/llm/litert\\_lm/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/adapter.md'\ndescription: Browser/WebGPU executor adapter for Google's LiteRT-LM (`@litert-lm/core`).\n---\n\n# @nhtio/adk/batteries/llm/litert\\_lm/adapter\n\nBrowser/WebGPU executor adapter for Google's LiteRT-LM (`@litert-lm/core`).\n\n## Remarks\n\nOn-device LLM inference via WebGPU + a bundled wasm runtime, `.litertlm` models. Unlike the WebLLM\nbattery (a thin extension of the OpenAI Chat Completions wire shape), LiteRT-LM has its **own** API —\n`Engine.create() → engine.createConversation({ preface }) → conversation.sendMessageStreaming():\nReadableStream` — with native `Message`/`Tool`/`tool_calls`/`tool_response` shapes (tool-call\n`arguments` arrive as a parsed object, not a JSON string). So this is a standalone adapter that reuses\nthe ADK's format-agnostic render helpers but maps history/tools/results to LiteRT's shapes.\n\nThree pluggable layers mirror the other LLM batteries: swappable translation helpers, three-layer\noptions merging (constructor → `executor()` overrides → `ctx.stash.liteRtLm`), and an\ninjectable/lazy engine (`engine` or `createEngine`, defaulting to a dynamic `@litert-lm/core` import).\n\n**The published `@litert-lm/core` docs lag the library** — every wire field here is mapped against the\ninstalled package's type declarations, the source of truth. The dependency is young (pinned exact);\nre-verify on upgrade.\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------- | ------------------------------------------------- |\n| [LiteRtLmAdapter](classes/LiteRtLmAdapter.md) | Cross-environment executor adapter for LiteRT-LM. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [isEngineContextOverflowMessage](functions/isEngineContextOverflowMessage.md) | Does this raw engine message report an INPUT context-cap overflow — the prompt's token ids exceed the engine's fixed `maxNumTokens`? The LiteRT-web runtime throws e.g. `Input token ids are too long. Exceeding the maximum number of tokens allowed: 12596 >= 12288`. Matched so the raw throw can be translated into the typed [E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW](../exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW.md) instead of the generic stream error — this is the ENGINE BACKSTOP that fires when the optional pre-dispatch guard is unarmed or undercounts. Exported so a host can classify a thrown/caught error the same way. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter/classes/LiteRtLmAdapter","title":"Class: LiteRtLmAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter/classes/LiteRtLmAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter/classes/LiteRtLmAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/adapter/classes/LiteRtLmAdapter.md\ndescription: Cross-environment executor adapter for LiteRT-LM.\n---\n\n# Class: LiteRtLmAdapter\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:306](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L306)\n\nCross-environment executor adapter for LiteRT-LM.\n\n## Remarks\n\nConstruct with at least `{ model }`; wire `new LiteRtLmAdapter(opts).executor()` into a\n`DispatchRunner` as the `executorCallback`. The engine is resolved lazily on first dispatch (or\neagerly via [LiteRtLmAdapter.preload](#preload)); pass `engine` to inject a pre-built one (e.g. in tests).\n\n## Constructors\n\n### Constructor\n\n```ts\nnew LiteRtLmAdapter(options: unknown): LiteRtLmAdapter;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L329)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------------------------------- |\n| `options` | `unknown` | Raw adapter options, validated against `liteRtLmOptionsSchema`. |\n\n#### Returns\n\n`LiteRtLmAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_LITERT\\_LM\\_OPTIONS](../../exceptions/variables/E_INVALID_LITERT_LM_OPTIONS.md) when `options` are invalid.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------ | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"liteRtLm\"` | The `ctx.stash` key under which per-dispatch option overrides are read. | [src/batteries/llm/litert\\_lm/adapter.ts:308](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L308) |\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:366](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L366)\n\nRelease the loaded engine's native resources (`Engine.delete()`), then drop the cached reference.\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\n`reset()` only nulls the JS reference; the LiteRT engine holds a WebGPU device + compiled graph that\nstay alive until GC. Loading many `.litertlm` engines back-to-back in one browser session accumulates\nthose until the GPU heap is exhausted. `@litert-lm/core`'s `Engine` exposes `delete()` — this settles\nany in-flight load, awaits `delete()`, swallows a teardown error (teardown must not throw), and\nfinishes with `reset()`. Idempotent and safe when nothing is loaded.\n\n***\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:559](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L559)\n\nProduce the bound [DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) the `DispatchRunner` invokes.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`LiteRtLmAdapterOptions`](../../types/interfaces/LiteRtLmAdapterOptions.md)> | Option overrides layered above the constructor baseline (below `ctx.stash`). |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L335)\n\nInstance WebGPU-availability probe (honours the `isWebGPUAvailable` option override).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(overrides?: Partial): Promise;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:345](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L345)\n\nEagerly resolve (load) the engine before the first dispatch.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`LiteRtLmAdapterOptions`](../../types/interfaces/LiteRtLmAdapterOptions.md)> | Optional option overrides applied for this load. |\n\n#### Returns\n\n`Promise`<`Engine`>\n\nThe resolved [LiteRtLmEngine](../../types/type-aliases/LiteRtLmEngine.md).\n\n***\n\n### recycle()\n\n```ts\nrecycle(overrides?: Partial): Promise;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:394](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L394)\n\nFree the WebGPU buffer cache by deleting the engine, then reload the same model.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`LiteRtLmAdapterOptions`](../../types/interfaces/LiteRtLmAdapterOptions.md)> | Optional option overrides applied to the reload (same as [preload](#preload)). |\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\nThe consumer-facing lever for the ONNX Runtime Web WebGPU buffer-freelist high-water-mark (see\n@nhtio/adk/batteries!probeGpuBudget). The pool is flushed only when the engine's sessions are\nreleased; there is no public flag to flush it mid-life, so the supported way to reclaim the retained\nworking-set without permanently unloading is to delete the engine and load again. This is exactly\n`dispose()` then `preload()`, surfaced as a named, intentional operation (e.g. an application\noffering a \"free GPU memory\" action after a @nhtio/adk/batteries!E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY).\nNOT invoked automatically — the ADK surfaces the lever and leaves the decision to the consumer.\nRe-incurs the cold-load cost. Idempotent.\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:351](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L351)\n\nDrop the cached engine and any in-flight load so the next dispatch re-resolves it.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L317)\n\nReturns `true` when the current runtime exposes WebGPU (`navigator.gpu`).\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter/functions/isEngineContextOverflowMessage","title":"Function: isEngineContextOverflowMessage()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter/functions/isEngineContextOverflowMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/adapter/functions/isEngineContextOverflowMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/adapter/functions/isEngineContextOverflowMessage.md\n---\n\n# Function: isEngineContextOverflowMessage()\n\n```ts\nfunction isEngineContextOverflowMessage(message: string): boolean;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/adapter.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/adapter.ts#L259)\n\nDoes this raw engine message report an INPUT context-cap overflow — the prompt's token ids exceed the\nengine's fixed `maxNumTokens`? The LiteRT-web runtime throws e.g. `Input token ids are too long.\nExceeding the maximum number of tokens allowed: 12596 >= 12288`. Matched so the raw throw can be\ntranslated into the typed [E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW](../../exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW.md) instead of the generic stream error —\nthis is the ENGINE BACKSTOP that fires when the optional pre-dispatch guard is unarmed or undercounts.\nExported so a host can classify a thrown/caught error the same way.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `message` | `string` |\n\n## Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions","title":"@nhtio/adk/batteries/llm/litert\\_lm/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/exceptions.md'\ndescription: Battery-scoped exception constructors for LiteRT-LM adapter failures.\n---\n\n# @nhtio/adk/batteries/llm/litert\\_lm/exceptions\n\nBattery-scoped exception constructors for LiteRT-LM adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the LiteRT-LM adapter. These exceptions are owned by the\nbattery (not the ADK core) and are minted via `createException` from `@nhtio/adk/factories`.\nRe-exported from the battery's barrel.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [E\\_INVALID\\_LITERT\\_LM\\_OPTIONS](variables/E_INVALID_LITERT_LM_OPTIONS.md) | Thrown when the resolved adapter options (constructor, executor overrides, or per-dispatch `stash.liteRtLm`) fail validation against `liteRtLmOptionsSchema`. |\n| [E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW](variables/E_LITERT_LM_CONTEXT_OVERFLOW.md) | Thrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in the message so middleware can target shedding. |\n| [E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS.md) | Raised when a tool-call emitted by the model carries malformed `arguments`. |\n| [E\\_LITERT\\_LM\\_STREAM\\_ERROR](variables/E_LITERT_LM_STREAM_ERROR.md) | Thrown when the LiteRT-LM engine call or response stream fails. Non-fatal — surfaced via `ctx.nack(...)`. |\n| [E\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_UNSUPPORTED_MEDIA_MODALITY.md) | Raised when a [@nhtio/adk!Media](../../../../common/classes/Media.md) instance whose modality cannot be represented for the LiteRT-LM model reaches the adapter under `unsupportedMediaPolicy: 'throw'`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_INVALID_LITERT_LM_OPTIONS","title":"Variable: E\\_INVALID\\_LITERT\\_LM\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_INVALID_LITERT_LM_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_INVALID_LITERT_LM_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_INVALID_LITERT_LM_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options (constructor, executor overrides, or\n per-dispatch `stash.liteRtLm`) fail validation against\n `liteRtLmOptionsSchema`.\n---\n\n# Variable: E\\_INVALID\\_LITERT\\_LM\\_OPTIONS\n\n```ts\nconst E_INVALID_LITERT_LM_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/exceptions.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/exceptions.ts#L18)\n\nThrown when the resolved adapter options (constructor, executor overrides, or per-dispatch\n`stash.liteRtLm`) fail validation against `liteRtLmOptionsSchema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW","title":"Variable: E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the total token weight of the resolved request exceeds\n `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{\n total, contextWindow, tokenEncoding, perBucket }` in the message so middleware\n can target shedding.\n---\n\n# Variable: E\\_LITERT\\_LM\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_LITERT_LM_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/exceptions.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/exceptions.ts#L31)\n\nThrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised\nwhen `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in\nthe message so middleware can target shedding.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_INVALID_TOOL_CALL_ARGS.md\ndescription: Raised when a tool-call emitted by the model carries malformed `arguments`.\n---\n\n# Variable: E\\_LITERT\\_LM\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_LITERT_LM_INVALID_TOOL_CALL_ARGS: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/exceptions.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/exceptions.ts#L66)\n\nRaised when a tool-call emitted by the model carries malformed `arguments`.\n\n## Remarks\n\nUnlike OpenAI-wire batteries (where tool-call `arguments` arrive as a JSON **string** that may\nfail to parse), LiteRT-LM delivers `ToolCall.function.arguments` already as a parsed object\n(`Record`). This exception therefore guards the rarer case where that field is\npresent but is not a plain object (e.g. an array or a primitive slipped through the wire shape).\n\nNon-fatal. The adapter does NOT throw this — it instantiates it inside `executeAndPersistToolCall`,\npulls `.message` into a [@nhtio/adk!Tokenizable](../../../../../common/classes/Tokenizable.md), and persists a `ToolCall` record with\n`isError: true` so the model can self-correct on the next iteration.\n\nPrintf args: `[reasonHeadline, rawArgs]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_STREAM_ERROR","title":"Variable: E\\_LITERT\\_LM\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_LITERT_LM_STREAM_ERROR.md\ndescription: >-\n Thrown when the LiteRT-LM engine call or response stream fails. Non-fatal —\n surfaced via `ctx.nack(...)`.\n---\n\n# Variable: E\\_LITERT\\_LM\\_STREAM\\_ERROR\n\n```ts\nconst E_LITERT_LM_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/exceptions.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/exceptions.ts#L43)\n\nThrown when the LiteRT-LM engine call or response stream fails. Non-fatal — surfaced via\n`ctx.nack(...)`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Raised when a {@link @nhtio/adk!Media} instance whose modality cannot be\n represented for the LiteRT-LM model reaches the adapter under\n `unsupportedMediaPolicy: 'throw'`.\n---\n\n# Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_UNSUPPORTED_MEDIA_MODALITY: CreatedException<[string, string, string]>;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/exceptions.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/exceptions.ts#L86)\n\nRaised when a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality cannot be represented for the\nLiteRT-LM model reaches the adapter under `unsupportedMediaPolicy: 'throw'`.\n\n## Remarks\n\nThe `@litert-lm/core` types expose `audioModalityEnabled` / `visionModalityEnabled`, but the\npreview `.litertlm` models are text-in/text-out today. Media this adapter cannot map (or that the\nconfigured model does not accept) triggers this under the `'throw'` policy; switch to\n`'fallback-stash'` or `'synthetic-description'` to degrade to a text representation instead.\n\nPrintf args: `[kind, mimeType, filename]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers","title":"@nhtio/adk/batteries/llm/litert\\_lm/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers.md'\ndescription: Translation helpers for the LiteRT-LM adapter.\n---\n\n# @nhtio/adk/batteries/llm/litert\\_lm/helpers\n\nTranslation helpers for the LiteRT-LM adapter.\n\n## Remarks\n\nTwo layers:\n\n1. **Re-exported format-agnostic helpers** from `chat_common` — they operate on ADK primitives and\n produce plain strings / trust envelopes / a JSON-Schema from a joi description, with no wire-format\n coupling. LiteRT reuses them verbatim (the same way the WebLLM battery does).\n2. **LiteRT-native mappers** defined here — the wire-shape functions the chat-completions batteries\n implement against the OpenAI wire format, rewritten against LiteRT's `Message` / `Tool` /\n `tool_response` / `Preface` shapes.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------- | --------------------------------------------------------------------- |\n| [LiteRtStreamAccumulator](interfaces/LiteRtStreamAccumulator.md) | A streaming accumulator over LiteRT `ReadableStream` chunks. |\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |\n| [defaultBuildLiteRtConversationInput](variables/defaultBuildLiteRtConversationInput.md) | Default [buildLiteRtConversationInput](functions/buildLiteRtConversationInput.md). |\n| [defaultCreateLiteRtStreamAccumulator](variables/defaultCreateLiteRtStreamAccumulator.md) | Default [createLiteRtStreamAccumulator](functions/createLiteRtStreamAccumulator.md). |\n| [defaultRenderLiteRtToolResult](variables/defaultRenderLiteRtToolResult.md) | Default [renderLiteRtToolResult](functions/renderLiteRtToolResult.md). |\n| [defaultRenderToolsAsPromptText](variables/defaultRenderToolsAsPromptText.md) | Default [renderToolsAsPromptText](functions/renderToolsAsPromptText.md). |\n| [defaultToolsToLiteRtTools](variables/defaultToolsToLiteRtTools.md) | Default [toolsToLiteRtTools](functions/toolsToLiteRtTools.md). |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [buildLiteRtConversationInput](functions/buildLiteRtConversationInput.md) | Build the LiteRT conversation input from the ADK dispatch context buckets. |\n| [createLiteRtStreamAccumulator](functions/createLiteRtStreamAccumulator.md) | Create a [LiteRtStreamAccumulator](interfaces/LiteRtStreamAccumulator.md). |\n| [renderLiteRtToolResult](functions/renderLiteRtToolResult.md) | Render a [@nhtio/adk!ToolCall](../../../../forge/classes/ToolCall.md)'s `results` into a LiteRT `tool_response` content item. |\n| [renderMediaToLiteRtContent](functions/renderMediaToLiteRtContent.md) | Render a media kind/mime/filename into a LiteRT content item, or fall back per `unsupportedMediaPolicy`. |\n| [renderToolsAsPromptText](functions/renderToolsAsPromptText.md) | Render tool definitions as a SYSTEM-PROMPT text block (the prompt-injection tool-delivery path), rather than the native `preface.tools` field. |\n| [toolsToLiteRtTools](functions/toolsToLiteRtTools.md) | Convert ADK [@nhtio/adk!Tool](../../../../forge/classes/Tool.md) / [@nhtio/adk!ArtifactTool](../../../../forge/classes/ArtifactTool.md) instances into LiteRT [LiteRtTool](../types/type-aliases/LiteRtTool.md) definitions. |\n\n## References\n\n### barePythonicToolCallParser\n\nRe-exports [barePythonicToolCallParser](../../transformers_js/helpers/variables/barePythonicToolCallParser.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### buildBundledReasoningParsers\n\nRe-exports [buildBundledReasoningParsers](../../transformers_js/helpers/functions/buildBundledReasoningParsers.md)\n\n***\n\n### BUNDLED\\_REASONING\\_PARSERS\n\nRe-exports [BUNDLED\\_REASONING\\_PARSERS](../../transformers_js/helpers/variables/BUNDLED_REASONING_PARSERS.md)\n\n***\n\n### BUNDLED\\_TOOL\\_CALL\\_PARSERS\n\nRe-exports [BUNDLED\\_TOOL\\_CALL\\_PARSERS](../../transformers_js/helpers/variables/BUNDLED_TOOL_CALL_PARSERS.md)\n\n***\n\n### ChatGenerationOptions\n\nRe-exports [ChatGenerationOptions](../../transformers_js/helpers/interfaces/ChatGenerationOptions.md)\n\n***\n\n### ChatSampler\n\nRe-exports [ChatSampler](../../transformers_js/helpers/type-aliases/ChatSampler.md)\n\n***\n\n### createAutoReasoningParser\n\nRe-exports [createAutoReasoningParser](../../transformers_js/helpers/functions/createAutoReasoningParser.md)\n\n***\n\n### createAutoToolCallParser\n\nRe-exports [createAutoToolCallParser](../../transformers_js/helpers/functions/createAutoToolCallParser.md)\n\n***\n\n### DEFAULT\\_REASONING\\_PARSER\\_ORDER\n\nRe-exports [DEFAULT\\_REASONING\\_PARSER\\_ORDER](../../transformers_js/helpers/variables/DEFAULT_REASONING_PARSER_ORDER.md)\n\n***\n\n### DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER\n\nRe-exports [DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER](../../transformers_js/helpers/variables/DEFAULT_TOOL_CALL_PARSER_ORDER.md)\n\n***\n\n### defaultBarePythonicToolCallParser\n\nRe-exports [defaultBarePythonicToolCallParser](../../transformers_js/helpers/variables/defaultBarePythonicToolCallParser.md)\n\n***\n\n### defaultCreateAutoReasoningParser\n\nRe-exports [defaultCreateAutoReasoningParser](../../transformers_js/helpers/variables/defaultCreateAutoReasoningParser.md)\n\n***\n\n### defaultCreateAutoToolCallParser\n\nRe-exports [defaultCreateAutoToolCallParser](../../transformers_js/helpers/variables/defaultCreateAutoToolCallParser.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultEmitLifecycle\n\nRe-exports [defaultEmitLifecycle](../../transformers_js/helpers/variables/defaultEmitLifecycle.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultGemmaChannelReasoningParser\n\nRe-exports [defaultGemmaChannelReasoningParser](../../transformers_js/helpers/variables/defaultGemmaChannelReasoningParser.md)\n\n***\n\n### defaultGemmaToolCallParser\n\nRe-exports [defaultGemmaToolCallParser](../../transformers_js/helpers/variables/defaultGemmaToolCallParser.md)\n\n***\n\n### defaultGptOssToolCallParser\n\nRe-exports [defaultGptOssToolCallParser](../../transformers_js/helpers/variables/defaultGptOssToolCallParser.md)\n\n***\n\n### defaultHarmonyAnalysisReasoningParser\n\nRe-exports [defaultHarmonyAnalysisReasoningParser](../../transformers_js/helpers/variables/defaultHarmonyAnalysisReasoningParser.md)\n\n***\n\n### defaultHermesToolCallParser\n\nRe-exports [defaultHermesToolCallParser](../../transformers_js/helpers/variables/defaultHermesToolCallParser.md)\n\n***\n\n### defaultLlama3JsonToolCallParser\n\nRe-exports [defaultLlama3JsonToolCallParser](../../transformers_js/helpers/variables/defaultLlama3JsonToolCallParser.md)\n\n***\n\n### defaultLooseKeyedToolCallParser\n\nRe-exports [defaultLooseKeyedToolCallParser](../../transformers_js/helpers/variables/defaultLooseKeyedToolCallParser.md)\n\n***\n\n### defaultMistralToolCallParser\n\nRe-exports [defaultMistralToolCallParser](../../transformers_js/helpers/variables/defaultMistralToolCallParser.md)\n\n***\n\n### defaultNoneReasoningParser\n\nRe-exports [defaultNoneReasoningParser](../../transformers_js/helpers/variables/defaultNoneReasoningParser.md)\n\n***\n\n### defaultNoneToolCallParser\n\nRe-exports [defaultNoneToolCallParser](../../transformers_js/helpers/variables/defaultNoneToolCallParser.md)\n\n***\n\n### defaultPhiToolCallParser\n\nRe-exports [defaultPhiToolCallParser](../../transformers_js/helpers/variables/defaultPhiToolCallParser.md)\n\n***\n\n### defaultPythonicToolCallParser\n\nRe-exports [defaultPythonicToolCallParser](../../transformers_js/helpers/variables/defaultPythonicToolCallParser.md)\n\n***\n\n### defaultQwen3CoderToolCallParser\n\nRe-exports [defaultQwen3CoderToolCallParser](../../transformers_js/helpers/variables/defaultQwen3CoderToolCallParser.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultResolveGenerationOptions\n\nRe-exports [defaultResolveGenerationOptions](../../transformers_js/helpers/variables/defaultResolveGenerationOptions.md)\n\n***\n\n### defaultResolveReasoningParser\n\nRe-exports [defaultResolveReasoningParser](../../transformers_js/helpers/variables/defaultResolveReasoningParser.md)\n\n***\n\n### defaultResolveToolCallParser\n\nRe-exports [defaultResolveToolCallParser](../../transformers_js/helpers/variables/defaultResolveToolCallParser.md)\n\n***\n\n### defaultThinkTagReasoningParser\n\nRe-exports [defaultThinkTagReasoningParser](../../transformers_js/helpers/variables/defaultThinkTagReasoningParser.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### emitLifecycle\n\nRe-exports [emitLifecycle](../../transformers_js/helpers/functions/emitLifecycle.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](../../openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### gemmaChannelReasoningParser\n\nRe-exports [gemmaChannelReasoningParser](../../transformers_js/helpers/variables/gemmaChannelReasoningParser.md)\n\n***\n\n### gemmaToolCallParser\n\nRe-exports [gemmaToolCallParser](../../transformers_js/helpers/variables/gemmaToolCallParser.md)\n\n***\n\n### GENERATION\\_DEFAULTS\n\nRe-exports [GENERATION\\_DEFAULTS](../../transformers_js/helpers/variables/GENERATION_DEFAULTS.md)\n\n***\n\n### gptOssToolCallParser\n\nRe-exports [gptOssToolCallParser](../../transformers_js/helpers/variables/gptOssToolCallParser.md)\n\n***\n\n### GpuBudget\n\nRe-exports [GpuBudget](../../transformers_js/helpers/interfaces/GpuBudget.md)\n\n***\n\n### GpuBufferInstrument\n\nRe-exports [GpuBufferInstrument](../../transformers_js/helpers/interfaces/GpuBufferInstrument.md)\n\n***\n\n### GpuBufferSample\n\nRe-exports [GpuBufferSample](../../transformers_js/helpers/interfaces/GpuBufferSample.md)\n\n***\n\n### harmonyAnalysisReasoningParser\n\nRe-exports [harmonyAnalysisReasoningParser](../../transformers_js/helpers/variables/harmonyAnalysisReasoningParser.md)\n\n***\n\n### hermesToolCallParser\n\nRe-exports [hermesToolCallParser](../../transformers_js/helpers/variables/hermesToolCallParser.md)\n\n***\n\n### instrumentGpuBuffers\n\nRe-exports [instrumentGpuBuffers](../../transformers_js/helpers/functions/instrumentGpuBuffers.md)\n\n***\n\n### isGpuOutOfMemoryError\n\nRe-exports [isGpuOutOfMemoryError](../../transformers_js/helpers/functions/isGpuOutOfMemoryError.md)\n\n***\n\n### JsonValue\n\nRe-exports [JsonValue](../../transformers_js/helpers/type-aliases/JsonValue.md)\n\n***\n\n### llama3JsonToolCallParser\n\nRe-exports [llama3JsonToolCallParser](../../transformers_js/helpers/variables/llama3JsonToolCallParser.md)\n\n***\n\n### looksLikeSpooledArtifact\n\nRe-exports [looksLikeSpooledArtifact](../../transformers_js/helpers/functions/looksLikeSpooledArtifact.md)\n\n***\n\n### looseKeyedToolCallParser\n\nRe-exports [looseKeyedToolCallParser](../../transformers_js/helpers/variables/looseKeyedToolCallParser.md)\n\n***\n\n### makeGemmaChannelReasoningParser\n\nRe-exports [makeGemmaChannelReasoningParser](../../transformers_js/helpers/functions/makeGemmaChannelReasoningParser.md)\n\n***\n\n### makeHarmonyAnalysisReasoningParser\n\nRe-exports [makeHarmonyAnalysisReasoningParser](../../transformers_js/helpers/functions/makeHarmonyAnalysisReasoningParser.md)\n\n***\n\n### makeThinkTagReasoningParser\n\nRe-exports [makeThinkTagReasoningParser](../../transformers_js/helpers/functions/makeThinkTagReasoningParser.md)\n\n***\n\n### mistralToolCallParser\n\nRe-exports [mistralToolCallParser](../../transformers_js/helpers/variables/mistralToolCallParser.md)\n\n***\n\n### noneReasoningParser\n\nRe-exports [noneReasoningParser](../../transformers_js/helpers/variables/noneReasoningParser.md)\n\n***\n\n### noneToolCallParser\n\nRe-exports [noneToolCallParser](../../transformers_js/helpers/variables/noneToolCallParser.md)\n\n***\n\n### ParsedToolCall\n\nRe-exports [ParsedToolCall](../../transformers_js/helpers/interfaces/ParsedToolCall.md)\n\n***\n\n### phiToolCallParser\n\nRe-exports [phiToolCallParser](../../transformers_js/helpers/variables/phiToolCallParser.md)\n\n***\n\n### probeGpuBudget\n\nRe-exports [probeGpuBudget](../../transformers_js/helpers/functions/probeGpuBudget.md)\n\n***\n\n### pythonicToolCallParser\n\nRe-exports [pythonicToolCallParser](../../transformers_js/helpers/variables/pythonicToolCallParser.md)\n\n***\n\n### qwen3CoderToolCallParser\n\nRe-exports [qwen3CoderToolCallParser](../../transformers_js/helpers/variables/qwen3CoderToolCallParser.md)\n\n***\n\n### ReasoningParseResult\n\nRe-exports [ReasoningParseResult](../../transformers_js/helpers/interfaces/ReasoningParseResult.md)\n\n***\n\n### ReasoningParserFn\n\nRe-exports [ReasoningParserFn](../../transformers_js/helpers/type-aliases/ReasoningParserFn.md)\n\n***\n\n### ReasoningParserName\n\nRe-exports [ReasoningParserName](../../transformers_js/helpers/type-aliases/ReasoningParserName.md)\n\n***\n\n### ReasoningParserOptions\n\nRe-exports [ReasoningParserOptions](../../transformers_js/helpers/interfaces/ReasoningParserOptions.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n\n***\n\n### ResolvedGenerationOptions\n\nRe-exports [ResolvedGenerationOptions](../../transformers_js/helpers/interfaces/ResolvedGenerationOptions.md)\n\n***\n\n### resolveGenerationOptions\n\nRe-exports [resolveGenerationOptions](../../transformers_js/helpers/functions/resolveGenerationOptions.md)\n\n***\n\n### resolveReasoningParser\n\nRe-exports [resolveReasoningParser](../../transformers_js/helpers/functions/resolveReasoningParser.md)\n\n***\n\n### resolveToolCallParser\n\nRe-exports [resolveToolCallParser](../../transformers_js/helpers/functions/resolveToolCallParser.md)\n\n***\n\n### thinkTagReasoningParser\n\nRe-exports [thinkTagReasoningParser](../../transformers_js/helpers/variables/thinkTagReasoningParser.md)\n\n***\n\n### ToolCallParserContext\n\nRe-exports [ToolCallParserContext](../../transformers_js/helpers/interfaces/ToolCallParserContext.md)\n\n***\n\n### ToolCallParseResult\n\nRe-exports [ToolCallParseResult](../../transformers_js/helpers/interfaces/ToolCallParseResult.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/buildLiteRtConversationInput","title":"Function: buildLiteRtConversationInput()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/buildLiteRtConversationInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/buildLiteRtConversationInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/buildLiteRtConversationInput.md\n---\n\n# Function: buildLiteRtConversationInput()\n\n```ts\nfunction buildLiteRtConversationInput(input: {\n audioModalityEnabled?: boolean;\n bucketOrder: ChatCompletionsBucketOrder;\n enableThinking?: boolean;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderCtx?: unknown;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderHandle:\n | ((input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string)\n | undefined) => Promise;\n renderMediaToLiteRtContent?: (input: {\n media: Media;\n modalityEnabled: boolean;\n nonce: string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderToolsAsPromptText?: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n toolDelivery?: \"prompt\" | \"native\";\n tools: ToolRegistry;\n toolsToLiteRtTools: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n }) => Tool[];\n unsupportedMediaPolicy?: UnsupportedMediaPolicy;\n visionModalityEnabled?: boolean;\n warn?: (msg: string) => void;\n}): Promise<{\n messages: Message[];\n preface: Preface;\n}>;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:433](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L433)\n\nBuild the LiteRT conversation input from the ADK dispatch context buckets.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `audioModalityEnabled?`: `boolean`; `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `enableThinking?`: `boolean`; `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `MessageContentItem`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`>; `renderMediaToLiteRtContent?`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `modalityEnabled`: `boolean`; `nonce`: `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageContentItem`\\[]>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderToolsAsPromptText?`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `toolDelivery?`: `\"prompt\"` | `\"native\"`; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `toolsToLiteRtTools`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `Tool`\\[]; `unsupportedMediaPolicy?`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `visionModalityEnabled?`: `boolean`; `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.audioModalityEnabled?` | `boolean` | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.enableThinking?` | `boolean` | Whether the model's \"thinking\" mode is enabled. Passed EXPLICITLY into the chat template via `preface.extra_context.enable_thinking` so the template never decides for itself. Defaults to `false`. |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderCtx?` | `unknown` | The live dispatch context, threaded so DYNAMIC (evaluatable) [Tokenizable](../../../../../common/classes/Tokenizable.md) content resolves against it at assembly via `.render(renderCtx)`. Optional — a static Tokenizable ignores it, and callers outside a dispatch may omit it (the evaluator's no-context fallback applies). Typed loosely (the primitive types the arg as `DispatchContext`; this battery does not import that contract). |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `MessageContentItem`> | - |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`> | - |\n| `input.renderMediaToLiteRtContent?` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `modalityEnabled`: `boolean`; `nonce`: `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageContentItem`\\[]> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderToolsAsPromptText?` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.toolDelivery?` | `\"prompt\"` | `\"native\"` | How tool definitions reach the model. `'prompt'` (default) renders them as system-prompt text (the portable path — the Gemma-4 `.litertlm` template throws on native `tools`); `'native'` uses `preface.tools` (the chat-template path — only for models whose template handles tools). |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.toolsToLiteRtTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `Tool`\\[] | - |\n| `input.unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.visionModalityEnabled?` | `boolean` | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`messages`: `Message`\\[];\n`preface`: `Preface`;\n}>\n\n## Remarks\n\nMaps the ADK history model onto LiteRT's `createConversation({ preface })` + per-turn\n`sendMessage(messages)` shape:\n\n* **Leading buckets** (system prompt + standingInstructions / memories / retrievables before\n `timeline` in `bucketOrder`) → a single `preface.messages` system message.\n* **Tools** → `preface.tools`.\n* **Timeline** (messages, surviving thoughts, tool calls — chronological) → the `messages` array\n sent for this turn, each a LiteRT `Message`. Thoughts render via the shared `renderThought` into\n assistant messages; tool calls render an assistant `tool_calls` message + a `tool` role message\n carrying the pre-rendered `tool_response` content item.\n\nReturns `{ preface, messages }` for `engine.createConversation({ preface })` then\n`conversation.sendMessageStreaming(messages)`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/createLiteRtStreamAccumulator","title":"Function: createLiteRtStreamAccumulator()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/createLiteRtStreamAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/createLiteRtStreamAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/createLiteRtStreamAccumulator.md\n---\n\n# Function: createLiteRtStreamAccumulator()\n\n```ts\nfunction createLiteRtStreamAccumulator(): LiteRtStreamAccumulator;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:668](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L668)\n\nCreate a [LiteRtStreamAccumulator](../interfaces/LiteRtStreamAccumulator.md).\n\n## Returns\n\n[`LiteRtStreamAccumulator`](../interfaces/LiteRtStreamAccumulator.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderLiteRtToolResult","title":"Function: renderLiteRtToolResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderLiteRtToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderLiteRtToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderLiteRtToolResult.md\n---\n\n# Function: renderLiteRtToolResult()\n\n```ts\nfunction renderLiteRtToolResult(input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L317)\n\nRender a [@nhtio/adk!ToolCall](../../../../../forge/classes/ToolCall.md)'s `results` into a LiteRT `tool_response` content item.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Override for the artifact-handle body renderer (see [renderArtifactHandleBody](../../../transformers_js/helpers/functions/renderArtifactHandleBody.md)). Defaults to the shared [defaultRenderArtifactHandleBody](../../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md). The adapter threads the consumer's `helpers.renderArtifactHandleBody` here so an app can change which forged `artifact_*` reader the model is steered toward first. |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] | - |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` | - |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<`MessageContentItem`>\n\n## Remarks\n\nA [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) result renders as a HANDLE (metadata + the forged `artifact_*`\ntools to read it) when its `ToolCall.inline === false` — the secure default — and inline via\n`asString()` only when a producer opted into `inline: true`. Applies the trust envelope (reusing the\nshared `renderTrustedContent`/`renderUntrustedContent`). Media results degrade to text via\n[renderMediaToLiteRtContent](renderMediaToLiteRtContent.md)'s fallback path (LiteRT tool responses are text-shaped).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderMediaToLiteRtContent","title":"Function: renderMediaToLiteRtContent()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderMediaToLiteRtContent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderMediaToLiteRtContent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderMediaToLiteRtContent.md\n---\n\n# Function: renderMediaToLiteRtContent()\n\n```ts\nfunction renderMediaToLiteRtContent(input: {\n media: Media;\n modalityEnabled: boolean;\n nonce: string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L211)\n\nRender a media kind/mime/filename into a LiteRT content item, or fall back per\n`unsupportedMediaPolicy`.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `media`: [`Media`](../../../../../common/classes/Media.md); `modalityEnabled`: `boolean`; `nonce`: `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.media` | [`Media`](../../../../../common/classes/Media.md) |\n| `input.modalityEnabled` | `boolean` |\n| `input.nonce` | `string` |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`MessageContentItem`\\[]>\n\n## Remarks\n\nThe preview `.litertlm` models are text-in/text-out, and the exact multimodal content-item wire\nshape is not yet stable in the published types. This maps image/audio/document/video to a\nbest-effort `{ type, path }`-style item when the matching modality flag is enabled, and otherwise\ndegrades through the shared `unsupportedMediaPolicy` (stash text / synthetic description / throw).\nVerify the content-item shape against the installed `.d.ts` + a real multimodal model before\nrelying on the native path.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderToolsAsPromptText","title":"Function: renderToolsAsPromptText()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderToolsAsPromptText.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderToolsAsPromptText","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderToolsAsPromptText.md\n---\n\n# Function: renderToolsAsPromptText()\n\n```ts\nfunction renderToolsAsPromptText(\n tools: readonly (Tool | ArtifactTool)[],\n deps?: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n): string;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L171)\n\nRender tool definitions as a SYSTEM-PROMPT text block (the prompt-injection tool-delivery path),\nrather than the native `preface.tools` field.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n`string`\n\n## Remarks\n\n**Why this exists.** LiteRT-LM applies the model's OWN bundled chat template; for the Gemma-4\n`.litertlm` preview builds, the template's tools branch is broken — passing `preface.tools` throws\n`Failed to apply template: undefined value` inside the wasm runtime (a known Gemma-4 chat-template\nbug, also seen in llama.cpp / mlx-lm / LM Studio when `tools[]` hits the native template). The\nportable fix every other browser runtime uses (WebLLM/MLC, Open WebUI's \"default\" mode) is to\ndescribe the tools as TEXT in the system prompt and parse the model's emitted call out of the output\n— which the shared [createAutoToolCallParser](../../../transformers_js/helpers/functions/createAutoToolCallParser.md) already does (its `gemma` family handles the\ndecoder-stripped `call:NAME{…}` runtime form, plus hermes/pythonic as fallbacks).\n\nThe block lists each tool's name, description, and JSON-Schema parameters, then instructs Gemma's\nOWN trained call format `call:NAME{key:value, …}` — NOT the pythonic `[func(arg=value)]` form. This\nmatters: the LiteRT-web runtime is Gemma-only, and a real Gemma E2B/E4B run emits the\ndecoder-stripped `call:NAME{…}` shape natively (verified via the real-model matrix; the `gemma`\nfamily in [createAutoToolCallParser](../../../transformers_js/helpers/functions/createAutoToolCallParser.md) is built for exactly this). Instructing the pythonic form\ninstead FIGHTS the model's training — a small instruct model, caught between its trained format and a\nconflicting instruction, degenerates to an unparseable hybrid (e.g. `say_i_dont_know\\nreason: …`)\nthat no parser catches, so the \"call\" leaks into the answer as prose. Teaching the model the format\nit already knows makes its natural output parse on the first try. A concrete example is included\nbecause a 2B follows a shown example far more reliably than an abstract grammar.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/toolsToLiteRtTools","title":"Function: toolsToLiteRtTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/toolsToLiteRtTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/toolsToLiteRtTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/toolsToLiteRtTools.md\n---\n\n# Function: toolsToLiteRtTools()\n\n```ts\nfunction toolsToLiteRtTools(\n tools: readonly (Tool | ArtifactTool)[],\n deps?: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n): Tool[];\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L119)\n\nConvert ADK [@nhtio/adk!Tool](../../../../../forge/classes/Tool.md) / [@nhtio/adk!ArtifactTool](../../../../../forge/classes/ArtifactTool.md) instances into LiteRT\n[LiteRtTool](../../types/type-aliases/LiteRtTool.md) definitions.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n`Tool`\\[]\n\n## Remarks\n\nReuses [descriptionToChatCompletionsJsonSchema](../../../../functions/descriptionToChatCompletionsJsonSchema.md) (format-agnostic: joi `describe()` → JSON\nSchema) for the `parameters` field — LiteRT's `Tool.parameters` follows JSON Schema, same as the\nchat-completions `function.parameters`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/interfaces/LiteRtStreamAccumulator","title":"Interface: LiteRtStreamAccumulator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/interfaces/LiteRtStreamAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/interfaces/LiteRtStreamAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/interfaces/LiteRtStreamAccumulator.md\ndescription: A streaming accumulator over LiteRT `ReadableStream` chunks.\n---\n\n# Interface: LiteRtStreamAccumulator\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:648](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L648)\n\nA streaming accumulator over LiteRT `ReadableStream` chunks.\n\n## Remarks\n\nEach chunk is a partial [LiteRtMessage](../../types/type-aliases/LiteRtMessage.md). The `@litert-lm/core` v0.13.1 JS runtime is\n**text-in / text-out**: it emits `content` only and does NOT populate `tool_calls` or `channels` on\noutput (those wire fields exist for feeding history back IN). Tool calls and reasoning come out as\n**raw text inside `content`**, in the model family's own format — the adapter parses them out after\nthe stream drains via the shared tool-call / reasoning parser layer.\n\nSo the accumulator collects assistant `content` text only, handling BOTH delivery conventions —\nincremental deltas (append) and full-accumulated snapshots (replace) — by detecting whether the\nincoming value extends the running buffer (`startsWith`) or is a fresh fragment. It also tolerates\n`content` arriving as a `MessageContentItem[]` by concatenating the text items.\n\n## Methods\n\n### content()\n\n```ts\ncontent(): string;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:652](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L652)\n\nFinal assembled content text.\n\n#### Returns\n\n`string`\n\n***\n\n### feed()\n\n```ts\nfeed(chunk: Message): {\n contentDelta: string;\n};\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:650](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L650)\n\nFeed one chunk; returns the newly-appended content text (for incremental reporting).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `chunk` | `Message` |\n\n#### Returns\n\n```ts\n{\n contentDelta: string;\n}\n```\n\n| Name | Type | Defined in |\n| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `contentDelta` | `string` | [src/batteries/llm/litert\\_lm/helpers.ts:650](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L650) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultBuildLiteRtConversationInput","title":"Variable: defaultBuildLiteRtConversationInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultBuildLiteRtConversationInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultBuildLiteRtConversationInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultBuildLiteRtConversationInput.md\ndescription: 'Default [`buildLiteRtConversationInput`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/buildLiteRtConversationInput).'\n---\n\n# Variable: defaultBuildLiteRtConversationInput\n\n```ts\nconst defaultBuildLiteRtConversationInput: (input: {\n audioModalityEnabled?: boolean;\n bucketOrder: ChatCompletionsBucketOrder;\n enableThinking?: boolean;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderCtx?: unknown;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderHandle:\n | ((input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string)\n | undefined) => Promise;\n renderMediaToLiteRtContent?: (input: {\n media: Media;\n modalityEnabled: boolean;\n nonce: string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderToolsAsPromptText?: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n toolDelivery?: \"prompt\" | \"native\";\n tools: ToolRegistry;\n toolsToLiteRtTools: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n }) => Tool[];\n unsupportedMediaPolicy?: UnsupportedMediaPolicy;\n visionModalityEnabled?: boolean;\n warn?: (msg: string) => void;\n}) => Promise<{\n messages: Message[];\n preface: Preface;\n}> = buildLiteRtConversationInput;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:631](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L631)\n\nDefault [buildLiteRtConversationInput](../functions/buildLiteRtConversationInput.md).\n\nBuild the LiteRT conversation input from the ADK dispatch context buckets.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `audioModalityEnabled?`: `boolean`; `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `enableThinking?`: `boolean`; `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `MessageContentItem`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`>; `renderMediaToLiteRtContent?`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `modalityEnabled`: `boolean`; `nonce`: `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageContentItem`\\[]>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderToolsAsPromptText?`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `toolDelivery?`: `\"prompt\"` | `\"native\"`; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `toolsToLiteRtTools`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `Tool`\\[]; `unsupportedMediaPolicy?`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `visionModalityEnabled?`: `boolean`; `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.audioModalityEnabled?` | `boolean` | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.enableThinking?` | `boolean` | Whether the model's \"thinking\" mode is enabled. Passed EXPLICITLY into the chat template via `preface.extra_context.enable_thinking` so the template never decides for itself. Defaults to `false`. |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderCtx?` | `unknown` | The live dispatch context, threaded so DYNAMIC (evaluatable) [Tokenizable](../../../../../common/classes/Tokenizable.md) content resolves against it at assembly via `.render(renderCtx)`. Optional — a static Tokenizable ignores it, and callers outside a dispatch may omit it (the evaluator's no-context fallback applies). Typed loosely (the primitive types the arg as `DispatchContext`; this battery does not import that contract). |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `MessageContentItem`> | - |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`> | - |\n| `input.renderMediaToLiteRtContent?` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `modalityEnabled`: `boolean`; `nonce`: `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`MessageContentItem`\\[]> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderToolsAsPromptText?` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.toolDelivery?` | `\"prompt\"` | `\"native\"` | How tool definitions reach the model. `'prompt'` (default) renders them as system-prompt text (the portable path — the Gemma-4 `.litertlm` template throws on native `tools`); `'native'` uses `preface.tools` (the chat-template path — only for models whose template handles tools). |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.toolsToLiteRtTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => `Tool`\\[] | - |\n| `input.unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.visionModalityEnabled?` | `boolean` | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`messages`: `Message`\\[];\n`preface`: `Preface`;\n}>\n\n## Remarks\n\nMaps the ADK history model onto LiteRT's `createConversation({ preface })` + per-turn\n`sendMessage(messages)` shape:\n\n* **Leading buckets** (system prompt + standingInstructions / memories / retrievables before\n `timeline` in `bucketOrder`) → a single `preface.messages` system message.\n* **Tools** → `preface.tools`.\n* **Timeline** (messages, surviving thoughts, tool calls — chronological) → the `messages` array\n sent for this turn, each a LiteRT `Message`. Thoughts render via the shared `renderThought` into\n assistant messages; tool calls render an assistant `tool_calls` message + a `tool` role message\n carrying the pre-rendered `tool_response` content item.\n\nReturns `{ preface, messages }` for `engine.createConversation({ preface })` then\n`conversation.sendMessageStreaming(messages)`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultCreateLiteRtStreamAccumulator","title":"Variable: defaultCreateLiteRtStreamAccumulator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultCreateLiteRtStreamAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultCreateLiteRtStreamAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultCreateLiteRtStreamAccumulator.md\ndescription: 'Default [`createLiteRtStreamAccumulator`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/createLiteRtStreamAccumulator).'\n---\n\n# Variable: defaultCreateLiteRtStreamAccumulator\n\n```ts\nconst defaultCreateLiteRtStreamAccumulator: () => LiteRtStreamAccumulator =\n createLiteRtStreamAccumulator;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:696](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L696)\n\nDefault [createLiteRtStreamAccumulator](../functions/createLiteRtStreamAccumulator.md).\n\nCreate a [LiteRtStreamAccumulator](../interfaces/LiteRtStreamAccumulator.md).\n\n## Returns\n\n[`LiteRtStreamAccumulator`](../interfaces/LiteRtStreamAccumulator.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderLiteRtToolResult","title":"Variable: defaultRenderLiteRtToolResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderLiteRtToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderLiteRtToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderLiteRtToolResult.md\ndescription: 'Default [`renderLiteRtToolResult`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderLiteRtToolResult).'\n---\n\n# Variable: defaultRenderLiteRtToolResult\n\n```ts\nconst defaultRenderLiteRtToolResult: (input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderLiteRtToolResult;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:413](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L413)\n\nDefault [renderLiteRtToolResult](../functions/renderLiteRtToolResult.md).\n\nRender a [@nhtio/adk!ToolCall](../../../../../forge/classes/ToolCall.md)'s `results` into a LiteRT `tool_response` content item.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Override for the artifact-handle body renderer (see [renderArtifactHandleBody](../../../transformers_js/helpers/functions/renderArtifactHandleBody.md)). Defaults to the shared [defaultRenderArtifactHandleBody](../../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md). The adapter threads the consumer's `helpers.renderArtifactHandleBody` here so an app can change which forged `artifact_*` reader the model is steered toward first. |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] | - |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` | - |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<`MessageContentItem`>\n\n## Remarks\n\nA [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) result renders as a HANDLE (metadata + the forged `artifact_*`\ntools to read it) when its `ToolCall.inline === false` — the secure default — and inline via\n`asString()` only when a producer opted into `inline: true`. Applies the trust envelope (reusing the\nshared `renderTrustedContent`/`renderUntrustedContent`). Media results degrade to text via\n[renderMediaToLiteRtContent](../functions/renderMediaToLiteRtContent.md)'s fallback path (LiteRT tool responses are text-shaped).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderToolsAsPromptText","title":"Variable: defaultRenderToolsAsPromptText","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderToolsAsPromptText.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderToolsAsPromptText","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultRenderToolsAsPromptText.md\ndescription: 'Default [`renderToolsAsPromptText`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/renderToolsAsPromptText).'\n---\n\n# Variable: defaultRenderToolsAsPromptText\n\n```ts\nconst defaultRenderToolsAsPromptText: (\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n) => string = renderToolsAsPromptText;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L197)\n\nDefault [renderToolsAsPromptText](../functions/renderToolsAsPromptText.md).\n\nRender tool definitions as a SYSTEM-PROMPT text block (the prompt-injection tool-delivery path),\nrather than the native `preface.tools` field.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n`string`\n\n## Remarks\n\n**Why this exists.** LiteRT-LM applies the model's OWN bundled chat template; for the Gemma-4\n`.litertlm` preview builds, the template's tools branch is broken — passing `preface.tools` throws\n`Failed to apply template: undefined value` inside the wasm runtime (a known Gemma-4 chat-template\nbug, also seen in llama.cpp / mlx-lm / LM Studio when `tools[]` hits the native template). The\nportable fix every other browser runtime uses (WebLLM/MLC, Open WebUI's \"default\" mode) is to\ndescribe the tools as TEXT in the system prompt and parse the model's emitted call out of the output\n— which the shared [createAutoToolCallParser](../../../transformers_js/helpers/functions/createAutoToolCallParser.md) already does (its `gemma` family handles the\ndecoder-stripped `call:NAME{…}` runtime form, plus hermes/pythonic as fallbacks).\n\nThe block lists each tool's name, description, and JSON-Schema parameters, then instructs Gemma's\nOWN trained call format `call:NAME{key:value, …}` — NOT the pythonic `[func(arg=value)]` form. This\nmatters: the LiteRT-web runtime is Gemma-only, and a real Gemma E2B/E4B run emits the\ndecoder-stripped `call:NAME{…}` shape natively (verified via the real-model matrix; the `gemma`\nfamily in [createAutoToolCallParser](../../../transformers_js/helpers/functions/createAutoToolCallParser.md) is built for exactly this). Instructing the pythonic form\ninstead FIGHTS the model's training — a small instruct model, caught between its trained format and a\nconflicting instruction, degenerates to an unparseable hybrid (e.g. `say_i_dont_know\\nreason: …`)\nthat no parser catches, so the \"call\" leaks into the answer as prose. Teaching the model the format\nit already knows makes its natural output parse on the first try. A concrete example is included\nbecause a 2B follows a shown example far more reliably than an abstract grammar.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultToolsToLiteRtTools","title":"Variable: defaultToolsToLiteRtTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultToolsToLiteRtTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultToolsToLiteRtTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/variables/defaultToolsToLiteRtTools.md\ndescription: 'Default [`toolsToLiteRtTools`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/helpers/functions/toolsToLiteRtTools).'\n---\n\n# Variable: defaultToolsToLiteRtTools\n\n```ts\nconst defaultToolsToLiteRtTools: (\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n) => Tool[] = toolsToLiteRtTools;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/helpers.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/helpers.ts#L144)\n\nDefault [toolsToLiteRtTools](../functions/toolsToLiteRtTools.md).\n\nConvert ADK [@nhtio/adk!Tool](../../../../../forge/classes/Tool.md) / [@nhtio/adk!ArtifactTool](../../../../../forge/classes/ArtifactTool.md) instances into LiteRT\n[LiteRtTool](../../types/type-aliases/LiteRtTool.md) definitions.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n`Tool`\\[]\n\n## Remarks\n\nReuses [descriptionToChatCompletionsJsonSchema](../../../../functions/descriptionToChatCompletionsJsonSchema.md) (format-agnostic: joi `describe()` → JSON\nSchema) for the `parameters` field — LiteRT's `Tool.parameters` follows JSON Schema, same as the\nchat-completions `function.parameters`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types","title":"@nhtio/adk/batteries/llm/litert\\_lm/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types.md'\ndescription: >-\n Types for the LiteRT-LM adapter — options, engine/conversation aliases, and\n the LiteRT wire shapes re-exported from `@litert-lm/core`.\n---\n\n# @nhtio/adk/batteries/llm/litert\\_lm/types\n\nTypes for the LiteRT-LM adapter — options, engine/conversation aliases, and the LiteRT wire\nshapes re-exported from `@litert-lm/core`.\n\n## Remarks\n\n**The published `@litert-lm/core` JS guide lags the library.** The shapes below mirror the\ninstalled package's type declarations (the source of truth), which expose tool use, channels\n(\"thinking\"), sampler controls, and multimodality that the public docs omit. Verify against the\ninstalled `.d.ts` when upgrading — the dependency is young and volatile.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| [LiteRtLmAdapterOptions](interfaces/LiteRtLmAdapterOptions.md) | Configuration for the in-browser LiteRT-LM adapter. |\n| [LiteRtSamplerParametersOption](interfaces/LiteRtSamplerParametersOption.md) | Sampler-parameters option shape (the `type` field accepts the numeric [SamplerType](type-aliases/SamplerType.md) value). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- |\n| [Backend](type-aliases/Backend.md) | Inference-backend enum value: `CPU`, `GPU`, etc. |\n| [CreateLiteRtLmEngine](type-aliases/CreateLiteRtLmEngine.md) | Factory that loads a `.litertlm` model and resolves a ready-to-use [LiteRtLmEngine](type-aliases/LiteRtLmEngine.md). |\n| [LiteRtConversationConfig](type-aliases/LiteRtConversationConfig.md) | Configuration for an [LiteRtLmConversation](type-aliases/LiteRtLmConversation.md). |\n| [LiteRtEngineSettings](type-aliases/LiteRtEngineSettings.md) | Engine-construction settings (`{ model, backend?, mainExecutorSettings? }`). |\n| [LiteRtLlmExecutorSettings](type-aliases/LiteRtLlmExecutorSettings.md) | Per-executor settings (context length, backend config, sampler backend). |\n| [LiteRtLmChatEngine](type-aliases/LiteRtLmChatEngine.md) | Alias of [LiteRtLmEngine](type-aliases/LiteRtLmEngine.md). |\n| [LiteRtLmConversation](type-aliases/LiteRtLmConversation.md) | A live LiteRT conversation created from an engine for one dispatch. |\n| [LiteRtLmDescriptionLike](type-aliases/LiteRtLmDescriptionLike.md) | The description envelope a joi schema produces, consumed by the JSON-schema converter. |\n| [LiteRtLmEngine](type-aliases/LiteRtLmEngine.md) | The LiteRT-LM engine instance the adapter drives. |\n| [LiteRtLmInitProgressReport](type-aliases/LiteRtLmInitProgressReport.md) | Progress report emitted while a LiteRT model loads. Provider-opaque; passed through verbatim. |\n| [LiteRtLmJsonSchema](type-aliases/LiteRtLmJsonSchema.md) | The JSON-schema-shaped value used for a tool's `parameters` field (re-export for convenience). |\n| [LiteRtMessage](type-aliases/LiteRtMessage.md) | A message in a LiteRT conversation: `{ role, content?, channels?, tool_calls? }`. |\n| [LiteRtMessageContentItem](type-aliases/LiteRtMessageContentItem.md) | An item in a message's content array (`{ type, text?, path?, tool_response? }`). |\n| [LiteRtMessageLike](type-aliases/LiteRtMessageLike.md) | A string or [LiteRtMessage](type-aliases/LiteRtMessage.md). |\n| [LiteRtPreface](type-aliases/LiteRtPreface.md) | Initial messages, tools, and context the conversation begins with. |\n| [LiteRtSamplerParameters](type-aliases/LiteRtSamplerParameters.md) | Sampler configuration (`{ type, k, p, temperature, seed }`). |\n| [LiteRtSessionConfig](type-aliases/LiteRtSessionConfig.md) | Per-session generation configuration (sampler, modality flags, output limits). |\n| [LiteRtTool](type-aliases/LiteRtTool.md) | A tool definition exposed to the model (`{ name, description?, parameters? }`). |\n| [LiteRtToolCall](type-aliases/LiteRtToolCall.md) | A tool call predicted by the model (`{ type, function: { name, arguments } }`). |\n| [LiteRtToolCallFunction](type-aliases/LiteRtToolCallFunction.md) | The function payload of a [LiteRtToolCall](type-aliases/LiteRtToolCall.md) (`{ name, arguments: object }`). |\n| [LiteRtToolParameters](type-aliases/LiteRtToolParameters.md) | Parameters for a [LiteRtTool](type-aliases/LiteRtTool.md), following JSON Schema. |\n| [LiteRtToolResponseValue](type-aliases/LiteRtToolResponseValue.md) | A tool response value fed back to the model. |\n| [SamplerType](type-aliases/SamplerType.md) | Sampler-type enum value: `TOP_K`, `TOP_P`, `GREEDY`. |\n\n## References\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### LiteRtLmBucketOrder\n\nRenames and re-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### LiteRtLmHelpers\n\nRenames and re-exports [ChatCompletionsHelpers](../../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtLmAdapterOptions","title":"Interface: LiteRtLmAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtLmAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtLmAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtLmAdapterOptions.md\ndescription: Configuration for the in-browser LiteRT-LM adapter.\n---\n\n# Interface: LiteRtLmAdapterOptions\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L140)\n\nConfiguration for the in-browser LiteRT-LM adapter.\n\n## Remarks\n\nSplits into three groups: **engine** controls (model + injection/loading), **generation** controls\n(LiteRT-native sampler/limits — NOT OpenAI sampling params), and **ADK-control** options shared with\nthe other LLM batteries (history shaping, trust, storage, media policy).\n\n## Extends\n\n* [`BatteryLifecycleHooks`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `audioModalityEnabled?` | `boolean` | Enable audio input. Maps to `SessionConfig.audioModalityEnabled`. When set, a user `Message`'s audio `attachments` map to LiteRT `{type:'audio', path:'data:…'}` content items; otherwise they degrade via `unsupportedMediaPolicy`. **Remarks** **This is the only multimodal knob the installed `@litert-lm/core` 0.13.1 exposes.** The build does NOT surface engine-level vision/audio backends (`EngineSettings` is `{model, backend?, mainExecutorSettings?}`; the WASM `createDefault` takes a single backend) — only this `SessionConfig` flag + `MessageContentItem.path` exist (`blob` is untyped). Whether the WASM runtime actually consumes the content items is **not yet runtime-verified in 0.13.1** (the published types over-promise — same shape as the `tool_calls` finding); the browser model matrix is the gate-on-proof. If the runtime ignores them, configure `unsupportedMediaPolicy` to degrade. | - | [src/batteries/llm/litert\\_lm/types.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L203) |\n| `autoAck?` | `boolean` | Automatically `ctx.ack()` when generation completes with no tool calls (default `false`). | - | [src/batteries/llm/litert\\_lm/types.ts:240](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L240) |\n| `backend?` | `number` | Inference backend (`CPU` / `GPU` / …). Maps to `EngineSettings.backend`. | - | [src/batteries/llm/litert\\_lm/types.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L188) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Order in which the leading/trailing context buckets are rendered. | - | [src/batteries/llm/litert\\_lm/types.ts:220](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L220) |\n| `contextWindow?` | `number` | Hard context-window token budget; enforced only when [LiteRtLmAdapterOptions.tokenEncoding](#property-tokenencoding) is non-null. | - | [src/batteries/llm/litert\\_lm/types.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L222) |\n| `createEngine?` | [`CreateLiteRtLmEngine`](../type-aliases/CreateLiteRtLmEngine.md) | Custom engine factory; overrides the default `Engine.create(...)` loader. | - | [src/batteries/llm/litert\\_lm/types.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L150) |\n| `enableConstrainedDecoding?` | `boolean` | Enable constrained decoding (channels). Maps to `ConversationConfig.enableConstrainedDecoding`. | - | [src/batteries/llm/litert\\_lm/types.ts:212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L212) |\n| `enableThinking?` | `boolean` | Whether to enable the model's \"thinking\"/reasoning mode, passed EXPLICITLY into the chat template via `preface.extra_context.enable_thinking`. Defaults to `false` — the gemma-4 `.litertlm` template gates `< | think | >`on`enable_thinking`, and leaving it unset lets the runtime decide (often ON), silently burning the output budget inside the thought channel. (Independent of `reasoningParser`, which only parses thinking that IS emitted.) | - | [src/batteries/llm/litert\\_lm/types.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L278) |\n| `engine?` | `Engine` | A pre-constructed engine to drive; mutually exclusive with [LiteRtLmAdapterOptions.createEngine](#property-createengine). | - | [src/batteries/llm/litert\\_lm/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L148) |\n| `extractMediaOutputs?` | [`MediaOutputExtractorFn`](../../../transformers_js/type-aliases/MediaOutputExtractorFn.md) | Extract GENERATED media (audio/image/…) from the raw LiteRT generation result and surface it as attachments on the assistant [@nhtio/adk!Message](../../../../../common/classes/Message.md). Default absent → text-only output, unchanged. Receives the raw final `LiteRtMessage` (whose `content` may be a structured `MessageContentItem[]`); each returned descriptor is persisted via `ctx.storeMediaBytes` and attached as `Media.toolGenerated`. The current `@litert-lm/core` runtime emits only `{type:'text'}` items, so this is a forward-looking seam for a model that emits media content items. | - | [src/batteries/llm/litert\\_lm/types.ts:299](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L299) |\n| `filterChannelContentFromKvCache?` | `boolean` | Drop channel (\"thinking\") content from the KV cache. Maps to `ConversationConfig.filterChannelContentFromKvCache`. | - | [src/batteries/llm/litert\\_lm/types.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L214) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | OPTIONAL hook to SHAPE the artifact-query tools forged from prior-turn SpooledArtifact results, before they merge into the visible tool set. Receives the merged forged registry + dispatch context; returns a (possibly narrowed) registry, applied BEFORE the merge with `ctx.tools`. Lets the assembler keep only the core readers on a tight window (the rest reachable via tool\\_catalog/call\\_a\\_tool). Default absent = identity (all forged tools) = backward-compatible. The battery stays budget-agnostic (per the CONTRIBUTING size-threshold rule) — it applies the supplied filter without measuring context; budget logic lives in the caller's filter. | - | [src/batteries/llm/litert\\_lm/types.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L257) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`ChatCompletionsHelpers`](../../../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)> | Pluggable per-function overrides for the rendering/translation helpers. | - | [src/batteries/llm/litert\\_lm/types.ts:234](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L234) |\n| `inputPromptAsHint?` | `string` | Optional hint prompt passed to `Engine.create(settings, inputPromptAsHint)` to warm the cache. | - | [src/batteries/llm/litert\\_lm/types.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L156) |\n| `isWebGPUAvailable?` | () => `boolean` | Override for the WebGPU-availability probe (defaults to a real `navigator.gpu` check). | - | [src/batteries/llm/litert\\_lm/types.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L154) |\n| `maxNumTokens?` | `number` | Context length (LiteRT-only). Maps to `EngineSettings.mainExecutorSettings.maxNumTokens`. Default `4096`. | - | [src/batteries/llm/litert\\_lm/types.ts:186](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L186) |\n| `maxOutputTokens?` | `number` | Native max tokens per turn. Prefer [maxTokens](#property-maxtokens). Maps to `SessionConfig.maxOutputTokens`. | - | [src/batteries/llm/litert\\_lm/types.ts:184](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L184) |\n| `maxTokens?` | `number` | Portable max generation length (canonical spelling of [maxOutputTokens](#property-maxoutputtokens)). Default `1024`. | - | [src/batteries/llm/litert\\_lm/types.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L162) |\n| `model` | `string` | `Blob` | `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>> | The `.litertlm` model to load: a URL string, a `ReadableStream`, or a `Blob`. Required. The model is fixed at engine-load time, not per request. | - | [src/batteries/llm/litert\\_lm/types.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L146) |\n| `multimodal?` | { `audio?`: `boolean`; `image?`: `boolean`; } | Enable multimodal input by kind (canonical spelling of [visionModalityEnabled](#property-visionmodalityenabled) + [audioModalityEnabled](#property-audiomodalityenabled)). | - | [src/batteries/llm/litert\\_lm/types.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L176) |\n| `multimodal.audio?` | `boolean` | - | - | [src/batteries/llm/litert\\_lm/types.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L176) |\n| `multimodal.image?` | `boolean` | - | - | [src/batteries/llm/litert\\_lm/types.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L176) |\n| `onCompiling?` | [`BatteryLifecycleCallback`](../../../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`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onCompiling`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-oncompiling) | [src/batteries/llm/chat\\_common/lifecycle.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `onComplete?` | [`BatteryLifecycleCallback`](../../../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | After the turn's output is parsed + persisted, before `ack` (fires per turn). | [`BatteryLifecycleHooks`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onComplete`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-oncomplete) | [src/batteries/llm/chat\\_common/lifecycle.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `onError?` | [`BatteryLifecycleCallback`](../../../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | A load or generation failure (paired with `nack`). | [`BatteryLifecycleHooks`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onError`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onerror) | [src/batteries/llm/chat\\_common/lifecycle.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `onGenerating?` | [`BatteryLifecycleCallback`](../../../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`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onGenerating`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-ongenerating) | [src/batteries/llm/chat\\_common/lifecycle.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `onInitProgress?` | (`report`: `unknown`) => `void` | Callback invoked with model-load progress reports (provider-opaque). | - | [src/batteries/llm/litert\\_lm/types.ts:152](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L152) |\n| `onLifecycle?` | [`BatteryLifecycleCallback`](../../../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | Fires on EVERY phase transition (the firehose). | [`BatteryLifecycleHooks`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onLifecycle`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onlifecycle) | [src/batteries/llm/chat\\_common/lifecycle.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `onLoading?` | [`BatteryLifecycleCallback`](../../../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | Weights/runtime loading — may fire repeatedly with `progress` as the provider reports it. | [`BatteryLifecycleHooks`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onLoading`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onloading) | [src/batteries/llm/chat\\_common/lifecycle.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | Observe the fully-assembled prompt this battery is about to send TO the model — fired once per terminal generation, the instant assembly completes and BEFORE the engine dispatch, with the rendered `preface`, the per-turn `messages`, and the rendered `tools` block. The mirror of [onRawGeneration](#property-onrawgeneration) (which taps what comes back). Purely observational (return value ignored, errors swallowed). Default absent. The request is handed back AS-IS — no redaction — so treat it as potentially sensitive if you persist it. See [PromptAssembledObserverFn](../../../../type-aliases/PromptAssembledObserverFn.md). | - | [src/batteries/llm/litert\\_lm/types.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L318) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | Observe the model's RAW text output for each completed generation — fired once per terminal generation, after envelope-stripping + reasoning/tool-call parsing but before the result is persisted, with the complete `rawText`, the residual `cleanedText`, and the extracted `reasoning` / `toolCalls`. Purely observational (return value ignored, errors swallowed). Default absent. This is the supported seam for parser bring-up against a new model, live \"why did it abstain?\" debugging, and ground-truth fixture capture — the job that previously needed a temporary hook patched into the adapter. See [RawGenerationObserverFn](../../../../type-aliases/RawGenerationObserverFn.md). | - | [src/batteries/llm/litert\\_lm/types.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L309) |\n| `onReady?` | [`BatteryLifecycleCallback`](../../../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md) | Engine/pipeline resolved and cached, before the first generation. | [`BatteryLifecycleHooks`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md).[`onReady`](../../../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md#property-onready) | [src/batteries/llm/chat\\_common/lifecycle.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `reasoningFieldPrecedence?` | [`ReasoningFieldPrecedence`](../../../openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md) | Precedence order for reasoning/thought fields. | - | [src/batteries/llm/litert\\_lm/types.ts:232](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L232) |\n| `reasoningOrphanRecovery?` | `boolean` | Recover UNPAIRED reasoning markers (a lone ``, a truncated ``) by inferring the missing half from the pseudo-streaming order, instead of leaking the stray marker into the visible answer. Defaults to `true`. Set `false` for strict pair-only parsing. Ignored when `reasoningParser` is a custom function. | - | [src/batteries/llm/litert\\_lm/types.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L290) |\n| `reasoningParser?` | | [`ReasoningParserName`](../../../transformers_js/helpers/type-aliases/ReasoningParserName.md) | [`ReasoningParserFn`](../../../transformers_js/helpers/type-aliases/ReasoningParserFn.md) | How to parse reasoning/thinking out of the model's text output. A family name, `'auto'` (the default), `'none'`, or a custom [ReasoningParserFn](../../../transformers_js/helpers/type-aliases/ReasoningParserFn.md). Extracted reasoning becomes ADK Thoughts. | - | [src/batteries/llm/litert\\_lm/types.ts:283](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L283) |\n| `replayCompatibility?` | readonly `string`\\[] | Replay-compatibility tags whose opaque reasoning payloads may be replayed. | - | [src/batteries/llm/litert\\_lm/types.ts:230](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L230) |\n| `sampler?` | [`ChatSampler`](../../../transformers_js/helpers/type-aliases/ChatSampler.md) | Portable sampler strategy (`'greedy'` default). Maps to `samplerParams.type` (GREEDY/TOP\\_K/TOP\\_P); GREEDY is top-1 so `k` is forced to 1. Canonical spelling of [samplerParams](#property-samplerparams)`.type`. | - | [src/batteries/llm/litert\\_lm/types.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L165) |\n| `samplerParams?` | [`LiteRtSamplerParametersOption`](LiteRtSamplerParametersOption.md) | Native sampler config `{ type, k, p, temperature, seed }`. Prefer [sampler](#property-sampler)/[temperature](#property-temperature)/ [topK](#property-topk)/[topP](#property-topp). Maps to `SessionConfig.samplerParams`. | - | [src/batteries/llm/litert\\_lm/types.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L182) |\n| `seed?` | `number` | RNG seed for reproducible sampling. | - | [src/batteries/llm/litert\\_lm/types.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L173) |\n| `selfIdentity?` | `string` | The assistant identity this adapter speaks as (default `'assistant'`). | - | [src/batteries/llm/litert\\_lm/types.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L224) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | Byte store for spooling raw tool output (defaults to a per-dispatch in-memory store). | - | [src/batteries/llm/litert\\_lm/types.ts:236](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L236) |\n| `stream?` | `boolean` | Stream tokens (default `true`). When `false`, a single completed message is returned. | - | [src/batteries/llm/litert\\_lm/types.ts:218](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L218) |\n| `temperature?` | `number` | Sampling temperature (used by `'top-k'`/`'top-p'`). Default `0.7`. | - | [src/batteries/llm/litert\\_lm/types.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L167) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Which thoughts are surfaced into history. | - | [src/batteries/llm/litert\\_lm/types.ts:226](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L226) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | Token encoding used for context-window accounting, or `null` to disable accounting (default `null`). | - | [src/batteries/llm/litert\\_lm/types.ts:228](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L228) |\n| `toolCallParser?` | | [`ToolCallParserName`](../../../transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) | How to parse tool calls out of the model's text output. LiteRT-LM (v0.13.1) is text-in/text-out: the model emits tool calls as family-specific text, not a structured field. A family name, `'auto'` (try-all in priority order — the default), `'none'` (disable), or a custom [ToolCallParserFn](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md). | - | [src/batteries/llm/litert\\_lm/types.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L247) |\n| `toolDelivery?` | `\"prompt\"` | `\"native\"` | How tool definitions are delivered to the model. Defaults to `'prompt'`. - `'prompt'` — render the tool definitions as a text block in the system prompt and parse the model's emitted call from its output (via `toolCallParser`). The portable path: LiteRT-LM applies the model's OWN bundled chat template, and the Gemma-4 `.litertlm` template's tools branch is broken (passing native `tools` throws `Failed to apply template: undefined value` in the wasm runtime — a known Gemma-4 template bug). This mirrors how WebLLM/MLC and Open WebUI's default mode give Gemma tools. - `'native'` — pass tool definitions via `preface.tools` (the chat-template path). Use ONLY for models whose template correctly renders a tools section. | - | [src/batteries/llm/litert\\_lm/types.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L270) |\n| `topK?` | `number` | Top-K cutoff (used by `'top-k'`). Default `40`. | - | [src/batteries/llm/litert\\_lm/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L169) |\n| `topP?` | `number` | Top-P (nucleus) cutoff (used by `'top-p'`). Default `0.95`. | - | [src/batteries/llm/litert\\_lm/types.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L171) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | How to handle media the model cannot natively consume (default `'throw'`). | - | [src/batteries/llm/litert\\_lm/types.ts:238](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L238) |\n| `visionModalityEnabled?` | `boolean` | Enable vision input. Maps to `SessionConfig.visionModalityEnabled`. When set, a user `Message`'s image `attachments` map to LiteRT `{type:'image', path:'data:…'}` content items; otherwise they degrade via `unsupportedMediaPolicy`. See [audioModalityEnabled](#property-audiomodalityenabled) for the 0.13.1 runtime-vs-types caveat (gated on a real-model proof). | - | [src/batteries/llm/litert\\_lm/types.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L210) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtSamplerParametersOption","title":"Interface: LiteRtSamplerParametersOption","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtSamplerParametersOption.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtSamplerParametersOption","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtSamplerParametersOption.md\ndescription: >-\n Sampler-parameters option shape (the `type` field accepts the numeric {@link\n SamplerType} value).\n---\n\n# Interface: LiteRtSamplerParametersOption\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L322)\n\nSampler-parameters option shape (the `type` field accepts the numeric [SamplerType](../type-aliases/SamplerType.md) value).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | -------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `k?` | `number` | Top-K cutoff. | [src/batteries/llm/litert\\_lm/types.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L326) |\n| `p?` | `number` | Top-P (nucleus) cutoff. | [src/batteries/llm/litert\\_lm/types.ts:328](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L328) |\n| `seed?` | `number` | RNG seed for reproducible sampling. | [src/batteries/llm/litert\\_lm/types.ts:332](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L332) |\n| `temperature?` | `number` | Sampling temperature. | [src/batteries/llm/litert\\_lm/types.ts:330](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L330) |\n| `type?` | `number` | Sampler strategy: `SamplerType.TOP_K | TOP_P | GREEDY`. | [src/batteries/llm/litert\\_lm/types.ts:324](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L324) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/Backend","title":"Type Alias: Backend","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/Backend.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/Backend","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/Backend.md\ndescription: 'Inference-backend enum value: `CPU`, `GPU`, etc.'\n---\n\n# Type Alias: Backend\n\n```ts\ntype Backend = LiteRtBackendEnum;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L95)\n\nInference-backend enum value: `CPU`, `GPU`, etc.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/CreateLiteRtLmEngine","title":"Type Alias: CreateLiteRtLmEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/CreateLiteRtLmEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/CreateLiteRtLmEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/CreateLiteRtLmEngine.md\ndescription: >-\n Factory that loads a `.litertlm` model and resolves a ready-to-use {@link\n LiteRtLmEngine}.\n---\n\n# Type Alias: CreateLiteRtLmEngine\n\n```ts\ntype CreateLiteRtLmEngine = (input: {\n engineSettings: EngineSettings;\n onInitProgress?: (report: LiteRtLmInitProgressReport) => void;\n}) => Promise;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L115)\n\nFactory that loads a `.litertlm` model and resolves a ready-to-use [LiteRtLmEngine](LiteRtLmEngine.md).\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `engineSettings`: `EngineSettings`; `onInitProgress?`: (`report`: [`LiteRtLmInitProgressReport`](LiteRtLmInitProgressReport.md)) => `void`; } |\n| `input.engineSettings` | `EngineSettings` |\n| `input.onInitProgress?` | (`report`: [`LiteRtLmInitProgressReport`](LiteRtLmInitProgressReport.md)) => `void` |\n\n## Returns\n\n`Promise`<[`LiteRtLmEngine`](LiteRtLmEngine.md)>\n\n## Remarks\n\nThe default factory (when this option is omitted) dynamically imports `@litert-lm/core` and calls\n`Engine.create(engineSettings)`. Supply a custom factory to control the WebGPU/worker setup, to\ninject a pre-warmed engine, or to mock the engine in tests without WebGPU.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtConversationConfig","title":"Type Alias: LiteRtConversationConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtConversationConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtConversationConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtConversationConfig.md\ndescription: 'Configuration for an [`LiteRtLmConversation`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmConversation).'\n---\n\n# Type Alias: LiteRtConversationConfig\n\n```ts\ntype LiteRtConversationConfig = ConversationConfig;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L83)\n\nConfiguration for an [LiteRtLmConversation](LiteRtLmConversation.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtEngineSettings","title":"Type Alias: LiteRtEngineSettings","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtEngineSettings.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtEngineSettings","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtEngineSettings.md\ndescription: 'Engine-construction settings (`{ model, backend?, mainExecutorSettings? }`).'\n---\n\n# Type Alias: LiteRtEngineSettings\n\n```ts\ntype LiteRtEngineSettings = EngineSettings;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L89)\n\nEngine-construction settings (`{ model, backend?, mainExecutorSettings? }`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLlmExecutorSettings","title":"Type Alias: LiteRtLlmExecutorSettings","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLlmExecutorSettings.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLlmExecutorSettings","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLlmExecutorSettings.md\ndescription: 'Per-executor settings (context length, backend config, sampler backend).'\n---\n\n# Type Alias: LiteRtLlmExecutorSettings\n\n```ts\ntype LiteRtLlmExecutorSettings = LlmExecutorSettings;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L91)\n\nPer-executor settings (context length, backend config, sampler backend).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmChatEngine","title":"Type Alias: LiteRtLmChatEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmChatEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmChatEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmChatEngine.md\ndescription: 'Alias of [`LiteRtLmEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmEngine).'\n---\n\n# Type Alias: LiteRtLmChatEngine\n\n```ts\ntype LiteRtLmChatEngine = LiteRtLmEngine;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L100)\n\nAlias of [LiteRtLmEngine](LiteRtLmEngine.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmConversation","title":"Type Alias: LiteRtLmConversation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmConversation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmConversation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmConversation.md\ndescription: A live LiteRT conversation created from an engine for one dispatch.\n---\n\n# Type Alias: LiteRtLmConversation\n\n```ts\ntype LiteRtLmConversation = LiteRtConversationClass;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L102)\n\nA live LiteRT conversation created from an engine for one dispatch.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmDescriptionLike","title":"Type Alias: LiteRtLmDescriptionLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmDescriptionLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmDescriptionLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmDescriptionLike.md\ndescription: >-\n The description envelope a joi schema produces, consumed by the JSON-schema\n converter.\n---\n\n# Type Alias: LiteRtLmDescriptionLike\n\n```ts\ntype LiteRtLmDescriptionLike = DescriptionLike;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:338](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L338)\n\nThe description envelope a joi schema produces, consumed by the JSON-schema converter.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmEngine","title":"Type Alias: LiteRtLmEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmEngine.md\ndescription: The LiteRT-LM engine instance the adapter drives.\n---\n\n# Type Alias: LiteRtLmEngine\n\n```ts\ntype LiteRtLmEngine = LiteRtEngineClass;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L98)\n\nThe LiteRT-LM engine instance the adapter drives.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmInitProgressReport","title":"Type Alias: LiteRtLmInitProgressReport","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmInitProgressReport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmInitProgressReport","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmInitProgressReport.md\ndescription: >-\n Progress report emitted while a LiteRT model loads. Provider-opaque; passed\n through verbatim.\n---\n\n# Type Alias: LiteRtLmInitProgressReport\n\n```ts\ntype LiteRtLmInitProgressReport = unknown;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L105)\n\nProgress report emitted while a LiteRT model loads. Provider-opaque; passed through verbatim.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmJsonSchema","title":"Type Alias: LiteRtLmJsonSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmJsonSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmJsonSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtLmJsonSchema.md\ndescription: >-\n The JSON-schema-shaped value used for a tool's `parameters` field (re-export\n for convenience).\n---\n\n# Type Alias: LiteRtLmJsonSchema\n\n```ts\ntype LiteRtLmJsonSchema = JsonSchema;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:336](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L336)\n\nThe JSON-schema-shaped value used for a tool's `parameters` field (re-export for convenience).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessage","title":"Type Alias: LiteRtMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessage.md\ndescription: >-\n A message in a LiteRT conversation: `{ role, content?, channels?, tool_calls?\n }`.\n---\n\n# Type Alias: LiteRtMessage\n\n```ts\ntype LiteRtMessage = Message;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L65)\n\nA message in a LiteRT conversation: `{ role, content?, channels?, tool_calls? }`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageContentItem","title":"Type Alias: LiteRtMessageContentItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageContentItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageContentItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageContentItem.md\ndescription: >-\n An item in a message's content array (`{ type, text?, path?, tool_response?\n }`).\n---\n\n# Type Alias: LiteRtMessageContentItem\n\n```ts\ntype LiteRtMessageContentItem = MessageContentItem;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L69)\n\nAn item in a message's content array (`{ type, text?, path?, tool_response? }`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageLike","title":"Type Alias: LiteRtMessageLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessageLike.md\ndescription: 'A string or [`LiteRtMessage`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtMessage).'\n---\n\n# Type Alias: LiteRtMessageLike\n\n```ts\ntype LiteRtMessageLike = MessageLike;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L67)\n\nA string or [LiteRtMessage](LiteRtMessage.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtPreface","title":"Type Alias: LiteRtPreface","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtPreface.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtPreface","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtPreface.md\ndescription: 'Initial messages, tools, and context the conversation begins with.'\n---\n\n# Type Alias: LiteRtPreface\n\n```ts\ntype LiteRtPreface = Preface;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L81)\n\nInitial messages, tools, and context the conversation begins with.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSamplerParameters","title":"Type Alias: LiteRtSamplerParameters","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSamplerParameters.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSamplerParameters","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSamplerParameters.md\ndescription: 'Sampler configuration (`{ type, k, p, temperature, seed }`).'\n---\n\n# Type Alias: LiteRtSamplerParameters\n\n```ts\ntype LiteRtSamplerParameters = SamplerParameters;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L87)\n\nSampler configuration (`{ type, k, p, temperature, seed }`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSessionConfig","title":"Type Alias: LiteRtSessionConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSessionConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSessionConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtSessionConfig.md\ndescription: 'Per-session generation configuration (sampler, modality flags, output limits).'\n---\n\n# Type Alias: LiteRtSessionConfig\n\n```ts\ntype LiteRtSessionConfig = SessionConfig;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L85)\n\nPer-session generation configuration (sampler, modality flags, output limits).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtTool","title":"Type Alias: LiteRtTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtTool.md\ndescription: >-\n A tool definition exposed to the model (`{ name, description?, parameters?\n }`).\n---\n\n# Type Alias: LiteRtTool\n\n```ts\ntype LiteRtTool = Tool;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L71)\n\nA tool definition exposed to the model (`{ name, description?, parameters? }`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCall","title":"Type Alias: LiteRtToolCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCall.md\ndescription: >-\n A tool call predicted by the model (`{ type, function: { name, arguments }\n }`).\n---\n\n# Type Alias: LiteRtToolCall\n\n```ts\ntype LiteRtToolCall = ToolCall;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L75)\n\nA tool call predicted by the model (`{ type, function: { name, arguments } }`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCallFunction","title":"Type Alias: LiteRtToolCallFunction","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCallFunction.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCallFunction","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCallFunction.md\ndescription: >-\n The function payload of a [`LiteRtToolCall`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolCall) (`{ name, arguments: object\n }`).\n---\n\n# Type Alias: LiteRtToolCallFunction\n\n```ts\ntype LiteRtToolCallFunction = ToolCallFunction;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L77)\n\nThe function payload of a [LiteRtToolCall](LiteRtToolCall.md) (`{ name, arguments: object }`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolParameters","title":"Type Alias: LiteRtToolParameters","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolParameters.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolParameters","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolParameters.md\ndescription: 'Parameters for a [`LiteRtTool`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtTool), following JSON Schema.'\n---\n\n# Type Alias: LiteRtToolParameters\n\n```ts\ntype LiteRtToolParameters = ToolParameters;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L73)\n\nParameters for a [LiteRtTool](LiteRtTool.md), following JSON Schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolResponseValue","title":"Type Alias: LiteRtToolResponseValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolResponseValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolResponseValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/LiteRtToolResponseValue.md\ndescription: A tool response value fed back to the model.\n---\n\n# Type Alias: LiteRtToolResponseValue\n\n```ts\ntype LiteRtToolResponseValue = ToolResponseValue;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L79)\n\nA tool response value fed back to the model.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/SamplerType","title":"Type Alias: SamplerType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/SamplerType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/SamplerType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/type-aliases/SamplerType.md\ndescription: 'Sampler-type enum value: `TOP_K`, `TOP_P`, `GREEDY`.'\n---\n\n# Type Alias: SamplerType\n\n```ts\ntype SamplerType = LiteRtSamplerTypeEnum;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/types.ts#L93)\n\nSampler-type enum value: `TOP_K`, `TOP_P`, `GREEDY`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation","title":"@nhtio/adk/batteries/llm/litert\\_lm/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/validation.md'\ndescription: Runtime validation schema and wrapper for LiteRT-LM adapter options.\n---\n\n# @nhtio/adk/batteries/llm/litert\\_lm/validation\n\nRuntime validation schema and wrapper for LiteRT-LM adapter options.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [liteRtLmOptionsSchema](variables/liteRtLmOptionsSchema.md) | Validator schema for [LiteRtLmAdapterOptions](../types/interfaces/LiteRtLmAdapterOptions.md). Rejects unknown keys (`.unknown(false)`) so typos and removed fields fail loud, and fills in defaults. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates raw adapter options against [liteRtLmOptionsSchema](variables/liteRtLmOptionsSchema.md), filling in defaults. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): LiteRtLmAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/validation.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/validation.ts#L249)\n\nValidates raw adapter options against [liteRtLmOptionsSchema](../variables/liteRtLmOptionsSchema.md), filling in defaults.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`LiteRtLmAdapterOptions`](../../types/interfaces/LiteRtLmAdapterOptions.md)\n\nThe resolved options object with defaults applied.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_LITERT\\_LM\\_OPTIONS](../../exceptions/variables/E_INVALID_LITERT_LM_OPTIONS.md) when `input` is invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation/variables/liteRtLmOptionsSchema","title":"Variable: liteRtLmOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation/variables/liteRtLmOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/litert_lm/validation/variables/liteRtLmOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/validation/variables/liteRtLmOptionsSchema.md\ndescription: >-\n Validator schema for [`LiteRtLmAdapterOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/litert_lm/types/interfaces/LiteRtLmAdapterOptions). Rejects unknown keys\n (`.unknown(false)`) so typos and removed fields fail loud, and fills in\n defaults.\n---\n\n# Variable: liteRtLmOptionsSchema\n\n```ts\nconst liteRtLmOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/litert\\_lm/validation.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/litert_lm/validation.ts#L128)\n\nValidator schema for [LiteRtLmAdapterOptions](../../types/interfaces/LiteRtLmAdapterOptions.md). Rejects unknown keys (`.unknown(false)`) so\ntypos and removed fields fail loud, and fills in defaults.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama","title":"@nhtio/adk/batteries/llm/ollama","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama.md'\ndescription: >-\n Native Ollama `/api/chat` adapter battery with swappable translation helpers\n and wire types.\n---\n\n# @nhtio/adk/batteries/llm/ollama\n\nNative Ollama `/api/chat` adapter battery with swappable translation helpers and wire types.\n\n## Remarks\n\nOpinionated native Ollama LLM battery. Ships an `OllamaAdapter` that targets Ollama's NATIVE\n`/api/chat` endpoint (NOT the OpenAI-compat `/v1` layer — for that, point the\n`openai_chat_completions` battery at `/v1`). Works with both local Ollama\n(`http://localhost:11434`, no auth) and cloud Ollama (`https://ollama.com`, `Authorization:\nBearer `); the only difference is `baseURL` plus the auth header. Native Ollama is\nHTTP-only — a Unix-socket deployment is reached via a custom `fetch` or an external bridge.\n\nNative `/api/chat` unlocks capabilities the `/v1` compat layer cannot express: per-request\ncontext size (`options.num_ctx`), native reasoning (`think` + `message.thinking`), structured\noutput (`format`), model lifecycle (`keep_alive`), object-form tool-call arguments, NDJSON\nstreaming, and native generation stats (surfaced via the runner's `generationStats` observability\nchannel).\n\nRe-exports the adapter class, every translation helper (wire-shape-agnostic helpers are shared\nwith the OpenAI battery via the internal `chat_common` submodule and re-exported here under their\noriginal names, each with a `default*` alias), the option / wire-shape types, the validation\nschema + `validateOptions` wrapper, and the battery-scoped exception classes.\n\n## References\n\n### buildOllamaHistory\n\nRe-exports [buildOllamaHistory](helpers/functions/buildOllamaHistory.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### deCollideToolCallIds\n\nRe-exports [deCollideToolCallIds](../../variables/deCollideToolCallIds.md)\n\n***\n\n### defaultBuildOllamaHistory\n\nRe-exports [defaultBuildOllamaHistory](helpers/variables/defaultBuildOllamaHistory.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultOllamaToolsFromTools\n\nRe-exports [defaultOllamaToolsFromTools](helpers/variables/defaultOllamaToolsFromTools.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderOllamaTimelineMessage\n\nRe-exports [defaultRenderOllamaTimelineMessage](helpers/variables/defaultRenderOllamaTimelineMessage.md)\n\n***\n\n### defaultRenderOllamaToolCallResult\n\nRe-exports [defaultRenderOllamaToolCallResult](helpers/variables/defaultRenderOllamaToolCallResult.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_INVALID\\_OLLAMA\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OLLAMA\\_OPTIONS](exceptions/variables/E_INVALID_OLLAMA_OPTIONS.md)\n\n***\n\n### E\\_OLLAMA\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OLLAMA\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_OLLAMA_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OLLAMA\\_HTTP\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_HTTP\\_ERROR](exceptions/variables/E_OLLAMA_HTTP_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OLLAMA\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OLLAMA\\_REQUEST\\_TIMEOUT](exceptions/variables/E_OLLAMA_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OLLAMA\\_STREAM\\_ERROR\n\nRe-exports [E\\_OLLAMA\\_STREAM\\_ERROR](exceptions/variables/E_OLLAMA_STREAM_ERROR.md)\n\n***\n\n### E\\_OLLAMA\\_STREAM\\_STALLED\n\nRe-exports [E\\_OLLAMA\\_STREAM\\_STALLED](exceptions/variables/E_OLLAMA_STREAM_STALLED.md)\n\n***\n\n### E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY](exceptions/variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### OllamaAdapter\n\nRe-exports [OllamaAdapter](adapter/classes/OllamaAdapter.md)\n\n***\n\n### OllamaAdapterOptions\n\nRe-exports [OllamaAdapterOptions](types/interfaces/OllamaAdapterOptions.md)\n\n***\n\n### OllamaChatRequestBody\n\nRe-exports [OllamaChatRequestBody](types/interfaces/OllamaChatRequestBody.md)\n\n***\n\n### OllamaChatResponse\n\nRe-exports [OllamaChatResponse](types/interfaces/OllamaChatResponse.md)\n\n***\n\n### OllamaChatStreamChunk\n\nRe-exports [OllamaChatStreamChunk](types/interfaces/OllamaChatStreamChunk.md)\n\n***\n\n### OllamaFormat\n\nRe-exports [OllamaFormat](types/type-aliases/OllamaFormat.md)\n\n***\n\n### OllamaHelpers\n\nRe-exports [OllamaHelpers](types/interfaces/OllamaHelpers.md)\n\n***\n\n### OllamaMessage\n\nRe-exports [OllamaMessage](types/interfaces/OllamaMessage.md)\n\n***\n\n### ollamaOptionsSchema\n\nRe-exports [ollamaOptionsSchema](validation/variables/ollamaOptionsSchema.md)\n\n***\n\n### OllamaRuntimeOptions\n\nRe-exports [OllamaRuntimeOptions](types/interfaces/OllamaRuntimeOptions.md)\n\n***\n\n### OllamaThink\n\nRe-exports [OllamaThink](types/type-aliases/OllamaThink.md)\n\n***\n\n### OllamaTool\n\nRe-exports [OllamaTool](types/type-aliases/OllamaTool.md)\n\n***\n\n### OllamaToolCall\n\nRe-exports [OllamaToolCall](types/interfaces/OllamaToolCall.md)\n\n***\n\n### ollamaToolsFromTools\n\nRe-exports [ollamaToolsFromTools](helpers/functions/ollamaToolsFromTools.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderOllamaTimelineMessage\n\nRe-exports [renderOllamaTimelineMessage](helpers/functions/renderOllamaTimelineMessage.md)\n\n***\n\n### renderOllamaToolCallResult\n\nRe-exports [renderOllamaToolCallResult](helpers/functions/renderOllamaToolCallResult.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../functions/toolsToChatCompletionsTools.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/adapter","title":"@nhtio/adk/batteries/llm/ollama/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/adapter.md'\ndescription: Cross-environment executor adapter for the native Ollama `/api/chat` endpoint.\n---\n\n# @nhtio/adk/batteries/llm/ollama/adapter\n\nCross-environment executor adapter for the native Ollama `/api/chat` endpoint.\n\n## Remarks\n\nNative Ollama LLM adapter targeting `/api/chat` (NOT the OpenAI-compat `/v1` layer — the\n`openai_chat_completions` battery already covers `/v1`). Works against both LOCAL Ollama\n(`http://localhost:11434`, no auth) and CLOUD Ollama (`https://ollama.com`, `Authorization:\nBearer `); the only difference is `baseURL` + the auth header. Native is HTTP-only — a\nUnix-socket deployment is reached via a custom `fetch` or an external bridge, not an adapter\noption.\n\nStructurally a sibling of the OpenAI Chat Completions adapter, with the native-wire divergences:\n\n* Request body: generation params are NESTED under `options`; `think` / `format` / `keep_alive`\n are top-level native controls; ADK control fields are stripped before sending.\n* Streaming: NDJSON (newline-delimited JSON objects), terminated in-band by `done: true` — there\n is no SSE `data:` framing and no `[DONE]` sentinel. Whole `tool_calls` arrive per chunk (no\n delta accumulation).\n* Reasoning: the single native `message.thinking` field (no multi-field precedence dance).\n* Tool calls: `arguments` is already a JSON OBJECT (no `JSON.parse`); native calls carry no `id`,\n so the adapter synthesizes one (uuidv6) for correlation / checksum / spool keying. Tool-result\n history messages use `tool_name` (the originating tool), not `tool_call_id`.\n* Generation stats: the terminal `done: true` object's token counts + nanosecond durations +\n `done_reason` are surfaced via `helpers.reportGenerationStats`.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------- | --------------------------------------------------------------------------------------- |\n| [OllamaAdapter](classes/OllamaAdapter.md) | Opinionated cross-environment LLM adapter for the native Ollama `/api/chat` wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/adapter/classes/OllamaAdapter","title":"Class: OllamaAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/adapter/classes/OllamaAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/adapter/classes/OllamaAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/adapter/classes/OllamaAdapter.md\ndescription: >-\n Opinionated cross-environment LLM adapter for the native Ollama `/api/chat`\n wire shape.\n---\n\n# Class: OllamaAdapter\n\nDefined in: [src/batteries/llm/ollama/adapter.ts:236](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/adapter.ts#L236)\n\nOpinionated cross-environment LLM adapter for the native Ollama `/api/chat` wire shape.\n\n## Remarks\n\nConstruction validates options eagerly via [validateOptions](../../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries/llm/ollama!E\\_INVALID\\_OLLAMA\\_OPTIONS](../../exceptions/variables/E_INVALID_OLLAMA_OPTIONS.md) on failure. The returned instance is reusable: call\n[OllamaAdapter.executor](#executor) once per `DispatchRunner` configuration to obtain a\n[@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to the baseline plus optional executor-scope\noverrides. Per-iteration overrides live on `ctx.stash.ollama` and take highest precedence;\n`headers`, `helpers`, `retry`, and the nested runtime `options` merge key-by-key across all three\nlayers, every other field is replaced wholesale at the highest layer that sets it.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OllamaAdapter(options: unknown): OllamaAdapter;\n```\n\nDefined in: [src/batteries/llm/ollama/adapter.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/adapter.ts#L247)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options. Re-validated on every iteration after per-dispatch and per-iteration overrides are layered in. |\n\n#### Returns\n\n`OllamaAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/llm/ollama!E\\_INVALID\\_OLLAMA\\_OPTIONS](../../exceptions/variables/E_INVALID_OLLAMA_OPTIONS.md) when `options` does not satisfy `ollamaOptionsSchema`.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ---------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"ollama\"` | Customary key for per-iteration overrides on `ctx.stash`. | [src/batteries/llm/ollama/adapter.ts:238](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/adapter.ts#L238) |\n\n## Methods\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/ollama/adapter.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/adapter.ts#L258)\n\nReturns a [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to this adapter's baseline plus optional\nexecutor-scope overrides.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`OllamaAdapterOptions`](../../types/interfaces/OllamaAdapterOptions.md)> | Optional executor-scope overrides. Higher precedence than the baseline, lower precedence than `ctx.stash[STASH_KEY]`. |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### isOllamaAdapter()\n\n```ts\nstatic isOllamaAdapter(value: unknown): value is OllamaAdapter;\n```\n\nDefined in: [src/batteries/llm/ollama/adapter.ts:1065](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/adapter.ts#L1065)\n\nReturns `true` when `value` is an OllamaAdapter instance.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n#### Returns\n\n`value is OllamaAdapter`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions","title":"@nhtio/adk/batteries/llm/ollama/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions.md'\ndescription: >-\n Battery-scoped exception constructors for the native Ollama `/api/chat`\n adapter.\n---\n\n# @nhtio/adk/batteries/llm/ollama/exceptions\n\nBattery-scoped exception constructors for the native Ollama `/api/chat` adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the native Ollama adapter. These exceptions are owned by\nthe battery (not the ADK core) and are minted via `createException` from `@nhtio/adk/factories`.\nRe-exported from the battery's barrel. They mirror the OpenAI Chat Completions battery's\nexception set (same status codes, same fatal/non-fatal split) with two deliberate divergences:\n\n* `E_OLLAMA_INVALID_TOOL_CALL_ARGS` — native `/api/chat` returns tool-call `arguments` as a JSON\n **object**, not a string, so there is no `JSON.parse` failure path. This fires only when the\n `arguments` value is present but is not a plain object (array / null / primitive — defensive\n against a non-conformant server or proxy).\n* `E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY` — native `/api/chat` supports only base64 `images[]`, so\n its \"unsupported\" set is wider than the OpenAI battery's (audio, document, and video all fall\n through here under `unsupportedMediaPolicy: 'throw'`).\n\nMalformed NDJSON lines are NOT a distinct exception — they are swallowed and surfaced via\n`helpers.log.trace` (matching the OpenAI battery's `sse-parse-failure` policy); only a transport\nthrow mid-stream raises `E_OLLAMA_STREAM_ERROR`.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [E\\_INVALID\\_OLLAMA\\_OPTIONS](variables/E_INVALID_OLLAMA_OPTIONS.md) | Thrown when the resolved adapter options (constructor, executor overrides, or per-dispatch `stash.ollama`) fail validation against `ollamaOptionsSchema`. |\n| [E\\_OLLAMA\\_CONTEXT\\_OVERFLOW](variables/E_OLLAMA_CONTEXT_OVERFLOW.md) | Thrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in the message so middleware can target shedding. |\n| [E\\_OLLAMA\\_HTTP\\_ERROR](variables/E_OLLAMA_HTTP_ERROR.md) | Thrown when the upstream `/api/chat` endpoint returns a non-2xx response. Non-fatal — surfaced via `ctx.nack(...)` so middleware can decide retry / fail. |\n| [E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS.md) | Raised when a tool-call's `arguments` value emitted by the model is present but is not a JSON object (e.g. an array, `null`, or a primitive). |\n| [E\\_OLLAMA\\_REQUEST\\_TIMEOUT](variables/E_OLLAMA_REQUEST_TIMEOUT.md) | Thrown when the initial request handshake (TCP connect, TLS, response headers) does not complete before `requestTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)`. Eligible for retry on the same footing as a retriable 5xx. |\n| [E\\_OLLAMA\\_STREAM\\_ERROR](variables/E_OLLAMA_STREAM_ERROR.md) | Thrown when the NDJSON stream emits a transport-level failure mid-stream (the reader throws). Non-fatal — surfaced via `ctx.nack(...)`. A single malformed NDJSON line is NOT this error — it is swallowed + logged at `trace`. |\n| [E\\_OLLAMA\\_STREAM\\_STALLED](variables/E_OLLAMA_STREAM_STALLED.md) | Thrown when the NDJSON stream goes silent for longer than `streamIdleTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)` so middleware can recover. |\n| [E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY.md) | Raised when a [@nhtio/adk!Media](../../../../common/classes/Media.md) instance whose modality cannot be natively represented in the Ollama `/api/chat` wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_INVALID_OLLAMA_OPTIONS","title":"Variable: E\\_INVALID\\_OLLAMA\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_INVALID_OLLAMA_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_INVALID_OLLAMA_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_INVALID_OLLAMA_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options (constructor, executor overrides, or\n per-dispatch `stash.ollama`) fail validation against `ollamaOptionsSchema`.\n---\n\n# Variable: E\\_INVALID\\_OLLAMA\\_OPTIONS\n\n```ts\nconst E_INVALID_OLLAMA_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L31)\n\nThrown when the resolved adapter options (constructor, executor overrides, or per-dispatch\n`stash.ollama`) fail validation against `ollamaOptionsSchema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_CONTEXT_OVERFLOW","title":"Variable: E\\_OLLAMA\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the total token weight of the resolved request exceeds\n `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{\n total, contextWindow, tokenEncoding, perBucket }` in the message so middleware\n can target shedding.\n---\n\n# Variable: E\\_OLLAMA\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_OLLAMA_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L48)\n\nThrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised\nwhen `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in\nthe message so middleware can target shedding.\n\n## Remarks\n\nThis is the ADK-side token-budget guard and is independent of Ollama's server-side `num_ctx`\n(KV-cache size) runtime option; the adapter does not auto-sync the two.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_HTTP_ERROR","title":"Variable: E\\_OLLAMA\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_HTTP_ERROR.md\ndescription: >-\n Thrown when the upstream `/api/chat` endpoint returns a non-2xx response.\n Non-fatal — surfaced via `ctx.nack(...)` so middleware can decide retry /\n fail.\n---\n\n# Variable: E\\_OLLAMA\\_HTTP\\_ERROR\n\n```ts\nconst E_OLLAMA_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L60)\n\nThrown when the upstream `/api/chat` endpoint returns a non-2xx response. Non-fatal — surfaced\nvia `ctx.nack(...)` so middleware can decide retry / fail.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_INVALID_TOOL_CALL_ARGS.md\ndescription: >-\n Raised when a tool-call's `arguments` value emitted by the model is present\n but is not a JSON object (e.g. an array, `null`, or a primitive).\n---\n\n# Variable: E\\_OLLAMA\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_OLLAMA_INVALID_TOOL_CALL_ARGS: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L121)\n\nRaised when a tool-call's `arguments` value emitted by the model is present but is not a JSON\nobject (e.g. an array, `null`, or a primitive).\n\n## Remarks\n\nNon-fatal. Native `/api/chat` delivers `arguments` already parsed as an object, so — unlike the\nOpenAI battery — there is no JSON-parse failure mode; this fires only on the not-an-object case.\nThe adapter does NOT throw it: it instantiates it inside `executeAndPersistToolCall`, pulls\n`.message` into a [@nhtio/adk!Tokenizable](../../../../../common/classes/Tokenizable.md), and persists a `ToolCall` record with\n`isError: true` so the model can self-correct on the next iteration.\n\nPrintf args: `[reasonHeadline, rawArgs]`.\n\n* `reasonHeadline` — short reason such as `'must be a JSON object; received array'`.\n* `rawArgs` — `JSON.stringify(arguments)` of what the model sent, echoed back so it can see it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_REQUEST_TIMEOUT","title":"Variable: E\\_OLLAMA\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_REQUEST_TIMEOUT.md\ndescription: >-\n Thrown when the initial request handshake (TCP connect, TLS, response headers)\n does not complete before `requestTimeoutMs`. Non-fatal — surfaced via\n `ctx.nack(...)`. Eligible for retry on the same footing as a retriable 5xx.\n---\n\n# Variable: E\\_OLLAMA\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_OLLAMA_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L98)\n\nThrown when the initial request handshake (TCP connect, TLS, response headers) does not complete\nbefore `requestTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)`. Eligible for retry on the\nsame footing as a retriable 5xx.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_ERROR","title":"Variable: E\\_OLLAMA\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_ERROR.md\ndescription: >-\n Thrown when the NDJSON stream emits a transport-level failure mid-stream (the\n reader throws). Non-fatal — surfaced via `ctx.nack(...)`. A single malformed\n NDJSON line is NOT this error — it is swallowed + logged at `trace`.\n---\n\n# Variable: E\\_OLLAMA\\_STREAM\\_ERROR\n\n```ts\nconst E_OLLAMA_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L73)\n\nThrown when the NDJSON stream emits a transport-level failure mid-stream (the reader throws).\nNon-fatal — surfaced via `ctx.nack(...)`. A single malformed NDJSON line is NOT this error — it\nis swallowed + logged at `trace`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_STALLED","title":"Variable: E\\_OLLAMA\\_STREAM\\_STALLED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_STALLED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_STALLED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_STREAM_STALLED.md\ndescription: >-\n Thrown when the NDJSON stream goes silent for longer than\n `streamIdleTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)` so middleware\n can recover.\n---\n\n# Variable: E\\_OLLAMA\\_STREAM\\_STALLED\n\n```ts\nconst E_OLLAMA_STREAM_STALLED: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L85)\n\nThrown when the NDJSON stream goes silent for longer than `streamIdleTimeoutMs`. Non-fatal —\nsurfaced via `ctx.nack(...)` so middleware can recover.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/exceptions/variables/E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Raised when a {@link @nhtio/adk!Media} instance whose modality cannot be\n natively represented in the Ollama `/api/chat` wire format reaches the adapter\n under `unsupportedMediaPolicy: 'throw'`.\n---\n\n# Variable: E\\_OLLAMA\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY: CreatedException<\n [string, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/ollama/exceptions.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/exceptions.ts#L141)\n\nRaised when a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality cannot be natively represented in\nthe Ollama `/api/chat` wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`.\n\n## Remarks\n\nNative `/api/chat` supports only base64 `images[]` — it has no audio, document, or video\nrepresentation — so this triggers for every non-image modality (a wider set than the OpenAI\nbattery, which natively supports audio and document blocks). Consumers can opt out of the throw\nby switching to `'fallback-stash'` or `'synthetic-description'`.\n\nPrintf args: `[kind, mimeType, filename]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers","title":"@nhtio/adk/batteries/llm/ollama/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers.md'\ndescription: >-\n Swappable translation helpers for rendering ADK state into native Ollama\n `/api/chat` requests.\n---\n\n# @nhtio/adk/batteries/llm/ollama/helpers\n\nSwappable translation helpers for rendering ADK state into native Ollama `/api/chat` requests.\n\n## Remarks\n\nThe wire-shape-agnostic helpers (`renderUntrustedContent`, `renderMemories`,\n`renderChatCompletionsSystemPrompt`, `toolsToChatCompletionsTools`, …) are shared with the OpenAI\nbattery via the internal `../chat_common/helpers` submodule and re-exported here under their\noriginal names. Only the Ollama-WIRE-SPECIFIC helpers are defined here:\n`renderOllamaTimelineMessage` (flat `content` + base64 `images[]` + `thinking`),\n`renderOllamaToolCallResult` (string-only result content), `buildOllamaHistory` (synthetic\n`assistant.tool_calls` with object-form `arguments` + `tool`-role messages labelled by\n`tool_name`), and `ollamaToolsFromTools` (alias of the shared tool-definition renderer — native\n`/api/chat` uses the same function-tool wire shape).\n\nNative `/api/chat` supports only base64 `images[]`; every non-image modality routes through the\n`unsupportedMediaPolicy` fallback (stash text / synthetic description) or throws.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [defaultBuildOllamaHistory](variables/defaultBuildOllamaHistory.md) | Default native-history assembler; alias of [buildOllamaHistory](functions/buildOllamaHistory.md). |\n| [defaultOllamaToolsFromTools](variables/defaultOllamaToolsFromTools.md) | Default implementation of [OllamaHelpers](../types/interfaces/OllamaHelpers.md)-style tool translation; alias of [ollamaToolsFromTools](functions/ollamaToolsFromTools.md). |\n| [defaultRenderOllamaTimelineMessage](variables/defaultRenderOllamaTimelineMessage.md) | Default timeline-message renderer; alias of [renderOllamaTimelineMessage](functions/renderOllamaTimelineMessage.md). |\n| [defaultRenderOllamaToolCallResult](variables/defaultRenderOllamaToolCallResult.md) | Default tool-call-result renderer; alias of [renderOllamaToolCallResult](functions/renderOllamaToolCallResult.md). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [buildOllamaHistory](functions/buildOllamaHistory.md) | Assembles the complete native Ollama message history for a dispatch — system prompt and content buckets, the interleaved timeline of messages/thoughts/tool calls, and the collected opaque reasoning payloads — by delegating to the injected sub-renderers. |\n| [ollamaToolsFromTools](functions/ollamaToolsFromTools.md) | Convert ADK tools to the native Ollama `tools[]` wire. Native `/api/chat` uses the identical `{ type: 'function', function: { name, description, parameters } }` shape as Chat Completions, so this is an alias of the shared renderer. |\n| [renderOllamaTimelineMessage](functions/renderOllamaTimelineMessage.md) | Renders a single timeline [@nhtio/adk!Message](../../../../common/classes/Message.md) into a native Ollama message — flattening any media into the base64 `images[]` array, surfacing reasoning as `thinking`, and wrapping textual bodies in the appropriate trust envelope. |\n| [renderOllamaToolCallResult](functions/renderOllamaToolCallResult.md) | Render a tool-call result to native Ollama tool-message content (always a string). Media results are routed through the internal media renderer: images cannot ride on a tool-role message's `content`, so an image result is replaced with a short text marker (the image bytes are not re-sent on a tool message); non-image media use the same fallback-text path as elsewhere. |\n\n## References\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../../functions/toolsToChatCompletionsTools.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/buildOllamaHistory","title":"Function: buildOllamaHistory()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/buildOllamaHistory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/buildOllamaHistory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/buildOllamaHistory.md\n---\n\n# Function: buildOllamaHistory()\n\n```ts\nfunction buildOllamaHistory(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderOllamaTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderOllamaToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise<{\n messages: OllamaMessage[];\n reasoningPayloads: {\n id: string;\n payload: unknown;\n replayCompatibility: string;\n }[];\n}>;\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:537](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L537)\n\nAssembles the complete native Ollama message history for a dispatch — system prompt and content\nbuckets, the interleaved timeline of messages/thoughts/tool calls, and the collected opaque\nreasoning payloads — by delegating to the injected sub-renderers.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderOllamaTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OllamaMessage`](../../types/interfaces/OllamaMessage.md)>; `renderOllamaToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`> | Pre-rendered results keyed by the same live ToolCall instances iterated below. |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderOllamaTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OllamaMessage`](../../types/interfaces/OllamaMessage.md)> | - |\n| `input.renderOllamaToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`messages`: [`OllamaMessage`](../../types/interfaces/OllamaMessage.md)\\[];\n`reasoningPayloads`: {\n`id`: `string`;\n`payload`: `unknown`;\n`replayCompatibility`: `string`;\n}\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/ollamaToolsFromTools","title":"Function: ollamaToolsFromTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/ollamaToolsFromTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/ollamaToolsFromTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/ollamaToolsFromTools.md\n---\n\n# Function: ollamaToolsFromTools()\n\n```ts\nfunction ollamaToolsFromTools(\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n): ChatCompletionsTool[];\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L102)\n\nConvert ADK tools to the native Ollama `tools[]` wire. Native `/api/chat` uses the identical\n`{ type: 'function', function: { name, description, parameters } }` shape as Chat Completions, so\nthis is an alias of the shared renderer.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n[`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaTimelineMessage","title":"Function: renderOllamaTimelineMessage()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaTimelineMessage.md\n---\n\n# Function: renderOllamaTimelineMessage()\n\n```ts\nfunction renderOllamaTimelineMessage(input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L272)\n\nRenders a single timeline [@nhtio/adk!Message](../../../../../common/classes/Message.md) into a native Ollama message — flattening any\nmedia into the base64 `images[]` array, surfacing reasoning as `thinking`, and wrapping textual\nbodies in the appropriate trust envelope.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`OllamaMessage`](../../types/interfaces/OllamaMessage.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaToolCallResult","title":"Function: renderOllamaToolCallResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/renderOllamaToolCallResult.md\n---\n\n# Function: renderOllamaToolCallResult()\n\n```ts\nfunction renderOllamaToolCallResult(input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:402](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L402)\n\nRender a tool-call result to native Ollama tool-message content (always a string). Media results\nare routed through the internal media renderer: images cannot ride on a tool-role message's\n`content`, so an image result is replaced with a short text marker (the image bytes are not\nre-sent on a tool message); non-image media use the same fallback-text path as elsewhere.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultBuildOllamaHistory","title":"Variable: defaultBuildOllamaHistory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultBuildOllamaHistory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultBuildOllamaHistory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultBuildOllamaHistory.md\ndescription: 'Default native-history assembler; alias of [`buildOllamaHistory`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/buildOllamaHistory).'\n---\n\n# Variable: defaultBuildOllamaHistory\n\n```ts\nconst defaultBuildOllamaHistory: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderOllamaTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderOllamaToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise<{\n messages: OllamaMessage[];\n reasoningPayloads: {\n id: string;\n payload: unknown;\n replayCompatibility: string;\n }[];\n}> = buildOllamaHistory;\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:738](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L738)\n\nDefault native-history assembler; alias of [buildOllamaHistory](../functions/buildOllamaHistory.md).\n\nAssembles the complete native Ollama message history for a dispatch — system prompt and content\nbuckets, the interleaved timeline of messages/thoughts/tool calls, and the collected opaque\nreasoning payloads — by delegating to the injected sub-renderers.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderOllamaTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OllamaMessage`](../../types/interfaces/OllamaMessage.md)>; `renderOllamaToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`> | Pre-rendered results keyed by the same live ToolCall instances iterated below. |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderOllamaTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OllamaMessage`](../../types/interfaces/OllamaMessage.md)> | - |\n| `input.renderOllamaToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`messages`: [`OllamaMessage`](../../types/interfaces/OllamaMessage.md)\\[];\n`reasoningPayloads`: {\n`id`: `string`;\n`payload`: `unknown`;\n`replayCompatibility`: `string`;\n}\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultOllamaToolsFromTools","title":"Variable: defaultOllamaToolsFromTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultOllamaToolsFromTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultOllamaToolsFromTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultOllamaToolsFromTools.md\ndescription: >-\n Default implementation of [`OllamaHelpers`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaHelpers)-style tool translation; alias\n of [`ollamaToolsFromTools`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/functions/ollamaToolsFromTools).\n---\n\n# Variable: defaultOllamaToolsFromTools\n\n```ts\nconst defaultOllamaToolsFromTools: (\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n) => ChatCompletionsTool[] = ollamaToolsFromTools;\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L107)\n\nDefault implementation of [OllamaHelpers](../../types/interfaces/OllamaHelpers.md)-style tool translation; alias of [ollamaToolsFromTools](../functions/ollamaToolsFromTools.md).\n\nConvert ADK tools to the native Ollama `tools[]` wire. Native `/api/chat` uses the identical\n`{ type: 'function', function: { name, description, parameters } }` shape as Chat Completions, so\nthis is an alias of the shared renderer.\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n[`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaTimelineMessage","title":"Variable: defaultRenderOllamaTimelineMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaTimelineMessage.md\ndescription: >-\n Default timeline-message renderer; alias of {@link\n renderOllamaTimelineMessage}.\n---\n\n# Variable: defaultRenderOllamaTimelineMessage\n\n```ts\nconst defaultRenderOllamaTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderOllamaTimelineMessage;\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:344](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L344)\n\nDefault timeline-message renderer; alias of [renderOllamaTimelineMessage](../functions/renderOllamaTimelineMessage.md).\n\nRenders a single timeline [@nhtio/adk!Message](../../../../../common/classes/Message.md) into a native Ollama message — flattening any\nmedia into the base64 `images[]` array, surfacing reasoning as `thinking`, and wrapping textual\nbodies in the appropriate trust envelope.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`OllamaMessage`](../../types/interfaces/OllamaMessage.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaToolCallResult","title":"Variable: defaultRenderOllamaToolCallResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/helpers/variables/defaultRenderOllamaToolCallResult.md\ndescription: >-\n Default tool-call-result renderer; alias of {@link\n renderOllamaToolCallResult}.\n---\n\n# Variable: defaultRenderOllamaToolCallResult\n\n```ts\nconst defaultRenderOllamaToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderOllamaToolCallResult;\n```\n\nDefined in: [src/batteries/llm/ollama/helpers.ts:523](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/helpers.ts#L523)\n\nDefault tool-call-result renderer; alias of [renderOllamaToolCallResult](../functions/renderOllamaToolCallResult.md).\n\nRender a tool-call result to native Ollama tool-message content (always a string). Media results\nare routed through the internal media renderer: images cannot ride on a tool-role message's\n`content`, so an image result is replaced with a short text marker (the image bytes are not\nre-sent on a tool message); non-image media use the same fallback-text path as elsewhere.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types","title":"@nhtio/adk/batteries/llm/ollama/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types.md'\ndescription: >-\n TypeScript wire shapes, helper contracts, and option types for the native\n Ollama battery.\n---\n\n# @nhtio/adk/batteries/llm/ollama/types\n\nTypeScript wire shapes, helper contracts, and option types for the native Ollama battery.\n\n## Remarks\n\nType aliases for the native Ollama `/api/chat` adapter — the native wire shapes (which differ\nfrom OpenAI Chat Completions: flat string `content` + separate base64 `images[]`, `thinking` for\nreasoning, object-form tool-call `arguments`, `tool_name` on tool-role messages, NDJSON\nstreaming terminated by `done: true`), the adapter's options shape, and the [OllamaHelpers](interfaces/OllamaHelpers.md)\ncontract. Runtime validation lives in `validation.ts` (`ollamaOptionsSchema`).\n\nWire-shape-agnostic types (`JsonSchema`, the attribute envelopes, `UnsupportedMediaPolicy`, the\nbucket order, the retry config, the function-tool wire) are imported from the shared, internal\n`../chat_common/types` submodule and re-exported here so consumers of\n`@nhtio/adk/batteries/llm/ollama` get a self-contained type surface.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OllamaAdapterOptions](interfaces/OllamaAdapterOptions.md) | Configuration options for the native Ollama `/api/chat` adapter. |\n| [OllamaChatRequestBody](interfaces/OllamaChatRequestBody.md) | The native `/api/chat` request body. |\n| [OllamaChatResponse](interfaces/OllamaChatResponse.md) | A non-streaming `/api/chat` response (single object with `done: true`). |\n| [OllamaChatStreamChunk](interfaces/OllamaChatStreamChunk.md) | A streamed NDJSON chunk from `/api/chat`. The terminal chunk carries `done: true` + stats. |\n| [OllamaHelpers](interfaces/OllamaHelpers.md) | Full translation-helper contract for the native Ollama battery. Extends the wire-shape-agnostic [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md) (shared with the OpenAI battery) and adds the Ollama-WIRE-SPECIFIC members: flat timeline-message rendering (`images[]` + `thinking`), string-only tool-call-result rendering, and native-history assembly (`tool_name`, object-form tool-call `arguments`). There is no streaming tool-call delta accumulator — native `/api/chat` emits whole `tool_calls` per chunk. |\n| [OllamaMessage](interfaces/OllamaMessage.md) | A native Ollama chat message. Flat shape: `content` is always a string; image attachments ride in a separate base64 `images[]` array (no content blocks); `thinking` carries reasoning; a tool-role result message labels its origin with `tool_name` (NOT a `tool_call_id`). |\n| [OllamaRuntimeOptions](interfaces/OllamaRuntimeOptions.md) | Native Ollama runtime/sampling parameters — sent NESTED under the request body's `options` key, NOT at the top level (this is the key structural divergence from the OpenAI wire, where these sit at the top level). All fields are optional; set only the ones you want to override. An index signature allows forward-compatible passthrough of llama.cpp parameters this type has not yet enumerated. |\n| [OllamaToolCall](interfaces/OllamaToolCall.md) | A native Ollama tool call as returned on a response/stream `message`. Note: `arguments` is a parsed JSON OBJECT (not a string), and there is no `id` or `type` field — the adapter synthesizes a correlation id. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OllamaFormat](type-aliases/OllamaFormat.md) | Native `format` control. `'json'` requests free-form JSON; a [JsonSchema](../../../interfaces/JsonSchema.md) object requests schema-constrained structured output (the model's `content` is then a JSON string matching it). |\n| [OllamaThink](type-aliases/OllamaThink.md) | Native `think` control for thinking-capable models. `true`/`false` toggle reasoning; the effort strings request a reasoning budget on models that support graded thinking. |\n| [OllamaTool](type-aliases/OllamaTool.md) | Native function-tool definition (structurally identical to the Chat Completions tool wire). |\n\n## References\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../../interfaces/MemoryAttrs.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../../interfaces/UntrustedContentAttrs.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaAdapterOptions","title":"Interface: OllamaAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaAdapterOptions.md\ndescription: Configuration options for the native Ollama `/api/chat` adapter.\n---\n\n# Interface: OllamaAdapterOptions\n\nDefined in: [src/batteries/llm/ollama/types.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L337)\n\nConfiguration options for the native Ollama `/api/chat` adapter.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | Bearer token for cloud Ollama (`https://ollama.com`). Omit for local (no auth). | [src/batteries/llm/ollama/types.ts:340](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L340) |\n| `autoAck?` | `boolean` | Whether the executor acks automatically on a tool-call-free terminal answer. | [src/batteries/llm/ollama/types.ts:381](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L381) |\n| `baseURL?` | `string` | Endpoint base URL. The adapter targets `/api/chat`. Defaults to `http://localhost:11434` (local); cloud is `https://ollama.com`. Native Ollama is HTTP-only — for a Unix-socket deployment, point this at an HTTP bridge (nginx `proxy_pass` / `socat`) or inject a custom [OllamaAdapterOptions.fetch](#property-fetch) instead. | [src/batteries/llm/ollama/types.ts:347](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L347) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Determines order of the system-prompt content buckets in history assembly. | [src/batteries/llm/ollama/types.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L365) |\n| `contextWindow?` | `number` | Size of the model's token context window (the ADK guard, independent of `num_ctx`). | [src/batteries/llm/ollama/types.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L367) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Custom `fetch` implementation. Use to reach a Unix-socket Ollama via a custom transport (e.g. undici with a `unix:` socket path) — native Ollama is HTTP-only, so socket access is a fetch/bridge concern, not an adapter option. | [src/batteries/llm/ollama/types.ts:355](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L355) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | OPTIONAL hook to SHAPE the artifact-query tools forged from prior-turn SpooledArtifact results, before they merge into the visible tool set. **Remarks** When a prior tool returned a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md), this battery forges that artifact class's reader tools (via `ctor.forgeTools(ctx)`) so the model can read the handle. A JSON artifact forges ~14 readers (~2.4k tokens of tool schema) — an unsheddable floor on a tight window, because the forge happens INSIDE the battery, downstream of any middleware subtractive pass. This hook lets the ASSEMBLER shape that forged set: it receives the merged forged registry + the dispatch context and returns a (possibly narrowed) registry, applied BEFORE the merge with `ctx.tools`. e.g. return only the core readers (`artifact_head`, `artifact_json_get`) so a tight window fits; the rest stay reachable via `tool_catalog`/`call_a_tool`. Default absent = identity (all forged tools) = fully backward-compatible. The battery stays BUDGET-AGNOSTIC (per the CONTRIBUTING size-threshold rule): it does NOT measure or compare against `contextWindow` — it just applies whatever filter the assembler supplied. Any budget logic lives in the caller's filter (middleware-side), which legitimately knows the turn's budget. | [src/batteries/llm/ollama/types.ts:450](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L450) |\n| `format?` | [`OllamaFormat`](../type-aliases/OllamaFormat.md) | Structured-output control: `'json'` or a JSON schema object. | [src/batteries/llm/ollama/types.ts:391](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L391) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Custom HTTP headers sent with every request (override built defaults, including auth). | [src/batteries/llm/ollama/types.ts:349](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L349) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`OllamaHelpers`](OllamaHelpers.md)> | Optional overrides for the Ollama translation helpers. | [src/batteries/llm/ollama/types.ts:377](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L377) |\n| `keep_alive?` | `string` | `number` | How long the model stays resident after the request (e.g. `'5m'`, `0` to unload). | [src/batteries/llm/ollama/types.ts:395](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L395) |\n| `localToolCallParser?` | | [`ToolCallParserName`](../../../transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) | OPTIONAL fallback parser for tool calls the provider's chat template did NOT return structurally. **Remarks** Native `/api/chat` tool-calling is authoritative: when Ollama returns `message.tool_calls`, those are used and this option is never consulted. But small models (Gemma, Phi, and others) frequently emit a tool call in a surface form the server template does not recognize — ``, or bare `name\\nkey: value`— in which case the call arrives as plain`message.content`and`tool_calls`is empty, silently dropping the call. This is a cross-model, cross-weight reality, not a single-provider quirk. Set this to a parser family name (e.g.`'gemma'`), `'auto'`(try every bundled parser in priority order), or a custom [ToolCallParserFn](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) to recover such calls from`content`ONLY when the provider returned none. Recovered calls execute exactly like native ones. Default absent = disabled = today's native-only behaviour (fully backward-compatible). Mirrors the on-device batteries'`toolCallParser`, which parse from text unconditionally because those runtimes never return structured calls. | [src/batteries/llm/ollama/types.ts:429](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L429) |\n| `model` | `string` | Required. The Ollama model name (e.g. `llama3.2`, `gpt-oss:120b` for cloud). | [src/batteries/llm/ollama/types.ts:387](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L387) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | Observe the fully-assembled request this battery is about to POST TO Ollama — fired once per terminal generation, the instant the body is built and BEFORE the fetch, with the wire `messages`, `tools`, and the complete `requestBody`. The mirror of [onRawGeneration](#property-onrawgeneration). Purely observational (return value ignored, errors swallowed). Default absent. The request is handed back AS-IS — no redaction — so treat it as potentially sensitive if you persist it. See [PromptAssembledObserverFn](../../../../type-aliases/PromptAssembledObserverFn.md). | [src/batteries/llm/ollama/types.ts:411](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L411) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | Observe the model's RAW response for each completed generation — fired once per terminal generation, after the provider's reply is parsed but before the result is persisted, with the returned assistant content (`rawText`), the residual `cleanedText`, and the extracted `reasoning` / `toolCalls`. Purely observational (return value ignored, errors swallowed). Default absent. See [RawGenerationObserverFn](../../../../type-aliases/RawGenerationObserverFn.md). | [src/batteries/llm/ollama/types.ts:403](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L403) |\n| `options?` | [`OllamaRuntimeOptions`](OllamaRuntimeOptions.md) | Native sampling/runtime parameters, sent nested under the request body's `options` key. | [src/batteries/llm/ollama/types.ts:393](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L393) |\n| `replayCompatibility?` | readonly `string`\\[] | List of replay labels supported by the assistant. | [src/batteries/llm/ollama/types.ts:375](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L375) |\n| `requestTimeoutMs?` | `number` | Request timeout in milliseconds for API calls. | [src/batteries/llm/ollama/types.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L361) |\n| `retry?` | [`ChatCompletionsRetryConfig`](../../../../interfaces/ChatCompletionsRetryConfig.md) | Configures request retry behavior. | [src/batteries/llm/ollama/types.ts:363](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L363) |\n| `selfIdentity?` | `string` | Unique identity label for the assistant instance. | [src/batteries/llm/ollama/types.ts:369](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L369) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | Backing store for `string` / `Uint8Array` tool returns; defaults to a per-dispatch in-memory store. | [src/batteries/llm/ollama/types.ts:379](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L379) |\n| `stream?` | `boolean` | Whether to stream the response chunk by chunk. | [src/batteries/llm/ollama/types.ts:357](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L357) |\n| `streamIdleTimeoutMs?` | `number` | Idle timeout in milliseconds for the stream before aborting. | [src/batteries/llm/ollama/types.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L359) |\n| `think?` | [`OllamaThink`](../type-aliases/OllamaThink.md) | Native reasoning control for thinking-capable models. | [src/batteries/llm/ollama/types.ts:389](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L389) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Determines which thoughts are surfaced back to the model. | [src/batteries/llm/ollama/types.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L371) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | Tokenizer encoding configuration for token counting. | [src/batteries/llm/ollama/types.ts:373](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L373) |\n| `toolCallIdFilter?` | [`ToolCallIdFilterFn`](../../../../type-aliases/ToolCallIdFilterFn.md) | Optional ingress hook for adapting provider tool-call ids; absent preserves the incoming id. | [src/batteries/llm/ollama/types.ts:431](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L431) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | Policy for handling a [@nhtio/adk!Media](../../../../../common/classes/Media.md) whose modality the Ollama wire cannot represent. | [src/batteries/llm/ollama/types.ts:383](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L383) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatRequestBody","title":"Interface: OllamaChatRequestBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatRequestBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatRequestBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatRequestBody.md\ndescription: The native `/api/chat` request body.\n---\n\n# Interface: OllamaChatRequestBody\n\nDefined in: [src/batteries/llm/ollama/types.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L177)\n\nThe native `/api/chat` request body.\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `_adk_reasoning_payloads?` | { `id`: `string`; `payload`: `unknown`; `replayCompatibility`: `string`; }\\[] | Side-channel for opaque vendor reasoning payloads. Vanilla Ollama ignores unknown top-level keys; gateways that understand it can forward it. Only set when non-empty. | [src/batteries/llm/ollama/types.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L198) |\n| `format?` | [`OllamaFormat`](../type-aliases/OllamaFormat.md) | Structured-output control: `'json'` or a JSON schema. | [src/batteries/llm/ollama/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L189) |\n| `keep_alive?` | `string` | `number` | How long the model stays resident after the request. | [src/batteries/llm/ollama/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L193) |\n| `messages` | [`OllamaMessage`](OllamaMessage.md)\\[] | The conversation history sent to the model. | [src/batteries/llm/ollama/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L181) |\n| `model` | `string` | Ollama model name to run. | [src/batteries/llm/ollama/types.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L179) |\n| `options?` | [`OllamaRuntimeOptions`](OllamaRuntimeOptions.md) | Native sampling/runtime parameters, nested under this key. | [src/batteries/llm/ollama/types.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L191) |\n| `stream` | `boolean` | Whether the response is streamed as NDJSON chunks. | [src/batteries/llm/ollama/types.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L183) |\n| `think?` | [`OllamaThink`](../type-aliases/OllamaThink.md) | Native reasoning control for thinking-capable models. | [src/batteries/llm/ollama/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L187) |\n| `tools?` | [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Function tools advertised to the model. | [src/batteries/llm/ollama/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L185) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatResponse","title":"Interface: OllamaChatResponse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatResponse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatResponse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatResponse.md\ndescription: 'A non-streaming `/api/chat` response (single object with `done: true`).'\n---\n\n# Interface: OllamaChatResponse\n\nDefined in: [src/batteries/llm/ollama/types.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L235)\n\nA non-streaming `/api/chat` response (single object with `done: true`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `created_at?` | `string` | ISO-8601 timestamp the response was created. | [src/batteries/llm/ollama/types.ts:239](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L239) |\n| `done?` | `boolean` | Always `true` for a non-streaming response. | [src/batteries/llm/ollama/types.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L249) |\n| `done_reason?` | `string` | Why generation stopped. | [src/batteries/llm/ollama/types.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L251) |\n| `eval_count?` | `number` | Number of tokens generated. | [src/batteries/llm/ollama/types.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L261) |\n| `eval_duration?` | `number` | Generation time in nanoseconds. | [src/batteries/llm/ollama/types.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L263) |\n| `load_duration?` | `number` | Model load time in nanoseconds. | [src/batteries/llm/ollama/types.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L255) |\n| `message?` | { `content?`: `string`; `images?`: `string`\\[]; `role?`: `\"assistant\"`; `thinking?`: `string`; `tool_calls?`: [`OllamaToolCall`](OllamaToolCall.md)\\[]; } | The completed assistant message. | [src/batteries/llm/ollama/types.ts:241](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L241) |\n| `message.content?` | `string` | - | [src/batteries/llm/ollama/types.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L243) |\n| `message.images?` | `string`\\[] | - | [src/batteries/llm/ollama/types.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L245) |\n| `message.role?` | `\"assistant\"` | - | [src/batteries/llm/ollama/types.ts:242](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L242) |\n| `message.thinking?` | `string` | - | [src/batteries/llm/ollama/types.ts:244](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L244) |\n| `message.tool_calls?` | [`OllamaToolCall`](OllamaToolCall.md)\\[] | - | [src/batteries/llm/ollama/types.ts:246](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L246) |\n| `model?` | `string` | Model that produced the response. | [src/batteries/llm/ollama/types.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L237) |\n| `prompt_eval_count?` | `number` | Number of prompt tokens evaluated. | [src/batteries/llm/ollama/types.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L257) |\n| `prompt_eval_duration?` | `number` | Prompt evaluation time in nanoseconds. | [src/batteries/llm/ollama/types.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L259) |\n| `total_duration?` | `number` | Total request time in nanoseconds. | [src/batteries/llm/ollama/types.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L253) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatStreamChunk","title":"Interface: OllamaChatStreamChunk","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatStreamChunk.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatStreamChunk","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaChatStreamChunk.md\ndescription: >-\n A streamed NDJSON chunk from `/api/chat`. The terminal chunk carries `done:\n true` + stats.\n---\n\n# Interface: OllamaChatStreamChunk\n\nDefined in: [src/batteries/llm/ollama/types.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L203)\n\nA streamed NDJSON chunk from `/api/chat`. The terminal chunk carries `done: true` + stats.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `created_at?` | `string` | ISO-8601 timestamp the chunk was created. | [src/batteries/llm/ollama/types.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L207) |\n| `done?` | `boolean` | `true` on the terminal chunk. | [src/batteries/llm/ollama/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L217) |\n| `done_reason?` | `string` | Why generation stopped, present on the terminal chunk. | [src/batteries/llm/ollama/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L219) |\n| `eval_count?` | `number` | Number of tokens generated (terminal chunk). | [src/batteries/llm/ollama/types.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L229) |\n| `eval_duration?` | `number` | Generation time in nanoseconds (terminal chunk). | [src/batteries/llm/ollama/types.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L231) |\n| `load_duration?` | `number` | Model load time in nanoseconds (terminal chunk). | [src/batteries/llm/ollama/types.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L223) |\n| `message?` | { `content?`: `string`; `images?`: `string`\\[]; `role?`: `\"assistant\"`; `thinking?`: `string`; `tool_calls?`: [`OllamaToolCall`](OllamaToolCall.md)\\[]; } | Partial assistant message carried by this chunk. | [src/batteries/llm/ollama/types.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L209) |\n| `message.content?` | `string` | - | [src/batteries/llm/ollama/types.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L211) |\n| `message.images?` | `string`\\[] | - | [src/batteries/llm/ollama/types.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L213) |\n| `message.role?` | `\"assistant\"` | - | [src/batteries/llm/ollama/types.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L210) |\n| `message.thinking?` | `string` | - | [src/batteries/llm/ollama/types.ts:212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L212) |\n| `message.tool_calls?` | [`OllamaToolCall`](OllamaToolCall.md)\\[] | - | [src/batteries/llm/ollama/types.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L214) |\n| `model?` | `string` | Model that produced the chunk. | [src/batteries/llm/ollama/types.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L205) |\n| `prompt_eval_count?` | `number` | Number of prompt tokens evaluated (terminal chunk). | [src/batteries/llm/ollama/types.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L225) |\n| `prompt_eval_duration?` | `number` | Prompt evaluation time in nanoseconds (terminal chunk). | [src/batteries/llm/ollama/types.ts:227](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L227) |\n| `total_duration?` | `number` | Total request time in nanoseconds (terminal chunk). | [src/batteries/llm/ollama/types.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L221) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaHelpers","title":"Interface: OllamaHelpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaHelpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaHelpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaHelpers.md\ndescription: >-\n Full translation-helper contract for the native Ollama battery. Extends the\n wire-shape-agnostic [`ChatHelpersCommon`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ChatHelpersCommon) (shared with the OpenAI battery)\n and adds the Ollama-WIRE-SPECIFIC members: flat timeline-message rendering\n (`images[]` + `thinking`), string-only tool-call-result rendering, and\n native-history assembly (`tool_name`, object-form tool-call `arguments`).\n There is no streaming tool-call delta accumulator — native `/api/chat` emits\n whole `tool_calls` per chunk.\n---\n\n# Interface: OllamaHelpers\n\nDefined in: [src/batteries/llm/ollama/types.ts:275](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L275)\n\nFull translation-helper contract for the native Ollama battery. Extends the wire-shape-agnostic\n[ChatHelpersCommon](../../../openai_responses/types/interfaces/ChatHelpersCommon.md) (shared with the OpenAI battery) and adds the Ollama-WIRE-SPECIFIC\nmembers: flat timeline-message rendering (`images[]` + `thinking`), string-only tool-call-result\nrendering, and native-history assembly (`tool_name`, object-form tool-call `arguments`). There is\nno streaming tool-call delta accumulator — native `/api/chat` emits whole `tool_calls` per chunk.\n\n## Extends\n\n* [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buildOllamaHistory` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderOllamaTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OllamaMessage`](OllamaMessage.md)>; `renderOllamaToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<{ `messages`: [`OllamaMessage`](OllamaMessage.md)\\[]; `reasoningPayloads`: { `id`: `string`; `payload`: `unknown`; `replayCompatibility`: `string`; }\\[]; }> | Assembles the full native history (system prompt, buckets, timeline, thoughts) into messages. | - | [src/batteries/llm/ollama/types.ts:294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L294) |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`descriptionToChatCompletionsJsonSchema`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema) | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`filterThoughts`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts) | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) tool result: metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam. When omitted the battery uses the shared defaultRenderArtifactHandleBody. A consumer overrides it to change WHICH reader the model is steered toward first — e.g. promoting the JSON content-readers (`artifact_json_get` / `artifact_json_keys`) ahead of the metadata-only `artifact_json_type` for a small model that grabs the first listed tool. The tool list itself comes from the artifact's `constructor.toolMethods`; an override typically reorders or re-annotates that list before delegating to the default renderer. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderArtifactHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody) | [src/batteries/llm/chat\\_common/types.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L571) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderChatCompletionsSystemPrompt`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt) | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderFirstPartyRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables) | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderMemories`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories) | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderOllamaTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OllamaMessage`](OllamaMessage.md)> | Renders a timeline message into a native Ollama message (`images[]` + `thinking`). | - | [src/batteries/llm/ollama/types.ts:277](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L277) |\n| `renderOllamaToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<`string`> | Renders a tool call's result into a native Ollama tool-role message body (string-only). | - | [src/batteries/llm/ollama/types.ts:284](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L284) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md) whose content is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam, the retrievable-side counterpart to [renderArtifactHandleBody](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody). When omitted the battery uses the shared defaultRenderRetrievableHandleBody. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablehandlebody) | [src/batteries/llm/chat\\_common/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L588) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables) | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableSafetyDirective`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective) | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderStandingInstructions`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions) | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPrivateRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables) | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPublicRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables) | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThought`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought) | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderTrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderUntrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`toolsToChatCompletionsTools`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools) | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaMessage","title":"Interface: OllamaMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaMessage.md\ndescription: >-\n A native Ollama chat message. Flat shape: `content` is always a string; image\n attachments ride in a separate base64 `images[]` array (no content blocks);\n `thinking` carries reasoning; a tool-role result message labels its origin\n with `tool_name` (NOT a `tool_call_id`).\n---\n\n# Interface: OllamaMessage\n\nDefined in: [src/batteries/llm/ollama/types.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L158)\n\nA native Ollama chat message. Flat shape: `content` is always a string; image attachments ride\nin a separate base64 `images[]` array (no content blocks); `thinking` carries reasoning; a\ntool-role result message labels its origin with `tool_name` (NOT a `tool_call_id`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | `string` | Flat text body of the message (never a content-block array). | [src/batteries/llm/ollama/types.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L162) |\n| `images?` | `string`\\[] | Base64-encoded image attachments, sent out-of-band from `content`. | [src/batteries/llm/ollama/types.ts:166](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L166) |\n| `role` | `\"user\"` | `\"assistant\"` | `\"tool\"` | `\"system\"` | Author role of the message. | [src/batteries/llm/ollama/types.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L160) |\n| `thinking?` | `string` | Reasoning/thinking text emitted by thinking-capable models. | [src/batteries/llm/ollama/types.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L164) |\n| `tool_calls?` | [`OllamaToolCall`](OllamaToolCall.md)\\[] | Tool calls the model emitted on this (assistant) message. | [src/batteries/llm/ollama/types.ts:168](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L168) |\n| `tool_name?` | `string` | Name of the tool a tool-role result message corresponds to. | [src/batteries/llm/ollama/types.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L170) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaRuntimeOptions","title":"Interface: OllamaRuntimeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaRuntimeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaRuntimeOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaRuntimeOptions.md\ndescription: >-\n Native Ollama runtime/sampling parameters — sent NESTED under the request\n body's `options` key, NOT at the top level (this is the key structural\n divergence from the OpenAI wire, where these sit at the top level). All fields\n are optional; set only the ones you want to override. An index signature\n allows forward-compatible passthrough of llama.cpp parameters this type has\n not yet enumerated.\n---\n\n# Interface: OllamaRuntimeOptions\n\nDefined in: [src/batteries/llm/ollama/types.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L91)\n\nNative Ollama runtime/sampling parameters — sent NESTED under the request body's `options` key,\nNOT at the top level (this is the key structural divergence from the OpenAI wire, where these\nsit at the top level). All fields are optional; set only the ones you want to override. An\nindex signature allows forward-compatible passthrough of llama.cpp parameters this type has not\nyet enumerated.\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\nForward-compatible passthrough for additional llama.cpp parameters.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | ---------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `frequency_penalty?` | `number` | Frequency penalty. | [src/batteries/llm/ollama/types.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L119) |\n| `main_gpu?` | `number` | Primary GPU index. | [src/batteries/llm/ollama/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L127) |\n| `min_p?` | `number` | Min-p sampling cutoff. | [src/batteries/llm/ollama/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L101) |\n| `num_batch?` | `number` | Prompt-processing batch size. | [src/batteries/llm/ollama/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L123) |\n| `num_ctx?` | `number` | Context window (KV-cache) size in tokens. Independent of the ADK `contextWindow` guard. | [src/batteries/llm/ollama/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L93) |\n| `num_gpu?` | `number` | Number of layers to offload to GPU(s). | [src/batteries/llm/ollama/types.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L125) |\n| `num_keep?` | `number` | Tokens to keep from the initial prompt when context is exceeded. | [src/batteries/llm/ollama/types.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L111) |\n| `num_predict?` | `number` | Max tokens to predict (`-1` = infinite, `-2` = fill context). | [src/batteries/llm/ollama/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L109) |\n| `num_thread?` | `number` | CPU thread count. | [src/batteries/llm/ollama/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L129) |\n| `numa?` | `boolean` | Enable NUMA support. | [src/batteries/llm/ollama/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L131) |\n| `penalize_newline?` | `boolean` | Penalize newline tokens. | [src/batteries/llm/ollama/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L121) |\n| `presence_penalty?` | `number` | Presence penalty. | [src/batteries/llm/ollama/types.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L117) |\n| `repeat_last_n?` | `number` | Look-back window for repeat penalty. | [src/batteries/llm/ollama/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L115) |\n| `repeat_penalty?` | `number` | Penalty applied to repeated tokens. | [src/batteries/llm/ollama/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L113) |\n| `seed?` | `number` | RNG seed for reproducible outputs. | [src/batteries/llm/ollama/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L105) |\n| `stop?` | `string` | `string`\\[] | Stop sequence(s). | [src/batteries/llm/ollama/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L107) |\n| `temperature?` | `number` | Sampling temperature. | [src/batteries/llm/ollama/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L95) |\n| `top_k?` | `number` | Top-k sampling cutoff. | [src/batteries/llm/ollama/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L99) |\n| `top_p?` | `number` | Nucleus sampling cutoff. | [src/batteries/llm/ollama/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L97) |\n| `typical_p?` | `number` | Typical-p sampling cutoff. | [src/batteries/llm/ollama/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L103) |\n| `use_mmap?` | `boolean` | Memory-map the model. | [src/batteries/llm/ollama/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L133) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaToolCall","title":"Interface: OllamaToolCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaToolCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaToolCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/interfaces/OllamaToolCall.md\ndescription: >-\n A native Ollama tool call as returned on a response/stream `message`. Note:\n `arguments` is a parsed JSON OBJECT (not a string), and there is no `id` or\n `type` field — the adapter synthesizes a correlation id.\n---\n\n# Interface: OllamaToolCall\n\nDefined in: [src/batteries/llm/ollama/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L145)\n\nA native Ollama tool call as returned on a response/stream `message`. Note: `arguments` is a\nparsed JSON OBJECT (not a string), and there is no `id` or `type` field — the adapter\nsynthesizes a correlation id.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `function` | { `arguments`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `name`: `string`; } | The called function: its name and its parsed-JSON-object arguments. | [src/batteries/llm/ollama/types.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L147) |\n| `function.arguments` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | - | [src/batteries/llm/ollama/types.ts:149](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L149) |\n| `function.name` | `string` | - | [src/batteries/llm/ollama/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L148) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaFormat","title":"Type Alias: OllamaFormat","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaFormat.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaFormat","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaFormat.md\ndescription: >-\n Native `format` control. `'json'` requests free-form JSON; a {@link\n JsonSchema} object requests schema-constrained structured output (the model's\n `content` is then a JSON string matching it).\n---\n\n# Type Alias: OllamaFormat\n\n```ts\ntype OllamaFormat = \"json\" | JsonSchema;\n```\n\nDefined in: [src/batteries/llm/ollama/types.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L80)\n\nNative `format` control. `'json'` requests free-form JSON; a [JsonSchema](../../../../interfaces/JsonSchema.md) object requests\nschema-constrained structured output (the model's `content` is then a JSON string matching it).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaThink","title":"Type Alias: OllamaThink","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaThink.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaThink","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaThink.md\ndescription: >-\n Native `think` control for thinking-capable models. `true`/`false` toggle\n reasoning; the effort strings request a reasoning budget on models that\n support graded thinking.\n---\n\n# Type Alias: OllamaThink\n\n```ts\ntype OllamaThink = boolean | \"low\" | \"medium\" | \"high\";\n```\n\nDefined in: [src/batteries/llm/ollama/types.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L72)\n\nNative `think` control for thinking-capable models. `true`/`false` toggle reasoning; the effort\nstrings request a reasoning budget on models that support graded thinking.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaTool","title":"Type Alias: OllamaTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/types/type-aliases/OllamaTool.md\ndescription: >-\n Native function-tool definition (structurally identical to the Chat\n Completions tool wire).\n---\n\n# Type Alias: OllamaTool\n\n```ts\ntype OllamaTool = ChatCompletionsTool;\n```\n\nDefined in: [src/batteries/llm/ollama/types.ts:174](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/types.ts#L174)\n\nNative function-tool definition (structurally identical to the Chat Completions tool wire).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation","title":"@nhtio/adk/batteries/llm/ollama/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/validation.md'\ndescription: Runtime validation schema and wrapper for native Ollama adapter options.\n---\n\n# @nhtio/adk/batteries/llm/ollama/validation\n\nRuntime validation schema and wrapper for native Ollama adapter options.\n\n## Remarks\n\nSchema and call-site wrapper for validating `OllamaAdapterOptions`. Used at construction time\nand at the start of every iteration against the merged options shape (stash > executor >\nconstructor). Throws `E_INVALID_OLLAMA_OPTIONS` on failure — same hard-fail policy as every other\nADK contract.\n\nNote the deliberate `.unknown(...)` asymmetry: the TOP level is `.unknown(false)` so option typos\nfail loud, but the nested `options` (runtime/sampling) block is `.unknown(true)` so new llama.cpp\nparameters pass through without a library bump.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ollamaOptionsSchema](variables/ollamaOptionsSchema.md) | Validator schema for `OllamaAdapterOptions`. Used by `validateOptions` at construction time and again at the start of every iteration after options have been merged (stash > executor > constructor). Rejects unknown top-level keys so typos fail loud. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `ollamaOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_OLLAMA_OPTIONS` (carrying the validator's error report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): OllamaAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/ollama/validation.ts:230](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/validation.ts#L230)\n\nValidates an arbitrary input against `ollamaOptionsSchema` and returns the resolved options\nshape. Throws `E_INVALID_OLLAMA_OPTIONS` (carrying the validator's error report on `cause`) on\nfailure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`OllamaAdapterOptions`](../../types/interfaces/OllamaAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation/variables/ollamaOptionsSchema","title":"Variable: ollamaOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation/variables/ollamaOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/ollama/validation/variables/ollamaOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/ollama/validation/variables/ollamaOptionsSchema.md\ndescription: >-\n Validator schema for `OllamaAdapterOptions`. Used by `validateOptions` at\n construction time and again at the start of every iteration after options have\n been merged (stash > executor > constructor). Rejects unknown top-level keys\n so typos fail loud.\n---\n\n# Variable: ollamaOptionsSchema\n\n```ts\nconst ollamaOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/ollama/validation.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/ollama/validation.ts#L165)\n\nValidator schema for `OllamaAdapterOptions`. Used by `validateOptions` at construction time and\nagain at the start of every iteration after options have been merged (stash > executor >\nconstructor). Rejects unknown top-level keys so typos fail loud.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions","title":"@nhtio/adk/batteries/llm/openai\\_chat\\_completions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions.md'\ndescription: >-\n OpenAI Chat Completions adapter battery with swappable translation helpers and\n wire types.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_chat\\_completions\n\nOpenAI Chat Completions adapter battery with swappable translation helpers and wire types.\n\n## Remarks\n\nOpinionated OpenAI Chat Completions LLM battery. Ships an `OpenAIChatCompletionsAdapter` that\ntargets any OpenAI-Chat-Completions-compatible endpoint (OpenAI proper, OpenRouter, Together,\nGroq, Ollama's `/v1`, vLLM, LM Studio, llama.cpp's `/v1`, Azure OpenAI behind a proxy,\nLiteLLM, custom gateways, etc.) and translates the ADK's primitives into the Chat\nCompletions wire shape.\n\nRe-exports the adapter class, every translation helper (each under its unprefixed name AND a\n`default*`-prefixed alias so consumers can compose partial overrides against the bundled\ndefaults), every option / wire-shape type alias, the validation schema + `validateOptions`\nwrapper, and the six battery-scoped exception classes.\n\nSee the project README for the design-decisions block governing this battery (trust-framed\nenvelopes, per-tool trust, swappable translation helpers, per-dispatch override channel via\n`stash`, trust-tier-distinct envelopes, multi-identity rendering, opaque-reasoning\nround-trips, etc.).\n\n## References\n\n### AssembledToolCall\n\nRe-exports [AssembledToolCall](types/interfaces/AssembledToolCall.md)\n\n***\n\n### buildChatCompletionsHistory\n\nRe-exports [buildChatCompletionsHistory](helpers/functions/buildChatCompletionsHistory.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsChunk\n\nRe-exports [ChatCompletionsChunk](types/interfaces/ChatCompletionsChunk.md)\n\n***\n\n### ChatCompletionsHelpers\n\nRe-exports [ChatCompletionsHelpers](types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### ChatCompletionsMessage\n\nRe-exports [ChatCompletionsMessage](types/interfaces/ChatCompletionsMessage.md)\n\n***\n\n### ChatCompletionsResponse\n\nRe-exports [ChatCompletionsResponse](types/interfaces/ChatCompletionsResponse.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### ChatCompletionsToolCallDelta\n\nRe-exports [ChatCompletionsToolCallDelta](types/interfaces/ChatCompletionsToolCallDelta.md)\n\n***\n\n### ChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [ChatCompletionsToolCallDeltaAccumulator](types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### createChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [createChatCompletionsToolCallDeltaAccumulator](helpers/functions/createChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### deCollideToolCallIds\n\nRe-exports [deCollideToolCallIds](../../variables/deCollideToolCallIds.md)\n\n***\n\n### defaultBuildChatCompletionsHistory\n\nRe-exports [defaultBuildChatCompletionsHistory](helpers/variables/defaultBuildChatCompletionsHistory.md)\n\n***\n\n### defaultCreateChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [defaultCreateChatCompletionsToolCallDeltaAccumulator](helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderChatCompletionsToolCallResult\n\nRe-exports [defaultRenderChatCompletionsToolCallResult](helpers/variables/defaultRenderChatCompletionsToolCallResult.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTimelineMessage\n\nRe-exports [defaultRenderTimelineMessage](helpers/variables/defaultRenderTimelineMessage.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS](exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR](exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT](exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED\n\nRe-exports [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED](exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### floorTrustTier\n\nRe-exports [floorTrustTier](../../functions/floorTrustTier.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### neutraliseDeveloperRulesTag\n\nRe-exports [neutraliseDeveloperRulesTag](../../functions/neutraliseDeveloperRulesTag.md)\n\n***\n\n### OpenAIChatCompletionsAdapter\n\nRe-exports [OpenAIChatCompletionsAdapter](adapter/classes/OpenAIChatCompletionsAdapter.md)\n\n***\n\n### OpenAIChatCompletionsAdapterOptions\n\nRe-exports [OpenAIChatCompletionsAdapterOptions](types/interfaces/OpenAIChatCompletionsAdapterOptions.md)\n\n***\n\n### openAIChatCompletionsOptionsSchema\n\nRe-exports [openAIChatCompletionsOptionsSchema](validation/variables/openAIChatCompletionsOptionsSchema.md)\n\n***\n\n### OpenAIChatCompletionsRequestBody\n\nRe-exports [OpenAIChatCompletionsRequestBody](types/interfaces/OpenAIChatCompletionsRequestBody.md)\n\n***\n\n### PromptAssembledObservation\n\nRe-exports [PromptAssembledObservation](../../interfaces/PromptAssembledObservation.md)\n\n***\n\n### PromptAssembledObserverFn\n\nRe-exports [PromptAssembledObserverFn](../../type-aliases/PromptAssembledObserverFn.md)\n\n***\n\n### RawGenerationObservation\n\nRe-exports [RawGenerationObservation](../../interfaces/RawGenerationObservation.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### ReasoningExtract\n\nRe-exports [ReasoningExtract](types/interfaces/ReasoningExtract.md)\n\n***\n\n### ReasoningField\n\nRe-exports [ReasoningField](types/type-aliases/ReasoningField.md)\n\n***\n\n### ReasoningFieldPrecedence\n\nRe-exports [ReasoningFieldPrecedence](types/type-aliases/ReasoningFieldPrecedence.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderChatCompletionsToolCallResult\n\nRe-exports [renderChatCompletionsToolCallResult](helpers/functions/renderChatCompletionsToolCallResult.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTimelineMessage\n\nRe-exports [renderTimelineMessage](helpers/functions/renderTimelineMessage.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### sanitizeFilenameForDescription\n\nRe-exports [sanitizeFilenameForDescription](../../functions/sanitizeFilenameForDescription.md)\n\n***\n\n### sanitizeMimeType\n\nRe-exports [sanitizeMimeType](../../functions/sanitizeMimeType.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### stripEnvelopeSpecialTokens\n\nRe-exports [stripEnvelopeSpecialTokens](../../functions/stripEnvelopeSpecialTokens.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../functions/toolsToChatCompletionsTools.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter","title":"@nhtio/adk/batteries/llm/openai\\_chat\\_completions/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter.md\ndescription: >-\n Cross-environment executor adapter for OpenAI Chat Completions compatible\n endpoints.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_chat\\_completions/adapter\n\nCross-environment executor adapter for OpenAI Chat Completions compatible endpoints.\n\n## Remarks\n\nCross-environment LLM adapter for the OpenAI Chat Completions wire shape. Chat Completions was\nchosen as the ADK's reference adapter because it is the de-facto interchange format for the\nmajority of OpenAI-compatible gateways (vLLM, Together, Groq, Fireworks, Ollama, Azure OpenAI,\nOpenRouter, DeepSeek, Mistral La Plateforme, and most self-hosted deployments). Its tool-call\nsynthetic-history shape (`role: 'assistant', tool_calls: [...]` followed by `role: 'tool'` with\n`tool_call_id`) is the lowest-common-denominator that every conformant gateway accepts.\n\nThe adapter is built around three pluggable layers:\n\n1. **Translation helpers** — the thirteen swappable functions exported from `./helpers` turn\n ADK primitives ([@nhtio/adk!Tokenizable](../../../../common/classes/Tokenizable.md), [@nhtio/adk!Memory](../../../../common/classes/Memory.md), [@nhtio/adk!Message](../../../../common/classes/Message.md), [@nhtio/adk!Thought](../../../../common/classes/Thought.md),\n [@nhtio/adk!ToolCall](../../../../forge/classes/ToolCall.md), [@nhtio/adk!Tool](../../../../forge/classes/Tool.md), [@nhtio/adk!ArtifactTool](../../../../forge/classes/ArtifactTool.md), [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md)) into Chat\n Completions wire shapes. Consumers override individual helpers via `options.helpers.*` to\n customise envelope formats, bucket ordering, thought surfacing, or JSON Schema generation\n without forking the adapter.\n2. **Three-layer options merging** — constructor baseline, per-`executor()` overrides, and\n per-iteration `ctx.stash.openaiChatCompletions` overrides combine with key-by-key\n precedence for `headers`/`helpers`/`retry` and wholesale replacement for everything else.\n The merged shape is re-validated on every iteration so a malformed stash override\n fails loud, not silently.\n3. **Cross-env transport** — uses `globalThis.fetch`, `TextDecoder`, `AbortController`, and\n `AbortSignal.any` only. No Node-specific primitives; works unchanged in browser, edge, and\n server runtimes. SSE framing is hand-parsed against `\\n\\n` separators so the streaming path\n has no dependency on a particular SSE library.\n\nPer-iteration flow (steps 1–9 of the plan):\n\n1. Merge constructor / executor / stash options and re-validate.\n2. Resolve helpers, falling back to bundled `default*` for each unset field.\n3. Forge artifact-query tools by walking `ctx.turnToolCalls`, collecting unique\n `SpooledArtifact` constructors, calling `.forgeTools(ctx)` on each, and merging the\n results with `ctx.tools`.\n4. Pre-render every persisted tool-call result into the prompt-ready string the timeline will\n use, cached by `tc.id`.\n5. When `tokenEncoding !== null`, sum the token weight of every persisted bucket and throw\n [@nhtio/adk/batteries!E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](../exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md) when the total exceeds `contextWindow`.\n6. Build the request body via `buildChatCompletionsHistory`; carry vendor-opaque reasoning\n blocks through the `_adk_reasoning_payloads` side-channel.\n7. POST with a linked `AbortSignal`, retry loop respecting `retry.*`, and a request-timeout\n watchdog that arms before fetch and clears once response headers arrive.\n8. Streaming path: SSE parse via `response.body.getReader()` + `TextDecoder`; surface deltas\n through `helpers.reportMessage` / `reportThought` / `reportToolCall`; assemble tool-call\n deltas via the accumulator; persist `Message` / `Thought` / `ToolCall` records on `[DONE]`.\n9. Non-streaming path: single `response.json()`; same persistence + tool-execution loop.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| [OpenAIChatCompletionsAdapter](classes/OpenAIChatCompletionsAdapter.md) | Opinionated cross-environment LLM adapter for the OpenAI Chat Completions wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter/classes/OpenAIChatCompletionsAdapter","title":"Class: OpenAIChatCompletionsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter/classes/OpenAIChatCompletionsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter/classes/OpenAIChatCompletionsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/adapter/classes/OpenAIChatCompletionsAdapter.md\ndescription: >-\n Opinionated cross-environment LLM adapter for the OpenAI Chat Completions wire\n shape.\n---\n\n# Class: OpenAIChatCompletionsAdapter\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/adapter.ts:321](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/adapter.ts#L321)\n\nOpinionated cross-environment LLM adapter for the OpenAI Chat Completions wire shape.\n\n## Remarks\n\nConstruction validates options eagerly via [@nhtio/adk/batteries!validateOptions](../../validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries!E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS](../../exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md) on failure — config bugs fail loud, not at\ndispatch time. The returned instance is reusable: call [OpenAIChatCompletionsAdapter.executor](#executor)\nonce per `DispatchRunner` configuration to obtain an [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to the\nbaseline plus optional executor-scope overrides.\n\nPer-iteration overrides live on the active [@nhtio/adk!DispatchContext](../../../../../types/interfaces/DispatchContext.md)'s\n`stash.openaiChatCompletions` slot and take highest precedence — they merge into the\nexecutor-scope shape on every iteration. `headers`, `helpers`, and `retry` merge key-by-key\nacross all three layers; every other field is replaced wholesale at the highest layer that\nsets it.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OpenAIChatCompletionsAdapter(options: unknown): OpenAIChatCompletionsAdapter;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/adapter.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/adapter.ts#L337)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options. Re-validated on every iteration after per-dispatch and per-iteration overrides are layered in. |\n\n#### Returns\n\n`OpenAIChatCompletionsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS](../../exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md) when `options` does not satisfy\n[@nhtio/adk/batteries!openAIChatCompletionsOptionsSchema](../../validation/variables/openAIChatCompletionsOptionsSchema.md).\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"openaiChatCompletions\"` | Customary key for per-iteration overrides on `ctx.stash`. The adapter reads `ctx.stash.get(OpenAIChatCompletionsAdapter.STASH_KEY, {})` at the start of every iteration and merges the value into the resolved options shape. | [src/batteries/llm/openai\\_chat\\_completions/adapter.ts:327](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/adapter.ts#L327) |\n\n## Methods\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/adapter.ts:350](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/adapter.ts#L350)\n\nReturns an [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to this adapter's baseline plus optional\nexecutor-scope overrides. The returned function is reusable across iterations — every\niteration re-merges with `ctx.stash[STASH_KEY]` and re-validates the result.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`OpenAIChatCompletionsAdapterOptions`](../../types/interfaces/OpenAIChatCompletionsAdapterOptions.md)> | Optional executor-scope overrides. Higher precedence than the baseline, lower precedence than `ctx.stash[STASH_KEY]`. |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\nAn [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) suitable for `DispatchRunner`.\n\n***\n\n### isOpenAIChatCompletionsAdapter()\n\n```ts\nstatic isOpenAIChatCompletionsAdapter(value: unknown): value is OpenAIChatCompletionsAdapter;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/adapter.ts:1455](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/adapter.ts#L1455)\n\nReturns `true` when `value` is an OpenAIChatCompletionsAdapter instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is OpenAIChatCompletionsAdapter`\n\n`true` when `value` is an `OpenAIChatCompletionsAdapter` instance.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions","title":"@nhtio/adk/batteries/llm/openai\\_chat\\_completions/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions.md\ndescription: >-\n Battery-scoped exception constructors for OpenAI Chat Completions adapter\n failures.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_chat\\_completions/exceptions\n\nBattery-scoped exception constructors for OpenAI Chat Completions adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the OpenAI Chat Completions adapter. These exceptions\nare owned by the battery (not the ADK core) and are minted via `createException` from\n`@nhtio/adk/factories`. Re-exported from the battery's barrel.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS](variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md) | Thrown when the resolved adapter options (constructor, executor overrides, or per-dispatch `stash.openaiChatCompletions`) fail validation against `openAIChatCompletionsOptionsSchema`. |\n| [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md) | Thrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in the message so middleware can target shedding. |\n| [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR](variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR.md) | Thrown when the upstream Chat Completions endpoint returns a non-2xx response. Non-fatal — surfaced via `ctx.nack(...)` so middleware can decide retry / fail. |\n| [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md) | Raised when a tool-call's `arguments` string emitted by the model is not a JSON object — either non-parseable JSON, or parseable JSON whose root is not an object (e.g. a bare string, number, array, or `null`). |\n| [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT](variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT.md) | Thrown when the initial request handshake (TCP connect, TLS, response headers) does not complete before `requestTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)`. Eligible for retry on the same footing as a retriable 5xx. |\n| [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR.md) | Thrown when the SSE stream emits a malformed chunk or the transport throws mid-stream. Non-fatal — surfaced via `ctx.nack(...)`. |\n| [E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED](variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED.md) | Thrown when the SSE stream goes silent for longer than `streamIdleTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)` with partial-state details so middleware can recover. |\n| [E\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_UNSUPPORTED_MEDIA_MODALITY.md) | Raised when a [@nhtio/adk!Media](../../../../common/classes/Media.md) instance whose modality cannot be natively represented in the OpenAI Chat Completions wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS","title":"Variable: E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options (constructor, executor overrides, or\n per-dispatch `stash.openaiChatCompletions`) fail validation against\n `openAIChatCompletionsOptionsSchema`.\n---\n\n# Variable: E\\_INVALID\\_OPENAI\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\n```ts\nconst E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L18)\n\nThrown when the resolved adapter options (constructor, executor overrides, or per-dispatch\n`stash.openaiChatCompletions`) fail validation against `openAIChatCompletionsOptionsSchema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW","title":"Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the total token weight of the resolved request exceeds\n `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries\n---\n\n# Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L31)\n\nThrown when the total token weight of the resolved request exceeds `contextWindow`. Only\nraised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding,\nperBucket }` in the message so middleware can target shedding.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR","title":"Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR.md\ndescription: >-\n Thrown when the upstream Chat Completions endpoint returns a non-2xx response.\n Non-fatal — surfaced via `ctx.nack(...)` so middleware can decide retry /\n fail.\n---\n\n# Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_HTTP\\_ERROR\n\n```ts\nconst E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L45)\n\nThrown when the upstream Chat Completions endpoint returns a non-2xx response. Non-fatal —\nsurfaced via `ctx.nack(...)` so middleware can decide retry / fail.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md\ndescription: >-\n Raised when a tool-call's `arguments` string emitted by the model is not a\n JSON object — either non-parseable JSON, or parseable JSON whose root is not\n an object (e.g. a bare string, number, array, or `null`).\n---\n\n# Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS: CreatedException<\n [string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L108)\n\nRaised when a tool-call's `arguments` string emitted by the model is not a JSON object —\neither non-parseable JSON, or parseable JSON whose root is not an object (e.g. a bare string,\nnumber, array, or `null`).\n\n## Remarks\n\nNon-fatal. The adapter does NOT throw this — it instantiates it inside\n`executeAndPersistToolCall`, pulls `.message` into a [@nhtio/adk!Tokenizable](../../../../../common/classes/Tokenizable.md), and persists a\n`ToolCall` record with `isError: true`. The model sees the formatted message in the next\niteration's history and can self-correct. Consumers introspecting persisted error results\ncan match on the `E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS` code substring.\n\nPrintf args: `[reasonHeadline, rawArgs]`.\n\n* `reasonHeadline` — short reason such as `'are not valid JSON'` or\n `'must be a JSON object; received array'`.\n* `rawArgs` — the raw `arguments` string the model emitted, echoed back verbatim so\n the model can see what it sent.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT","title":"Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT.md\ndescription: >-\n Thrown when the initial request handshake (TCP connect, TLS, response headers)\n does not complete before `requestTimeoutMs`. Non-fatal — surfaced via\n `ctx.nack(...)`. Eligible for retry on the same footing as a retriable 5xx.\n---\n\n# Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L82)\n\nThrown when the initial request handshake (TCP connect, TLS, response headers) does not\ncomplete before `requestTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)`. Eligible for\nretry on the same footing as a retriable 5xx.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR","title":"Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR.md\ndescription: >-\n Thrown when the SSE stream emits a malformed chunk or the transport throws\n mid-stream. Non-fatal — surfaced via `ctx.nack(...)`.\n---\n\n# Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\n```ts\nconst E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L57)\n\nThrown when the SSE stream emits a malformed chunk or the transport throws mid-stream.\nNon-fatal — surfaced via `ctx.nack(...)`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED","title":"Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED.md\ndescription: >-\n Thrown when the SSE stream goes silent for longer than `streamIdleTimeoutMs`.\n Non-fatal — surfaced via `ctx.nack(...)` with partial-state details so\n middleware can recover.\n---\n\n# Variable: E\\_OPENAI\\_CHAT\\_COMPLETIONS\\_STREAM\\_STALLED\n\n```ts\nconst E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L69)\n\nThrown when the SSE stream goes silent for longer than `streamIdleTimeoutMs`. Non-fatal —\nsurfaced via `ctx.nack(...)` with partial-state details so middleware can recover.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Raised when a {@link @nhtio/adk!Media} instance whose modality cannot be\n natively represented in the OpenAI Chat Completions wire format reaches the\n adapter under `unsupportedMediaPolicy: 'throw'`.\n---\n\n# Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_UNSUPPORTED_MEDIA_MODALITY: CreatedException<[string, string, string]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/exceptions.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/exceptions.ts#L128)\n\nRaised when a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality cannot be natively represented in the\nOpenAI Chat Completions wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`.\n\n## Remarks\n\nToday only `kind: 'video'` triggers this — Chat Completions natively supports `image`,\n`audio`, and `document` content blocks but has no video block. Consumers can opt out of the\nthrow by switching to `'fallback-stash'` or `'synthetic-description'` (see\n[@nhtio/adk/batteries/llm/openai\\_chat\\_completions/types!UnsupportedMediaPolicy](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)).\n\nPrintf args: `[kind, mimeType, filename]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers","title":"@nhtio/adk/batteries/llm/openai\\_chat\\_completions/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers.md\ndescription: >-\n Swappable translation helpers for rendering ADK state into Chat Completions\n requests.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_chat\\_completions/helpers\n\nSwappable translation helpers for rendering ADK state into Chat Completions requests.\n\n## Remarks\n\nThe swappable translation helpers that turn ADK primitives into OpenAI Chat Completions wire\nshapes. Each helper is exported under its unprefixed name AND under a `default*` alias so\nconsumers can compose partial overrides. Helpers that compose other helpers receive their\ndependents via explicit input arguments — never via module-level closure — so a swap at any\nlayer propagates correctly.\n\nThe wire-shape-AGNOSTIC helpers (`renderUntrustedContent`, `renderMemories`,\n`renderChatCompletionsSystemPrompt`, `toolsToChatCompletionsTools`, …) now live in the shared,\ninternal `../chat_common/helpers` submodule and are re-exported here under their original names\nso every existing import keeps resolving. Only the OpenAI-WIRE-SPECIFIC helpers\n(`renderTimelineMessage`, `renderChatCompletionsToolCallResult`, `buildChatCompletionsHistory`,\n`createChatCompletionsToolCallDeltaAccumulator`) and the reasoning-field extractor are defined\nhere.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [defaultBuildChatCompletionsHistory](variables/defaultBuildChatCompletionsHistory.md) | Default history assembler; alias of [buildChatCompletionsHistory](functions/buildChatCompletionsHistory.md). |\n| [defaultCreateChatCompletionsToolCallDeltaAccumulator](variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md) | Default delta-accumulator factory; alias of [createChatCompletionsToolCallDeltaAccumulator](functions/createChatCompletionsToolCallDeltaAccumulator.md). |\n| [defaultRenderChatCompletionsToolCallResult](variables/defaultRenderChatCompletionsToolCallResult.md) | Default tool-call-result renderer; alias of [renderChatCompletionsToolCallResult](functions/renderChatCompletionsToolCallResult.md). |\n| [defaultRenderTimelineMessage](variables/defaultRenderTimelineMessage.md) | Default timeline-message renderer; alias of [renderTimelineMessage](functions/renderTimelineMessage.md). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [buildChatCompletionsHistory](functions/buildChatCompletionsHistory.md) | Assembles the complete OpenAI Chat Completions message history for a dispatch — system prompt and content buckets, the interleaved timeline of messages/thoughts/tool calls (with synthetic `assistant.tool_calls` and `tool.tool_call_id` shaping), and the collected opaque reasoning payloads — by delegating to the injected sub-renderers. |\n| [createChatCompletionsToolCallDeltaAccumulator](functions/createChatCompletionsToolCallDeltaAccumulator.md) | Creates a fresh accumulator that stitches streamed [ChatCompletionsToolCallDelta](../types/interfaces/ChatCompletionsToolCallDelta.md) fragments (keyed by their stream index) into fully-assembled tool calls, drained once the stream completes. |\n| [extractReasoningFields](functions/extractReasoningFields.md) | Pulls model reasoning/thinking text out of a Chat Completions response message or stream delta, reading every wire field named in `precedence` that carries a non-empty string. |\n| [renderChatCompletionsToolCallResult](functions/renderChatCompletionsToolCallResult.md) | Renders a tool call's result(s) into the OpenAI Chat Completions tool-message body — either a plain string or an array of content blocks when the result carries media — wrapping textual output in the trust envelope appropriate to the tool's trust level. |\n| [renderTimelineMessage](functions/renderTimelineMessage.md) | Renders a single timeline [@nhtio/adk!Message](../../../../common/classes/Message.md) into an OpenAI Chat Completions message — mapping media to content blocks (`image_url` / `input_audio` / `file`), wrapping textual bodies in the appropriate trust envelope, and applying the unsupported-media policy. |\n\n## References\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### floorTrustTier\n\nRe-exports [floorTrustTier](../../../functions/floorTrustTier.md)\n\n***\n\n### neutraliseDeveloperRulesTag\n\nRe-exports [neutraliseDeveloperRulesTag](../../../functions/neutraliseDeveloperRulesTag.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n\n***\n\n### sanitizeFilenameForDescription\n\nRe-exports [sanitizeFilenameForDescription](../../../functions/sanitizeFilenameForDescription.md)\n\n***\n\n### sanitizeMimeType\n\nRe-exports [sanitizeMimeType](../../../functions/sanitizeMimeType.md)\n\n***\n\n### stripEnvelopeSpecialTokens\n\nRe-exports [stripEnvelopeSpecialTokens](../../../functions/stripEnvelopeSpecialTokens.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../../functions/toolsToChatCompletionsTools.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/buildChatCompletionsHistory","title":"Function: buildChatCompletionsHistory()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/buildChatCompletionsHistory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/buildChatCompletionsHistory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/buildChatCompletionsHistory.md\n---\n\n# Function: buildChatCompletionsHistory()\n\n```ts\nfunction buildChatCompletionsHistory(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderChatCompletionsToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise<\n | string\n | ChatCompletionsContentBlock[]>;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise<{\n messages: ChatCompletionsMessage[];\n reasoningPayloads: {\n id: string;\n payload: unknown;\n replayCompatibility: string;\n }[];\n}>;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:681](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L681)\n\nAssembles the complete OpenAI Chat Completions message history for a dispatch — system prompt and\ncontent buckets, the interleaved timeline of messages/thoughts/tool calls (with synthetic\n`assistant.tool_calls` and `tool.tool_call_id` shaping), and the collected opaque reasoning\npayloads — by delegating to the injected sub-renderers.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderChatCompletionsToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> |\n| `input.renderChatCompletionsToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]> |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]> |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderRetrievableSafetyDirective` | () => `string` |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` |\n| `input.renderTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)> |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.replayCompatibility` | readonly `string`\\[] |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> |\n| `input.selfIdentity` | `string` |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<{\n`messages`: [`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)\\[];\n`reasoningPayloads`: {\n`id`: `string`;\n`payload`: `unknown`;\n`replayCompatibility`: `string`;\n}\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator","title":"Function: createChatCompletionsToolCallDeltaAccumulator()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator.md\n---\n\n# Function: createChatCompletionsToolCallDeltaAccumulator()\n\n```ts\nfunction createChatCompletionsToolCallDeltaAccumulator(): ChatCompletionsToolCallDeltaAccumulator;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:928](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L928)\n\nCreates a fresh accumulator that stitches streamed [ChatCompletionsToolCallDelta](../../types/interfaces/ChatCompletionsToolCallDelta.md) fragments\n(keyed by their stream index) into fully-assembled tool calls, drained once the stream completes.\n\n## Returns\n\n[`ChatCompletionsToolCallDeltaAccumulator`](../../types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/extractReasoningFields","title":"Function: extractReasoningFields()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/extractReasoningFields.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/extractReasoningFields","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/extractReasoningFields.md\n---\n\n# Function: extractReasoningFields()\n\n```ts\nfunction extractReasoningFields(\n src: Partial> | undefined,\n precedence: ReasoningFieldPrecedence,\n): ReasoningExtract[];\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L131)\n\nPulls model reasoning/thinking text out of a Chat Completions response message or stream delta,\nreading every wire field named in `precedence` that carries a non-empty string.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| `src` | | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`ReasoningField`](../../types/type-aliases/ReasoningField.md), `string` | `null` | `undefined`>> | `undefined` | The response `message` or stream `delta` to read from. |\n| `precedence` | [`ReasoningFieldPrecedence`](../../types/type-aliases/ReasoningFieldPrecedence.md) | Ordered, de-duplicated field names to read (see `reasoningFieldPrecedence`). |\n\n## Returns\n\n[`ReasoningExtract`](../../types/interfaces/ReasoningExtract.md)\\[]\n\nThe present, content-deduplicated reasoning traces in precedence order.\n\n## Remarks\n\nReasoning is not part of OpenAI's official Chat Completions spec, so OpenAI-compatible providers\ndisagree on the field name (`reasoning` for Ollama and current vLLM; `reasoning_content` for\nlegacy vLLM and DeepSeek). This reads the union, in `precedence` order, and de-duplicates by\ncontent value: a field whose text exactly matches one already kept is dropped.\n\nThe result length encodes the emission rule the callers follow:\n\n* `0` — no reasoning present.\n* `1` — a single thought (covers \"only one field present\" AND \"several present but identical\").\n* `≥2` — divergent fields; each surfaces as its own thought rather than silently dropping one.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult","title":"Function: renderChatCompletionsToolCallResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult.md\n---\n\n# Function: renderChatCompletionsToolCallResult()\n\n```ts\nfunction renderChatCompletionsToolCallResult(input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:540](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L540)\n\nRenders a tool call's result(s) into the OpenAI Chat Completions tool-message body — either a\nplain string or an array of content blocks when the result carries media — wrapping textual\noutput in the trust envelope appropriate to the tool's trust level.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<\n| `string`\n| [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderTimelineMessage","title":"Function: renderTimelineMessage()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderTimelineMessage.md\n---\n\n# Function: renderTimelineMessage()\n\n```ts\nfunction renderTimelineMessage(input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:379](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L379)\n\nRenders a single timeline [@nhtio/adk!Message](../../../../../common/classes/Message.md) into an OpenAI Chat Completions message —\nmapping media to content blocks (`image_url` / `input_audio` / `file`), wrapping textual bodies\nin the appropriate trust envelope, and applying the unsupported-media policy.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory","title":"Variable: defaultBuildChatCompletionsHistory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory.md\ndescription: 'Default history assembler; alias of [`buildChatCompletionsHistory`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/buildChatCompletionsHistory).'\n---\n\n# Variable: defaultBuildChatCompletionsHistory\n\n```ts\nconst defaultBuildChatCompletionsHistory: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderChatCompletionsToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise<\n | string\n | ChatCompletionsContentBlock[]>;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise<{\n messages: ChatCompletionsMessage[];\n reasoningPayloads: {\n id: string;\n payload: unknown;\n replayCompatibility: string;\n }[];\n}> = buildChatCompletionsHistory;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:919](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L919)\n\nDefault history assembler; alias of [buildChatCompletionsHistory](../functions/buildChatCompletionsHistory.md).\n\nAssembles the complete OpenAI Chat Completions message history for a dispatch — system prompt and\ncontent buckets, the interleaved timeline of messages/thoughts/tool calls (with synthetic\n`assistant.tool_calls` and `tool.tool_call_id` shaping), and the collected opaque reasoning\npayloads — by delegating to the injected sub-renderers.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderChatCompletionsToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> |\n| `input.renderChatCompletionsToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]> |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]> |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderRetrievableSafetyDirective` | () => `string` |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` |\n| `input.renderTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)> |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.replayCompatibility` | readonly `string`\\[] |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> |\n| `input.selfIdentity` | `string` |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<{\n`messages`: [`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)\\[];\n`reasoningPayloads`: {\n`id`: `string`;\n`payload`: `unknown`;\n`replayCompatibility`: `string`;\n}\\[];\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator","title":"Variable: defaultCreateChatCompletionsToolCallDeltaAccumulator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md\ndescription: >-\n Default delta-accumulator factory; alias of {@link\n createChatCompletionsToolCallDeltaAccumulator}.\n---\n\n# Variable: defaultCreateChatCompletionsToolCallDeltaAccumulator\n\n```ts\nconst defaultCreateChatCompletionsToolCallDeltaAccumulator: () => ChatCompletionsToolCallDeltaAccumulator =\n createChatCompletionsToolCallDeltaAccumulator;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:967](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L967)\n\nDefault delta-accumulator factory; alias of [createChatCompletionsToolCallDeltaAccumulator](../functions/createChatCompletionsToolCallDeltaAccumulator.md).\n\nCreates a fresh accumulator that stitches streamed [ChatCompletionsToolCallDelta](../../types/interfaces/ChatCompletionsToolCallDelta.md) fragments\n(keyed by their stream index) into fully-assembled tool calls, drained once the stream completes.\n\n## Returns\n\n[`ChatCompletionsToolCallDeltaAccumulator`](../../types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult","title":"Variable: defaultRenderChatCompletionsToolCallResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult.md\ndescription: >-\n Default tool-call-result renderer; alias of {@link\n renderChatCompletionsToolCallResult}.\n---\n\n# Variable: defaultRenderChatCompletionsToolCallResult\n\n```ts\nconst defaultRenderChatCompletionsToolCallResult: (input: {\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise =\n renderChatCompletionsToolCallResult;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:663](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L663)\n\nDefault tool-call-result renderer; alias of [renderChatCompletionsToolCallResult](../functions/renderChatCompletionsToolCallResult.md).\n\nRenders a tool call's result(s) into the OpenAI Chat Completions tool-message body — either a\nplain string or an array of content blocks when the result carries media — wrapping textual\noutput in the trust envelope appropriate to the tool's trust level.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<\n| `string`\n| [`ChatCompletionsContentBlock`](../../types/type-aliases/ChatCompletionsContentBlock.md)\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderTimelineMessage","title":"Variable: defaultRenderTimelineMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/variables/defaultRenderTimelineMessage.md\ndescription: 'Default timeline-message renderer; alias of [`renderTimelineMessage`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/helpers/functions/renderTimelineMessage).'\n---\n\n# Variable: defaultRenderTimelineMessage\n\n```ts\nconst defaultRenderTimelineMessage: (input: {\n message: Message;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderTimelineMessage;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/helpers.ts:463](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/helpers.ts#L463)\n\nDefault timeline-message renderer; alias of [renderTimelineMessage](../functions/renderTimelineMessage.md).\n\nRenders a single timeline [@nhtio/adk!Message](../../../../../common/classes/Message.md) into an OpenAI Chat Completions message —\nmapping media to content blocks (`image_url` / `input_audio` / `file`), wrapping textual bodies\nin the appropriate trust envelope, and applying the unsupported-media policy.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`ChatCompletionsMessage`](../../types/interfaces/ChatCompletionsMessage.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types","title":"@nhtio/adk/batteries/llm/openai\\_chat\\_completions/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types.md\ndescription: >-\n TypeScript wire shapes, helper contracts, and option types for the Chat\n Completions battery.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_chat\\_completions/types\n\nTypeScript wire shapes, helper contracts, and option types for the Chat Completions battery.\n\n## Remarks\n\nShared TypeScript type aliases for the OpenAI Chat Completions adapter — wire shapes,\nhelper input/output shapes, and the adapter's options shape. These are documentation-level\ntypes only; runtime validation lives in `validation.ts` (`openAIChatCompletionsOptionsSchema`).\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [AssembledToolCall](interfaces/AssembledToolCall.md) | An assembled tool call ready for execution. |\n| [ChatCompletionsChunk](interfaces/ChatCompletionsChunk.md) | Streaming chunk response from a chat completion API. |\n| [ChatCompletionsChunkChoice](interfaces/ChatCompletionsChunkChoice.md) | A choice option in a streaming chat completions chunk. |\n| [ChatCompletionsChunkDelta](interfaces/ChatCompletionsChunkDelta.md) | Stream delta payload for a chat completion choice chunk. |\n| [ChatCompletionsHelpers](interfaces/ChatCompletionsHelpers.md) | Full translation-helper contract for the OpenAI Chat Completions battery. |\n| [ChatCompletionsMessage](interfaces/ChatCompletionsMessage.md) | Chat completion message wire object. |\n| [ChatCompletionsResponse](interfaces/ChatCompletionsResponse.md) | Non-streaming chat completion response payload. |\n| [ChatCompletionsResponseChoice](interfaces/ChatCompletionsResponseChoice.md) | A choice returned in non-streaming chat completions. |\n| [ChatCompletionsResponseMessage](interfaces/ChatCompletionsResponseMessage.md) | A message response in non-streaming chat completions. |\n| [ChatCompletionsToolCallDelta](interfaces/ChatCompletionsToolCallDelta.md) | Part of a tool call in a streaming response. |\n| [ChatCompletionsToolCallDeltaAccumulator](interfaces/ChatCompletionsToolCallDeltaAccumulator.md) | Accumulator for stitching together streaming tool call deltas into fully-assembled tool calls. |\n| [ChatCompletionsToolCallWire](interfaces/ChatCompletionsToolCallWire.md) | Wire representation of a tool call in a chat completion response or request. |\n| [OpenAIChatCompletionsAdapterOptions](interfaces/OpenAIChatCompletionsAdapterOptions.md) | Configuration options for the OpenAI Chat Completions adapter. |\n| [OpenAIChatCompletionsRequestBody](interfaces/OpenAIChatCompletionsRequestBody.md) | Request body structure for the OpenAI Chat Completions API. |\n| [ReasoningExtract](interfaces/ReasoningExtract.md) | A single reasoning trace extracted from a response message or stream delta — the wire `field` it came from and its `content`. Returned by `extractReasoningFields`. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ChatCompletionsContentBlock](type-aliases/ChatCompletionsContentBlock.md) | Discriminated union of content block shapes accepted by the OpenAI Chat Completions wire format for a content-array message body. |\n| [ReasoningField](type-aliases/ReasoningField.md) | A wire field name that may carry model reasoning/thinking output on an OpenAI-compatible Chat Completions response. |\n| [ReasoningFieldPrecedence](type-aliases/ReasoningFieldPrecedence.md) | Ordered precedence list of reasoning wire fields. See [OpenAIChatCompletionsAdapterOptions.reasoningFieldPrecedence](interfaces/OpenAIChatCompletionsAdapterOptions.md#property-reasoningfieldprecedence). |\n\n## References\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../../interfaces/MemoryAttrs.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../../interfaces/UntrustedContentAttrs.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/AssembledToolCall","title":"Interface: AssembledToolCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/AssembledToolCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/AssembledToolCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/AssembledToolCall.md\ndescription: An assembled tool call ready for execution.\n---\n\n# Interface: AssembledToolCall\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L189)\n\nAn assembled tool call ready for execution.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ------------ | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | `string` | Stringified JSON arguments for the function. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L205) |\n| `id` | `string` | Unique identifier for the tool call. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L193) |\n| `name` | `string` | Name of the function to call. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L201) |\n| `type` | `\"function\"` | Type of tool call, typically 'function'. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L197) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunk","title":"Interface: ChatCompletionsChunk","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunk.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunk","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunk.md\ndescription: Streaming chunk response from a chat completion API.\n---\n\n# Interface: ChatCompletionsChunk\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L270)\n\nStreaming chunk response from a chat completion API.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `choices?` | [`ChatCompletionsChunkChoice`](ChatCompletionsChunkChoice.md)\\[] | List of chunk choice options. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L290) |\n| `created?` | `number` | Unix timestamp when the chunk was created. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L282) |\n| `id?` | `string` | Unique identifier for the chunk. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:274](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L274) |\n| `model?` | `string` | The model name used for generation. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:286](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L286) |\n| `object?` | `string` | The object type, typically 'chat.completion.chunk'. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L278) |\n| `usage?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Token usage statistics if requested. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L294) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkChoice","title":"Interface: ChatCompletionsChunkChoice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkChoice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkChoice","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkChoice.md\ndescription: A choice option in a streaming chat completions chunk.\n---\n\n# Interface: ChatCompletionsChunkChoice\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:252](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L252)\n\nA choice option in a streaming chat completions chunk.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `delta?` | [`ChatCompletionsChunkDelta`](ChatCompletionsChunkDelta.md) | The stream delta object. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L260) |\n| `finish_reason?` | `string` | `null` | The reason the generation stopped. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L264) |\n| `index?` | `number` | Index of the choice in the completions list. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:256](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L256) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkDelta","title":"Interface: ChatCompletionsChunkDelta","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkDelta.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkDelta","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsChunkDelta.md\ndescription: Stream delta payload for a chat completion choice chunk.\n---\n\n# Interface: ChatCompletionsChunkDelta\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L225)\n\nStream delta payload for a chat completion choice chunk.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | `string` | `null` | The content block text fragment. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:233](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L233) |\n| `reasoning?` | `string` | `null` | Non-spec, provider-specific reasoning channel. Emitted by Ollama's `/v1` and current vLLM (which renamed `reasoning_content` → `reasoning`); see [OpenAIChatCompletionsAdapterOptions.reasoningFieldPrecedence](OpenAIChatCompletionsAdapterOptions.md#property-reasoningfieldprecedence). | [src/batteries/llm/openai\\_chat\\_completions/types.ts:242](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L242) |\n| `reasoning_content?` | `string` | `null` | De-facto field for model reasoning output. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L237) |\n| `role?` | `\"assistant\"` | Optional role of the message author. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L229) |\n| `tool_calls?` | [`ChatCompletionsToolCallDelta`](ChatCompletionsToolCallDelta.md)\\[] | Partial stream deltas for tool calls. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:246](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L246) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsHelpers","title":"Interface: ChatCompletionsHelpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsHelpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md\ndescription: Full translation-helper contract for the OpenAI Chat Completions battery.\n---\n\n# Interface: ChatCompletionsHelpers\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:385](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L385)\n\nFull translation-helper contract for the OpenAI Chat Completions battery.\n\n## Remarks\n\nExtends the wire-shape-agnostic [ChatHelpersCommon](../../../openai_responses/types/interfaces/ChatHelpersCommon.md) (the string/JSON-Schema/tool-definition\nrenderers shared with the Ollama battery) and adds the OpenAI-wire-specific members: timeline\nmessage rendering (content blocks), tool-call-result rendering (content blocks), full-history\nassembly (synthetic `assistant.tool_calls` + `tool.tool_call_id` shape), and the streaming\ntool-call delta accumulator. The `deps` parameters reference [ChatHelpersCommon](../../../openai_responses/types/interfaces/ChatHelpersCommon.md) member\ntypes, so this interface carries no self-referential typing for the shared helpers.\n\n## Extends\n\n* [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buildChatCompletionsHistory` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderChatCompletionsToolCallResult`: (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`ChatCompletionsContentBlock`](../type-aliases/ChatCompletionsContentBlock.md)\\[]>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`ChatCompletionsContentBlock`](../type-aliases/ChatCompletionsContentBlock.md)\\[]>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`ChatCompletionsMessage`](ChatCompletionsMessage.md)>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<{ `messages`: [`ChatCompletionsMessage`](ChatCompletionsMessage.md)\\[]; `reasoningPayloads`: { `id`: `string`; `payload`: `unknown`; `replayCompatibility`: `string`; }\\[]; }> | Builds the entire chat history (system prompts, memories, retrievables, timeline, and thoughts) into wire format. | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:410](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L410) |\n| `createChatCompletionsToolCallDeltaAccumulator` | () => [`ChatCompletionsToolCallDeltaAccumulator`](ChatCompletionsToolCallDeltaAccumulator.md) | Instantiates a new tool call delta accumulator for streaming responses. | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L448) |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`descriptionToChatCompletionsJsonSchema`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema) | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`filterThoughts`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-filterthoughts) | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) tool result: metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam. When omitted the battery uses the shared defaultRenderArtifactHandleBody. A consumer overrides it to change WHICH reader the model is steered toward first — e.g. promoting the JSON content-readers (`artifact_json_get` / `artifact_json_keys`) ahead of the metadata-only `artifact_json_type` for a small model that grabs the first listed tool. The tool list itself comes from the artifact's `constructor.toolMethods`; an override typically reorders or re-annotates that list before delegating to the default renderer. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderArtifactHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody) | [src/batteries/llm/chat\\_common/types.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L571) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderChatCompletionsSystemPrompt`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderchatcompletionssystemprompt) | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderChatCompletionsToolCallResult` | (`input`: { `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`ChatCompletionsContentBlock`](../type-aliases/ChatCompletionsContentBlock.md)\\[]> | Renders tool call result payloads into the corresponding wire-formatted message content blocks or text. | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:398](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L398) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderFirstPartyRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderfirstpartyretrievables) | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderMemories`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendermemories) | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md) whose content is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam, the retrievable-side counterpart to [renderArtifactHandleBody](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderartifacthandlebody). When omitted the battery uses the shared defaultRenderRetrievableHandleBody. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableHandleBody`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablehandlebody) | [src/batteries/llm/chat\\_common/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L588) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievables) | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderRetrievableSafetyDirective`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderretrievablesafetydirective) | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderStandingInstructions`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderstandinginstructions) | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPrivateRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables) | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThirdPartyPublicRetrievables`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthirdpartypublicretrievables) | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderThought`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderthought) | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`ChatCompletionsMessage`](ChatCompletionsMessage.md)> | Renders a timeline message into a wire-formatted message. | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:389](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L389) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderTrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-rendertrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`renderUntrustedContent`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-renderuntrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [`ChatHelpersCommon`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md).[`toolsToChatCompletionsTools`](../../../openai_responses/types/interfaces/ChatHelpersCommon.md#property-toolstochatcompletionstools) | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsMessage","title":"Interface: ChatCompletionsMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsMessage.md\ndescription: Chat completion message wire object.\n---\n\n# Interface: ChatCompletionsMessage\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:138](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L138)\n\nChat completion message wire object.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | | `string` | [`ChatCompletionsContentBlock`](../type-aliases/ChatCompletionsContentBlock.md)\\[] | `null` | The contents of the message. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L146) |\n| `name?` | `string` | An optional name for the participant. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L150) |\n| `role` | `\"user\"` | `\"assistant\"` | `\"tool\"` | `\"system\"` | `\"developer\"` | The role of the author of this message. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L142) |\n| `tool_call_id?` | `string` | Tool call identifier if responding to a tool call. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L154) |\n| `tool_calls?` | [`ChatCompletionsToolCallWire`](ChatCompletionsToolCallWire.md)\\[] | The tool calls generated by the model. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L158) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponse","title":"Interface: ChatCompletionsResponse","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponse.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponse","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponse.md\ndescription: Non-streaming chat completion response payload.\n---\n\n# Interface: ChatCompletionsResponse\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:345](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L345)\n\nNon-streaming chat completion response payload.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `choices?` | [`ChatCompletionsResponseChoice`](ChatCompletionsResponseChoice.md)\\[] | List of choices generated by the model. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L365) |\n| `created?` | `number` | Unix timestamp when the response was created. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:357](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L357) |\n| `id?` | `string` | Unique identifier for the response. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:349](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L349) |\n| `model?` | `string` | Model used for completion. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L361) |\n| `object?` | `string` | Object type, typically 'chat.completion'. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:353](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L353) |\n| `usage?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Token usage statistics. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:369](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L369) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseChoice","title":"Interface: ChatCompletionsResponseChoice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseChoice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseChoice","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseChoice.md\ndescription: A choice returned in non-streaming chat completions.\n---\n\n# Interface: ChatCompletionsResponseChoice\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:327](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L327)\n\nA choice returned in non-streaming chat completions.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `finish_reason?` | `string` | `null` | Reason why the model finished generating. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:339](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L339) |\n| `index?` | `number` | Index of the choice in the list. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:331](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L331) |\n| `message?` | [`ChatCompletionsResponseMessage`](ChatCompletionsResponseMessage.md) | Message response payload. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L335) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseMessage","title":"Interface: ChatCompletionsResponseMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsResponseMessage.md\ndescription: A message response in non-streaming chat completions.\n---\n\n# Interface: ChatCompletionsResponseMessage\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:300](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L300)\n\nA message response in non-streaming chat completions.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | `string` | `null` | Text contents of the response. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:308](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L308) |\n| `reasoning?` | `string` | `null` | Non-spec, provider-specific reasoning channel. Emitted by Ollama's `/v1` and current vLLM (which renamed `reasoning_content` → `reasoning`); see [OpenAIChatCompletionsAdapterOptions.reasoningFieldPrecedence](OpenAIChatCompletionsAdapterOptions.md#property-reasoningfieldprecedence). | [src/batteries/llm/openai\\_chat\\_completions/types.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L317) |\n| `reasoning_content?` | `string` | `null` | De-facto field for model reasoning output. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:312](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L312) |\n| `role?` | `\"assistant\"` | Role of the message author. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:304](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L304) |\n| `tool_calls?` | [`ChatCompletionsToolCallWire`](ChatCompletionsToolCallWire.md)\\[] | The tool calls returned by the model. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:321](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L321) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDelta","title":"Interface: ChatCompletionsToolCallDelta","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDelta.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDelta","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDelta.md\ndescription: Part of a tool call in a streaming response.\n---\n\n# Interface: ChatCompletionsToolCallDelta\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L164)\n\nPart of a tool call in a streaming response.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ------------------------------------------------ | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `function?` | { `arguments?`: `string`; `name?`: `string`; } | The partial function name or arguments. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:180](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L180) |\n| `function.arguments?` | `string` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L182) |\n| `function.name?` | `string` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L181) |\n| `id?` | `string` | The identifier of the tool call. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L172) |\n| `index` | `number` | The index of the tool call in the stream. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:168](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L168) |\n| `type?` | `\"function\"` | The tool type, typically 'function'. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L176) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDeltaAccumulator","title":"Interface: ChatCompletionsToolCallDeltaAccumulator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDeltaAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md\ndescription: >-\n Accumulator for stitching together streaming tool call deltas into\n fully-assembled tool calls.\n---\n\n# Interface: ChatCompletionsToolCallDeltaAccumulator\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L211)\n\nAccumulator for stitching together streaming tool call deltas into fully-assembled tool calls.\n\n## Methods\n\n### drain()\n\n```ts\ndrain(): AssembledToolCall[];\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L219)\n\nDrains and returns the completed assembled tool calls.\n\n#### Returns\n\n[`AssembledToolCall`](AssembledToolCall.md)\\[]\n\n***\n\n### feed()\n\n```ts\nfeed(delta: ChatCompletionsToolCallDelta): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L215)\n\nFeeds a tool call delta into the accumulator.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------- |\n| `delta` | [`ChatCompletionsToolCallDelta`](ChatCompletionsToolCallDelta.md) |\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallWire","title":"Interface: ChatCompletionsToolCallWire","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallWire.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallWire","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ChatCompletionsToolCallWire.md\ndescription: Wire representation of a tool call in a chat completion response or request.\n---\n\n# Interface: ChatCompletionsToolCallWire\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L101)\n\nWire representation of a tool call in a chat completion response or request.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ------------------------------------------------ | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `function?` | { `arguments?`: `string`; `name?`: `string`; } | Function detail payload. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L113) |\n| `function.arguments?` | `string` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L115) |\n| `function.name?` | `string` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L114) |\n| `id` | `string` | Unique identifier for the tool call. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L105) |\n| `type?` | `\"function\"` | Type of the tool call, typically 'function'. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L109) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions","title":"Interface: OpenAIChatCompletionsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsAdapterOptions.md\ndescription: Configuration options for the OpenAI Chat Completions adapter.\n---\n\n# Interface: OpenAIChatCompletionsAdapterOptions\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:486](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L486)\n\nConfiguration options for the OpenAI Chat Completions adapter.\n\n## Properties\n\n| Property | Type | Default value | Description | Defined in |\n| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | `undefined` | API key for authenticating requests to the OpenAI-compatible service. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:489](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L489) |\n| `audio?` | { `format`: `\"wav\"` | `\"mp3\"` | `\"flac\"` | `\"opus\"` | `\"pcm16\"`; `voice`: `string`; } | `undefined` | Parameters for audio output if requested. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L614) |\n| `audio.format` | `\"wav\"` | `\"mp3\"` | `\"flac\"` | `\"opus\"` | `\"pcm16\"` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L614) |\n| `audio.voice` | `string` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L614) |\n| `autoAck?` | `boolean` | `false` | Whether the executor should call [ctx.ack()](../../../../../types/interfaces/DispatchContext.md#ack) itself when a generation completes with no tool calls (a terminal text answer). **Remarks** `ack()` is terminal and one-shot: once called, the dispatch loop exits after the current iteration. When the executor acks automatically, it seizes turn-completion control from the implementor — a `dispatchOutputPipeline` quality gate can never run, because the signal is already set before the output pipeline executes. This option therefore defaults to **`false`** (opt-in). With `autoAck: false`, a tool-call-free response leaves the context unsignalled and the executor returns; the implementor's output pipeline (or a later iteration) is responsible for calling `ctx.ack()` / `ctx.nack()`. This is the seam that makes output-side quality gates (citation enforcement, schema validation, regenerate-on-reject) possible. Set `autoAck: true` to restore single-shot behavior: the executor acks the moment a tool-call-free answer finishes, terminating the turn without giving the output pipeline a vote. The tool-call path is unaffected by this flag — it always withholds ack so the runner can iterate and execute the calls. Error paths always [nack](../../../../../types/interfaces/DispatchContext.md#nack) regardless of this flag. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:608](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L608) |\n| `baseURL?` | `string` | `undefined` | Base URL for the OpenAI-compatible API endpoint. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:491](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L491) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | `undefined` | Determines order of memory and retrievable buckets in history assembly. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:505](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L505) |\n| `contextWindow?` | `number` | `undefined` | Size of the model's token context window. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:507](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L507) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | `undefined` | Custom fetch implementation to use for HTTP requests. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:503](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L503) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | `undefined` | OPTIONAL hook to SHAPE the artifact-query tools forged from prior-turn SpooledArtifact results, before they merge into the visible tool set. Receives the merged forged registry + dispatch context; returns a (possibly narrowed) registry, applied BEFORE the merge with `ctx.tools`. Lets the assembler keep only the core readers on a tight window (the rest reachable via tool\\_catalog/call\\_a\\_tool). Default absent = identity (all forged tools) = backward-compatible. The battery stays budget-agnostic (per the CONTRIBUTING size-threshold rule) — it applies the supplied filter without measuring context; budget logic lives in the caller's filter. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:763](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L763) |\n| `frequency_penalty?` | `number` | `undefined` | Frequency penalty wire field to discourage repeating words. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:616](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L616) |\n| `function_call?` | | `\"auto\"` | `\"none\"` | { `name`: `string`; } | `undefined` | Deprecated wire field to control which function is called. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:618](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L618) |\n| `functions?` | { `description?`: `string`; `name`: `string`; `parameters?`: [`JsonSchema`](../../../../interfaces/JsonSchema.md); }\\[] | `undefined` | Deprecated list of functions available to the model. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:620](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L620) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | `undefined` | Extra HTTP headers to include with each request. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:493](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L493) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`ChatCompletionsHelpers`](ChatCompletionsHelpers.md)> | `undefined` | Optional overrides for OpenAI chat completions helpers. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:536](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L536) |\n| `localToolCallParser?` | | [`ToolCallParserName`](../../../transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) | `undefined` | OPTIONAL fallback parser for tool calls the provider did NOT return structurally. **Remarks** The Chat Completions `message.tool_calls` array is authoritative: when the provider returns tool calls, those are used and this option is never consulted. But some models — especially small local ones served through an OpenAI-compatible endpoint — emit a tool call in a surface form the endpoint does not lift into `tool_calls`: ``, or bare `name\\nkey: value`. Those land as plain assistant `content`with`tool_calls`empty, silently dropping the call. This is a cross-model, cross-weight reality, not a single-endpoint quirk. Set this to a parser family name (e.g.`'gemma'`), `'auto'`(try every bundled parser in priority order), or a custom [ToolCallParserFn](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) to recover such calls from`content`ONLY when the provider returned none. Recovered calls execute exactly like native ones. Default absent = disabled = today's native-only behaviour (fully backward-compatible). Mirrors the on-device batteries'`toolCallParser`, which parse from text unconditionally because those runtimes never return structured calls. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:751](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L751) |\n| `logit_bias?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `number`> | `undefined` | Bias logits to control token generation likelihood. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:622](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L622) |\n| `logprobs?` | `boolean` | `undefined` | Request log probabilities for generated tokens. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:624](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L624) |\n| `max_completion_tokens?` | `number` | `undefined` | Hard limit on token count for model reasoning/completion. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:626](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L626) |\n| `max_tokens?` | `number` | `undefined` | Maximum number of generated tokens. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:628](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L628) |\n| `metadata?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | `undefined` | Metadata key-value pairs forwarded to the provider. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:630](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L630) |\n| `modalities?` | (`\"text\"` | `\"audio\"`)\\[] | `undefined` | Desired modalities for model output, such as text and audio. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:632](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L632) |\n| `model` | `string` | `undefined` | Name of the model to use for completion. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:612](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L612) |\n| `n?` | `number` | `undefined` | Number of completions to generate for each request. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:634](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L634) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | `undefined` | Observe the fully-assembled request this battery is about to POST TO the provider — fired once per terminal generation, the instant the body is built and BEFORE the fetch, with the wire `messages`, `tools`, and the complete `requestBody`. The mirror of [onRawGeneration](#property-onrawgeneration). Purely observational (return value ignored, errors swallowed). Default absent. An ADK-control key — stripped from the wire request body, never sent to the provider. The request is handed back AS-IS — no redaction — so treat it as potentially sensitive (it may contain auth material that rode the body) if you persist it. See [PromptAssembledObserverFn](../../../../type-aliases/PromptAssembledObserverFn.md). | [src/batteries/llm/openai\\_chat\\_completions/types.ts:732](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L732) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | `undefined` | Observe the model's RAW response for each completed generation — fired once per terminal generation, after the provider's reply is parsed but before the result is persisted, with the returned assistant content (`rawText`), the residual `cleanedText`, and the extracted `reasoning` / `toolCalls`. Purely observational (return value ignored, errors swallowed). Default absent. An ADK-control key — stripped from the wire request body, never sent to the provider. See [RawGenerationObserverFn](../../../../type-aliases/RawGenerationObserverFn.md). | [src/batteries/llm/openai\\_chat\\_completions/types.ts:722](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L722) |\n| `parallel_tool_calls?` | `boolean` | `undefined` | Allow the model to emit multiple tool calls in one turn. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:636](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L636) |\n| `prediction?` | { `content`: | `string` | { `text`: `string`; `type`: `\"text\"`; }\\[]; `type`: `\"content\"`; } | `undefined` | Prediction helper to accelerate latency of known content. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:638](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L638) |\n| `prediction.content` | | `string` | { `text`: `string`; `type`: `\"text\"`; }\\[] | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:640](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L640) |\n| `prediction.type` | `\"content\"` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:639](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L639) |\n| `presence_penalty?` | `number` | `undefined` | Presence penalty wire field to encourage new topics. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:643](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L643) |\n| `prompt_cache_key?` | `string` | `undefined` | Vendor cache key for caching system prompts. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:645](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L645) |\n| `prompt_cache_retention?` | `\"in_memory\"` | `\"24h\"` | `undefined` | Cache retention strategy for cached system prompts. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:647](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L647) |\n| `reasoning_effort?` | `\"none\"` | `\"minimal\"` | `\"low\"` | `\"medium\"` | `\"high\"` | `undefined` | Target reasoning depth/effort for reasoning models. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:649](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L649) |\n| `reasoningFieldPrecedence?` | [`ReasoningFieldPrecedence`](../type-aliases/ReasoningFieldPrecedence.md) | `['reasoning', 'reasoning_content']` | Ordered precedence of the wire fields the adapter reads for model reasoning/thinking output. **Remarks** Reasoning is not part of OpenAI's official Chat Completions spec, so OpenAI-compatible providers disagree on the field name: Ollama's `/v1` and current vLLM emit `reasoning`, while legacy vLLM (≤0.8) and the DeepSeek API emit `reasoning_content`. The adapter reads every field in this list that is present on the response. Precedence governs two things. When more than one listed field is present with **identical** content (or only one is present), the adapter emits a single thought attributed to the highest-precedence field. When listed fields are present with **divergent** content, each surfaces as its own thought (ordered by precedence) rather than silently dropping one — a thought stream is the wrong place to lose data. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:534](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L534) |\n| `replayCompatibility?` | readonly `string`\\[] | `undefined` | List of replay labels supported by the assistant. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L515) |\n| `requestTimeoutMs?` | `number` | `undefined` | Request timeout in milliseconds for API calls. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:499](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L499) |\n| `response_format?` | | { `type`: `\"text\"`; } | { `type`: `\"json_object\"`; } | { `json_schema`: { `description?`: `string`; `name`: `string`; `schema`: [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; }; `type`: `\"json_schema\"`; } | `undefined` | Enforces a specific output format, e.g. JSON schema. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:651](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L651) |\n| `retry?` | [`ChatCompletionsRetryConfig`](../../../../interfaces/ChatCompletionsRetryConfig.md) | `undefined` | Configures request retry behavior. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:501](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L501) |\n| `safety_identifier?` | `string` | `undefined` | Unique safety system identifier or configuration ID. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:664](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L664) |\n| `seed?` | `number` | `undefined` | Deterministic random seed for generation. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:666](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L666) |\n| `selfIdentity?` | `string` | `undefined` | Unique identity label for the assistant instance. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:509](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L509) |\n| `service_tier?` | `\"default\"` | `\"auto\"` | `\"flex\"` | `\"scale\"` | `\"priority\"` | `undefined` | Service reliability tier for processing the request. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:668](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L668) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | a new `InMemorySpoolStore` per dispatch | Backing store for `string` / `Uint8Array` tool returns. Tool output bytes are written under the tool call's id; the resulting [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) (or the tool's configured subclass) is the model-visible handle for the rest of the turn. **Remarks** Defaults to a fresh, ephemeral per-dispatch [@nhtio/adk/batteries/storage/in\\_memory!InMemorySpoolStore](../../../../storage/in_memory/classes/InMemorySpoolStore.md). Inject an [@nhtio/adk/batteries/storage/opfs!OpfsSpoolStore](../../../../storage/opfs/classes/OpfsSpoolStore.md) or a Flydrive-backed store to persist artifacts to durable storage (and to stream large/binary tool output to disk rather than buffering it in memory). **Lifetime / namespacing:** the default store is per-dispatch, so tool-call ids only need to be unique within a dispatch. An injected durable store persists across turns and dispatches, so the tool-call ids used as keys must be globally unique for that store (or the store must apply its own `keyPrefix`); the adapter does not namespace keys for you, and it does not delete entries — lifetime and cleanup of an injected store are the consumer's responsibility. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:557](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L557) |\n| `stop?` | `string` | `string`\\[] | `undefined` | Custom stop sequence strings. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:670](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L670) |\n| `store?` | `boolean` | `undefined` | Request the provider to store the completed trace. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:672](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L672) |\n| `stream?` | `boolean` | `undefined` | Whether to stream the completion response chunk by chunk. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:495](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L495) |\n| `stream_options?` | { `include_obfuscation?`: `boolean`; `include_usage?`: `boolean`; } | `undefined` | Configuration options for response streaming. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:674](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L674) |\n| `stream_options.include_obfuscation?` | `boolean` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:674](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L674) |\n| `stream_options.include_usage?` | `boolean` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:674](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L674) |\n| `streamIdleTimeoutMs?` | `number` | `undefined` | Idle timeout in milliseconds for the stream before aborting. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:497](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L497) |\n| `strictToolChoice?` | `boolean` | `false` | When `tool_choice` (or the `allowed_tools` variant) forces the model onto a specific tool name, and that name resolves to an ephemeral, forged artifact-query tool (one produced by `.forgeTools(ctx)` — i.e. `tool.ephemeral === true`), this flag controls how the adapter reacts: - `false` (default): emit a single `helpers.log.warn({ kind: 'tool-choice-forged-artifact', ... })` record and continue. Forging an artifact-query tool by name is almost always a misconfiguration — the tool may not exist in the next iteration once the artifact ages out — but the call still goes through. - `true`: hard-fail with `E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS`. Use this in production deployments where forcing a forged tool indicates a real bug. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:573](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L573) |\n| `temperature?` | `number` | `undefined` | Sampling temperature control. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:676](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L676) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | `undefined` | Determines which thoughts are surfaced back to the model. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L511) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | `undefined` | Tokenizer encoding configuration for token counting. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L513) |\n| `tool_choice?` | | `\"required\"` | `\"auto\"` | `\"none\"` | { `function`: { `name`: `string`; }; `type`: `\"function\"`; } | { `custom`: { `name`: `string`; }; `type`: `\"custom\"`; } | { `allowed_tools`: { `mode`: `\"required\"` | `\"auto\"`; `tools`: ( | { `function`: { `name`: `string`; }; `type`: `\"function\"`; } | { `custom`: { `name`: `string`; }; `type`: `\"custom\"`; })\\[]; }; `type`: `\"allowed_tools\"`; } | `undefined` | Enforce or disable tool execution selection. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:678](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L678) |\n| `toolCallIdFilter?` | [`ToolCallIdFilterFn`](../../../../type-aliases/ToolCallIdFilterFn.md) | `undefined` | Optional ingress hook for adapting provider tool-call ids; absent preserves the vendor id. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:753](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L753) |\n| `top_logprobs?` | `number` | `undefined` | Top log probability tokens limit. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:695](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L695) |\n| `top_p?` | `number` | `undefined` | Nucleus sampling probability threshold. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:697](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L697) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `'throw'` | Policy for how the adapter handles a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality the OpenAI Chat Completions wire format does not natively support (today: video). See [UnsupportedMediaPolicy](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md). | [src/batteries/llm/openai\\_chat\\_completions/types.ts:582](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L582) |\n| `user?` | `string` | `undefined` | End-user identifier for abuse monitoring. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:699](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L699) |\n| `verbosity?` | `\"low\"` | `\"medium\"` | `\"high\"` | `undefined` | Diagnostics verbosity level. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:701](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L701) |\n| `web_search_options?` | { `search_context_size?`: `\"low\"` | `\"medium\"` | `\"high\"`; `user_location?`: { `approximate`: { `city?`: `string`; `country?`: `string`; `region?`: `string`; `timezone?`: `string`; }; `type`: `\"approximate\"`; }; } | `undefined` | Configuration for built-in web search. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:703](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L703) |\n| `web_search_options.search_context_size?` | `\"low\"` | `\"medium\"` | `\"high\"` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:704](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L704) |\n| `web_search_options.user_location?` | { `approximate`: { `city?`: `string`; `country?`: `string`; `region?`: `string`; `timezone?`: `string`; }; `type`: `\"approximate\"`; } | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:705](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L705) |\n| `web_search_options.user_location.approximate` | { `city?`: `string`; `country?`: `string`; `region?`: `string`; `timezone?`: `string`; } | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:707](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L707) |\n| `web_search_options.user_location.approximate.city?` | `string` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:708](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L708) |\n| `web_search_options.user_location.approximate.country?` | `string` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:709](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L709) |\n| `web_search_options.user_location.approximate.region?` | `string` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:710](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L710) |\n| `web_search_options.user_location.approximate.timezone?` | `string` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:711](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L711) |\n| `web_search_options.user_location.type` | `\"approximate\"` | `undefined` | - | [src/batteries/llm/openai\\_chat\\_completions/types.ts:706](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L706) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsRequestBody","title":"Interface: OpenAIChatCompletionsRequestBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsRequestBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsRequestBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/OpenAIChatCompletionsRequestBody.md\ndescription: Request body structure for the OpenAI Chat Completions API.\n---\n\n# Interface: OpenAIChatCompletionsRequestBody\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:456](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L456)\n\nRequest body structure for the OpenAI Chat Completions API.\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_adk_reasoning_payloads?` | { `id`: `string`; `payload`: `unknown`; `replayCompatibility`: `string`; }\\[] | Side-channel for opaque vendor reasoning payloads. Forwarded to gateways that understand them; stripped by gateways that don't. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:477](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L477) |\n| `messages` | [`ChatCompletionsMessage`](ChatCompletionsMessage.md)\\[] | A list of messages comprising the conversation history so far. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:464](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L464) |\n| `model` | `string` | ID of the model to use. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:460](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L460) |\n| `stream` | `boolean` | If set, partial message deltas will be sent as server-sent events. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:468](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L468) |\n| `tools?` | [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | A list of tools the model may call. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:472](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L472) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ReasoningExtract","title":"Interface: ReasoningExtract","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ReasoningExtract.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ReasoningExtract","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/interfaces/ReasoningExtract.md\ndescription: >-\n A single reasoning trace extracted from a response message or stream delta —\n the wire `field` it came from and its `content`. Returned by\n `extractReasoningFields`.\n---\n\n# Interface: ReasoningExtract\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L85)\n\nA single reasoning trace extracted from a response message or stream delta — the wire `field` it\ncame from and its `content`. Returned by `extractReasoningFields`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ----------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | `string` | The content of the reasoning block. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L93) |\n| `field` | [`ReasoningField`](../type-aliases/ReasoningField.md) | The reasoning field name. | [src/batteries/llm/openai\\_chat\\_completions/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L89) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ChatCompletionsContentBlock","title":"Type Alias: ChatCompletionsContentBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ChatCompletionsContentBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ChatCompletionsContentBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ChatCompletionsContentBlock.md\ndescription: >-\n Discriminated union of content block shapes accepted by the OpenAI Chat\n Completions wire format for a content-array message body.\n---\n\n# Type Alias: ChatCompletionsContentBlock\n\n```ts\ntype ChatCompletionsContentBlock =\n | {\n text: string;\n type: \"text\";\n }\n | {\n image_url: {\n detail?: \"auto\" | \"low\" | \"high\";\n url: string;\n };\n type: \"image_url\";\n }\n | {\n input_audio: {\n data: string;\n format: \"wav\" | \"mp3\";\n };\n type: \"input_audio\";\n }\n | {\n file: {\n file_data?: string;\n file_id?: string;\n filename?: string;\n };\n type: \"file\";\n };\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L129)\n\nDiscriminated union of content block shapes accepted by the OpenAI Chat Completions wire\nformat for a content-array message body.\n\n## Remarks\n\n`text` is the trust-envelope-wrapped string body. `image_url` carries either an inline\n`data:` URI or a remote URL. `input_audio` carries base64-encoded audio plus a format hint.\n`file` carries either a previously-uploaded `file_id` or an inline `file_data` blob with\na `filename`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningField","title":"Type Alias: ReasoningField","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningField.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningField","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningField.md\ndescription: >-\n A wire field name that may carry model reasoning/thinking output on an\n OpenAI-compatible Chat Completions response.\n---\n\n# Type Alias: ReasoningField\n\n```ts\ntype ReasoningField = \"reasoning\" | \"reasoning_content\";\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L73)\n\nA wire field name that may carry model reasoning/thinking output on an OpenAI-compatible\nChat Completions response.\n\n## Remarks\n\nNeither name is part of OpenAI's official Chat Completions spec (OpenAI hides reasoning on Chat\nCompletions and surfaces it only on the Responses API). They are de-facto, provider-specific\nconventions: `reasoning_content` originates with legacy vLLM (≤0.8) and the DeepSeek API, while\n`reasoning` is what Ollama's `/v1` and current vLLM (post-rename) emit.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence","title":"Type Alias: ReasoningFieldPrecedence","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md\ndescription: >-\n Ordered precedence list of reasoning wire fields. See {@link\n OpenAIChatCompletionsAdapterOptions.reasoningFieldPrecedence}.\n---\n\n# Type Alias: ReasoningFieldPrecedence\n\n```ts\ntype ReasoningFieldPrecedence = ReadonlyArray;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/types.ts#L79)\n\nOrdered precedence list of reasoning wire fields. See\n[OpenAIChatCompletionsAdapterOptions.reasoningFieldPrecedence](../interfaces/OpenAIChatCompletionsAdapterOptions.md#property-reasoningfieldprecedence).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation","title":"@nhtio/adk/batteries/llm/openai\\_chat\\_completions/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation.md\ndescription: >-\n Runtime validation schema and wrapper for OpenAI Chat Completions adapter\n options.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_chat\\_completions/validation\n\nRuntime validation schema and wrapper for OpenAI Chat Completions adapter options.\n\n## Remarks\n\nSchema and call-site wrapper for validating `OpenAIChatCompletionsAdapterOptions`. Used at\nconstruction time and at the start of every iteration against the merged options shape\n(stash > executor > constructor). Throws `E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS` on\nfailure — same hard-fail policy as every other ADK contract.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | ----------------------------------------------------------- |\n| [openAIChatCompletionsOptionsSchema](variables/openAIChatCompletionsOptionsSchema.md) | Validator schema for `OpenAIChatCompletionsAdapterOptions`. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `openAIChatCompletionsOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS` (carrying the validator's error report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): OpenAIChatCompletionsAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/validation.ts:352](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/validation.ts#L352)\n\nValidates an arbitrary input against `openAIChatCompletionsOptionsSchema` and returns the\nresolved options shape. Throws `E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS` (carrying the\nvalidator's error report on `cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`OpenAIChatCompletionsAdapterOptions`](../../types/interfaces/OpenAIChatCompletionsAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/variables/openAIChatCompletionsOptionsSchema","title":"Variable: openAIChatCompletionsOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/variables/openAIChatCompletionsOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/variables/openAIChatCompletionsOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_chat_completions/validation/variables/openAIChatCompletionsOptionsSchema.md\ndescription: Validator schema for `OpenAIChatCompletionsAdapterOptions`.\n---\n\n# Variable: openAIChatCompletionsOptionsSchema\n\n```ts\nconst openAIChatCompletionsOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/openai\\_chat\\_completions/validation.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_chat_completions/validation.ts#L249)\n\nValidator schema for `OpenAIChatCompletionsAdapterOptions`.\n\n## Remarks\n\nUsed by `validateOptions` at construction time and again at the start of every iteration after\noptions have been merged (stash > executor > constructor). Rejects unknown top-level keys\nso typos and removed fields (`bucketBudgets`, `maxInlineToolResultFraction`, `trustedTools`)\nfail loud.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses","title":"@nhtio/adk/batteries/llm/openai\\_responses","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses.md'\ndescription: >-\n Native OpenAI Responses API adapter battery with swappable translation helpers\n and wire types.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_responses\n\nNative OpenAI Responses API adapter battery with swappable translation helpers and wire types.\n\n## Remarks\n\nOpinionated cross-environment OpenAI Responses battery. Ships an `OpenAIResponsesAdapter` that\ntargets the Responses API's flat `input: Item[]` wire shape via a hand-rolled `fetch` + SSE\ntransport — no `openai` SDK dependency, mirroring `openai_chat_completions`'s transport\napproach.\n\nUnlocks capabilities the Chat Completions wire cannot express as directly: native reasoning-item\nreplay (signed `encrypted_content`, prefix-fingerprinted and adjacency-enforced per the\nreasoning/output-item pairing constraint), document (`input_file`) media, and hosted server-side\ntool awareness.\n\nRe-exports the adapter class, every translation helper (wire-shape-agnostic helpers are shared\nwith the sibling Chat-family batteries via the internal `chat_common` submodule and re-exported\nhere under their original names, each with a `default*` alias, plus this battery's own\nResponses-specific helpers), the option / wire-shape types, the validation schema +\n`validateOptions` wrapper, and the battery-scoped exception classes.\n\n## References\n\n### buildOpenAIResponsesInput\n\nRe-exports [buildOpenAIResponsesInput](helpers/functions/buildOpenAIResponsesInput.md)\n\n***\n\n### canonicalFingerprint\n\nRe-exports [canonicalFingerprint](helpers/functions/canonicalFingerprint.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### ChatHelpersCommon\n\nRe-exports [ChatHelpersCommon](types/interfaces/ChatHelpersCommon.md)\n\n***\n\n### createResponsesOutputSlotMachine\n\nRe-exports [createResponsesOutputSlotMachine](helpers/functions/createResponsesOutputSlotMachine.md)\n\n***\n\n### deCollideOpenAIResponsesToolCallIds\n\nRe-exports [deCollideOpenAIResponsesToolCallIds](helpers/functions/deCollideOpenAIResponsesToolCallIds.md)\n\n***\n\n### deCollideToolCallIds\n\nRe-exports [deCollideToolCallIds](../../variables/deCollideToolCallIds.md)\n\n***\n\n### defaultBuildOpenAIResponsesInput\n\nRe-exports [defaultBuildOpenAIResponsesInput](helpers/variables/defaultBuildOpenAIResponsesInput.md)\n\n***\n\n### defaultCanonicalFingerprint\n\nRe-exports [defaultCanonicalFingerprint](helpers/variables/defaultCanonicalFingerprint.md)\n\n***\n\n### defaultCreateResponsesOutputSlotMachine\n\nRe-exports [defaultCreateResponsesOutputSlotMachine](helpers/variables/defaultCreateResponsesOutputSlotMachine.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderOpenAIResponsesMediaBlocks\n\nRe-exports [defaultRenderOpenAIResponsesMediaBlocks](helpers/variables/defaultRenderOpenAIResponsesMediaBlocks.md)\n\n***\n\n### defaultRenderOpenAIResponsesReasoningItem\n\nRe-exports [defaultRenderOpenAIResponsesReasoningItem](helpers/variables/defaultRenderOpenAIResponsesReasoningItem.md)\n\n***\n\n### defaultRenderOpenAIResponsesTimelineMessage\n\nRe-exports [defaultRenderOpenAIResponsesTimelineMessage](helpers/variables/defaultRenderOpenAIResponsesTimelineMessage.md)\n\n***\n\n### defaultRenderOpenAIResponsesToolCallResult\n\nRe-exports [defaultRenderOpenAIResponsesToolCallResult](helpers/variables/defaultRenderOpenAIResponsesToolCallResult.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### defaultToolsToOpenAIResponsesTools\n\nRe-exports [defaultToolsToOpenAIResponsesTools](helpers/variables/defaultToolsToOpenAIResponsesTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS](exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR](exceptions/variables/E_OPENAI_RESPONSES_HTTP_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED](exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT](exceptions/variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR](exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED](exceptions/variables/E_OPENAI_RESPONSES_STREAM_STALLED.md)\n\n***\n\n### E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](exceptions/variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### fingerprintOpenAIResponsesPrefix\n\nRe-exports [fingerprintOpenAIResponsesPrefix](helpers/functions/fingerprintOpenAIResponsesPrefix.md)\n\n***\n\n### floorTrustTier\n\nRe-exports [floorTrustTier](../../functions/floorTrustTier.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### neutraliseDeveloperRulesTag\n\nRe-exports [neutraliseDeveloperRulesTag](../../functions/neutraliseDeveloperRulesTag.md)\n\n***\n\n### normalizeOpenAIResponsesItemId\n\nRe-exports [normalizeOpenAIResponsesItemId](helpers/functions/normalizeOpenAIResponsesItemId.md)\n\n***\n\n### OpenAIResponsesAdapter\n\nRe-exports [OpenAIResponsesAdapter](adapter/classes/OpenAIResponsesAdapter.md)\n\n***\n\n### OpenAIResponsesAdapterOptions\n\nRe-exports [OpenAIResponsesAdapterOptions](types/interfaces/OpenAIResponsesAdapterOptions.md)\n\n***\n\n### OpenAIResponsesCompletedEvent\n\nRe-exports [OpenAIResponsesCompletedEvent](types/interfaces/OpenAIResponsesCompletedEvent.md)\n\n***\n\n### OpenAIResponsesErrorEvent\n\nRe-exports [OpenAIResponsesErrorEvent](types/interfaces/OpenAIResponsesErrorEvent.md)\n\n***\n\n### OpenAIResponsesFailedEvent\n\nRe-exports [OpenAIResponsesFailedEvent](types/interfaces/OpenAIResponsesFailedEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallArgumentsDeltaEvent\n\nRe-exports [OpenAIResponsesFunctionCallArgumentsDeltaEvent](types/interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallArgumentsDoneEvent\n\nRe-exports [OpenAIResponsesFunctionCallArgumentsDoneEvent](types/interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent.md)\n\n***\n\n### OpenAIResponsesFunctionCallItem\n\nRe-exports [OpenAIResponsesFunctionCallItem](types/interfaces/OpenAIResponsesFunctionCallItem.md)\n\n***\n\n### OpenAIResponsesFunctionCallOutputItem\n\nRe-exports [OpenAIResponsesFunctionCallOutputItem](types/interfaces/OpenAIResponsesFunctionCallOutputItem.md)\n\n***\n\n### OpenAIResponsesHelpers\n\nRe-exports [OpenAIResponsesHelpers](types/interfaces/OpenAIResponsesHelpers.md)\n\n***\n\n### OpenAIResponsesIncludable\n\nRe-exports [OpenAIResponsesIncludable](types/type-aliases/OpenAIResponsesIncludable.md)\n\n***\n\n### OpenAIResponsesIncompleteEvent\n\nRe-exports [OpenAIResponsesIncompleteEvent](types/interfaces/OpenAIResponsesIncompleteEvent.md)\n\n***\n\n### OpenAIResponsesInputContentBlock\n\nRe-exports [OpenAIResponsesInputContentBlock](types/type-aliases/OpenAIResponsesInputContentBlock.md)\n\n***\n\n### OpenAIResponsesInputItem\n\nRe-exports [OpenAIResponsesInputItem](types/type-aliases/OpenAIResponsesInputItem.md)\n\n***\n\n### OpenAIResponsesMessageItem\n\nRe-exports [OpenAIResponsesMessageItem](types/interfaces/OpenAIResponsesMessageItem.md)\n\n***\n\n### OpenAIResponsesOpaqueOutputItem\n\nRe-exports [OpenAIResponsesOpaqueOutputItem](types/interfaces/OpenAIResponsesOpaqueOutputItem.md)\n\n***\n\n### openAIResponsesOptionsSchema\n\nRe-exports [openAIResponsesOptionsSchema](validation/variables/openAIResponsesOptionsSchema.md)\n\n***\n\n### OpenAIResponsesOutputItem\n\nRe-exports [OpenAIResponsesOutputItem](types/type-aliases/OpenAIResponsesOutputItem.md)\n\n***\n\n### OpenAIResponsesOutputItemAddedEvent\n\nRe-exports [OpenAIResponsesOutputItemAddedEvent](types/interfaces/OpenAIResponsesOutputItemAddedEvent.md)\n\n***\n\n### OpenAIResponsesOutputItemDoneEvent\n\nRe-exports [OpenAIResponsesOutputItemDoneEvent](types/interfaces/OpenAIResponsesOutputItemDoneEvent.md)\n\n***\n\n### OpenAIResponsesOutputMessageContentPart\n\nRe-exports [OpenAIResponsesOutputMessageContentPart](types/type-aliases/OpenAIResponsesOutputMessageContentPart.md)\n\n***\n\n### OpenAIResponsesOutputMessageItem\n\nRe-exports [OpenAIResponsesOutputMessageItem](types/interfaces/OpenAIResponsesOutputMessageItem.md)\n\n***\n\n### OpenAIResponsesOutputTextDeltaEvent\n\nRe-exports [OpenAIResponsesOutputTextDeltaEvent](types/interfaces/OpenAIResponsesOutputTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesOutputTextDoneEvent\n\nRe-exports [OpenAIResponsesOutputTextDoneEvent](types/interfaces/OpenAIResponsesOutputTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesReasoningContentPart\n\nRe-exports [OpenAIResponsesReasoningContentPart](types/interfaces/OpenAIResponsesReasoningContentPart.md)\n\n***\n\n### OpenAIResponsesReasoningItem\n\nRe-exports [OpenAIResponsesReasoningItem](types/interfaces/OpenAIResponsesReasoningItem.md)\n\n***\n\n### OpenAIResponsesReasoningReplayPayload\n\nRe-exports [OpenAIResponsesReasoningReplayPayload](types/interfaces/OpenAIResponsesReasoningReplayPayload.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryPart\n\nRe-exports [OpenAIResponsesReasoningSummaryPart](types/interfaces/OpenAIResponsesReasoningSummaryPart.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryTextDeltaEvent\n\nRe-exports [OpenAIResponsesReasoningSummaryTextDeltaEvent](types/interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesReasoningSummaryTextDoneEvent\n\nRe-exports [OpenAIResponsesReasoningSummaryTextDoneEvent](types/interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesReasoningTextDeltaEvent\n\nRe-exports [OpenAIResponsesReasoningTextDeltaEvent](types/interfaces/OpenAIResponsesReasoningTextDeltaEvent.md)\n\n***\n\n### OpenAIResponsesReasoningTextDoneEvent\n\nRe-exports [OpenAIResponsesReasoningTextDoneEvent](types/interfaces/OpenAIResponsesReasoningTextDoneEvent.md)\n\n***\n\n### OpenAIResponsesRefusalDeltaEvent\n\nRe-exports [OpenAIResponsesRefusalDeltaEvent](types/interfaces/OpenAIResponsesRefusalDeltaEvent.md)\n\n***\n\n### OpenAIResponsesRefusalDoneEvent\n\nRe-exports [OpenAIResponsesRefusalDoneEvent](types/interfaces/OpenAIResponsesRefusalDoneEvent.md)\n\n***\n\n### OpenAIResponsesRequestBody\n\nRe-exports [OpenAIResponsesRequestBody](types/interfaces/OpenAIResponsesRequestBody.md)\n\n***\n\n### OpenAIResponsesResponseObject\n\nRe-exports [OpenAIResponsesResponseObject](types/interfaces/OpenAIResponsesResponseObject.md)\n\n***\n\n### OpenAIResponsesStreamEvent\n\nRe-exports [OpenAIResponsesStreamEvent](types/type-aliases/OpenAIResponsesStreamEvent.md)\n\n***\n\n### OpenAIResponsesTool\n\nRe-exports [OpenAIResponsesTool](types/type-aliases/OpenAIResponsesTool.md)\n\n***\n\n### OpenAIResponsesToolChoice\n\nRe-exports [OpenAIResponsesToolChoice](types/type-aliases/OpenAIResponsesToolChoice.md)\n\n***\n\n### OpenAIResponsesUsage\n\nRe-exports [OpenAIResponsesUsage](types/interfaces/OpenAIResponsesUsage.md)\n\n***\n\n### ReasoningReplayMode\n\nRe-exports [ReasoningReplayMode](types/type-aliases/ReasoningReplayMode.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderOpenAIResponsesMediaBlocks\n\nRe-exports [renderOpenAIResponsesMediaBlocks](helpers/functions/renderOpenAIResponsesMediaBlocks.md)\n\n***\n\n### renderOpenAIResponsesReasoningItem\n\nRe-exports [renderOpenAIResponsesReasoningItem](helpers/functions/renderOpenAIResponsesReasoningItem.md)\n\n***\n\n### renderOpenAIResponsesTimelineMessage\n\nRe-exports [renderOpenAIResponsesTimelineMessage](helpers/functions/renderOpenAIResponsesTimelineMessage.md)\n\n***\n\n### renderOpenAIResponsesToolCallResult\n\nRe-exports [renderOpenAIResponsesToolCallResult](helpers/functions/renderOpenAIResponsesToolCallResult.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### ResponsesOutputSlot\n\nRe-exports [ResponsesOutputSlot](types/type-aliases/ResponsesOutputSlot.md)\n\n***\n\n### ResponsesOutputSlotMachine\n\nRe-exports [ResponsesOutputSlotMachine](types/interfaces/ResponsesOutputSlotMachine.md)\n\n***\n\n### ResponsesTextSlot\n\nRe-exports [ResponsesTextSlot](types/interfaces/ResponsesTextSlot.md)\n\n***\n\n### ResponsesThinkingSlot\n\nRe-exports [ResponsesThinkingSlot](types/interfaces/ResponsesThinkingSlot.md)\n\n***\n\n### ResponsesToolCallSlot\n\nRe-exports [ResponsesToolCallSlot](types/interfaces/ResponsesToolCallSlot.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### sanitizeFilenameForDescription\n\nRe-exports [sanitizeFilenameForDescription](../../functions/sanitizeFilenameForDescription.md)\n\n***\n\n### sanitizeMimeType\n\nRe-exports [sanitizeMimeType](../../functions/sanitizeMimeType.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### stripEnvelopeSpecialTokens\n\nRe-exports [stripEnvelopeSpecialTokens](../../functions/stripEnvelopeSpecialTokens.md)\n\n***\n\n### SystemPromptChannel\n\nRe-exports [SystemPromptChannel](types/type-aliases/SystemPromptChannel.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../functions/toolsToChatCompletionsTools.md)\n\n***\n\n### toolsToOpenAIResponsesTools\n\nRe-exports [toolsToOpenAIResponsesTools](helpers/functions/toolsToOpenAIResponsesTools.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/adapter","title":"@nhtio/adk/batteries/llm/openai\\_responses/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/adapter.md'\ndescription: Cross-environment executor adapter for the OpenAI Responses API.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_responses/adapter\n\nCross-environment executor adapter for the OpenAI Responses API.\n\n## Remarks\n\nCross-environment LLM adapter for the OpenAI Responses wire shape — a flat `input: Item[]` array\n(not `messages[]`), where a tool call and its result are two SIBLING top-level items\n(`function_call` / `function_call_output`), and the system prompt defaults to a top-level\n`instructions` string rather than a leading message item.\n\nThe adapter is built around the same three pluggable layers as `openai_chat_completions`:\n\n1. **Translation helpers** — the swappable functions exported from `./helpers` turn ADK\n primitives into Responses wire shapes. Consumers override individual helpers via\n `options.helpers.*`.\n2. **Three-layer options merging** — constructor baseline, per-`executor()` overrides, and\n per-iteration `ctx.stash.openaiResponses` overrides combine with key-by-key precedence for\n `headers`/`helpers`/`retry` and wholesale replacement for everything else. The merged shape\n is re-validated on every iteration.\n3. **Cross-env transport** — hand-rolled `fetch` + SSE parsing, mirroring\n `openai_chat_completions/adapter.ts`'s transport exactly. No `openai` SDK dependency.\n\nThis adapter is STATELESS by design: `store: false` is always sent (never a settable option),\nand the full `input` array is resent every iteration. There is no `[DONE]` sentinel on the\nResponses SSE stream — termination is `response.completed` / `.incomplete` / `.failed`; EOF\nwithout one of these is a best-effort recovery, not a hard failure: it warn-logs and drains\nwhatever was accumulated rather than nacking with [E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR](../exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR.md) (that\nexception is reserved for a genuine stream-level error, e.g. the connection itself failing).\n\nRecoverable-failure handling: a 400 whose body matches `invalid_encrypted_content` drops every\nreasoning item from the resolved input and retries the request once — a documented real-world\nfailure mode when a persisted reasoning `Thought` outlives a server-side key rotation. A 400\nmatching the reasoning/output-item pairing violation phrases translates to\n[E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED](../exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED.md) instead of a generic HTTP error.\n\n`background` is NOT supported: this executor has no polling/resumption loop for a\n`queued`/`in_progress` background response (the Responses API's async mode; see\nhttps://platform.openai.com/docs/guides/background), so `background: true` is rejected up front\nby the options schema (`E_INVALID_OPENAI_RESPONSES_OPTIONS`, see `validation.ts`) rather than\nreaching this executor at all — accepting it here would otherwise fall straight into the\nordinary streaming/non-streaming response handling below and treat the initial\n`queued`/`in_progress` response body as a complete, empty answer, silently discarding whatever\nthe background job eventually produces.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| [OpenAIResponsesAdapter](classes/OpenAIResponsesAdapter.md) | Opinionated cross-environment LLM adapter for the OpenAI Responses wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/adapter/classes/OpenAIResponsesAdapter","title":"Class: OpenAIResponsesAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/adapter/classes/OpenAIResponsesAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/adapter/classes/OpenAIResponsesAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/adapter/classes/OpenAIResponsesAdapter.md\ndescription: Opinionated cross-environment LLM adapter for the OpenAI Responses wire shape.\n---\n\n# Class: OpenAIResponsesAdapter\n\nDefined in: [src/batteries/llm/openai\\_responses/adapter.ts:382](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/adapter.ts#L382)\n\nOpinionated cross-environment LLM adapter for the OpenAI Responses wire shape.\n\n## Remarks\n\nConstruction validates options eagerly via [validateOptions](../../validation/functions/validateOptions.md) and throws\n[E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS](../../exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS.md) on failure. The returned instance is reusable: call\n[OpenAIResponsesAdapter.executor](#executor) once per `DispatchRunner` configuration.\n\nPer-iteration overrides live on the active `DispatchContext`'s `stash.openaiResponses` slot and\ntake highest precedence — they merge into the executor-scope shape on every iteration.\n`headers`, `helpers`, and `retry` merge key-by-key across all three layers; every other field is\nreplaced wholesale at the highest layer that sets it.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OpenAIResponsesAdapter(options: unknown): OpenAIResponsesAdapter;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/adapter.ts:398](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/adapter.ts#L398)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options. Re-validated on every iteration after per-dispatch and per-iteration overrides are layered in. |\n\n#### Returns\n\n`OpenAIResponsesAdapter`\n\n#### Throws\n\nE\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS when `options` does not satisfy\n`openAIResponsesOptionsSchema`.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"openaiResponses\"` | Customary key for per-iteration overrides on `ctx.stash`. The adapter reads `ctx.stash.get(OpenAIResponsesAdapter.STASH_KEY, {})` at the start of every iteration and merges the value into the resolved options shape. | [src/batteries/llm/openai\\_responses/adapter.ts:388](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/adapter.ts#L388) |\n\n## Methods\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/adapter.ts:411](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/adapter.ts#L411)\n\nReturns a `DispatchExecutorFn` bound to this adapter's baseline plus optional executor-scope\noverrides. The returned function is reusable across iterations — every iteration re-merges\nwith `ctx.stash[STASH_KEY]` and re-validates the result.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`OpenAIResponsesAdapterOptions`](../../types/interfaces/OpenAIResponsesAdapterOptions.md)> | Optional executor-scope overrides. Higher precedence than the baseline, lower precedence than `ctx.stash[STASH_KEY]`. |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\nA `DispatchExecutorFn` suitable for `DispatchRunner`.\n\n***\n\n### isOpenAIResponsesAdapter()\n\n```ts\nstatic isOpenAIResponsesAdapter(value: unknown): value is OpenAIResponsesAdapter;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/adapter.ts:1979](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/adapter.ts#L1979)\n\nReturns `true` when `value` is an OpenAIResponsesAdapter instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is OpenAIResponsesAdapter`\n\n`true` when `value` is an `OpenAIResponsesAdapter` instance.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions","title":"@nhtio/adk/batteries/llm/openai\\_responses/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions.md'\ndescription: Battery-scoped exception constructors for the OpenAI Responses adapter.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_responses/exceptions\n\nBattery-scoped exception constructors for the OpenAI Responses adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the OpenAI Responses adapter. These exceptions are owned by\nthe battery (not the ADK core) and are minted via `createException` from `@nhtio/adk/factories`.\nRe-exported from the battery's barrel. The status codes and fatal split mirror the sibling\n`openai_chat_completions` and `anthropic_messages` batteries.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS](variables/E_INVALID_OPENAI_RESPONSES_OPTIONS.md) | Thrown when the resolved adapter options (constructor, executor overrides, or per-dispatch `stash.openaiResponses`) fail validation against `openAIResponsesOptionsSchema`. |\n| [E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW](variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW.md) | Thrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in the message so middleware can target shedding. |\n| [E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR](variables/E_OPENAI_RESPONSES_HTTP_ERROR.md) | Thrown when the upstream Responses endpoint returns a non-2xx response. Non-fatal — surfaced via `ctx.nack(...)` so middleware can decide retry / fail. |\n| [E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS.md) | Raised when a tool-call's `arguments` string emitted by the model is not a JSON object — either non-parseable JSON, or parseable JSON whose root is not an object (e.g. a bare string, number, array, or `null`). |\n| [E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED](variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED.md) | Thrown when the upstream Responses API rejects the request because a replayed `reasoning` item violates the undocumented reasoning/output-item pairing constraint (`openai/openai-node#1791`) — detected by matching the upstream error body against known phrases (e.g. \"of type 'reasoning' was provided without\" / \"Items are not persisted when store is set to false\"). |\n| [E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT](variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT.md) | Thrown when the initial request handshake (TCP connect, TLS, response headers) does not complete before `requestTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)`. Eligible for retry on the same footing as a retriable 5xx. |\n| [E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR](variables/E_OPENAI_RESPONSES_STREAM_ERROR.md) | Thrown when the SSE stream emits a malformed chunk, the transport throws mid-stream, or an explicit upstream `response.failed` / `error` terminal event arrives. |\n| [E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED](variables/E_OPENAI_RESPONSES_STREAM_STALLED.md) | Thrown when the SSE stream goes silent for longer than `streamIdleTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)` with partial-state details so middleware can recover. |\n| [E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY.md) | Raised when a [@nhtio/adk!Media](../../../../common/classes/Media.md) instance whose modality cannot be natively represented in the OpenAI Responses wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS","title":"Variable: E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_INVALID_OPENAI_RESPONSES_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options (constructor, executor overrides, or\n per-dispatch `stash.openaiResponses`) fail validation against\n `openAIResponsesOptionsSchema`.\n---\n\n# Variable: E\\_INVALID\\_OPENAI\\_RESPONSES\\_OPTIONS\n\n```ts\nconst E_INVALID_OPENAI_RESPONSES_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L19)\n\nThrown when the resolved adapter options (constructor, executor overrides, or per-dispatch\n`stash.openaiResponses`) fail validation against `openAIResponsesOptionsSchema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW","title":"Variable: E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the total token weight of the resolved request exceeds\n `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{\n total, contextWindow, tokenEncoding, perBucket }` in the message so middleware\n can target shedding.\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_OPENAI_RESPONSES_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L32)\n\nThrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised\nwhen `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in\nthe message so middleware can target shedding.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_HTTP_ERROR","title":"Variable: E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_HTTP_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_HTTP_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_HTTP_ERROR.md\ndescription: >-\n Thrown when the upstream Responses endpoint returns a non-2xx response.\n Non-fatal — surfaced via `ctx.nack(...)` so middleware can decide retry /\n fail.\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_HTTP\\_ERROR\n\n```ts\nconst E_OPENAI_RESPONSES_HTTP_ERROR: CreatedException<[number, string]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L46)\n\nThrown when the upstream Responses endpoint returns a non-2xx response. Non-fatal — surfaced via\n`ctx.nack(...)` so middleware can decide retry / fail.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS.md\ndescription: >-\n Raised when a tool-call's `arguments` string emitted by the model is not a\n JSON object — either non-parseable JSON, or parseable JSON whose root is not\n an object (e.g. a bare string, number, array, or `null`).\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS: CreatedException<\n [string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L115)\n\nRaised when a tool-call's `arguments` string emitted by the model is not a JSON object — either\nnon-parseable JSON, or parseable JSON whose root is not an object (e.g. a bare string, number,\narray, or `null`).\n\n## Remarks\n\nNon-fatal. The adapter does NOT throw this — it instantiates it inside\n`executeAndPersistToolCall`, pulls `.message` into a [@nhtio/adk!Tokenizable](../../../../../common/classes/Tokenizable.md), and persists a\n`ToolCall` record with `isError: true`. The model sees the formatted message in the next\niteration's history and can self-correct. Consumers introspecting persisted error results can\nmatch on the `E_OPENAI_RESPONSES_INVALID_TOOL_CALL_ARGS` code substring.\n\nPrintf args: `[reasonHeadline, rawArgs]`.\n\n* `reasonHeadline` — short reason such as `'are not valid JSON'` or\n `'must be a JSON object; received array'`.\n* `rawArgs` — the raw `arguments` string the model emitted, echoed back verbatim so the model\n can see what it sent.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED","title":"Variable: E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED.md\ndescription: >-\n Thrown when the upstream Responses API rejects the request because a replayed\n `reasoning` item violates the undocumented reasoning/output-item pairing\n constraint (`openai/openai-node#1791`) — detected by matching the upstream\n error body against known phrases (e.g. \"of type 'reasoning' was provided\n without\" / \"Items are not persisted when store is set to false\").\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_REASONING\\_REPLAY\\_REJECTED\n\n```ts\nconst E_OPENAI_RESPONSES_REASONING_REPLAY_REJECTED: CreatedException<\n [string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L157)\n\nThrown when the upstream Responses API rejects the request because a replayed `reasoning` item\nviolates the undocumented reasoning/output-item pairing constraint (`openai/openai-node#1791`) —\ndetected by matching the upstream error body against known phrases (e.g. \"of type 'reasoning'\nwas provided without\" / \"Items are not persisted when store is set to false\").\n\n## Remarks\n\nNon-fatal — surfaced via `ctx.nack(...)`. Names the offending item and suggests\n`reasoningReplay: 'off'` as a mitigation, rather than surfacing a generic HTTP error.\n\nPrintf args: `[itemId, upstreamMessage]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT","title":"Variable: E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_REQUEST_TIMEOUT.md\ndescription: >-\n Thrown when the initial request handshake (TCP connect, TLS, response headers)\n does not complete before `requestTimeoutMs`. Non-fatal — surfaced via\n `ctx.nack(...)`. Eligible for retry on the same footing as a retriable 5xx.\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_REQUEST\\_TIMEOUT\n\n```ts\nconst E_OPENAI_RESPONSES_REQUEST_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L89)\n\nThrown when the initial request handshake (TCP connect, TLS, response headers) does not complete\nbefore `requestTimeoutMs`. Non-fatal — surfaced via `ctx.nack(...)`. Eligible for retry on the\nsame footing as a retriable 5xx.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR","title":"Variable: E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_ERROR.md\ndescription: >-\n Thrown when the SSE stream emits a malformed chunk, the transport throws\n mid-stream, or an explicit upstream `response.failed` / `error` terminal event\n arrives.\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_STREAM\\_ERROR\n\n```ts\nconst E_OPENAI_RESPONSES_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L64)\n\nThrown when the SSE stream emits a malformed chunk, the transport throws mid-stream, or an\nexplicit upstream `response.failed` / `error` terminal event arrives.\n\n## Remarks\n\nNOT thrown when the stream reaches EOF without ever observing a terminal event. The Responses\nSSE stream has no `[DONE]` sentinel, so a truncated-looking stream is indistinguishable from a\nshort one: the adapter warn-logs (`kind: 'sse-eof-without-terminal-event'`) and drains whatever\nit accumulated, rather than discarding a usable partial turn.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_STALLED","title":"Variable: E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_STALLED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_STALLED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_STREAM_STALLED.md\ndescription: >-\n Thrown when the SSE stream goes silent for longer than `streamIdleTimeoutMs`.\n Non-fatal — surfaced via `ctx.nack(...)` with partial-state details so\n middleware can recover.\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_STREAM\\_STALLED\n\n```ts\nconst E_OPENAI_RESPONSES_STREAM_STALLED: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L76)\n\nThrown when the SSE stream goes silent for longer than `streamIdleTimeoutMs`. Non-fatal —\nsurfaced via `ctx.nack(...)` with partial-state details so middleware can recover.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/exceptions/variables/E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Raised when a {@link @nhtio/adk!Media} instance whose modality cannot be\n natively represented in the OpenAI Responses wire format reaches the adapter\n under `unsupportedMediaPolicy: 'throw'`.\n---\n\n# Variable: E\\_OPENAI\\_RESPONSES\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_OPENAI_RESPONSES_UNSUPPORTED_MEDIA_MODALITY: CreatedException<\n [string, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/exceptions.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/exceptions.ts#L135)\n\nRaised when a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality cannot be natively represented in\nthe OpenAI Responses wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`.\n\n## Remarks\n\nToday `audio` and `video` trigger this — the Responses input-content union has no audio member\n(confirmed against the `openai` SDK's own type definitions) and no video member either. Consumers\ncan opt out of the throw by switching to `'fallback-stash'` or `'synthetic-description'` (see\n[@nhtio/adk/batteries/llm/openai\\_responses/types!UnsupportedMediaPolicy](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)).\n\nPrintf args: `[kind, mimeType, filename]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers","title":"@nhtio/adk/batteries/llm/openai\\_responses/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers.md'\ndescription: >-\n Swappable translation helpers for rendering ADK state into OpenAI Responses\n requests.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_responses/helpers\n\nSwappable translation helpers for rendering ADK state into OpenAI Responses requests.\n\n## Remarks\n\nThe swappable translation helpers that turn ADK primitives into OpenAI Responses wire shapes.\nEach helper is exported under its unprefixed name AND under a `default*` alias so consumers can\ncompose partial overrides. Helpers that compose other helpers receive their dependents via\nexplicit input arguments — never via module-level closure — so a swap at any layer propagates\ncorrectly.\n\nThe wire-shape-AGNOSTIC helpers (`renderUntrustedContent`, `renderMemories`,\n`renderChatCompletionsSystemPrompt`, `descriptionToChatCompletionsJsonSchema`,\n`canonicalFingerprint`, …) live in the shared, internal `../chat_common/helpers` submodule and\nare re-exported here under their original names so every existing import keeps resolving. Only\nthe Responses-WIRE-SPECIFIC helpers (media mapping, timeline-message rendering, tool-call-result\nrendering, the `buildOpenAIResponsesInput` assembler, the reasoning-replay machinery, the\nfingerprint wrapper, the tool-declaration translator, and the streaming output-slot state\nmachine) are defined here.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| [defaultBuildOpenAIResponsesInput](variables/defaultBuildOpenAIResponsesInput.md) | Default history assembler; alias of [buildOpenAIResponsesInput](functions/buildOpenAIResponsesInput.md). |\n| [defaultCanonicalFingerprint](variables/defaultCanonicalFingerprint.md) | Default canonical-fingerprint primitive; alias of [canonicalFingerprint](functions/canonicalFingerprint.md). |\n| [defaultCreateResponsesOutputSlotMachine](variables/defaultCreateResponsesOutputSlotMachine.md) | Default output-slot state machine factory; alias of [createResponsesOutputSlotMachine](functions/createResponsesOutputSlotMachine.md). |\n| [defaultRenderOpenAIResponsesMediaBlocks](variables/defaultRenderOpenAIResponsesMediaBlocks.md) | Default OpenAI Responses media renderer; alias of [renderOpenAIResponsesMediaBlocks](functions/renderOpenAIResponsesMediaBlocks.md). |\n| [defaultRenderOpenAIResponsesReasoningItem](variables/defaultRenderOpenAIResponsesReasoningItem.md) | Default reasoning-item renderer; alias of [renderOpenAIResponsesReasoningItem](functions/renderOpenAIResponsesReasoningItem.md). |\n| [defaultRenderOpenAIResponsesTimelineMessage](variables/defaultRenderOpenAIResponsesTimelineMessage.md) | Default timeline-message renderer; alias of [renderOpenAIResponsesTimelineMessage](functions/renderOpenAIResponsesTimelineMessage.md). |\n| [defaultRenderOpenAIResponsesToolCallResult](variables/defaultRenderOpenAIResponsesToolCallResult.md) | Default tool-call-result renderer; alias of [renderOpenAIResponsesToolCallResult](functions/renderOpenAIResponsesToolCallResult.md). |\n| [defaultToolsToOpenAIResponsesTools](variables/defaultToolsToOpenAIResponsesTools.md) | Default tool-translation helper; alias of [toolsToOpenAIResponsesTools](functions/toolsToOpenAIResponsesTools.md). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [buildOpenAIResponsesInput](functions/buildOpenAIResponsesInput.md) | Implements [OpenAIResponsesHelpers.buildOpenAIResponsesInput](../types/interfaces/OpenAIResponsesHelpers.md#property-buildopenairesponsesinput). |\n| [canonicalFingerprint](functions/canonicalFingerprint.md) | Computes a SHA-256 fingerprint of `value` via canonical canonicalisation, over its UTF-8 bytes, using `globalThis.crypto.subtle.digest`. |\n| [createResponsesOutputSlotMachine](functions/createResponsesOutputSlotMachine.md) | Implements [OpenAIResponsesHelpers.createResponsesOutputSlotMachine](../types/interfaces/OpenAIResponsesHelpers.md#property-createresponsesoutputslotmachine). |\n| [deCollideOpenAIResponsesToolCallIds](functions/deCollideOpenAIResponsesToolCallIds.md) | De-collides a Responses id while preserving a valid `fc_` item discriminator. |\n| [fingerprintOpenAIResponsesPrefix](functions/fingerprintOpenAIResponsesPrefix.md) | Implements [OpenAIResponsesHelpers.fingerprintOpenAIResponsesPrefix](../types/interfaces/OpenAIResponsesHelpers.md#property-fingerprintopenairesponsesprefix). |\n| [normalizeOpenAIResponsesItemId](functions/normalizeOpenAIResponsesItemId.md) | Normalises an ADK-authored id to the Responses item-id charset, and hashes+truncates ids over the 64-character limit (Known Gotcha #5) rather than sending an oversized id verbatim. |\n| [renderOpenAIResponsesMediaBlocks](functions/renderOpenAIResponsesMediaBlocks.md) | Implements [OpenAIResponsesHelpers.renderOpenAIResponsesMediaBlocks](../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsesmediablocks). |\n| [renderOpenAIResponsesReasoningItem](functions/renderOpenAIResponsesReasoningItem.md) | Implements [OpenAIResponsesHelpers.renderOpenAIResponsesReasoningItem](../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsesreasoningitem). |\n| [renderOpenAIResponsesTimelineMessage](functions/renderOpenAIResponsesTimelineMessage.md) | Implements [OpenAIResponsesHelpers.renderOpenAIResponsesTimelineMessage](../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsestimelinemessage). |\n| [renderOpenAIResponsesToolCallResult](functions/renderOpenAIResponsesToolCallResult.md) | Implements [OpenAIResponsesHelpers.renderOpenAIResponsesToolCallResult](../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsestoolcallresult). |\n| [toolsToOpenAIResponsesTools](functions/toolsToOpenAIResponsesTools.md) | Implements [OpenAIResponsesHelpers.toolsToOpenAIResponsesTools](../types/interfaces/OpenAIResponsesHelpers.md#property-toolstoopenairesponsestools). |\n\n## References\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderArtifactHandleBody\n\nRe-exports [defaultRenderArtifactHandleBody](../../transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### floorTrustTier\n\nRe-exports [floorTrustTier](../../../functions/floorTrustTier.md)\n\n***\n\n### looksLikeSpooledArtifact\n\nRe-exports [looksLikeSpooledArtifact](../../transformers_js/helpers/functions/looksLikeSpooledArtifact.md)\n\n***\n\n### neutraliseDeveloperRulesTag\n\nRe-exports [neutraliseDeveloperRulesTag](../../../functions/neutraliseDeveloperRulesTag.md)\n\n***\n\n### renderArtifactHandleBody\n\nRe-exports [renderArtifactHandleBody](../../transformers_js/helpers/functions/renderArtifactHandleBody.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n\n***\n\n### sanitizeFilenameForDescription\n\nRe-exports [sanitizeFilenameForDescription](../../../functions/sanitizeFilenameForDescription.md)\n\n***\n\n### sanitizeMimeType\n\nRe-exports [sanitizeMimeType](../../../functions/sanitizeMimeType.md)\n\n***\n\n### stripEnvelopeSpecialTokens\n\nRe-exports [stripEnvelopeSpecialTokens](../../../functions/stripEnvelopeSpecialTokens.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../../functions/toolsToChatCompletionsTools.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/buildOpenAIResponsesInput","title":"Function: buildOpenAIResponsesInput()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/buildOpenAIResponsesInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/buildOpenAIResponsesInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/buildOpenAIResponsesInput.md\n---\n\n# Function: buildOpenAIResponsesInput()\n\n```ts\nfunction buildOpenAIResponsesInput(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n fingerprintOpenAIResponsesPrefix: (input: {\n input: OpenAIResponsesInputItem[];\n instructions?: string;\n model: string;\n throughItem?: number;\n tools?: OpenAIResponsesTool[];\n }) => Promise;\n memories: Iterable;\n messages: Iterable;\n model: string;\n reasoningReplay: ReasoningReplayMode;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderCtx?: unknown;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderOpenAIResponsesReasoningItem: (input: {\n prefixFingerprint: string;\n reasoningReplay: ReasoningReplayMode;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n }) =>\n | OpenAIResponsesReasoningItem\n | undefined;\n renderOpenAIResponsesTimelineMessage: (input: {\n message: Message;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise<\n | OpenAIResponsesInputItem\n | null>;\n renderOpenAIResponsesToolCallResult: (input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise<\n | string\n | OpenAIResponsesInputContentBlock[]>;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n strict?: boolean;\n systemPrompt: Tokenizable;\n systemPromptChannel: SystemPromptChannel;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n toolsToOpenAIResponsesTools: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: unknown) => JsonSchema;\n strict?: boolean;\n }) => OpenAIResponsesTool[];\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise<{\n fingerprintableLength: number;\n input: OpenAIResponsesInputItem[];\n instructions?: string;\n tools?: OpenAIResponsesTool[];\n}>;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:770](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L770)\n\nImplements [OpenAIResponsesHelpers.buildOpenAIResponsesInput](../../types/interfaces/OpenAIResponsesHelpers.md#property-buildopenairesponsesinput).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `fingerprintOpenAIResponsesPrefix`: (`input`: { `input`: [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `model`: `string`; `throughItem?`: `number`; `tools?`: [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]; }) => `Promise`<`string`>; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `model`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderOpenAIResponsesReasoningItem`: (`input`: { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => | [`OpenAIResponsesReasoningItem`](../../types/interfaces/OpenAIResponsesReasoningItem.md) | `undefined`; `renderOpenAIResponsesTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md) | `null`>; `renderOpenAIResponsesToolCallResult`: (`input`: { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `strict?`: `boolean`; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `systemPromptChannel`: [`SystemPromptChannel`](../../types/type-aliases/SystemPromptChannel.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `toolsToOpenAIResponsesTools`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; }) => [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.fingerprintOpenAIResponsesPrefix` | (`input`: { `input`: [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `model`: `string`; `throughItem?`: `number`; `tools?`: [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]; }) => `Promise`<`string`> | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.model` | `string` | - |\n| `input.reasoningReplay` | [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md) | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderCtx?` | `unknown` | Live dispatch context used to resolve a DYNAMIC `systemPrompt` via `.render(ctx)`. Forwarded to `renderChatCompletionsSystemPrompt`, whose own `renderCtx` seam exists for this. Without it a context-reading system prompt renders against `undefined` and silently loses whatever it was reading. |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | - |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderOpenAIResponsesMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | - |\n| `input.renderOpenAIResponsesReasoningItem` | (`input`: { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => | [`OpenAIResponsesReasoningItem`](../../types/interfaces/OpenAIResponsesReasoningItem.md) | `undefined` | - |\n| `input.renderOpenAIResponsesTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md) | `null`> | - |\n| `input.renderOpenAIResponsesToolCallResult` | (`input`: { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.strict?` | `boolean` | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.systemPromptChannel` | [`SystemPromptChannel`](../../types/type-aliases/SystemPromptChannel.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.toolsToOpenAIResponsesTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; }) => [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[] | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`fingerprintableLength`: `number`;\n`input`: [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[];\n`instructions?`: `string`;\n`tools?`: [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[];\n}>\n\n## Remarks\n\nAlgorithm (mirrors the plan's Part 2 spec exactly):\n\n1. Leading `instructions` (or leading `developer`/`system`-role item, per `systemPromptChannel`)\n — ALWAYS ADK-rendered via `renderChatCompletionsSystemPrompt`; there is no consumer-facing\n escape hatch.\n2. Timeline: messages/thoughts/tool-calls merged and sorted by `createdAt`. A tool call renders\n as two SIBLING top-level items (`function_call` then `function_call_output`), with composite\n id splitting. A thought replays as a native `reasoning` item only when `reasoningReplay !==\n 'off'` and a valid, prefix-matched signature exists; otherwise it renders as plain text.\n3. Reasoning-pairing enforcement pass — walks `input` left to right, dropping any `reasoning`\n item not immediately followed by its paired output item, and stripping the `id` from an\n output item whose paired reasoning item was just dropped.\n4. Trailing buckets (`bucketOrder` labels after `'timeline'`) render as a trailing\n `{type:'message', role:'system', ...}` item.\n\n## Load-bearing invariants\n\nThese are consequences of the step ORDER above, not incidental details. Both were unwritten\nonce, and both were violated in ways that silently disabled reasoning replay — so they are\nstated here explicitly and pinned by executable tests (see\n`tests/unit/batteries/llm/openai_responses/reasoning_replay.cross.spec.ts`, \"assembly\ninvariants\").\n\n1. **The step-3 sweep only ever sees a PREFIX of the final `input`.** Step 4 appends the\n trailing bucket AFTER the sweep has run, so any item added there is invisible to every\n fingerprint the sweep computes. A reasoning-replay fingerprint must therefore cover only the\n sweep-visible region — that is what the returned `fingerprintableLength` marks, and why\n `persistThought` passes it as `throughItem`. Hashing the whole `input` instead cannot match\n on the next turn whenever a trailing bucket exists, and drops every replayed item as stale.\n\n2. **A reasoning item must sort STRICTLY BEFORE the output item it is paired with.** The step-2\n timeline pushes messages before thoughts and then applies a STABLE sort by `createdAt`, so on\n an identical timestamp the message wins the tie and lands ahead of its own reasoning item —\n leaving that item unpaired, and the step-3 sweep drops it. Callers persisting a thought and\n its message from one response must therefore assign strictly increasing timestamps rather\n than calling a clock twice (two `DateTime.now()` calls collide ~998 times in 1000).\n\n3. **`tools` is `undefined`, never `[]`, when the registry is empty** (see the return shape).\n Fingerprints on both the persist and validate side must use that same shape:\n `canonicalFingerprint` serialises `undefined` and `[]` to different bytes, so coercing on one\n side only makes every hash mismatch for tool-less agents.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/canonicalFingerprint","title":"Function: canonicalFingerprint()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/canonicalFingerprint.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/canonicalFingerprint","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/canonicalFingerprint.md\n---\n\n# Function: canonicalFingerprint()\n\n```ts\nfunction canonicalFingerprint(value: unknown): Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:968](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L968)\n\nComputes a SHA-256 fingerprint of `value` via canonical canonicalisation, over its UTF-8\nbytes, using `globalThis.crypto.subtle.digest`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`Promise`<`string`>\n\n## Remarks\n\nWire-shape-agnostic replay-prefix fingerprinting primitive shared across the Chat-family LLM\nbatteries' \"reasoning replay\" features (Anthropic's signed `thinking` blocks, and any sibling\nbattery's equivalent). Each battery assembles its own wire-shaped prefix object — e.g. `{ model,\nsystem, tools, messages }` for Anthropic Messages — and passes it here; this primitive carries no\nknowledge of any individual wire shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/createResponsesOutputSlotMachine","title":"Function: createResponsesOutputSlotMachine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/createResponsesOutputSlotMachine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/createResponsesOutputSlotMachine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/createResponsesOutputSlotMachine.md\n---\n\n# Function: createResponsesOutputSlotMachine()\n\n```ts\nfunction createResponsesOutputSlotMachine(): ResponsesOutputSlotMachine;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:1087](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L1087)\n\nImplements [OpenAIResponsesHelpers.createResponsesOutputSlotMachine](../../types/interfaces/OpenAIResponsesHelpers.md#property-createresponsesoutputslotmachine).\n\n## Returns\n\n[`ResponsesOutputSlotMachine`](../../types/interfaces/ResponsesOutputSlotMachine.md)\n\n## Remarks\n\nStreaming state keyed by `output_index` (one slot per output item — NOT a tool-call `index`,\nunlike Chat Completions). `openSlot` deliberately opens NO slot for an unrecognized/hosted\nserver-side tool item type (`web_search_call`, `code_interpreter_call`, `mcp_call`, etc.) — Known\nGotcha #6 — so every subsequent event keyed to that `output_index` is silently ignored rather\nthan crashing on an unexpected slot kind.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/deCollideOpenAIResponsesToolCallIds","title":"Function: deCollideOpenAIResponsesToolCallIds()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/deCollideOpenAIResponsesToolCallIds.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/deCollideOpenAIResponsesToolCallIds","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/deCollideOpenAIResponsesToolCallIds.md\n---\n\n# Function: deCollideOpenAIResponsesToolCallIds()\n\n```ts\nfunction deCollideOpenAIResponsesToolCallIds(\n id: string,\n ctx: DispatchContext,\n): string;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L78)\n\nDe-collides a Responses id while preserving a valid `fc_` item discriminator.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------- |\n| `id` | `string` |\n| `ctx` | [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md) |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/fingerprintOpenAIResponsesPrefix","title":"Function: fingerprintOpenAIResponsesPrefix()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/fingerprintOpenAIResponsesPrefix.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/fingerprintOpenAIResponsesPrefix","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/fingerprintOpenAIResponsesPrefix.md\n---\n\n# Function: fingerprintOpenAIResponsesPrefix()\n\n```ts\nfunction fingerprintOpenAIResponsesPrefix(input: {\n input: OpenAIResponsesInputItem[];\n instructions?: string;\n model: string;\n throughItem?: number;\n tools?: OpenAIResponsesTool[];\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:622](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L622)\n\nImplements [OpenAIResponsesHelpers.fingerprintOpenAIResponsesPrefix](../../types/interfaces/OpenAIResponsesHelpers.md#property-fingerprintopenairesponsesprefix).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `input`: [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `model`: `string`; `throughItem?`: `number`; `tools?`: [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]; } |\n| `input.input` | [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[] |\n| `input.instructions?` | `string` |\n| `input.model` | `string` |\n| `input.throughItem?` | `number` |\n| `input.tools?` | [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[] |\n\n## Returns\n\n`Promise`<`string`>\n\n## Remarks\n\nComputes the fingerprint used for OpenAI Responses reasoning-item replay. The input is the exact\nassembled request prefix: `model`, `instructions`, `tools`, and `input` through (but not\nincluding) the item at `throughItem`. Assembles the Responses-shaped prefix object and delegates\ncanonicalisation + hashing to the shared, wire-agnostic [canonicalFingerprint](canonicalFingerprint.md) primitive —\nmirroring `fingerprintAnthropicMessagesPrefix`'s shape-and-slice pattern exactly: object keys are\nrecursively sorted; array order and item boundaries are preserved.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/normalizeOpenAIResponsesItemId","title":"Function: normalizeOpenAIResponsesItemId()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/normalizeOpenAIResponsesItemId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/normalizeOpenAIResponsesItemId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/normalizeOpenAIResponsesItemId.md\n---\n\n# Function: normalizeOpenAIResponsesItemId()\n\n```ts\nfunction normalizeOpenAIResponsesItemId(id: string, prefix?: string): string;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:1202](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L1202)\n\nNormalises an ADK-authored id to the Responses item-id charset, and hashes+truncates ids over\nthe 64-character limit (Known Gotcha #5) rather than sending an oversized id verbatim.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | -------- | ------------- |\n| `id` | `string` | `undefined` |\n| `prefix` | `string` | `'msg'` |\n\n## Returns\n\n`string`\n\n## Remarks\n\nNot part of the public [OpenAIResponsesHelpers](../../types/interfaces/OpenAIResponsesHelpers.md) contract (no override seam is warranted for\na pure charset/length transform) — exported for the adapter and for direct unit testing.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesMediaBlocks","title":"Function: renderOpenAIResponsesMediaBlocks()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesMediaBlocks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesMediaBlocks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesMediaBlocks.md\n---\n\n# Function: renderOpenAIResponsesMediaBlocks()\n\n```ts\nfunction renderOpenAIResponsesMediaBlocks(input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L221)\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesMediaBlocks](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsesmediablocks).\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.media` | [`Media`](../../../../../common/classes/Media.md) |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>\n\n## Remarks\n\n`image` maps to `input_image` (a data URI). `document` maps to `input_file` using the\nNOW-CONFIRMED `file_data: 'data:;base64,'` shape (a live probe against the real\nResponses API accepted this exact shape with `filename` alongside it — see the battery's design\nnotes). `audio`/`video` — and any other kind/mime this battery cannot natively express — route\nthrough `unsupportedMediaPolicy`, unchanged.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesReasoningItem","title":"Function: renderOpenAIResponsesReasoningItem()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesReasoningItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesReasoningItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesReasoningItem.md\n---\n\n# Function: renderOpenAIResponsesReasoningItem()\n\n```ts\nfunction renderOpenAIResponsesReasoningItem(input: {\n prefixFingerprint: string;\n reasoningReplay: ReasoningReplayMode;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n}): OpenAIResponsesReasoningItem | undefined;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:655](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L655)\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesReasoningItem](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsesreasoningitem).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.prefixFingerprint` | `string` |\n| `input.reasoningReplay` | [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md) |\n| `input.replayCompatibility` | readonly `string`\\[] |\n| `input.thought` | [`Thought`](../../../../../common/classes/Thought.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n| [`OpenAIResponsesReasoningItem`](../../types/interfaces/OpenAIResponsesReasoningItem.md)\n| `undefined`\n\n## Remarks\n\nConverts an eligible stored [OpenAIResponsesReasoningReplayPayload](../../types/interfaces/OpenAIResponsesReasoningReplayPayload.md) into a wire `reasoning`\nitem, or `undefined` if ineligible (no payload, wrong variant, or a stale fingerprint). The\nadjacency-sweep pass in [buildOpenAIResponsesInput](buildOpenAIResponsesInput.md) is what actually enforces the\nreasoning/output-item pairing constraint (Known Gotcha #1) — this function only validates the\nsignature/fingerprint half of eligibility.\n\nUnder `reasoningReplay: 'summary-only'`, the returned item strips `content`\n(full reasoning text) and `encrypted_content` — only `summary` is replayed. `'encrypted'` (or any\nother non-`'off'` mode) returns the stored item verbatim.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesTimelineMessage","title":"Function: renderOpenAIResponsesTimelineMessage()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesTimelineMessage.md\n---\n\n# Function: renderOpenAIResponsesTimelineMessage()\n\n```ts\nfunction renderOpenAIResponsesTimelineMessage(input: {\n message: Message;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:331](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L331)\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesTimelineMessage](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsestimelinemessage).\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.renderOpenAIResponsesMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<\n| [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\n| `null`>\n\n## Remarks\n\nA USER message, or a peer-identity ASSISTANT message (a message from an assistant identity that\nis not this adapter's own `selfIdentity`), renders as a plain `role`-carrying input message item\n— the ADK's own prior assistant turns are NOT routed through this renderer; the caller renders\nthose via renderOpenAIResponsesOwnAssistantMessage instead, into the OUTPUT-message shape\nthe reasoning-pairing validator expects (see the module's Known Gotchas).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesToolCallResult","title":"Function: renderOpenAIResponsesToolCallResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/renderOpenAIResponsesToolCallResult.md\n---\n\n# Function: renderOpenAIResponsesToolCallResult()\n\n```ts\nfunction renderOpenAIResponsesToolCallResult(input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:403](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L403)\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesToolCallResult](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsestoolcallresult).\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderOpenAIResponsesMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<\n| `string`\n| [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>\n\n## Remarks\n\nRenders a tool call's result(s) into the shape a `function_call_output` item's `output` field\naccepts — either a plain string or an array of content blocks when the result carries media —\nmirroring `openai_chat_completions/helpers.ts`'s `renderChatCompletionsToolCallResult` structure.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/toolsToOpenAIResponsesTools","title":"Function: toolsToOpenAIResponsesTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/toolsToOpenAIResponsesTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/toolsToOpenAIResponsesTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/toolsToOpenAIResponsesTools.md\n---\n\n# Function: toolsToOpenAIResponsesTools()\n\n```ts\nfunction toolsToOpenAIResponsesTools(\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: unknown) => JsonSchema;\n strict?: boolean;\n },\n): OpenAIResponsesTool[];\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L588)\n\nImplements [OpenAIResponsesHelpers.toolsToOpenAIResponsesTools](../../types/interfaces/OpenAIResponsesHelpers.md#property-toolstoopenairesponsestools).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n| `deps.strict?` | `boolean` |\n\n## Returns\n\n[`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]\n\n## Remarks\n\n`name` is TOP-LEVEL, unlike Chat Completions' `{type:'function', function:{name, ...}}` nesting.\nReuses the shared, unmodified `descriptionToChatCompletionsJsonSchema` for the JSON Schema body —\nonly the envelope differs.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultBuildOpenAIResponsesInput","title":"Variable: defaultBuildOpenAIResponsesInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultBuildOpenAIResponsesInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultBuildOpenAIResponsesInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultBuildOpenAIResponsesInput.md\ndescription: 'Default history assembler; alias of [`buildOpenAIResponsesInput`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/buildOpenAIResponsesInput).'\n---\n\n# Variable: defaultBuildOpenAIResponsesInput\n\n```ts\nconst defaultBuildOpenAIResponsesInput: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n fingerprintOpenAIResponsesPrefix: (input: {\n input: OpenAIResponsesInputItem[];\n instructions?: string;\n model: string;\n throughItem?: number;\n tools?: OpenAIResponsesTool[];\n }) => Promise;\n memories: Iterable;\n messages: Iterable;\n model: string;\n reasoningReplay: ReasoningReplayMode;\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderCtx?: unknown;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderOpenAIResponsesReasoningItem: (input: {\n prefixFingerprint: string;\n reasoningReplay: ReasoningReplayMode;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n }) =>\n | OpenAIResponsesReasoningItem\n | undefined;\n renderOpenAIResponsesTimelineMessage: (input: {\n message: Message;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise<\n | OpenAIResponsesInputItem\n | null>;\n renderOpenAIResponsesToolCallResult: (input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n results: | Tokenizable\n | SpooledArtifact\n | Media\n | Media[]\n | SpooledArtifact[];\n tool: | Tool\n | ArtifactTool\n | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise<\n | string\n | OpenAIResponsesInputContentBlock[]>;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n strict?: boolean;\n systemPrompt: Tokenizable;\n systemPromptChannel: SystemPromptChannel;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n toolsToOpenAIResponsesTools: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: unknown) => JsonSchema;\n strict?: boolean;\n }) => OpenAIResponsesTool[];\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise<{\n fingerprintableLength: number;\n input: OpenAIResponsesInputItem[];\n instructions?: string;\n tools?: OpenAIResponsesTool[];\n}> = buildOpenAIResponsesInput;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:1073](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L1073)\n\nDefault history assembler; alias of [buildOpenAIResponsesInput](../functions/buildOpenAIResponsesInput.md).\n\nImplements [OpenAIResponsesHelpers.buildOpenAIResponsesInput](../../types/interfaces/OpenAIResponsesHelpers.md#property-buildopenairesponsesinput).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `fingerprintOpenAIResponsesPrefix`: (`input`: { `input`: [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `model`: `string`; `throughItem?`: `number`; `tools?`: [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]; }) => `Promise`<`string`>; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `model`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderOpenAIResponsesReasoningItem`: (`input`: { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => | [`OpenAIResponsesReasoningItem`](../../types/interfaces/OpenAIResponsesReasoningItem.md) | `undefined`; `renderOpenAIResponsesTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md) | `null`>; `renderOpenAIResponsesToolCallResult`: (`input`: { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `strict?`: `boolean`; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `systemPromptChannel`: [`SystemPromptChannel`](../../types/type-aliases/SystemPromptChannel.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `toolsToOpenAIResponsesTools`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; }) => [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | - |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.fingerprintOpenAIResponsesPrefix` | (`input`: { `input`: [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `model`: `string`; `throughItem?`: `number`; `tools?`: [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]; }) => `Promise`<`string`> | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.model` | `string` | - |\n| `input.reasoningReplay` | [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md) | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderCtx?` | `unknown` | Live dispatch context used to resolve a DYNAMIC `systemPrompt` via `.render(ctx)`. Forwarded to `renderChatCompletionsSystemPrompt`, whose own `renderCtx` seam exists for this. Without it a context-reading system prompt renders against `undefined` and silently loses whatever it was reading. |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | - |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderOpenAIResponsesMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | - |\n| `input.renderOpenAIResponsesReasoningItem` | (`input`: { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => | [`OpenAIResponsesReasoningItem`](../../types/interfaces/OpenAIResponsesReasoningItem.md) | `undefined` | - |\n| `input.renderOpenAIResponsesTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md) | `null`> | - |\n| `input.renderOpenAIResponsesToolCallResult` | (`input`: { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.strict?` | `boolean` | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.systemPromptChannel` | [`SystemPromptChannel`](../../types/type-aliases/SystemPromptChannel.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.toolsToOpenAIResponsesTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; }) => [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[] | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`fingerprintableLength`: `number`;\n`input`: [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\\[];\n`instructions?`: `string`;\n`tools?`: [`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[];\n}>\n\n## Remarks\n\nAlgorithm (mirrors the plan's Part 2 spec exactly):\n\n1. Leading `instructions` (or leading `developer`/`system`-role item, per `systemPromptChannel`)\n — ALWAYS ADK-rendered via `renderChatCompletionsSystemPrompt`; there is no consumer-facing\n escape hatch.\n2. Timeline: messages/thoughts/tool-calls merged and sorted by `createdAt`. A tool call renders\n as two SIBLING top-level items (`function_call` then `function_call_output`), with composite\n id splitting. A thought replays as a native `reasoning` item only when `reasoningReplay !==\n 'off'` and a valid, prefix-matched signature exists; otherwise it renders as plain text.\n3. Reasoning-pairing enforcement pass — walks `input` left to right, dropping any `reasoning`\n item not immediately followed by its paired output item, and stripping the `id` from an\n output item whose paired reasoning item was just dropped.\n4. Trailing buckets (`bucketOrder` labels after `'timeline'`) render as a trailing\n `{type:'message', role:'system', ...}` item.\n\n## Load-bearing invariants\n\nThese are consequences of the step ORDER above, not incidental details. Both were unwritten\nonce, and both were violated in ways that silently disabled reasoning replay — so they are\nstated here explicitly and pinned by executable tests (see\n`tests/unit/batteries/llm/openai_responses/reasoning_replay.cross.spec.ts`, \"assembly\ninvariants\").\n\n1. **The step-3 sweep only ever sees a PREFIX of the final `input`.** Step 4 appends the\n trailing bucket AFTER the sweep has run, so any item added there is invisible to every\n fingerprint the sweep computes. A reasoning-replay fingerprint must therefore cover only the\n sweep-visible region — that is what the returned `fingerprintableLength` marks, and why\n `persistThought` passes it as `throughItem`. Hashing the whole `input` instead cannot match\n on the next turn whenever a trailing bucket exists, and drops every replayed item as stale.\n\n2. **A reasoning item must sort STRICTLY BEFORE the output item it is paired with.** The step-2\n timeline pushes messages before thoughts and then applies a STABLE sort by `createdAt`, so on\n an identical timestamp the message wins the tie and lands ahead of its own reasoning item —\n leaving that item unpaired, and the step-3 sweep drops it. Callers persisting a thought and\n its message from one response must therefore assign strictly increasing timestamps rather\n than calling a clock twice (two `DateTime.now()` calls collide ~998 times in 1000).\n\n3. **`tools` is `undefined`, never `[]`, when the registry is empty** (see the return shape).\n Fingerprints on both the persist and validate side must use that same shape:\n `canonicalFingerprint` serialises `undefined` and `[]` to different bytes, so coercing on one\n side only makes every hash mismatch for tool-less agents.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCanonicalFingerprint","title":"Variable: defaultCanonicalFingerprint","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCanonicalFingerprint.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCanonicalFingerprint","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCanonicalFingerprint.md\ndescription: >-\n Default canonical-fingerprint primitive; alias of {@link\n canonicalFingerprint}.\n---\n\n# Variable: defaultCanonicalFingerprint\n\n```ts\nconst defaultCanonicalFingerprint: (value: unknown) => Promise =\n canonicalFingerprint;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:974](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L974)\n\nDefault canonical-fingerprint primitive; alias of [canonicalFingerprint](../functions/canonicalFingerprint.md).\n\nComputes a SHA-256 fingerprint of `value` via canonical canonicalisation, over its UTF-8\nbytes, using `globalThis.crypto.subtle.digest`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`Promise`<`string`>\n\n## Remarks\n\nWire-shape-agnostic replay-prefix fingerprinting primitive shared across the Chat-family LLM\nbatteries' \"reasoning replay\" features (Anthropic's signed `thinking` blocks, and any sibling\nbattery's equivalent). Each battery assembles its own wire-shaped prefix object — e.g. `{ model,\nsystem, tools, messages }` for Anthropic Messages — and passes it here; this primitive carries no\nknowledge of any individual wire shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCreateResponsesOutputSlotMachine","title":"Variable: defaultCreateResponsesOutputSlotMachine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCreateResponsesOutputSlotMachine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCreateResponsesOutputSlotMachine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultCreateResponsesOutputSlotMachine.md\ndescription: >-\n Default output-slot state machine factory; alias of {@link\n createResponsesOutputSlotMachine}.\n---\n\n# Variable: defaultCreateResponsesOutputSlotMachine\n\n```ts\nconst defaultCreateResponsesOutputSlotMachine: () => ResponsesOutputSlotMachine =\n createResponsesOutputSlotMachine;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:1190](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L1190)\n\nDefault output-slot state machine factory; alias of [createResponsesOutputSlotMachine](../functions/createResponsesOutputSlotMachine.md).\n\nImplements [OpenAIResponsesHelpers.createResponsesOutputSlotMachine](../../types/interfaces/OpenAIResponsesHelpers.md#property-createresponsesoutputslotmachine).\n\n## Returns\n\n[`ResponsesOutputSlotMachine`](../../types/interfaces/ResponsesOutputSlotMachine.md)\n\n## Remarks\n\nStreaming state keyed by `output_index` (one slot per output item — NOT a tool-call `index`,\nunlike Chat Completions). `openSlot` deliberately opens NO slot for an unrecognized/hosted\nserver-side tool item type (`web_search_call`, `code_interpreter_call`, `mcp_call`, etc.) — Known\nGotcha #6 — so every subsequent event keyed to that `output_index` is silently ignored rather\nthan crashing on an unexpected slot kind.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesMediaBlocks","title":"Variable: defaultRenderOpenAIResponsesMediaBlocks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesMediaBlocks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesMediaBlocks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesMediaBlocks.md\ndescription: >-\n Default OpenAI Responses media renderer; alias of {@link\n renderOpenAIResponsesMediaBlocks}.\n---\n\n# Variable: defaultRenderOpenAIResponsesMediaBlocks\n\n```ts\nconst defaultRenderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise =\n renderOpenAIResponsesMediaBlocks;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L317)\n\nDefault OpenAI Responses media renderer; alias of [renderOpenAIResponsesMediaBlocks](../functions/renderOpenAIResponsesMediaBlocks.md).\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesMediaBlocks](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsesmediablocks).\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.media` | [`Media`](../../../../../common/classes/Media.md) |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>\n\n## Remarks\n\n`image` maps to `input_image` (a data URI). `document` maps to `input_file` using the\nNOW-CONFIRMED `file_data: 'data:;base64,'` shape (a live probe against the real\nResponses API accepted this exact shape with `filename` alongside it — see the battery's design\nnotes). `audio`/`video` — and any other kind/mime this battery cannot natively express — route\nthrough `unsupportedMediaPolicy`, unchanged.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesReasoningItem","title":"Variable: defaultRenderOpenAIResponsesReasoningItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesReasoningItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesReasoningItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesReasoningItem.md\ndescription: >-\n Default reasoning-item renderer; alias of {@link\n renderOpenAIResponsesReasoningItem}.\n---\n\n# Variable: defaultRenderOpenAIResponsesReasoningItem\n\n```ts\nconst defaultRenderOpenAIResponsesReasoningItem: (input: {\n prefixFingerprint: string;\n reasoningReplay: ReasoningReplayMode;\n replayCompatibility: readonly string[];\n thought: Thought;\n warn?: (msg: string) => void;\n}) => OpenAIResponsesReasoningItem | undefined =\n renderOpenAIResponsesReasoningItem;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:682](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L682)\n\nDefault reasoning-item renderer; alias of [renderOpenAIResponsesReasoningItem](../functions/renderOpenAIResponsesReasoningItem.md).\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesReasoningItem](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsesreasoningitem).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.prefixFingerprint` | `string` |\n| `input.reasoningReplay` | [`ReasoningReplayMode`](../../types/type-aliases/ReasoningReplayMode.md) |\n| `input.replayCompatibility` | readonly `string`\\[] |\n| `input.thought` | [`Thought`](../../../../../common/classes/Thought.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n| [`OpenAIResponsesReasoningItem`](../../types/interfaces/OpenAIResponsesReasoningItem.md)\n| `undefined`\n\n## Remarks\n\nConverts an eligible stored [OpenAIResponsesReasoningReplayPayload](../../types/interfaces/OpenAIResponsesReasoningReplayPayload.md) into a wire `reasoning`\nitem, or `undefined` if ineligible (no payload, wrong variant, or a stale fingerprint). The\nadjacency-sweep pass in [buildOpenAIResponsesInput](../functions/buildOpenAIResponsesInput.md) is what actually enforces the\nreasoning/output-item pairing constraint (Known Gotcha #1) — this function only validates the\nsignature/fingerprint half of eligibility.\n\nUnder `reasoningReplay: 'summary-only'`, the returned item strips `content`\n(full reasoning text) and `encrypted_content` — only `summary` is replayed. `'encrypted'` (or any\nother non-`'off'` mode) returns the stored item verbatim.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesTimelineMessage","title":"Variable: defaultRenderOpenAIResponsesTimelineMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesTimelineMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesTimelineMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesTimelineMessage.md\ndescription: >-\n Default timeline-message renderer; alias of {@link\n renderOpenAIResponsesTimelineMessage}.\n---\n\n# Variable: defaultRenderOpenAIResponsesTimelineMessage\n\n```ts\nconst defaultRenderOpenAIResponsesTimelineMessage: (input: {\n message: Message;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n selfIdentity: string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise =\n renderOpenAIResponsesTimelineMessage;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:391](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L391)\n\nDefault timeline-message renderer; alias of [renderOpenAIResponsesTimelineMessage](../functions/renderOpenAIResponsesTimelineMessage.md).\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesTimelineMessage](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsestimelinemessage).\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.message` | [`Message`](../../../../../common/classes/Message.md) |\n| `input.renderOpenAIResponsesMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.selfIdentity` | `string` |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<\n| [`OpenAIResponsesInputItem`](../../types/type-aliases/OpenAIResponsesInputItem.md)\n| `null`>\n\n## Remarks\n\nA USER message, or a peer-identity ASSISTANT message (a message from an assistant identity that\nis not this adapter's own `selfIdentity`), renders as a plain `role`-carrying input message item\n— the ADK's own prior assistant turns are NOT routed through this renderer; the caller renders\nthose via renderOpenAIResponsesOwnAssistantMessage instead, into the OUTPUT-message shape\nthe reasoning-pairing validator expects (see the module's Known Gotchas).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesToolCallResult","title":"Variable: defaultRenderOpenAIResponsesToolCallResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesToolCallResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesToolCallResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultRenderOpenAIResponsesToolCallResult.md\ndescription: >-\n Default tool-call-result renderer; alias of {@link\n renderOpenAIResponsesToolCallResult}.\n---\n\n# Variable: defaultRenderOpenAIResponsesToolCallResult\n\n```ts\nconst defaultRenderOpenAIResponsesToolCallResult: (input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderOpenAIResponsesMediaBlocks: (input: {\n media: Media;\n renderTrustedContent: (\n content: string,\n attrs: TrustedContentAttrs,\n ) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n }) => Promise;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise =\n renderOpenAIResponsesToolCallResult;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:576](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L576)\n\nDefault tool-call-result renderer; alias of [renderOpenAIResponsesToolCallResult](../functions/renderOpenAIResponsesToolCallResult.md).\n\nImplements [OpenAIResponsesHelpers.renderOpenAIResponsesToolCallResult](../../types/interfaces/OpenAIResponsesHelpers.md#property-renderopenairesponsestoolcallresult).\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input` | { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` |\n| `input.renderOpenAIResponsesMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) |\n| `input.warn?` | (`msg`: `string`) => `void` |\n\n## Returns\n\n`Promise`<\n| `string`\n| [`OpenAIResponsesInputContentBlock`](../../types/type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>\n\n## Remarks\n\nRenders a tool call's result(s) into the shape a `function_call_output` item's `output` field\naccepts — either a plain string or an array of content blocks when the result carries media —\nmirroring `openai_chat_completions/helpers.ts`'s `renderChatCompletionsToolCallResult` structure.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultToolsToOpenAIResponsesTools","title":"Variable: defaultToolsToOpenAIResponsesTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultToolsToOpenAIResponsesTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultToolsToOpenAIResponsesTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/variables/defaultToolsToOpenAIResponsesTools.md\ndescription: 'Default tool-translation helper; alias of [`toolsToOpenAIResponsesTools`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/helpers/functions/toolsToOpenAIResponsesTools).'\n---\n\n# Variable: defaultToolsToOpenAIResponsesTools\n\n```ts\nconst defaultToolsToOpenAIResponsesTools: (\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: unknown) => JsonSchema;\n strict?: boolean;\n },\n) => OpenAIResponsesTool[] = toolsToOpenAIResponsesTools;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/helpers.ts:607](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/helpers.ts#L607)\n\nDefault tool-translation helper; alias of [toolsToOpenAIResponsesTools](../functions/toolsToOpenAIResponsesTools.md).\n\nImplements [OpenAIResponsesHelpers.toolsToOpenAIResponsesTools](../../types/interfaces/OpenAIResponsesHelpers.md#property-toolstoopenairesponsestools).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n| `deps.strict?` | `boolean` |\n\n## Returns\n\n[`OpenAIResponsesTool`](../../types/type-aliases/OpenAIResponsesTool.md)\\[]\n\n## Remarks\n\n`name` is TOP-LEVEL, unlike Chat Completions' `{type:'function', function:{name, ...}}` nesting.\nReuses the shared, unmodified `descriptionToChatCompletionsJsonSchema` for the JSON Schema body —\nonly the envelope differs.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types","title":"@nhtio/adk/batteries/llm/openai\\_responses/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types.md'\ndescription: >-\n TypeScript wire shapes, helper contracts, and option types for the OpenAI\n Responses battery.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_responses/types\n\nTypeScript wire shapes, helper contracts, and option types for the OpenAI Responses battery.\n\n## Remarks\n\nType aliases for the OpenAI Responses adapter — wire shapes, helper input/output shapes, and the\nadapter's options shape. These are documentation-level types only; runtime validation lives in\n`validation.ts` (`openAIResponsesOptionsSchema`).\n\nThe Responses API replaces the flat `messages[]` array with a flat `input: Item[]` array — a tool\ncall and its result are two SIBLING top-level items, not one message containing both. The system\nprompt lives in a top-level `instructions` string field by default (or, via `systemPromptChannel`,\na leading `developer`/`system`-role item instead).\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ChatHelpersCommon](interfaces/ChatHelpersCommon.md) | The wire-shape-agnostic subset of a Chat-family battery's translation helpers — every helper that produces a plain `string` (or JSON Schema / tool-definition wire, which is identical across the family) rather than a battery-specific message object. |\n| [OpenAIResponsesAdapterOptions](interfaces/OpenAIResponsesAdapterOptions.md) | Configuration options for the OpenAI Responses adapter. |\n| [OpenAIResponsesCompletedEvent](interfaces/OpenAIResponsesCompletedEvent.md) | Terminal SSE event emitted when the response completes successfully. |\n| [OpenAIResponsesErrorEvent](interfaces/OpenAIResponsesErrorEvent.md) | Terminal SSE event emitted when the stream itself errors, outside of any particular response object. |\n| [OpenAIResponsesFailedEvent](interfaces/OpenAIResponsesFailedEvent.md) | Terminal SSE event emitted when the response fails outright. |\n| [OpenAIResponsesFunctionCallArgumentsDeltaEvent](interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent.md) | SSE event emitted when a fragment of a tool call's JSON arguments streams in. |\n| [OpenAIResponsesFunctionCallArgumentsDoneEvent](interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent.md) | SSE event emitted when a tool call's JSON arguments string is finalized. |\n| [OpenAIResponsesFunctionCallItem](interfaces/OpenAIResponsesFunctionCallItem.md) | A model-emitted function (tool) call item. |\n| [OpenAIResponsesFunctionCallOutputItem](interfaces/OpenAIResponsesFunctionCallOutputItem.md) | The result of executing a `function_call_output`'s paired `function_call`. |\n| [OpenAIResponsesHelpers](interfaces/OpenAIResponsesHelpers.md) | Full translation-helper contract for the OpenAI Responses battery. |\n| [OpenAIResponsesIncompleteEvent](interfaces/OpenAIResponsesIncompleteEvent.md) | Terminal SSE event emitted when the response stops before completing (e.g. hit `max_output_tokens`). |\n| [OpenAIResponsesMessageItem](interfaces/OpenAIResponsesMessageItem.md) | An input message item — the leading-content-channel item shape (`role: 'user'`, or the leading `developer`/`system`-role item rendered when `systemPromptChannel` is not `'instructions'`, or a trailing after-timeline bucket message), plus a peer-identity assistant timeline turn rendered as a plain input message rather than the full output-item shape. |\n| [OpenAIResponsesOpaqueOutputItem](interfaces/OpenAIResponsesOpaqueOutputItem.md) | Any other output item type the Responses API can emit that this battery does not natively model (hosted server-side tools: `web_search_call`, `code_interpreter_call`, `mcp_call`, etc.). Carried through structurally so the streaming state machine can recognize — and deliberately decline to open a slot for — an item type it does not know, per Known Gotcha #6. |\n| [OpenAIResponsesOutputItemAddedEvent](interfaces/OpenAIResponsesOutputItemAddedEvent.md) | SSE event emitted when a new output item is opened (streaming begins for that item). |\n| [OpenAIResponsesOutputItemDoneEvent](interfaces/OpenAIResponsesOutputItemDoneEvent.md) | SSE event emitted when an output item is finalized — its terminal, fully-populated shape. |\n| [OpenAIResponsesOutputMessageItem](interfaces/OpenAIResponsesOutputMessageItem.md) | An assistant output-message item, in the OUTPUT shape (not the input shape) — used when replaying the ADK's OWN prior assistant text back into `input`, so the reasoning-pairing validator (see the Known Gotchas) recognizes it correctly as a genuine prior output item. |\n| [OpenAIResponsesOutputTextDeltaEvent](interfaces/OpenAIResponsesOutputTextDeltaEvent.md) | SSE event emitted when a text fragment streams in for an output message's content. |\n| [OpenAIResponsesOutputTextDoneEvent](interfaces/OpenAIResponsesOutputTextDoneEvent.md) | SSE event emitted when an output message's text content part is finalized. |\n| [OpenAIResponsesReasoningContentPart](interfaces/OpenAIResponsesReasoningContentPart.md) | One full-reasoning-text part of a `reasoning` item (present only under some `include` values). |\n| [OpenAIResponsesReasoningItem](interfaces/OpenAIResponsesReasoningItem.md) | A model-emitted `reasoning` item — the native wire representation of a \"thought.\" Only ever sent back on `input` when `reasoningReplay !== 'off'` and its stored signature/prefix-fingerprint is still valid; see the reasoning-pairing adjacency-sweep pass and Known Gotcha #1. |\n| [OpenAIResponsesReasoningReplayPayload](interfaces/OpenAIResponsesReasoningReplayPayload.md) | Opaque payload stored on a replayable OpenAI Responses reasoning `Thought`. Sibling to the Anthropic battery's `AnthropicThinkingReplayPayload`. |\n| [OpenAIResponsesReasoningSummaryPart](interfaces/OpenAIResponsesReasoningSummaryPart.md) | One summary-text part of a `reasoning` item. |\n| [OpenAIResponsesReasoningSummaryTextDeltaEvent](interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent.md) | SSE event emitted when a reasoning-summary text fragment streams in for a `reasoning` item. |\n| [OpenAIResponsesReasoningSummaryTextDoneEvent](interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent.md) | SSE event emitted when a `reasoning` item's summary-text part is finalized. |\n| [OpenAIResponsesReasoningTextDeltaEvent](interfaces/OpenAIResponsesReasoningTextDeltaEvent.md) | SSE event emitted when a full-reasoning text fragment streams in for a `reasoning` item. |\n| [OpenAIResponsesReasoningTextDoneEvent](interfaces/OpenAIResponsesReasoningTextDoneEvent.md) | SSE event emitted when a `reasoning` item's full-reasoning-text part is finalized. |\n| [OpenAIResponsesRefusalDeltaEvent](interfaces/OpenAIResponsesRefusalDeltaEvent.md) | SSE event emitted when a refusal fragment streams in for an output message's content. |\n| [OpenAIResponsesRefusalDoneEvent](interfaces/OpenAIResponsesRefusalDoneEvent.md) | SSE event emitted when an output message's refusal content part is finalized. |\n| [OpenAIResponsesRequestBody](interfaces/OpenAIResponsesRequestBody.md) | The WIRE body shape this battery constructs and sends — not a 1:1 mirror of consumer-settable options. `instructions` and `store` are ALWAYS adapter-computed; neither is a key on [OpenAIResponsesAdapterOptions](interfaces/OpenAIResponsesAdapterOptions.md). |\n| [OpenAIResponsesResponseObject](interfaces/OpenAIResponsesResponseObject.md) | The full `response` object — returned directly (non-streaming), or nested under a terminal streaming event. |\n| [OpenAIResponsesUsage](interfaces/OpenAIResponsesUsage.md) | Token-usage accounting on a Responses `response` object. |\n| [ResponsesOutputSlotMachine](interfaces/ResponsesOutputSlotMachine.md) | Per-dispatch streaming-state accumulator, keyed by `output_index` (one slot per output item — NOT a tool-call `index`, unlike Chat Completions). Constructed fresh per generation via [OpenAIResponsesHelpers.createResponsesOutputSlotMachine](interfaces/OpenAIResponsesHelpers.md#property-createresponsesoutputslotmachine). |\n| [ResponsesTextSlot](interfaces/ResponsesTextSlot.md) | A streaming text (assistant output-message) slot. |\n| [ResponsesThinkingSlot](interfaces/ResponsesThinkingSlot.md) | A streaming reasoning (\"thinking\") slot. |\n| [ResponsesToolCallSlot](interfaces/ResponsesToolCallSlot.md) | A streaming tool-call slot. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OpenAIResponsesIncludable](type-aliases/OpenAIResponsesIncludable.md) | Value(s) requestable via the wire `include` array. |\n| [OpenAIResponsesInputContentBlock](type-aliases/OpenAIResponsesInputContentBlock.md) | Discriminated union of content block shapes accepted by the OpenAI Responses `input` item content array (and, per the API reference, also the shape a `function_call_output.output` array entry may take). |\n| [OpenAIResponsesInputItem](type-aliases/OpenAIResponsesInputItem.md) | Discriminated union of every item shape this battery sends on the `input` array. |\n| [OpenAIResponsesOutputItem](type-aliases/OpenAIResponsesOutputItem.md) | Discriminated union of every item shape the Responses API can emit in `response.output`. |\n| [OpenAIResponsesOutputMessageContentPart](type-aliases/OpenAIResponsesOutputMessageContentPart.md) | One output-message content part. |\n| [OpenAIResponsesStreamEvent](type-aliases/OpenAIResponsesStreamEvent.md) | Discriminated union of every streaming event this battery handles explicitly, plus a structural fallback (`{type: string, ...}`) for the many other event types the Responses API emits (`response.created`, `response.in_progress`, `response.content_part.added/.done`, hosted-tool progress events, etc.) that this battery does not act on. |\n| [OpenAIResponsesTool](type-aliases/OpenAIResponsesTool.md) | Wire shape of a single function tool advertised to the model. `name` is TOP-LEVEL, unlike Chat Completions' `{type:'function', function:{name, ...}}` nesting. |\n| [OpenAIResponsesToolChoice](type-aliases/OpenAIResponsesToolChoice.md) | Tool-choice directive accepted by this battery's v1 (a subset of the full wire union). |\n| [ReasoningReplayMode](type-aliases/ReasoningReplayMode.md) | Reasoning-replay mode. See [OpenAIResponsesAdapterOptions.reasoningReplay](interfaces/OpenAIResponsesAdapterOptions.md#property-reasoningreplay). |\n| [ResponsesOutputSlot](type-aliases/ResponsesOutputSlot.md) | Union of every tracked per-`output_index` slot kind. |\n| [SystemPromptChannel](type-aliases/SystemPromptChannel.md) | Channel the ADK-rendered system prompt is placed on. See [OpenAIResponsesAdapterOptions.systemPromptChannel](interfaces/OpenAIResponsesAdapterOptions.md#property-systempromptchannel). |\n\n## References\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsRetryConfig\n\nRe-exports [ChatCompletionsRetryConfig](../../../interfaces/ChatCompletionsRetryConfig.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../../interfaces/MemoryAttrs.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](../../transformers_js/helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](../../transformers_js/helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../../interfaces/UntrustedContentAttrs.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ChatHelpersCommon","title":"Interface: ChatHelpersCommon","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ChatHelpersCommon.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ChatHelpersCommon","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ChatHelpersCommon.md\ndescription: >-\n The wire-shape-agnostic subset of a Chat-family battery's translation helpers\n — every helper that produces a plain `string` (or JSON Schema /\n tool-definition wire, which is identical across the family) rather than a\n battery-specific message object.\n---\n\n# Interface: ChatHelpersCommon\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:509](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L509)\n\nThe wire-shape-agnostic subset of a Chat-family battery's translation helpers — every helper\nthat produces a plain `string` (or JSON Schema / tool-definition wire, which is identical across\nthe family) rather than a battery-specific message object.\n\n## Remarks\n\nBoth `ChatCompletionsHelpers` (OpenAI battery) and `OllamaHelpers` (Ollama battery) extend this\ncontract and add their own wire-specific members (timeline-message rendering, tool-call-result\nrendering, history assembly, and — for OpenAI — streaming tool-call delta accumulation). Helpers\nthat compose other helpers receive their dependents via explicit `deps` arguments typed against\nTHIS contract (never against a battery-specific bag), so the shared implementations carry no\nimport edge back to any individual battery.\n\n## Extended by\n\n* [`OpenAIResponsesHelpers`](OpenAIResponsesHelpers.md)\n* [`ChatCompletionsHelpers`](../../../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n* [`OllamaHelpers`](../../../ollama/types/interfaces/OllamaHelpers.md)\n* [`GeminiGenerateContentHelpers`](../../../gemini_generate_content/types/interfaces/GeminiGenerateContentHelpers.md)\n* [`ClaudeCodeCliHelpers`](../../../claude_code_cli/types/interfaces/ClaudeCodeCliHelpers.md)\n* [`BedrockConverseHelpers`](../../../bedrock_converse/types/interfaces/BedrockConverseHelpers.md)\n* [`AnthropicMessagesHelpers`](../../../anthropic_messages/types/interfaces/AnthropicMessagesHelpers.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) tool result: metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam. When omitted the battery uses the shared defaultRenderArtifactHandleBody. A consumer overrides it to change WHICH reader the model is steered toward first — e.g. promoting the JSON content-readers (`artifact_json_get` / `artifact_json_keys`) ahead of the metadata-only `artifact_json_type` for a small model that grabs the first listed tool. The tool list itself comes from the artifact's `constructor.toolMethods`; an override typically reorders or re-annotates that list before delegating to the default renderer. | [src/batteries/llm/chat\\_common/types.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L571) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md) whose content is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam, the retrievable-side counterpart to [renderArtifactHandleBody](#property-renderartifacthandlebody). When omitted the battery uses the shared defaultRenderRetrievableHandleBody. | [src/batteries/llm/chat\\_common/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L588) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesAdapterOptions","title":"Interface: OpenAIResponsesAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesAdapterOptions.md\ndescription: Configuration options for the OpenAI Responses adapter.\n---\n\n# Interface: OpenAIResponsesAdapterOptions\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:825](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L825)\n\nConfiguration options for the OpenAI Responses adapter.\n\n## Properties\n\n| Property | Type | Default value | Description | Defined in |\n| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apiKey?` | `string` | `undefined` | API key for authenticating requests. | [src/batteries/llm/openai\\_responses/types.ts:828](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L828) |\n| `autoAck?` | `boolean` | `undefined` | Whether the executor should call `ctx.ack()` itself when a generation completes with no tool calls. | [src/batteries/llm/openai\\_responses/types.ts:866](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L866) |\n| `background?` | `boolean` | `undefined` | Request the generation run in the background (async). NOT SUPPORTED — this adapter has no polling/resumption logic for a `queued`/`in_progress` background response, so `true` is rejected at validation time (`E_INVALID_OPENAI_RESPONSES_OPTIONS`) rather than silently treated as a completed, empty answer. `false`/`undefined` (the default, synchronous request/response) are unaffected. | [src/batteries/llm/openai\\_responses/types.ts:973](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L973) |\n| `baseURL?` | `string` | `undefined` | Base URL for the OpenAI-compatible Responses endpoint. | [src/batteries/llm/openai\\_responses/types.ts:830](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L830) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | `undefined` | Determines order of memory and retrievable buckets in history assembly. | [src/batteries/llm/openai\\_responses/types.ts:848](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L848) |\n| `contextWindow?` | `number` | `undefined` | Size of the model's token context window. | [src/batteries/llm/openai\\_responses/types.ts:850](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L850) |\n| `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | `undefined` | Custom fetch implementation to use for HTTP requests. | [src/batteries/llm/openai\\_responses/types.ts:846](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L846) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | `undefined` | Optional hook to shape forged artifact-query tools before they merge into the visible tool set. | [src/batteries/llm/openai\\_responses/types.ts:878](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L878) |\n| `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | `undefined` | Extra HTTP headers to include with each request. | [src/batteries/llm/openai\\_responses/types.ts:836](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L836) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`OpenAIResponsesHelpers`](OpenAIResponsesHelpers.md)> | `undefined` | Optional overrides for OpenAI Responses helpers. | [src/batteries/llm/openai\\_responses/types.ts:860](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L860) |\n| `include?` | [`OpenAIResponsesIncludable`](../type-aliases/OpenAIResponsesIncludable.md)\\[] | `undefined` | Additional output data requested from the model. **Remarks** `'reasoning.encrypted_content'` is auto-added when `reasoningReplay === 'encrypted'`; a caller value does not need to repeat it (de-duplicated). | [src/batteries/llm/openai\\_responses/types.ts:927](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L927) |\n| `localToolCallParser?` | | [`ToolCallParserName`](../../../transformers_js/helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../../transformers_js/helpers/type-aliases/ToolCallParserFn.md) | `undefined` | Optional fallback parser for tool calls the provider did not return structurally. | [src/batteries/llm/openai\\_responses/types.ts:876](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L876) |\n| `max_output_tokens?` | `number` | `undefined` | Hard limit on generated output tokens. **Remarks** The API enforces an UNDOCUMENTED minimum of 16 (`400 Invalid 'max_output_tokens'... Expected a value >= 16`) — enforced in this battery's validation schema so a too-small value fails at config time, not dispatch time. | [src/batteries/llm/openai\\_responses/types.ts:941](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L941) |\n| `metadata?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | `undefined` | Metadata key-value pairs forwarded to the provider. | [src/batteries/llm/openai\\_responses/types.ts:961](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L961) |\n| `model` | `string` | `undefined` | Name of the model to use for generation. REQUIRED. | [src/batteries/llm/openai\\_responses/types.ts:919](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L919) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | `undefined` | Observe the fully-assembled request before dispatch. | [src/batteries/llm/openai\\_responses/types.ts:872](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L872) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | `undefined` | Observe the model's raw response for each completed generation. | [src/batteries/llm/openai\\_responses/types.ts:870](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L870) |\n| `organization?` | `string` | `undefined` | Optional OpenAI organization id, sent as `OpenAI-Organization`. | [src/batteries/llm/openai\\_responses/types.ts:832](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L832) |\n| `parallel_tool_calls?` | `boolean` | `undefined` | Allow the model to emit multiple tool calls in one turn. | [src/batteries/llm/openai\\_responses/types.ts:943](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L943) |\n| `project?` | `string` | `undefined` | Optional OpenAI project id, sent as `OpenAI-Project`. | [src/batteries/llm/openai\\_responses/types.ts:834](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L834) |\n| `prompt_cache_key?` | `string` | `undefined` | Vendor cache key for caching system/prefix content. | [src/batteries/llm/openai\\_responses/types.ts:955](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L955) |\n| `prompt_cache_retention?` | `\"in_memory\"` | `\"24h\"` | `undefined` | Cache retention strategy for cached prefix content. | [src/batteries/llm/openai\\_responses/types.ts:957](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L957) |\n| `reasoning?` | { `effort?`: `\"none\"` | `\"minimal\"` | `\"low\"` | `\"medium\"` | `\"high\"` | `\"xhigh\"`; `summary?`: `\"auto\"` | `\"concise\"` | `\"detailed\"`; } | `undefined` | Reasoning-effort / summary configuration for reasoning-capable models. | [src/batteries/llm/openai\\_responses/types.ts:929](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L929) |\n| `reasoning.effort?` | `\"none\"` | `\"minimal\"` | `\"low\"` | `\"medium\"` | `\"high\"` | `\"xhigh\"` | `undefined` | - | [src/batteries/llm/openai\\_responses/types.ts:930](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L930) |\n| `reasoning.summary?` | `\"auto\"` | `\"concise\"` | `\"detailed\"` | `undefined` | - | [src/batteries/llm/openai\\_responses/types.ts:931](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L931) |\n| `reasoningReplay?` | [`ReasoningReplayMode`](../type-aliases/ReasoningReplayMode.md) | `'off'` | Reasoning-replay mode. **Remarks** `'off'` (default) — thoughts never replay as native `reasoning` items; they render as plain text instead. `'encrypted'` — replay signed reasoning items, auto-adding `'reasoning.encrypted_content'` to `include`. `'summary-only'` — replay reasoning items without requesting the encrypted payload. This is real, scoped, stateful machinery (persisted opaque payloads, prefix-fence fingerprinting, adjacency enforcement, item-id manipulation) — see the battery's design notes for the reasoning/output-item pairing hazard this default guards against. | [src/batteries/llm/openai\\_responses/types.ts:908](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L908) |\n| `replayCompatibility?` | readonly `string`\\[] | `undefined` | List of replay labels supported by the assistant. | [src/batteries/llm/openai\\_responses/types.ts:858](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L858) |\n| `requestTimeoutMs?` | `number` | `undefined` | Request timeout in milliseconds for API calls. | [src/batteries/llm/openai\\_responses/types.ts:842](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L842) |\n| `retry?` | [`ChatCompletionsRetryConfig`](../../../../interfaces/ChatCompletionsRetryConfig.md) | `undefined` | Configures request retry behavior. | [src/batteries/llm/openai\\_responses/types.ts:844](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L844) |\n| `safety_identifier?` | `string` | `undefined` | Unique safety system identifier or configuration id. | [src/batteries/llm/openai\\_responses/types.ts:959](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L959) |\n| `selfIdentity?` | `string` | `undefined` | Unique identity label for the assistant instance. | [src/batteries/llm/openai\\_responses/types.ts:852](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L852) |\n| `service_tier?` | `\"default\"` | `\"auto\"` | `\"flex\"` | `\"scale\"` | `\"priority\"` | `undefined` | Service reliability tier for processing the request. | [src/batteries/llm/openai\\_responses/types.ts:953](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L953) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | `undefined` | Backing store for `string` / `Uint8Array` tool returns. | [src/batteries/llm/openai\\_responses/types.ts:862](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L862) |\n| `stream?` | `boolean` | `undefined` | Whether to stream the response via SSE. | [src/batteries/llm/openai\\_responses/types.ts:838](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L838) |\n| `stream_options?` | { `include_obfuscation?`: `boolean`; } | `undefined` | Configuration options for response streaming. | [src/batteries/llm/openai\\_responses/types.ts:975](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L975) |\n| `stream_options.include_obfuscation?` | `boolean` | `undefined` | - | [src/batteries/llm/openai\\_responses/types.ts:975](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L975) |\n| `streamIdleTimeoutMs?` | `number` | `undefined` | Idle timeout in milliseconds for the stream before aborting. | [src/batteries/llm/openai\\_responses/types.ts:840](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L840) |\n| `strict?` | `boolean` | `undefined` | Global `strict` default forwarded to every emitted tool declaration's `strict` field, when the caller hasn't already got a reason not to (kept `undefined` by default since `strict: true` requires `additionalProperties: false` and full `required` coverage that ADK's Joi-derived schemas don't guarantee). | [src/batteries/llm/openai\\_responses/types.ts:915](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L915) |\n| `strictToolChoice?` | `boolean` | `undefined` | Whether a `tool_choice` forcing a forged ephemeral artifact-query tool throws instead of warning. | [src/batteries/llm/openai\\_responses/types.ts:864](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L864) |\n| `systemPromptChannel?` | [`SystemPromptChannel`](../type-aliases/SystemPromptChannel.md) | `'instructions'` | Where the ADK-rendered system prompt is placed on the wire. **Remarks** `'instructions'` (default) — the top-level `instructions` string field. `'developer-item'` / `'system-item'` — a leading `developer`/`system`-role input message item instead, for gateways that only understand the item form. Either way the CONTENT is always ADK-rendered; there is no consumer-facing escape hatch to hand-author it directly (see the `instructions` note below). | [src/batteries/llm/openai\\_responses/types.ts:892](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L892) |\n| `temperature?` | `number` | `undefined` | Sampling temperature control. | [src/batteries/llm/openai\\_responses/types.ts:945](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L945) |\n| `text?` | { `format?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `verbosity?`: `\"low\"` | `\"medium\"` | `\"high\"`; } | `undefined` | Structured-output format / verbosity configuration. | [src/batteries/llm/openai\\_responses/types.ts:965](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L965) |\n| `text.format?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | `undefined` | - | [src/batteries/llm/openai\\_responses/types.ts:965](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L965) |\n| `text.verbosity?` | `\"low\"` | `\"medium\"` | `\"high\"` | `undefined` | - | [src/batteries/llm/openai\\_responses/types.ts:965](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L965) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | `undefined` | Determines which thoughts are surfaced back to the model. | [src/batteries/llm/openai\\_responses/types.ts:854](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L854) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | `undefined` | Tokenizer encoding configuration for token counting. | [src/batteries/llm/openai\\_responses/types.ts:856](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L856) |\n| `tool_choice?` | [`OpenAIResponsesToolChoice`](../type-aliases/OpenAIResponsesToolChoice.md) | `undefined` | Tool-choice directive. | [src/batteries/llm/openai\\_responses/types.ts:963](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L963) |\n| `toolCallIdFilter?` | [`ToolCallIdFilterFn`](../../../../type-aliases/ToolCallIdFilterFn.md) | `undefined` | Optional ingress hook for adapting provider tool-call ids; absent preserves the vendor id. | [src/batteries/llm/openai\\_responses/types.ts:874](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L874) |\n| `top_logprobs?` | `number` | `undefined` | Top log-probability tokens limit. | [src/batteries/llm/openai\\_responses/types.ts:949](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L949) |\n| `top_p?` | `number` | `undefined` | Nucleus sampling probability threshold. | [src/batteries/llm/openai\\_responses/types.ts:947](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L947) |\n| `truncation?` | `\"auto\"` | `\"disabled\"` | `undefined` | Context-truncation strategy. | [src/batteries/llm/openai\\_responses/types.ts:951](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L951) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md) | `undefined` | Policy for a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality this wire cannot represent (audio, video). | [src/batteries/llm/openai\\_responses/types.ts:868](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L868) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesCompletedEvent","title":"Interface: OpenAIResponsesCompletedEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesCompletedEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesCompletedEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesCompletedEvent.md\ndescription: Terminal SSE event emitted when the response completes successfully.\n---\n\n# Interface: OpenAIResponsesCompletedEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:470](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L470)\n\nTerminal SSE event emitted when the response completes successfully.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `response` | [`OpenAIResponsesResponseObject`](OpenAIResponsesResponseObject.md) | The full, terminal response object. | - | - | [src/batteries/llm/openai\\_responses/types.ts:474](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L474) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.completed\"` | Event-type discriminator; always `'response.completed'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:472](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L472) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesErrorEvent","title":"Interface: OpenAIResponsesErrorEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesErrorEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesErrorEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesErrorEvent.md\ndescription: >-\n Terminal SSE event emitted when the stream itself errors, outside of any\n particular response object.\n---\n\n# Interface: OpenAIResponsesErrorEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:494](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L494)\n\nTerminal SSE event emitted when the stream itself errors, outside of any particular response object.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ------------------ | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `code?` | `string` | `null` | Provider-defined machine-readable error code, when available. | - | - | [src/batteries/llm/openai\\_responses/types.ts:498](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L498) |\n| `message` | `string` | Human-readable error message. | - | - | [src/batteries/llm/openai\\_responses/types.ts:500](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L500) |\n| `param?` | `string` | `null` | The request parameter the error relates to, when applicable. | - | - | [src/batteries/llm/openai\\_responses/types.ts:502](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L502) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"error\"` | Event-type discriminator; always `'error'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:496](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L496) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFailedEvent","title":"Interface: OpenAIResponsesFailedEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFailedEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFailedEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFailedEvent.md\ndescription: Terminal SSE event emitted when the response fails outright.\n---\n\n# Interface: OpenAIResponsesFailedEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:486](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L486)\n\nTerminal SSE event emitted when the response fails outright.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `response` | [`OpenAIResponsesResponseObject`](OpenAIResponsesResponseObject.md) | The full response object, with `error` describing the failure. | - | - | [src/batteries/llm/openai\\_responses/types.ts:490](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L490) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.failed\"` | Event-type discriminator; always `'response.failed'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:488](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L488) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent","title":"Interface: OpenAIResponsesFunctionCallArgumentsDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDeltaEvent.md\ndescription: SSE event emitted when a fragment of a tool call's JSON arguments streams in.\n---\n\n# Interface: OpenAIResponsesFunctionCallArgumentsDeltaEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:446](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L446)\n\nSSE event emitted when a fragment of a tool call's JSON arguments streams in.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ------------------------------------------ | ---------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `delta` | `string` | The incremental arguments-string fragment to append. | - | - | [src/batteries/llm/openai\\_responses/types.ts:454](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L454) |\n| `item_id` | `string` | The id of the function-call item this delta belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:450](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L450) |\n| `output_index` | `number` | The index of the function-call item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:452](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L452) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.function_call_arguments.delta\"` | Event-type discriminator; always `'response.function_call_arguments.delta'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L448) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent","title":"Interface: OpenAIResponsesFunctionCallArgumentsDoneEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallArgumentsDoneEvent.md\ndescription: SSE event emitted when a tool call's JSON arguments string is finalized.\n---\n\n# Interface: OpenAIResponsesFunctionCallArgumentsDoneEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:458](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L458)\n\nSSE event emitted when a tool call's JSON arguments string is finalized.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `arguments` | `string` | The complete, finalized JSON-encoded arguments string. This REPLACES, never merges with, prior deltas. | - | - | [src/batteries/llm/openai\\_responses/types.ts:466](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L466) |\n| `item_id` | `string` | The id of the function-call item this arguments string belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:462](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L462) |\n| `output_index` | `number` | The index of the function-call item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:464](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L464) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.function_call_arguments.done\"` | Event-type discriminator; always `'response.function_call_arguments.done'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:460](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L460) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallItem","title":"Interface: OpenAIResponsesFunctionCallItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallItem.md\ndescription: A model-emitted function (tool) call item.\n---\n\n# Interface: OpenAIResponsesFunctionCallItem\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L143)\n\nA model-emitted function (tool) call item.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `arguments` | `string` | The JSON-encoded arguments string. | [src/batteries/llm/openai\\_responses/types.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L151) |\n| `call_id` | `string` | Correlates this call with its sibling `function_call_output` item. | [src/batteries/llm/openai\\_responses/types.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L147) |\n| `id?` | `string` | Item id (distinct from `call_id`) — present on real provider-emitted items. | [src/batteries/llm/openai\\_responses/types.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L153) |\n| `name` | `string` | The tool name the model called. | [src/batteries/llm/openai\\_responses/types.ts:149](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L149) |\n| `status?` | `\"completed\"` | `\"incomplete\"` | `\"in_progress\"` | Lifecycle status of the call item. | [src/batteries/llm/openai\\_responses/types.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L155) |\n| `type` | `\"function_call\"` | Item discriminator; always `'function_call'`. | [src/batteries/llm/openai\\_responses/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L145) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallOutputItem","title":"Interface: OpenAIResponsesFunctionCallOutputItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallOutputItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallOutputItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesFunctionCallOutputItem.md\ndescription: The result of executing a `function_call_output`'s paired `function_call`.\n---\n\n# Interface: OpenAIResponsesFunctionCallOutputItem\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L159)\n\nThe result of executing a `function_call_output`'s paired `function_call`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `call_id` | `string` | Correlates this result with its sibling `function_call` item. | [src/batteries/llm/openai\\_responses/types.ts:163](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L163) |\n| `id?` | `string` | Item id, as assigned by the provider. | [src/batteries/llm/openai\\_responses/types.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L167) |\n| `output` | | `string` | [`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[] | The tool result — a plain string, or (per the API reference) an array of content blocks. | [src/batteries/llm/openai\\_responses/types.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L165) |\n| `status?` | `\"completed\"` | `\"incomplete\"` | `\"in_progress\"` | Lifecycle status of the output item. | [src/batteries/llm/openai\\_responses/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L169) |\n| `type` | `\"function_call_output\"` | Item discriminator; always `'function_call_output'`. | [src/batteries/llm/openai\\_responses/types.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L161) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesHelpers","title":"Interface: OpenAIResponsesHelpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesHelpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesHelpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesHelpers.md\ndescription: Full translation-helper contract for the OpenAI Responses battery.\n---\n\n# Interface: OpenAIResponsesHelpers\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:699](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L699)\n\nFull translation-helper contract for the OpenAI Responses battery.\n\n## Extends\n\n* [`ChatHelpersCommon`](ChatHelpersCommon.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buildOpenAIResponsesInput` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `fingerprintOpenAIResponsesPrefix`: (`input`: { `input`: [`OpenAIResponsesInputItem`](../type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `model`: `string`; `throughItem?`: `number`; `tools?`: [`OpenAIResponsesTool`](../type-aliases/OpenAIResponsesTool.md)\\[]; }) => `Promise`<`string`>; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `model`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../type-aliases/ReasoningReplayMode.md); `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderCtx?`: `unknown`; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), | `string` | [`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderOpenAIResponsesReasoningItem`: (`input`: { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => | [`OpenAIResponsesReasoningItem`](OpenAIResponsesReasoningItem.md) | `undefined`; `renderOpenAIResponsesTimelineMessage`: (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | [`OpenAIResponsesInputItem`](../type-aliases/OpenAIResponsesInputItem.md) | `null`>; `renderOpenAIResponsesToolCallResult`: (`input`: { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `strict?`: `boolean`; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `systemPromptChannel`: [`SystemPromptChannel`](../type-aliases/SystemPromptChannel.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `toolsToOpenAIResponsesTools`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; }) => [`OpenAIResponsesTool`](../type-aliases/OpenAIResponsesTool.md)\\[]; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<{ `fingerprintableLength`: `number`; `input`: [`OpenAIResponsesInputItem`](../type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `tools?`: [`OpenAIResponsesTool`](../type-aliases/OpenAIResponsesTool.md)\\[]; }> | Assembles the full Responses `input` array, `instructions`, and `tools`, including the reasoning-pairing enforcement pass. | - | [src/batteries/llm/openai\\_responses/types.ts:752](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L752) |\n| `createResponsesOutputSlotMachine` | () => [`ResponsesOutputSlotMachine`](ResponsesOutputSlotMachine.md) | Instantiates a new streaming output-slot state machine. | - | [src/batteries/llm/openai\\_responses/types.ts:817](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L817) |\n| `descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) | Converts a validator `describe()` envelope into the Chat-Completions JSON-Schema subset. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`descriptionToChatCompletionsJsonSchema`](ChatHelpersCommon.md#property-descriptiontochatcompletionsjsonschema) | [src/batteries/llm/chat\\_common/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L511) |\n| `filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | Selects which thoughts to surface, by surfacing mode, self identity, and replay compatibility. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`filterThoughts`](ChatHelpersCommon.md#property-filterthoughts) | [src/batteries/llm/chat\\_common/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L599) |\n| `fingerprintOpenAIResponsesPrefix` | (`input`: { `input`: [`OpenAIResponsesInputItem`](../type-aliases/OpenAIResponsesInputItem.md)\\[]; `instructions?`: `string`; `model`: `string`; `throughItem?`: `number`; `tools?`: [`OpenAIResponsesTool`](../type-aliases/OpenAIResponsesTool.md)\\[]; }) => `Promise`<`string`> | Computes the fingerprint used to gate reasoning-item replay. | - | [src/batteries/llm/openai\\_responses/types.ts:736](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L736) |\n| `renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md) tool result: metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam. When omitted the battery uses the shared defaultRenderArtifactHandleBody. A consumer overrides it to change WHICH reader the model is steered toward first — e.g. promoting the JSON content-readers (`artifact_json_get` / `artifact_json_keys`) ahead of the metadata-only `artifact_json_type` for a small model that grabs the first listed tool. The tool list itself comes from the artifact's `constructor.toolMethods`; an override typically reorders or re-annotates that list before delegating to the default renderer. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderArtifactHandleBody`](ChatHelpersCommon.md#property-renderartifacthandlebody) | [src/batteries/llm/chat\\_common/types.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L571) |\n| `renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | Assembles the system-prompt message from its constituent buckets in [ChatCompletionsBucketOrder](../../../../type-aliases/ChatCompletionsBucketOrder.md). | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderChatCompletionsSystemPrompt`](ChatHelpersCommon.md#property-renderchatcompletionssystemprompt) | [src/batteries/llm/chat\\_common/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L611) |\n| `renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`> | Renders first-party (trusted) retrievables into a single prompt block. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderFirstPartyRetrievables`](ChatHelpersCommon.md#property-renderfirstpartyretrievables) | [src/batteries/llm/chat\\_common/types.ts:526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L526) |\n| `renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | Renders memories (each with its attribute bag) into a single prompt block. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderMemories`](ChatHelpersCommon.md#property-rendermemories) | [src/batteries/llm/chat\\_common/types.ts:522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L522) |\n| `renderOpenAIResponsesMediaBlocks` | (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | Renders one ADK media value into Responses content blocks. | - | [src/batteries/llm/openai\\_responses/types.ts:701](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L701) |\n| `renderOpenAIResponsesReasoningItem` | (`input`: { `prefixFingerprint`: `string`; `reasoningReplay`: [`ReasoningReplayMode`](../type-aliases/ReasoningReplayMode.md); `replayCompatibility`: readonly `string`\\[]; `thought`: [`Thought`](../../../../../common/classes/Thought.md); `warn?`: (`msg`: `string`) => `void`; }) => | [`OpenAIResponsesReasoningItem`](OpenAIResponsesReasoningItem.md) | `undefined` | Converts an eligible stored reasoning-replay payload into a wire `reasoning` item, or `undefined` if ineligible. | - | [src/batteries/llm/openai\\_responses/types.ts:744](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L744) |\n| `renderOpenAIResponsesTimelineMessage` | (`input`: { `message`: [`Message`](../../../../../common/classes/Message.md); `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `selfIdentity`: `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | [`OpenAIResponsesInputItem`](../type-aliases/OpenAIResponsesInputItem.md) | `null`> | Renders an ADK timeline message into a Responses input message item. | - | [src/batteries/llm/openai\\_responses/types.ts:709](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L709) |\n| `renderOpenAIResponsesToolCallResult` | (`input`: { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderOpenAIResponsesMediaBlocks`: (`input`: { `media`: [`Media`](../../../../../common/classes/Media.md); `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`<[`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]>; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; }) => `Promise`< | `string` | [`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[]> | Renders a tool call's result into a `function_call_output` item's `output`. | - | [src/batteries/llm/openai\\_responses/types.ts:719](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L719) |\n| `renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Renders the directions-bearing \"handle\" body for a non-inlined [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md) whose content is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): metadata (callId/kind/byteLength/lineCount) plus the forged `artifact_*` tools the model should call to read it incrementally. **Remarks** Optional override seam, the retrievable-side counterpart to [renderArtifactHandleBody](ChatHelpersCommon.md#property-renderartifacthandlebody). When omitted the battery uses the shared defaultRenderRetrievableHandleBody. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderRetrievableHandleBody`](ChatHelpersCommon.md#property-renderretrievablehandlebody) | [src/batteries/llm/chat\\_common/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L588) |\n| `renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Assembles the full retrievables block: safety directive plus the trust-tiered sub-renderers. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderRetrievables`](ChatHelpersCommon.md#property-renderretrievables) | [src/batteries/llm/chat\\_common/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L547) |\n| `renderRetrievableSafetyDirective` | () => `string` | Renders the safety directive that precedes any retrievable content. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderRetrievableSafetyDirective`](ChatHelpersCommon.md#property-renderretrievablesafetydirective) | [src/batteries/llm/chat\\_common/types.ts:524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L524) |\n| `renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | Renders standing instructions into a single prompt block. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderStandingInstructions`](ChatHelpersCommon.md#property-renderstandinginstructions) | [src/batteries/llm/chat\\_common/types.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L517) |\n| `renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party private retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderThirdPartyPrivateRetrievables`](ChatHelpersCommon.md#property-renderthirdpartyprivateretrievables) | [src/batteries/llm/chat\\_common/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L539) |\n| `renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | Renders third-party public retrievables, wrapping each in the untrusted-content envelope. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderThirdPartyPublicRetrievables`](ChatHelpersCommon.md#property-renderthirdpartypublicretrievables) | [src/batteries/llm/chat\\_common/types.ts:531](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L531) |\n| `renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | Renders a single thought into its prompt block, optionally carrying an opaque replay payload. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderThought`](ChatHelpersCommon.md#property-renderthought) | [src/batteries/llm/chat\\_common/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L597) |\n| `renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | Wraps trusted (first-party) text in the trusted-content trust envelope. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderTrustedContent`](ChatHelpersCommon.md#property-rendertrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L515) |\n| `renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | Wraps untrusted (third-party) text in the untrusted-content trust envelope. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`renderUntrustedContent`](ChatHelpersCommon.md#property-renderuntrustedcontent) | [src/batteries/llm/chat\\_common/types.ts:513](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L513) |\n| `toolsToChatCompletionsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`ChatCompletionsTool`](../../../../interfaces/ChatCompletionsTool.md)\\[] | Translates the tool registry into the function-tool wire array advertised to the model. | [`ChatHelpersCommon`](ChatHelpersCommon.md).[`toolsToChatCompletionsTools`](ChatHelpersCommon.md#property-toolstochatcompletionstools) | [src/batteries/llm/chat\\_common/types.ts:606](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L606) |\n| `toolsToOpenAIResponsesTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: `unknown`) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); `strict?`: `boolean`; }) => [`OpenAIResponsesTool`](../type-aliases/OpenAIResponsesTool.md)\\[] | Translates the ADK tool registry into Responses function-tool definitions (`name` top-level). | - | [src/batteries/llm/openai\\_responses/types.ts:731](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L731) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesIncompleteEvent","title":"Interface: OpenAIResponsesIncompleteEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesIncompleteEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesIncompleteEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesIncompleteEvent.md\ndescription: >-\n Terminal SSE event emitted when the response stops before completing (e.g. hit\n `max_output_tokens`).\n---\n\n# Interface: OpenAIResponsesIncompleteEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:478](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L478)\n\nTerminal SSE event emitted when the response stops before completing (e.g. hit `max_output_tokens`).\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `response` | [`OpenAIResponsesResponseObject`](OpenAIResponsesResponseObject.md) | The full response object, with `incomplete_details` explaining why it stopped early. | - | - | [src/batteries/llm/openai\\_responses/types.ts:482](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L482) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.incomplete\"` | Event-type discriminator; always `'response.incomplete'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:480](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L480) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesMessageItem","title":"Interface: OpenAIResponsesMessageItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesMessageItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesMessageItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesMessageItem.md\ndescription: >-\n An input message item — the leading-content-channel item shape (`role:\n 'user'`, or the leading `developer`/`system`-role item rendered when\n `systemPromptChannel` is not `'instructions'`, or a trailing after-timeline\n bucket message), plus a peer-identity assistant timeline turn rendered as a\n plain input message rather than the full output-item shape.\n---\n\n# Interface: OpenAIResponsesMessageItem\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L108)\n\nAn input message item — the leading-content-channel item shape (`role: 'user'`, or the leading\n`developer`/`system`-role item rendered when `systemPromptChannel` is not `'instructions'`, or a\ntrailing after-timeline bucket message), plus a peer-identity assistant timeline turn rendered as\na plain input message rather than the full output-item shape.\n\n## Remarks\n\n`role: 'assistant'` is included — the wire's shorthand `EasyInputMessage` form accepts it for a\nplain, non-native-output assistant turn (distinct from [OpenAIResponsesOutputMessageItem](OpenAIResponsesOutputMessageItem.md),\nwhich is the full native-output shape used only when replaying the model's OWN prior turn).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | [`OpenAIResponsesInputContentBlock`](../type-aliases/OpenAIResponsesInputContentBlock.md)\\[] | Content blocks. | [src/batteries/llm/openai\\_responses/types.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L114) |\n| `id?` | `string` | Optional item id. | [src/batteries/llm/openai\\_responses/types.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L116) |\n| `role` | `\"user\"` | `\"assistant\"` | `\"system\"` | `\"developer\"` | The message's role. | [src/batteries/llm/openai\\_responses/types.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L112) |\n| `type?` | `\"message\"` | Item discriminator. Optional on input items per the wire (defaults to `'message'`). | [src/batteries/llm/openai\\_responses/types.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L110) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOpaqueOutputItem","title":"Interface: OpenAIResponsesOpaqueOutputItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOpaqueOutputItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOpaqueOutputItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOpaqueOutputItem.md\ndescription: >-\n Any other output item type the Responses API can emit that this battery does\n not natively model (hosted server-side tools: `web_search_call`,\n `code_interpreter_call`, `mcp_call`, etc.). Carried through structurally so\n the streaming state machine can recognize — and deliberately decline to open a\n slot for — an item type it does not know, per Known Gotcha #6.\n---\n\n# Interface: OpenAIResponsesOpaqueOutputItem\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L214)\n\nAny other output item type the Responses API can emit that this battery does not natively\nmodel (hosted server-side tools: `web_search_call`, `code_interpreter_call`, `mcp_call`, etc.).\nCarried through structurally so the streaming state machine can recognize — and deliberately\ndecline to open a slot for — an item type it does not know, per Known Gotcha #6.\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | -------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `id?` | `string` | Item id, as assigned by the provider, when present. | [src/batteries/llm/openai\\_responses/types.ts:218](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L218) |\n| `type` | `string` | The provider's item-type discriminator, not one this battery recognizes structurally. | [src/batteries/llm/openai\\_responses/types.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L216) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemAddedEvent","title":"Interface: OpenAIResponsesOutputItemAddedEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemAddedEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemAddedEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemAddedEvent.md\ndescription: >-\n SSE event emitted when a new output item is opened (streaming begins for that\n item).\n---\n\n# Interface: OpenAIResponsesOutputItemAddedEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:314](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L314)\n\nSSE event emitted when a new output item is opened (streaming begins for that item).\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `item` | [`OpenAIResponsesOutputItem`](../type-aliases/OpenAIResponsesOutputItem.md) | The item as it stood at the moment it was opened (fields fill in as later deltas arrive). | - | - | [src/batteries/llm/openai\\_responses/types.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L320) |\n| `output_index` | `number` | The index of the newly-opened item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L318) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.output_item.added\"` | Event-type discriminator; always `'response.output_item.added'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:316](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L316) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemDoneEvent","title":"Interface: OpenAIResponsesOutputItemDoneEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemDoneEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemDoneEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputItemDoneEvent.md\ndescription: >-\n SSE event emitted when an output item is finalized — its terminal,\n fully-populated shape.\n---\n\n# Interface: OpenAIResponsesOutputItemDoneEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:324](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L324)\n\nSSE event emitted when an output item is finalized — its terminal, fully-populated shape.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `item` | [`OpenAIResponsesOutputItem`](../type-aliases/OpenAIResponsesOutputItem.md) | The fully-populated item. | - | - | [src/batteries/llm/openai\\_responses/types.ts:330](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L330) |\n| `output_index` | `number` | The index of the finalized item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:328](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L328) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.output_item.done\"` | Event-type discriminator; always `'response.output_item.done'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L326) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputMessageItem","title":"Interface: OpenAIResponsesOutputMessageItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputMessageItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputMessageItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputMessageItem.md\ndescription: >-\n An assistant output-message item, in the OUTPUT shape (not the input shape) —\n used when replaying the ADK's OWN prior assistant text back into `input`, so\n the reasoning-pairing validator (see the Known Gotchas) recognizes it\n correctly as a genuine prior output item.\n---\n\n# Interface: OpenAIResponsesOutputMessageItem\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L129)\n\nAn assistant output-message item, in the OUTPUT shape (not the input shape) — used when\nreplaying the ADK's OWN prior assistant text back into `input`, so the reasoning-pairing\nvalidator (see the Known Gotchas) recognizes it correctly as a genuine prior output item.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content` | [`OpenAIResponsesOutputMessageContentPart`](../type-aliases/OpenAIResponsesOutputMessageContentPart.md)\\[] | The message's output content parts (text and/or refusal). | [src/batteries/llm/openai\\_responses/types.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L139) |\n| `id?` | `string` | The item's id, as assigned by the provider. | [src/batteries/llm/openai\\_responses/types.ts:137](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L137) |\n| `role` | `\"assistant\"` | Always `'assistant'` on an output-shaped message item. | [src/batteries/llm/openai\\_responses/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L133) |\n| `status?` | `\"completed\"` | `\"incomplete\"` | `\"in_progress\"` | Present on replay (`'completed'`); the live streaming path observes richer statuses. | [src/batteries/llm/openai\\_responses/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L135) |\n| `type` | `\"message\"` | Item discriminator; always `'message'` for an output message. | [src/batteries/llm/openai\\_responses/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L131) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDeltaEvent","title":"Interface: OpenAIResponsesOutputTextDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDeltaEvent.md\ndescription: >-\n SSE event emitted when a text fragment streams in for an output message's\n content.\n---\n\n# Interface: OpenAIResponsesOutputTextDeltaEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:334](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L334)\n\nSSE event emitted when a text fragment streams in for an output message's content.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ------------------------------ | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content_index` | `number` | The index of the content part within the item's `content` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:342](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L342) |\n| `delta` | `string` | The incremental text fragment to append. | - | - | [src/batteries/llm/openai\\_responses/types.ts:344](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L344) |\n| `item_id` | `string` | The id of the output-message item this delta belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:338](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L338) |\n| `output_index` | `number` | The index of the output-message item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:340](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L340) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.output_text.delta\"` | Event-type discriminator; always `'response.output_text.delta'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:336](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L336) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDoneEvent","title":"Interface: OpenAIResponsesOutputTextDoneEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDoneEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDoneEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesOutputTextDoneEvent.md\ndescription: SSE event emitted when an output message's text content part is finalized.\n---\n\n# Interface: OpenAIResponsesOutputTextDoneEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:348](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L348)\n\nSSE event emitted when an output message's text content part is finalized.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ----------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content_index` | `number` | The index of the content part within the item's `content` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:356](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L356) |\n| `item_id` | `string` | The id of the output-message item this text belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:352](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L352) |\n| `output_index` | `number` | The index of the output-message item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:354](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L354) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `text` | `string` | The complete, finalized text. | - | - | [src/batteries/llm/openai\\_responses/types.ts:358](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L358) |\n| `type` | `\"response.output_text.done\"` | Event-type discriminator; always `'response.output_text.done'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:350](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L350) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningContentPart","title":"Interface: OpenAIResponsesReasoningContentPart","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningContentPart.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningContentPart","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningContentPart.md\ndescription: >-\n One full-reasoning-text part of a `reasoning` item (present only under some\n `include` values).\n---\n\n# Interface: OpenAIResponsesReasoningContentPart\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L181)\n\nOne full-reasoning-text part of a `reasoning` item (present only under some `include` values).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ------------------ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `text` | `string` | The unsummarized reasoning text. | [src/batteries/llm/openai\\_responses/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L185) |\n| `type` | `\"reasoning_text\"` | Part discriminator; always `'reasoning_text'`. | [src/batteries/llm/openai\\_responses/types.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L183) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningItem","title":"Interface: OpenAIResponsesReasoningItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningItem.md\ndescription: >-\n A model-emitted `reasoning` item — the native wire representation of a\n \"thought.\" Only ever sent back on `input` when `reasoningReplay !== 'off'` and\n its stored signature/prefix-fingerprint is still valid; see the\n reasoning-pairing adjacency-sweep pass and Known Gotcha #1.\n---\n\n# Interface: OpenAIResponsesReasoningItem\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L193)\n\nA model-emitted `reasoning` item — the native wire representation of a \"thought.\" Only ever sent\nback on `input` when `reasoningReplay !== 'off'` and its stored signature/prefix-fingerprint is\nstill valid; see the reasoning-pairing adjacency-sweep pass and Known Gotcha #1.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | [`OpenAIResponsesReasoningContentPart`](OpenAIResponsesReasoningContentPart.md)\\[] | Ordered full-reasoning-text parts, present only under some `include` values. | [src/batteries/llm/openai\\_responses/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L201) |\n| `encrypted_content?` | `string` | `null` | Opaque, provider-signed reasoning payload. Present only when `include` requested it. | [src/batteries/llm/openai\\_responses/types.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L203) |\n| `id` | `string` | Item id, used to correlate this reasoning item with adjacent output items on replay. | [src/batteries/llm/openai\\_responses/types.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L197) |\n| `status?` | `\"completed\"` | `\"incomplete\"` | `\"in_progress\"` | Lifecycle status of the reasoning item. | [src/batteries/llm/openai\\_responses/types.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L205) |\n| `summary` | [`OpenAIResponsesReasoningSummaryPart`](OpenAIResponsesReasoningSummaryPart.md)\\[] | Ordered summary-text parts for this reasoning item. | [src/batteries/llm/openai\\_responses/types.ts:199](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L199) |\n| `type` | `\"reasoning\"` | Item discriminator; always `'reasoning'`. | [src/batteries/llm/openai\\_responses/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L195) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningReplayPayload","title":"Interface: OpenAIResponsesReasoningReplayPayload","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningReplayPayload.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningReplayPayload","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningReplayPayload.md\ndescription: >-\n Opaque payload stored on a replayable OpenAI Responses reasoning `Thought`.\n Sibling to the Anthropic battery's `AnthropicThinkingReplayPayload`.\n---\n\n# Interface: OpenAIResponsesReasoningReplayPayload\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L611)\n\nOpaque payload stored on a replayable OpenAI Responses reasoning `Thought`. Sibling to the\nAnthropic battery's `AnthropicThinkingReplayPayload`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `item` | [`OpenAIResponsesReasoningItem`](OpenAIResponsesReasoningItem.md) | The reasoning item exactly as the provider emitted it. | [src/batteries/llm/openai\\_responses/types.ts:615](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L615) |\n| `pairedItemId` | `string` | `undefined` | The id of the item that immediately followed this reasoning item in `response.output`. | [src/batteries/llm/openai\\_responses/types.ts:617](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L617) |\n| `prefixFingerprint` | `string` | Stable fingerprint of the signed conversation prefix. | [src/batteries/llm/openai\\_responses/types.ts:619](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L619) |\n| `variant` | `\"responses-reasoning\"` | Payload variant discriminator; always `'responses-reasoning'`. | [src/batteries/llm/openai\\_responses/types.ts:613](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L613) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryPart","title":"Interface: OpenAIResponsesReasoningSummaryPart","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryPart.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryPart","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryPart.md\ndescription: One summary-text part of a `reasoning` item.\n---\n\n# Interface: OpenAIResponsesReasoningSummaryPart\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L173)\n\nOne summary-text part of a `reasoning` item.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ---------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `text` | `string` | The summarized reasoning text. | [src/batteries/llm/openai\\_responses/types.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L177) |\n| `type` | `\"summary_text\"` | Part discriminator; always `'summary_text'`. | [src/batteries/llm/openai\\_responses/types.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L175) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent","title":"Interface: OpenAIResponsesReasoningSummaryTextDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDeltaEvent.md\ndescription: >-\n SSE event emitted when a reasoning-summary text fragment streams in for a\n `reasoning` item.\n---\n\n# Interface: OpenAIResponsesReasoningSummaryTextDeltaEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:390](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L390)\n\nSSE event emitted when a reasoning-summary text fragment streams in for a `reasoning` item.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `delta` | `string` | The incremental summary-text fragment to append. | - | - | [src/batteries/llm/openai\\_responses/types.ts:400](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L400) |\n| `item_id` | `string` | The id of the reasoning item this delta belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:394](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L394) |\n| `output_index` | `number` | The index of the reasoning item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:396](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L396) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `summary_index` | `number` | The index of the summary part within the item's `summary` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:398](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L398) |\n| `type` | `\"response.reasoning_summary_text.delta\"` | Event-type discriminator; always `'response.reasoning_summary_text.delta'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:392](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L392) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent","title":"Interface: OpenAIResponsesReasoningSummaryTextDoneEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningSummaryTextDoneEvent.md\ndescription: SSE event emitted when a `reasoning` item's summary-text part is finalized.\n---\n\n# Interface: OpenAIResponsesReasoningSummaryTextDoneEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:404](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L404)\n\nSSE event emitted when a `reasoning` item's summary-text part is finalized.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ---------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `item_id` | `string` | The id of the reasoning item this summary belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L408) |\n| `output_index` | `number` | The index of the reasoning item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:410](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L410) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `summary_index` | `number` | The index of the summary part within the item's `summary` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:412](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L412) |\n| `text` | `string` | The complete, finalized summary text. | - | - | [src/batteries/llm/openai\\_responses/types.ts:414](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L414) |\n| `type` | `\"response.reasoning_summary_text.done\"` | Event-type discriminator; always `'response.reasoning_summary_text.done'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:406](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L406) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDeltaEvent","title":"Interface: OpenAIResponsesReasoningTextDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDeltaEvent.md\ndescription: >-\n SSE event emitted when a full-reasoning text fragment streams in for a\n `reasoning` item.\n---\n\n# Interface: OpenAIResponsesReasoningTextDeltaEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:418](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L418)\n\nSSE event emitted when a full-reasoning text fragment streams in for a `reasoning` item.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content_index` | `number` | The index of the content part within the item's `content` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:426](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L426) |\n| `delta` | `string` | The incremental reasoning-text fragment to append. | - | - | [src/batteries/llm/openai\\_responses/types.ts:428](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L428) |\n| `item_id` | `string` | The id of the reasoning item this delta belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:422](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L422) |\n| `output_index` | `number` | The index of the reasoning item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:424](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L424) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.reasoning_text.delta\"` | Event-type discriminator; always `'response.reasoning_text.delta'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:420](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L420) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDoneEvent","title":"Interface: OpenAIResponsesReasoningTextDoneEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDoneEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDoneEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesReasoningTextDoneEvent.md\ndescription: >-\n SSE event emitted when a `reasoning` item's full-reasoning-text part is\n finalized.\n---\n\n# Interface: OpenAIResponsesReasoningTextDoneEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:432](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L432)\n\nSSE event emitted when a `reasoning` item's full-reasoning-text part is finalized.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | -------------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content_index` | `number` | The index of the content part within the item's `content` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:440](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L440) |\n| `item_id` | `string` | The id of the reasoning item this text belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:436](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L436) |\n| `output_index` | `number` | The index of the reasoning item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:438](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L438) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `text` | `string` | The complete, finalized reasoning text. | - | - | [src/batteries/llm/openai\\_responses/types.ts:442](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L442) |\n| `type` | `\"response.reasoning_text.done\"` | Event-type discriminator; always `'response.reasoning_text.done'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:434](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L434) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDeltaEvent","title":"Interface: OpenAIResponsesRefusalDeltaEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDeltaEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDeltaEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDeltaEvent.md\ndescription: >-\n SSE event emitted when a refusal fragment streams in for an output message's\n content.\n---\n\n# Interface: OpenAIResponsesRefusalDeltaEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:362](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L362)\n\nSSE event emitted when a refusal fragment streams in for an output message's content.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | -------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content_index` | `number` | The index of the content part within the item's `content` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:370](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L370) |\n| `delta` | `string` | The incremental refusal-text fragment to append. | - | - | [src/batteries/llm/openai\\_responses/types.ts:372](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L372) |\n| `item_id` | `string` | The id of the output-message item this delta belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:366](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L366) |\n| `output_index` | `number` | The index of the output-message item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:368](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L368) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.refusal.delta\"` | Event-type discriminator; always `'response.refusal.delta'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:364](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L364) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDoneEvent","title":"Interface: OpenAIResponsesRefusalDoneEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDoneEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDoneEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRefusalDoneEvent.md\ndescription: SSE event emitted when an output message's refusal content part is finalized.\n---\n\n# Interface: OpenAIResponsesRefusalDoneEvent\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:376](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L376)\n\nSSE event emitted when an output message's refusal content part is finalized.\n\n## Extends\n\n* `OpenAIResponsesStreamEventBase`\n\n## Properties\n\n| Property | Type | Description | Overrides | Inherited from | Defined in |\n| -------------------------------------------------------- | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content_index` | `number` | The index of the content part within the item's `content` array. | - | - | [src/batteries/llm/openai\\_responses/types.ts:384](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L384) |\n| `item_id` | `string` | The id of the output-message item this refusal belongs to. | - | - | [src/batteries/llm/openai\\_responses/types.ts:380](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L380) |\n| `output_index` | `number` | The index of the output-message item within `response.output`. | - | - | [src/batteries/llm/openai\\_responses/types.ts:382](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L382) |\n| `refusal` | `string` | The complete, finalized refusal text. | - | - | [src/batteries/llm/openai\\_responses/types.ts:386](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L386) |\n| `sequence_number?` | `number` | Monotonically increasing sequence number for this event within the stream. | - | `OpenAIResponsesStreamEventBase.sequence_number` | [src/batteries/llm/openai\\_responses/types.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L310) |\n| `type` | `\"response.refusal.done\"` | Event-type discriminator; always `'response.refusal.done'`. | `OpenAIResponsesStreamEventBase.type` | - | [src/batteries/llm/openai\\_responses/types.ts:378](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L378) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRequestBody","title":"Interface: OpenAIResponsesRequestBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRequestBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRequestBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesRequestBody.md\ndescription: >-\n The WIRE body shape this battery constructs and sends — not a 1:1 mirror of\n consumer-settable options. `instructions` and `store` are ALWAYS\n adapter-computed; neither is a key on [`OpenAIResponsesAdapterOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesAdapterOptions).\n---\n\n# Interface: OpenAIResponsesRequestBody\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:641](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L641)\n\nThe WIRE body shape this battery constructs and sends — not a 1:1 mirror of consumer-settable\noptions. `instructions` and `store` are ALWAYS adapter-computed; neither is a key on\n[OpenAIResponsesAdapterOptions](OpenAIResponsesAdapterOptions.md).\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `background?` | `boolean` | Request the generation run in the background (async). | [src/batteries/llm/openai\\_responses/types.ts:688](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L688) |\n| `include?` | [`OpenAIResponsesIncludable`](../type-aliases/OpenAIResponsesIncludable.md)\\[] | Additional output data requested from the model, e.g. `'reasoning.encrypted_content'`. | [src/batteries/llm/openai\\_responses/types.ts:653](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L653) |\n| `input` | [`OpenAIResponsesInputItem`](../type-aliases/OpenAIResponsesInputItem.md)\\[] | The flat array of input items — messages, tool calls/results, and reasoning items. | [src/batteries/llm/openai\\_responses/types.ts:645](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L645) |\n| `instructions?` | `string` | ALWAYS ADK-rendered; never a consumer-settable option. | [src/batteries/llm/openai\\_responses/types.ts:649](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L649) |\n| `max_output_tokens?` | `number` | Hard limit on the number of generated output tokens. | [src/batteries/llm/openai\\_responses/types.ts:664](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L664) |\n| `metadata?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Metadata key-value pairs forwarded to the provider. | [src/batteries/llm/openai\\_responses/types.ts:684](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L684) |\n| `model` | `string` | ID of the model to use for generation. | [src/batteries/llm/openai\\_responses/types.ts:643](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L643) |\n| `parallel_tool_calls?` | `boolean` | Allow the model to emit multiple tool calls in one turn. | [src/batteries/llm/openai\\_responses/types.ts:666](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L666) |\n| `prompt_cache_key?` | `string` | Vendor cache key for caching prefix content. | [src/batteries/llm/openai\\_responses/types.ts:678](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L678) |\n| `prompt_cache_retention?` | `\"in_memory\"` | `\"24h\"` | Cache retention strategy for cached prefix content. | [src/batteries/llm/openai\\_responses/types.ts:680](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L680) |\n| `reasoning?` | { `effort?`: `\"none\"` | `\"minimal\"` | `\"low\"` | `\"medium\"` | `\"high\"` | `\"xhigh\"`; `summary?`: `\"auto\"` | `\"concise\"` | `\"detailed\"`; } | Reasoning-effort / summary configuration for reasoning-capable models. | [src/batteries/llm/openai\\_responses/types.ts:659](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L659) |\n| `reasoning.effort?` | `\"none\"` | `\"minimal\"` | `\"low\"` | `\"medium\"` | `\"high\"` | `\"xhigh\"` | - | [src/batteries/llm/openai\\_responses/types.ts:660](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L660) |\n| `reasoning.summary?` | `\"auto\"` | `\"concise\"` | `\"detailed\"` | - | [src/batteries/llm/openai\\_responses/types.ts:661](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L661) |\n| `safety_identifier?` | `string` | Unique safety system identifier or configuration id. | [src/batteries/llm/openai\\_responses/types.ts:682](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L682) |\n| `service_tier?` | `\"default\"` | `\"auto\"` | `\"flex\"` | `\"scale\"` | `\"priority\"` | Service reliability tier for processing the request. | [src/batteries/llm/openai\\_responses/types.ts:676](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L676) |\n| `store` | `false` | ALWAYS `false` — this adapter is stateless; see the battery's design notes. | [src/batteries/llm/openai\\_responses/types.ts:651](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L651) |\n| `stream` | `boolean` | If set, partial output deltas are sent as server-sent events. | [src/batteries/llm/openai\\_responses/types.ts:647](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L647) |\n| `stream_options?` | { `include_obfuscation?`: `boolean`; } | Configuration options for response streaming. | [src/batteries/llm/openai\\_responses/types.ts:690](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L690) |\n| `stream_options.include_obfuscation?` | `boolean` | - | [src/batteries/llm/openai\\_responses/types.ts:690](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L690) |\n| `temperature?` | `number` | Sampling temperature control. | [src/batteries/llm/openai\\_responses/types.ts:668](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L668) |\n| `text?` | { `format?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; `verbosity?`: `\"low\"` | `\"medium\"` | `\"high\"`; } | Structured-output format / verbosity configuration. | [src/batteries/llm/openai\\_responses/types.ts:686](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L686) |\n| `text.format?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | - | [src/batteries/llm/openai\\_responses/types.ts:686](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L686) |\n| `text.verbosity?` | `\"low\"` | `\"medium\"` | `\"high\"` | - | [src/batteries/llm/openai\\_responses/types.ts:686](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L686) |\n| `tool_choice?` | [`OpenAIResponsesToolChoice`](../type-aliases/OpenAIResponsesToolChoice.md) | Tool-choice directive constraining which (if any) tool the model may call. | [src/batteries/llm/openai\\_responses/types.ts:657](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L657) |\n| `tools?` | [`OpenAIResponsesTool`](../type-aliases/OpenAIResponsesTool.md)\\[] | Function-tool definitions the model may call. | [src/batteries/llm/openai\\_responses/types.ts:655](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L655) |\n| `top_logprobs?` | `number` | Top log-probability tokens limit. | [src/batteries/llm/openai\\_responses/types.ts:672](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L672) |\n| `top_p?` | `number` | Nucleus sampling probability threshold. | [src/batteries/llm/openai\\_responses/types.ts:670](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L670) |\n| `truncation?` | `\"auto\"` | `\"disabled\"` | Context-truncation strategy. | [src/batteries/llm/openai\\_responses/types.ts:674](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L674) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesResponseObject","title":"Interface: OpenAIResponsesResponseObject","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesResponseObject.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesResponseObject","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesResponseObject.md\ndescription: >-\n The full `response` object — returned directly (non-streaming), or nested\n under a terminal streaming event.\n---\n\n# Interface: OpenAIResponsesResponseObject\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:280](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L280)\n\nThe full `response` object — returned directly (non-streaming), or nested under a terminal streaming event.\n\n## Indexable\n\n```ts\n[key: string]: unknown\n```\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `created_at?` | `number` | Unix timestamp (seconds) when the response was created. | [src/batteries/llm/openai\\_responses/types.ts:286](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L286) |\n| `error?` | | { `code?`: `string`; `message?`: `string`; `type?`: `string`; } | `null` | Present when `status` is `'failed'`; the provider's error details. | [src/batteries/llm/openai\\_responses/types.ts:300](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L300) |\n| `id?` | `string` | The response's unique identifier. | [src/batteries/llm/openai\\_responses/types.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L282) |\n| `incomplete_details?` | | { `reason?`: `string`; } | `null` | Present when `status` is `'incomplete'`; explains why generation stopped early. | [src/batteries/llm/openai\\_responses/types.ts:298](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L298) |\n| `model?` | `string` | The model that generated the response. | [src/batteries/llm/openai\\_responses/types.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L290) |\n| `object?` | `string` | Object-type discriminator, typically `'response'`. | [src/batteries/llm/openai\\_responses/types.ts:284](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L284) |\n| `output?` | [`OpenAIResponsesOutputItem`](../type-aliases/OpenAIResponsesOutputItem.md)\\[] | The ordered output items the model produced. | [src/batteries/llm/openai\\_responses/types.ts:292](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L292) |\n| `output_text?` | `string` | Convenience concatenation of the response's output text, when the provider supplies it. | [src/batteries/llm/openai\\_responses/types.ts:294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L294) |\n| `status?` | | `\"failed\"` | `\"completed\"` | `\"incomplete\"` | `\"in_progress\"` | `\"cancelled\"` | `\"queued\"` | Terminal or in-flight lifecycle status of the response. | [src/batteries/llm/openai\\_responses/types.ts:288](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L288) |\n| `usage?` | [`OpenAIResponsesUsage`](OpenAIResponsesUsage.md) | Token-usage accounting for this response. | [src/batteries/llm/openai\\_responses/types.ts:296](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L296) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesUsage","title":"Interface: OpenAIResponsesUsage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesUsage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesUsage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/OpenAIResponsesUsage.md\ndescription: Token-usage accounting on a Responses `response` object.\n---\n\n# Interface: OpenAIResponsesUsage\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:266](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L266)\n\nToken-usage accounting on a Responses `response` object.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input_tokens?` | `number` | Number of tokens in the request input. | [src/batteries/llm/openai\\_responses/types.ts:268](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L268) |\n| `input_tokens_details?` | { `cached_tokens?`: `number`; } | Breakdown of the input token count, e.g. how many were served from cache. | [src/batteries/llm/openai\\_responses/types.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L270) |\n| `input_tokens_details.cached_tokens?` | `number` | - | [src/batteries/llm/openai\\_responses/types.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L270) |\n| `output_tokens?` | `number` | Number of tokens generated in the response. | [src/batteries/llm/openai\\_responses/types.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L272) |\n| `output_tokens_details?` | { `reasoning_tokens?`: `number`; } | Breakdown of the output token count, e.g. how many were spent on reasoning. | [src/batteries/llm/openai\\_responses/types.ts:274](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L274) |\n| `output_tokens_details.reasoning_tokens?` | `number` | - | [src/batteries/llm/openai\\_responses/types.ts:274](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L274) |\n| `total_tokens?` | `number` | Total tokens (input + output) accounted for by this usage record. | [src/batteries/llm/openai\\_responses/types.ts:276](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L276) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesOutputSlotMachine","title":"Interface: ResponsesOutputSlotMachine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesOutputSlotMachine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesOutputSlotMachine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesOutputSlotMachine.md\ndescription: >-\n Per-dispatch streaming-state accumulator, keyed by `output_index` (one slot\n per output item — NOT a tool-call `index`, unlike Chat Completions).\n Constructed fresh per generation via {@link\n OpenAIResponsesHelpers.createResponsesOutputSlotMachine}.\n---\n\n# Interface: ResponsesOutputSlotMachine\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:580](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L580)\n\nPer-dispatch streaming-state accumulator, keyed by `output_index` (one slot per output item —\nNOT a tool-call `index`, unlike Chat Completions). Constructed fresh per generation via\n[OpenAIResponsesHelpers.createResponsesOutputSlotMachine](OpenAIResponsesHelpers.md#property-createresponsesoutputslotmachine).\n\n## Methods\n\n### appendFunctionCallArgumentsDelta()\n\n```ts\nappendFunctionCallArgumentsDelta(outputIndex: number, delta: string): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:594](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L594)\n\nAppends a `function_call_arguments` delta to the tool-call slot at `outputIndex`.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------- |\n| `outputIndex` | `number` |\n| `delta` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### appendReasoningSummary()\n\n```ts\nappendReasoningSummary(outputIndex: number, delta: string): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:590](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L590)\n\nAppends a `reasoning_summary_text` delta to the thinking slot at `outputIndex`.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------- |\n| `outputIndex` | `number` |\n| `delta` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### appendReasoningText()\n\n```ts\nappendReasoningText(outputIndex: number, delta: string): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:592](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L592)\n\nAppends a `reasoning_text` delta to the thinking slot at `outputIndex`.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------- |\n| `outputIndex` | `number` |\n| `delta` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### appendRefusal()\n\n```ts\nappendRefusal(outputIndex: number, delta: string): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L588)\n\nAppends a `refusal` delta to the text slot at `outputIndex`.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------- |\n| `outputIndex` | `number` |\n| `delta` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### appendText()\n\n```ts\nappendText(outputIndex: number, delta: string): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:586](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L586)\n\nAppends an `output_text` delta to the text slot at `outputIndex`.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------- |\n| `outputIndex` | `number` |\n| `delta` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### backfillEncryptedContent()\n\n```ts\nbackfillEncryptedContent(outputIndex: number, encryptedContent: string): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:600](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L600)\n\nBackfills `encryptedContent` on the thinking slot at `outputIndex` from the terminal event's `response.output`, when `.done` omitted it.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------ | -------- |\n| `outputIndex` | `number` |\n| `encryptedContent` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### finalizeSlot()\n\n```ts\nfinalizeSlot(outputIndex: number, item: OpenAIResponsesOutputItem): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:598](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L598)\n\nFinalizes the slot at `outputIndex` from a `response.output_item.done` event's `item` — the ONLY point at which a reasoning item's `encrypted_content`/signature is captured.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | --------------------------------------------------------------------------- |\n| `outputIndex` | `number` |\n| `item` | [`OpenAIResponsesOutputItem`](../type-aliases/OpenAIResponsesOutputItem.md) |\n\n#### Returns\n\n`void`\n\n***\n\n### getSlot()\n\n```ts\ngetSlot(outputIndex: number):\n | ResponsesOutputSlot\n | undefined;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:584](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L584)\n\nReturns the slot at `outputIndex`, if one is open.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------- |\n| `outputIndex` | `number` |\n\n#### Returns\n\n| [`ResponsesOutputSlot`](../type-aliases/ResponsesOutputSlot.md)\n| `undefined`\n\n***\n\n### openSlot()\n\n```ts\nopenSlot(outputIndex: number, item: OpenAIResponsesOutputItem):\n | ResponsesOutputSlot\n | undefined;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:582](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L582)\n\nOpens a slot for `outputIndex` from a `response.output_item.added` event's `item`. Unknown/hosted item types open no slot and return `undefined`.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | --------------------------------------------------------------------------- |\n| `outputIndex` | `number` |\n| `item` | [`OpenAIResponsesOutputItem`](../type-aliases/OpenAIResponsesOutputItem.md) |\n\n#### Returns\n\n| [`ResponsesOutputSlot`](../type-aliases/ResponsesOutputSlot.md)\n| `undefined`\n\n***\n\n### setFunctionCallArgumentsDone()\n\n```ts\nsetFunctionCallArgumentsDone(outputIndex: number, args: string): void;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:596](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L596)\n\nAuthoritatively REPLACES (never merges) the tool-call slot's `args` at `outputIndex`.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | -------- |\n| `outputIndex` | `number` |\n| `args` | `string` |\n\n#### Returns\n\n`void`\n\n***\n\n### slots()\n\n```ts\nslots(): ReadonlyMap;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:602](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L602)\n\nReturns every currently tracked slot, keyed by `output_index`.\n\n#### Returns\n\n`ReadonlyMap`<`number`, [`ResponsesOutputSlot`](../type-aliases/ResponsesOutputSlot.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesTextSlot","title":"Interface: ResponsesTextSlot","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesTextSlot.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesTextSlot","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesTextSlot.md\ndescription: A streaming text (assistant output-message) slot.\n---\n\n# Interface: ResponsesTextSlot\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:533](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L533)\n\nA streaming text (assistant output-message) slot.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | -------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `itemId` | `string` | The id of the output-message item this slot accumulates. | [src/batteries/llm/openai\\_responses/types.ts:537](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L537) |\n| `kind` | `\"text\"` | Slot-kind discriminator; always `'text'`. | [src/batteries/llm/openai\\_responses/types.ts:535](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L535) |\n| `refusal` | `string` | Accumulated refusal text so far. | [src/batteries/llm/openai\\_responses/types.ts:541](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L541) |\n| `text` | `string` | Accumulated output text so far. | [src/batteries/llm/openai\\_responses/types.ts:539](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L539) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesThinkingSlot","title":"Interface: ResponsesThinkingSlot","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesThinkingSlot.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesThinkingSlot","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesThinkingSlot.md\ndescription: A streaming reasoning (\"thinking\") slot.\n---\n\n# Interface: ResponsesThinkingSlot\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:545](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L545)\n\nA streaming reasoning (\"thinking\") slot.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `encryptedContent?` | `string` | The opaque, provider-signed reasoning payload, once captured on finalization. | [src/batteries/llm/openai\\_responses/types.ts:555](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L555) |\n| `itemId` | `string` | The id of the reasoning item this slot accumulates. | [src/batteries/llm/openai\\_responses/types.ts:549](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L549) |\n| `kind` | `\"thinking\"` | Slot-kind discriminator; always `'thinking'`. | [src/batteries/llm/openai\\_responses/types.ts:547](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L547) |\n| `reasoningText` | `string` | Accumulated full-reasoning text so far. | [src/batteries/llm/openai\\_responses/types.ts:553](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L553) |\n| `summaryText` | `string` | Accumulated reasoning-summary text so far. | [src/batteries/llm/openai\\_responses/types.ts:551](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L551) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesToolCallSlot","title":"Interface: ResponsesToolCallSlot","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesToolCallSlot.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesToolCallSlot","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/interfaces/ResponsesToolCallSlot.md\ndescription: A streaming tool-call slot.\n---\n\n# Interface: ResponsesToolCallSlot\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:559](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L559)\n\nA streaming tool-call slot.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | ------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | `string` | Accumulated (or authoritatively replaced) JSON-encoded arguments string so far. | [src/batteries/llm/openai\\_responses/types.ts:569](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L569) |\n| `callId` | `string` | Correlates this call with its sibling `function_call_output` item. | [src/batteries/llm/openai\\_responses/types.ts:565](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L565) |\n| `itemId` | `string` | The id of the function-call item this slot accumulates. | [src/batteries/llm/openai\\_responses/types.ts:563](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L563) |\n| `kind` | `\"toolCall\"` | Slot-kind discriminator; always `'toolCall'`. | [src/batteries/llm/openai\\_responses/types.ts:561](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L561) |\n| `name` | `string` | The tool name the model called. | [src/batteries/llm/openai\\_responses/types.ts:567](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L567) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesIncludable","title":"Type Alias: OpenAIResponsesIncludable","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesIncludable.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesIncludable","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesIncludable.md\ndescription: Value(s) requestable via the wire `include` array.\n---\n\n# Type Alias: OpenAIResponsesIncludable\n\n```ts\ntype OpenAIResponsesIncludable =\n | \"reasoning.encrypted_content\"\n | \"message.output_text.logprobs\"\n | (string & {});\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:631](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L631)\n\nValue(s) requestable via the wire `include` array.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputContentBlock","title":"Type Alias: OpenAIResponsesInputContentBlock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputContentBlock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputContentBlock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputContentBlock.md\ndescription: >-\n Discriminated union of content block shapes accepted by the OpenAI Responses\n `input` item content array (and, per the API reference, also the shape a\n `function_call_output.output` array entry may take).\n---\n\n# Type Alias: OpenAIResponsesInputContentBlock\n\n```ts\ntype OpenAIResponsesInputContentBlock =\n | {\n text: string;\n type: \"input_text\";\n }\n | {\n detail: \"low\" | \"high\" | \"auto\" | \"original\";\n file_id?: string;\n image_url?: string;\n type: \"input_image\";\n }\n | {\n detail?: \"low\" | \"high\";\n file_data?: string;\n file_id?: string;\n file_url?: string;\n filename?: string;\n type: \"input_file\";\n };\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L78)\n\nDiscriminated union of content block shapes accepted by the OpenAI Responses `input` item\ncontent array (and, per the API reference, also the shape a `function_call_output.output` array\nentry may take).\n\n## Remarks\n\n`input_audio` is deliberately absent — confirmed against the `openai` SDK's own type definitions\n(`ResponseInputContent` has no audio member). Audio media routes through `unsupportedMediaPolicy`,\nunlike `openai_chat_completions`.\n\n`input_file.file_data` uses a full `data:;base64,` data URI (not bare base64) —\nconfirmed via a live probe against the real Responses API (see the battery's design notes).\n`filename` is required alongside `file_data`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputItem","title":"Type Alias: OpenAIResponsesInputItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesInputItem.md\ndescription: >-\n Discriminated union of every item shape this battery sends on the `input`\n array.\n---\n\n# Type Alias: OpenAIResponsesInputItem\n\n```ts\ntype OpenAIResponsesInputItem =\n | OpenAIResponsesMessageItem\n | OpenAIResponsesOutputMessageItem\n | OpenAIResponsesFunctionCallItem\n | OpenAIResponsesFunctionCallOutputItem\n | OpenAIResponsesReasoningItem;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L223)\n\nDiscriminated union of every item shape this battery sends on the `input` array.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputItem","title":"Type Alias: OpenAIResponsesOutputItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputItem.md\ndescription: >-\n Discriminated union of every item shape the Responses API can emit in\n `response.output`.\n---\n\n# Type Alias: OpenAIResponsesOutputItem\n\n```ts\ntype OpenAIResponsesOutputItem =\n | OpenAIResponsesOutputMessageItem\n | OpenAIResponsesFunctionCallItem\n | OpenAIResponsesReasoningItem\n | OpenAIResponsesOpaqueOutputItem;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L231)\n\nDiscriminated union of every item shape the Responses API can emit in `response.output`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputMessageContentPart","title":"Type Alias: OpenAIResponsesOutputMessageContentPart","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputMessageContentPart.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputMessageContentPart","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesOutputMessageContentPart.md\ndescription: One output-message content part.\n---\n\n# Type Alias: OpenAIResponsesOutputMessageContentPart\n\n```ts\ntype OpenAIResponsesOutputMessageContentPart =\n | {\n annotations: unknown[];\n text: string;\n type: \"output_text\";\n }\n | {\n refusal: string;\n type: \"refusal\";\n };\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L120)\n\nOne output-message content part.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesStreamEvent","title":"Type Alias: OpenAIResponsesStreamEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesStreamEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesStreamEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesStreamEvent.md\ndescription: >-\n Discriminated union of every streaming event this battery handles explicitly,\n plus a structural fallback (`{type: string, ...}`) for the many other event\n types the Responses API emits (`response.created`, `response.in_progress`,\n `response.content_part.added/.done`, hosted-tool progress events, etc.) that\n this battery does not act on.\n---\n\n# Type Alias: OpenAIResponsesStreamEvent\n\n```ts\ntype OpenAIResponsesStreamEvent =\n | OpenAIResponsesOutputItemAddedEvent\n | OpenAIResponsesOutputItemDoneEvent\n | OpenAIResponsesOutputTextDeltaEvent\n | OpenAIResponsesOutputTextDoneEvent\n | OpenAIResponsesRefusalDeltaEvent\n | OpenAIResponsesRefusalDoneEvent\n | OpenAIResponsesReasoningSummaryTextDeltaEvent\n | OpenAIResponsesReasoningSummaryTextDoneEvent\n | OpenAIResponsesReasoningTextDeltaEvent\n | OpenAIResponsesReasoningTextDoneEvent\n | OpenAIResponsesFunctionCallArgumentsDeltaEvent\n | OpenAIResponsesFunctionCallArgumentsDoneEvent\n | OpenAIResponsesCompletedEvent\n | OpenAIResponsesIncompleteEvent\n | OpenAIResponsesFailedEvent\n | OpenAIResponsesErrorEvent\n | (OpenAIResponsesStreamEventBase & Record);\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:511](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L511)\n\nDiscriminated union of every streaming event this battery handles explicitly, plus a structural\nfallback (`{type: string, ...}`) for the many other event types the Responses API emits\n(`response.created`, `response.in_progress`, `response.content_part.added/.done`, hosted-tool\nprogress events, etc.) that this battery does not act on.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesTool","title":"Type Alias: OpenAIResponsesTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesTool.md\ndescription: >-\n Wire shape of a single function tool advertised to the model. `name` is\n TOP-LEVEL, unlike Chat Completions' `{type:'function', function:{name, ...}}`\n nesting.\n---\n\n# Type Alias: OpenAIResponsesTool\n\n```ts\ntype OpenAIResponsesTool = {\n description?: string | null;\n name: string;\n parameters: JsonSchema | null;\n strict?: boolean | null;\n type: \"function\";\n};\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L243)\n\nWire shape of a single function tool advertised to the model. `name` is TOP-LEVEL, unlike Chat\nCompletions' `{type:'function', function:{name, ...}}` nesting.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | -------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `description?` | `string` | `null` | Human-readable description of what the tool does, shown to the model. | [src/batteries/llm/openai\\_responses/types.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L249) |\n| `name` | `string` | The tool's name, as the model will reference it in a `function_call` item. | [src/batteries/llm/openai\\_responses/types.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L247) |\n| `parameters` | [`JsonSchema`](../../../../interfaces/JsonSchema.md) | `null` | JSON Schema describing the tool's accepted arguments. | [src/batteries/llm/openai\\_responses/types.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L251) |\n| `strict?` | `boolean` | `null` | Whether the provider should enforce strict schema adherence for this tool's arguments. | [src/batteries/llm/openai\\_responses/types.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L253) |\n| `type` | `\"function\"` | Tool-kind discriminator; always `'function'` for this battery's v1. | [src/batteries/llm/openai\\_responses/types.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L245) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesToolChoice","title":"Type Alias: OpenAIResponsesToolChoice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesToolChoice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesToolChoice","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/OpenAIResponsesToolChoice.md\ndescription: >-\n Tool-choice directive accepted by this battery's v1 (a subset of the full wire\n union).\n---\n\n# Type Alias: OpenAIResponsesToolChoice\n\n```ts\ntype OpenAIResponsesToolChoice =\n | \"none\"\n | \"auto\"\n | \"required\"\n | {\n name: string;\n type: \"function\";\n };\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L257)\n\nTool-choice directive accepted by this battery's v1 (a subset of the full wire union).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ReasoningReplayMode","title":"Type Alias: ReasoningReplayMode","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ReasoningReplayMode.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ReasoningReplayMode","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ReasoningReplayMode.md\ndescription: >-\n Reasoning-replay mode. See {@link\n OpenAIResponsesAdapterOptions.reasoningReplay}.\n---\n\n# Type Alias: ReasoningReplayMode\n\n```ts\ntype ReasoningReplayMode = \"off\" | \"encrypted\" | \"summary-only\";\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:623](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L623)\n\nReasoning-replay mode. See [OpenAIResponsesAdapterOptions.reasoningReplay](../interfaces/OpenAIResponsesAdapterOptions.md#property-reasoningreplay).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ResponsesOutputSlot","title":"Type Alias: ResponsesOutputSlot","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ResponsesOutputSlot.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ResponsesOutputSlot","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/ResponsesOutputSlot.md\ndescription: Union of every tracked per-`output_index` slot kind.\n---\n\n# Type Alias: ResponsesOutputSlot\n\n```ts\ntype ResponsesOutputSlot =\n | ResponsesTextSlot\n | ResponsesThinkingSlot\n | ResponsesToolCallSlot;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:573](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L573)\n\nUnion of every tracked per-`output_index` slot kind.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/SystemPromptChannel","title":"Type Alias: SystemPromptChannel","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/SystemPromptChannel.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/SystemPromptChannel","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/types/type-aliases/SystemPromptChannel.md\ndescription: >-\n Channel the ADK-rendered system prompt is placed on. See {@link\n OpenAIResponsesAdapterOptions.systemPromptChannel}.\n---\n\n# Type Alias: SystemPromptChannel\n\n```ts\ntype SystemPromptChannel = \"instructions\" | \"developer-item\" | \"system-item\";\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/types.ts:626](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/types.ts#L626)\n\nChannel the ADK-rendered system prompt is placed on. See [OpenAIResponsesAdapterOptions.systemPromptChannel](../interfaces/OpenAIResponsesAdapterOptions.md#property-systempromptchannel).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation","title":"@nhtio/adk/batteries/llm/openai\\_responses/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/validation.md'\ndescription: Runtime validation schema and wrapper for OpenAI Responses adapter options.\n---\n\n# @nhtio/adk/batteries/llm/openai\\_responses/validation\n\nRuntime validation schema and wrapper for OpenAI Responses adapter options.\n\n## Remarks\n\nSchema and call-site wrapper for validating `OpenAIResponsesAdapterOptions`. Used at\nconstruction time and at the start of every iteration against the merged options shape\n(stash > executor > constructor). Throws `E_INVALID_OPENAI_RESPONSES_OPTIONS` on failure — same\nhard-fail policy as every other ADK contract.\n\nNotable divergences from the sibling `openai_chat_completions`/`anthropic_messages` schemas:\n\n* NO `instructions` key and NO `store` key at all — both are exclusively adapter-owned (see\n the battery's design notes). `.unknown(false)` rejects them the same way it rejects\n `previous_response_id`/`conversation`/`prompt`/`context_management` — ADK owns history and the\n system prompt on every battery; this one simply has no escape hatch for either.\n* `max_output_tokens` carries `.min(16)` — an undocumented API minimum (`400 Invalid\n 'max_output_tokens'... Expected a value >= 16`) enforced at config time instead of dispatch\n time.\n* `background` only accepts `false`/undefined — `true` is rejected, since this adapter has no\n polling/resumption logic for a queued/in\\_progress background response (see the option's own\n doc comment in types.ts).\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------- | ----------------------------------------------------- |\n| [openAIResponsesOptionsSchema](variables/openAIResponsesOptionsSchema.md) | Validator schema for `OpenAIResponsesAdapterOptions`. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `openAIResponsesOptionsSchema` and returns the resolved options shape. Throws `E_INVALID_OPENAI_RESPONSES_OPTIONS` (carrying the validator's error report on `cause`) on failure. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): OpenAIResponsesAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/validation.ts:271](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/validation.ts#L271)\n\nValidates an arbitrary input against `openAIResponsesOptionsSchema` and returns the resolved\noptions shape. Throws `E_INVALID_OPENAI_RESPONSES_OPTIONS` (carrying the validator's error report\non `cause`) on failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`OpenAIResponsesAdapterOptions`](../../types/interfaces/OpenAIResponsesAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation/variables/openAIResponsesOptionsSchema","title":"Variable: openAIResponsesOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation/variables/openAIResponsesOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/openai_responses/validation/variables/openAIResponsesOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/openai_responses/validation/variables/openAIResponsesOptionsSchema.md\ndescription: Validator schema for `OpenAIResponsesAdapterOptions`.\n---\n\n# Variable: openAIResponsesOptionsSchema\n\n```ts\nconst openAIResponsesOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/openai\\_responses/validation.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/openai_responses/validation.ts#L188)\n\nValidator schema for `OpenAIResponsesAdapterOptions`.\n\n## Remarks\n\nUsed by `validateOptions` at construction time and again at the start of every iteration after\noptions have been merged (stash > executor > constructor). Rejects unknown top-level keys so\ntypos, removed fields, and every server-side-conversation-state key\n(`previous_response_id`/`conversation`/`prompt`/`context_management`) fail loud — as does\n`instructions`/`store`, which are simply not part of this options interface at all (see the\nmodule remarks above).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js","title":"@nhtio/adk/batteries/llm/transformers\\_js","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js.md'\ndescription: >-\n transformers.js LLM adapter battery — dual-environment (Node + browser)\n on-device text generation.\n---\n\n# @nhtio/adk/batteries/llm/transformers\\_js\n\ntransformers.js LLM adapter battery — dual-environment (Node + browser) on-device text generation.\n\n## Remarks\n\nOpinionated LLM battery wrapping `@huggingface/transformers` (transformers.js) — on-device inference\nvia ONNX Runtime, auto-selecting `onnxruntime-node` (native, plain Node) or `onnxruntime-web`\n(WASM + WebGPU). Environment-neutral: NO WebGPU gate.\n\n**transformers.js is text-in / text-out** — it injects tool definitions into the chat template but\ndoes NOT return structured tool calls or reasoning. This battery parses them out of the model's text\nvia the shared, configurable parser layer (`toolCallParser` / `reasoningParser`, both `'auto'` by\ndefault), mirroring how vLLM/SGLang/Ollama do post-hoc, per-family parsing. The bundled defaults\ntarget the small ONNX models that run in transformers.js (Gemma 4 E2B/E4B, gpt-oss:20b,\nQwen3-Instruct, Llama 3.2, SmolLM); a custom parser function is the escape hatch for anything else.\n\nRe-exports the adapter class, every translation helper (each with its `default*` alias), the shared\ntool-call + reasoning parser layer (family parsers, `auto` drivers, resolvers, contract types), the\noption/wire types, the validation schema + `validateOptions`, and the battery-scoped exceptions.\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [MediaOutputExtractorFn](type-aliases/MediaOutputExtractorFn.md) | Extracts generated media from a battery's raw generation result so the adapter can surface it as assistant `Message.attachments`. Injectable + defaulted to absent (no media output) on every LLM battery, mirroring the `toolCallParser` / `reasoningParser` / `decodeMedia` injection seams. |\n| [UnsupportedMediaPolicy](type-aliases/UnsupportedMediaPolicy.md) | Policy for how a Chat-family battery handles a [@nhtio/adk!Media](../../../common/classes/Media.md) instance whose modality the wire protocol cannot natively represent. |\n\n## References\n\n### barePythonicToolCallParser\n\nRe-exports [barePythonicToolCallParser](helpers/variables/barePythonicToolCallParser.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### buildBundledReasoningParsers\n\nRe-exports [buildBundledReasoningParsers](helpers/functions/buildBundledReasoningParsers.md)\n\n***\n\n### buildTransformersJsMessages\n\nRe-exports [buildTransformersJsMessages](helpers/functions/buildTransformersJsMessages.md)\n\n***\n\n### BUNDLED\\_REASONING\\_PARSERS\n\nRe-exports [BUNDLED\\_REASONING\\_PARSERS](helpers/variables/BUNDLED_REASONING_PARSERS.md)\n\n***\n\n### BUNDLED\\_TOOL\\_CALL\\_PARSERS\n\nRe-exports [BUNDLED\\_TOOL\\_CALL\\_PARSERS](helpers/variables/BUNDLED_TOOL_CALL_PARSERS.md)\n\n***\n\n### ChatGenerationOptions\n\nRe-exports [ChatGenerationOptions](helpers/interfaces/ChatGenerationOptions.md)\n\n***\n\n### ChatSampler\n\nRe-exports [ChatSampler](helpers/type-aliases/ChatSampler.md)\n\n***\n\n### createAutoReasoningParser\n\nRe-exports [createAutoReasoningParser](helpers/functions/createAutoReasoningParser.md)\n\n***\n\n### createAutoToolCallParser\n\nRe-exports [createAutoToolCallParser](helpers/functions/createAutoToolCallParser.md)\n\n***\n\n### CreateTransformersJsMultimodal\n\nRe-exports [CreateTransformersJsMultimodal](types/type-aliases/CreateTransformersJsMultimodal.md)\n\n***\n\n### CreateTransformersJsPipeline\n\nRe-exports [CreateTransformersJsPipeline](types/type-aliases/CreateTransformersJsPipeline.md)\n\n***\n\n### createTransformersJsStreamAccumulator\n\nRe-exports [createTransformersJsStreamAccumulator](helpers/functions/createTransformersJsStreamAccumulator.md)\n\n***\n\n### CreateTransformersJsStreamer\n\nRe-exports [CreateTransformersJsStreamer](types/type-aliases/CreateTransformersJsStreamer.md)\n\n***\n\n### DEFAULT\\_REASONING\\_PARSER\\_ORDER\n\nRe-exports [DEFAULT\\_REASONING\\_PARSER\\_ORDER](helpers/variables/DEFAULT_REASONING_PARSER_ORDER.md)\n\n***\n\n### DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER\n\nRe-exports [DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER](helpers/variables/DEFAULT_TOOL_CALL_PARSER_ORDER.md)\n\n***\n\n### defaultBarePythonicToolCallParser\n\nRe-exports [defaultBarePythonicToolCallParser](helpers/variables/defaultBarePythonicToolCallParser.md)\n\n***\n\n### defaultBuildTransformersJsMessages\n\nRe-exports [defaultBuildTransformersJsMessages](helpers/variables/defaultBuildTransformersJsMessages.md)\n\n***\n\n### defaultCreateAutoReasoningParser\n\nRe-exports [defaultCreateAutoReasoningParser](helpers/variables/defaultCreateAutoReasoningParser.md)\n\n***\n\n### defaultCreateAutoToolCallParser\n\nRe-exports [defaultCreateAutoToolCallParser](helpers/variables/defaultCreateAutoToolCallParser.md)\n\n***\n\n### defaultCreateTransformersJsStreamAccumulator\n\nRe-exports [defaultCreateTransformersJsStreamAccumulator](helpers/variables/defaultCreateTransformersJsStreamAccumulator.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultEmitLifecycle\n\nRe-exports [defaultEmitLifecycle](helpers/variables/defaultEmitLifecycle.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultGemmaChannelReasoningParser\n\nRe-exports [defaultGemmaChannelReasoningParser](helpers/variables/defaultGemmaChannelReasoningParser.md)\n\n***\n\n### defaultGemmaToolCallParser\n\nRe-exports [defaultGemmaToolCallParser](helpers/variables/defaultGemmaToolCallParser.md)\n\n***\n\n### defaultGptOssToolCallParser\n\nRe-exports [defaultGptOssToolCallParser](helpers/variables/defaultGptOssToolCallParser.md)\n\n***\n\n### defaultHarmonyAnalysisReasoningParser\n\nRe-exports [defaultHarmonyAnalysisReasoningParser](helpers/variables/defaultHarmonyAnalysisReasoningParser.md)\n\n***\n\n### defaultHermesToolCallParser\n\nRe-exports [defaultHermesToolCallParser](helpers/variables/defaultHermesToolCallParser.md)\n\n***\n\n### defaultLlama3JsonToolCallParser\n\nRe-exports [defaultLlama3JsonToolCallParser](helpers/variables/defaultLlama3JsonToolCallParser.md)\n\n***\n\n### defaultLooseKeyedToolCallParser\n\nRe-exports [defaultLooseKeyedToolCallParser](helpers/variables/defaultLooseKeyedToolCallParser.md)\n\n***\n\n### defaultMediaToTransformersInput\n\nRe-exports [defaultMediaToTransformersInput](helpers/variables/defaultMediaToTransformersInput.md)\n\n***\n\n### defaultMistralToolCallParser\n\nRe-exports [defaultMistralToolCallParser](helpers/variables/defaultMistralToolCallParser.md)\n\n***\n\n### defaultNoneReasoningParser\n\nRe-exports [defaultNoneReasoningParser](helpers/variables/defaultNoneReasoningParser.md)\n\n***\n\n### defaultNoneToolCallParser\n\nRe-exports [defaultNoneToolCallParser](helpers/variables/defaultNoneToolCallParser.md)\n\n***\n\n### defaultPhiToolCallParser\n\nRe-exports [defaultPhiToolCallParser](helpers/variables/defaultPhiToolCallParser.md)\n\n***\n\n### defaultPythonicToolCallParser\n\nRe-exports [defaultPythonicToolCallParser](helpers/variables/defaultPythonicToolCallParser.md)\n\n***\n\n### defaultQwen3CoderToolCallParser\n\nRe-exports [defaultQwen3CoderToolCallParser](helpers/variables/defaultQwen3CoderToolCallParser.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTransformersJsToolResult\n\nRe-exports [defaultRenderTransformersJsToolResult](helpers/variables/defaultRenderTransformersJsToolResult.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultResolveGenerationOptions\n\nRe-exports [defaultResolveGenerationOptions](helpers/variables/defaultResolveGenerationOptions.md)\n\n***\n\n### defaultResolveReasoningParser\n\nRe-exports [defaultResolveReasoningParser](helpers/variables/defaultResolveReasoningParser.md)\n\n***\n\n### defaultResolveToolCallParser\n\nRe-exports [defaultResolveToolCallParser](helpers/variables/defaultResolveToolCallParser.md)\n\n***\n\n### defaultThinkTagReasoningParser\n\nRe-exports [defaultThinkTagReasoningParser](helpers/variables/defaultThinkTagReasoningParser.md)\n\n***\n\n### defaultToolsToTransformersJsTools\n\nRe-exports [defaultToolsToTransformersJsTools](helpers/variables/defaultToolsToTransformersJsTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS](exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md)\n\n***\n\n### E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY\n\nRe-exports [E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY](../chat_common/exceptions/variables/E_LLM_GPU_OUT_OF_MEMORY.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR](exceptions/variables/E_TRANSFORMERS_JS_STREAM_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED](exceptions/variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED.md)\n\n***\n\n### E\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_UNSUPPORTED\\_MEDIA\\_MODALITY](exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### emitLifecycle\n\nRe-exports [emitLifecycle](helpers/functions/emitLifecycle.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](../openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### gemmaChannelReasoningParser\n\nRe-exports [gemmaChannelReasoningParser](helpers/variables/gemmaChannelReasoningParser.md)\n\n***\n\n### gemmaToolCallParser\n\nRe-exports [gemmaToolCallParser](helpers/variables/gemmaToolCallParser.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### GENERATION\\_DEFAULTS\n\nRe-exports [GENERATION\\_DEFAULTS](helpers/variables/GENERATION_DEFAULTS.md)\n\n***\n\n### gptOssToolCallParser\n\nRe-exports [gptOssToolCallParser](helpers/variables/gptOssToolCallParser.md)\n\n***\n\n### GpuBudget\n\nRe-exports [GpuBudget](helpers/interfaces/GpuBudget.md)\n\n***\n\n### GpuBufferInstrument\n\nRe-exports [GpuBufferInstrument](helpers/interfaces/GpuBufferInstrument.md)\n\n***\n\n### GpuBufferSample\n\nRe-exports [GpuBufferSample](helpers/interfaces/GpuBufferSample.md)\n\n***\n\n### harmonyAnalysisReasoningParser\n\nRe-exports [harmonyAnalysisReasoningParser](helpers/variables/harmonyAnalysisReasoningParser.md)\n\n***\n\n### hermesToolCallParser\n\nRe-exports [hermesToolCallParser](helpers/variables/hermesToolCallParser.md)\n\n***\n\n### installModelSource\n\nRe-exports [installModelSource](model_source/functions/installModelSource.md)\n\n***\n\n### instrumentGpuBuffers\n\nRe-exports [instrumentGpuBuffers](helpers/functions/instrumentGpuBuffers.md)\n\n***\n\n### isGpuOutOfMemoryError\n\nRe-exports [isGpuOutOfMemoryError](helpers/functions/isGpuOutOfMemoryError.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### JsonValue\n\nRe-exports [JsonValue](helpers/type-aliases/JsonValue.md)\n\n***\n\n### llama3JsonToolCallParser\n\nRe-exports [llama3JsonToolCallParser](helpers/variables/llama3JsonToolCallParser.md)\n\n***\n\n### looseKeyedToolCallParser\n\nRe-exports [looseKeyedToolCallParser](helpers/variables/looseKeyedToolCallParser.md)\n\n***\n\n### makeGemmaChannelReasoningParser\n\nRe-exports [makeGemmaChannelReasoningParser](helpers/functions/makeGemmaChannelReasoningParser.md)\n\n***\n\n### makeHarmonyAnalysisReasoningParser\n\nRe-exports [makeHarmonyAnalysisReasoningParser](helpers/functions/makeHarmonyAnalysisReasoningParser.md)\n\n***\n\n### makeThinkTagReasoningParser\n\nRe-exports [makeThinkTagReasoningParser](helpers/functions/makeThinkTagReasoningParser.md)\n\n***\n\n### mediaToTransformersInput\n\nRe-exports [mediaToTransformersInput](helpers/functions/mediaToTransformersInput.md)\n\n***\n\n### mistralToolCallParser\n\nRe-exports [mistralToolCallParser](helpers/variables/mistralToolCallParser.md)\n\n***\n\n### modelSourceToCache\n\nRe-exports [modelSourceToCache](model_source/functions/modelSourceToCache.md)\n\n***\n\n### noneReasoningParser\n\nRe-exports [noneReasoningParser](helpers/variables/noneReasoningParser.md)\n\n***\n\n### noneToolCallParser\n\nRe-exports [noneToolCallParser](helpers/variables/noneToolCallParser.md)\n\n***\n\n### ParsedToolCall\n\nRe-exports [ParsedToolCall](helpers/interfaces/ParsedToolCall.md)\n\n***\n\n### parseResourceKey\n\nRe-exports [parseResourceKey](model_source/functions/parseResourceKey.md)\n\n***\n\n### phiToolCallParser\n\nRe-exports [phiToolCallParser](helpers/variables/phiToolCallParser.md)\n\n***\n\n### probeGpuBudget\n\nRe-exports [probeGpuBudget](helpers/functions/probeGpuBudget.md)\n\n***\n\n### pythonicToolCallParser\n\nRe-exports [pythonicToolCallParser](helpers/variables/pythonicToolCallParser.md)\n\n***\n\n### qwen3CoderToolCallParser\n\nRe-exports [qwen3CoderToolCallParser](helpers/variables/qwen3CoderToolCallParser.md)\n\n***\n\n### RawGenerationObservation\n\nRe-exports [RawGenerationObservation](../../interfaces/RawGenerationObservation.md)\n\n***\n\n### RawGenerationObserverFn\n\nRe-exports [RawGenerationObserverFn](../../type-aliases/RawGenerationObserverFn.md)\n\n***\n\n### ReasoningParseResult\n\nRe-exports [ReasoningParseResult](helpers/interfaces/ReasoningParseResult.md)\n\n***\n\n### ReasoningParserFn\n\nRe-exports [ReasoningParserFn](helpers/type-aliases/ReasoningParserFn.md)\n\n***\n\n### ReasoningParserName\n\nRe-exports [ReasoningParserName](helpers/type-aliases/ReasoningParserName.md)\n\n***\n\n### ReasoningParserOptions\n\nRe-exports [ReasoningParserOptions](helpers/interfaces/ReasoningParserOptions.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTransformersJsToolResult\n\nRe-exports [renderTransformersJsToolResult](helpers/functions/renderTransformersJsToolResult.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### ResolvedGenerationOptions\n\nRe-exports [ResolvedGenerationOptions](helpers/interfaces/ResolvedGenerationOptions.md)\n\n***\n\n### resolveGenerationOptions\n\nRe-exports [resolveGenerationOptions](helpers/functions/resolveGenerationOptions.md)\n\n***\n\n### resolveReasoningParser\n\nRe-exports [resolveReasoningParser](helpers/functions/resolveReasoningParser.md)\n\n***\n\n### resolveToolCallParser\n\nRe-exports [resolveToolCallParser](helpers/functions/resolveToolCallParser.md)\n\n***\n\n### thinkTagReasoningParser\n\nRe-exports [thinkTagReasoningParser](helpers/variables/thinkTagReasoningParser.md)\n\n***\n\n### ToolCallParserContext\n\nRe-exports [ToolCallParserContext](helpers/interfaces/ToolCallParserContext.md)\n\n***\n\n### ToolCallParseResult\n\nRe-exports [ToolCallParseResult](helpers/interfaces/ToolCallParseResult.md)\n\n***\n\n### ToolCallParserFn\n\nRe-exports [ToolCallParserFn](helpers/type-aliases/ToolCallParserFn.md)\n\n***\n\n### ToolCallParserName\n\nRe-exports [ToolCallParserName](helpers/type-aliases/ToolCallParserName.md)\n\n***\n\n### toolsToTransformersJsTools\n\nRe-exports [toolsToTransformersJsTools](helpers/functions/toolsToTransformersJsTools.md)\n\n***\n\n### TransformersJsAdapter\n\nRe-exports [TransformersJsAdapter](adapter/classes/TransformersJsAdapter.md)\n\n***\n\n### TransformersJsAdapterOptions\n\nRe-exports [TransformersJsAdapterOptions](types/interfaces/TransformersJsAdapterOptions.md)\n\n***\n\n### TransformersJsBucketOrder\n\nRenames and re-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### TransformersJsDataType\n\nRe-exports [TransformersJsDataType](types/type-aliases/TransformersJsDataType.md)\n\n***\n\n### TransformersJsDescriptionLike\n\nRe-exports [TransformersJsDescriptionLike](types/type-aliases/TransformersJsDescriptionLike.md)\n\n***\n\n### TransformersJsDevice\n\nRe-exports [TransformersJsDevice](types/type-aliases/TransformersJsDevice.md)\n\n***\n\n### TransformersJsDeviceType\n\nRe-exports [TransformersJsDeviceType](types/type-aliases/TransformersJsDeviceType.md)\n\n***\n\n### TransformersJsDtype\n\nRe-exports [TransformersJsDtype](types/type-aliases/TransformersJsDtype.md)\n\n***\n\n### TransformersJsHelpers\n\nRenames and re-exports [ChatCompletionsHelpers](../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### TransformersJsJsonSchema\n\nRe-exports [TransformersJsJsonSchema](types/type-aliases/TransformersJsJsonSchema.md)\n\n***\n\n### TransformersJsMessage\n\nRe-exports [TransformersJsMessage](types/type-aliases/TransformersJsMessage.md)\n\n***\n\n### TransformersJsModel\n\nRe-exports [TransformersJsModel](types/type-aliases/TransformersJsModel.md)\n\n***\n\n### TransformersJsModelSource\n\nRe-exports [TransformersJsModelSource](types/type-aliases/TransformersJsModelSource.md)\n\n***\n\n### transformersJsOptionsSchema\n\nRe-exports [transformersJsOptionsSchema](validation/variables/transformersJsOptionsSchema.md)\n\n***\n\n### TransformersJsPipeline\n\nRe-exports [TransformersJsPipeline](types/type-aliases/TransformersJsPipeline.md)\n\n***\n\n### TransformersJsProcessor\n\nRe-exports [TransformersJsProcessor](types/type-aliases/TransformersJsProcessor.md)\n\n***\n\n### TransformersJsProgressCallback\n\nRe-exports [TransformersJsProgressCallback](types/type-aliases/TransformersJsProgressCallback.md)\n\n***\n\n### TransformersJsSessionOptions\n\nRe-exports [TransformersJsSessionOptions](types/type-aliases/TransformersJsSessionOptions.md)\n\n***\n\n### TransformersJsStreamAccumulator\n\nRe-exports [TransformersJsStreamAccumulator](helpers/interfaces/TransformersJsStreamAccumulator.md)\n\n***\n\n### TransformersJsTextStreamer\n\nRe-exports [TransformersJsTextStreamer](types/type-aliases/TransformersJsTextStreamer.md)\n\n***\n\n### TransformersJsTool\n\nRe-exports [TransformersJsTool](helpers/interfaces/TransformersJsTool.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n\n***\n\n### withModelSource\n\nRe-exports [withModelSource](model_source/functions/withModelSource.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter","title":"@nhtio/adk/batteries/llm/transformers\\_js/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/adapter.md'\ndescription: >-\n Dual-environment (Node + browser) executor adapter for transformers.js\n (`@huggingface/transformers`).\n---\n\n# @nhtio/adk/batteries/llm/transformers\\_js/adapter\n\nDual-environment (Node + browser) executor adapter for transformers.js (`@huggingface/transformers`).\n\n## Remarks\n\nOn-device text generation via ONNX Runtime — `onnxruntime-node` (native) in Node, `onnxruntime-web`\n(WASM + WebGPU) in the browser, auto-selected by the package. So this battery is\n**environment-neutral**: it does NOT gate on WebGPU.\n\n**transformers.js is text-in / text-out.** It injects tool definitions into the chat template but\ndoes NOT return structured tool calls or reasoning — the model emits both as **family-specific raw\ntext**. This adapter parses them out via the shared, configurable parser layer (`toolCallParser` /\n`reasoningParser`, both defaulting to `'auto'`): after generation, the reasoning parser pulls\nthinking into ADK Thoughts and the tool-call parser pulls calls into ADK ToolCalls, leaving clean\nprose as the assistant Message.\n\nThree pluggable layers mirror the other LLM batteries: swappable translation helpers, three-layer\noptions merging (constructor → `executor()` overrides → `ctx.stash.transformersJs`), and an\ninjectable/lazy pipeline (`pipeline` or `createPipeline`, defaulting to a dynamic import).\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------------------- | ---------------------------------------------------------------------- |\n| [TransformersJsAdapter](classes/TransformersJsAdapter.md) | Dual-environment executor adapter for transformers.js text generation. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| [\\_\\_extractGeneratedText](functions/extractGeneratedText.md) | Pull the newly-generated assistant text out of a transformers.js text-generation result. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter/classes/TransformersJsAdapter","title":"Class: TransformersJsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter/classes/TransformersJsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter/classes/TransformersJsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/adapter/classes/TransformersJsAdapter.md\ndescription: Dual-environment executor adapter for transformers.js text generation.\n---\n\n# Class: TransformersJsAdapter\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:353](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L353)\n\nDual-environment executor adapter for transformers.js text generation.\n\n## Remarks\n\nConstruct with at least `{ model }`; wire `new TransformersJsAdapter(opts).executor()` into a\n`DispatchRunner` as the `executorCallback`. The pipeline is resolved lazily on first dispatch (or\neagerly via [TransformersJsAdapter.preload](#preload)); pass `pipeline` to inject a pre-built one.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew TransformersJsAdapter(options: unknown): TransformersJsAdapter;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:381](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L381)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------------------------------------- |\n| `options` | `unknown` | Raw adapter options, validated against `transformersJsOptionsSchema`. |\n\n#### Returns\n\n`TransformersJsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md) when `options` are invalid.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------------ | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"transformersJs\"` | The `ctx.stash` key under which per-dispatch option overrides are read. | [src/batteries/llm/transformers\\_js/adapter.ts:355](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L355) |\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L425)\n\nRelease the loaded model's underlying ONNX sessions + GPU/wasm buffers, then drop all cached\nreferences (so the next dispatch re-resolves a fresh pipeline).\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\n`reset()` only nulls the JS references — it does NOT free the native ONNX Runtime sessions or the\nWebGPU/wasm device memory they hold. Those leak until GC, and in a browser session that loads many\nmodels back-to-back (e.g. a full matrix run) the accumulated sessions exhaust the heap, surfacing as\n`Can't create a session … Failed to load external data file … memory copy`. transformers.js exposes\n`PreTrainedModel.dispose()` (\"disposes of all the ONNX sessions created during inference\") and\n`Pipeline.dispose()` — this awaits them so the memory is actually reclaimed between loads. Settles any\nin-flight load first, swallows per-handle disposal errors (a half-loaded model must not throw out of\nteardown), and finishes with `reset()`. Idempotent and safe to call when nothing is loaded.\n\n***\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:697](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L697)\n\nProduce the bound [DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) the `DispatchRunner` invokes.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`TransformersJsAdapterOptions`](../../types/interfaces/TransformersJsAdapterOptions.md)> | Option overrides layered above the constructor baseline (below `ctx.stash`). |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:387](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L387)\n\nInstance availability probe (honours the `isAvailable` option override).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(overrides?: Partial): Promise;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:396](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L396)\n\nEagerly resolve (load) the pipeline before the first dispatch.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`TransformersJsAdapterOptions`](../../types/interfaces/TransformersJsAdapterOptions.md)> | Optional option overrides applied for this load. |\n\n#### Returns\n\n`Promise`<`TextGenerationPipeline`>\n\n***\n\n### recycle()\n\n```ts\nrecycle(overrides?: Partial): Promise;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:463](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L463)\n\nFree the WebGPU buffer cache by releasing the model's ONNX sessions, then reload the same model.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`TransformersJsAdapterOptions`](../../types/interfaces/TransformersJsAdapterOptions.md)> | Optional option overrides applied to the reload (same as [preload](#preload)). |\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\nThe consumer-facing lever for the ONNX Runtime Web WebGPU **buffer-freelist high-water-mark** (see\n@nhtio/adk/batteries!probeGpuBudget and the battery's GPU-budget notes). ORT-web parks freed\nactivation buffers in per-size buckets sized to the largest tensor shape the model has run; the pool\nis flushed ONLY when every session of the model is released (ORT clears the cache at\n`sessionCount === 0`; microsoft/onnxruntime#22490). There is no public flag to flush it mid-life, so\nthe supported way to reclaim that retained working-set without permanently unloading the model is to\ndispose the sessions and load again.\n\nThis is exactly `dispose()` followed by `preload()` — surfaced as a named method because \"recycle to\nfree the GPU buffer cache\" is a distinct, intentional operation (e.g. an application offering a\n\"free GPU memory\" action after a @nhtio/adk/batteries!E\\_LLM\\_GPU\\_OUT\\_OF\\_MEMORY), not a\nteardown. It is NOT invoked automatically by the battery — the ADK surfaces the lever and leaves the\ndecision to the consumer. Re-incurs the cold-load cost (download is cached; the WebGPU graph/shader\ncompile is not). Idempotent.\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:404](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L404)\n\nDrop the cached pipeline/engine and any in-flight load so the next dispatch re-resolves it.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:373](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L373)\n\nWhether this battery is available. transformers.js is environment-neutral (Node + browser), so this\nis `true` whenever the runtime can import the peer — there is no WebGPU requirement. Static form\nreturns `true`; the instance form honours an injected `isAvailable` override.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter/functions/extractGeneratedText","title":"Function: \\_\\_extractGeneratedText()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter/functions/extractGeneratedText.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/adapter/functions/extractGeneratedText","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/adapter/functions/extractGeneratedText.md\n---\n\n# Function: \\_\\_extractGeneratedText()\n\n```ts\nfunction __extractGeneratedText(output: unknown): string;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/adapter.ts:1384](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/adapter.ts#L1384)\n\nPull the newly-generated assistant text out of a transformers.js text-generation result.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `output` | `unknown` |\n\n## Returns\n\n`string`\n\n## Remarks\n\nChat input → `[{ generated_text: Message[] }]` (the last message is the new assistant turn);\nstring input → `[{ generated_text: string }]`. We always send chat input, so we take the last\nmessage's content, falling back defensively to a string `generated_text`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions","title":"@nhtio/adk/batteries/llm/transformers\\_js/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/exceptions.md'\ndescription: Battery-scoped exception constructors for the transformers.js LLM adapter.\n---\n\n# @nhtio/adk/batteries/llm/transformers\\_js/exceptions\n\nBattery-scoped exception constructors for the transformers.js LLM adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the transformers.js (`@huggingface/transformers`) LLM adapter,\nminted via `createException` from `@nhtio/adk/factories` and re-exported from the battery barrel.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS](variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md) | Thrown when the resolved adapter options (constructor, executor overrides, or per-dispatch `stash.transformersJs`) fail validation against `transformersJsOptionsSchema`. |\n| [E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW](variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW.md) | Thrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised when `tokenEncoding` is non-null. |\n| [E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS.md) | Raised when a tool call parsed out of model output carries malformed arguments (not a JSON object). |\n| [E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR](variables/E_TRANSFORMERS_JS_STREAM_ERROR.md) | Thrown when the transformers.js pipeline fails to load (e.g. the `@huggingface/transformers` peer is not installed) or the generation call errors. Non-fatal — surfaced via `ctx.nack(...)`. |\n| [E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED](variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED.md) | Raised when the model emitted text that looked like a tool call but no configured parser could extract a well-formed call from it. |\n| [E\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_UNSUPPORTED_MEDIA_MODALITY.md) | Raised when a [@nhtio/adk!Media](../../../../common/classes/Media.md) instance whose modality the configured model cannot consume reaches the adapter under `unsupportedMediaPolicy: 'throw'`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS","title":"Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options (constructor, executor overrides, or\n per-dispatch `stash.transformersJs`) fail validation against\n `transformersJsOptionsSchema`.\n---\n\n# Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS\n\n```ts\nconst E_INVALID_TRANSFORMERS_JS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/exceptions.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/exceptions.ts#L17)\n\nThrown when the resolved adapter options (constructor, executor overrides, or per-dispatch\n`stash.transformersJs`) fail validation against `transformersJsOptionsSchema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW","title":"Variable: E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the total token weight of the resolved request exceeds\n `contextWindow`. Only raised when `tokenEncoding` is non-null.\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_TRANSFORMERS_JS_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/exceptions.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/exceptions.ts#L29)\n\nThrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised\nwhen `tokenEncoding` is non-null.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS.md\ndescription: >-\n Raised when a tool call parsed out of model output carries malformed arguments\n (not a JSON object).\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS: CreatedException<\n [string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/exceptions.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/exceptions.ts#L57)\n\nRaised when a tool call parsed out of model output carries malformed arguments (not a JSON object).\n\n## Remarks\n\nNon-fatal. The adapter does NOT throw it — it instantiates it inside `executeAndPersistToolCall`,\npulls `.message` into a [@nhtio/adk!Tokenizable](../../../../../common/classes/Tokenizable.md), and persists a `ToolCall` with\n`isError: true` so the model can self-correct. Printf args: `[reasonHeadline, rawArgs]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_STREAM_ERROR","title":"Variable: E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_STREAM_ERROR.md\ndescription: >-\n Thrown when the transformers.js pipeline fails to load (e.g. the\n `@huggingface/transformers` peer is not installed) or the generation call\n errors. Non-fatal — surfaced via `ctx.nack(...)`.\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_STREAM\\_ERROR\n\n```ts\nconst E_TRANSFORMERS_JS_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/exceptions.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/exceptions.ts#L41)\n\nThrown when the transformers.js pipeline fails to load (e.g. the `@huggingface/transformers` peer\nis not installed) or the generation call errors. Non-fatal — surfaced via `ctx.nack(...)`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED","title":"Variable: E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TOOL_PARSE_FAILED.md\ndescription: >-\n Raised when the model emitted text that looked like a tool call but no\n configured parser could extract a well-formed call from it.\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_TOOL\\_PARSE\\_FAILED\n\n```ts\nconst E_TRANSFORMERS_JS_TOOL_PARSE_FAILED: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/exceptions.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/exceptions.ts#L74)\n\nRaised when the model emitted text that looked like a tool call but no configured parser could\nextract a well-formed call from it.\n\n## Remarks\n\nNon-fatal. The adapter persists a `ToolCall` with `isError: true` carrying this message so the\nmodel self-corrects on the next iteration (e.g. switch the `toolCallParser` option to match the\nmodel family, or supply a custom parser). Printf args: `[parserName, rawTextExcerpt]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Raised when a {@link @nhtio/adk!Media} instance whose modality the configured\n model cannot consume reaches the adapter under `unsupportedMediaPolicy:\n 'throw'`.\n---\n\n# Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_UNSUPPORTED_MEDIA_MODALITY: CreatedException<[string, string, string]>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/exceptions.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/exceptions.ts#L89)\n\nRaised when a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality the configured model cannot consume\nreaches the adapter under `unsupportedMediaPolicy: 'throw'`.\n\n## Remarks\n\nPrintf args: `[kind, mimeType, filename]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers","title":"@nhtio/adk/batteries/llm/transformers\\_js/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers.md'\ndescription: Translation helpers for the transformers.js LLM adapter.\n---\n\n# @nhtio/adk/batteries/llm/transformers\\_js/helpers\n\nTranslation helpers for the transformers.js LLM adapter.\n\n## Remarks\n\nTwo layers, like the other LLM batteries:\n\n1. **Re-exported format-agnostic helpers** from `chat_common` (string/trust-envelope renderers,\n the joi→JSON-Schema converter, thought rendering/filtering) — reused verbatim.\n2. **transformers.js-native mappers** defined here — building the `{role,content}[]` message array\n * the `tools` definitions, and a stream accumulator that collects decoded text (parsing of tool\n calls / reasoning happens once after the stream drains, via the shared parser layer).\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [BatteryLifecycleHooks](interfaces/BatteryLifecycleHooks.md) | The opt-in lifecycle option block mixed into each battery's options interface. Every phase transition fires [onLifecycle](interfaces/BatteryLifecycleHooks.md#property-onlifecycle) (the firehose) AND the matching per-phase hook; subscribe to either or both. All optional — omitting them leaves behavior byte-for-byte unchanged. |\n| [BatteryLifecycleReport](interfaces/BatteryLifecycleReport.md) | A single normalized lifecycle report. |\n| [ChatGenerationOptions](interfaces/ChatGenerationOptions.md) | The canonical generation options both on-device batteries accept. Every field optional + defaulted. |\n| [GpuBudget](interfaces/GpuBudget.md) | A snapshot of the WebGPU device's memory budget, as reported by the adapter/device limits. |\n| [GpuBufferInstrument](interfaces/GpuBufferInstrument.md) | A handle returned by [instrumentGpuBuffers](functions/instrumentGpuBuffers.md): read live samples, then `uninstall()` to restore. |\n| [GpuBufferSample](interfaces/GpuBufferSample.md) | A live GPU-memory sample taken by a [GpuBufferInstrument](interfaces/GpuBufferInstrument.md). |\n| [ParsedToolCall](interfaces/ParsedToolCall.md) | A single tool call extracted from model output. `arguments` is a parsed object, never a string. |\n| [ReasoningParseResult](interfaces/ReasoningParseResult.md) | The result of running a [ReasoningParserFn](type-aliases/ReasoningParserFn.md) over assistant text. |\n| [ReasoningParserOptions](interfaces/ReasoningParserOptions.md) | Options shared by the bundled reasoning parsers. |\n| [ResolvedGenerationOptions](interfaces/ResolvedGenerationOptions.md) | The resolved, fully-defaulted generation config the adapters consume. |\n| [ToolCallParserContext](interfaces/ToolCallParserContext.md) | Context passed to a parser: the names of the tools actually offered this turn. |\n| [ToolCallParseResult](interfaces/ToolCallParseResult.md) | The result of running a [ToolCallParserFn](type-aliases/ToolCallParserFn.md) over assistant text. |\n| [TransformersJsStreamAccumulator](interfaces/TransformersJsStreamAccumulator.md) | A streaming accumulator over transformers.js `TextStreamer` decoded-text deltas. |\n| [TransformersJsTool](interfaces/TransformersJsTool.md) | A tool definition in the transformers.js `tools` array (OpenAI-function-shaped). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [BatteryLifecycleBattery](type-aliases/BatteryLifecycleBattery.md) | Which battery emitted a lifecycle report. |\n| [BatteryLifecycleCallback](type-aliases/BatteryLifecycleCallback.md) | A lifecycle report consumer. |\n| [BatteryLifecyclePhase](type-aliases/BatteryLifecyclePhase.md) | The coarse lifecycle phases a battery transitions through. |\n| [ChatSampler](type-aliases/ChatSampler.md) | The portable sampler strategy. Maps to each battery's native mechanism: - `'greedy'` — deterministic argmax. transformers.js `do_sample:false`; LiteRT `SamplerType.GREEDY` (which is top-1, so `k` is forced to 1). - `'top-k'` — sample from the top-`k` logits. transformers.js `do_sample:true`+`top_k`; LiteRT `SamplerType.TOP_K`+`k`. - `'top-p'` — nucleus sampling. transformers.js `do_sample:true`+`top_p`; LiteRT `SamplerType.TOP_P`+`p`. |\n| [JsonValue](type-aliases/JsonValue.md) | A JSON-serialisable value — the shape of parsed tool-call arguments. |\n| [ReasoningParserFn](type-aliases/ReasoningParserFn.md) | A synchronous reasoning text parser. |\n| [ReasoningParserName](type-aliases/ReasoningParserName.md) | The bundled reasoning parser names, plus `'auto'` (try-all) and `'none'` (disable). |\n| [ToolCallParserFn](type-aliases/ToolCallParserFn.md) | A synchronous tool-call text parser. |\n| [ToolCallParserName](type-aliases/ToolCallParserName.md) | The bundled family parser names, plus `'auto'` (try-all) and `'none'` (disable). |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------------------------- | --------- | ------ | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | ---------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---- | ----------------------------------------------------------------------------------- |\n| [barePythonicToolCallParser](variables/barePythonicToolCallParser.md) | Parse a BARE pythonic call — `provide_answer(answer=“…”, sources=[“/x”])` — i.e. the pythonic `NAME(kwargs)` form WITHOUT the surrounding `[ … ]` list wrapper that [pythonicToolCallParser](variables/pythonicToolCallParser.md) requires. Small models (observed: Gemma-4 E2B via transformers.js) emit this for a single call, sometimes with a leading `/`, a `call:` prefix, or smart quotes in the args. |\n| [BUNDLED\\_REASONING\\_PARSERS](variables/BUNDLED_REASONING_PARSERS.md) | The bundled reasoning parsers keyed by name (excluding `'auto'`/`'none'`), orphan recovery ON. |\n| [BUNDLED\\_TOOL\\_CALL\\_PARSERS](variables/BUNDLED_TOOL_CALL_PARSERS.md) | The bundled family parsers keyed by name (excluding `'auto'`/`'none'`). |\n| [DEFAULT\\_REASONING\\_PARSER\\_ORDER](variables/DEFAULT_REASONING_PARSER_ORDER.md) | The default `'auto'` precedence. All three are literal-marker-anchored, so order is collision-free. |\n| [DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER](variables/DEFAULT_TOOL_CALL_PARSER_ORDER.md) | The default `'auto'` precedence. Marker-anchored families first (collision-free); the weak-signal pythonic/llama3\\_json forms run last and are gated on callee∈toolNames. |\n| [defaultBarePythonicToolCallParser](variables/defaultBarePythonicToolCallParser.md) | Default [barePythonicToolCallParser](variables/barePythonicToolCallParser.md). |\n| [defaultBuildTransformersJsMessages](variables/defaultBuildTransformersJsMessages.md) | Default [buildTransformersJsMessages](functions/buildTransformersJsMessages.md). |\n| [defaultCreateAutoReasoningParser](variables/defaultCreateAutoReasoningParser.md) | Default [createAutoReasoningParser](functions/createAutoReasoningParser.md). |\n| [defaultCreateAutoToolCallParser](variables/defaultCreateAutoToolCallParser.md) | Default [createAutoToolCallParser](functions/createAutoToolCallParser.md). |\n| [defaultCreateTransformersJsStreamAccumulator](variables/defaultCreateTransformersJsStreamAccumulator.md) | Default [createTransformersJsStreamAccumulator](functions/createTransformersJsStreamAccumulator.md). |\n| [defaultEmitLifecycle](variables/defaultEmitLifecycle.md) | Default [emitLifecycle](functions/emitLifecycle.md). |\n| [defaultGemmaChannelReasoningParser](variables/defaultGemmaChannelReasoningParser.md) | Default [gemmaChannelReasoningParser](variables/gemmaChannelReasoningParser.md). |\n| [defaultGemmaToolCallParser](variables/defaultGemmaToolCallParser.md) | Default [gemmaToolCallParser](variables/gemmaToolCallParser.md). |\n| [defaultGptOssToolCallParser](variables/defaultGptOssToolCallParser.md) | Default [gptOssToolCallParser](variables/gptOssToolCallParser.md). |\n| [defaultHarmonyAnalysisReasoningParser](variables/defaultHarmonyAnalysisReasoningParser.md) | Default [harmonyAnalysisReasoningParser](variables/harmonyAnalysisReasoningParser.md). |\n| [defaultHermesToolCallParser](variables/defaultHermesToolCallParser.md) | Default [hermesToolCallParser](variables/hermesToolCallParser.md). |\n| [defaultLlama3JsonToolCallParser](variables/defaultLlama3JsonToolCallParser.md) | Default [llama3JsonToolCallParser](variables/llama3JsonToolCallParser.md). |\n| [defaultLooseKeyedToolCallParser](variables/defaultLooseKeyedToolCallParser.md) | Default [looseKeyedToolCallParser](variables/looseKeyedToolCallParser.md). |\n| [defaultMediaToTransformersInput](variables/defaultMediaToTransformersInput.md) | Default [mediaToTransformersInput](functions/mediaToTransformersInput.md). |\n| [defaultMistralToolCallParser](variables/defaultMistralToolCallParser.md) | Default [mistralToolCallParser](variables/mistralToolCallParser.md). |\n| [defaultNoneReasoningParser](variables/defaultNoneReasoningParser.md) | Default [noneReasoningParser](variables/noneReasoningParser.md). |\n| [defaultNoneToolCallParser](variables/defaultNoneToolCallParser.md) | Default [noneToolCallParser](variables/noneToolCallParser.md). |\n| [defaultPhiToolCallParser](variables/defaultPhiToolCallParser.md) | Default [phiToolCallParser](variables/phiToolCallParser.md). |\n| [defaultPythonicToolCallParser](variables/defaultPythonicToolCallParser.md) | Default [pythonicToolCallParser](variables/pythonicToolCallParser.md). |\n| [defaultQwen3CoderToolCallParser](variables/defaultQwen3CoderToolCallParser.md) | Default [qwen3CoderToolCallParser](variables/qwen3CoderToolCallParser.md). |\n| [defaultRenderArtifactHandleBody](variables/defaultRenderArtifactHandleBody.md) | Default handle-body renderer for tool-call artifacts; the `renderArtifactHandleBody` override falls back to this. |\n| [defaultRenderTransformersJsToolResult](variables/defaultRenderTransformersJsToolResult.md) | Default [renderTransformersJsToolResult](functions/renderTransformersJsToolResult.md). |\n| [defaultResolveGenerationOptions](variables/defaultResolveGenerationOptions.md) | Default [resolveGenerationOptions](functions/resolveGenerationOptions.md). |\n| [defaultResolveReasoningParser](variables/defaultResolveReasoningParser.md) | Default [resolveReasoningParser](functions/resolveReasoningParser.md). |\n| [defaultResolveToolCallParser](variables/defaultResolveToolCallParser.md) | Default [resolveToolCallParser](functions/resolveToolCallParser.md). |\n| [defaultThinkTagReasoningParser](variables/defaultThinkTagReasoningParser.md) | Default [thinkTagReasoningParser](variables/thinkTagReasoningParser.md). |\n| [defaultToolsToTransformersJsTools](variables/defaultToolsToTransformersJsTools.md) | Default [toolsToTransformersJsTools](functions/toolsToTransformersJsTools.md). |\n| [gemmaChannelReasoningParser](variables/gemmaChannelReasoningParser.md) | Default [makeGemmaChannelReasoningParser](functions/makeGemmaChannelReasoningParser.md) (orphan recovery on). |\n| [gemmaToolCallParser](variables/gemmaToolCallParser.md) | Parse Gemma E2B/E4B tool calls. Accepts the wrapped template form (`< | tool_call>call:NAME{k:< | \" | >v< | \" | >}`) AND the decoder-stripped runtime form (`call:NAME{k:v}`, special tokens removed, scalars unquoted — the shape a real ONNX run emits), including NESTED argument blocks with curly smart quotes (the form a real E4B `provide_answer`emits:`{answer:< | “ | >…< | ” | >,sources:[{path:…}]}`), AND the PREFIX-LESS bare form `NAME{…}`with no`call:`lead (e.g.`say_i_dont_know{reason: \"…\"}`— a real E2B/E4B runtime shape), gated on`ctx.toolNames`. Targets the E2B/E4B form only — Gemma 3 (`tool_code` fences) and FunctionGemma (``) are out of scope (use a custom [ToolCallParserFn](type-aliases/ToolCallParserFn.md)). |\n| [GENERATION\\_DEFAULTS](variables/GENERATION_DEFAULTS.md) | Deterministic-friendly defaults, identical across batteries. |\n| [gptOssToolCallParser](variables/gptOssToolCallParser.md) | Parse gpt-oss Harmony tool calls on the `commentary` channel: `< | channel | >commentary to=functions.NAME < | constrain | >json< | message | >{…}< | call | >`. The arguments payload after `< | message | >`is JSON, located by a string-aware balanced-brace scan so an embedded`< | call | >` / brace inside a string value survives. Anchored on the literal Harmony markers. |\n| [harmonyAnalysisReasoningParser](variables/harmonyAnalysisReasoningParser.md) | Default [makeHarmonyAnalysisReasoningParser](functions/makeHarmonyAnalysisReasoningParser.md) (orphan recovery on). |\n| [hermesToolCallParser](variables/hermesToolCallParser.md) | Parse Hermes-style `{\"name\":…,\"arguments\":{…}}` tags. The de-facto standard, reused by Qwen2.5/Qwen3-Instruct. Anchored on the literal tags — zero collision with bare JSON. |\n| [llama3JsonToolCallParser](variables/llama3JsonToolCallParser.md) | Parse bare top-level JSON tool call(s) — `{\"name\":\"x\",\"parameters\":{…}}` (or `\"arguments\"`), optionally wrapped in a `json … ` fence (a common small-model emission — verified via the real-model matrix on Qwen2.5-Coder-0.5B). The weakest signal, so it is gated hard: after un-fencing, the output must be ONLY top-level JSON object(s) AND every callee must be a real tool (`ctx.toolNames`). Runs after every marker-anchored family in `'auto'`. |\n| [looseKeyedToolCallParser](variables/looseKeyedToolCallParser.md) | Parse the DEGENERATE keyed form a small instruct model emits when it ignores every structured tool-call grammar: the bare tool NAME on its own line, then one or more `argname: value` lines. |\n| [mistralToolCallParser](variables/mistralToolCallParser.md) | Parse Mistral tool calls — the `[TOOL_CALLS]` token followed by a JSON array of `{ name, arguments }`. Anchored on the literal `[TOOL_CALLS]` token. |\n| [noneReasoningParser](variables/noneReasoningParser.md) | A parser that never extracts anything — disables reasoning parsing entirely. |\n| [noneToolCallParser](variables/noneToolCallParser.md) | A parser that never extracts anything — disables tool-call parsing entirely. |\n| [phiToolCallParser](variables/phiToolCallParser.md) | Parse Phi-4-mini tool calls: the literal `functools` token followed by a JSON array of `{ name, arguments }` objects (e.g. `functools[{\"name\":\"get_weather\",\"arguments\":{\"city\":\"SF\"}}]`). |\n| [pythonicToolCallParser](variables/pythonicToolCallParser.md) | Parse pythonic tool calls — `[get_weather(city='SF'), get_time()]`. Requires the **whole trimmed output** to be the bracketed call list, so it cannot false-positive on incidental prose. Parallel calls are inherent to the format. |\n| [qwen3CoderToolCallParser](variables/qwen3CoderToolCallParser.md) | Parse Qwen3-Coder's custom per-parameter XML — `v …`. Values are taken as trimmed strings (the format is untyped). Anchored on the literal ``. |\n| [thinkTagReasoningParser](variables/thinkTagReasoningParser.md) | Default [makeThinkTagReasoningParser](functions/makeThinkTagReasoningParser.md) (orphan recovery on). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [buildBundledReasoningParsers](functions/buildBundledReasoningParsers.md) | Build the bundled family parsers honouring [ReasoningParserOptions](interfaces/ReasoningParserOptions.md) (e.g. orphan recovery). |\n| [buildTransformersJsMessages](functions/buildTransformersJsMessages.md) | Build the transformers.js `messages` array + `tools` from the ADK dispatch context buckets. |\n| [createAutoReasoningParser](functions/createAutoReasoningParser.md) | Compose an `'auto'` reasoning parser: run each parser in `order` until one returns a non-empty `reasoning` array; that result wins. Returns no-match if none claim the text. |\n| [createAutoToolCallParser](functions/createAutoToolCallParser.md) | Compose an `'auto'` parser: run each family parser in `order` until one returns a non-empty `calls` array; that result wins. Returns no-match if none claim the text. |\n| [createTransformersJsStreamAccumulator](functions/createTransformersJsStreamAccumulator.md) | Create a [TransformersJsStreamAccumulator](interfaces/TransformersJsStreamAccumulator.md). |\n| [emitLifecycle](functions/emitLifecycle.md) | Build a [BatteryLifecycleReport](interfaces/BatteryLifecycleReport.md) (stamping `at`) and dispatch it to the firehose ([BatteryLifecycleHooks.onLifecycle](interfaces/BatteryLifecycleHooks.md#property-onlifecycle)) AND the per-phase hook for `phase`. A no-op when `hooks` is undefined or carries no relevant callbacks. Defensive: each callback is invoked through safeInvoke, so a throwing consumer never disrupts the battery. |\n| [instrumentGpuBuffers](functions/instrumentGpuBuffers.md) | Install an OPT-IN live GPU-buffer instrument by wrapping `GPUDevice.prototype.createBuffer`. |\n| [isGpuOutOfMemoryError](functions/isGpuOutOfMemoryError.md) | Detect the WebGPU \"out of memory / failed to allocate\" family of errors from a message string. |\n| [looksLikeSpooledArtifact](functions/looksLikeSpooledArtifact.md) | Structural (cross-realm-safe) check that a tool result is a [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md): it exposes the reader surface the handle pattern needs (`asString` + `byteLength`/`lineCount`) and a constructor carrying the `toolMethods` descriptor list the model is told to call. Used instead of a bare `instanceof` so a SpooledArtifact from another realm (worker, bundle copy) still matches. |\n| [makeGemmaChannelReasoningParser](functions/makeGemmaChannelReasoningParser.md) | Parse Gemma E2B/E4B reasoning emitted on the thought channel: `< | channel>thought\\n…`. Targets the E2B/E4B delimited form (the transformers.js-runnable one). Reasoning is only emitted when `< | think | >` is injected into the system prompt. Unpaired markers are recovered by default — see [ReasoningParserOptions](interfaces/ReasoningParserOptions.md). |\n| [makeHarmonyAnalysisReasoningParser](functions/makeHarmonyAnalysisReasoningParser.md) | Parse gpt-oss Harmony chain-of-thought on the `analysis` channel: `< | channel | >analysis< | message | >…< | end | >`. (The user-visible answer is the separate `final`channel; tool calls are`commentary` — handled by the tool-call parser.) Unpaired markers are recovered by default — see [ReasoningParserOptions](interfaces/ReasoningParserOptions.md). |\n| [makeThinkTagReasoningParser](functions/makeThinkTagReasoningParser.md) | Parse `…` (and the `…` variant) reasoning blocks — the dominant convention, used by Qwen3, DeepSeek-R1, and most distilled reasoning models. Unpaired markers (a lone `` or a truncated ``) are recovered by default — see [ReasoningParserOptions](interfaces/ReasoningParserOptions.md). |\n| [mediaToTransformersInput](functions/mediaToTransformersInput.md) | Decode an ADK [@nhtio/adk!Media](../../../../common/classes/Media.md) into a transformers.js multimodal input. |\n| [probeGpuBudget](functions/probeGpuBudget.md) | Probe the host WebGPU device for its memory budget (per-allocation ceilings + adapter info). |\n| [renderArtifactHandleBody](functions/renderArtifactHandleBody.md) | Render the \"handle\" body for a tool call's spooled-artifact result marked `inline: false`. See buildHandleBody for the shared mechanics; this variant's leading sentence frames the artifact as a tool result. |\n| [renderTransformersJsToolResult](functions/renderTransformersJsToolResult.md) | Render a [@nhtio/adk!ToolCall](../../../../forge/classes/ToolCall.md)'s `results` into a plain-text tool message body. |\n| [resolveGenerationOptions](functions/resolveGenerationOptions.md) | Resolve the canonical [ChatGenerationOptions](interfaces/ChatGenerationOptions.md) (already merged across option layers) into a fully-defaulted [ResolvedGenerationOptions](interfaces/ResolvedGenerationOptions.md). Native per-battery fallbacks are passed via `nativeFallbacks` and consulted ONLY when the canonical field is absent (canonical wins). The adapter then maps the resolved shape onto its runtime API. |\n| [resolveReasoningParser](functions/resolveReasoningParser.md) | Resolve a `reasoningParser` option (a name, `'auto'`, `'none'`, or a custom fn) to a concrete [ReasoningParserFn](type-aliases/ReasoningParserFn.md). |\n| [resolveToolCallParser](functions/resolveToolCallParser.md) | Resolve a `toolCallParser` option (a name, `'auto'`, `'none'`, or a custom fn) to a concrete [ToolCallParserFn](type-aliases/ToolCallParserFn.md). |\n| [toolsToTransformersJsTools](functions/toolsToTransformersJsTools.md) | Convert ADK [@nhtio/adk!Tool](../../../../forge/classes/Tool.md) / [@nhtio/adk!ArtifactTool](../../../../forge/classes/ArtifactTool.md) instances into the transformers.js `tools` array shape (OpenAI-function-shaped — what `apply_chat_template` expects). |\n\n## References\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievableHandleBody\n\nRe-exports [defaultRenderRetrievableHandleBody](../../webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](../../openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievableHandleBody\n\nRe-exports [renderRetrievableHandleBody](../../webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildBundledReasoningParsers","title":"Function: buildBundledReasoningParsers()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildBundledReasoningParsers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildBundledReasoningParsers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildBundledReasoningParsers.md\n---\n\n# Function: buildBundledReasoningParsers()\n\n```ts\nfunction buildBundledReasoningParsers(\n opts?: ReasoningParserOptions,\n): Record, ReasoningParserFn>;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:284](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L284)\n\nBuild the bundled family parsers honouring [ReasoningParserOptions](../interfaces/ReasoningParserOptions.md) (e.g. orphan recovery).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `opts` | [`ReasoningParserOptions`](../interfaces/ReasoningParserOptions.md) |\n\n## Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ReasoningParserName`](../type-aliases/ReasoningParserName.md), `\"auto\"` | `\"none\"`>, [`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildTransformersJsMessages","title":"Function: buildTransformersJsMessages()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildTransformersJsMessages.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildTransformersJsMessages","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildTransformersJsMessages.md\n---\n\n# Function: buildTransformersJsMessages()\n\n```ts\nfunction buildTransformersJsMessages(input: {\n bucketOrder: ChatCompletionsBucketOrder;\n decodeMedia?: (media: Media) => Promise<{\n data: unknown;\n kind: \"audio\" | \"image\";\n }>;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n multimodal?: {\n audio: boolean;\n image: boolean;\n };\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderHandle:\n | ((input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string)\n | undefined) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n toolsToTransformersJsTools: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n }) => TransformersJsTool[];\n unsupportedMediaPolicy?: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise<{\n audio: unknown[];\n images: unknown[];\n messages: Message[];\n tools: TransformersJsTool[];\n}>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:289](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L289)\n\nBuild the transformers.js `messages` array + `tools` from the ADK dispatch context buckets.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `decodeMedia?`: (`media`: [`Media`](../../../../../common/classes/Media.md)) => `Promise`<{ `data`: `unknown`; `kind`: `\"audio\"` | `\"image\"`; }>; `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `multimodal?`: { `audio`: `boolean`; `image`: `boolean`; }; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `toolsToTransformersJsTools`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[]; `unsupportedMediaPolicy?`: [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.decodeMedia?` | (`media`: [`Media`](../../../../../common/classes/Media.md)) => `Promise`<{ `data`: `unknown`; `kind`: `\"audio\"` | `\"image\"`; }> | Decodes a Media instance to a transformers.js input (RawImage / audio samples). Adapter-injected. |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.multimodal?` | { `audio`: `boolean`; `image`: `boolean`; } | Multimodal config. Absent/false → text-only (every message renders a plain string `content`, the byte-for-byte original behavior). When set, a message carrying `attachments` of an enabled kind renders a content-array (text + `{type:'image' | 'audio'}`placeholders) and the decoded media is collected into`images`/`audio`(consumed positionally by`processor(prompt, images, audio)`). |\n| `input.multimodal.audio` | `boolean` | - |\n| `input.multimodal.image` | `boolean` | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`> | - |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.toolsToTransformersJsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[] | - |\n| `input.unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`audio`: `unknown`\\[];\n`images`: `unknown`\\[];\n`messages`: `Message`\\[];\n`tools`: [`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[];\n}>\n\n## Remarks\n\nLeading buckets (system prompt + standing instructions / memories / retrievables) render into a\nsingle `system` message; the timeline (messages, surviving thoughts, tool calls — chronological)\nrenders into `user`/`assistant`/`tool` messages. Tools are returned separately for the `tools`\ngenerate-kwarg. Mirrors `buildLiteRtConversationInput`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoReasoningParser","title":"Function: createAutoReasoningParser()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoReasoningParser.md\n---\n\n# Function: createAutoReasoningParser()\n\n```ts\nfunction createAutoReasoningParser(\n parsers?: Partial<\n Record, ReasoningParserFn>\n >,\n order?: readonly (\"think_tag\" | \"harmony_analysis\" | \"gemma_channel\")[],\n): ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:301](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L301)\n\nCompose an `'auto'` reasoning parser: run each parser in `order` until one returns a non-empty\n`reasoning` array; that result wins. Returns no-match if none claim the text.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ReasoningParserName`](../type-aliases/ReasoningParserName.md), `\"auto\"` | `\"none\"`>, [`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)>> | `BUNDLED_REASONING_PARSERS` |\n| `order` | readonly (`\"think_tag\"` | `\"harmony_analysis\"` | `\"gemma_channel\"`)\\[] | `DEFAULT_REASONING_PARSER_ORDER` |\n\n## Returns\n\n[`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoToolCallParser","title":"Function: createAutoToolCallParser()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoToolCallParser.md\n---\n\n# Function: createAutoToolCallParser()\n\n```ts\nfunction createAutoToolCallParser(\n parsers?: Partial<\n Record, ToolCallParserFn>\n >,\n order?: readonly (\n | \"gemma\"\n | \"hermes\"\n | \"gpt_oss\"\n | \"pythonic\"\n | \"bare_pythonic\"\n | \"loose_keyed\"\n | \"llama3_json\"\n | \"mistral\"\n | \"qwen3_coder\"\n | \"phi\"\n )[],\n): ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1092](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1092)\n\nCompose an `'auto'` parser: run each family parser in `order` until one returns a non-empty\n`calls` array; that result wins. Returns no-match if none claim the text.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ToolCallParserName`](../type-aliases/ToolCallParserName.md), `\"auto\"` | `\"none\"`>, [`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)>> | `BUNDLED_TOOL_CALL_PARSERS` |\n| `order` | readonly ( | `\"gemma\"` | `\"hermes\"` | `\"gpt_oss\"` | `\"pythonic\"` | `\"bare_pythonic\"` | `\"loose_keyed\"` | `\"llama3_json\"` | `\"mistral\"` | `\"qwen3_coder\"` | `\"phi\"`)\\[] | `DEFAULT_TOOL_CALL_PARSER_ORDER` |\n\n## Returns\n\n[`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createTransformersJsStreamAccumulator","title":"Function: createTransformersJsStreamAccumulator()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createTransformersJsStreamAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createTransformersJsStreamAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createTransformersJsStreamAccumulator.md\n---\n\n# Function: createTransformersJsStreamAccumulator()\n\n```ts\nfunction createTransformersJsStreamAccumulator(): TransformersJsStreamAccumulator;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:600](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L600)\n\nCreate a [TransformersJsStreamAccumulator](../interfaces/TransformersJsStreamAccumulator.md).\n\n## Returns\n\n[`TransformersJsStreamAccumulator`](../interfaces/TransformersJsStreamAccumulator.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/emitLifecycle","title":"Function: emitLifecycle()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/emitLifecycle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/emitLifecycle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/emitLifecycle.md\n---\n\n# Function: emitLifecycle()\n\n```ts\nfunction emitLifecycle(\n hooks: BatteryLifecycleHooks | undefined,\n battery: BatteryLifecycleBattery,\n model: string,\n phase: BatteryLifecyclePhase,\n extra?: Partial<\n Pick<\n BatteryLifecycleReport,\n \"error\" | \"raw\" | \"progress\" | \"detail\" | \"gpuBudget\"\n >\n >,\n now?: () => string,\n): void;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/lifecycle.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L146)\n\nBuild a [BatteryLifecycleReport](../interfaces/BatteryLifecycleReport.md) (stamping `at`) and dispatch it to the firehose\n([BatteryLifecycleHooks.onLifecycle](../interfaces/BatteryLifecycleHooks.md#property-onlifecycle)) AND the per-phase hook for `phase`. A no-op when `hooks`\nis undefined or carries no relevant callbacks. Defensive: each callback is invoked through\nsafeInvoke, so a throwing consumer never disrupts the battery.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |\n| `hooks` | | [`BatteryLifecycleHooks`](../interfaces/BatteryLifecycleHooks.md) | `undefined` | The merged lifecycle hooks (may be undefined). |\n| `battery` | [`BatteryLifecycleBattery`](../type-aliases/BatteryLifecycleBattery.md) | Which battery is emitting. |\n| `model` | `string` | Best-effort model id string. |\n| `phase` | [`BatteryLifecyclePhase`](../type-aliases/BatteryLifecyclePhase.md) | The phase being entered. |\n| `extra?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<[`BatteryLifecycleReport`](../interfaces/BatteryLifecycleReport.md), `\"error\"` | `\"raw\"` | `\"progress\"` | `\"detail\"` | `\"gpuBudget\"`>> | Optional `detail` / `progress` / `raw` / `error` fields. |\n| `now?` | () => `string` | Injectable clock for tests; defaults to luxon `DateTime.now().toISO()`. |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/instrumentGpuBuffers","title":"Function: instrumentGpuBuffers()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/instrumentGpuBuffers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/instrumentGpuBuffers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/instrumentGpuBuffers.md\n---\n\n# Function: instrumentGpuBuffers()\n\n```ts\nfunction instrumentGpuBuffers(globalScope?: unknown): GpuBufferInstrument;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/gpu\\_budget.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L187)\n\nInstall an OPT-IN live GPU-buffer instrument by wrapping `GPUDevice.prototype.createBuffer`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| -------------- | --------- | ------------------------------------------------------ |\n| `globalScope?` | `unknown` | Injectable global for tests; defaults to `globalThis`. |\n\n## Returns\n\n[`GpuBufferInstrument`](../interfaces/GpuBufferInstrument.md)\n\nA [GpuBufferInstrument](../interfaces/GpuBufferInstrument.md); `sample()` returns zeroes when WebGPU is unavailable.\n\n## Remarks\n\nThis is the packaged, productionized form of the diagnostic probe used to PROVE the ORT-web freelist\nhigh-water-mark growth. It wraps `createBuffer` (and the returned buffer's `destroy`) on the device\nprototype to tally live/peak GPU bytes, so an application can watch the working-set climb toward the\n[GpuBudget](../interfaces/GpuBudget.md) ceiling and surface \"you're at X of Y GiB\" — turning the invisible cliff into a\ngauge the user can act on BEFORE the OOM.\n\nIt is **purely observational and strictly opt-in**: nothing in the batteries installs it. Wrapping a\nglobal prototype is intrusive, so this is never on by default — an application enables it consciously\n(typically only in a debug/diagnostics build). Always `uninstall()` when done. Returns a no-op\ninstrument when WebGPU is unavailable (Node / no API).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/isGpuOutOfMemoryError","title":"Function: isGpuOutOfMemoryError()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/isGpuOutOfMemoryError.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/isGpuOutOfMemoryError","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/isGpuOutOfMemoryError.md\n---\n\n# Function: isGpuOutOfMemoryError()\n\n```ts\nfunction isGpuOutOfMemoryError(message: string): boolean;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/gpu\\_budget.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L62)\n\nDetect the WebGPU \"out of memory / failed to allocate\" family of errors from a message string.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | -------------------------------------------------------------------- |\n| `message` | `string` | The error message (or any stringifiable value's `String(...)` form). |\n\n## Returns\n\n`boolean`\n\n`true` when the message matches a known GPU-exhaustion signature.\n\n## Remarks\n\nORT-web surfaces GPU exhaustion through several non-obvious signatures depending on where the\nallocation failed (buffer mapping, device loss, unaligned-access fallback, Dawn validation). This\nmatcher is the single source of truth both on-device batteries use to translate a raw provider throw\ninto a typed, catchable `E_*_GPU_OUT_OF_MEMORY`. Substring/case-insensitive; intentionally broad on\nthe well-known phrases but anchored enough not to swallow unrelated errors. Verified against the\nsignatures observed in the flagship agent's WebGPU OOM repro (Apple Metal, 4 GiB budget).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/looksLikeSpooledArtifact","title":"Function: looksLikeSpooledArtifact()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/looksLikeSpooledArtifact.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/looksLikeSpooledArtifact","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/looksLikeSpooledArtifact.md\n---\n\n# Function: looksLikeSpooledArtifact()\n\n```ts\nfunction looksLikeSpooledArtifact(\n value: unknown,\n): value is {\n asString: () => Promise;\n byteLength: () => Promise;\n lineCount: () => Promise;\n};\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:397](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L397)\n\nStructural (cross-realm-safe) check that a tool result is a [@nhtio/adk!SpooledArtifact](../../../../../spooled_artifact/classes/SpooledArtifact.md): it\nexposes the reader surface the handle pattern needs (`asString` + `byteLength`/`lineCount`) and a\nconstructor carrying the `toolMethods` descriptor list the model is told to call. Used instead of a\nbare `instanceof` so a SpooledArtifact from another realm (worker, bundle copy) still matches.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is { asString: () => Promise; byteLength: () => Promise; lineCount: () => Promise }`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeGemmaChannelReasoningParser","title":"Function: makeGemmaChannelReasoningParser()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeGemmaChannelReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeGemmaChannelReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeGemmaChannelReasoningParser.md\n---\n\n# Function: makeGemmaChannelReasoningParser()\n\n```ts\nfunction makeGemmaChannelReasoningParser(\n opts?: ReasoningParserOptions,\n): ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:250](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L250)\n\nParse Gemma E2B/E4B reasoning emitted on the thought channel:\n`<|channel>thought\\n…`. Targets the E2B/E4B delimited form (the transformers.js-runnable\none). Reasoning is only emitted when `<|think|>` is injected into the system prompt. Unpaired markers\nare recovered by default — see [ReasoningParserOptions](../interfaces/ReasoningParserOptions.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `opts` | [`ReasoningParserOptions`](../interfaces/ReasoningParserOptions.md) |\n\n## Returns\n\n[`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeHarmonyAnalysisReasoningParser","title":"Function: makeHarmonyAnalysisReasoningParser()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeHarmonyAnalysisReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeHarmonyAnalysisReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeHarmonyAnalysisReasoningParser.md\n---\n\n# Function: makeHarmonyAnalysisReasoningParser()\n\n```ts\nfunction makeHarmonyAnalysisReasoningParser(\n opts?: ReasoningParserOptions,\n): ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L222)\n\nParse gpt-oss Harmony chain-of-thought on the `analysis` channel:\n`<|channel|>analysis<|message|>…<|end|>`. (The user-visible answer is the separate `final` channel;\ntool calls are `commentary` — handled by the tool-call parser.) Unpaired markers are recovered by\ndefault — see [ReasoningParserOptions](../interfaces/ReasoningParserOptions.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `opts` | [`ReasoningParserOptions`](../interfaces/ReasoningParserOptions.md) |\n\n## Returns\n\n[`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeThinkTagReasoningParser","title":"Function: makeThinkTagReasoningParser()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeThinkTagReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeThinkTagReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeThinkTagReasoningParser.md\n---\n\n# Function: makeThinkTagReasoningParser()\n\n```ts\nfunction makeThinkTagReasoningParser(\n opts?: ReasoningParserOptions,\n): ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L188)\n\nParse `…` (and the `…` variant) reasoning blocks — the dominant\nconvention, used by Qwen3, DeepSeek-R1, and most distilled reasoning models. Unpaired markers (a lone\n`` or a truncated ``) are recovered by default — see [ReasoningParserOptions](../interfaces/ReasoningParserOptions.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `opts` | [`ReasoningParserOptions`](../interfaces/ReasoningParserOptions.md) |\n\n## Returns\n\n[`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/mediaToTransformersInput","title":"Function: mediaToTransformersInput()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/mediaToTransformersInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/mediaToTransformersInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/mediaToTransformersInput.md\n---\n\n# Function: mediaToTransformersInput()\n\n```ts\nfunction mediaToTransformersInput(\n media: Media,\n opts?: {\n audioSampleRate?: number;\n },\n): Promise<{\n data: unknown;\n kind: \"audio\" | \"image\";\n}>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:461](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L461)\n\nDecode an ADK [@nhtio/adk!Media](../../../../../common/classes/Media.md) into a transformers.js multimodal input.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | ------------------------------------------------- |\n| `media` | [`Media`](../../../../../common/classes/Media.md) |\n| `opts?` | { `audioSampleRate?`: `number`; } |\n| `opts.audioSampleRate?` | `number` |\n\n## Returns\n\n`Promise`<{\n`data`: `unknown`;\n`kind`: `\"audio\"` | `\"image\"`;\n}>\n\n## Remarks\n\nImage → `RawImage.fromBlob(...)`; audio → `Float32Array` PCM at the model's sample rate (16 kHz\ndefault) via `read_audio` over a `data:` URL. Imports `@huggingface/transformers` lazily, so it's\nonly loaded on the multimodal path. (Verified against a real Gemma-4 run — see plan 0a.)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/probeGpuBudget","title":"Function: probeGpuBudget()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/probeGpuBudget.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/probeGpuBudget","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/probeGpuBudget.md\n---\n\n# Function: probeGpuBudget()\n\n```ts\nfunction probeGpuBudget(nav?: NavigatorGpuLike): Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/gpu\\_budget.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L108)\n\nProbe the host WebGPU device for its memory budget (per-allocation ceilings + adapter info).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------ | --------------------------------------------------------------------------------- |\n| `nav?` | `NavigatorGpuLike` | Injectable `navigator`-like object for tests; defaults to the global `navigator`. |\n\n## Returns\n\n`Promise`<[`GpuBudget`](../interfaces/GpuBudget.md)>\n\nThe [GpuBudget](../interfaces/GpuBudget.md) snapshot.\n\n## Remarks\n\nReads `navigator.gpu` adapter limits — this is OBSERVABILITY ONLY; it allocates nothing and changes\nno behavior. Returns `{ available: false }` (with zeroed sizes) when WebGPU is absent (Node, a\nbrowser without the API, or a refused adapter) so callers can branch without try/catch. Best-effort\nand never throws. A battery emits the result through its lifecycle hook so the application can show\n\"you have ~N GiB of GPU budget\" and let the user choose a context window accordingly.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderArtifactHandleBody","title":"Function: renderArtifactHandleBody()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderArtifactHandleBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderArtifactHandleBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderArtifactHandleBody.md\n---\n\n# Function: renderArtifactHandleBody()\n\n```ts\nfunction renderArtifactHandleBody(input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n}): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:482](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L482)\n\nRender the \"handle\" body for a tool call's spooled-artifact result marked `inline: false`. See\nbuildHandleBody for the shared mechanics; this variant's leading sentence frames the\nartifact as a tool result.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; } |\n| `input.artifact` | `unknown` |\n| `input.byteLength` | `number` |\n| `input.callId` | `string` |\n| `input.encoding?` | `string` |\n| `input.estimatedTokens?` | `number` |\n| `input.lineCount` | `number` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderTransformersJsToolResult","title":"Function: renderTransformersJsToolResult()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderTransformersJsToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderTransformersJsToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderTransformersJsToolResult.md\n---\n\n# Function: renderTransformersJsToolResult()\n\n```ts\nfunction renderTransformersJsToolResult(input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}): Promise;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L193)\n\nRender a [@nhtio/adk!ToolCall](../../../../../forge/classes/ToolCall.md)'s `results` into a plain-text tool message body.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Override for the artifact-handle body renderer (see [renderArtifactHandleBody](renderArtifactHandleBody.md)). Defaults to the shared [defaultRenderArtifactHandleBody](../variables/defaultRenderArtifactHandleBody.md). The adapter threads the consumer's `helpers.renderArtifactHandleBody` here so an app can change which forged `artifact_*` reader the model is steered toward first. |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] | - |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` | - |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<`string`>\n\n## Remarks\n\ntransformers.js chat templates take a `tool`-role message whose `content` is a string. A\n`SpooledArtifact` result renders as a HANDLE (metadata + the forged `artifact_*` tools to read it)\nwhen its `ToolCall.inline === false` — the secure default — and inline via `asString()` only when a\nproducer opted into `inline: true`. Applies the trust envelope and degrades Media to text.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveGenerationOptions","title":"Function: resolveGenerationOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveGenerationOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveGenerationOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveGenerationOptions.md\n---\n\n# Function: resolveGenerationOptions()\n\n```ts\nfunction resolveGenerationOptions(\n canonical: ChatGenerationOptions,\n nativeFallbacks?: {\n enableThinking?: boolean;\n maxTokens?: number;\n multimodal?: {\n audio?: boolean;\n image?: boolean;\n };\n sampler?: ChatSampler;\n seed?: number;\n temperature?: number;\n topK?: number;\n topP?: number;\n },\n): ResolvedGenerationOptions;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/generation.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L109)\n\nResolve the canonical [ChatGenerationOptions](../interfaces/ChatGenerationOptions.md) (already merged across option layers) into a\nfully-defaulted [ResolvedGenerationOptions](../interfaces/ResolvedGenerationOptions.md). Native per-battery fallbacks are passed via\n`nativeFallbacks` and consulted ONLY when the canonical field is absent (canonical wins). The adapter\nthen maps the resolved shape onto its runtime API.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `canonical` | [`ChatGenerationOptions`](../interfaces/ChatGenerationOptions.md) | The canonical fields from the merged adapter options. |\n| `nativeFallbacks` | { `enableThinking?`: `boolean`; `maxTokens?`: `number`; `multimodal?`: { `audio?`: `boolean`; `image?`: `boolean`; }; `sampler?`: [`ChatSampler`](../type-aliases/ChatSampler.md); `seed?`: `number`; `temperature?`: `number`; `topK?`: `number`; `topP?`: `number`; } | Battery-native equivalents to fall back to when a canonical field is unset (e.g. transformers.js `maxNewTokens`, LiteRT `maxOutputTokens`). Each is consulted second. |\n| `nativeFallbacks.enableThinking?` | `boolean` | - |\n| `nativeFallbacks.maxTokens?` | `number` | - |\n| `nativeFallbacks.multimodal?` | { `audio?`: `boolean`; `image?`: `boolean`; } | - |\n| `nativeFallbacks.multimodal.audio?` | `boolean` | - |\n| `nativeFallbacks.multimodal.image?` | `boolean` | - |\n| `nativeFallbacks.sampler?` | [`ChatSampler`](../type-aliases/ChatSampler.md) | - |\n| `nativeFallbacks.seed?` | `number` | - |\n| `nativeFallbacks.temperature?` | `number` | - |\n| `nativeFallbacks.topK?` | `number` | - |\n| `nativeFallbacks.topP?` | `number` | - |\n\n## Returns\n\n[`ResolvedGenerationOptions`](../interfaces/ResolvedGenerationOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveReasoningParser","title":"Function: resolveReasoningParser()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveReasoningParser.md\n---\n\n# Function: resolveReasoningParser()\n\n```ts\nfunction resolveReasoningParser(\n option: ReasoningParserName | ReasoningParserFn | undefined,\n parsers?: Partial<\n Record, ReasoningParserFn>\n >,\n opts?: ReasoningParserOptions,\n): ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L335)\n\nResolve a `reasoningParser` option (a name, `'auto'`, `'none'`, or a custom fn) to a concrete\n[ReasoningParserFn](../type-aliases/ReasoningParserFn.md).\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `option` | | [`ReasoningParserName`](../type-aliases/ReasoningParserName.md) | [`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md) | `undefined` | `undefined` | The option value. Defaults to `'auto'` when undefined. |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ReasoningParserName`](../type-aliases/ReasoningParserName.md), `\"auto\"` | `\"none\"`>, [`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)>> | `BUNDLED_REASONING_PARSERS` | Override the bundled parsers. Ignored when `opts.orphanRecovery` is set (the bundled family parsers are rebuilt with that setting); pass a custom `option` fn for full control. |\n| `opts` | [`ReasoningParserOptions`](../interfaces/ReasoningParserOptions.md) | `{}` | [ReasoningParserOptions](../interfaces/ReasoningParserOptions.md); `orphanRecovery` defaults to `true`. When `false`, the named/auto bundled parsers are rebuilt in strict pair-only mode. |\n\n## Returns\n\n[`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveToolCallParser","title":"Function: resolveToolCallParser()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveToolCallParser.md\n---\n\n# Function: resolveToolCallParser()\n\n```ts\nfunction resolveToolCallParser(\n option: ToolCallParserName | ToolCallParserFn | undefined,\n parsers?: Partial<\n Record, ToolCallParserFn>\n >,\n): ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1121)\n\nResolve a `toolCallParser` option (a name, `'auto'`, `'none'`, or a custom fn) to a concrete\n[ToolCallParserFn](../type-aliases/ToolCallParserFn.md).\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ----------------------------------------------------------------- |\n| `option` | | [`ToolCallParserName`](../type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md) | `undefined` | `undefined` | The option value. Defaults to `'auto'` when undefined. |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ToolCallParserName`](../type-aliases/ToolCallParserName.md), `\"auto\"` | `\"none\"`>, [`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)>> | `BUNDLED_TOOL_CALL_PARSERS` | Override the bundled family parsers (e.g. swap the Gemma parser). |\n\n## Returns\n\n[`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/toolsToTransformersJsTools","title":"Function: toolsToTransformersJsTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/toolsToTransformersJsTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/toolsToTransformersJsTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/toolsToTransformersJsTools.md\n---\n\n# Function: toolsToTransformersJsTools()\n\n```ts\nfunction toolsToTransformersJsTools(\n tools: readonly (Tool | ArtifactTool)[],\n deps?: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n): TransformersJsTool[];\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L123)\n\nConvert ADK [@nhtio/adk!Tool](../../../../../forge/classes/Tool.md) / [@nhtio/adk!ArtifactTool](../../../../../forge/classes/ArtifactTool.md) instances into the\ntransformers.js `tools` array shape (OpenAI-function-shaped — what `apply_chat_template` expects).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n[`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks","title":"Interface: BatteryLifecycleHooks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md\ndescription: >-\n The opt-in lifecycle option block mixed into each battery's options interface.\n Every phase transition fires {@link onLifecycle} (the firehose) AND the\n matching per-phase hook; subscribe to either or both. All optional — omitting\n them leaves behavior byte-for-byte unchanged.\n---\n\n# Interface: BatteryLifecycleHooks\n\nDefined in: [src/batteries/llm/chat\\_common/lifecycle.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L84)\n\nThe opt-in lifecycle option block mixed into each battery's options interface. Every phase transition\nfires [onLifecycle](#property-onlifecycle) (the firehose) AND the matching per-phase hook; subscribe to either or both.\nAll optional — omitting them leaves behavior byte-for-byte unchanged.\n\n## Extended by\n\n* [`TransformersJsTtsAdapterOptions`](../../../../tts/transformers_js/types/interfaces/TransformersJsTtsAdapterOptions.md)\n* [`TesseractJsOcrAdapterOptions`](../../../../specialists/ocr/tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions.md)\n* [`TransformersJsCaptionAdapterOptions`](../../../../specialists/caption/transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions.md)\n* [`TransformersJsAdapterOptions`](../../types/interfaces/TransformersJsAdapterOptions.md)\n* [`LiteRtLmAdapterOptions`](../../../litert_lm/types/interfaces/LiteRtLmAdapterOptions.md)\n* [`TransformersJsGenerationAdapterOptions`](../../../../generation/transformers_js/types/interfaces/TransformersJsGenerationAdapterOptions.md)\n* [`LocalDiffusionGenerationAdapterOptions`](../../../../generation/local_diffusion/types/interfaces/LocalDiffusionGenerationAdapterOptions.md)\n* [`TransformersJsEmbeddingsAdapterOptions`](../../../../embeddings/transformers_js/types/interfaces/TransformersJsEmbeddingsAdapterOptions.md)\n* [`WebLLMChatCompletionsAdapterOptions`](../../../../interfaces/WebLLMChatCompletionsAdapterOptions.md)\n* [`TransformersJsSttAdapterOptions`](../../../../interfaces/TransformersJsSttAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `onCompiling?` | [`BatteryLifecycleCallback`](../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. | [src/batteries/llm/chat\\_common/lifecycle.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `onComplete?` | [`BatteryLifecycleCallback`](../type-aliases/BatteryLifecycleCallback.md) | After the turn's output is parsed + persisted, before `ack` (fires per turn). | [src/batteries/llm/chat\\_common/lifecycle.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `onError?` | [`BatteryLifecycleCallback`](../type-aliases/BatteryLifecycleCallback.md) | A load or generation failure (paired with `nack`). | [src/batteries/llm/chat\\_common/lifecycle.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `onGenerating?` | [`BatteryLifecycleCallback`](../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`. | [src/batteries/llm/chat\\_common/lifecycle.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `onLifecycle?` | [`BatteryLifecycleCallback`](../type-aliases/BatteryLifecycleCallback.md) | Fires on EVERY phase transition (the firehose). | [src/batteries/llm/chat\\_common/lifecycle.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `onLoading?` | [`BatteryLifecycleCallback`](../type-aliases/BatteryLifecycleCallback.md) | Weights/runtime loading — may fire repeatedly with `progress` as the provider reports it. | [src/batteries/llm/chat\\_common/lifecycle.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `onReady?` | [`BatteryLifecycleCallback`](../type-aliases/BatteryLifecycleCallback.md) | Engine/pipeline resolved and cached, before the first generation. | [src/batteries/llm/chat\\_common/lifecycle.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleReport","title":"Interface: BatteryLifecycleReport","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleReport","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md\ndescription: A single normalized lifecycle report.\n---\n\n# Interface: BatteryLifecycleReport\n\nDefined in: [src/batteries/llm/chat\\_common/lifecycle.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L46)\n\nA single normalized lifecycle report.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `at` | `string` | ISO-8601 timestamp stamped when the report was emitted. | [src/batteries/llm/chat\\_common/lifecycle.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L54) |\n| `battery` | [`BatteryLifecycleBattery`](../type-aliases/BatteryLifecycleBattery.md) | The battery that produced this report. | [src/batteries/llm/chat\\_common/lifecycle.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L50) |\n| `detail?` | `string` | Human-readable detail, e.g. `'booting WebGPU runtime'`. | [src/batteries/llm/chat\\_common/lifecycle.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L56) |\n| `error?` | `unknown` | The failure, populated only when `phase === 'error'`. | [src/batteries/llm/chat\\_common/lifecycle.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L66) |\n| `gpuBudget?` | [`GpuBudget`](GpuBudget.md) | The probed WebGPU device budget, populated on the `ready` phase for on-device batteries running on the WebGPU EP. SURFACED, not enforced — the consumer reads this to know the per-allocation ceiling (the wall an over-large context window hits) and choose its window accordingly. Absent on non-WebGPU runtimes (Node/wasm) and on every other phase. See [GpuBudget](GpuBudget.md). | [src/batteries/llm/chat\\_common/lifecycle.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L73) |\n| `model` | `string` | Best-effort model identifier (the `model` option; `''` / `''` when not a string). | [src/batteries/llm/chat\\_common/lifecycle.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L52) |\n| `phase` | [`BatteryLifecyclePhase`](../type-aliases/BatteryLifecyclePhase.md) | The phase being entered. | [src/batteries/llm/chat\\_common/lifecycle.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L48) |\n| `progress?` | `number` | Normalized progress in `0..1`, when the provider reports it. Emitted during the `loading` phase (weights download/compile) and — for engines that stream per-step generation progress, e.g. the diffusion denoise loop — during the `generating` phase as well. | [src/batteries/llm/chat\\_common/lifecycle.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L62) |\n| `raw?` | `unknown` | The provider's own progress payload, passed through verbatim (the `loading` or `generating` phase). | [src/batteries/llm/chat\\_common/lifecycle.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L64) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ChatGenerationOptions","title":"Interface: ChatGenerationOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ChatGenerationOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ChatGenerationOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ChatGenerationOptions.md\ndescription: >-\n The canonical generation options both on-device batteries accept. Every field\n optional + defaulted.\n---\n\n# Interface: ChatGenerationOptions\n\nDefined in: [src/batteries/llm/chat\\_common/generation.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L33)\n\nThe canonical generation options both on-device batteries accept. Every field optional + defaulted.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------ | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `enableThinking?` | `boolean` | Whether to enable the model's \"thinking\"/reasoning mode, passed EXPLICITLY to the chat template. Default `false` — many reasoning templates default thinking ON and burn the budget. Already shared by both batteries under this exact name; restated here so the whole generation contract is in one place. | [src/batteries/llm/chat\\_common/generation.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L54) |\n| `maxTokens?` | `number` | Maximum tokens to GENERATE this turn. The portable spelling of transformers.js `maxNewTokens` / LiteRT `maxOutputTokens`. Default `1024`. | [src/batteries/llm/chat\\_common/generation.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L38) |\n| `multimodal?` | { `audio?`: `boolean`; `image?`: `boolean`; } | Enable multimodal input by kind. The portable spelling of transformers.js `multimodal:{image,audio}` / LiteRT `visionModalityEnabled`+`audioModalityEnabled`. | [src/batteries/llm/chat\\_common/generation.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L59) |\n| `multimodal.audio?` | `boolean` | - | [src/batteries/llm/chat\\_common/generation.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L59) |\n| `multimodal.image?` | `boolean` | - | [src/batteries/llm/chat\\_common/generation.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L59) |\n| `sampler?` | [`ChatSampler`](../type-aliases/ChatSampler.md) | Sampler strategy (default `'greedy'` — deterministic). See [ChatSampler](../type-aliases/ChatSampler.md). | [src/batteries/llm/chat\\_common/generation.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L40) |\n| `seed?` | `number` | RNG seed for reproducible sampling (best-effort; only honoured by batteries that expose it). | [src/batteries/llm/chat\\_common/generation.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L48) |\n| `temperature?` | `number` | Sampling temperature, used when `sampler` is `'top-k'`/`'top-p'`. Always pinned. Default `0.7`. | [src/batteries/llm/chat\\_common/generation.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L42) |\n| `topK?` | `number` | Top-K cutoff, used when `sampler` is `'top-k'`. Default `40`. | [src/batteries/llm/chat\\_common/generation.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L44) |\n| `topP?` | `number` | Top-P (nucleus) cutoff, used when `sampler` is `'top-p'`. Default `0.95`. | [src/batteries/llm/chat\\_common/generation.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L46) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBudget","title":"Interface: GpuBudget","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBudget.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBudget","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBudget.md\ndescription: >-\n A snapshot of the WebGPU device's memory budget, as reported by the\n adapter/device limits.\n---\n\n# Interface: GpuBudget\n\nDefined in: [src/batteries/llm/chat\\_common/gpu\\_budget.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L37)\n\nA snapshot of the WebGPU device's memory budget, as reported by the adapter/device limits.\n\n## Remarks\n\nAll sizes are bytes. `maxBufferSize` and `maxStorageBufferBindingSize` are the hard per-allocation\nceilings a single ONNX tensor buffer cannot exceed — the practical wall an over-large context window\nhits first (e.g. ~4 GiB on Apple Metal). These are LIMITS, not live usage; pair with\n[GpuBufferInstrument](GpuBufferInstrument.md) for live high-water-mark tracking.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `adapterInfo?` | { `architecture?`: `string`; `description?`: `string`; `device?`: `string`; `vendor?`: `string`; } | Best-effort adapter description (vendor/architecture/device), when the runtime exposes it. | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L43) |\n| `adapterInfo.architecture?` | `string` | - | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L43) |\n| `adapterInfo.description?` | `string` | - | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L43) |\n| `adapterInfo.device?` | `string` | - | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L43) |\n| `adapterInfo.vendor?` | `string` | - | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L43) |\n| `available` | `boolean` | `true` when these numbers came from a real `navigator.gpu` device; `false`/absent ⇒ unavailable. | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L45) |\n| `maxBufferBytes` | `number` | Largest single `GPUBuffer` the device will allocate, in bytes (`GPUSupportedLimits.maxBufferSize`). | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L39) |\n| `maxStorageBufferBindingBytes` | `number` | Largest storage-buffer binding, in bytes (`GPUSupportedLimits.maxStorageBufferBindingSize`). | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L41) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferInstrument","title":"Interface: GpuBufferInstrument","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferInstrument.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferInstrument","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferInstrument.md\ndescription: >-\n A handle returned by [`instrumentGpuBuffers`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/instrumentGpuBuffers): read live samples, then\n `uninstall()` to restore.\n---\n\n# Interface: GpuBufferInstrument\n\nDefined in: [src/batteries/llm/chat\\_common/gpu\\_budget.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L162)\n\nA handle returned by [instrumentGpuBuffers](../functions/instrumentGpuBuffers.md): read live samples, then `uninstall()` to restore.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `sample` | () => [`GpuBufferSample`](GpuBufferSample.md) | Take a live sample of GPU buffer usage. | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L164) |\n| `uninstall` | () => `void` | Restore the original `createBuffer`/`destroy` (idempotent). Call when done measuring. | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:166](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L166) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferSample","title":"Interface: GpuBufferSample","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferSample.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferSample","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferSample.md\ndescription: 'A live GPU-memory sample taken by a [`GpuBufferInstrument`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/GpuBufferInstrument).'\n---\n\n# Interface: GpuBufferSample\n\nDefined in: [src/batteries/llm/chat\\_common/gpu\\_budget.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L148)\n\nA live GPU-memory sample taken by a [GpuBufferInstrument](GpuBufferInstrument.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `created` | `number` | Total `createBuffer` calls observed since instrumentation began. | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L150) |\n| `destroyed` | `number` | Total `buffer.destroy()` calls observed. | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:152](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L152) |\n| `live` | `number` | Currently-live buffer count (`created - destroyed`). | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L154) |\n| `liveBytes` | `number` | Currently-live buffer bytes (the number that climbs as the freelist retains larger working sets). | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L156) |\n| `peakBytes` | `number` | Peak live bytes seen — the high-water-mark that, against [GpuBudget](GpuBudget.md), predicts the OOM. | [src/batteries/llm/chat\\_common/gpu\\_budget.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/gpu_budget.ts#L158) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ParsedToolCall","title":"Interface: ParsedToolCall","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ParsedToolCall.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ParsedToolCall","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ParsedToolCall.md\ndescription: >-\n A single tool call extracted from model output. `arguments` is a parsed\n object, never a string.\n---\n\n# Interface: ParsedToolCall\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L39)\n\nA single tool call extracted from model output. `arguments` is a parsed object, never a string.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `arguments` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`JsonValue`](../type-aliases/JsonValue.md)> | The parsed argument object (never a JSON string). | [src/batteries/llm/chat\\_common/tool\\_parsers.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L43) |\n| `name` | `string` | The tool name the model called. | [src/batteries/llm/chat\\_common/tool\\_parsers.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L41) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParseResult","title":"Interface: ReasoningParseResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParseResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParseResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParseResult.md\ndescription: 'The result of running a [`ReasoningParserFn`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserFn) over assistant text.'\n---\n\n# Interface: ReasoningParseResult\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L30)\n\nThe result of running a [ReasoningParserFn](../type-aliases/ReasoningParserFn.md) over assistant text.\n\n## Remarks\n\n`reasoning` holds each extracted thinking trace in document order; `cleanedText` is the prose with\nevery consumed reasoning span removed and trimmed. On no-match a parser MUST return\n`{ reasoning: [], cleanedText: rawText }` verbatim.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cleanedText` | `string` | The prose with every consumed reasoning span removed; equals the input on no-match. | [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L34) |\n| `reasoning` | `string`\\[] | Each extracted thinking trace, in document order. Empty when no reasoning was found. | [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L32) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParserOptions","title":"Interface: ReasoningParserOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParserOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParserOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ReasoningParserOptions.md\ndescription: Options shared by the bundled reasoning parsers.\n---\n\n# Interface: ReasoningParserOptions\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L59)\n\nOptions shared by the bundled reasoning parsers.\n\n## Remarks\n\n`orphanRecovery` (default `true`) controls whether an **unpaired** reasoning marker is recovered by\ninferring the missing half from the pseudo-streaming order, rather than being left to leak into the\nvisible answer. A real-world gemma-4-E4B WebGPU quant \"randomly emits ``\" with no matching\nopen; because generation is start→end, a lone close implies the block opened at the previous close\n(or start-of-output), and a lone open with no close implies reasoning ran to end-of-stream. Turn this\noff for strict pair-only behaviour (markers without a matching partner are left verbatim).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------ | --------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `orphanRecovery?` | `boolean` | Recover unpaired markers by inferring the missing half (default `true`). | [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L61) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ResolvedGenerationOptions","title":"Interface: ResolvedGenerationOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ResolvedGenerationOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ResolvedGenerationOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ResolvedGenerationOptions.md\ndescription: 'The resolved, fully-defaulted generation config the adapters consume.'\n---\n\n# Interface: ResolvedGenerationOptions\n\nDefined in: [src/batteries/llm/chat\\_common/generation.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L63)\n\nThe resolved, fully-defaulted generation config the adapters consume.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | ----------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `enableThinking` | `boolean` | Whether thinking/reasoning mode is enabled. | [src/batteries/llm/chat\\_common/generation.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L77) |\n| `maxTokens` | `number` | Max tokens to generate this turn. | [src/batteries/llm/chat\\_common/generation.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L65) |\n| `multimodal` | { `audio`: `boolean`; `image`: `boolean`; } | Resolved multimodal-input flags by kind. | [src/batteries/llm/chat\\_common/generation.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L79) |\n| `multimodal.audio` | `boolean` | - | [src/batteries/llm/chat\\_common/generation.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L79) |\n| `multimodal.image` | `boolean` | - | [src/batteries/llm/chat\\_common/generation.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L79) |\n| `sampler` | [`ChatSampler`](../type-aliases/ChatSampler.md) | The resolved sampler strategy. | [src/batteries/llm/chat\\_common/generation.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L67) |\n| `seed?` | `number` | RNG seed, when provided. | [src/batteries/llm/chat\\_common/generation.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L75) |\n| `temperature` | `number` | Sampling temperature (used by `'top-k'`/`'top-p'`). | [src/batteries/llm/chat\\_common/generation.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L69) |\n| `topK` | `number` | Top-K cutoff (used by `'top-k'`). | [src/batteries/llm/chat\\_common/generation.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L71) |\n| `topP` | `number` | Top-P (nucleus) cutoff (used by `'top-p'`). | [src/batteries/llm/chat\\_common/generation.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L73) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParserContext","title":"Interface: ToolCallParserContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParserContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParserContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParserContext.md\ndescription: 'Context passed to a parser: the names of the tools actually offered this turn.'\n---\n\n# Interface: ToolCallParserContext\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L63)\n\nContext passed to a parser: the names of the tools actually offered this turn.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `toolNames` | readonly `string`\\[] | The visible tool names this turn — lets a parser reject calls to tools that don't exist. | [src/batteries/llm/chat\\_common/tool\\_parsers.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L65) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParseResult","title":"Interface: ToolCallParseResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParseResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParseResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/ToolCallParseResult.md\ndescription: 'The result of running a [`ToolCallParserFn`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserFn) over assistant text.'\n---\n\n# Interface: ToolCallParseResult\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L55)\n\nThe result of running a [ToolCallParserFn](../type-aliases/ToolCallParserFn.md) over assistant text.\n\n## Remarks\n\n`cleanedText` is the prose with every consumed tool-call span removed and trimmed, so the visible\nassistant message never carries raw markup. On no-match a parser MUST return\n`{ calls: [], cleanedText: rawText }` verbatim — that is the signal the `'auto'` driver uses to\ndetect \"this parser made no claim\" and move to the next one.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `calls` | [`ParsedToolCall`](ParsedToolCall.md)\\[] | The tool calls extracted, in document order. Empty when the parser made no claim. | [src/batteries/llm/chat\\_common/tool\\_parsers.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L57) |\n| `cleanedText` | `string` | The assistant prose with every consumed tool-call span removed; equals the input on no-match. | [src/batteries/llm/chat\\_common/tool\\_parsers.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L59) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsStreamAccumulator","title":"Interface: TransformersJsStreamAccumulator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsStreamAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsStreamAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsStreamAccumulator.md\ndescription: >-\n A streaming accumulator over transformers.js `TextStreamer` decoded-text\n deltas.\n---\n\n# Interface: TransformersJsStreamAccumulator\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:592](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L592)\n\nA streaming accumulator over transformers.js `TextStreamer` decoded-text deltas.\n\n## Remarks\n\ntransformers.js streams **decoded text** (via the `TextStreamer` callback), not structured events.\nThis accumulator just concatenates the deltas; tool-call and reasoning extraction run **once after\nthe stream drains**, over `content()`, via the shared parser layer.\n\n## Methods\n\n### content()\n\n```ts\ncontent(): string;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:596](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L596)\n\nThe full accumulated text.\n\n#### Returns\n\n`string`\n\n***\n\n### feed()\n\n```ts\nfeed(delta: string): string;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:594](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L594)\n\nFeed one decoded-text delta; returns it (for live prose reporting).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `delta` | `string` |\n\n#### Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsTool","title":"Interface: TransformersJsTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/interfaces/TransformersJsTool.md\ndescription: >-\n A tool definition in the transformers.js `tools` array\n (OpenAI-function-shaped).\n---\n\n# Interface: TransformersJsTool\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L108)\n\nA tool definition in the transformers.js `tools` array (OpenAI-function-shaped).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `function` | { `description?`: `string`; `name`: `string`; `parameters?`: [`JsonSchema`](../../../../interfaces/JsonSchema.md); } | The function descriptor: name, optional description, and JSON-Schema parameters. | [src/batteries/llm/transformers\\_js/helpers.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L112) |\n| `function.description?` | `string` | - | [src/batteries/llm/transformers\\_js/helpers.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L114) |\n| `function.name` | `string` | - | [src/batteries/llm/transformers\\_js/helpers.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L113) |\n| `function.parameters?` | [`JsonSchema`](../../../../interfaces/JsonSchema.md) | - | [src/batteries/llm/transformers\\_js/helpers.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L115) |\n| `type` | `\"function\"` | Always `'function'` — the only tool type transformers.js chat templates understand. | [src/batteries/llm/transformers\\_js/helpers.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L110) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery","title":"Type Alias: BatteryLifecycleBattery","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md\ndescription: Which battery emitted a lifecycle report.\n---\n\n# Type Alias: BatteryLifecycleBattery\n\n```ts\ntype BatteryLifecycleBattery =\n | \"transformers_js\"\n | \"litert_lm\"\n | \"webllm\"\n | \"transformers_js_embed\"\n | \"transformers_js_stt\"\n | \"transformers_js_caption\"\n | \"transformers_js_generation\"\n | \"transformers_js_tts\"\n | \"local_diffusion_generation\"\n | \"tesseract_js_ocr\";\n```\n\nDefined in: [src/batteries/llm/chat\\_common/lifecycle.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L33)\n\nWhich battery emitted a lifecycle report.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback","title":"Type Alias: BatteryLifecycleCallback","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md\ndescription: A lifecycle report consumer.\n---\n\n# Type Alias: BatteryLifecycleCallback\n\n```ts\ntype BatteryLifecycleCallback = (report: BatteryLifecycleReport) => void;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/lifecycle.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L77)\n\nA lifecycle report consumer.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `report` | [`BatteryLifecycleReport`](../interfaces/BatteryLifecycleReport.md) |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase","title":"Type Alias: BatteryLifecyclePhase","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md\ndescription: The coarse lifecycle phases a battery transitions through.\n---\n\n# Type Alias: BatteryLifecyclePhase\n\n```ts\ntype BatteryLifecyclePhase =\n | \"loading\"\n | \"compiling\"\n | \"ready\"\n | \"generating\"\n | \"complete\"\n | \"error\";\n```\n\nDefined in: [src/batteries/llm/chat\\_common/lifecycle.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L24)\n\nThe coarse lifecycle phases a battery transitions through.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ChatSampler","title":"Type Alias: ChatSampler","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ChatSampler.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ChatSampler","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ChatSampler.md\ndescription: >-\n The portable sampler strategy. Maps to each battery's native mechanism: -\n `'greedy'` — deterministic argmax. transformers.js `do_sample:false`; LiteRT\n `SamplerType.GREEDY` (which is top-1, so `k` is forced to 1). - `'top-k'` —\n sample from the top-`k` logits. transformers.js `do_sample:true`+`top_k`;\n LiteRT `SamplerType.TOP_K`+`k`. - `'top-p'` — nucleus sampling.\n transformers.js `do_sample:true`+`top_p`; LiteRT `SamplerType.TOP_P`+`p`.\n---\n\n# Type Alias: ChatSampler\n\n```ts\ntype ChatSampler = \"greedy\" | \"top-k\" | \"top-p\";\n```\n\nDefined in: [src/batteries/llm/chat\\_common/generation.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L30)\n\nThe portable sampler strategy. Maps to each battery's native mechanism:\n\n* `'greedy'` — deterministic argmax. transformers.js `do_sample:false`; LiteRT `SamplerType.GREEDY`\n (which is top-1, so `k` is forced to 1).\n* `'top-k'` — sample from the top-`k` logits. transformers.js `do_sample:true`+`top_k`; LiteRT\n `SamplerType.TOP_K`+`k`.\n* `'top-p'` — nucleus sampling. transformers.js `do_sample:true`+`top_p`; LiteRT `SamplerType.TOP_P`+`p`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/JsonValue","title":"Type Alias: JsonValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/JsonValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/JsonValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/JsonValue.md\ndescription: A JSON-serialisable value — the shape of parsed tool-call arguments.\n---\n\n# Type Alias: JsonValue\n\n```ts\ntype JsonValue =\n | string\n | number\n | boolean\n | null\n | JsonValue[]\n | {\n [key: string]: JsonValue;\n };\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L30)\n\nA JSON-serialisable value — the shape of parsed tool-call arguments.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserFn","title":"Type Alias: ReasoningParserFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserFn.md\ndescription: A synchronous reasoning text parser.\n---\n\n# Type Alias: ReasoningParserFn\n\n```ts\ntype ReasoningParserFn = (rawText: string) => ReasoningParseResult;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L38)\n\nA synchronous reasoning text parser.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `rawText` | `string` |\n\n## Returns\n\n[`ReasoningParseResult`](../interfaces/ReasoningParseResult.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserName","title":"Type Alias: ReasoningParserName","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserName.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserName","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ReasoningParserName.md\ndescription: >-\n The bundled reasoning parser names, plus `'auto'` (try-all) and `'none'`\n (disable).\n---\n\n# Type Alias: ReasoningParserName\n\n```ts\ntype ReasoningParserName =\n | \"auto\"\n | \"think_tag\"\n | \"harmony_analysis\"\n | \"gemma_channel\"\n | \"none\";\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L41)\n\nThe bundled reasoning parser names, plus `'auto'` (try-all) and `'none'` (disable).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserFn","title":"Type Alias: ToolCallParserFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserFn.md\ndescription: A synchronous tool-call text parser.\n---\n\n# Type Alias: ToolCallParserFn\n\n```ts\ntype ToolCallParserFn = (\n rawText: string,\n ctx: ToolCallParserContext,\n) => ToolCallParseResult;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L69)\n\nA synchronous tool-call text parser.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------- |\n| `rawText` | `string` |\n| `ctx` | [`ToolCallParserContext`](../interfaces/ToolCallParserContext.md) |\n\n## Returns\n\n[`ToolCallParseResult`](../interfaces/ToolCallParseResult.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserName","title":"Type Alias: ToolCallParserName","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserName.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserName","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/type-aliases/ToolCallParserName.md\ndescription: >-\n The bundled family parser names, plus `'auto'` (try-all) and `'none'`\n (disable).\n---\n\n# Type Alias: ToolCallParserName\n\n```ts\ntype ToolCallParserName =\n | \"auto\"\n | \"hermes\"\n | \"gemma\"\n | \"gpt_oss\"\n | \"pythonic\"\n | \"bare_pythonic\"\n | \"loose_keyed\"\n | \"llama3_json\"\n | \"mistral\"\n | \"qwen3_coder\"\n | \"phi\"\n | \"none\";\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L72)\n\nThe bundled family parser names, plus `'auto'` (try-all) and `'none'` (disable).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/barePythonicToolCallParser","title":"Variable: barePythonicToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/barePythonicToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/barePythonicToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/barePythonicToolCallParser.md\ndescription: >-\n Parse a BARE pythonic call — `provide_answer(answer=“…”, sources=[“/x”])` —\n i.e. the pythonic `NAME(kwargs)` form WITHOUT the surrounding `[ … ]` list\n wrapper that [`pythonicToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/pythonicToolCallParser) requires. Small models (observed:\n Gemma-4 E2B via transformers.js) emit this for a single call, sometimes with a\n leading `/`, a `call:` prefix, or smart quotes in the args.\n---\n\n# Variable: barePythonicToolCallParser\n\n```ts\nconst barePythonicToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:754](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L754)\n\nParse a BARE pythonic call — `provide_answer(answer=“…”, sources=[“/x”])` — i.e. the pythonic\n`NAME(kwargs)` form WITHOUT the surrounding `[ … ]` list wrapper that [pythonicToolCallParser](pythonicToolCallParser.md)\nrequires. Small models (observed: Gemma-4 E2B via transformers.js) emit this for a single call,\nsometimes with a leading `/`, a `call:` prefix, or smart quotes in the args.\n\nBecause the bare shape is a WEAK signal (it can resemble incidental prose like \"see foo(bar)\"),\nthis parser is gated HARD: it only claims a call whose callee is a real offered tool\n(`ctx.toolNames`). That gate is what makes dropping the `[ ]` requirement safe. Runs after the\nstrict bracketed pythonic parser in the `'auto'` order.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_REASONING_PARSERS","title":"Variable: BUNDLED\\_REASONING\\_PARSERS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_REASONING_PARSERS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_REASONING_PARSERS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_REASONING_PARSERS.md\ndescription: >-\n The bundled reasoning parsers keyed by name (excluding `'auto'`/`'none'`),\n orphan recovery ON.\n---\n\n# Variable: BUNDLED\\_REASONING\\_PARSERS\n\n```ts\nconst BUNDLED_REASONING_PARSERS: Readonly<\n Record, ReasoningParserFn>\n>;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:275](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L275)\n\nThe bundled reasoning parsers keyed by name (excluding `'auto'`/`'none'`), orphan recovery ON.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_TOOL_CALL_PARSERS","title":"Variable: BUNDLED\\_TOOL\\_CALL\\_PARSERS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_TOOL_CALL_PARSERS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_TOOL_CALL_PARSERS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/BUNDLED_TOOL_CALL_PARSERS.md\ndescription: The bundled family parsers keyed by name (excluding `'auto'`/`'none'`).\n---\n\n# Variable: BUNDLED\\_TOOL\\_CALL\\_PARSERS\n\n```ts\nconst BUNDLED_TOOL_CALL_PARSERS: Readonly<\n Record, ToolCallParserFn>\n>;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1050](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1050)\n\nThe bundled family parsers keyed by name (excluding `'auto'`/`'none'`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_REASONING_PARSER_ORDER","title":"Variable: DEFAULT\\_REASONING\\_PARSER\\_ORDER","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_REASONING_PARSER_ORDER.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_REASONING_PARSER_ORDER","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_REASONING_PARSER_ORDER.md\ndescription: >-\n The default `'auto'` precedence. All three are literal-marker-anchored, so\n order is collision-free.\n---\n\n# Variable: DEFAULT\\_REASONING\\_PARSER\\_ORDER\n\n```ts\nconst DEFAULT_REASONING_PARSER_ORDER: ReadonlyArray<\n Exclude\n>;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:293](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L293)\n\nThe default `'auto'` precedence. All three are literal-marker-anchored, so order is collision-free.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_TOOL_CALL_PARSER_ORDER","title":"Variable: DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_TOOL_CALL_PARSER_ORDER.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_TOOL_CALL_PARSER_ORDER","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/DEFAULT_TOOL_CALL_PARSER_ORDER.md\ndescription: >-\n The default `'auto'` precedence. Marker-anchored families first\n (collision-free); the weak-signal pythonic/llama3_json forms run last and are\n gated on callee∈toolNames.\n---\n\n# Variable: DEFAULT\\_TOOL\\_CALL\\_PARSER\\_ORDER\n\n```ts\nconst DEFAULT_TOOL_CALL_PARSER_ORDER: ReadonlyArray<\n Exclude\n>;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1069](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1069)\n\nThe default `'auto'` precedence. Marker-anchored families first (collision-free); the weak-signal\npythonic/llama3\\_json forms run last and are gated on callee∈toolNames.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBarePythonicToolCallParser","title":"Variable: defaultBarePythonicToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBarePythonicToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBarePythonicToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBarePythonicToolCallParser.md\ndescription: 'Default [`barePythonicToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/barePythonicToolCallParser).'\n---\n\n# Variable: defaultBarePythonicToolCallParser\n\n```ts\nconst defaultBarePythonicToolCallParser: ToolCallParserFn =\n barePythonicToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:778](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L778)\n\nDefault [barePythonicToolCallParser](barePythonicToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBuildTransformersJsMessages","title":"Variable: defaultBuildTransformersJsMessages","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBuildTransformersJsMessages.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBuildTransformersJsMessages","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultBuildTransformersJsMessages.md\ndescription: 'Default [`buildTransformersJsMessages`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/buildTransformersJsMessages).'\n---\n\n# Variable: defaultBuildTransformersJsMessages\n\n```ts\nconst defaultBuildTransformersJsMessages: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n decodeMedia?: (media: Media) => Promise<{\n data: unknown;\n kind: \"audio\" | \"image\";\n }>;\n filterThoughts: (thoughts: Iterable, mode: \"all\" | \"all-self\" | \"latest-self\", selfIdentity: string, replayCompatibility: readonly string[]) => Thought[];\n memories: Iterable;\n messages: Iterable;\n multimodal?: {\n audio: boolean;\n image: boolean;\n };\n renderChatCompletionsSystemPrompt: (input: {\n bucketOrder: ChatCompletionsBucketOrder;\n memories: Iterable;\n renderCtx?: unknown;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: ... | ...;\n estimatedTokens?: ... | ...;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: ...;\n byteLength: ...;\n callId: ...;\n encoding?: ...;\n estimatedTokens?: ...;\n lineCount: ...;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n retrievables: Iterable;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n }) => Promise;\n renderedToolCallResults: Map;\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderHandle:\n | ((input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string)\n | undefined) => Promise;\n renderMemories: (items: Iterable<{\n attrs: MemoryAttrs;\n memory: Memory;\n }>) => string;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderFirstPartyRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string) => Promise;\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderRetrievableSafetyDirective: () => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderRetrievableSafetyDirective: () => string;\n renderStandingInstructions: (items: Iterable, attrs?: StandingInstructionAttrs) => string;\n renderThirdPartyPrivateRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThirdPartyPublicRetrievables: (items: Iterable<{\n attrs: RetrievableAttrs;\n retrievable: Retrievable;\n }>, deps: {\n renderRetrievableHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n }) => Promise;\n renderThought: (content: string, attrs: ThoughtAttrs, payload?: unknown) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (content: string, attrs: UntrustedContentAttrs) => string;\n replayCompatibility: readonly string[];\n retrievables: Iterable;\n selfIdentity: string;\n standingInstructions: Iterable;\n systemPrompt: Tokenizable;\n thoughts: Iterable;\n thoughtSurfacing: \"all\" | \"all-self\" | \"latest-self\";\n toolCalls: Iterable;\n tools: ToolRegistry;\n toolsToTransformersJsTools: (tools: readonly (\n | Tool\n | ArtifactTool)[], deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n }) => TransformersJsTool[];\n unsupportedMediaPolicy?: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise<{\n audio: unknown[];\n images: unknown[];\n messages: Message[];\n tools: TransformersJsTool[];\n}> = buildTransformersJsMessages;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:451](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L451)\n\nDefault [buildTransformersJsMessages](../functions/buildTransformersJsMessages.md).\n\nBuild the transformers.js `messages` array + `tools` from the ADK dispatch context buckets.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `decodeMedia?`: (`media`: [`Media`](../../../../../common/classes/Media.md)) => `Promise`<{ `data`: `unknown`; `kind`: `\"audio\"` | `\"image\"`; }>; `filterThoughts`: (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[]; `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `messages`: `Iterable`<[`Message`](../../../../../common/classes/Message.md)>; `multimodal?`: { `audio`: `boolean`; `image`: `boolean`; }; `renderChatCompletionsSystemPrompt`: (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`>; `renderedToolCallResults`: `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`>; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThought`: (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `replayCompatibility`: readonly `string`\\[]; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `selfIdentity`: `string`; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); `thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>; `thoughtSurfacing`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`; `toolCalls`: `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)>; `tools`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md); `toolsToTransformersJsTools`: (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[]; `unsupportedMediaPolicy?`: [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.bucketOrder` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | - |\n| `input.decodeMedia?` | (`media`: [`Media`](../../../../../common/classes/Media.md)) => `Promise`<{ `data`: `unknown`; `kind`: `\"audio\"` | `\"image\"`; }> | Decodes a Media instance to a transformers.js input (RawImage / audio samples). Adapter-injected. |\n| `input.filterThoughts` | (`thoughts`: `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)>, `mode`: `\"all\"` | `\"all-self\"` | `\"latest-self\"`, `selfIdentity`: `string`, `replayCompatibility`: readonly `string`\\[]) => [`Thought`](../../../../../common/classes/Thought.md)\\[] | - |\n| `input.memories` | `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)> | - |\n| `input.messages` | `Iterable`<[`Message`](../../../../../common/classes/Message.md)> | - |\n| `input.multimodal?` | { `audio`: `boolean`; `image`: `boolean`; } | Multimodal config. Absent/false → text-only (every message renders a plain string `content`, the byte-for-byte original behavior). When set, a message carrying `attachments` of an enabled kind renders a content-array (text + `{type:'image' | 'audio'}`placeholders) and the decoded media is collected into`images`/`audio`(consumed positionally by`processor(prompt, images, audio)`). |\n| `input.multimodal.audio` | `boolean` | - |\n| `input.multimodal.image` | `boolean` | - |\n| `input.renderChatCompletionsSystemPrompt` | (`input`: { `bucketOrder`: [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md); `memories`: `Iterable`<[`Memory`](../../../../../common/classes/Memory.md)>; `renderCtx?`: `unknown`; `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderMemories`: (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string`; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: ... | ...; `estimatedTokens?`: ... | ...; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: ...; `byteLength`: ...; `callId`: ...; `encoding?`: ...; `estimatedTokens?`: ...; `lineCount`: ...; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderRetrievableSafetyDirective`: () => `string`; `renderStandingInstructions`: (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `retrievables`: `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)>; `standingInstructions`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>; `systemPrompt`: [`Tokenizable`](../../../../../common/classes/Tokenizable.md); }) => `Promise`<`string`> | - |\n| `input.renderedToolCallResults` | `Map`<[`ToolCall`](../../../../../forge/classes/ToolCall.md), `string`> | - |\n| `input.renderFirstPartyRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderHandle`: | ((`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) | `undefined`) => `Promise`<`string`> | - |\n| `input.renderMemories` | (`items`: `Iterable`<{ `attrs`: [`MemoryAttrs`](../../../../interfaces/MemoryAttrs.md); `memory`: [`Memory`](../../../../../common/classes/Memory.md); }>) => `string` | - |\n| `input.renderRetrievableHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | - |\n| `input.renderRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderFirstPartyRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`) => `Promise`<`string`>; `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderRetrievableSafetyDirective`: () => `string`; `renderThirdPartyPrivateRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderThirdPartyPublicRetrievables`: (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`>; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderRetrievableSafetyDirective` | () => `string` | - |\n| `input.renderStandingInstructions` | (`items`: `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)>, `attrs?`: [`StandingInstructionAttrs`](../../../../interfaces/StandingInstructionAttrs.md)) => `string` | - |\n| `input.renderThirdPartyPrivateRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThirdPartyPublicRetrievables` | (`items`: `Iterable`<{ `attrs`: [`RetrievableAttrs`](../../../../interfaces/RetrievableAttrs.md); `retrievable`: [`Retrievable`](../../../../../common/classes/Retrievable.md); }>, `deps`: { `renderRetrievableHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; }) => `Promise`<`string`> | - |\n| `input.renderThought` | (`content`: `string`, `attrs`: [`ThoughtAttrs`](../../../../interfaces/ThoughtAttrs.md), `payload?`: `unknown`) => `string` | - |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.replayCompatibility` | readonly `string`\\[] | - |\n| `input.retrievables` | `Iterable`<[`Retrievable`](../../../../../common/classes/Retrievable.md)> | - |\n| `input.selfIdentity` | `string` | - |\n| `input.standingInstructions` | `Iterable`<[`Tokenizable`](../../../../../common/classes/Tokenizable.md)> | - |\n| `input.systemPrompt` | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | - |\n| `input.thoughts` | `Iterable`<[`Thought`](../../../../../common/classes/Thought.md)> | - |\n| `input.thoughtSurfacing` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | - |\n| `input.toolCalls` | `Iterable`<[`ToolCall`](../../../../../forge/classes/ToolCall.md)> | - |\n| `input.tools` | [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | - |\n| `input.toolsToTransformersJsTools` | (`tools`: readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[], `deps`: { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); }) => [`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[] | - |\n| `input.unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<{\n`audio`: `unknown`\\[];\n`images`: `unknown`\\[];\n`messages`: `Message`\\[];\n`tools`: [`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[];\n}>\n\n## Remarks\n\nLeading buckets (system prompt + standing instructions / memories / retrievables) render into a\nsingle `system` message; the timeline (messages, surviving thoughts, tool calls — chronological)\nrenders into `user`/`assistant`/`tool` messages. Tools are returned separately for the `tools`\ngenerate-kwarg. Mirrors `buildLiteRtConversationInput`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoReasoningParser","title":"Variable: defaultCreateAutoReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoReasoningParser.md\ndescription: 'Default [`createAutoReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoReasoningParser).'\n---\n\n# Variable: defaultCreateAutoReasoningParser\n\n```ts\nconst defaultCreateAutoReasoningParser: (\n parsers: Partial<\n Record, ReasoningParserFn>\n >,\n order: readonly (\"think_tag\" | \"harmony_analysis\" | \"gemma_channel\")[],\n) => ReasoningParserFn = createAutoReasoningParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:323](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L323)\n\nDefault [createAutoReasoningParser](../functions/createAutoReasoningParser.md).\n\nCompose an `'auto'` reasoning parser: run each parser in `order` until one returns a non-empty\n`reasoning` array; that result wins. Returns no-match if none claim the text.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ReasoningParserName`](../type-aliases/ReasoningParserName.md), `\"auto\"` | `\"none\"`>, [`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)>> | `BUNDLED_REASONING_PARSERS` |\n| `order` | readonly (`\"think_tag\"` | `\"harmony_analysis\"` | `\"gemma_channel\"`)\\[] | `DEFAULT_REASONING_PARSER_ORDER` |\n\n## Returns\n\n[`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoToolCallParser","title":"Variable: defaultCreateAutoToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateAutoToolCallParser.md\ndescription: 'Default [`createAutoToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createAutoToolCallParser).'\n---\n\n# Variable: defaultCreateAutoToolCallParser\n\n```ts\nconst defaultCreateAutoToolCallParser: (\n parsers: Partial<\n Record, ToolCallParserFn>\n >,\n order: readonly (\n | \"gemma\"\n | \"hermes\"\n | \"gpt_oss\"\n | \"pythonic\"\n | \"bare_pythonic\"\n | \"loose_keyed\"\n | \"llama3_json\"\n | \"mistral\"\n | \"qwen3_coder\"\n | \"phi\"\n )[],\n) => ToolCallParserFn = createAutoToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1112)\n\nDefault [createAutoToolCallParser](../functions/createAutoToolCallParser.md).\n\nCompose an `'auto'` parser: run each family parser in `order` until one returns a non-empty\n`calls` array; that result wins. Returns no-match if none claim the text.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ToolCallParserName`](../type-aliases/ToolCallParserName.md), `\"auto\"` | `\"none\"`>, [`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)>> | `BUNDLED_TOOL_CALL_PARSERS` |\n| `order` | readonly ( | `\"gemma\"` | `\"hermes\"` | `\"gpt_oss\"` | `\"pythonic\"` | `\"bare_pythonic\"` | `\"loose_keyed\"` | `\"llama3_json\"` | `\"mistral\"` | `\"qwen3_coder\"` | `\"phi\"`)\\[] | `DEFAULT_TOOL_CALL_PARSER_ORDER` |\n\n## Returns\n\n[`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateTransformersJsStreamAccumulator","title":"Variable: defaultCreateTransformersJsStreamAccumulator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateTransformersJsStreamAccumulator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateTransformersJsStreamAccumulator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultCreateTransformersJsStreamAccumulator.md\ndescription: 'Default [`createTransformersJsStreamAccumulator`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/createTransformersJsStreamAccumulator).'\n---\n\n# Variable: defaultCreateTransformersJsStreamAccumulator\n\n```ts\nconst defaultCreateTransformersJsStreamAccumulator: () => TransformersJsStreamAccumulator =\n createTransformersJsStreamAccumulator;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:613](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L613)\n\nDefault [createTransformersJsStreamAccumulator](../functions/createTransformersJsStreamAccumulator.md).\n\nCreate a [TransformersJsStreamAccumulator](../interfaces/TransformersJsStreamAccumulator.md).\n\n## Returns\n\n[`TransformersJsStreamAccumulator`](../interfaces/TransformersJsStreamAccumulator.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultEmitLifecycle","title":"Variable: defaultEmitLifecycle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultEmitLifecycle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultEmitLifecycle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultEmitLifecycle.md\ndescription: 'Default [`emitLifecycle`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/emitLifecycle).'\n---\n\n# Variable: defaultEmitLifecycle\n\n```ts\nconst defaultEmitLifecycle: (\n hooks: BatteryLifecycleHooks | undefined,\n battery: BatteryLifecycleBattery,\n model: string,\n phase: BatteryLifecyclePhase,\n extra?: Partial<\n Pick<\n BatteryLifecycleReport,\n \"error\" | \"raw\" | \"progress\" | \"detail\" | \"gpuBudget\"\n >\n >,\n now: () => string,\n) => void = emitLifecycle;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/lifecycle.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L170)\n\nDefault [emitLifecycle](../functions/emitLifecycle.md).\n\nBuild a [BatteryLifecycleReport](../interfaces/BatteryLifecycleReport.md) (stamping `at`) and dispatch it to the firehose\n([BatteryLifecycleHooks.onLifecycle](../interfaces/BatteryLifecycleHooks.md#property-onlifecycle)) AND the per-phase hook for `phase`. A no-op when `hooks`\nis undefined or carries no relevant callbacks. Defensive: each callback is invoked through\nsafeInvoke, so a throwing consumer never disrupts the battery.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |\n| `hooks` | | [`BatteryLifecycleHooks`](../interfaces/BatteryLifecycleHooks.md) | `undefined` | The merged lifecycle hooks (may be undefined). |\n| `battery` | [`BatteryLifecycleBattery`](../type-aliases/BatteryLifecycleBattery.md) | Which battery is emitting. |\n| `model` | `string` | Best-effort model id string. |\n| `phase` | [`BatteryLifecyclePhase`](../type-aliases/BatteryLifecyclePhase.md) | The phase being entered. |\n| `extra?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<[`BatteryLifecycleReport`](../interfaces/BatteryLifecycleReport.md), `\"error\"` | `\"raw\"` | `\"progress\"` | `\"detail\"` | `\"gpuBudget\"`>> | Optional `detail` / `progress` / `raw` / `error` fields. |\n| `now?` | () => `string` | Injectable clock for tests; defaults to luxon `DateTime.now().toISO()`. |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaChannelReasoningParser","title":"Variable: defaultGemmaChannelReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaChannelReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaChannelReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaChannelReasoningParser.md\ndescription: 'Default [`gemmaChannelReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaChannelReasoningParser).'\n---\n\n# Variable: defaultGemmaChannelReasoningParser\n\n```ts\nconst defaultGemmaChannelReasoningParser: ReasoningParserFn =\n gemmaChannelReasoningParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:262](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L262)\n\nDefault [gemmaChannelReasoningParser](gemmaChannelReasoningParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaToolCallParser","title":"Variable: defaultGemmaToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGemmaToolCallParser.md\ndescription: 'Default [`gemmaToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaToolCallParser).'\n---\n\n# Variable: defaultGemmaToolCallParser\n\n```ts\nconst defaultGemmaToolCallParser: ToolCallParserFn = gemmaToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:587](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L587)\n\nDefault [gemmaToolCallParser](gemmaToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGptOssToolCallParser","title":"Variable: defaultGptOssToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGptOssToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGptOssToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultGptOssToolCallParser.md\ndescription: 'Default [`gptOssToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gptOssToolCallParser).'\n---\n\n# Variable: defaultGptOssToolCallParser\n\n```ts\nconst defaultGptOssToolCallParser: ToolCallParserFn = gptOssToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:634](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L634)\n\nDefault [gptOssToolCallParser](gptOssToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHarmonyAnalysisReasoningParser","title":"Variable: defaultHarmonyAnalysisReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHarmonyAnalysisReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHarmonyAnalysisReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHarmonyAnalysisReasoningParser.md\ndescription: 'Default [`harmonyAnalysisReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/harmonyAnalysisReasoningParser).'\n---\n\n# Variable: defaultHarmonyAnalysisReasoningParser\n\n```ts\nconst defaultHarmonyAnalysisReasoningParser: ReasoningParserFn =\n harmonyAnalysisReasoningParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L235)\n\nDefault [harmonyAnalysisReasoningParser](harmonyAnalysisReasoningParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHermesToolCallParser","title":"Variable: defaultHermesToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHermesToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHermesToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultHermesToolCallParser.md\ndescription: 'Default [`hermesToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/hermesToolCallParser).'\n---\n\n# Variable: defaultHermesToolCallParser\n\n```ts\nconst defaultHermesToolCallParser: ToolCallParserFn = hermesToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:192](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L192)\n\nDefault [hermesToolCallParser](hermesToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLlama3JsonToolCallParser","title":"Variable: defaultLlama3JsonToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLlama3JsonToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLlama3JsonToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLlama3JsonToolCallParser.md\ndescription: 'Default [`llama3JsonToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/llama3JsonToolCallParser).'\n---\n\n# Variable: defaultLlama3JsonToolCallParser\n\n```ts\nconst defaultLlama3JsonToolCallParser: ToolCallParserFn =\n llama3JsonToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:909](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L909)\n\nDefault [llama3JsonToolCallParser](llama3JsonToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLooseKeyedToolCallParser","title":"Variable: defaultLooseKeyedToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLooseKeyedToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLooseKeyedToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultLooseKeyedToolCallParser.md\ndescription: 'Default [`looseKeyedToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/looseKeyedToolCallParser).'\n---\n\n# Variable: defaultLooseKeyedToolCallParser\n\n```ts\nconst defaultLooseKeyedToolCallParser: ToolCallParserFn =\n looseKeyedToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:850](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L850)\n\nDefault [looseKeyedToolCallParser](looseKeyedToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMediaToTransformersInput","title":"Variable: defaultMediaToTransformersInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMediaToTransformersInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMediaToTransformersInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMediaToTransformersInput.md\ndescription: 'Default [`mediaToTransformersInput`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/mediaToTransformersInput).'\n---\n\n# Variable: defaultMediaToTransformersInput\n\n```ts\nconst defaultMediaToTransformersInput: (\n media: Media,\n opts?: {\n audioSampleRate?: number;\n },\n) => Promise<{\n data: unknown;\n kind: \"audio\" | \"image\";\n}> = mediaToTransformersInput;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:582](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L582)\n\nDefault [mediaToTransformersInput](../functions/mediaToTransformersInput.md).\n\nDecode an ADK [@nhtio/adk!Media](../../../../../common/classes/Media.md) into a transformers.js multimodal input.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | ------------------------------------------------- |\n| `media` | [`Media`](../../../../../common/classes/Media.md) |\n| `opts?` | { `audioSampleRate?`: `number`; } |\n| `opts.audioSampleRate?` | `number` |\n\n## Returns\n\n`Promise`<{\n`data`: `unknown`;\n`kind`: `\"audio\"` | `\"image\"`;\n}>\n\n## Remarks\n\nImage → `RawImage.fromBlob(...)`; audio → `Float32Array` PCM at the model's sample rate (16 kHz\ndefault) via `read_audio` over a `data:` URL. Imports `@huggingface/transformers` lazily, so it's\nonly loaded on the multimodal path. (Verified against a real Gemma-4 run — see plan 0a.)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMistralToolCallParser","title":"Variable: defaultMistralToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMistralToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMistralToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultMistralToolCallParser.md\ndescription: 'Default [`mistralToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/mistralToolCallParser).'\n---\n\n# Variable: defaultMistralToolCallParser\n\n```ts\nconst defaultMistralToolCallParser: ToolCallParserFn = mistralToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:946](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L946)\n\nDefault [mistralToolCallParser](mistralToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneReasoningParser","title":"Variable: defaultNoneReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneReasoningParser.md\ndescription: 'Default [`noneReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneReasoningParser).'\n---\n\n# Variable: defaultNoneReasoningParser\n\n```ts\nconst defaultNoneReasoningParser: ReasoningParserFn = noneReasoningParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L270)\n\nDefault [noneReasoningParser](noneReasoningParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneToolCallParser","title":"Variable: defaultNoneToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultNoneToolCallParser.md\ndescription: 'Default [`noneToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneToolCallParser).'\n---\n\n# Variable: defaultNoneToolCallParser\n\n```ts\nconst defaultNoneToolCallParser: ToolCallParserFn = noneToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1045](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1045)\n\nDefault [noneToolCallParser](noneToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPhiToolCallParser","title":"Variable: defaultPhiToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPhiToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPhiToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPhiToolCallParser.md\ndescription: 'Default [`phiToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/phiToolCallParser).'\n---\n\n# Variable: defaultPhiToolCallParser\n\n```ts\nconst defaultPhiToolCallParser: ToolCallParserFn = phiToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1037](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1037)\n\nDefault [phiToolCallParser](phiToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPythonicToolCallParser","title":"Variable: defaultPythonicToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPythonicToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPythonicToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultPythonicToolCallParser.md\ndescription: 'Default [`pythonicToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/pythonicToolCallParser).'\n---\n\n# Variable: defaultPythonicToolCallParser\n\n```ts\nconst defaultPythonicToolCallParser: ToolCallParserFn = pythonicToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:735](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L735)\n\nDefault [pythonicToolCallParser](pythonicToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultQwen3CoderToolCallParser","title":"Variable: defaultQwen3CoderToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultQwen3CoderToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultQwen3CoderToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultQwen3CoderToolCallParser.md\ndescription: 'Default [`qwen3CoderToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/qwen3CoderToolCallParser).'\n---\n\n# Variable: defaultQwen3CoderToolCallParser\n\n```ts\nconst defaultQwen3CoderToolCallParser: ToolCallParserFn =\n qwen3CoderToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:974](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L974)\n\nDefault [qwen3CoderToolCallParser](qwen3CoderToolCallParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderArtifactHandleBody","title":"Variable: defaultRenderArtifactHandleBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderArtifactHandleBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderArtifactHandleBody.md\ndescription: >-\n Default handle-body renderer for tool-call artifacts; the\n `renderArtifactHandleBody` override falls back to this.\n---\n\n# Variable: defaultRenderArtifactHandleBody\n\n```ts\nconst defaultRenderArtifactHandleBody: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n}) => string = renderArtifactHandleBody;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L515)\n\nDefault handle-body renderer for tool-call artifacts; the `renderArtifactHandleBody` override falls back to this.\n\nRender the \"handle\" body for a tool call's spooled-artifact result marked `inline: false`. See\nbuildHandleBody for the shared mechanics; this variant's leading sentence frames the\nartifact as a tool result.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; } |\n| `input.artifact` | `unknown` |\n| `input.byteLength` | `number` |\n| `input.callId` | `string` |\n| `input.encoding?` | `string` |\n| `input.estimatedTokens?` | `number` |\n| `input.lineCount` | `number` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderTransformersJsToolResult","title":"Variable: defaultRenderTransformersJsToolResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderTransformersJsToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderTransformersJsToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultRenderTransformersJsToolResult.md\ndescription: 'Default [`renderTransformersJsToolResult`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/renderTransformersJsToolResult).'\n---\n\n# Variable: defaultRenderTransformersJsToolResult\n\n```ts\nconst defaultRenderTransformersJsToolResult: (input: {\n renderArtifactHandleBody?: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n }) => string;\n renderTrustedContent: (content: string, attrs: TrustedContentAttrs) => string;\n renderUntrustedContent: (\n content: string,\n attrs: UntrustedContentAttrs,\n ) => string;\n results: Tokenizable | SpooledArtifact | Media | Media[] | SpooledArtifact[];\n tool: Tool | ArtifactTool | undefined;\n toolCall: ToolCall;\n unsupportedMediaPolicy: UnsupportedMediaPolicy;\n warn?: (msg: string) => void;\n}) => Promise = renderTransformersJsToolResult;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L278)\n\nDefault [renderTransformersJsToolResult](../functions/renderTransformersJsToolResult.md).\n\nRender a [@nhtio/adk!ToolCall](../../../../../forge/classes/ToolCall.md)'s `results` into a plain-text tool message body.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `renderArtifactHandleBody?`: (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string`; `renderTrustedContent`: (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string`; `renderUntrustedContent`: (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string`; `results`: | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[]; `tool`: | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined`; `toolCall`: [`ToolCall`](../../../../../forge/classes/ToolCall.md); `unsupportedMediaPolicy`: [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md); `warn?`: (`msg`: `string`) => `void`; } | - |\n| `input.renderArtifactHandleBody?` | (`input`: { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; }) => `string` | Override for the artifact-handle body renderer (see [renderArtifactHandleBody](../functions/renderArtifactHandleBody.md)). Defaults to the shared [defaultRenderArtifactHandleBody](defaultRenderArtifactHandleBody.md). The adapter threads the consumer's `helpers.renderArtifactHandleBody` here so an app can change which forged `artifact_*` reader the model is steered toward first. |\n| `input.renderTrustedContent` | (`content`: `string`, `attrs`: [`TrustedContentAttrs`](../../../../interfaces/TrustedContentAttrs.md)) => `string` | - |\n| `input.renderUntrustedContent` | (`content`: `string`, `attrs`: [`UntrustedContentAttrs`](../../../../interfaces/UntrustedContentAttrs.md)) => `string` | - |\n| `input.results` | | [`Tokenizable`](../../../../../common/classes/Tokenizable.md) | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md) | [`Media`](../../../../../common/classes/Media.md) | [`Media`](../../../../../common/classes/Media.md)\\[] | [`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)\\[] | - |\n| `input.tool` | | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md) | `undefined` | - |\n| `input.toolCall` | [`ToolCall`](../../../../../forge/classes/ToolCall.md) | - |\n| `input.unsupportedMediaPolicy` | [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md) | - |\n| `input.warn?` | (`msg`: `string`) => `void` | - |\n\n## Returns\n\n`Promise`<`string`>\n\n## Remarks\n\ntransformers.js chat templates take a `tool`-role message whose `content` is a string. A\n`SpooledArtifact` result renders as a HANDLE (metadata + the forged `artifact_*` tools to read it)\nwhen its `ToolCall.inline === false` — the secure default — and inline via `asString()` only when a\nproducer opted into `inline: true`. Applies the trust envelope and degrades Media to text.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveGenerationOptions","title":"Variable: defaultResolveGenerationOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveGenerationOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveGenerationOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveGenerationOptions.md\ndescription: 'Default [`resolveGenerationOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveGenerationOptions).'\n---\n\n# Variable: defaultResolveGenerationOptions\n\n```ts\nconst defaultResolveGenerationOptions: (\n canonical: ChatGenerationOptions,\n nativeFallbacks: {\n enableThinking?: boolean;\n maxTokens?: number;\n multimodal?: {\n audio?: boolean;\n image?: boolean;\n };\n sampler?: ChatSampler;\n seed?: number;\n temperature?: number;\n topK?: number;\n topP?: number;\n },\n) => ResolvedGenerationOptions = resolveGenerationOptions;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/generation.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L145)\n\nDefault [resolveGenerationOptions](../functions/resolveGenerationOptions.md).\n\nResolve the canonical [ChatGenerationOptions](../interfaces/ChatGenerationOptions.md) (already merged across option layers) into a\nfully-defaulted [ResolvedGenerationOptions](../interfaces/ResolvedGenerationOptions.md). Native per-battery fallbacks are passed via\n`nativeFallbacks` and consulted ONLY when the canonical field is absent (canonical wins). The adapter\nthen maps the resolved shape onto its runtime API.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `canonical` | [`ChatGenerationOptions`](../interfaces/ChatGenerationOptions.md) | The canonical fields from the merged adapter options. |\n| `nativeFallbacks` | { `enableThinking?`: `boolean`; `maxTokens?`: `number`; `multimodal?`: { `audio?`: `boolean`; `image?`: `boolean`; }; `sampler?`: [`ChatSampler`](../type-aliases/ChatSampler.md); `seed?`: `number`; `temperature?`: `number`; `topK?`: `number`; `topP?`: `number`; } | Battery-native equivalents to fall back to when a canonical field is unset (e.g. transformers.js `maxNewTokens`, LiteRT `maxOutputTokens`). Each is consulted second. |\n| `nativeFallbacks.enableThinking?` | `boolean` | - |\n| `nativeFallbacks.maxTokens?` | `number` | - |\n| `nativeFallbacks.multimodal?` | { `audio?`: `boolean`; `image?`: `boolean`; } | - |\n| `nativeFallbacks.multimodal.audio?` | `boolean` | - |\n| `nativeFallbacks.multimodal.image?` | `boolean` | - |\n| `nativeFallbacks.sampler?` | [`ChatSampler`](../type-aliases/ChatSampler.md) | - |\n| `nativeFallbacks.seed?` | `number` | - |\n| `nativeFallbacks.temperature?` | `number` | - |\n| `nativeFallbacks.topK?` | `number` | - |\n| `nativeFallbacks.topP?` | `number` | - |\n\n## Returns\n\n[`ResolvedGenerationOptions`](../interfaces/ResolvedGenerationOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveReasoningParser","title":"Variable: defaultResolveReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveReasoningParser.md\ndescription: 'Default [`resolveReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveReasoningParser).'\n---\n\n# Variable: defaultResolveReasoningParser\n\n```ts\nconst defaultResolveReasoningParser: (\n option: ReasoningParserName | ReasoningParserFn | undefined,\n parsers: Partial<\n Record, ReasoningParserFn>\n >,\n opts: ReasoningParserOptions,\n) => ReasoningParserFn = resolveReasoningParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:355](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L355)\n\nDefault [resolveReasoningParser](../functions/resolveReasoningParser.md).\n\nResolve a `reasoningParser` option (a name, `'auto'`, `'none'`, or a custom fn) to a concrete\n[ReasoningParserFn](../type-aliases/ReasoningParserFn.md).\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `option` | | [`ReasoningParserName`](../type-aliases/ReasoningParserName.md) | [`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md) | `undefined` | `undefined` | The option value. Defaults to `'auto'` when undefined. |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ReasoningParserName`](../type-aliases/ReasoningParserName.md), `\"auto\"` | `\"none\"`>, [`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)>> | `BUNDLED_REASONING_PARSERS` | Override the bundled parsers. Ignored when `opts.orphanRecovery` is set (the bundled family parsers are rebuilt with that setting); pass a custom `option` fn for full control. |\n| `opts` | [`ReasoningParserOptions`](../interfaces/ReasoningParserOptions.md) | `{}` | [ReasoningParserOptions](../interfaces/ReasoningParserOptions.md); `orphanRecovery` defaults to `true`. When `false`, the named/auto bundled parsers are rebuilt in strict pair-only mode. |\n\n## Returns\n\n[`ReasoningParserFn`](../type-aliases/ReasoningParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveToolCallParser","title":"Variable: defaultResolveToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultResolveToolCallParser.md\ndescription: 'Default [`resolveToolCallParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/resolveToolCallParser).'\n---\n\n# Variable: defaultResolveToolCallParser\n\n```ts\nconst defaultResolveToolCallParser: (\n option: ToolCallParserName | ToolCallParserFn | undefined,\n parsers: Partial<\n Record, ToolCallParserFn>\n >,\n) => ToolCallParserFn = resolveToolCallParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1135)\n\nDefault [resolveToolCallParser](../functions/resolveToolCallParser.md).\n\nResolve a `toolCallParser` option (a name, `'auto'`, `'none'`, or a custom fn) to a concrete\n[ToolCallParserFn](../type-aliases/ToolCallParserFn.md).\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ----------------------------------------------------------------- |\n| `option` | | [`ToolCallParserName`](../type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md) | `undefined` | `undefined` | The option value. Defaults to `'auto'` when undefined. |\n| `parsers` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<[`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludetype-excludedunion)<[`ToolCallParserName`](../type-aliases/ToolCallParserName.md), `\"auto\"` | `\"none\"`>, [`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)>> | `BUNDLED_TOOL_CALL_PARSERS` | Override the bundled family parsers (e.g. swap the Gemma parser). |\n\n## Returns\n\n[`ToolCallParserFn`](../type-aliases/ToolCallParserFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultThinkTagReasoningParser","title":"Variable: defaultThinkTagReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultThinkTagReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultThinkTagReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultThinkTagReasoningParser.md\ndescription: 'Default [`thinkTagReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/thinkTagReasoningParser).'\n---\n\n# Variable: defaultThinkTagReasoningParser\n\n```ts\nconst defaultThinkTagReasoningParser: ReasoningParserFn =\n thinkTagReasoningParser;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L209)\n\nDefault [thinkTagReasoningParser](thinkTagReasoningParser.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultToolsToTransformersJsTools","title":"Variable: defaultToolsToTransformersJsTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultToolsToTransformersJsTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultToolsToTransformersJsTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/defaultToolsToTransformersJsTools.md\ndescription: 'Default [`toolsToTransformersJsTools`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/toolsToTransformersJsTools).'\n---\n\n# Variable: defaultToolsToTransformersJsTools\n\n```ts\nconst defaultToolsToTransformersJsTools: (\n tools: readonly (Tool | ArtifactTool)[],\n deps: {\n descriptionToChatCompletionsJsonSchema: (d: DescriptionLike) => JsonSchema;\n },\n) => TransformersJsTool[] = toolsToTransformersJsTools;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/helpers.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/helpers.ts#L151)\n\nDefault [toolsToTransformersJsTools](../functions/toolsToTransformersJsTools.md).\n\nConvert ADK [@nhtio/adk!Tool](../../../../../forge/classes/Tool.md) / [@nhtio/adk!ArtifactTool](../../../../../forge/classes/ArtifactTool.md) instances into the\ntransformers.js `tools` array shape (OpenAI-function-shaped — what `apply_chat_template` expects).\n\n## Parameters\n\n| Parameter | Type |\n| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tools` | readonly ( | [`Tool`](../../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../../spooled_artifact/classes/SpooledArtifact.md)> | [`ArtifactTool`](../../../../../forge/classes/ArtifactTool.md))\\[] |\n| `deps` | { `descriptionToChatCompletionsJsonSchema`: (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md); } |\n| `deps.descriptionToChatCompletionsJsonSchema` | (`d`: [`DescriptionLike`](../../../../interfaces/DescriptionLike.md)) => [`JsonSchema`](../../../../interfaces/JsonSchema.md) |\n\n## Returns\n\n[`TransformersJsTool`](../interfaces/TransformersJsTool.md)\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaChannelReasoningParser","title":"Variable: gemmaChannelReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaChannelReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaChannelReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaChannelReasoningParser.md\ndescription: 'Default [`makeGemmaChannelReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeGemmaChannelReasoningParser) (orphan recovery on).'\n---\n\n# Variable: gemmaChannelReasoningParser\n\n```ts\nconst gemmaChannelReasoningParser: ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L259)\n\nDefault [makeGemmaChannelReasoningParser](../functions/makeGemmaChannelReasoningParser.md) (orphan recovery on).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaToolCallParser","title":"Variable: gemmaToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gemmaToolCallParser.md\ndescription: >-\n Parse Gemma E2B/E4B tool calls. Accepts the wrapped template form\n (`<|tool_call>call:NAME{k:<|\"|>v<|\"|>}`) AND the decoder-stripped\n runtime form (`call:NAME{k:v}`, special tokens removed, scalars unquoted — the\n shape a real ONNX run emits), including NESTED argument blocks with curly\n smart quotes (the form a real E4B `provide_answer` emits:\n `{answer:<|“|>…<|”|>,sources:[{path:…}]}`), AND the PREFIX-LESS bare form\n `NAME{…}` with no `call:` lead (e.g. `say_i_dont_know{reason: \"…\"}` — a real\n E2B/E4B runtime shape), gated on `ctx.toolNames`. Targets the E2B/E4B form\n only — Gemma 3 (`tool_code` fences) and FunctionGemma\n (``) are out of scope (use a custom {@link\n ToolCallParserFn}).\n---\n\n# Variable: gemmaToolCallParser\n\n```ts\nconst gemmaToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:566](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L566)\n\nParse Gemma E2B/E4B tool calls. Accepts the wrapped template form\n(`<|tool_call>call:NAME{k:<|\"|>v<|\"|>}`) AND the decoder-stripped runtime form\n(`call:NAME{k:v}`, special tokens removed, scalars unquoted — the shape a real ONNX run emits),\nincluding NESTED argument blocks with curly smart quotes (the form a real E4B `provide_answer`\nemits: `{answer:<|“|>…<|”|>,sources:[{path:…}]}`), AND the PREFIX-LESS bare form `NAME{…}` with no\n`call:` lead (e.g. `say_i_dont_know{reason: \"…\"}` — a real E2B/E4B runtime shape), gated on\n`ctx.toolNames`. Targets the E2B/E4B form only — Gemma 3 (`tool_code` fences) and FunctionGemma\n(``) are out of scope (use a custom [ToolCallParserFn](../type-aliases/ToolCallParserFn.md)).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/GENERATION_DEFAULTS","title":"Variable: GENERATION\\_DEFAULTS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/GENERATION_DEFAULTS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/GENERATION_DEFAULTS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/GENERATION_DEFAULTS.md\ndescription: 'Deterministic-friendly defaults, identical across batteries.'\n---\n\n# Variable: GENERATION\\_DEFAULTS\n\n```ts\nconst GENERATION_DEFAULTS: ResolvedGenerationOptions;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/generation.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/generation.ts#L83)\n\nDeterministic-friendly defaults, identical across batteries.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gptOssToolCallParser","title":"Variable: gptOssToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gptOssToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gptOssToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/gptOssToolCallParser.md\ndescription: >-\n Parse gpt-oss Harmony tool calls on the `commentary` channel:\n `<|channel|>commentary to=functions.NAME\n <|constrain|>json<|message|>{…}<|call|>`. The arguments payload after\n `<|message|>` is JSON, located by a string-aware balanced-brace scan so an\n embedded `<|call|>` / brace inside a string value survives. Anchored on the\n literal Harmony markers.\n---\n\n# Variable: gptOssToolCallParser\n\n```ts\nconst gptOssToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:607](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L607)\n\nParse gpt-oss Harmony tool calls on the `commentary` channel:\n`<|channel|>commentary to=functions.NAME <|constrain|>json<|message|>{…}<|call|>`. The arguments\npayload after `<|message|>` is JSON, located by a string-aware balanced-brace scan so an embedded\n`<|call|>` / brace inside a string value survives. Anchored on the literal Harmony markers.\n\n## Remarks\n\nThe Harmony channel/constrain ordering has a documented upstream template-vs-spec drift;\nthis matches the common ordering. Verify against a real gpt-oss ONNX run when one is available.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/harmonyAnalysisReasoningParser","title":"Variable: harmonyAnalysisReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/harmonyAnalysisReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/harmonyAnalysisReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/harmonyAnalysisReasoningParser.md\ndescription: 'Default [`makeHarmonyAnalysisReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeHarmonyAnalysisReasoningParser) (orphan recovery on).'\n---\n\n# Variable: harmonyAnalysisReasoningParser\n\n```ts\nconst harmonyAnalysisReasoningParser: ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L231)\n\nDefault [makeHarmonyAnalysisReasoningParser](../functions/makeHarmonyAnalysisReasoningParser.md) (orphan recovery on).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/hermesToolCallParser","title":"Variable: hermesToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/hermesToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/hermesToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/hermesToolCallParser.md\ndescription: >-\n Parse Hermes-style `{\"name\":…,\"arguments\":{…}}` tags.\n The de-facto standard, reused by Qwen2.5/Qwen3-Instruct. Anchored on the\n literal tags — zero collision with bare JSON.\n---\n\n# Variable: hermesToolCallParser\n\n```ts\nconst hermesToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L158)\n\nParse Hermes-style `{\"name\":…,\"arguments\":{…}}` tags. The de-facto standard,\nreused by Qwen2.5/Qwen3-Instruct. Anchored on the literal tags — zero collision with bare JSON.\n\n## Remarks\n\nThe JSON object after each `` is located by a string-aware balanced-brace scan (not a lazy\n`` regex), so an embedded `` or `{`/`}` inside a string argument value (e.g.\n`{\"text\":\"\"}`) survives instead of truncating the call. The literal `` close\nis still consumed for span removal when present immediately after the object.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/llama3JsonToolCallParser","title":"Variable: llama3JsonToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/llama3JsonToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/llama3JsonToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/llama3JsonToolCallParser.md\ndescription: >-\n Parse bare top-level JSON tool call(s) — `{\"name\":\"x\",\"parameters\":{…}}` (or\n `\"arguments\"`), optionally wrapped in a ```` ```json … ``` ```` fence (a\n common small-model emission — verified via the real-model matrix on\n Qwen2.5-Coder-0.5B). The weakest signal, so it is gated hard: after\n un-fencing, the output must be ONLY top-level JSON object(s) AND every callee\n must be a real tool (`ctx.toolNames`). Runs after every marker-anchored family\n in `'auto'`.\n---\n\n# Variable: llama3JsonToolCallParser\n\n```ts\nconst llama3JsonToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:882](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L882)\n\nParse bare top-level JSON tool call(s) — `{\"name\":\"x\",\"parameters\":{…}}` (or `\"arguments\"`),\noptionally wrapped in a ` ```json … ``` ` fence (a common small-model emission — verified via\nthe real-model matrix on Qwen2.5-Coder-0.5B). The weakest signal, so it is gated hard: after\nun-fencing, the output must be ONLY top-level JSON object(s) AND every callee must be a real tool\n(`ctx.toolNames`). Runs after every marker-anchored family in `'auto'`.\n\n## Remarks\n\n**Parallel calls.** Small Llama-family / Qwen-Coder models emit MULTIPLE calls as several top-level\nobjects separated by `,` / `;` / whitespace (verified on the real-model matrix:\nLlama-3.2-1B → `{…}; {…}`, Qwen2.5-Coder-0.5B → a fenced `{…},\\n{…}`). So we string-aware brace-scan\nthe (un-fenced) text into successive balanced `{…}` objects, accepting only the separators above\nbetween them — if any NON-separator prose sits between or around the objects, the whole thing declines\n(the hard whole-output gate, so this never false-positives on JSON embedded in a sentence).\n\n**Disambiguation, NOT authorization.** This parser is marker-free, so it must distinguish a tool call\nfrom arbitrary JSON content. It does that STRUCTURALLY: whole-output-is-object(s) + each object has a\nstring `name`. It deliberately does NOT check the callee against `ctx.toolNames` — whether a requested\ntool is *allowed* is the consumer's decision, not the parser's. An unknown-tool call is surfaced like\nany other; the dispatch layer already replies \"Tool not found: … Available tools: …\" so the model can\nself-correct. Silently dropping the call here would hide both the request and that feedback loop.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/looseKeyedToolCallParser","title":"Variable: looseKeyedToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/looseKeyedToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/looseKeyedToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/looseKeyedToolCallParser.md\ndescription: >-\n Parse the DEGENERATE keyed form a small instruct model emits when it ignores\n every structured tool-call grammar: the bare tool NAME on its own line, then\n one or more `argname: value` lines.\n---\n\n# Variable: looseKeyedToolCallParser\n\n```ts\nconst looseKeyedToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:815](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L815)\n\nParse the DEGENERATE keyed form a small instruct model emits when it ignores every structured\ntool-call grammar: the bare tool NAME on its own line, then one or more `argname: value` lines.\n\n## Remarks\n\nObserved verbatim from **Gemma-4 E2B on LiteRT-web** (raw-captured): asked to call an answer tool it\nemits, with no `call:`/braces/brackets/JSON at all —\n\n```\nsay_i_dont_know\nreason: The documentation does not contain a definition for that.\n```\n\nNo marker-anchored or pythonic/JSON parser claims this, so the \"call\" leaks into the visible answer as\nprose AND the turn looks like a refusal (the tool the model meant to invoke never fires). A 2B can't\nbe reliably *instructed* into a format (changing the prompt's documented format did not change the\noutput), so the robust path is to parse the shape it actually produces.\n\nWEAK SIGNAL, gated HARD (like [barePythonicToolCallParser](barePythonicToolCallParser.md)): it only claims when the FIRST\nnon-empty line is EXACTLY a real offered tool name (`ctx.toolNames`) and is followed by at least one\n`key: value` line. That gate is what keeps it from misreading ordinary prose (\"Note: …\", a heading\nwith a colon). Single call only (the degenerate form has no list syntax); runs LAST in `'auto'`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/mistralToolCallParser","title":"Variable: mistralToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/mistralToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/mistralToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/mistralToolCallParser.md\ndescription: >-\n Parse Mistral tool calls — the `[TOOL_CALLS]` token followed by a JSON array\n of `{ name, arguments }`. Anchored on the literal `[TOOL_CALLS]` token.\n---\n\n# Variable: mistralToolCallParser\n\n```ts\nconst mistralToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:924](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L924)\n\nParse Mistral tool calls — the `[TOOL_CALLS]` token followed by a JSON array of\n`{ name, arguments }`. Anchored on the literal `[TOOL_CALLS]` token.\n\n## Remarks\n\nThe array is located by a string-aware balanced-bracket scan from the first `[` after the token (same\napproach as [phiToolCallParser](phiToolCallParser.md)), so a `]` inside a string argument value (e.g.\n`{\"text\":\"a]b\"}`) does not truncate the array the way the old greedy `\\[[\\s\\S]*\\]` regex did.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneReasoningParser","title":"Variable: noneReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneReasoningParser.md\ndescription: A parser that never extracts anything — disables reasoning parsing entirely.\n---\n\n# Variable: noneReasoningParser\n\n```ts\nconst noneReasoningParser: ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:267](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L267)\n\nA parser that never extracts anything — disables reasoning parsing entirely.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneToolCallParser","title":"Variable: noneToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/noneToolCallParser.md\ndescription: A parser that never extracts anything — disables tool-call parsing entirely.\n---\n\n# Variable: noneToolCallParser\n\n```ts\nconst noneToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:1042](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L1042)\n\nA parser that never extracts anything — disables tool-call parsing entirely.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/phiToolCallParser","title":"Variable: phiToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/phiToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/phiToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/phiToolCallParser.md\ndescription: >-\n Parse Phi-4-mini tool calls: the literal `functools` token followed by a JSON\n array of `{ name, arguments }` objects (e.g.\n `functools[{\"name\":\"get_weather\",\"arguments\":{\"city\":\"SF\"}}]`).\n---\n\n# Variable: phiToolCallParser\n\n```ts\nconst phiToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:993](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L993)\n\nParse Phi-4-mini tool calls: the literal `functools` token followed by a JSON array of\n`{ name, arguments }` objects (e.g. `functools[{\"name\":\"get_weather\",\"arguments\":{\"city\":\"SF\"}}]`).\n\n## Remarks\n\nAnchored on the `functools` begin-of-tool token (vLLM's `phi4_mini_json`). The array is located by\nscanning for the first `[` after the token and matching to its balanced closing `]`, so trailing\nprose after the call does not break parsing. Declines (no-match) if the payload is not a JSON array\nof name-bearing objects.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/pythonicToolCallParser","title":"Variable: pythonicToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/pythonicToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/pythonicToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/pythonicToolCallParser.md\ndescription: >-\n Parse pythonic tool calls — `[get_weather(city='SF'), get_time()]`. Requires\n the **whole trimmed output** to be the bracketed call list, so it cannot\n false-positive on incidental prose. Parallel calls are inherent to the format.\n---\n\n# Variable: pythonicToolCallParser\n\n```ts\nconst pythonicToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:716](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L716)\n\nParse pythonic tool calls — `[get_weather(city='SF'), get_time()]`. Requires the **whole trimmed\noutput** to be the bracketed call list, so it cannot false-positive on incidental prose. Parallel\ncalls are inherent to the format.\n\n**Disambiguation, NOT authorization.** The `[fn(args), …]` shape (whole-output) is the structural\nsignal that this is a call list. It deliberately does NOT check callees against `ctx.toolNames` —\nwhether a tool is *allowed* is the consumer's call, and the dispatch layer already replies \"Tool not\nfound: … Available tools: …\" so the model can self-correct. Dropping an unknown-tool call here would\nhide the request and that feedback loop.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/qwen3CoderToolCallParser","title":"Variable: qwen3CoderToolCallParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/qwen3CoderToolCallParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/qwen3CoderToolCallParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/qwen3CoderToolCallParser.md\ndescription: Parse Qwen3-Coder's custom per-parameter XML —\n---\n\n# Variable: qwen3CoderToolCallParser\n\n```ts\nconst qwen3CoderToolCallParser: ToolCallParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/tool\\_parsers.ts:959](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/tool_parsers.ts#L959)\n\nParse Qwen3-Coder's custom per-parameter XML — `v\n…`. Values are taken as trimmed strings (the format is untyped). Anchored on\nthe literal ``.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/thinkTagReasoningParser","title":"Variable: thinkTagReasoningParser","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/thinkTagReasoningParser.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/thinkTagReasoningParser","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/variables/thinkTagReasoningParser.md\ndescription: 'Default [`makeThinkTagReasoningParser`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/helpers/functions/makeThinkTagReasoningParser) (orphan recovery on).'\n---\n\n# Variable: thinkTagReasoningParser\n\n```ts\nconst thinkTagReasoningParser: ReasoningParserFn;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/reasoning\\_parsers.ts:206](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/reasoning_parsers.ts#L206)\n\nDefault [makeThinkTagReasoningParser](../functions/makeThinkTagReasoningParser.md) (orphan recovery on).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source","title":"@nhtio/adk/batteries/llm/transformers\\_js/model\\_source","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/model_source.md\ndescription: >-\n Custom model-source resolver for transformers.js — the dual-environment seam\n that lets a consumer serve a model's files (each submodule ONNX, the\n tokenizer, the config) from anywhere: OPFS, a different repo per modality,\n bundled bytes, an in-memory map.\n---\n\n# @nhtio/adk/batteries/llm/transformers\\_js/model\\_source\n\nCustom model-source resolver for transformers.js — the dual-environment seam that lets a consumer\nserve a model's files (each submodule ONNX, the tokenizer, the config) from anywhere: OPFS, a\ndifferent repo per modality, bundled bytes, an in-memory map.\n\n## Remarks\n\n**Mechanism (verified against the installed `@huggingface/transformers` build, NODE + WEB, 8 refs\neach — ungated by `IS_NODE_ENV`):** transformers.js routes every model file through\n`env.customCache.match(key)` when `env.useCustomCache === true`. `match` may return a `Response`\n(bytes), a `string` (a path/URL the loader then fetches), or `undefined` (fall through to the normal\nHF download). This module installs a `customCache` whose `match` parses the loader's key back into\n`{repo, filename}` and delegates to the user's [TransformersJsModelSource](../types/type-aliases/TransformersJsModelSource.md) hook.\n\n**The cache key is the REMOTE URL, not `${repo}/${filename}` (corrected at impl from the plan's\nassumption).** `buildResourcePaths` computes `remoteURL = pathJoin(env.remoteHost,\nenv.remotePathTemplate.replace('{model}', repo).replace('{revision}', rev), filename)` →\n`https://huggingface.co//resolve//`. `tryCache` first probes the *local*\npath (no `/resolve/` segment — our parser returns `undefined`, so it correctly falls through) and\nthen this remote URL. [parseResourceKey](functions/parseResourceKey.md) reverses exactly that template.\n\n**`env` is a process-global singleton.** [withModelSource](functions/withModelSource.md) sets `useCustomCache`/`customCache`\nfor the duration of one load and restores the previous values after — behind a module-level async\nmutex so concurrent loads across adapters never observe each other's hook. [installModelSource](functions/installModelSource.md)\nis the lower-level set-and-return-a-restore-fn primitive for callers that manage their own scope.\n\nThe resolver does NOT implement OPFS/bundled reading — it is the plug; the consumer's hook is the\nimplementation. Reused verbatim by the embeddings battery (same `env` mechanism).\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [installModelSource](functions/installModelSource.md) | Install a model-source hook on `env` and return a restore function. Sets `useCustomCache = true` + `customCache`, capturing the previous values. The returned `restore()` puts them back. NOT mutex- guarded on its own — use [withModelSource](functions/withModelSource.md) for the scoped, serialized form. |\n| [modelSourceToCache](functions/modelSourceToCache.md) | Wrap a [TransformersJsModelSource](../types/type-aliases/TransformersJsModelSource.md) hook into a Web-Cache-API-compatible object suitable for `env.customCache`. `match` parses the key, calls the hook, and normalizes the result: `Uint8Array` → `new Response(bytes)`; `string`/`Response` pass through; `undefined`/throw → fall through. `put` is a no-op (served files are never re-cached — `toCacheResponse` is false for them). |\n| [parseResourceKey](functions/parseResourceKey.md) | Reverse `buildResourcePaths`' remote-URL key back into `{repo, filename}`. |\n| [withModelSource](functions/withModelSource.md) | Run `load()` with `hook` installed on `env`, then restore — serialized against every other `withModelSource` call so concurrent adapter loads never clobber the global `env`. The hook is only active for the duration of `load()`; after it resolves (or rejects) the prior `env` cache config is restored even on error. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/installModelSource","title":"Function: installModelSource()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/installModelSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/installModelSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/installModelSource.md\n---\n\n# Function: installModelSource()\n\n```ts\nfunction installModelSource(\n env: TransformersEnvLike,\n hook: TransformersJsModelSource,\n): () => void;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/model\\_source.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/model_source.ts#L131)\n\nInstall a model-source hook on `env` and return a restore function. Sets `useCustomCache = true` +\n`customCache`, capturing the previous values. The returned `restore()` puts them back. NOT mutex-\nguarded on its own — use [withModelSource](withModelSource.md) for the scoped, serialized form.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |\n| `env` | `TransformersEnvLike` | The transformers.js `env` object (from `await import('@huggingface/transformers')`). |\n| `hook` | [`TransformersJsModelSource`](../../types/type-aliases/TransformersJsModelSource.md) | The resolver to install. |\n\n## Returns\n\nA function that restores `env`'s prior cache configuration.\n\n() => `void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/modelSourceToCache","title":"Function: modelSourceToCache()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/modelSourceToCache.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/modelSourceToCache","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/modelSourceToCache.md\n---\n\n# Function: modelSourceToCache()\n\n```ts\nfunction modelSourceToCache(\n hook: TransformersJsModelSource,\n env?: {\n remoteHost?: string;\n remotePathTemplate?: string;\n },\n): TransformersCacheLike;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/model\\_source.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/model_source.ts#L95)\n\nWrap a [TransformersJsModelSource](../../types/type-aliases/TransformersJsModelSource.md) hook into a Web-Cache-API-compatible object suitable for\n`env.customCache`. `match` parses the key, calls the hook, and normalizes the result:\n`Uint8Array` → `new Response(bytes)`; `string`/`Response` pass through; `undefined`/throw → fall\nthrough. `put` is a no-op (served files are never re-cached — `toCacheResponse` is false for them).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |\n| `hook` | [`TransformersJsModelSource`](../../types/type-aliases/TransformersJsModelSource.md) | The consumer's resolver. |\n| `env` | { `remoteHost?`: `string`; `remotePathTemplate?`: `string`; } | Host/template for key parsing (defaults to the library defaults). |\n| `env.remoteHost?` | `string` | - |\n| `env.remotePathTemplate?` | `string` | - |\n\n## Returns\n\n`TransformersCacheLike`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/parseResourceKey","title":"Function: parseResourceKey()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/parseResourceKey.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/parseResourceKey","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/parseResourceKey.md\n---\n\n# Function: parseResourceKey()\n\n```ts\nfunction parseResourceKey(\n key: string,\n env?: {\n remoteHost?: string;\n remotePathTemplate?: string;\n },\n):\n | {\n filename: string;\n repo: string;\n }\n | undefined;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/model\\_source.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/model_source.ts#L62)\n\nReverse `buildResourcePaths`' remote-URL key back into `{repo, filename}`.\n\nHandles the canonical `{host}{model}/resolve/{revision}/{filename}` template. Returns `undefined`\nfor any key that is not a remote-host URL (e.g. the local-path probe `tryCache` issues first), so the\ncaller falls through to the default loader instead of mis-routing.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------- |\n| `key` | `string` | The string transformers.js passes to `cache.match` (the remote URL). |\n| `env` | { `remoteHost?`: `string`; `remotePathTemplate?`: `string`; } | The (possibly customized) host/template; defaults match the library's own defaults. |\n| `env.remoteHost?` | `string` | - |\n| `env.remotePathTemplate?` | `string` | - |\n\n## Returns\n\n| {\n`filename`: `string`;\n`repo`: `string`;\n}\n| `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/withModelSource","title":"Function: withModelSource()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/withModelSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/withModelSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/model_source/functions/withModelSource.md\n---\n\n# Function: withModelSource()\n\n```ts\nfunction withModelSource(\n env: TransformersEnvLike,\n hook: TransformersJsModelSource,\n load: () => Promise,\n): Promise;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/model\\_source.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/model_source.ts#L158)\n\nRun `load()` with `hook` installed on `env`, then restore — serialized against every other\n`withModelSource` call so concurrent adapter loads never clobber the global `env`. The hook is only\nactive for the duration of `load()`; after it resolves (or rejects) the prior `env` cache config is\nrestored even on error.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `T` |\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |\n| `env` | `TransformersEnvLike` | The transformers.js `env` object. |\n| `hook` | [`TransformersJsModelSource`](../../types/type-aliases/TransformersJsModelSource.md) | The resolver to install for this load. |\n| `load` | () => `Promise`<`T`> | The async load operation (e.g. `pipeline(...)` / `from_pretrained(...)`). |\n\n## Returns\n\n`Promise`<`T`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/MediaOutputExtractorFn","title":"Type Alias: MediaOutputExtractorFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/MediaOutputExtractorFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/MediaOutputExtractorFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/MediaOutputExtractorFn.md\ndescription: >-\n Extracts generated media from a battery's raw generation result so the adapter\n can surface it as assistant `Message.attachments`. Injectable + defaulted to\n absent (no media output) on every LLM battery, mirroring the `toolCallParser`\n / `reasoningParser` / `decodeMedia` injection seams.\n---\n\n# Type Alias: MediaOutputExtractorFn\n\n```ts\ntype MediaOutputExtractorFn = (\n result: unknown,\n) => GeneratedMediaOutput[] | Promise;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L326)\n\nExtracts generated media from a battery's raw generation result so the adapter can surface it as\nassistant `Message.attachments`. Injectable + defaulted to absent (no media output) on every LLM\nbattery, mirroring the `toolCallParser` / `reasoningParser` / `decodeMedia` injection seams.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `result` | `unknown` |\n\n## Returns\n\n| [`GeneratedMediaOutput`](../../../interfaces/GeneratedMediaOutput.md)\\[]\n| `Promise`<[`GeneratedMediaOutput`](../../../interfaces/GeneratedMediaOutput.md)\\[]>\n\n## Remarks\n\n`result` is the battery-native generation object (transformers.js `model.generate` / pipeline output;\nthe LiteRT-LM final `Message` + raw content items) — deliberately typed `unknown` because its shape is\nbattery-specific and the extractor is supplied by whoever wraps a media-emitting model. Returning an\nempty array (or not supplying the hook) yields today's text-only behavior, byte-for-byte unchanged.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/UnsupportedMediaPolicy","title":"Type Alias: UnsupportedMediaPolicy","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/UnsupportedMediaPolicy.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/UnsupportedMediaPolicy","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/type-aliases/UnsupportedMediaPolicy.md\ndescription: >-\n Policy for how a Chat-family battery handles a {@link @nhtio/adk!Media}\n instance whose modality the wire protocol cannot natively represent.\n---\n\n# Type Alias: UnsupportedMediaPolicy\n\n```ts\ntype UnsupportedMediaPolicy =\n | \"throw\"\n | \"fallback-stash\"\n | \"synthetic-description\"\n | {\n mode: \"fallback-stash\";\n stashKeys: ReadonlyArray;\n };\n```\n\nDefined in: [src/batteries/llm/chat\\_common/types.ts:283](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/types.ts#L283)\n\nPolicy for how a Chat-family battery handles a [@nhtio/adk!Media](../../../../common/classes/Media.md) instance whose modality the\nwire protocol cannot natively represent.\n\n## Remarks\n\nThe option SHAPE is shared; each battery decides which modalities count as \"unsupported\"\n(OpenAI Chat Completions: video; Ollama native `/api/chat`: everything except image). Three\nmodes:\n\n* `'throw'` — raise the battery's unsupported-media exception and fail the dispatch. Loud\n failure; the default, so a misconfigured pipeline surfaces immediately.\n* `'fallback-stash'` — look for a model-readable text entry in `media.stash`. If present, render\n that text inside the appropriate trust envelope in lieu of a media block. If no entry is found,\n fall through to `'synthetic-description'` behaviour. The shorthand string form uses the\n battery's default key list (`['text:transcript', 'text:caption', 'text:description']`, walked\n in order). The object form `{ mode: 'fallback-stash'; stashKeys }` overrides the key list.\n* `'synthetic-description'` — always render a synthetic text description constructed from\n `filename`, `byteLength`, and `mimeType` regardless of `stash` presence.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types","title":"@nhtio/adk/batteries/llm/transformers\\_js/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types.md'\ndescription: >-\n Types for the transformers.js LLM adapter — options, pipeline aliases, and the\n parser option types.\n---\n\n# @nhtio/adk/batteries/llm/transformers\\_js/types\n\nTypes for the transformers.js LLM adapter — options, pipeline aliases, and the parser option types.\n\n## Remarks\n\ntransformers.js (`@huggingface/transformers`) is **dual-environment**: its package `exports` map\nauto-selects `onnxruntime-node` (native, plain Node) vs `onnxruntime-web` (WASM + WebGPU). `device`\nand `dtype` pick the backend. So this battery is **environment-neutral** — it does NOT gate on\n`navigator.gpu`.\n\nThe pipeline/streamer/message shapes are **local aliases** of `@huggingface/transformers` types\n(`export type X = Y`), never direct re-exports of the externalized peer (which breaks the bundler).\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------------------- | -------------------------------------------------- |\n| [TransformersJsAdapterOptions](interfaces/TransformersJsAdapterOptions.md) | Configuration for the transformers.js LLM adapter. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | ----- | ----- | ------- | --- |\n| [CreateTransformersJsMultimodal](type-aliases/CreateTransformersJsMultimodal.md) | Factory for the multimodal model+processor pair (used when `multimodal` is enabled instead of the text-generation pipeline). Default: `AutoModelForImageTextToText.from_pretrained(model, {device,dtype})` + `AutoProcessor.from_pretrained(model)`. Override to inject pre-built instances or mock in tests. |\n| [CreateTransformersJsPipeline](type-aliases/CreateTransformersJsPipeline.md) | Factory that loads a text-generation pipeline and resolves it ready to use. |\n| [CreateTransformersJsStreamer](type-aliases/CreateTransformersJsStreamer.md) | Factory for the streaming token sink passed to the pipeline's `streamer` generate-kwarg. |\n| [TransformersJsDataType](type-aliases/TransformersJsDataType.md) | Quantization/precision dtype: `'auto' | 'fp32' | 'fp16' | 'q8' | 'q4' | 'q4f16' | …`. |\n| [TransformersJsDescriptionLike](type-aliases/TransformersJsDescriptionLike.md) | The description envelope a joi schema produces, consumed by the JSON-schema converter. |\n| [TransformersJsDevice](type-aliases/TransformersJsDevice.md) | `device`/`dtype` for a multimodal model: a single value (all submodules) OR a `Record` keyed by ONNX submodule filename (`vision_encoder` / `audio_encoder` / `embed_tokens` / `decoder_model_merged`) — the way to configure each modality's precision/backend separately. |\n| [TransformersJsDeviceType](type-aliases/TransformersJsDeviceType.md) | Inference device: `'auto' | 'webgpu' | 'wasm' | 'cpu' | 'gpu' | …`. |\n| [TransformersJsDtype](type-aliases/TransformersJsDtype.md) | Per-submodule dtype override (see [TransformersJsDevice](type-aliases/TransformersJsDevice.md)). |\n| [TransformersJsJsonSchema](type-aliases/TransformersJsJsonSchema.md) | The JSON-schema-shaped value used for a tool's `parameters` field (re-export for convenience). |\n| [TransformersJsMessage](type-aliases/TransformersJsMessage.md) | A chat message: `{ role, content }` (content is a string for text models). |\n| [TransformersJsModel](type-aliases/TransformersJsModel.md) | A loaded multimodal model instance (`AutoModelForImageTextToText` output). |\n| [TransformersJsModelSource](type-aliases/TransformersJsModelSource.md) | Custom model-source resolver — the seam for OPFS / separate-source / per-submodule loading. Called once per model file (`req.filename` distinguishes `vision_encoder.onnx` from `decoder_model_merged.onnx`). Return bytes, a path/URL string, a `Response`, or `undefined` to fall through to the default HF fetch. |\n| [TransformersJsPipeline](type-aliases/TransformersJsPipeline.md) | The text-generation pipeline instance the adapter drives. |\n| [TransformersJsProcessor](type-aliases/TransformersJsProcessor.md) | A loaded multimodal processor instance (`AutoProcessor` output). |\n| [TransformersJsProgressCallback](type-aliases/TransformersJsProgressCallback.md) | Model-load progress callback. |\n| [TransformersJsSessionOptions](type-aliases/TransformersJsSessionOptions.md) | ONNX Runtime session options forwarded verbatim to transformers.js's `session_options` loader arg. |\n| [TransformersJsTextStreamer](type-aliases/TransformersJsTextStreamer.md) | The callback-based token streamer. |\n\n## References\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../../interfaces/DescriptionLike.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../../interfaces/JsonSchema.md)\n\n***\n\n### TransformersJsBucketOrder\n\nRenames and re-exports [ChatCompletionsBucketOrder](../../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### TransformersJsHelpers\n\nRenames and re-exports [ChatCompletionsHelpers](../../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### UnsupportedMediaPolicy\n\nRe-exports [UnsupportedMediaPolicy](../type-aliases/UnsupportedMediaPolicy.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/interfaces/TransformersJsAdapterOptions","title":"Interface: TransformersJsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/interfaces/TransformersJsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/interfaces/TransformersJsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/interfaces/TransformersJsAdapterOptions.md\ndescription: Configuration for the transformers.js LLM adapter.\n---\n\n# Interface: TransformersJsAdapterOptions\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L172)\n\nConfiguration for the transformers.js LLM adapter.\n\n## Remarks\n\nThree groups: **engine** (model + loading), **generation** (transformers.js `generate` kwargs), and\n**ADK-control** (shared with the other LLM batteries), the last including the two **text-parser\nselectors** that make this battery work: transformers.js does NOT return structured tool calls or\nreasoning — the model emits them as family-specific text, and `toolCallParser` / `reasoningParser`\nchoose how that text is parsed.\n\n## Extends\n\n* [`BatteryLifecycleHooks`](../../helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `autoAck?` | `boolean` | Automatically `ctx.ack()` when generation completes with no tool calls (default `false`). | - | [src/batteries/llm/transformers\\_js/types.ts:298](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L298) |\n| `bucketOrder?` | [`ChatCompletionsBucketOrder`](../../../../type-aliases/ChatCompletionsBucketOrder.md) | Order in which the leading/trailing context buckets are rendered. | - | [src/batteries/llm/transformers\\_js/types.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L278) |\n| `contextWindow?` | `number` | Hard context-window token budget; enforced only when `tokenEncoding` is non-null. | - | [src/batteries/llm/transformers\\_js/types.ts:280](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L280) |\n| `createMultimodal?` | [`CreateTransformersJsMultimodal`](../type-aliases/CreateTransformersJsMultimodal.md) | Custom multimodal model+processor factory; overrides the default Auto\\* loaders. | - | [src/batteries/llm/transformers\\_js/types.ts:226](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L226) |\n| `createPipeline?` | [`CreateTransformersJsPipeline`](../type-aliases/CreateTransformersJsPipeline.md) | Custom pipeline factory; overrides the default `pipeline('text-generation', …)` loader. | - | [src/batteries/llm/transformers\\_js/types.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L179) |\n| `createStreamer?` | [`CreateTransformersJsStreamer`](../type-aliases/CreateTransformersJsStreamer.md) | Custom streaming-sink factory; overrides the default `TextStreamer` (avoids importing the peer). | - | [src/batteries/llm/transformers\\_js/types.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L181) |\n| `device?` | [`TransformersJsDevice`](../type-aliases/TransformersJsDevice.md) | Inference device. A single value, or — for a multimodal model — a `Record` keyed by submodule filename (`vision_encoder`/`audio_encoder`/`embed_tokens`/`decoder_model_merged`) to configure each separately. Default: transformers.js environment default. | - | [src/batteries/llm/transformers\\_js/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L187) |\n| `doSample?` | `boolean` | Native sample flag (`do_sample`); `false` = greedy. Prefer [sampler](#property-sampler). | - | [src/batteries/llm/transformers\\_js/types.ts:254](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L254) |\n| `dtype?` | [`TransformersJsDtype`](../type-aliases/TransformersJsDtype.md) | Quantization/precision dtype (e.g. `'q4f16'`), or a per-submodule `Record` (see [device](#property-device)). | - | [src/batteries/llm/transformers\\_js/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L189) |\n| `enableThinking?` | `boolean` | Whether to enable the model's \"thinking\"/reasoning mode, passed EXPLICITLY to the chat template as `enable_thinking`. Defaults to `false` — many reasoning templates (Qwen3, DeepSeek-R1) default thinking ON, which silently burns the token budget inside `` and leaves empty prose. We pin it off unless you opt in. (Independent of `reasoningParser`, which only parses thinking that IS emitted.) Part of the shared ChatGenerationOptions contract. | - | [src/batteries/llm/transformers\\_js/types.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L272) |\n| `extractMediaOutputs?` | [`MediaOutputExtractorFn`](../../type-aliases/MediaOutputExtractorFn.md) | Extract GENERATED media (audio/image/…) from the raw generation result and surface it as attachments on the assistant [@nhtio/adk!Message](../../../../../common/classes/Message.md). Default absent → text-only output, byte-for-byte unchanged. The tested open-weight chat checkpoints emit only text; supply this when wrapping a media-emitting model. Receives the raw transformers.js generation object (the `model.generate` / pipeline output); each returned [MediaOutputExtractorFn](../../type-aliases/MediaOutputExtractorFn.md) descriptor is persisted via `ctx.storeMediaBytes` and attached as a `Media.toolGenerated(...)`. | - | [src/batteries/llm/transformers\\_js/types.ts:334](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L334) |\n| `forgeToolsFilter?` | (`forged`: [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md), `ctx`: [`DispatchContext`](../../../../../types/interfaces/DispatchContext.md)) => [`ToolRegistry`](../../../../../forge/classes/ToolRegistry.md) | OPTIONAL hook to SHAPE the artifact-query tools forged from prior-turn SpooledArtifact results, before they merge into the visible tool set. Receives the merged forged registry + dispatch context; returns a (possibly narrowed) registry, applied BEFORE the merge with `ctx.tools`. Lets the assembler keep only the core readers on a tight window (the rest reachable via tool\\_catalog/call\\_a\\_tool). Default absent = identity = backward-compatible. The battery stays budget-agnostic (per the CONTRIBUTING size-threshold rule) — it applies the supplied filter without measuring context; budget logic lives in the caller. | - | [src/batteries/llm/transformers\\_js/types.ts:313](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L313) |\n| `helpers?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`ChatCompletionsHelpers`](../../../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)> | Pluggable per-function overrides for the rendering/translation helpers. | - | [src/batteries/llm/transformers\\_js/types.ts:292](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L292) |\n| `isAvailable?` | () => `boolean` | Override the availability probe. Default: `true` whenever the peer is importable (env-neutral). | - | [src/batteries/llm/transformers\\_js/types.ts:233](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L233) |\n| `maxNewTokens?` | `number` | Native max tokens (`max_new_tokens`). Prefer [maxTokens](#property-maxtokens). Default `1024`. | - | [src/batteries/llm/transformers\\_js/types.ts:252](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L252) |\n| `maxTokens?` | `number` | Portable max generation length (canonical spelling of [maxNewTokens](#property-maxnewtokens)). Default `1024`. | - | [src/batteries/llm/transformers\\_js/types.ts:240](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L240) |\n| `model` | `string` | The model id (e.g. `onnx-community/gemma-4-E2B-it-ONNX`). Required; no default. | - | [src/batteries/llm/transformers\\_js/types.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L175) |\n| `modelSource?` | [`TransformersJsModelSource`](../type-aliases/TransformersJsModelSource.md) | Custom model-source resolver (OPFS / separate-source / per-submodule loading). Wraps transformers.js's `env.customCache`; serves each model file from any source. Dual-environment (Node + browser). | - | [src/batteries/llm/transformers\\_js/types.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L231) |\n| `multimodal?` | | `boolean` | { `audio?`: `boolean`; `image?`: `boolean`; } | Enable multimodal (image/audio) input. Default off → the text-only path is byte-for-byte unchanged. When on, the model loads via `AutoModelForImageTextToText` + `AutoProcessor` (not the text-generation pipeline), and `Media` attachments on a `Message` are fed to the model. `true` = both modalities the model supports; `{image?,audio?}` restricts which `Media` kinds are sent natively (others degrade via `unsupportedMediaPolicy`). Output is still text → the tool-call/reasoning parsers are unaffected. | - | [src/batteries/llm/transformers\\_js/types.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L222) |\n| `multimodalEngine?` | { `model`: `PreTrainedModel`; `processor`: `Processor`; } | A pre-built multimodal model+processor pair; mutually exclusive with `createMultimodal`. | - | [src/batteries/llm/transformers\\_js/types.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L224) |\n| `multimodalEngine.model` | `PreTrainedModel` | - | - | [src/batteries/llm/transformers\\_js/types.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L224) |\n| `multimodalEngine.processor` | `Processor` | - | - | [src/batteries/llm/transformers\\_js/types.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L224) |\n| `onCompiling?` | [`BatteryLifecycleCallback`](../../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`](../../helpers/interfaces/BatteryLifecycleHooks.md).[`onCompiling`](../../helpers/interfaces/BatteryLifecycleHooks.md#property-oncompiling) | [src/batteries/llm/chat\\_common/lifecycle.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `onComplete?` | [`BatteryLifecycleCallback`](../../helpers/type-aliases/BatteryLifecycleCallback.md) | After the turn's output is parsed + persisted, before `ack` (fires per turn). | [`BatteryLifecycleHooks`](../../helpers/interfaces/BatteryLifecycleHooks.md).[`onComplete`](../../helpers/interfaces/BatteryLifecycleHooks.md#property-oncomplete) | [src/batteries/llm/chat\\_common/lifecycle.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `onError?` | [`BatteryLifecycleCallback`](../../helpers/type-aliases/BatteryLifecycleCallback.md) | A load or generation failure (paired with `nack`). | [`BatteryLifecycleHooks`](../../helpers/interfaces/BatteryLifecycleHooks.md).[`onError`](../../helpers/interfaces/BatteryLifecycleHooks.md#property-onerror) | [src/batteries/llm/chat\\_common/lifecycle.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `onGenerating?` | [`BatteryLifecycleCallback`](../../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`](../../helpers/interfaces/BatteryLifecycleHooks.md).[`onGenerating`](../../helpers/interfaces/BatteryLifecycleHooks.md#property-ongenerating) | [src/batteries/llm/chat\\_common/lifecycle.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `onInitProgress?` | `ProgressCallback` | Called with model-load progress reports while weights download/compile. | - | [src/batteries/llm/transformers\\_js/types.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L214) |\n| `onLifecycle?` | [`BatteryLifecycleCallback`](../../helpers/type-aliases/BatteryLifecycleCallback.md) | Fires on EVERY phase transition (the firehose). | [`BatteryLifecycleHooks`](../../helpers/interfaces/BatteryLifecycleHooks.md).[`onLifecycle`](../../helpers/interfaces/BatteryLifecycleHooks.md#property-onlifecycle) | [src/batteries/llm/chat\\_common/lifecycle.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `onLoading?` | [`BatteryLifecycleCallback`](../../helpers/type-aliases/BatteryLifecycleCallback.md) | Weights/runtime loading — may fire repeatedly with `progress` as the provider reports it. | [`BatteryLifecycleHooks`](../../helpers/interfaces/BatteryLifecycleHooks.md).[`onLoading`](../../helpers/interfaces/BatteryLifecycleHooks.md#property-onloading) | [src/batteries/llm/chat\\_common/lifecycle.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `onPromptAssembled?` | [`PromptAssembledObserverFn`](../../../../type-aliases/PromptAssembledObserverFn.md) | Observe the fully-assembled prompt this battery is about to send TO the model — fired once per terminal generation, the instant assembly completes and BEFORE the pipeline/generate dispatch, with the per-turn `messages` and the `tools` handed to `apply_chat_template`. The mirror of [onRawGeneration](#property-onrawgeneration). Purely observational (return value ignored, errors swallowed). Default absent. The request is handed back AS-IS — no redaction — so treat it as potentially sensitive if you persist it. See [PromptAssembledObserverFn](../../../../type-aliases/PromptAssembledObserverFn.md). | - | [src/batteries/llm/transformers\\_js/types.ts:353](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L353) |\n| `onRawGeneration?` | [`RawGenerationObserverFn`](../../../../type-aliases/RawGenerationObserverFn.md) | Observe the model's RAW text output for each completed generation — fired once per terminal generation, after envelope-stripping + reasoning/tool-call parsing but before the result is persisted, with the complete `rawText`, the residual `cleanedText`, and the extracted `reasoning` / `toolCalls`. Purely observational (return value ignored, errors swallowed). Default absent. This is the supported seam for parser bring-up against a new model, live \"why did it abstain?\" debugging, and ground-truth fixture capture — the job that previously needed a temporary hook patched into the adapter. See [RawGenerationObserverFn](../../../../type-aliases/RawGenerationObserverFn.md). | - | [src/batteries/llm/transformers\\_js/types.ts:344](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L344) |\n| `onReady?` | [`BatteryLifecycleCallback`](../../helpers/type-aliases/BatteryLifecycleCallback.md) | Engine/pipeline resolved and cached, before the first generation. | [`BatteryLifecycleHooks`](../../helpers/interfaces/BatteryLifecycleHooks.md).[`onReady`](../../helpers/interfaces/BatteryLifecycleHooks.md#property-onready) | [src/batteries/llm/chat\\_common/lifecycle.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `pinKvCacheToGpu?` | `boolean` | Pin the autoregressive KV cache (`present.*` outputs) to GPU buffers on the WebGPU EP, keeping it OFF the ONNX-Runtime-Web **wasm32 linear-memory heap** (hard-capped at 4 GiB). **Default `true`.** **Remarks** This is the battery's headline in-browser memory default: the wasm32 heap is the wall hit first when running on the WASM/JSEP WebGPU path, and the KV cache is its largest growing consumer across a multi-generate turn. transformers.js is *supposed* to pin this automatically, but its auto-pin silently no-ops on models with nested config (e.g. Gemma-4's `text_config`) — leaving the KV cache on the wasm heap. We apply the pin explicitly by default so the common case \"just works\". The ESCAPE HATCH: set `false` to disable entirely, or set your own `sessionOptions.preferredOutputLocation` — an explicit value ALWAYS wins and is never overwritten. No effect off the WebGPU EP (there is no `'gpu-buffer'` location on the wasm/cpu backend). | - | [src/batteries/llm/transformers\\_js/types.ts:212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L212) |\n| `pipeline?` | `TextGenerationPipeline` | A pre-built text-generation pipeline to drive; mutually exclusive with `createPipeline`. | - | [src/batteries/llm/transformers\\_js/types.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L177) |\n| `reasoningFieldPrecedence?` | [`ReasoningFieldPrecedence`](../../../openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md) | Precedence order for reasoning/thought fields. | - | [src/batteries/llm/transformers\\_js/types.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L290) |\n| `reasoningOrphanRecovery?` | `boolean` | Recover UNPAIRED reasoning markers (a lone ``, a truncated ``) by inferring the missing half from the pseudo-streaming order, instead of leaking the stray marker into the visible answer. Defaults to `true`. Set `false` for strict pair-only parsing. Ignored when `reasoningParser` is a custom function. Motivated by real gemma-4-E4B WebGPU \"randomly emits ``\" drift. | - | [src/batteries/llm/transformers\\_js/types.ts:325](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L325) |\n| `reasoningParser?` | | [`ReasoningParserName`](../../helpers/type-aliases/ReasoningParserName.md) | [`ReasoningParserFn`](../../helpers/type-aliases/ReasoningParserFn.md) | How to parse reasoning/thinking out of the model's text output. A family name, `'auto'` (the default), `'none'`, or a custom [ReasoningParserFn](../../helpers/type-aliases/ReasoningParserFn.md). Extracted reasoning becomes ADK Thoughts. | - | [src/batteries/llm/transformers\\_js/types.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L318) |\n| `repetitionPenalty?` | `number` | Repetition penalty (always sent). Default `1.1`. | - | [src/batteries/llm/transformers\\_js/types.ts:262](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L262) |\n| `replayCompatibility?` | readonly `string`\\[] | Replay-compatibility tags whose opaque reasoning payloads may be replayed. | - | [src/batteries/llm/transformers\\_js/types.ts:288](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L288) |\n| `sampler?` | [`ChatSampler`](../../helpers/type-aliases/ChatSampler.md) | Portable sampler strategy (`'greedy'` default). `'greedy'`→`do_sample:false`; `'top-k'`/`'top-p'`→ `do_sample:true`+the matching cutoff. Canonical spelling of [doSample](#property-dosample). | - | [src/batteries/llm/transformers\\_js/types.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L243) |\n| `seed?` | `number` | RNG seed for reproducible sampling (best-effort). | - | [src/batteries/llm/transformers\\_js/types.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L245) |\n| `selfIdentity?` | `string` | The assistant identity this adapter speaks as (default `'assistant'`). | - | [src/batteries/llm/transformers\\_js/types.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L282) |\n| `sessionOptions?` | [`TransformersJsSessionOptions`](../type-aliases/TransformersJsSessionOptions.md) | ONNX Runtime session options forwarded verbatim to the loader's `session_options` arg (both the pipeline and multimodal paths). A REACHABLE LEVER for advanced WebGPU memory/perf control — surfaced, never auto-applied. See [TransformersJsSessionOptions](../type-aliases/TransformersJsSessionOptions.md) for useful keys. The battery sets no default here; whatever you pass is what the runtime gets. | - | [src/batteries/llm/transformers\\_js/types.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L196) |\n| `spoolStore?` | [`SpoolStore`](../../../../../common/type-aliases/SpoolStore.md) | Byte store for spooling raw tool output (defaults to a per-dispatch in-memory store). | - | [src/batteries/llm/transformers\\_js/types.ts:294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L294) |\n| `stopStrings?` | readonly `string`\\[] | Stop strings that halt generation. | - | [src/batteries/llm/transformers\\_js/types.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L264) |\n| `stream?` | `boolean` | Stream tokens (default `true`). When `false`, a single completed message is returned. | - | [src/batteries/llm/transformers\\_js/types.ts:276](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L276) |\n| `temperature?` | `number` | Sampling temperature. Default `0.7`. | - | [src/batteries/llm/transformers\\_js/types.ts:256](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L256) |\n| `thoughtSurfacing?` | `\"all\"` | `\"all-self\"` | `\"latest-self\"` | Which thoughts are surfaced into history. | - | [src/batteries/llm/transformers\\_js/types.ts:284](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L284) |\n| `tokenEncoding?` | | [`TokenEncodingId`](../../../../../type-aliases/TokenEncodingId.md) | `null` | Token encoding used for context-window accounting, or `null` to disable (default `null`). | - | [src/batteries/llm/transformers\\_js/types.ts:286](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L286) |\n| `toolCallParser?` | | [`ToolCallParserName`](../../helpers/type-aliases/ToolCallParserName.md) | [`ToolCallParserFn`](../../helpers/type-aliases/ToolCallParserFn.md) | How to parse tool calls out of the model's text output (transformers.js does not return them structured). A family name, `'auto'` (try-all in priority order — the default), `'none'` (disable), or a custom [ToolCallParserFn](../../helpers/type-aliases/ToolCallParserFn.md). | - | [src/batteries/llm/transformers\\_js/types.ts:304](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L304) |\n| `topK?` | `number` | Top-K cutoff. Default `40`. | - | [src/batteries/llm/transformers\\_js/types.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L258) |\n| `topP?` | `number` | Top-P (nucleus) cutoff. Default `0.95`. | - | [src/batteries/llm/transformers\\_js/types.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L260) |\n| `unsupportedMediaPolicy?` | [`UnsupportedMediaPolicy`](../../type-aliases/UnsupportedMediaPolicy.md) | How to handle media the model cannot natively consume (default `'throw'`). | - | [src/batteries/llm/transformers\\_js/types.ts:296](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L296) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsMultimodal","title":"Type Alias: CreateTransformersJsMultimodal","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsMultimodal.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsMultimodal","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsMultimodal.md\ndescription: >-\n Factory for the multimodal model+processor pair (used when `multimodal` is\n enabled instead of the text-generation pipeline). Default:\n `AutoModelForImageTextToText.from_pretrained(model, {device,dtype})` +\n `AutoProcessor.from_pretrained(model)`. Override to inject pre-built instances\n or mock in tests.\n---\n\n# Type Alias: CreateTransformersJsMultimodal\n\n```ts\ntype CreateTransformersJsMultimodal = (input: {\n device?: TransformersJsDevice;\n dtype?: TransformersJsDtype;\n model: string;\n onInitProgress?: TransformersJsProgressCallback;\n sessionOptions?: TransformersJsSessionOptions;\n}) => Promise<{\n model: TransformersJsModel;\n processor: TransformersJsProcessor;\n}>;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L151)\n\nFactory for the multimodal model+processor pair (used when `multimodal` is enabled instead of the\ntext-generation pipeline). Default: `AutoModelForImageTextToText.from_pretrained(model, {device,dtype})`\n\n* `AutoProcessor.from_pretrained(model)`. Override to inject pre-built instances or mock in tests.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| `input` | { `device?`: [`TransformersJsDevice`](TransformersJsDevice.md); `dtype?`: [`TransformersJsDtype`](TransformersJsDtype.md); `model`: `string`; `onInitProgress?`: [`TransformersJsProgressCallback`](TransformersJsProgressCallback.md); `sessionOptions?`: [`TransformersJsSessionOptions`](TransformersJsSessionOptions.md); } | - |\n| `input.device?` | [`TransformersJsDevice`](TransformersJsDevice.md) | - |\n| `input.dtype?` | [`TransformersJsDtype`](TransformersJsDtype.md) | - |\n| `input.model` | `string` | - |\n| `input.onInitProgress?` | [`TransformersJsProgressCallback`](TransformersJsProgressCallback.md) | - |\n| `input.sessionOptions?` | [`TransformersJsSessionOptions`](TransformersJsSessionOptions.md) | ONNX Runtime session options forwarded verbatim to `from_pretrained(...)` as `session_options`. |\n\n## Returns\n\n`Promise`<{\n`model`: [`TransformersJsModel`](TransformersJsModel.md);\n`processor`: [`TransformersJsProcessor`](TransformersJsProcessor.md);\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsPipeline","title":"Type Alias: CreateTransformersJsPipeline","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsPipeline.md\ndescription: Factory that loads a text-generation pipeline and resolves it ready to use.\n---\n\n# Type Alias: CreateTransformersJsPipeline\n\n```ts\ntype CreateTransformersJsPipeline = (input: {\n device?: TransformersJsDevice;\n dtype?: TransformersJsDtype;\n model: string;\n onInitProgress?: TransformersJsProgressCallback;\n sessionOptions?: TransformersJsSessionOptions;\n}) => Promise;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L123)\n\nFactory that loads a text-generation pipeline and resolves it ready to use.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| `input` | { `device?`: [`TransformersJsDevice`](TransformersJsDevice.md); `dtype?`: [`TransformersJsDtype`](TransformersJsDtype.md); `model`: `string`; `onInitProgress?`: [`TransformersJsProgressCallback`](TransformersJsProgressCallback.md); `sessionOptions?`: [`TransformersJsSessionOptions`](TransformersJsSessionOptions.md); } | - |\n| `input.device?` | [`TransformersJsDevice`](TransformersJsDevice.md) | - |\n| `input.dtype?` | [`TransformersJsDtype`](TransformersJsDtype.md) | - |\n| `input.model` | `string` | - |\n| `input.onInitProgress?` | [`TransformersJsProgressCallback`](TransformersJsProgressCallback.md) | - |\n| `input.sessionOptions?` | [`TransformersJsSessionOptions`](TransformersJsSessionOptions.md) | ONNX Runtime session options forwarded verbatim to `pipeline(...)` as `session_options`. |\n\n## Returns\n\n`Promise`<[`TransformersJsPipeline`](TransformersJsPipeline.md)>\n\n## Remarks\n\nThe default factory dynamically imports `@huggingface/transformers` and calls\n`pipeline('text-generation', model, { device, dtype, … })`. Supply a custom factory to control\nloading, inject a pre-warmed pipeline, or mock it in tests.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsStreamer","title":"Type Alias: CreateTransformersJsStreamer","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsStreamer.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsStreamer","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/CreateTransformersJsStreamer.md\ndescription: >-\n Factory for the streaming token sink passed to the pipeline's `streamer`\n generate-kwarg.\n---\n\n# Type Alias: CreateTransformersJsStreamer\n\n```ts\ntype CreateTransformersJsStreamer = (input: {\n onText: (text: string) => void;\n pipeline: TransformersJsPipeline;\n}) => Promise | unknown;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L141)\n\nFactory for the streaming token sink passed to the pipeline's `streamer` generate-kwarg.\n\n## Parameters\n\n| Parameter | Type |\n| ---------------- | ---------------------------------------------------------------------------------------------------------------- |\n| `input` | { `onText`: (`text`: `string`) => `void`; `pipeline`: [`TransformersJsPipeline`](TransformersJsPipeline.md); } |\n| `input.onText` | (`text`: `string`) => `void` |\n| `input.pipeline` | [`TransformersJsPipeline`](TransformersJsPipeline.md) |\n\n## Returns\n\n`Promise`<`unknown`> | `unknown`\n\n## Remarks\n\nThe default factory dynamically imports `@huggingface/transformers`'s `TextStreamer` and wires its\n`callback_function` to `onText`. Override to inject a lightweight streamer (e.g. in tests, to avoid\nimporting the heavy peer) — any object the pipeline accepts as `streamer` and that calls `onText`\nwith each decoded text delta works.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDataType","title":"Type Alias: TransformersJsDataType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDataType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDataType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDataType.md\ndescription: 'Quantization/precision dtype: `''auto''|''fp32''|''fp16''|''q8''|''q4''|''q4f16''|…`.'\n---\n\n# Type Alias: TransformersJsDataType\n\n```ts\ntype TransformersJsDataType = TransformersDataType;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L58)\n\nQuantization/precision dtype: `'auto'|'fp32'|'fp16'|'q8'|'q4'|'q4f16'|…`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDescriptionLike","title":"Type Alias: TransformersJsDescriptionLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDescriptionLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDescriptionLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDescriptionLike.md\ndescription: >-\n The description envelope a joi schema produces, consumed by the JSON-schema\n converter.\n---\n\n# Type Alias: TransformersJsDescriptionLike\n\n```ts\ntype TransformersJsDescriptionLike = DescriptionLike;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L359)\n\nThe description envelope a joi schema produces, consumed by the JSON-schema converter.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDevice","title":"Type Alias: TransformersJsDevice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDevice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDevice","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDevice.md\ndescription: >-\n `device`/`dtype` for a multimodal model: a single value (all submodules) OR a\n `Record` keyed by ONNX submodule filename (`vision_encoder` / `audio_encoder`\n / `embed_tokens` / `decoder_model_merged`) — the way to configure each\n modality's precision/backend separately.\n---\n\n# Type Alias: TransformersJsDevice\n\n```ts\ntype TransformersJsDevice =\n | TransformersJsDeviceType\n | Record;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L85)\n\n`device`/`dtype` for a multimodal model: a single value (all submodules) OR a `Record` keyed by ONNX\nsubmodule filename (`vision_encoder` / `audio_encoder` / `embed_tokens` / `decoder_model_merged`) —\nthe way to configure each modality's precision/backend separately.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDeviceType","title":"Type Alias: TransformersJsDeviceType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDeviceType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDeviceType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDeviceType.md\ndescription: 'Inference device: `''auto''|''webgpu''|''wasm''|''cpu''|''gpu''|…`.'\n---\n\n# Type Alias: TransformersJsDeviceType\n\n```ts\ntype TransformersJsDeviceType = TransformersDeviceType;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L60)\n\nInference device: `'auto'|'webgpu'|'wasm'|'cpu'|'gpu'|…`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDtype","title":"Type Alias: TransformersJsDtype","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDtype.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDtype","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDtype.md\ndescription: 'Per-submodule dtype override (see [`TransformersJsDevice`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsDevice)).'\n---\n\n# Type Alias: TransformersJsDtype\n\n```ts\ntype TransformersJsDtype =\n | TransformersJsDataType\n | Record;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L89)\n\nPer-submodule dtype override (see [TransformersJsDevice](TransformersJsDevice.md)).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsJsonSchema","title":"Type Alias: TransformersJsJsonSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsJsonSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsJsonSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsJsonSchema.md\ndescription: >-\n The JSON-schema-shaped value used for a tool's `parameters` field (re-export\n for convenience).\n---\n\n# Type Alias: TransformersJsJsonSchema\n\n```ts\ntype TransformersJsJsonSchema = JsonSchema;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:357](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L357)\n\nThe JSON-schema-shaped value used for a tool's `parameters` field (re-export for convenience).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsMessage","title":"Type Alias: TransformersJsMessage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsMessage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsMessage","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsMessage.md\ndescription: 'A chat message: `{ role, content }` (content is a string for text models).'\n---\n\n# Type Alias: TransformersJsMessage\n\n```ts\ntype TransformersJsMessage = TransformersMessage;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L52)\n\nA chat message: `{ role, content }` (content is a string for text models).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModel","title":"Type Alias: TransformersJsModel","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModel.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModel","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModel.md\ndescription: A loaded multimodal model instance (`AutoModelForImageTextToText` output).\n---\n\n# Type Alias: TransformersJsModel\n\n```ts\ntype TransformersJsModel = PreTrainedModel;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L64)\n\nA loaded multimodal model instance (`AutoModelForImageTextToText` output).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModelSource","title":"Type Alias: TransformersJsModelSource","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModelSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModelSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsModelSource.md\ndescription: >-\n Custom model-source resolver — the seam for OPFS / separate-source /\n per-submodule loading. Called once per model file (`req.filename`\n distinguishes `vision_encoder.onnx` from `decoder_model_merged.onnx`). Return\n bytes, a path/URL string, a `Response`, or `undefined` to fall through to the\n default HF fetch.\n---\n\n# Type Alias: TransformersJsModelSource\n\n```ts\ntype TransformersJsModelSource = (req: {\n filename: string;\n repo: string;\n}) =>\n | Promise\n | Uint8Array\n | string\n | Response\n | undefined;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L96)\n\nCustom model-source resolver — the seam for OPFS / separate-source / per-submodule loading. Called\nonce per model file (`req.filename` distinguishes `vision_encoder.onnx` from `decoder_model_merged.onnx`).\nReturn bytes, a path/URL string, a `Response`, or `undefined` to fall through to the default HF fetch.\n\n## Parameters\n\n| Parameter | Type |\n| -------------- | --------------------------------------------- |\n| `req` | { `filename`: `string`; `repo`: `string`; } |\n| `req.filename` | `string` |\n| `req.repo` | `string` |\n\n## Returns\n\n| `Promise`<`Uint8Array` | `string` | `Response` | `undefined`>\n| `Uint8Array`\n| `string`\n| `Response`\n| `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsPipeline","title":"Type Alias: TransformersJsPipeline","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsPipeline.md\ndescription: The text-generation pipeline instance the adapter drives.\n---\n\n# Type Alias: TransformersJsPipeline\n\n```ts\ntype TransformersJsPipeline = TextGenerationPipeline;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L54)\n\nThe text-generation pipeline instance the adapter drives.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProcessor","title":"Type Alias: TransformersJsProcessor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProcessor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProcessor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProcessor.md\ndescription: A loaded multimodal processor instance (`AutoProcessor` output).\n---\n\n# Type Alias: TransformersJsProcessor\n\n```ts\ntype TransformersJsProcessor = Processor;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L66)\n\nA loaded multimodal processor instance (`AutoProcessor` output).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProgressCallback","title":"Type Alias: TransformersJsProgressCallback","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProgressCallback.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProgressCallback","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsProgressCallback.md\ndescription: Model-load progress callback.\n---\n\n# Type Alias: TransformersJsProgressCallback\n\n```ts\ntype TransformersJsProgressCallback = ProgressCallback;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L62)\n\nModel-load progress callback.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsSessionOptions","title":"Type Alias: TransformersJsSessionOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsSessionOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsSessionOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsSessionOptions.md\ndescription: >-\n ONNX Runtime session options forwarded verbatim to transformers.js's\n `session_options` loader arg.\n---\n\n# Type Alias: TransformersJsSessionOptions\n\n```ts\ntype TransformersJsSessionOptions = Record;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L78)\n\nONNX Runtime session options forwarded verbatim to transformers.js's `session_options` loader arg.\n\n## Remarks\n\nA REACHABLE LEVER, never auto-applied by the battery (surface, don't impose). Kept structurally open\n(`Record`) rather than aliasing `onnxruntime-common`'s `InferenceSession.SessionOptions`\ndirectly: that type is not a peer of this battery, and a hard re-export of an external type breaks the\nbundler (the same reason the wire shapes above are local aliases). Useful keys for the WebGPU EP:\n`preferredOutputLocation` (`'gpu-buffer'` to keep outputs on GPU for IO-binding), `graphOptimizationLevel`,\n`enableGraphCapture`. Note `freeDimensionOverrides` cannot pin a KV-cached decoder's dynamic dims.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsTextStreamer","title":"Type Alias: TransformersJsTextStreamer","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsTextStreamer.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsTextStreamer","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/type-aliases/TransformersJsTextStreamer.md\ndescription: The callback-based token streamer.\n---\n\n# Type Alias: TransformersJsTextStreamer\n\n```ts\ntype TransformersJsTextStreamer = TextStreamer;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/types.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/types.ts#L56)\n\nThe callback-based token streamer.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation","title":"@nhtio/adk/batteries/llm/transformers\\_js/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/validation.md'\ndescription: Runtime validation schema and wrapper for transformers.js LLM adapter options.\n---\n\n# @nhtio/adk/batteries/llm/transformers\\_js/validation\n\nRuntime validation schema and wrapper for transformers.js LLM adapter options.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [transformersJsOptionsSchema](variables/transformersJsOptionsSchema.md) | Validator schema for [TransformersJsAdapterOptions](../types/interfaces/TransformersJsAdapterOptions.md). Rejects unknown keys (`.unknown(false)`) and fills in defaults. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates raw adapter options against [transformersJsOptionsSchema](variables/transformersJsOptionsSchema.md), filling in defaults. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): TransformersJsAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/validation.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/validation.ts#L210)\n\nValidates raw adapter options against [transformersJsOptionsSchema](../variables/transformersJsOptionsSchema.md), filling in defaults.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`TransformersJsAdapterOptions`](../../types/interfaces/TransformersJsAdapterOptions.md)\n\nThe resolved options object with defaults applied.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_OPTIONS.md) when `input` is invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation/variables/transformersJsOptionsSchema","title":"Variable: transformersJsOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation/variables/transformersJsOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/transformers_js/validation/variables/transformersJsOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/validation/variables/transformersJsOptionsSchema.md\ndescription: >-\n Validator schema for [`TransformersJsAdapterOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/llm/transformers_js/types/interfaces/TransformersJsAdapterOptions). Rejects unknown\n keys (`.unknown(false)`) and fills in defaults.\n---\n\n# Variable: transformersJsOptionsSchema\n\n```ts\nconst transformersJsOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/transformers\\_js/validation.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/transformers_js/validation.ts#L114)\n\nValidator schema for [TransformersJsAdapterOptions](../../types/interfaces/TransformersJsAdapterOptions.md). Rejects unknown keys (`.unknown(false)`)\nand fills in defaults.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions","title":"@nhtio/adk/batteries/llm/webllm\\_chat\\_completions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions.md'\ndescription: >-\n WebLLM Chat Completions adapter battery with swappable translation helpers and\n wire types.\n---\n\n# @nhtio/adk/batteries/llm/webllm\\_chat\\_completions\n\nWebLLM Chat Completions adapter battery with swappable translation helpers and wire types.\n\n## Remarks\n\nOpinionated WebLLM Chat Completions LLM battery. Ships a `WebLLMChatCompletionsAdapter` that\ntargets WebLLM's in-process OpenAI-style Chat Completions API and translates the ADK's\nprimitives into that wire shape.\n\nRe-exports the adapter class, every translation helper (each under its unprefixed name AND a\n`default*`-prefixed alias so consumers can compose partial overrides against the bundled\ndefaults), every option / wire-shape type alias, the validation schema + `validateOptions`\nwrapper, and the six battery-scoped exception classes.\n\nSee the project README for the design-decisions block governing this battery (trust-framed\nenvelopes, per-tool trust, swappable translation helpers, per-dispatch override channel via\n`stash`, trust-tier-distinct envelopes, multi-identity rendering, opaque-reasoning\nround-trips, etc.).\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |\n| [CreateWebLLMChatCompletionsEngine](type-aliases/CreateWebLLMChatCompletionsEngine.md) | Factory that loads a model and resolves a ready-to-use [WebLLMEngine](../../type-aliases/WebLLMEngine.md). |\n| [WebLLMChatCompletionsEngine](type-aliases/WebLLMChatCompletionsEngine.md) | Alias of [WebLLMEngine](../../type-aliases/WebLLMEngine.md). |\n\n## References\n\n### AssembledToolCall\n\nRe-exports [AssembledToolCall](../openai_chat_completions/types/interfaces/AssembledToolCall.md)\n\n***\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### buildChatCompletionsHistory\n\nRe-exports [buildChatCompletionsHistory](../openai_chat_completions/helpers/functions/buildChatCompletionsHistory.md)\n\n***\n\n### ChatCompletionsBucketLabel\n\nRe-exports [ChatCompletionsBucketLabel](../../type-aliases/ChatCompletionsBucketLabel.md)\n\n***\n\n### ChatCompletionsBucketOrder\n\nRe-exports [ChatCompletionsBucketOrder](../../type-aliases/ChatCompletionsBucketOrder.md)\n\n***\n\n### ChatCompletionsChunk\n\nRe-exports [ChatCompletionsChunk](../openai_chat_completions/types/interfaces/ChatCompletionsChunk.md)\n\n***\n\n### ChatCompletionsHelpers\n\nRe-exports [ChatCompletionsHelpers](../openai_chat_completions/types/interfaces/ChatCompletionsHelpers.md)\n\n***\n\n### ChatCompletionsMessage\n\nRe-exports [ChatCompletionsMessage](../openai_chat_completions/types/interfaces/ChatCompletionsMessage.md)\n\n***\n\n### ChatCompletionsResponse\n\nRe-exports [ChatCompletionsResponse](../openai_chat_completions/types/interfaces/ChatCompletionsResponse.md)\n\n***\n\n### ChatCompletionsTool\n\nRe-exports [ChatCompletionsTool](../../interfaces/ChatCompletionsTool.md)\n\n***\n\n### ChatCompletionsToolCallDelta\n\nRe-exports [ChatCompletionsToolCallDelta](../openai_chat_completions/types/interfaces/ChatCompletionsToolCallDelta.md)\n\n***\n\n### ChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [ChatCompletionsToolCallDeltaAccumulator](../openai_chat_completions/types/interfaces/ChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### createChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [createChatCompletionsToolCallDeltaAccumulator](../openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### deCollideToolCallIds\n\nRe-exports [deCollideToolCallIds](../../variables/deCollideToolCallIds.md)\n\n***\n\n### defaultBuildChatCompletionsHistory\n\nRe-exports [defaultBuildChatCompletionsHistory](../openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory.md)\n\n***\n\n### defaultCreateChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [defaultCreateChatCompletionsToolCallDeltaAccumulator](../openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderChatCompletionsToolCallResult\n\nRe-exports [defaultRenderChatCompletionsToolCallResult](../openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTimelineMessage\n\nRe-exports [defaultRenderTimelineMessage](../openai_chat_completions/helpers/variables/defaultRenderTimelineMessage.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### DescriptionLike\n\nRe-exports [DescriptionLike](../../interfaces/DescriptionLike.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS](exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md)\n\n***\n\n### E\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\nRe-exports [E\\_UNSUPPORTED\\_MEDIA\\_MODALITY](exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md)\n\n***\n\n### E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\nRe-exports [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](../openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../functions/filterThoughts.md)\n\n***\n\n### JsonSchema\n\nRe-exports [JsonSchema](../../interfaces/JsonSchema.md)\n\n***\n\n### MemoryAttrs\n\nRe-exports [MemoryAttrs](../../interfaces/MemoryAttrs.md)\n\n***\n\n### ReasoningExtract\n\nRe-exports [ReasoningExtract](../openai_chat_completions/types/interfaces/ReasoningExtract.md)\n\n***\n\n### ReasoningField\n\nRe-exports [ReasoningField](../openai_chat_completions/types/type-aliases/ReasoningField.md)\n\n***\n\n### ReasoningFieldPrecedence\n\nRe-exports [ReasoningFieldPrecedence](../openai_chat_completions/types/type-aliases/ReasoningFieldPrecedence.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderChatCompletionsToolCallResult\n\nRe-exports [renderChatCompletionsToolCallResult](../openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../functions/renderMemories.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../functions/renderThought.md)\n\n***\n\n### renderTimelineMessage\n\nRe-exports [renderTimelineMessage](../openai_chat_completions/helpers/functions/renderTimelineMessage.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../functions/renderUntrustedContent.md)\n\n***\n\n### RetrievableAttrs\n\nRe-exports [RetrievableAttrs](../../interfaces/RetrievableAttrs.md)\n\n***\n\n### StandingInstructionAttrs\n\nRe-exports [StandingInstructionAttrs](../../interfaces/StandingInstructionAttrs.md)\n\n***\n\n### ThoughtAttrs\n\nRe-exports [ThoughtAttrs](../../interfaces/ThoughtAttrs.md)\n\n***\n\n### ToolCallIdFilterFn\n\nRe-exports [ToolCallIdFilterFn](../../type-aliases/ToolCallIdFilterFn.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../functions/toolsToChatCompletionsTools.md)\n\n***\n\n### TrustedContentAttrs\n\nRe-exports [TrustedContentAttrs](../../interfaces/TrustedContentAttrs.md)\n\n***\n\n### UntrustedContentAttrs\n\nRe-exports [UntrustedContentAttrs](../../interfaces/UntrustedContentAttrs.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n\n***\n\n### WebLLMChatCompletionsAdapter\n\nRe-exports [WebLLMChatCompletionsAdapter](adapter/classes/WebLLMChatCompletionsAdapter.md)\n\n***\n\n### WebLLMChatCompletionsAdapterOptions\n\nRe-exports [WebLLMChatCompletionsAdapterOptions](../../interfaces/WebLLMChatCompletionsAdapterOptions.md)\n\n***\n\n### webLLMChatCompletionsOptionsSchema\n\nRe-exports [webLLMChatCompletionsOptionsSchema](validation/variables/webLLMChatCompletionsOptionsSchema.md)\n\n***\n\n### WebLLMChatCompletionsRequestBody\n\nRe-exports [WebLLMChatCompletionsRequestBody](../../type-aliases/WebLLMChatCompletionsRequestBody.md)\n\n***\n\n### WebLLMEngine\n\nRe-exports [WebLLMEngine](../../type-aliases/WebLLMEngine.md)\n\n***\n\n### WebLLMInitProgressReport\n\nRe-exports [WebLLMInitProgressReport](../../type-aliases/WebLLMInitProgressReport.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter","title":"@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter.md\ndescription: >-\n Cross-environment executor adapter for WebLLM Chat Completions compatible\n endpoints.\n---\n\n# @nhtio/adk/batteries/llm/webllm\\_chat\\_completions/adapter\n\nCross-environment executor adapter for WebLLM Chat Completions compatible endpoints.\n\n## Remarks\n\nCross-environment LLM adapter for the WebLLM Chat Completions wire shape. Chat Completions was\nchosen as the ADK's reference adapter because it is the de-facto interchange format for the\nmajority of OpenAI-compatible gateways (vLLM, Together, Groq, Fireworks, Ollama, Azure OpenAI,\nOpenRouter, DeepSeek, Mistral La Plateforme, and most self-hosted deployments). Its tool-call\nsynthetic-history shape (`role: 'assistant', tool_calls: [...]` followed by `role: 'tool'` with\n`tool_call_id`) is the lowest-common-denominator that every conformant gateway accepts.\n\nThe adapter is built around three pluggable layers:\n\n1. **Translation helpers** — the thirteen swappable functions exported from `./helpers` turn\n ADK primitives ([@nhtio/adk!Tokenizable](../../../../common/classes/Tokenizable.md), [@nhtio/adk!Memory](../../../../common/classes/Memory.md), [@nhtio/adk!Message](../../../../common/classes/Message.md), [@nhtio/adk!Thought](../../../../common/classes/Thought.md),\n [@nhtio/adk!ToolCall](../../../../forge/classes/ToolCall.md), [@nhtio/adk!Tool](../../../../forge/classes/Tool.md), [@nhtio/adk!ArtifactTool](../../../../forge/classes/ArtifactTool.md), [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md)) into Chat\n Completions wire shapes. Consumers override individual helpers via `options.helpers.*` to\n customise envelope formats, bucket ordering, thought surfacing, or JSON Schema generation\n without forking the adapter.\n2. **Three-layer options merging** — constructor baseline, per-`executor()` overrides, and\n per-iteration `ctx.stash.webLLMChatCompletions` overrides combine with key-by-key\n precedence for `helpers` and wholesale replacement for everything else.\n The merged shape is re-validated on every iteration so a malformed stash override\n fails loud, not silently.\n3. **WebLLM engine invocation** — accepts a preloaded `engine` or lazy `createEngine` factory.\n The resolved request body is passed directly to WebLLM's OpenAI-compatible chat API.\n\nPer-iteration flow (steps 1–9 of the plan):\n\n1. Merge constructor / executor / stash options and re-validate.\n2. Resolve helpers, falling back to bundled `default*` for each unset field.\n3. Forge artifact-query tools by walking `ctx.turnToolCalls`, collecting unique\n `SpooledArtifact` constructors, calling `.forgeTools(ctx)` on each, and merging the\n results with `ctx.tools`.\n4. Pre-render every persisted tool-call result into the prompt-ready string the timeline will\n use, cached by `tc.id`.\n5. When `tokenEncoding !== null`, sum the token weight of every persisted bucket and throw\n [@nhtio/adk/batteries!E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](../exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md) when the total exceeds `contextWindow`.\n6. Build the request body via `buildChatCompletionsHistory`; carry vendor-opaque reasoning\n blocks through the `_adk_reasoning_payloads` side-channel.\n7. Resolve or lazily create a WebLLM engine and call `engine.chat.completions.create(body)`.\n8. Streaming path: consume WebLLM's async chunk iterable; surface deltas through\n `helpers.reportMessage` / `reportThought` / `reportToolCall`; assemble tool-call deltas via\n the accumulator; persist `Message` / `Thought` / `ToolCall` records on stream end.\n9. Non-streaming path: consume the returned Chat Completion object; same persistence +\n tool-execution loop.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| [WebLLMChatCompletionsAdapter](classes/WebLLMChatCompletionsAdapter.md) | Opinionated cross-environment LLM adapter for the WebLLM Chat Completions wire shape. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter/classes/WebLLMChatCompletionsAdapter","title":"Class: WebLLMChatCompletionsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter/classes/WebLLMChatCompletionsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter/classes/WebLLMChatCompletionsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/adapter/classes/WebLLMChatCompletionsAdapter.md\ndescription: >-\n Opinionated cross-environment LLM adapter for the WebLLM Chat Completions wire\n shape.\n---\n\n# Class: WebLLMChatCompletionsAdapter\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L259)\n\nOpinionated cross-environment LLM adapter for the WebLLM Chat Completions wire shape.\n\n## Remarks\n\nConstruction validates options eagerly via [@nhtio/adk/batteries!validateOptions](../../../openai_chat_completions/validation/functions/validateOptions.md) and throws\n[@nhtio/adk/batteries!E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS](../../exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md) on failure — config bugs fail loud, not at\ndispatch time. The returned instance is reusable: call [WebLLMChatCompletionsAdapter.executor](#executor)\nonce per `DispatchRunner` configuration to obtain an [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to the\nbaseline plus optional executor-scope overrides.\n\nPer-iteration overrides live on the active [@nhtio/adk!DispatchContext](../../../../../types/interfaces/DispatchContext.md)'s\n`stash.webLLMChatCompletions` slot and take highest precedence — they merge into the\nexecutor-scope shape on every iteration. `helpers` merge key-by-key across all three layers;\nevery other field is replaced wholesale at the highest layer that\nsets it.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew WebLLMChatCompletionsAdapter(options: unknown): WebLLMChatCompletionsAdapter;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L290)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `options` | `unknown` | Constructor-baseline options. Re-validated on every iteration after per-dispatch and per-iteration overrides are layered in. |\n\n#### Returns\n\n`WebLLMChatCompletionsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS](../../exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md) when `options` does not satisfy\n[@nhtio/adk/batteries!webLLMChatCompletionsOptionsSchema](../../validation/variables/webLLMChatCompletionsOptionsSchema.md).\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `STASH_KEY` | `readonly` | `\"webLLMChatCompletions\"` | Customary key for per-iteration overrides on `ctx.stash`. The adapter reads `ctx.stash.get(WebLLMChatCompletionsAdapter.STASH_KEY, {})` at the start of every iteration and merges the value into the resolved options shape. | [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:265](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L265) |\n\n## Methods\n\n### executor()\n\n```ts\nexecutor(overrides?: Partial): DispatchExecutorFn;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:407](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L407)\n\nReturns an [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) bound to this adapter's baseline plus optional\nexecutor-scope overrides. The returned function is reusable across iterations — every\niteration re-merges with `ctx.stash[STASH_KEY]` and re-validates the result.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`WebLLMChatCompletionsAdapterOptions`](../../../../interfaces/WebLLMChatCompletionsAdapterOptions.md)> | Optional executor-scope overrides. Higher precedence than the baseline, lower precedence than `ctx.stash[STASH_KEY]`. |\n\n#### Returns\n\n[`DispatchExecutorFn`](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md)\n\nAn [@nhtio/adk!DispatchExecutorFn](../../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) suitable for `DispatchRunner`.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L318)\n\nInstance-level availability check, honouring an injected\n[WebLLMChatCompletionsAdapterOptions.isWebGPUAvailable](../../../../interfaces/WebLLMChatCompletionsAdapterOptions.md#property-iswebgpuavailable) override.\n\n#### Returns\n\n`boolean`\n\n`true` when a WebLLM engine can run in the current environment.\n\n***\n\n### preload()\n\n```ts\npreload(overrides?: Partial): Promise;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:301](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L301)\n\nEagerly loads (and caches) the engine so the first dispatch does not pay the model-load cost.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |\n| `overrides?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`WebLLMChatCompletionsAdapterOptions`](../../../../interfaces/WebLLMChatCompletionsAdapterOptions.md)> | Optional option overrides layered over the constructor baseline. |\n\n#### Returns\n\n`Promise`<`MLCEngineInterface`>\n\nThe resolved [WebLLMEngine](../../../../type-aliases/WebLLMEngine.md).\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:307](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L307)\n\nDrops the cached engine and any in-flight load so the next dispatch re-resolves it.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:276](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L276)\n\nWhether the runtime can host a WebLLM engine — i.e. WebGPU (`navigator.gpu`) is present.\n\n#### Returns\n\n`boolean`\n\n`true` when WebGPU is available in the current environment.\n\n***\n\n### isWebLLMChatCompletionsAdapter()\n\n```ts\nstatic isWebLLMChatCompletionsAdapter(value: unknown): value is WebLLMChatCompletionsAdapter;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/adapter.ts:1212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/adapter.ts#L1212)\n\nReturns `true` when `value` is an WebLLMChatCompletionsAdapter instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is WebLLMChatCompletionsAdapter`\n\n`true` when `value` is an `WebLLMChatCompletionsAdapter` instance.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions","title":"@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions.md\ndescription: >-\n Battery-scoped exception constructors for WebLLM Chat Completions adapter\n failures.\n---\n\n# @nhtio/adk/batteries/llm/webllm\\_chat\\_completions/exceptions\n\nBattery-scoped exception constructors for WebLLM Chat Completions adapter failures.\n\n## Remarks\n\nBattery-scoped exception classes for the WebLLM Chat Completions adapter. These exceptions\nare owned by the battery (not the ADK core) and are minted via `createException` from\n`@nhtio/adk/factories`. Re-exported from the battery's barrel.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS](variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md) | Thrown when the resolved adapter options (constructor, executor overrides, or per-dispatch `stash.webLLMChatCompletions`) fail validation against `webLLMChatCompletionsOptionsSchema`. |\n| [E\\_UNSUPPORTED\\_MEDIA\\_MODALITY](variables/E_UNSUPPORTED_MEDIA_MODALITY.md) | Raised when a [@nhtio/adk!Media](../../../../common/classes/Media.md) instance whose modality cannot be natively represented in the WebLLM Chat Completions wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`. |\n| [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW](variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md) | Thrown when the total token weight of the resolved request exceeds `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding, perBucket }` in the message so middleware can target shedding. |\n| [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS](variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md) | Raised when a tool-call's `arguments` string emitted by the model is not a JSON object — either non-parseable JSON, or parseable JSON whose root is not an object (e.g. a bare string, number, array, or `null`). |\n| [E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR](variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR.md) | Thrown when the WebLLM engine call or async stream fails. Non-fatal — surfaced via `ctx.nack(...)`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS","title":"Variable: E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options (constructor, executor overrides, or\n per-dispatch `stash.webLLMChatCompletions`) fail validation against\n `webLLMChatCompletionsOptionsSchema`.\n---\n\n# Variable: E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS\n\n```ts\nconst E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/exceptions.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/exceptions.ts#L18)\n\nThrown when the resolved adapter options (constructor, executor overrides, or per-dispatch\n`stash.webLLMChatCompletions`) fail validation against `webLLMChatCompletionsOptionsSchema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","title":"Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_UNSUPPORTED_MEDIA_MODALITY.md\ndescription: >-\n Raised when a {@link @nhtio/adk!Media} instance whose modality cannot be\n natively represented in the WebLLM Chat Completions wire format reaches the\n adapter under `unsupportedMediaPolicy: 'throw'`.\n---\n\n# Variable: E\\_UNSUPPORTED\\_MEDIA\\_MODALITY\n\n```ts\nconst E_UNSUPPORTED_MEDIA_MODALITY: CreatedException<[string, string, string]>;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/exceptions.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/exceptions.ts#L91)\n\nRaised when a [@nhtio/adk!Media](../../../../../common/classes/Media.md) instance whose modality cannot be natively represented in the\nWebLLM Chat Completions wire format reaches the adapter under `unsupportedMediaPolicy: 'throw'`.\n\n## Remarks\n\nToday only `kind: 'video'` triggers this — Chat Completions natively supports `image`,\n`audio`, and `document` content blocks but has no video block. Consumers can opt out of the\nthrow by switching to `'fallback-stash'` or `'synthetic-description'` (see\n[@nhtio/adk/batteries/llm/openai\\_chat\\_completions/types!UnsupportedMediaPolicy](../../../transformers_js/type-aliases/UnsupportedMediaPolicy.md)).\n\nPrintf args: `[kind, mimeType, filename]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW","title":"Variable: E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW.md\ndescription: >-\n Thrown when the total token weight of the resolved request exceeds\n `contextWindow`. Only raised when `tokenEncoding` is non-null. Carries\n---\n\n# Variable: E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_CONTEXT\\_OVERFLOW\n\n```ts\nconst E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW: CreatedException<\n [number, number, string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/exceptions.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/exceptions.ts#L31)\n\nThrown when the total token weight of the resolved request exceeds `contextWindow`. Only\nraised when `tokenEncoding` is non-null. Carries `{ total, contextWindow, tokenEncoding,\nperBucket }` in the message so middleware can target shedding.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS","title":"Variable: E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS.md\ndescription: >-\n Raised when a tool-call's `arguments` string emitted by the model is not a\n JSON object — either non-parseable JSON, or parseable JSON whose root is not\n an object (e.g. a bare string, number, array, or `null`).\n---\n\n# Variable: E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_INVALID\\_TOOL\\_CALL\\_ARGS\n\n```ts\nconst E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS: CreatedException<\n [string, string]\n>;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/exceptions.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/exceptions.ts#L71)\n\nRaised when a tool-call's `arguments` string emitted by the model is not a JSON object —\neither non-parseable JSON, or parseable JSON whose root is not an object (e.g. a bare string,\nnumber, array, or `null`).\n\n## Remarks\n\nNon-fatal. The adapter does NOT throw this — it instantiates it inside\n`executeAndPersistToolCall`, pulls `.message` into a [@nhtio/adk!Tokenizable](../../../../../common/classes/Tokenizable.md), and persists a\n`ToolCall` record with `isError: true`. The model sees the formatted message in the next\niteration's history and can self-correct. Consumers introspecting persisted error results\ncan match on the `E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS` code substring.\n\nPrintf args: `[reasonHeadline, rawArgs]`.\n\n* `reasonHeadline` — short reason such as `'are not valid JSON'` or\n `'must be a JSON object; received array'`.\n* `rawArgs` — the raw `arguments` string the model emitted, echoed back verbatim so\n the model can see what it sent.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR","title":"Variable: E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/exceptions/variables/E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR.md\ndescription: >-\n Thrown when the WebLLM engine call or async stream fails. Non-fatal — surfaced\n via `ctx.nack(...)`.\n---\n\n# Variable: E\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_STREAM\\_ERROR\n\n```ts\nconst E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/exceptions.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/exceptions.ts#L45)\n\nThrown when the WebLLM engine call or async stream fails. Non-fatal — surfaced via\n`ctx.nack(...)`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers","title":"@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers.md\ndescription: >-\n Swappable translation helpers for rendering ADK state into WebLLM Chat\n Completions requests.\n---\n\n# @nhtio/adk/batteries/llm/webllm\\_chat\\_completions/helpers\n\nSwappable translation helpers for rendering ADK state into WebLLM Chat Completions requests.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |\n| [defaultRenderRetrievableHandleBody](variables/defaultRenderRetrievableHandleBody.md) | Default handle-body renderer for retrievable artifacts; the `renderRetrievableHandleBody` override falls back to this. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [renderRetrievableHandleBody](functions/renderRetrievableHandleBody.md) | Render the \"handle\" body for a [@nhtio/adk!Retrievable](../../../../common/classes/Retrievable.md)'s spooled-artifact content marked `inline: false`. See buildHandleBody for the shared mechanics; this variant's leading sentence frames the artifact as a retrieved record rather than a tool result. |\n\n## References\n\n### buildChatCompletionsHistory\n\nRe-exports [buildChatCompletionsHistory](../../openai_chat_completions/helpers/functions/buildChatCompletionsHistory.md)\n\n***\n\n### createChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [createChatCompletionsToolCallDeltaAccumulator](../../openai_chat_completions/helpers/functions/createChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### defaultBuildChatCompletionsHistory\n\nRe-exports [defaultBuildChatCompletionsHistory](../../openai_chat_completions/helpers/variables/defaultBuildChatCompletionsHistory.md)\n\n***\n\n### defaultCreateChatCompletionsToolCallDeltaAccumulator\n\nRe-exports [defaultCreateChatCompletionsToolCallDeltaAccumulator](../../openai_chat_completions/helpers/variables/defaultCreateChatCompletionsToolCallDeltaAccumulator.md)\n\n***\n\n### defaultDescriptionToChatCompletionsJsonSchema\n\nRe-exports [defaultDescriptionToChatCompletionsJsonSchema](../../../variables/defaultDescriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### defaultFilterThoughts\n\nRe-exports [defaultFilterThoughts](../../../variables/defaultFilterThoughts.md)\n\n***\n\n### defaultRenderChatCompletionsSystemPrompt\n\nRe-exports [defaultRenderChatCompletionsSystemPrompt](../../../variables/defaultRenderChatCompletionsSystemPrompt.md)\n\n***\n\n### defaultRenderChatCompletionsToolCallResult\n\nRe-exports [defaultRenderChatCompletionsToolCallResult](../../openai_chat_completions/helpers/variables/defaultRenderChatCompletionsToolCallResult.md)\n\n***\n\n### defaultRenderFirstPartyRetrievables\n\nRe-exports [defaultRenderFirstPartyRetrievables](../../../variables/defaultRenderFirstPartyRetrievables.md)\n\n***\n\n### defaultRenderMemories\n\nRe-exports [defaultRenderMemories](../../../variables/defaultRenderMemories.md)\n\n***\n\n### defaultRenderRetrievables\n\nRe-exports [defaultRenderRetrievables](../../../variables/defaultRenderRetrievables.md)\n\n***\n\n### defaultRenderRetrievableSafetyDirective\n\nRe-exports [defaultRenderRetrievableSafetyDirective](../../../variables/defaultRenderRetrievableSafetyDirective.md)\n\n***\n\n### defaultRenderStandingInstructions\n\nRe-exports [defaultRenderStandingInstructions](../../../variables/defaultRenderStandingInstructions.md)\n\n***\n\n### defaultRenderThirdPartyPrivateRetrievables\n\nRe-exports [defaultRenderThirdPartyPrivateRetrievables](../../../variables/defaultRenderThirdPartyPrivateRetrievables.md)\n\n***\n\n### defaultRenderThirdPartyPublicRetrievables\n\nRe-exports [defaultRenderThirdPartyPublicRetrievables](../../../variables/defaultRenderThirdPartyPublicRetrievables.md)\n\n***\n\n### defaultRenderThought\n\nRe-exports [defaultRenderThought](../../../variables/defaultRenderThought.md)\n\n***\n\n### defaultRenderTimelineMessage\n\nRe-exports [defaultRenderTimelineMessage](../../openai_chat_completions/helpers/variables/defaultRenderTimelineMessage.md)\n\n***\n\n### defaultRenderTrustedContent\n\nRe-exports [defaultRenderTrustedContent](../../../variables/defaultRenderTrustedContent.md)\n\n***\n\n### defaultRenderUntrustedContent\n\nRe-exports [defaultRenderUntrustedContent](../../../variables/defaultRenderUntrustedContent.md)\n\n***\n\n### defaultToolsToChatCompletionsTools\n\nRe-exports [defaultToolsToChatCompletionsTools](../../../variables/defaultToolsToChatCompletionsTools.md)\n\n***\n\n### descriptionToChatCompletionsJsonSchema\n\nRe-exports [descriptionToChatCompletionsJsonSchema](../../../functions/descriptionToChatCompletionsJsonSchema.md)\n\n***\n\n### extractReasoningFields\n\nRe-exports [extractReasoningFields](../../openai_chat_completions/helpers/functions/extractReasoningFields.md)\n\n***\n\n### filterThoughts\n\nRe-exports [filterThoughts](../../../functions/filterThoughts.md)\n\n***\n\n### renderChatCompletionsSystemPrompt\n\nRe-exports [renderChatCompletionsSystemPrompt](../../../functions/renderChatCompletionsSystemPrompt.md)\n\n***\n\n### renderChatCompletionsToolCallResult\n\nRe-exports [renderChatCompletionsToolCallResult](../../openai_chat_completions/helpers/functions/renderChatCompletionsToolCallResult.md)\n\n***\n\n### renderFirstPartyRetrievables\n\nRe-exports [renderFirstPartyRetrievables](../../../functions/renderFirstPartyRetrievables.md)\n\n***\n\n### renderMemories\n\nRe-exports [renderMemories](../../../functions/renderMemories.md)\n\n***\n\n### renderRetrievables\n\nRe-exports [renderRetrievables](../../../functions/renderRetrievables.md)\n\n***\n\n### renderRetrievableSafetyDirective\n\nRe-exports [renderRetrievableSafetyDirective](../../../functions/renderRetrievableSafetyDirective.md)\n\n***\n\n### renderStandingInstructions\n\nRe-exports [renderStandingInstructions](../../../functions/renderStandingInstructions.md)\n\n***\n\n### renderThirdPartyPrivateRetrievables\n\nRe-exports [renderThirdPartyPrivateRetrievables](../../../functions/renderThirdPartyPrivateRetrievables.md)\n\n***\n\n### renderThirdPartyPublicRetrievables\n\nRe-exports [renderThirdPartyPublicRetrievables](../../../functions/renderThirdPartyPublicRetrievables.md)\n\n***\n\n### renderThought\n\nRe-exports [renderThought](../../../functions/renderThought.md)\n\n***\n\n### renderTimelineMessage\n\nRe-exports [renderTimelineMessage](../../openai_chat_completions/helpers/functions/renderTimelineMessage.md)\n\n***\n\n### renderTrustedContent\n\nRe-exports [renderTrustedContent](../../../functions/renderTrustedContent.md)\n\n***\n\n### renderUntrustedContent\n\nRe-exports [renderUntrustedContent](../../../functions/renderUntrustedContent.md)\n\n***\n\n### toolsToChatCompletionsTools\n\nRe-exports [toolsToChatCompletionsTools](../../../functions/toolsToChatCompletionsTools.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/functions/renderRetrievableHandleBody","title":"Function: renderRetrievableHandleBody()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/functions/renderRetrievableHandleBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/functions/renderRetrievableHandleBody.md\n---\n\n# Function: renderRetrievableHandleBody()\n\n```ts\nfunction renderRetrievableHandleBody(input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n}): string;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:501](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L501)\n\nRender the \"handle\" body for a [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md)'s spooled-artifact content marked\n`inline: false`. See buildHandleBody for the shared mechanics; this variant's leading\nsentence frames the artifact as a retrieved record rather than a tool result.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; } |\n| `input.artifact` | `unknown` |\n| `input.byteLength` | `number` |\n| `input.callId` | `string` |\n| `input.encoding?` | `string` |\n| `input.estimatedTokens?` | `number` |\n| `input.lineCount` | `number` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody","title":"Variable: defaultRenderRetrievableHandleBody","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/helpers/variables/defaultRenderRetrievableHandleBody.md\ndescription: >-\n Default handle-body renderer for retrievable artifacts; the\n `renderRetrievableHandleBody` override falls back to this.\n---\n\n# Variable: defaultRenderRetrievableHandleBody\n\n```ts\nconst defaultRenderRetrievableHandleBody: (input: {\n artifact: unknown;\n byteLength: number;\n callId: string;\n encoding?: string;\n estimatedTokens?: number;\n lineCount: number;\n}) => string = renderRetrievableHandleBody;\n```\n\nDefined in: [src/batteries/llm/chat\\_common/helpers.ts:517](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/chat_common/helpers.ts#L517)\n\nDefault handle-body renderer for retrievable artifacts; the `renderRetrievableHandleBody` override falls back to this.\n\nRender the \"handle\" body for a [@nhtio/adk!Retrievable](../../../../../common/classes/Retrievable.md)'s spooled-artifact content marked\n`inline: false`. See buildHandleBody for the shared mechanics; this variant's leading\nsentence frames the artifact as a retrieved record rather than a tool result.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `artifact`: `unknown`; `byteLength`: `number`; `callId`: `string`; `encoding?`: `string`; `estimatedTokens?`: `number`; `lineCount`: `number`; } |\n| `input.artifact` | `unknown` |\n| `input.byteLength` | `number` |\n| `input.callId` | `string` |\n| `input.encoding?` | `string` |\n| `input.estimatedTokens?` | `number` |\n| `input.lineCount` | `number` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/CreateWebLLMChatCompletionsEngine","title":"Type Alias: CreateWebLLMChatCompletionsEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/CreateWebLLMChatCompletionsEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/CreateWebLLMChatCompletionsEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/CreateWebLLMChatCompletionsEngine.md\ndescription: 'Factory that loads a model and resolves a ready-to-use [`WebLLMEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/type-aliases/WebLLMEngine).'\n---\n\n# Type Alias: CreateWebLLMChatCompletionsEngine\n\n```ts\ntype CreateWebLLMChatCompletionsEngine = (input: {\n chatOptions?: ChatOptions | ChatOptions[];\n engineConfig?: MLCEngineConfig;\n model: string;\n onInitProgress?: (report: InitProgressReport) => void;\n}) => Promise;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/types.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L65)\n\nFactory that loads a model and resolves a ready-to-use [WebLLMEngine](../../../type-aliases/WebLLMEngine.md).\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `chatOptions?`: `ChatOptions` | `ChatOptions`\\[]; `engineConfig?`: `MLCEngineConfig`; `model`: `string`; `onInitProgress?`: (`report`: `InitProgressReport`) => `void`; } |\n| `input.chatOptions?` | `ChatOptions` | `ChatOptions`\\[] |\n| `input.engineConfig?` | `MLCEngineConfig` |\n| `input.model` | `string` |\n| `input.onInitProgress?` | (`report`: `InitProgressReport`) => `void` |\n\n## Returns\n\n`Promise`<[`WebLLMEngine`](../../../type-aliases/WebLLMEngine.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/WebLLMChatCompletionsEngine","title":"Type Alias: WebLLMChatCompletionsEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/WebLLMChatCompletionsEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/WebLLMChatCompletionsEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/type-aliases/WebLLMChatCompletionsEngine.md\ndescription: 'Alias of [`WebLLMEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/type-aliases/WebLLMEngine).'\n---\n\n# Type Alias: WebLLMChatCompletionsEngine\n\n```ts\ntype WebLLMChatCompletionsEngine = WebLLMEngine;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/types.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/types.ts#L61)\n\nAlias of [WebLLMEngine](../../../type-aliases/WebLLMEngine.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation","title":"@nhtio/adk/batteries/llm/webllm\\_chat\\_completions/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation.md\ndescription: >-\n Runtime validation schema and wrapper for WebLLM Chat Completions adapter\n options.\n---\n\n# @nhtio/adk/batteries/llm/webllm\\_chat\\_completions/validation\n\nRuntime validation schema and wrapper for WebLLM Chat Completions adapter options.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [webLLMChatCompletionsOptionsSchema](variables/webLLMChatCompletionsOptionsSchema.md) | Validator schema for [WebLLMChatCompletionsAdapterOptions](../../../interfaces/WebLLMChatCompletionsAdapterOptions.md). Rejects unknown keys (`.unknown(false)`) so typos and removed fields fail loud, and fills in defaults. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates raw adapter options against [webLLMChatCompletionsOptionsSchema](variables/webLLMChatCompletionsOptionsSchema.md), filling in defaults. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): WebLLMChatCompletionsAdapterOptions;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/validation.ts:254](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/validation.ts#L254)\n\nValidates raw adapter options against [webLLMChatCompletionsOptionsSchema](../variables/webLLMChatCompletionsOptionsSchema.md), filling in\ndefaults.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`WebLLMChatCompletionsAdapterOptions`](../../../../interfaces/WebLLMChatCompletionsAdapterOptions.md)\n\nThe resolved options object with defaults applied.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_WEBLLM\\_CHAT\\_COMPLETIONS\\_OPTIONS](../../exceptions/variables/E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS.md) when `input` is invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/variables/webLLMChatCompletionsOptionsSchema","title":"Variable: webLLMChatCompletionsOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/variables/webLLMChatCompletionsOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/variables/webLLMChatCompletionsOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/llm/webllm_chat_completions/validation/variables/webLLMChatCompletionsOptionsSchema.md\ndescription: >-\n Validator schema for [`WebLLMChatCompletionsAdapterOptions`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/WebLLMChatCompletionsAdapterOptions). Rejects\n unknown keys (`.unknown(false)`) so typos and removed fields fail loud, and\n fills in defaults.\n---\n\n# Variable: webLLMChatCompletionsOptionsSchema\n\n```ts\nconst webLLMChatCompletionsOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/llm/webllm\\_chat\\_completions/validation.ts:152](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/llm/webllm_chat_completions/validation.ts#L152)\n\nValidator schema for [WebLLMChatCompletionsAdapterOptions](../../../../interfaces/WebLLMChatCompletionsAdapterOptions.md). Rejects unknown keys\n(`.unknown(false)`) so typos and removed fields fail loud, and fills in defaults.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media","title":"@nhtio/adk/batteries/media","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media.md'\ndescription: >-\n A knex-inspired local media pipeline: one declarative plan, three front-ends\n (chainable builder, pipe string, JSON ops), engines as composable seams.\n---\n\n# @nhtio/adk/batteries/media\n\nA knex-inspired local media pipeline: one declarative plan, three front-ends (chainable\nbuilder, pipe string, JSON ops), engines as composable seams.\n\n## Remarks\n\nMost implementations give you two ways to process media — ship it to an external API, or\nflood the model's context window with the bytes. This battery is the third option: **full\ncontrol of media — local processing, no external APIs by default, cross-environment where\npossible.** Your data stays in your application and infrastructure unless you deliberately\nwire an engine that sends it elsewhere.\n\nThe entry point is [createMediaPipeline](functions/createMediaPipeline.md):\n\n```ts\nimport { createMediaPipeline } from \"@nhtio/adk/batteries/media\";\n\nconst mp = await createMediaPipeline({\n engines: [\n // an ordered array of self-declaring engines; resolvers run eagerly at construction,\n // but each engine's heavy peer dependency loads lazily on first actual use\n () =>\n import(\"@nhtio/adk/batteries/media/engines/jimp\").then((m) =>\n m.jimpEngine(),\n ),\n ],\n});\n\n// chainable builder (implementor DX)\nconst redacted = await mp(payload)\n .select({ pages: [2, 3] })\n .redact({ match: [/\\d{3}-\\d{2}-\\d{4}/] });\n\n// pipe string (the LLM-facing DSL — same plan underneath)\nconst result = await mp.query(\n payload,\n \"select pages=2-3 | redact match=/\\\\d{3}-\\\\d{2}-\\\\d{4}/\",\n);\n```\n\nMedia pipelines have no standard — every tool invented its own grammar. LLMs don't share one\nmental model of that chaos, so the pipe DSL projects every operation onto the one\ntransformation idiom every model already groks: shell pipes with `key=value` args. The verbs\na deployment advertises narrow to the engines it configured; everything else fails loud with\na model-actionable message.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [MediaChain](classes/MediaChain.md) | The chainable builder. Immutable — every verb returns a new instance sharing the executor. Thenable — `await` runs the chain and resolves to the terminal step's natural type. |\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [AudioNamespace](interfaces/AudioNamespace.md) | `audio.*` verbs. |\n| [CapabilityProbe](interfaces/CapabilityProbe.md) | The minimal synchronous capability probe the validator narrows against. The pipeline's engine registry implements it; tests stub it. |\n| [CellUpdate](interfaces/CellUpdate.md) | A cell update for `sheet.updateCells`. |\n| [EngineRegistry](interfaces/EngineRegistry.md) | Ordered capability-filtered dispatch over the pipeline's engines. |\n| [EngineSelectionContext](interfaces/EngineSelectionContext.md) | The request summary a selection stage sees: enough to implement content- and format-dependent rules without exposing dispatch internals. |\n| [ImageNamespace](interfaces/ImageNamespace.md) | `image.*` verbs (the runtime fuses adjacent image steps into one engine pass). |\n| [MediaOp](interfaces/MediaOp.md) | The JSON ops front-end's step shape — identical to [MediaStep](interfaces/MediaStep.md) minus the span. |\n| [MediaPipeline](interfaces/MediaPipeline.md) | The callable pipeline returned by [createMediaPipeline](functions/createMediaPipeline.md): `mp(payload)` opens a chainable builder; `mp.query(payload, q)` runs a pipe-string statement; `mp.ops(payload, ops)` runs a JSON ops array. All three compile to the same plan and execute on the same runtime. |\n| [MediaPipelineConfig](interfaces/MediaPipelineConfig.md) | Configuration for [createMediaPipeline](functions/createMediaPipeline.md). |\n| [MediaPlan](interfaces/MediaPlan.md) | The neutral plan: an ordered, linear list of steps. No branching. |\n| [MediaStep](interfaces/MediaStep.md) | One transform step: a canonical verb id plus its validated content args. |\n| [RawArgValue](interfaces/RawArgValue.md) | A parsed-but-unvalidated arg value, before the verb's arg schema refines it. |\n| [RawSegment](interfaces/RawSegment.md) | One parsed segment: verb words plus named args, all position-bearing. |\n| [RegExpRef](interfaces/RegExpRef.md) | A serializable regex reference. Never a live `RegExp` in the IR. |\n| [ResizeOptions](interfaces/ResizeOptions.md) | Options accepted by image resize. |\n| [RunOptions](interfaces/RunOptions.md) | Per-run options for `query`/`ops`. |\n| [SheetNamespace](interfaces/SheetNamespace.md) | `sheet.*` verbs, mirrored from the verb table. |\n| [SlidesNamespace](interfaces/SlidesNamespace.md) | `slides.*` verbs. |\n| [SourceSpan](interfaces/SourceSpan.md) | Source span carried by steps parsed from a pipe string, for error mapping. |\n| [StepContext](interfaces/StepContext.md) | The mutable execution context threaded through interceptors and step impls. |\n| [StepPayload](interfaces/StepPayload.md) | A single in-flight value travelling between steps. |\n| [ValidateOptions](interfaces/ValidateOptions.md) | Options for [validateSegments](functions/validateSegments.md) / [validateOps](functions/validateOps.md). |\n| [VerbArgSpec](interfaces/VerbArgSpec.md) | Declaration of one named arg on a verb. |\n| [VerbSpec](interfaces/VerbSpec.md) | One verb table entry. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ChainExecutor](type-aliases/ChainExecutor.md) | The function a builder calls to execute its accumulated ops. Bound by the pipeline. |\n| [ChainInput](type-aliases/ChainInput.md) | The input shapes `mp(...)` accepts. |\n| [EngineSelectionMiddlewareFn](type-aliases/EngineSelectionMiddlewareFn.md) | A selection-middleware stage — the seam for quality heuristics and implementor overrides when several engines can perform the same transform (e.g. route complex workbooks past a pure-JS converter to LibreOffice). Same onion shape as the battery's `use` interceptors; a fresh runner is minted per dispatch. Keep stages cheap or memoized: they run with bytes in hand on every dispatch. |\n| [FormatFamily](type-aliases/FormatFamily.md) | Broad input families used for verb-applicability checks. |\n| [MediaArgJson](type-aliases/MediaArgJson.md) | A structured (JSON-shaped) arg value. In the pipe surface these are written as quoted JSON (`updates='[{\"address\":\"B2\",\"value\":3}]'`); in ops they are plain JSON. `null` is legal only inside structured values (cell values), never as a top-level scalar. |\n| [MediaArgScalar](type-aliases/MediaArgScalar.md) | Scalar arg values the flat pipe grammar can express directly. |\n| [MediaArgValue](type-aliases/MediaArgValue.md) | The value space of a single verb arg in the IR. |\n| [MediaChainRef](type-aliases/MediaChainRef.md) | How other media are referenced from builder verbs: an id string or `{ mediaId }`. |\n| [MediaRef](type-aliases/MediaRef.md) | A reference to another media participating in a multi-input verb (`merge`, `diff`, `apply_patch`, `slides.update_image`). |\n| [MediaRefResolver](type-aliases/MediaRefResolver.md) | Resolves a media-ref id to its payload — supplied by the consumer (or the agent forge). |\n| [MediaStepMiddlewareFn](type-aliases/MediaStepMiddlewareFn.md) | Consumer step interceptor — the `use` seam. Same onion shape as the tool batteries. |\n| [PlanResult](type-aliases/PlanResult.md) | The settled result of executing a whole plan. |\n| [StepImpl](type-aliases/StepImpl.md) | One verb's implementation. Registered into the runtime's step registry. |\n| [StepResult](type-aliases/StepResult.md) | What a step produces. `media` continues the chain (or terminates as bytes); `media-list` and `data` are terminal-only shapes enforced by the plan compiler. |\n| [VerbArgType](type-aliases/VerbArgType.md) | The value type of a single declared arg. |\n| [VerbOutput](type-aliases/VerbOutput.md) | What awaiting a chain ending in this verb resolves to. |\n| [VerbRequirement](type-aliases/VerbRequirement.md) | A verb's capability requirement against the deployment's engine registry. Verbs with no requirement are always advertised; input-conditional engine needs (e.g. `extract.text` needing OCR only for images) stay runtime checks inside the step implementation. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_MEDIA\\_PIPELINE\\_CONFIG](variables/E_INVALID_MEDIA_PIPELINE_CONFIG.md) | Thrown when `createMediaPipeline` receives an invalid configuration — a malformed engine, a resolver that resolved to a value failing its contract guard, or an invalid option shape. |\n| [E\\_MEDIA\\_BAD\\_ARG](variables/E_MEDIA_BAD_ARG.md) | Thrown when an arg value fails its declared type/enum/constraint — including descending ranges, invalid regex sources, malformed embedded JSON, and out-of-enum values. |\n| [E\\_MEDIA\\_ENGINE\\_REQUIRED](variables/E_MEDIA_ENGINE_REQUIRED.md) | Thrown at plan validation when a verb (or the specific input it is applied to) requires an engine that is not configured on this pipeline. The message states which engine slot is missing and — when the failure is input-specific — that the verb should not be retried on this media in this deployment. |\n| [E\\_MEDIA\\_MISSING\\_ARG](variables/E_MEDIA_MISSING_ARG.md) | Thrown when a verb's required arg is absent from the statement. |\n| [E\\_MEDIA\\_NOT\\_PIPE\\_EXPRESSIBLE](variables/E_MEDIA_NOT_PIPE_EXPRESSIBLE.md) | Thrown by `toPipe()` when the plan contains constructs the flat pipe grammar cannot express — currently only nested-builder media refs. Quoted-JSON structured args DO render; use `toOps()` for a total serialization. |\n| [E\\_MEDIA\\_PIPE\\_SYNTAX](variables/E_MEDIA_PIPE_SYNTAX.md) | Thrown by `parsePipe` when the pipe expression fails to tokenize or parse. The message carries line/col position and a corrective exemplar. |\n| [E\\_MEDIA\\_STEP\\_FAILED](variables/E_MEDIA_STEP_FAILED.md) | Thrown by the step runtime when a step implementation fails mid-execution (corrupt input, engine error). Carries the underlying error as `cause`. |\n| [E\\_MEDIA\\_STEP\\_UNAVAILABLE](variables/E_MEDIA_STEP_UNAVAILABLE.md) | Thrown by the step runtime when a plan step has no registered implementation. Distinct from `E_MEDIA_ENGINE_REQUIRED`: this indicates the battery itself does not (yet) implement the verb, not that the consumer omitted an engine. |\n| [E\\_MEDIA\\_UNKNOWN\\_ARG](variables/E_MEDIA_UNKNOWN_ARG.md) | Thrown when a statement passes an arg a verb does not declare. The message includes a did-you-mean suggestion and the verb's declared args. |\n| [E\\_MEDIA\\_UNKNOWN\\_VERB](variables/E_MEDIA_UNKNOWN_VERB.md) | Thrown when a statement names a verb that does not exist in the verb table. The message includes a did-you-mean suggestion (Levenshtein over folded verb forms, including suffix-word matches) and the list of verbs available in this deployment. |\n| [E\\_MEDIA\\_UNSUPPORTED\\_OP](variables/E_MEDIA_UNSUPPORTED_OP.md) | Thrown at plan validation when a verb cannot apply to the input's format family (e.g. a `sheet.*` verb on a PDF), or a namespace verb is used on the wrong media kind. |\n| [EXT\\_TO\\_MIME](variables/EXT_TO_MIME.md) | A small extension → MIME lookup for filenames produced by transforms. |\n| [FOLDED\\_VERBS](variables/FOLDED_VERBS.md) | All folded verb word-sequences, for the parser's longest-match verb recognition and for generated grammar text. |\n| [MIME](variables/MIME.md) | Well-known MIME constants used across the battery. |\n| [VERB\\_INDEX](variables/VERB_INDEX.md) | Map of canonical verb id → spec, for direct lookup. |\n| [VERBS](variables/VERBS.md) | The canonical verb table. Order is presentation order in generated grammar text. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [availableVerbs](functions/availableVerbs.md) | The folded verb forms available under a given capability configuration. |\n| [buildEngineRegistry](functions/buildEngineRegistry.md) | Build the registry over a resolved, validated engine array. |\n| [createMediaPipeline](functions/createMediaPipeline.md) | Create a media pipeline. |\n| [familyOf](functions/familyOf.md) | Classify a MIME type into the verb table's broad format family. |\n| [fromOps](functions/fromOps.md) | Build a [MediaPlan](interfaces/MediaPlan.md) from a JSON ops array. The inverse of [toOps](functions/toOps.md). |\n| [isMediaRef](functions/isMediaRef.md) | `true` when `value` is a [MediaRef](type-aliases/MediaRef.md). |\n| [isRegExpRef](functions/isRegExpRef.md) | `true` when `value` is a [RegExpRef](interfaces/RegExpRef.md). |\n| [lowerSegments](functions/lowerSegments.md) | Lower raw segments to an (unvalidated) [MediaPlan](interfaces/MediaPlan.md). Quoted-JSON arg parsing and type/enum checks happen in the validator, which consumes the raw segments — this lowering exists for tooling that wants the structural plan without validation. |\n| [parsePipeRaw](functions/parsePipeRaw.md) | Parse a pipe expression into raw, position-bearing segments. |\n| [replaceExtension](functions/replaceExtension.md) | Replace (or add) a filename's extension. |\n| [suggestVerbs](functions/suggestVerbs.md) | Suggest the nearest verbs to an unknown input, for did-you-mean errors. Matches whole folded forms AND suffix words (`resize` suggests `image resize`), per the frozen error model. |\n| [toOps](functions/toOps.md) | Render a [MediaPlan](interfaces/MediaPlan.md) to its JSON ops array. Total — every plan has an ops form. |\n| [toPipe](functions/toPipe.md) | Render a [MediaPlan](interfaces/MediaPlan.md) to its canonical pipe string. |\n| [unsupportedForMutationReason](functions/unsupportedForMutationReason.md) | Reason a mutation verb cannot run against this MIME type, or `undefined` when mutation is allowed. Returns a reason string (not a throw) so callers compose model-actionable failures. |\n| [validateOps](functions/validateOps.md) | Validate a JSON ops array into a [MediaPlan](interfaces/MediaPlan.md). The same checks as the pipe path — verbs fold the same way, args validate against the same specs — so the two front-ends produce identical plans for equivalent statements. |\n| [validateSegments](functions/validateSegments.md) | Validate raw pipe segments into a [MediaPlan](interfaces/MediaPlan.md). |\n\n## References\n\n### AsrConvertOptions\n\nRe-exports [AsrConvertOptions](contracts/interfaces/AsrConvertOptions.md)\n\n***\n\n### bytesToPcm\n\nRe-exports [bytesToPcm](contracts/functions/bytesToPcm.md)\n\n***\n\n### ConvertCapability\n\nRe-exports [ConvertCapability](contracts/interfaces/ConvertCapability.md)\n\n***\n\n### ConvertOptions\n\nRe-exports [ConvertOptions](contracts/interfaces/ConvertOptions.md)\n\n***\n\n### ConvertOutput\n\nRe-exports [ConvertOutput](contracts/interfaces/ConvertOutput.md)\n\n***\n\n### ConvertRequest\n\nRe-exports [ConvertRequest](contracts/interfaces/ConvertRequest.md)\n\n***\n\n### ConvertResult\n\nRe-exports [ConvertResult](contracts/interfaces/ConvertResult.md)\n\n***\n\n### EditCapability\n\nRe-exports [EditCapability](contracts/interfaces/EditCapability.md)\n\n***\n\n### EditRequest\n\nRe-exports [EditRequest](contracts/interfaces/EditRequest.md)\n\n***\n\n### EditResult\n\nRe-exports [EditResult](contracts/interfaces/EditResult.md)\n\n***\n\n### EditSummary\n\nRe-exports [EditSummary](contracts/interfaces/EditSummary.md)\n\n***\n\n### EMPTY\\_MIME\n\nRe-exports [EMPTY\\_MIME](contracts/variables/EMPTY_MIME.md)\n\n***\n\n### EngineResolver\n\nRe-exports [EngineResolver](contracts/type-aliases/EngineResolver.md)\n\n***\n\n### foldVerb\n\nRe-exports [foldVerb](forge/functions/foldVerb.md)\n\n***\n\n### ImageAnnotation\n\nRe-exports [ImageAnnotation](contracts/type-aliases/ImageAnnotation.md)\n\n***\n\n### ImagesConvertOptions\n\nRe-exports [ImagesConvertOptions](contracts/interfaces/ImagesConvertOptions.md)\n\n***\n\n### implementsMediaEngine\n\nRe-exports [implementsMediaEngine](contracts/functions/implementsMediaEngine.md)\n\n***\n\n### MediaEngine\n\nRe-exports [MediaEngine](contracts/interfaces/MediaEngine.md)\n\n***\n\n### MimePattern\n\nRe-exports [MimePattern](contracts/type-aliases/MimePattern.md)\n\n***\n\n### MutateCapability\n\nRe-exports [MutateCapability](contracts/interfaces/MutateCapability.md)\n\n***\n\n### MutateRequest\n\nRe-exports [MutateRequest](contracts/interfaces/MutateRequest.md)\n\n***\n\n### OcrConvertOptions\n\nRe-exports [OcrConvertOptions](contracts/interfaces/OcrConvertOptions.md)\n\n***\n\n### PCM\\_MIME\n\nRe-exports [PCM\\_MIME](contracts/variables/PCM_MIME.md)\n\n***\n\n### pcmToBytes\n\nRe-exports [pcmToBytes](contracts/functions/pcmToBytes.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/classes/MediaChain","title":"Class: MediaChain","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/classes/MediaChain.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/classes/MediaChain","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/classes/MediaChain.md'\ndescription: >-\n The chainable builder. Immutable — every verb returns a new instance sharing\n the executor. Thenable — `await` runs the chain and resolves to the terminal\n step's natural type.\n---\n\n# Class: MediaChain\n\nDefined in: [src/batteries/media/builder.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L56)\n\nThe chainable builder. Immutable — every verb returns a new instance sharing the executor.\nThenable — `await` runs the chain and resolves to the terminal step's natural type.\n\n## Implements\n\n* `PromiseLike`<`unknown`>\n\n## Constructors\n\n### Constructor\n\n```ts\nnew MediaChain(exec: ChainExecutor, ops?: MediaOp[]): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L60)\n\n#### Parameters\n\n| Parameter | Type | Default value |\n| --------- | --------------------------------------------------- | ------------- |\n| `exec` | [`ChainExecutor`](../type-aliases/ChainExecutor.md) | `undefined` |\n| `ops` | [`MediaOp`](../interfaces/MediaOp.md)\\[] | `[]` |\n\n#### Returns\n\n`MediaChain`\n\n## Accessors\n\n### audio\n\n#### Get Signature\n\n```ts\nget audio(): AudioNamespace;\n```\n\nDefined in: [src/batteries/media/builder.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L198)\n\nAudio operations.\n\n##### Returns\n\n[`AudioNamespace`](../interfaces/AudioNamespace.md)\n\n***\n\n### image\n\n#### Get Signature\n\n```ts\nget image(): ImageNamespace;\n```\n\nDefined in: [src/batteries/media/builder.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L193)\n\nImage transforms.\n\n##### Returns\n\n[`ImageNamespace`](../interfaces/ImageNamespace.md)\n\n***\n\n### sheet\n\n#### Get Signature\n\n```ts\nget sheet(): SheetNamespace;\n```\n\nDefined in: [src/batteries/media/builder.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L183)\n\nSpreadsheet mutations.\n\n##### Returns\n\n[`SheetNamespace`](../interfaces/SheetNamespace.md)\n\n***\n\n### slides\n\n#### Get Signature\n\n```ts\nget slides(): SlidesNamespace;\n```\n\nDefined in: [src/batteries/media/builder.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L188)\n\nPresentation mutations.\n\n##### Returns\n\n[`SlidesNamespace`](../interfaces/SlidesNamespace.md)\n\n## Methods\n\n### applyPatch()\n\n```ts\napplyPatch(patch: string, options?: {\n with?: MediaChainRef[];\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:134](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L134)\n\nApply a unified-diff patch.\n\n#### Parameters\n\n| Parameter | Type |\n| --------------- | --------------------------------------------------------------------- |\n| `patch` | `string` |\n| `options` | { `with?`: [`MediaChainRef`](../type-aliases/MediaChainRef.md)\\[]; } |\n| `options.with?` | [`MediaChainRef`](../type-aliases/MediaChainRef.md)\\[] |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### chunk()\n\n```ts\nchunk(options?: {\n overlap?: number;\n size?: number;\n strategy?: \"sentence\" | \"paragraph\" | \"fixed\";\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L170)\n\nChunk extracted text. Terminal: resolves to a chunk array.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------- | ------------------------------------------------------------------------------------------------------- |\n| `options` | { `overlap?`: `number`; `size?`: `number`; `strategy?`: `\"sentence\"` | `\"paragraph\"` | `\"fixed\"`; } |\n| `options.overlap?` | `number` |\n| `options.size?` | `number` |\n| `options.strategy?` | `\"sentence\"` | `\"paragraph\"` | `\"fixed\"` |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### convert()\n\n```ts\nconvert(to: string): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L72)\n\nConvert to another format (requires a convert engine).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `to` | `string` |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### diff()\n\n```ts\ndiff(other: MediaChainRef): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L129)\n\nCompare against another media. Terminal: resolves to a structured diff.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------- |\n| `other` | [`MediaChainRef`](../type-aliases/MediaChainRef.md) |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### extractAssets()\n\n```ts\nextractAssets(options?: {\n types?: (\"all\" | \"image\" | \"font\" | \"attachment\")[];\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L161)\n\nExtract embedded assets. Terminal: resolves to a media list.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------- | ----------------------------------------------------------------------- |\n| `options` | { `types?`: (`\"all\"` | `\"image\"` | `\"font\"` | `\"attachment\"`)\\[]; } |\n| `options.types?` | (`\"all\"` | `\"image\"` | `\"font\"` | `\"attachment\"`)\\[] |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### extractMetadata()\n\n```ts\nextractMetadata(): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L156)\n\nExtract metadata. Terminal: resolves to a metadata object.\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### extractText()\n\n```ts\nextractText(options?: {\n lang?: string[];\n ocr?: \"off\" | \"auto\" | \"force\";\n ocrOut?: \"json\" | \"txt\" | \"hocr\";\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L141)\n\nExtract text (routes by format; OCR engine used when needed). Terminal: resolves to text.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------- | ---------------------------------------------------------------------------------------------------------------- |\n| `options` | { `lang?`: `string`\\[]; `ocr?`: `\"off\"` | `\"auto\"` | `\"force\"`; `ocrOut?`: `\"json\"` | `\"txt\"` | `\"hocr\"`; } |\n| `options.lang?` | `string`\\[] |\n| `options.ocr?` | `\"off\"` | `\"auto\"` | `\"force\"` |\n| `options.ocrOut?` | `\"json\"` | `\"txt\"` | `\"hocr\"` |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### merge()\n\n```ts\nmerge(...others: MediaChainRef[]): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L90)\n\nMerge other media into this one, in order.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ----------------------------------------------------- |\n| ...`others` | [`MediaChainRef`](../type-aliases/MediaChainRef.md)\\[] |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### normalize()\n\n```ts\nnormalize(): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L119)\n\nNormalize structure/encoding.\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### redact()\n\n```ts\nredact(options: {\n match: string | RegExp | (string | RegExp)[];\n replace?: string;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L100)\n\nRedact matching text (literals or RegExp).\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------ | -------------------------------------------------------------------------------------- |\n| `options` | { `match`: `string` | `RegExp` | (`string` | `RegExp`)\\[]; `replace?`: `string`; } |\n| `options.match` | `string` | `RegExp` | (`string` | `RegExp`)\\[] |\n| `options.replace?` | `string` |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### reorder()\n\n```ts\nreorder(order: number[]): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L95)\n\nReorder pages by 1-based index.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------- |\n| `order` | `number`\\[] |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### run()\n\n```ts\nrun(): Promise;\n```\n\nDefined in: [src/batteries/media/builder.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L229)\n\nExecute and return the raw [PlanResult](../type-aliases/PlanResult.md) (no unwrapping).\n\n#### Returns\n\n`Promise`<[`StepResult`](../type-aliases/StepResult.md)>\n\n***\n\n### sanitize()\n\n```ts\nsanitize(): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L114)\n\nRemove potentially unsafe embedded content.\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### select()\n\n```ts\nselect(options: {\n pages: number[];\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L77)\n\nKeep only the listed 1-based pages.\n\n#### Parameters\n\n| Parameter | Type |\n| --------------- | -------------------------- |\n| `options` | { `pages`: `number`\\[]; } |\n| `options.pages` | `number`\\[] |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### split()\n\n```ts\nsplit(options?: {\n by?: \"page\" | \"section\";\n ranges?: number[][];\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L82)\n\nSplit by page (optionally grouped `[[start,end], …]`). Terminal: resolves to media list.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------- | -------------------------------------------------------------- |\n| `options` | { `by?`: `\"page\"` | `\"section\"`; `ranges?`: `number`\\[]\\[]; } |\n| `options.by?` | `\"page\"` | `\"section\"` |\n| `options.ranges?` | `number`\\[]\\[] |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### then()\n\n```ts\nthen(onfulfilled?:\n | ((value: unknown) => TResult1 | PromiseLike)\n | null, onrejected?:\n | ((reason: unknown) => TResult2 | PromiseLike)\n| null): PromiseLike;\n```\n\nDefined in: [src/batteries/media/builder.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L221)\n\nThenable: awaiting the chain executes it.\n\n#### Type Parameters\n\n| Type Parameter | Default type |\n| -------------- | ------------ |\n| `TResult1` | `unknown` |\n| `TResult2` | `never` |\n\n#### Parameters\n\n| Parameter | Type |\n| -------------- | --------------------------------------------------------------------------------- |\n| `onfulfilled?` | | ((`value`: `unknown`) => `TResult1` | `PromiseLike`<`TResult1`>) | `null` |\n| `onrejected?` | | ((`reason`: `unknown`) => `TResult2` | `PromiseLike`<`TResult2`>) | `null` |\n\n#### Returns\n\n`PromiseLike`<`TResult1` | `TResult2`>\n\n#### Implementation of\n\n```ts\nPromiseLike.then;\n```\n\n***\n\n### toOps()\n\n```ts\ntoOps(): MediaOp[];\n```\n\nDefined in: [src/batteries/media/builder.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L205)\n\nThe accumulated ops (a copy).\n\n#### Returns\n\n[`MediaOp`](../interfaces/MediaOp.md)\\[]\n\n***\n\n### toPipe()\n\n```ts\ntoPipe(): string;\n```\n\nDefined in: [src/batteries/media/builder.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L210)\n\nThe canonical pipe form of the accumulated chain.\n\n#### Returns\n\n`string`\n\n***\n\n### updateText()\n\n```ts\nupdateText(anchor: string, replace: string): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L124)\n\nReplace the first occurrence of anchor text.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `anchor` | `string` |\n| `replace` | `string` |\n\n#### Returns\n\n`MediaChain`\n\n***\n\n### withOp()\n\n```ts\nwithOp(verb: string, args: Record): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L216)\n\nInternal — used by namespaces to append.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `verb` | `string` |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`MediaArgValue`](../type-aliases/MediaArgValue.md)> |\n\n#### Returns\n\n`MediaChain`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts","title":"@nhtio/adk/batteries/media/contracts","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts.md'\ndescription: >-\n Generic engine contracts for the media pipeline battery — the seams every\n implementation (bundled or BYO) plugs into.\n---\n\n# @nhtio/adk/batteries/media/contracts\n\nGeneric engine contracts for the media pipeline battery — the seams every implementation\n(bundled or BYO) plugs into.\n\n## Remarks\n\nEngines are seams, not policies. An engine is a self-declaring capability provider: it\nstates exactly which transforms it supports — [ConvertCapability](interfaces/ConvertCapability.md) edges (input MIME\npatterns to output format tokens), [MutateCapability](interfaces/MutateCapability.md) groups (same-format content\ntransforms), and [EditCapability](interfaces/EditCapability.md) groups (structural document operations) — and the\npipeline dispatches against those declarations. There are only three capability shapes\nbecause there are only three things a media engine ever does: change the format, change the\ncontent, or restructure the document. OCR is a convert (image to text). Transcription is a\nconvert (PCM to text). Decoding audio is a convert (container to PCM). Generating a blank\nfile is a convert (from [EMPTY\\_MIME](variables/EMPTY_MIME.md) — the source format happens to be nothing).\nResizing is a mutate. Inserting a worksheet row is an edit. A new capability is a new edge\nin the data, never a new contract.\n\nEngines are supplied to `createMediaPipeline` as a flat ordered array and resolved eagerly\nat construction (declarations drive verb narrowing, so they must be known up front).\nBundled engines stay cheap to resolve: their heavy peer dependencies load lazily inside\nthe capability methods, on first actual use.\n\nAll contracts are duck-typed: validation guards check structure, not class identity, so a\nconsumer can implement an interface from scratch or adapt an existing client. Contracts are\nenforced at runtime — construction validates every engine and every declared capability and\nthrows `E_INVALID_MEDIA_PIPELINE_CONFIG` naming the offending index when a value fails.\n\nTwo further contracts exist so that even \"run a binary\" and \"give a binary a file\" are\nmovable seams rather than Node assumptions:\n\n* [BinaryExecutor](interfaces/BinaryExecutor.md) — how an invocation runs. The bundled `execa_executor` wraps execa;\n a browser/remote/sandbox executor satisfies the same contract.\n* [ScratchWorkspace](interfaces/ScratchWorkspace.md) — bytes ⇄ executor-visible paths. A sibling of `ByteStore`, NOT a\n `ByteStore`: byte stores promise in-process readers, while binaries are foreign processes\n that need real paths. The bundled `fs_workspace` uses `node:fs/promises` via an async\n resolver; any implementation whose paths the chosen executor can see is valid — that\n compatibility is the consumer's composition decision.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [AsrConvertOptions](interfaces/AsrConvertOptions.md) | Options understood by transcription-flavored converts ([PCM\\_MIME](variables/PCM_MIME.md) → `txt`/`srt`/`vtt`/`json`). |\n| [BinaryExecResult](interfaces/BinaryExecResult.md) | The settled result of a [BinaryExecutor.exec](interfaces/BinaryExecutor.md#exec) call. |\n| [BinaryExecutor](interfaces/BinaryExecutor.md) | Runs a binary invocation to completion. How and where it runs — local child process, remote runner, sandbox, container, a browser-side WASI shim — is the implementation's business. |\n| [BinaryInvocation](interfaces/BinaryInvocation.md) | A single binary invocation handed to a [BinaryExecutor](interfaces/BinaryExecutor.md). |\n| [ConvertCapability](interfaces/ConvertCapability.md) | One uniform block of an engine's conversion matrix: every format token in `to` is producible from every input matching `from`. |\n| [ConvertOptions](interfaces/ConvertOptions.md) | The options bag carried by a [ConvertRequest](interfaces/ConvertRequest.md) — one typed, augmentable interface merging every documented convention. |\n| [ConvertOutput](interfaces/ConvertOutput.md) | One output of a convert — most converts yield exactly one; `images` yields many. |\n| [ConvertRequest](interfaces/ConvertRequest.md) | A format-changing request handed to a [ConvertCapability](interfaces/ConvertCapability.md). |\n| [ConvertResult](interfaces/ConvertResult.md) | The settled result of a convert. |\n| [EditCapability](interfaces/EditCapability.md) | A structural document-editing capability group: every op in `ops` is applicable to every input matching `over`. |\n| [EditRequest](interfaces/EditRequest.md) | A structural document operation handed to an [EditCapability](interfaces/EditCapability.md): one named op with its verb-table args, applied to in-memory bytes. Unlike the fused [MutateRequest](interfaces/MutateRequest.md) (which folds adjacent image transforms into one decode/encode), edits run one op per request — a worksheet splice is not a pixel pass and gains nothing from fusion. |\n| [EditResult](interfaces/EditResult.md) | The settled result of an edit: the restructured bytes plus optional change counts. |\n| [EditSummary](interfaces/EditSummary.md) | Counts an edit reports back for result summaries. |\n| [EngineBytesResult](interfaces/EngineBytesResult.md) | Common result shape for engines that transform bytes to bytes. |\n| [ImagesConvertOptions](interfaces/ImagesConvertOptions.md) | Options understood by embedded-image extraction converts (`application/pdf` → `images`). |\n| [MediaEngine](interfaces/MediaEngine.md) | A self-declaring media engine: an id for error messages plus the capabilities it provides. At least one capability entry is required. |\n| [MutateCapability](interfaces/MutateCapability.md) | A same-format content-transform capability group. |\n| [MutateRequest](interfaces/MutateRequest.md) | A same-format content transform handed to a [MutateCapability](interfaces/MutateCapability.md) — the fused image request: adjacent `image.*` steps fold into ONE request so a resize→rotate→format chain costs a single decode/encode. |\n| [OcrConvertOptions](interfaces/OcrConvertOptions.md) | Options understood by OCR-flavored converts (`image/*` → `txt`/`hocr`/`json`). |\n| [ScratchWorkspace](interfaces/ScratchWorkspace.md) | Bytes ⇄ executor-visible paths. The seam that lets binary-backed engines exchange files with the process (or remote runner) that executes them. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [EngineResolver](type-aliases/EngineResolver.md) | A value-or-resolver: the canonical way to supply an engine. Resolvers may be sync or async (dynamic import) and may resolve to the value directly or a `{ default: value }` module namespace. Engine resolvers run eagerly at pipeline construction — the engine module itself is cheap; heavy peer dependencies load lazily inside capability methods. |\n| [ImageAnnotation](type-aliases/ImageAnnotation.md) | A primitive rendered by the image annotation operation. |\n| [MimePattern](type-aliases/MimePattern.md) | An input-matching pattern: an exact MIME type (`application/pdf`), a family wildcard (`image/*`), or a virtual MIME such as [PCM\\_MIME](variables/PCM_MIME.md). |\n| [ScratchWorkspaceFactory](type-aliases/ScratchWorkspaceFactory.md) | A factory for per-execution scratch workspaces. Engines mint one workspace per invocation so concurrent executions never share a directory. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [EMPTY\\_MIME](variables/EMPTY_MIME.md) | The virtual source MIME type for media generation — the single seam through which new media comes into existence. An engine that can mint a blank/seed file declares `converts: [{ from: [EMPTY_MIME], to: [...] }]` and receives a [ConvertRequest](interfaces/ConvertRequest.md) with zero bytes; the format token in `to` names what gets created. |\n| [PCM\\_MIME](variables/PCM_MIME.md) | The virtual MIME type for decoded mono PCM audio — the intermediate between an audio container and a transcription. Bytes are little-endian Float32 samples in `[-1, 1]`; a [ConvertOutput](interfaces/ConvertOutput.md) carrying PCM must set `meta.sampleRate` (Hz). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [bytesToPcm](functions/bytesToPcm.md) | Read PCM samples back out of transport bytes. |\n| [implementsBinaryExecutor](functions/implementsBinaryExecutor.md) | `true` when `value` structurally implements [BinaryExecutor](interfaces/BinaryExecutor.md). |\n| [implementsConvertCapability](functions/implementsConvertCapability.md) | `true` when `value` structurally implements [ConvertCapability](interfaces/ConvertCapability.md). |\n| [implementsEditCapability](functions/implementsEditCapability.md) | `true` when `value` structurally implements [EditCapability](interfaces/EditCapability.md). |\n| [implementsMediaEngine](functions/implementsMediaEngine.md) | `true` when `value` structurally implements [MediaEngine](interfaces/MediaEngine.md): a string id plus at least one well-formed capability entry. Every declared entry must pass its capability guard. |\n| [implementsMutateCapability](functions/implementsMutateCapability.md) | `true` when `value` structurally implements [MutateCapability](interfaces/MutateCapability.md). |\n| [implementsScratchWorkspace](functions/implementsScratchWorkspace.md) | `true` when `value` structurally implements [ScratchWorkspace](interfaces/ScratchWorkspace.md). |\n| [pcmToBytes](functions/pcmToBytes.md) | Pack PCM samples into transport bytes for a [ConvertOutput](interfaces/ConvertOutput.md). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/bytesToPcm","title":"Function: bytesToPcm()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/bytesToPcm.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/bytesToPcm","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/bytesToPcm.md\n---\n\n# Function: bytesToPcm()\n\n```ts\nfunction bytesToPcm(bytes: Uint8Array): Float32Array;\n```\n\nDefined in: [src/batteries/media/contracts.ts:194](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L194)\n\nRead PCM samples back out of transport bytes.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------ | ------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | Little-endian Float32 bytes (as produced by [pcmToBytes](pcmToBytes.md)). |\n\n## Returns\n\n`Float32Array`\n\nThe mono PCM samples.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsBinaryExecutor","title":"Function: implementsBinaryExecutor()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsBinaryExecutor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsBinaryExecutor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/implementsBinaryExecutor.md\n---\n\n# Function: implementsBinaryExecutor()\n\n```ts\nfunction implementsBinaryExecutor(value: unknown): value is BinaryExecutor;\n```\n\nDefined in: [src/batteries/media/contracts.ts:479](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L479)\n\n`true` when `value` structurally implements [BinaryExecutor](../interfaces/BinaryExecutor.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is BinaryExecutor`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsConvertCapability","title":"Function: implementsConvertCapability()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsConvertCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsConvertCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/implementsConvertCapability.md\n---\n\n# Function: implementsConvertCapability()\n\n```ts\nfunction implementsConvertCapability(\n value: unknown,\n): value is ConvertCapability;\n```\n\nDefined in: [src/batteries/media/contracts.ts:487](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L487)\n\n`true` when `value` structurally implements [ConvertCapability](../interfaces/ConvertCapability.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is ConvertCapability`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsEditCapability","title":"Function: implementsEditCapability()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsEditCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsEditCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/implementsEditCapability.md\n---\n\n# Function: implementsEditCapability()\n\n```ts\nfunction implementsEditCapability(value: unknown): value is EditCapability;\n```\n\nDefined in: [src/batteries/media/contracts.ts:500](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L500)\n\n`true` when `value` structurally implements [EditCapability](../interfaces/EditCapability.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is EditCapability`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsMediaEngine","title":"Function: implementsMediaEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsMediaEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsMediaEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/implementsMediaEngine.md\n---\n\n# Function: implementsMediaEngine()\n\n```ts\nfunction implementsMediaEngine(value: unknown): value is MediaEngine;\n```\n\nDefined in: [src/batteries/media/contracts.ts:509](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L509)\n\n`true` when `value` structurally implements [MediaEngine](../interfaces/MediaEngine.md): a string id plus at least\none well-formed capability entry. Every declared entry must pass its capability guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is MediaEngine`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsMutateCapability","title":"Function: implementsMutateCapability()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsMutateCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsMutateCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/implementsMutateCapability.md\n---\n\n# Function: implementsMutateCapability()\n\n```ts\nfunction implementsMutateCapability(value: unknown): value is MutateCapability;\n```\n\nDefined in: [src/batteries/media/contracts.ts:493](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L493)\n\n`true` when `value` structurally implements [MutateCapability](../interfaces/MutateCapability.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is MutateCapability`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsScratchWorkspace","title":"Function: implementsScratchWorkspace()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsScratchWorkspace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/implementsScratchWorkspace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/implementsScratchWorkspace.md\n---\n\n# Function: implementsScratchWorkspace()\n\n```ts\nfunction implementsScratchWorkspace(value: unknown): value is ScratchWorkspace;\n```\n\nDefined in: [src/batteries/media/contracts.ts:483](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L483)\n\n`true` when `value` structurally implements [ScratchWorkspace](../interfaces/ScratchWorkspace.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is ScratchWorkspace`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/pcmToBytes","title":"Function: pcmToBytes()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/pcmToBytes.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/functions/pcmToBytes","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/functions/pcmToBytes.md\n---\n\n# Function: pcmToBytes()\n\n```ts\nfunction pcmToBytes(pcm: Float32Array): Uint8Array;\n```\n\nDefined in: [src/batteries/media/contracts.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L183)\n\nPack PCM samples into transport bytes for a [ConvertOutput](../interfaces/ConvertOutput.md).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------- | ------------------------------ |\n| `pcm` | `Float32Array` | Mono PCM samples in `[-1, 1]`. |\n\n## Returns\n\n`Uint8Array`\n\nThe samples as little-endian Float32 bytes.\n\n## Remarks\n\nA `Float32Array` view over arbitrary `Uint8Array` bytes requires 4-byte alignment, which\nsliced buffers do not guarantee — this helper (and [bytesToPcm](bytesToPcm.md)) copy-normalize so\nneither side has to think about alignment.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/AsrConvertOptions","title":"Interface: AsrConvertOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/AsrConvertOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/AsrConvertOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/AsrConvertOptions.md\ndescription: >-\n Options understood by transcription-flavored converts ([`PCM_MIME`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/variables/PCM_MIME) →\n `txt`/`srt`/`vtt`/`json`).\n---\n\n# Interface: AsrConvertOptions\n\nDefined in: [src/batteries/media/contracts.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L209)\n\nOptions understood by transcription-flavored converts ([PCM\\_MIME](../variables/PCM_MIME.md) → `txt`/`srt`/`vtt`/`json`).\n\n## Extended by\n\n* [`ConvertOptions`](ConvertOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | --------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `lang?` | `string` | Source-language hint (BCP-47-ish). | [src/batteries/media/contracts.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L211) |\n| `translate?` | `boolean` | Translate the transcription to English. | [src/batteries/media/contracts.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L213) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecResult","title":"Interface: BinaryExecResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecResult.md\ndescription: 'The settled result of a [`BinaryExecutor.exec`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecutor#exec) call.'\n---\n\n# Interface: BinaryExecResult\n\nDefined in: [src/batteries/media/contracts.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L79)\n\nThe settled result of a [BinaryExecutor.exec](BinaryExecutor.md#exec) call.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | --------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `exitCode` | `number` | The process exit code (or -1 when the process failed to start). | [src/batteries/media/contracts.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L81) |\n| `failed` | `boolean` | `true` when the invocation failed (non-zero exit, spawn failure, timeout, abort). | [src/batteries/media/contracts.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L87) |\n| `stderr` | `string` | Captured standard error. | [src/batteries/media/contracts.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L85) |\n| `stdout` | `string` | Captured standard output. | [src/batteries/media/contracts.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L83) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecutor","title":"Interface: BinaryExecutor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecutor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecutor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecutor.md\ndescription: >-\n Runs a binary invocation to completion. How and where it runs — local child\n process, remote runner, sandbox, container, a browser-side WASI shim — is the\n implementation's business.\n---\n\n# Interface: BinaryExecutor\n\nDefined in: [src/batteries/media/contracts.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L94)\n\nRuns a binary invocation to completion. How and where it runs — local child process, remote\nrunner, sandbox, container, a browser-side WASI shim — is the implementation's business.\n\n## Methods\n\n### exec()\n\n```ts\nexec(invocation: BinaryInvocation): Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L102)\n\nRun one invocation to completion and report the result. Implementations must not throw on\nnon-zero exits — report via `failed`/`exitCode` so callers map failures to readable errors.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------ | ----------------------------------------- | ------------------------------------- |\n| `invocation` | [`BinaryInvocation`](BinaryInvocation.md) | The command, args, and limits to run. |\n\n#### Returns\n\n`Promise`<[`BinaryExecResult`](BinaryExecResult.md)>\n\nThe settled result.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryInvocation","title":"Interface: BinaryInvocation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryInvocation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryInvocation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryInvocation.md\ndescription: 'A single binary invocation handed to a [`BinaryExecutor`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/BinaryExecutor).'\n---\n\n# Interface: BinaryInvocation\n\nDefined in: [src/batteries/media/contracts.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L67)\n\nA single binary invocation handed to a [BinaryExecutor](BinaryExecutor.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | `string`\\[] | Arguments, exec-style (no shell interpolation). | [src/batteries/media/contracts.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L71) |\n| `cmd` | `string` | The command to run (an absolute path or a name the executor can resolve). | [src/batteries/media/contracts.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L69) |\n| `signal?` | `AbortSignal` | Abort signal to cancel the invocation. | [src/batteries/media/contracts.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L75) |\n| `timeoutMs?` | `number` | Wall-clock timeout in milliseconds. | [src/batteries/media/contracts.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L73) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertCapability","title":"Interface: ConvertCapability","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertCapability.md\ndescription: >-\n One uniform block of an engine's conversion matrix: every format token in `to`\n is producible from every input matching `from`.\n---\n\n# Interface: ConvertCapability\n\nDefined in: [src/batteries/media/contracts.ts:291](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L291)\n\nOne uniform block of an engine's conversion matrix: every format token in `to` is\nproducible from every input matching `from`.\n\n## Remarks\n\nDeclarations are plain data — the registry reads them without calling engine code. An\ninput-dependent matrix (LibreOffice: docx→pdf yes, docx→xlsx no, ods→xlsx yes) is expressed\nas several capability groups, each a uniform from×to block.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `from` | readonly `string`\\[] | Input patterns this block accepts. | [src/batteries/media/contracts.ts:293](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L293) |\n| `to` | readonly `string`\\[] | Format tokens producible from every `from` member. | [src/batteries/media/contracts.ts:295](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L295) |\n\n## Methods\n\n### convert()\n\n```ts\nconvert(request: ConvertRequest): Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:302](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L302)\n\nPerform the conversion.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------- | ------------------------------------------- |\n| `request` | [`ConvertRequest`](ConvertRequest.md) | The input bytes, target token, and options. |\n\n#### Returns\n\n`Promise`<[`ConvertResult`](ConvertResult.md)>\n\nThe conversion outputs.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOptions","title":"Interface: ConvertOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOptions.md\ndescription: >-\n The options bag carried by a [`ConvertRequest`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertRequest) — one typed, augmentable\n interface merging every documented convention.\n---\n\n# Interface: ConvertOptions\n\nDefined in: [src/batteries/media/contracts.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L245)\n\nThe options bag carried by a [ConvertRequest](ConvertRequest.md) — one typed, augmentable interface\nmerging every documented convention.\n\n## Remarks\n\nConsumers add their own keys via declaration merging against this module:\n\n```ts\ndeclare module \"@nhtio/adk/batteries/media/contracts\" {\n interface ConvertOptions {\n watermark?: { text: string };\n }\n}\n```\n\nTypo'd keys become excess-property compile errors at literal call sites; the runtime stays\nopen — engines must ignore keys they don't understand (multi-hop conversion forwards one\nbag to every hop). The namespace is flat and globally merged, so BYO keys should be named\nto avoid collisions (prefix by engine where ambiguous).\n\n## Extends\n\n* [`OcrConvertOptions`](OcrConvertOptions.md).[`AsrConvertOptions`](AsrConvertOptions.md).[`ImagesConvertOptions`](ImagesConvertOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `augmentedWatermark?` | { `text`: `string`; } | - | - | [tests/unit/batteries/media/convert\\_options\\_augmentation.cross.spec.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/tests/unit/batteries/media/convert_options_augmentation.cross.spec.ts#L9) |\n| `augmentedWatermark.text` | `string` | - | - | [tests/unit/batteries/media/convert\\_options\\_augmentation.cross.spec.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/tests/unit/batteries/media/convert_options_augmentation.cross.spec.ts#L9) |\n| `format?` | `string` | Preferred output encoding token (`jpg`, `png`, …). An extractor that can emit it natively should; outputs in other encodings are re-encoded downstream by the requesting step. | [`ImagesConvertOptions`](ImagesConvertOptions.md).[`format`](ImagesConvertOptions.md#property-format) | [src/batteries/media/contracts.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L222) |\n| `lang?` | `string` | Source-language hint (BCP-47-ish). | [`AsrConvertOptions`](AsrConvertOptions.md).[`lang`](AsrConvertOptions.md#property-lang) | [src/batteries/media/contracts.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L211) |\n| `languages?` | readonly `string`\\[] | Recognition language hints (e.g. `['eng','deu']`). | [`OcrConvertOptions`](OcrConvertOptions.md).[`languages`](OcrConvertOptions.md#property-languages) | [src/batteries/media/contracts.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L205) |\n| `translate?` | `boolean` | Translate the transcription to English. | [`AsrConvertOptions`](AsrConvertOptions.md).[`translate`](AsrConvertOptions.md#property-translate) | [src/batteries/media/contracts.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L213) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOutput","title":"Interface: ConvertOutput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOutput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOutput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOutput.md\ndescription: >-\n One output of a convert — most converts yield exactly one; `images` yields\n many.\n---\n\n# Interface: ConvertOutput\n\nDefined in: [src/batteries/media/contracts.ts:267](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L267)\n\nOne output of a convert — most converts yield exactly one; `images` yields many.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The output bytes. | [src/batteries/media/contracts.ts:269](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L269) |\n| `meta?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Output metadata (e.g. `{ sampleRate: 44100 }` on [PCM\\_MIME](../variables/PCM_MIME.md) outputs). | [src/batteries/media/contracts.ts:273](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L273) |\n| `mimeType` | `string` | The output MIME type (honest — native encoding, no silent re-encode). | [src/batteries/media/contracts.ts:271](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L271) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertRequest","title":"Interface: ConvertRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertRequest.md\ndescription: 'A format-changing request handed to a [`ConvertCapability`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertCapability).'\n---\n\n# Interface: ConvertRequest\n\nDefined in: [src/batteries/media/contracts.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L251)\n\nA format-changing request handed to a [ConvertCapability](ConvertCapability.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The input content bytes. | [src/batteries/media/contracts.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L253) |\n| `filename` | `string` | The input filename (extension informs format sniffing). | [src/batteries/media/contracts.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L257) |\n| `mimeType` | `string` | The input MIME type. | [src/batteries/media/contracts.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L255) |\n| `options?` | [`ConvertOptions`](ConvertOptions.md) | Capability-specific options — see [ConvertOptions](ConvertOptions.md). | [src/batteries/media/contracts.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L261) |\n| `signal?` | `AbortSignal` | Abort signal threaded from the pipeline execution. | [src/batteries/media/contracts.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L263) |\n| `to` | `string` | The target format token (`pdf`, `docx`, `txt`, `pcm`, `images`, …). | [src/batteries/media/contracts.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L259) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertResult","title":"Interface: ConvertResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertResult.md\ndescription: The settled result of a convert.\n---\n\n# Interface: ConvertResult\n\nDefined in: [src/batteries/media/contracts.ts:277](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L277)\n\nThe settled result of a convert.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ---------------------------------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `outputs` | readonly [`ConvertOutput`](ConvertOutput.md)\\[] | The outputs, in source order. | [src/batteries/media/contracts.ts:279](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L279) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditCapability","title":"Interface: EditCapability","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/EditCapability.md\ndescription: >-\n A structural document-editing capability group: every op in `ops` is\n applicable to every input matching `over`.\n---\n\n# Interface: EditCapability\n\nDefined in: [src/batteries/media/contracts.ts:441](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L441)\n\nA structural document-editing capability group: every op in `ops` is applicable to every\ninput matching `over`.\n\n## Remarks\n\nTwo engines may declare the same ops over the same patterns with different fidelity — e.g.\nan ExcelJS-backed editor preserves styling while a SheetJS CE-backed one strips it. The\nregistry does not rank fidelity; supply order (or selection middleware) decides, which makes\nthe trade-off the consumer's visible composition decision.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `ops` | readonly `string`\\[] | Operation names supported (`sheet.update_cells`, `sheet.add_rows`, …). | [src/batteries/media/contracts.ts:445](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L445) |\n| `over` | readonly `string`\\[] | Input patterns this block edits. | [src/batteries/media/contracts.ts:443](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L443) |\n\n## Methods\n\n### edit()\n\n```ts\nedit(request: EditRequest): Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:452](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L452)\n\nApply one structural operation.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------- | -------------------------------------- |\n| `request` | [`EditRequest`](EditRequest.md) | The op, its args, and the input bytes. |\n\n#### Returns\n\n`Promise`<[`EditResult`](EditResult.md)>\n\nThe restructured bytes plus optional change counts.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditRequest","title":"Interface: EditRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/EditRequest.md\ndescription: >-\n A structural document operation handed to an [`EditCapability`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/EditCapability): one named\n op with its verb-table args, applied to in-memory bytes. Unlike the fused\n [`MutateRequest`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateRequest) (which folds adjacent image transforms into one\n decode/encode), edits run one op per request — a worksheet splice is not a\n pixel pass and gains nothing from fusion.\n---\n\n# Interface: EditRequest\n\nDefined in: [src/batteries/media/contracts.ts:400](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L400)\n\nA structural document operation handed to an [EditCapability](EditCapability.md): one named op with its\nverb-table args, applied to in-memory bytes. Unlike the fused [MutateRequest](MutateRequest.md) (which\nfolds adjacent image transforms into one decode/encode), edits run one op per request — a\nworksheet splice is not a pixel pass and gains nothing from fusion.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | The op's arguments, in the verb table's declared shapes. | [src/batteries/media/contracts.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L408) |\n| `bytes` | `Uint8Array` | The input bytes. | [src/batteries/media/contracts.ts:402](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L402) |\n| `mimeType` | `string` | The input MIME type. | [src/batteries/media/contracts.ts:404](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L404) |\n| `op` | `string` | The operation name, namespaced as in the verb table (`sheet.update_cells`, …). | [src/batteries/media/contracts.ts:406](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L406) |\n| `signal?` | `AbortSignal` | Abort signal threaded from the pipeline execution. | [src/batteries/media/contracts.ts:410](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L410) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditResult","title":"Interface: EditResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/EditResult.md\ndescription: >-\n The settled result of an edit: the restructured bytes plus optional change\n counts.\n---\n\n# Interface: EditResult\n\nDefined in: [src/batteries/media/contracts.ts:426](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L426)\n\nThe settled result of an edit: the restructured bytes plus optional change counts.\n\n## Extends\n\n* [`EngineBytesResult`](EngineBytesResult.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------- | ------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The output bytes. | [`EngineBytesResult`](EngineBytesResult.md).[`bytes`](EngineBytesResult.md#property-bytes) | [src/batteries/media/contracts.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L59) |\n| `mimeType` | `string` | The output MIME type. | [`EngineBytesResult`](EngineBytesResult.md).[`mimeType`](EngineBytesResult.md#property-mimetype) | [src/batteries/media/contracts.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L61) |\n| `summary?` | [`EditSummary`](EditSummary.md) | Change counts for result summaries. | - | [src/batteries/media/contracts.ts:428](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L428) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditSummary","title":"Interface: EditSummary","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditSummary.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EditSummary","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/EditSummary.md\ndescription: Counts an edit reports back for result summaries.\n---\n\n# Interface: EditSummary\n\nDefined in: [src/batteries/media/contracts.ts:414](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L414)\n\nCounts an edit reports back for result summaries.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ---------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `added?` | `number` | Items added (rows, columns, sheets…). | [src/batteries/media/contracts.ts:416](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L416) |\n| `modified?` | `number` | Items modified. | [src/batteries/media/contracts.ts:420](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L420) |\n| `removed?` | `number` | Items removed. | [src/batteries/media/contracts.ts:418](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L418) |\n| `warnings?` | `string`\\[] | Non-fatal notes surfaced to the model. | [src/batteries/media/contracts.ts:422](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L422) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EngineBytesResult","title":"Interface: EngineBytesResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EngineBytesResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/EngineBytesResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/EngineBytesResult.md\ndescription: Common result shape for engines that transform bytes to bytes.\n---\n\n# Interface: EngineBytesResult\n\nDefined in: [src/batteries/media/contracts.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L57)\n\nCommon result shape for engines that transform bytes to bytes.\n\n## Extended by\n\n* [`EditResult`](EditResult.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The output bytes. | [src/batteries/media/contracts.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L59) |\n| `mimeType` | `string` | The output MIME type. | [src/batteries/media/contracts.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L61) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ImagesConvertOptions","title":"Interface: ImagesConvertOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ImagesConvertOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ImagesConvertOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ImagesConvertOptions.md\ndescription: >-\n Options understood by embedded-image extraction converts (`application/pdf` →\n `images`).\n---\n\n# Interface: ImagesConvertOptions\n\nDefined in: [src/batteries/media/contracts.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L217)\n\nOptions understood by embedded-image extraction converts (`application/pdf` → `images`).\n\n## Extended by\n\n* [`ConvertOptions`](ConvertOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `format?` | `string` | Preferred output encoding token (`jpg`, `png`, …). An extractor that can emit it natively should; outputs in other encodings are re-encoded downstream by the requesting step. | [src/batteries/media/contracts.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L222) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine","title":"Interface: MediaEngine","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/MediaEngine.md\ndescription: >-\n A self-declaring media engine: an id for error messages plus the capabilities\n it provides. At least one capability entry is required.\n---\n\n# Interface: MediaEngine\n\nDefined in: [src/batteries/media/contracts.ts:459](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L459)\n\nA self-declaring media engine: an id for error messages plus the capabilities it provides.\nAt least one capability entry is required.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------ | ---------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `converts?` | `readonly` | readonly [`ConvertCapability`](ConvertCapability.md)\\[] | Format-changing capability groups. | [src/batteries/media/contracts.ts:463](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L463) |\n| `edits?` | `readonly` | readonly [`EditCapability`](EditCapability.md)\\[] | Structural document-editing capability groups. | [src/batteries/media/contracts.ts:467](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L467) |\n| `id` | `readonly` | `string` | Stable identifier used in config and dispatch error messages (`jimp`, `soffice`, …). | [src/batteries/media/contracts.ts:461](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L461) |\n| `mutates?` | `readonly` | readonly [`MutateCapability`](MutateCapability.md)\\[] | Same-format content-transform capability groups. | [src/batteries/media/contracts.ts:465](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L465) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateCapability","title":"Interface: MutateCapability","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateCapability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateCapability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateCapability.md\ndescription: A same-format content-transform capability group.\n---\n\n# Interface: MutateCapability\n\nDefined in: [src/batteries/media/contracts.ts:378](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L378)\n\nA same-format content-transform capability group.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `encodes` | readonly `string`\\[] | Format tokens reachable via `request.format` in the same fused call. | [src/batteries/media/contracts.ts:384](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L384) |\n| `ops` | readonly `string`\\[] | Content operations supported (`resize`, `rotate`, `flip`, `strip_metadata`, `annotate`). | [src/batteries/media/contracts.ts:382](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L382) |\n| `over` | readonly `string`\\[] | Input patterns this block mutates. | [src/batteries/media/contracts.ts:380](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L380) |\n\n## Methods\n\n### mutate()\n\n```ts\nmutate(request: MutateRequest): Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:391](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L391)\n\nApply the fused transform.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------- | -------------------------------------- |\n| `request` | [`MutateRequest`](MutateRequest.md) | The folded operations and input bytes. |\n\n#### Returns\n\n`Promise`<[`EngineBytesResult`](EngineBytesResult.md)>\n\nThe transformed bytes.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateRequest","title":"Interface: MutateRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateRequest.md\ndescription: >-\n A same-format content transform handed to a [`MutateCapability`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/MutateCapability) — the\n fused image request: adjacent `image.*` steps fold into ONE request so a\n resize→rotate→format chain costs a single decode/encode.\n---\n\n# Interface: MutateRequest\n\nDefined in: [src/batteries/media/contracts.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L310)\n\nA same-format content transform handed to a [MutateCapability](MutateCapability.md) — the fused image\nrequest: adjacent `image.*` steps fold into ONE request so a resize→rotate→format chain\ncosts a single decode/encode.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `annotate?` | readonly [`ImageAnnotation`](../type-aliases/ImageAnnotation.md)\\[] | Vector annotation primitives, rendered over the image. | [src/batteries/media/contracts.ts:328](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L328) |\n| `bytes` | `Uint8Array` | The input bytes. | [src/batteries/media/contracts.ts:312](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L312) |\n| `flip?` | { `horizontal?`: `boolean`; `vertical?`: `boolean`; } | Flip axes. | [src/batteries/media/contracts.ts:324](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L324) |\n| `flip.horizontal?` | `boolean` | - | [src/batteries/media/contracts.ts:324](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L324) |\n| `flip.vertical?` | `boolean` | - | [src/batteries/media/contracts.ts:324](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L324) |\n| `format?` | { `quality?`: `number`; `to`: `string`; } | Re-encode target, when requested (rides the same fused call). | [src/batteries/media/contracts.ts:330](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L330) |\n| `format.quality?` | `number` | - | [src/batteries/media/contracts.ts:330](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L330) |\n| `format.to` | `string` | - | [src/batteries/media/contracts.ts:330](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L330) |\n| `mimeType` | `string` | The input MIME type. | [src/batteries/media/contracts.ts:314](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L314) |\n| `resize?` | { `fit?`: `\"fill\"` | `\"cover\"` | `\"contain\"` | `\"inside\"` | `\"outside\"`; `height?`: `number`; `width?`: `number`; } | Resize, when requested. | [src/batteries/media/contracts.ts:316](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L316) |\n| `resize.fit?` | `\"fill\"` | `\"cover\"` | `\"contain\"` | `\"inside\"` | `\"outside\"` | - | [src/batteries/media/contracts.ts:319](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L319) |\n| `resize.height?` | `number` | - | [src/batteries/media/contracts.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L318) |\n| `resize.width?` | `number` | - | [src/batteries/media/contracts.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L317) |\n| `rotate?` | `90` | `180` | `270` | Clockwise rotation in degrees. | [src/batteries/media/contracts.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L322) |\n| `signal?` | `AbortSignal` | Abort signal threaded from the pipeline execution. | [src/batteries/media/contracts.ts:332](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L332) |\n| `stripMetadata?` | `boolean` | Remove EXIF/ICC metadata. | [src/batteries/media/contracts.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L326) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/OcrConvertOptions","title":"Interface: OcrConvertOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/OcrConvertOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/OcrConvertOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/OcrConvertOptions.md\ndescription: Options understood by OCR-flavored converts (`image/*` → `txt`/`hocr`/`json`).\n---\n\n# Interface: OcrConvertOptions\n\nDefined in: [src/batteries/media/contracts.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L203)\n\nOptions understood by OCR-flavored converts (`image/*` → `txt`/`hocr`/`json`).\n\n## Extended by\n\n* [`ConvertOptions`](ConvertOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `languages?` | readonly `string`\\[] | Recognition language hints (e.g. `['eng','deu']`). | [src/batteries/media/contracts.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L205) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ScratchWorkspace","title":"Interface: ScratchWorkspace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ScratchWorkspace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/interfaces/ScratchWorkspace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ScratchWorkspace.md\ndescription: >-\n Bytes ⇄ executor-visible paths. The seam that lets binary-backed engines\n exchange files with the process (or remote runner) that executes them.\n---\n\n# Interface: ScratchWorkspace\n\nDefined in: [src/batteries/media/contracts.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L109)\n\nBytes ⇄ executor-visible paths. The seam that lets binary-backed engines exchange files\nwith the process (or remote runner) that executes them.\n\n## Methods\n\n### dir()\n\n```ts\ndir(): string;\n```\n\nDefined in: [src/batteries/media/contracts.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L127)\n\nThe workspace root directory, for `--outdir`-style binary arguments.\n\n#### Returns\n\n`string`\n\n***\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L131)\n\nRemove the workspace and everything in it. Engines call this in `finally`.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### list()\n\n```ts\nlist(): Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L129)\n\nList the files currently in the workspace root (basenames).\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\n***\n\n### materialize()\n\n```ts\nmaterialize(bytes: Uint8Array, filename: string): Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L118)\n\nWrite `bytes` into the workspace under `filename` and return the absolute path the\npaired executor can open.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ---------- | ------------ | -------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The content to materialize. |\n| `filename` | `string` | The basename to use (extension matters to format-sniffing binaries). |\n\n#### Returns\n\n`Promise`<`string`>\n\nThe absolute path.\n\n***\n\n### read()\n\n```ts\nread(path: string): Promise>;\n```\n\nDefined in: [src/batteries/media/contracts.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L125)\n\nRead a file the executor produced inside the workspace.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | -------------------------- |\n| `path` | `string` | The absolute path to read. |\n\n#### Returns\n\n`Promise`<`Uint8Array`<`ArrayBufferLike`>>\n\nThe file bytes.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/EngineResolver","title":"Type Alias: EngineResolver\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/EngineResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/EngineResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/type-aliases/EngineResolver.md\ndescription: >-\n A value-or-resolver: the canonical way to supply an engine. Resolvers may be\n sync or async (dynamic import) and may resolve to the value directly or a `{\n default: value }` module namespace. Engine resolvers run eagerly at pipeline\n construction — the engine module itself is cheap; heavy peer dependencies load\n lazily inside capability methods.\n---\n\n# Type Alias: EngineResolver\\\n\n```ts\ntype EngineResolver =\n | T\n | (() =>\n | T\n | {\n default: T;\n }\n | Promise<\n | T\n | {\n default: T;\n }\n >);\n```\n\nDefined in: [src/batteries/media/contracts.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L52)\n\nA value-or-resolver: the canonical way to supply an engine. Resolvers may be sync or async\n(dynamic import) and may resolve to the value directly or a `{ default: value }` module\nnamespace. Engine resolvers run eagerly at pipeline construction — the engine module itself\nis cheap; heavy peer dependencies load lazily inside capability methods.\n\n## Type Parameters\n\n| Type Parameter | Default type |\n| -------------- | --------------------------------------------- |\n| `T` | [`MediaEngine`](../interfaces/MediaEngine.md) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/ImageAnnotation","title":"Type Alias: ImageAnnotation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/ImageAnnotation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/ImageAnnotation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/type-aliases/ImageAnnotation.md\ndescription: A primitive rendered by the image annotation operation.\n---\n\n# Type Alias: ImageAnnotation\n\n```ts\ntype ImageAnnotation =\n | {\n color?: string;\n fill?: string;\n height: number;\n strokeWidth?: number;\n type: \"rect\";\n width: number;\n x: number;\n y: number;\n }\n | {\n color?: string;\n strokeWidth?: number;\n type: \"line\" | \"arrow\";\n x1: number;\n x2: number;\n y1: number;\n y2: number;\n }\n | {\n color?: string;\n cx: number;\n cy: number;\n fill?: string;\n rx: number;\n ry: number;\n strokeWidth?: number;\n type: \"ellipse\";\n }\n | {\n color?: string;\n font?: string;\n size?: number;\n text: string;\n type: \"text\";\n x: number;\n y: number;\n };\n```\n\nDefined in: [src/batteries/media/contracts.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L337)\n\nA primitive rendered by the image annotation operation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/MimePattern","title":"Type Alias: MimePattern","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/MimePattern.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/MimePattern","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/type-aliases/MimePattern.md\ndescription: >-\n An input-matching pattern: an exact MIME type (`application/pdf`), a family\n wildcard (`image/*`), or a virtual MIME such as [`PCM_MIME`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/variables/PCM_MIME).\n---\n\n# Type Alias: MimePattern\n\n```ts\ntype MimePattern = string;\n```\n\nDefined in: [src/batteries/media/contracts.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L146)\n\nAn input-matching pattern: an exact MIME type (`application/pdf`), a family wildcard\n(`image/*`), or a virtual MIME such as [PCM\\_MIME](../variables/PCM_MIME.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/ScratchWorkspaceFactory","title":"Type Alias: ScratchWorkspaceFactory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/ScratchWorkspaceFactory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/type-aliases/ScratchWorkspaceFactory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/type-aliases/ScratchWorkspaceFactory.md\ndescription: >-\n A factory for per-execution scratch workspaces. Engines mint one workspace per\n invocation so concurrent executions never share a directory.\n---\n\n# Type Alias: ScratchWorkspaceFactory\n\n```ts\ntype ScratchWorkspaceFactory = () =>\n | ScratchWorkspace\n | Promise;\n```\n\nDefined in: [src/batteries/media/contracts.ts:138](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L138)\n\nA factory for per-execution scratch workspaces. Engines mint one workspace per invocation\nso concurrent executions never share a directory.\n\n## Returns\n\n| [`ScratchWorkspace`](../interfaces/ScratchWorkspace.md)\n| `Promise`<[`ScratchWorkspace`](../interfaces/ScratchWorkspace.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/variables/EMPTY_MIME","title":"Variable: EMPTY\\_MIME","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/variables/EMPTY_MIME.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/variables/EMPTY_MIME","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/variables/EMPTY_MIME.md\ndescription: >-\n The virtual source MIME type for media generation — the single seam through\n which new media comes into existence. An engine that can mint a blank/seed\n file declares `converts: [{ from: [EMPTY_MIME], to: [...] }]` and receives a\n [`ConvertRequest`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertRequest) with zero bytes; the format token in `to` names what\n gets created.\n---\n\n# Variable: EMPTY\\_MIME\n\n```ts\nconst EMPTY_MIME: \"application/x-adk-empty\" = \"application/x-adk-empty\";\n```\n\nDefined in: [src/batteries/media/contracts.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L170)\n\nThe virtual source MIME type for media generation — the single seam through which new media\ncomes into existence. An engine that can mint a blank/seed file declares\n`converts: [{ from: [EMPTY_MIME], to: [...] }]` and receives a [ConvertRequest](../interfaces/ConvertRequest.md) with\nzero bytes; the format token in `to` names what gets created.\n\n## Remarks\n\nGenerating an .xlsx, a blank canvas, or a second of silence IS media generation — it is\n*deterministic* generation (same inputs, same bytes). *Model-based semantic* generation\n(diffusion, TTS) is the same edge with different machinery: a BYO engine declares\n`from: [EMPTY_MIME]` and consumes a prompt from `request.options`. Both kinds ride one\ndeclaration shape, which is exactly why this is a MIME and not a special API. `EMPTY_MIME`\ncan never become a conversion intermediate: no engine declares `to: 'empty'`, so the\npathfinder only ever sees it as a source.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/variables/PCM_MIME","title":"Variable: PCM\\_MIME","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/variables/PCM_MIME.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/contracts/variables/PCM_MIME","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/variables/PCM_MIME.md\ndescription: >-\n The virtual MIME type for decoded mono PCM audio — the intermediate between an\n audio container and a transcription. Bytes are little-endian Float32 samples\n in `[-1, 1]`; a [`ConvertOutput`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOutput) carrying PCM must set `meta.sampleRate`\n (Hz).\n---\n\n# Variable: PCM\\_MIME\n\n```ts\nconst PCM_MIME: \"audio/x-adk-pcm\" = \"audio/x-adk-pcm\";\n```\n\nDefined in: [src/batteries/media/contracts.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/contracts.ts#L153)\n\nThe virtual MIME type for decoded mono PCM audio — the intermediate between an audio\ncontainer and a transcription. Bytes are little-endian Float32 samples in `[-1, 1]`;\na [ConvertOutput](../interfaces/ConvertOutput.md) carrying PCM must set `meta.sampleRate` (Hz).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode","title":"@nhtio/adk/batteries/media/engines/audio\\_decode","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/audio_decode.md'\ndescription: >-\n A cross-environment audio-decoding {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine} backed by the `audio-decode`\n package (pure JS/WASM codecs — no ffmpeg, no native bindings; works in Node\n and browsers).\n---\n\n# @nhtio/adk/batteries/media/engines/audio\\_decode\n\nA cross-environment audio-decoding [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md)\nbacked by the `audio-decode` package (pure JS/WASM codecs — no ffmpeg, no native bindings;\nworks in Node and browsers).\n\n## Remarks\n\nDeclares two convert capabilities: audio containers to the virtual `pcm` token (mp3 /\nm4a-aac / ogg-vorbis / opus / flac / wav), downmixed to mono; and a generation edge —\n`EMPTY_MIME` → wav. Audio bytes are just bytes in a documented envelope: the generated\nseed is a canonical 44-byte RIFF/WAVE header plus one second of 16-bit mono silence at\n44100 Hz, written by a dependency-free helper (generation never loads the decode peer).\nThe PCM output reports the SOURCE sample rate in `meta.sampleRate` — the pipeline's\ntranscribe step resamples to the 16 kHz transcription engines expect. For exotic\ncontainers, compose an ffmpeg-backed engine instead; the capability declaration is the\nseam.\n\n`audio-decode` is an optional peer dependency, lazily imported on first actual use.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [AudioBufferLike](interfaces/AudioBufferLike.md) | The decoded shapes audio-decode resolves to. Some codecs return an AudioBuffer-compatible object (`numberOfChannels` + `getChannelData`); others (e.g. the wav path in Node) return a plain `{ channelData: Float32Array[], sampleRate }` record. The engine normalizes both. |\n| [AudioDecodeEngineOptions](interfaces/AudioDecodeEngineOptions.md) | Options for [audioDecodeEngine](functions/audioDecodeEngine.md). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------- | ------------------------------------------------------------- |\n| [AudioDecodeFn](type-aliases/AudioDecodeFn.md) | The decode function shape the `audio-decode` package exports. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------- | ----------------------------------------- |\n| [audioDecodeEngine](functions/audioDecodeEngine.md) | Construct the audio-decode-backed engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/functions/audioDecodeEngine","title":"Function: audioDecodeEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/functions/audioDecodeEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/functions/audioDecodeEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/audio_decode/functions/audioDecodeEngine.md\n---\n\n# Function: audioDecodeEngine()\n\n```ts\nfunction audioDecodeEngine(options?: AudioDecodeEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/audio\\_decode.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L101)\n\nConstruct the audio-decode-backed engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------- | ---------------------------------- |\n| `options` | [`AudioDecodeEngineOptions`](../interfaces/AudioDecodeEngineOptions.md) | Optional module resolver override. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioBufferLike","title":"Interface: AudioBufferLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioBufferLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioBufferLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioBufferLike.md\ndescription: >-\n The decoded shapes audio-decode resolves to. Some codecs return an\n AudioBuffer-compatible object (`numberOfChannels` + `getChannelData`); others\n (e.g. the wav path in Node) return a plain `{ channelData: Float32Array[],\n sampleRate }` record. The engine normalizes both.\n---\n\n# Interface: AudioBufferLike\n\nDefined in: [src/batteries/media/engines/audio\\_decode.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L33)\n\nThe decoded shapes audio-decode resolves to. Some codecs return an AudioBuffer-compatible\nobject (`numberOfChannels` + `getChannelData`); others (e.g. the wav path in Node) return a\nplain `{ channelData: Float32Array[], sampleRate }` record. The engine normalizes both.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `channelData?` | `Float32Array`<`ArrayBufferLike`>\\[] | Raw per-channel sample arrays on the plain-record shape. | [src/batteries/media/engines/audio\\_decode.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L41) |\n| `numberOfChannels?` | `number` | Channel count when the AudioBuffer-compatible shape is returned. | [src/batteries/media/engines/audio\\_decode.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L35) |\n| `sampleRate` | `number` | Sample rate of the decoded audio, in Hz. Present on both shapes. | [src/batteries/media/engines/audio\\_decode.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L37) |\n\n## Methods\n\n### getChannelData()?\n\n```ts\noptional getChannelData(channel: number): Float32Array;\n```\n\nDefined in: [src/batteries/media/engines/audio\\_decode.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L39)\n\nPer-channel sample accessor on the AudioBuffer-compatible shape.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `channel` | `number` |\n\n#### Returns\n\n`Float32Array`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioDecodeEngineOptions","title":"Interface: AudioDecodeEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioDecodeEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioDecodeEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/audio_decode/interfaces/AudioDecodeEngineOptions.md\ndescription: 'Options for [`audioDecodeEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/audio_decode/functions/audioDecodeEngine).'\n---\n\n# Interface: AudioDecodeEngineOptions\n\nDefined in: [src/batteries/media/engines/audio\\_decode.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L87)\n\nOptions for [audioDecodeEngine](../functions/audioDecodeEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `audioDecode?` | () => | [`AudioDecodeFn`](../type-aliases/AudioDecodeFn.md) | { `default`: [`AudioDecodeFn`](../type-aliases/AudioDecodeFn.md); } | `Promise`< | [`AudioDecodeFn`](../type-aliases/AudioDecodeFn.md) | { `default`: [`AudioDecodeFn`](../type-aliases/AudioDecodeFn.md); }> | Override the module resolution. Default: `import('audio-decode')`. | [src/batteries/media/engines/audio\\_decode.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L89) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/type-aliases/AudioDecodeFn","title":"Type Alias: AudioDecodeFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/type-aliases/AudioDecodeFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/audio_decode/type-aliases/AudioDecodeFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/audio_decode/type-aliases/AudioDecodeFn.md\ndescription: The decode function shape the `audio-decode` package exports.\n---\n\n# Type Alias: AudioDecodeFn\n\n```ts\ntype AudioDecodeFn = (\n bytes: Uint8Array | ArrayBuffer,\n) => Promise;\n```\n\nDefined in: [src/batteries/media/engines/audio\\_decode.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/audio_decode.ts#L45)\n\nThe decode function shape the `audio-decode` package exports.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------- |\n| `bytes` | `Uint8Array` | `ArrayBuffer` |\n\n## Returns\n\n`Promise`<[`AudioBufferLike`](../interfaces/AudioBufferLike.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data","title":"@nhtio/adk/batteries/media/engines/data","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/data.md'\ndescription: >-\n The deterministic text/data {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine}: seeds and conversions for\n the text-shaped family (txt/md/json/yaml/csv/html).\n---\n\n# @nhtio/adk/batteries/media/engines/data\n\nThe deterministic text/data [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md):\nseeds and conversions for the text-shaped family (txt/md/json/yaml/csv/html).\n\n## Remarks\n\nThe smallest engine in the fleet, and deliberately so: text-family media generation is a\nliteral (`''`, `'{}'`, a minimal HTML shell) and text-family conversion is a parse and a\nre-serialize. Everything here is deterministic — same inputs, same bytes — and cross-env\n(no `node:*` anywhere).\n\nCapabilities:\n\n* **generate**: `EMPTY_MIME` → txt, md, json, yaml, csv, html.\n* **convert**: json ⇄ yaml (js-yaml), json ⇄ csv (papaparse), json → txt (pretty print).\n\n`papaparse` is an optional peer (lazily imported only for the csv edges); `js-yaml` is a\nregular dependency of the library.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------- | -------------------------------------------------- |\n| [DataEngineOptions](interfaces/DataEngineOptions.md) | Options for [dataEngine](functions/dataEngine.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------- | --------------------------------------------- |\n| [dataEngine](functions/dataEngine.md) | Construct the deterministic text/data engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data/functions/dataEngine","title":"Function: dataEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data/functions/dataEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data/functions/dataEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/data/functions/dataEngine.md\n---\n\n# Function: dataEngine()\n\n```ts\nfunction dataEngine(options?: DataEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/data.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/data.ts#L60)\n\nConstruct the deterministic text/data engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------- | ---------------------------------- |\n| `options` | [`DataEngineOptions`](../interfaces/DataEngineOptions.md) | Optional module resolver override. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data/interfaces/DataEngineOptions","title":"Interface: DataEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data/interfaces/DataEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/data/interfaces/DataEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/data/interfaces/DataEngineOptions.md\ndescription: 'Options for [`dataEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/data/functions/dataEngine).'\n---\n\n# Interface: DataEngineOptions\n\nDefined in: [src/batteries/media/engines/data.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/data.ts#L32)\n\nOptions for [dataEngine](../functions/dataEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `papaparse?` | () => `__module` | `Promise`<`__module`> | Override the papaparse resolution (tests / custom builds). Default: `import('papaparse')`. | [src/batteries/media/engines/data.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/data.ts#L34) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs","title":"@nhtio/adk/batteries/media/engines/exceljs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/exceljs.md'\ndescription: >-\n The ExcelJS-backed workbook {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine}: the fidelity-preserving\n structural editor for xlsx, plus in-process blank-workbook generation.\n---\n\n# @nhtio/adk/batteries/media/engines/exceljs\n\nThe ExcelJS-backed workbook [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md): the\nfidelity-preserving structural editor for xlsx, plus in-process blank-workbook generation.\n\n## Remarks\n\nExcelJS models the parts of a workbook that matter to humans — fonts, fills, comments,\nmerged ranges, data validations — and carries them through a read→edit→write cycle intact.\nThat is this engine's whole reason to exist: the `sheet.*` verbs mutate workbooks users\nhand us, and an edit that strips the user's formatting as a side effect is corruption with\ngood intentions. Compose this engine FIRST in the engines array when fidelity matters; the\nsheetjs engine edits a far wider read matrix (ODS, XLS, NUMBERS, …) but SheetJS Community\nEdition strips styling in the process.\n\nCapabilities:\n\n* **generate**: `EMPTY_MIME` → xlsx (a blank workbook with one `Sheet1` — every sheet step\n expects at least one worksheet).\n* **edit**: the ten `sheet.*` structural ops over xlsx, styling preserved.\n\n`exceljs` is an optional peer dependency, lazily imported on first actual use. Cross-env by\nconstruction: no `node:*` imports, `Uint8Array` in and out (ExcelJS ships a browser build\nvia its `browser` field).\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | -------------------------------------------------------- |\n| [ExceljsEngineOptions](interfaces/ExceljsEngineOptions.md) | Options for [exceljsEngine](functions/exceljsEngine.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------- | --------------------------------------------- |\n| [exceljsEngine](functions/exceljsEngine.md) | Construct the ExcelJS-backed workbook engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs/functions/exceljsEngine","title":"Function: exceljsEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs/functions/exceljsEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs/functions/exceljsEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/exceljs/functions/exceljsEngine.md\n---\n\n# Function: exceljsEngine()\n\n```ts\nfunction exceljsEngine(options?: ExceljsEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/exceljs.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/exceljs.ts#L69)\n\nConstruct the ExcelJS-backed workbook engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------- | ---------------------------------- |\n| `options` | [`ExceljsEngineOptions`](../interfaces/ExceljsEngineOptions.md) | Optional module resolver override. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs/interfaces/ExceljsEngineOptions","title":"Interface: ExceljsEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs/interfaces/ExceljsEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/exceljs/interfaces/ExceljsEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/exceljs/interfaces/ExceljsEngineOptions.md\ndescription: 'Options for [`exceljsEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/exceljs/functions/exceljsEngine).'\n---\n\n# Interface: ExceljsEngineOptions\n\nDefined in: [src/batteries/media/engines/exceljs.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/exceljs.ts#L44)\n\nOptions for [exceljsEngine](../functions/exceljsEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `exceljs?` | () => `__module` | `Promise`<`__module`> | Override the module resolution (tests / custom builds). Default: `import('exceljs')`. | [src/batteries/media/engines/exceljs.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/exceljs.ts#L46) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor","title":"@nhtio/adk/batteries/media/engines/execa\\_executor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/execa_executor.md'\ndescription: >-\n A {@link @nhtio/adk/batteries/media/contracts!BinaryExecutor} implementation\n that runs invocations as local child processes via execa.\n---\n\n# @nhtio/adk/batteries/media/engines/execa\\_executor\n\nA [@nhtio/adk/batteries/media/contracts!BinaryExecutor](../../contracts/interfaces/BinaryExecutor.md) implementation that runs\ninvocations as local child processes via execa.\n\n## Remarks\n\nThe bundled local-process executor. `execa` is an optional peer dependency acquired through\nan async resolver (default: a lazy dynamic import) — importing this module pulls nothing;\nconstructing the executor is what resolves the peer, and only on first `exec`.\n\nProcess execution is a movable seam: anything implementing the `BinaryExecutor` contract —\na remote runner, a sandbox, a container shim — composes into binary engines exactly like\nthis one. The paired `ScratchWorkspace` must produce paths this executor can open; for the\nlocal-process case, the bundled `fs_workspace` is the natural pair.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------------------- |\n| [ExecaExecutorOptions](interfaces/ExecaExecutorOptions.md) | Options for [execaExecutor](functions/execaExecutor.md). |\n| [ExecaLike](interfaces/ExecaLike.md) | The slice of execa this executor uses (kept minimal for BYO substitution in tests). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------- | --------------------------------------------- |\n| [ExecaResolver](type-aliases/ExecaResolver.md) | Resolver forms accepted for the execa module. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------- | --------------------------------------------------------------------------------------------------- |\n| [execaExecutor](functions/execaExecutor.md) | Construct the bundled local-process [BinaryExecutor](../../contracts/interfaces/BinaryExecutor.md). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/functions/execaExecutor","title":"Function: execaExecutor()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/functions/execaExecutor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/functions/execaExecutor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/execa_executor/functions/execaExecutor.md\n---\n\n# Function: execaExecutor()\n\n```ts\nfunction execaExecutor(options?: ExecaExecutorOptions): BinaryExecutor;\n```\n\nDefined in: [src/batteries/media/engines/execa\\_executor.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/execa_executor.ts#L84)\n\nConstruct the bundled local-process [BinaryExecutor](../../../contracts/interfaces/BinaryExecutor.md).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------- | -------------------------------- |\n| `options` | [`ExecaExecutorOptions`](../interfaces/ExecaExecutorOptions.md) | The execa resolver and defaults. |\n\n## Returns\n\n[`BinaryExecutor`](../../../contracts/interfaces/BinaryExecutor.md)\n\nA `BinaryExecutor` running invocations as local child processes.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaExecutorOptions","title":"Interface: ExecaExecutorOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaExecutorOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaExecutorOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaExecutorOptions.md\ndescription: 'Options for [`execaExecutor`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/execa_executor/functions/execaExecutor).'\n---\n\n# Interface: ExecaExecutorOptions\n\nDefined in: [src/batteries/media/engines/execa\\_executor.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/execa_executor.ts#L47)\n\nOptions for [execaExecutor](../functions/execaExecutor.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `defaultTimeoutMs?` | `number` | Default timeout applied when an invocation does not specify one. | [src/batteries/media/engines/execa\\_executor.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/execa_executor.ts#L54) |\n| `execa?` | [`ExecaResolver`](../type-aliases/ExecaResolver.md) | The execa function or an async resolver for it. Defaults to a lazy dynamic import of the `execa` package (optional peer). | [src/batteries/media/engines/execa\\_executor.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/execa_executor.ts#L52) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaLike","title":"Interface: ExecaLike()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/execa_executor/interfaces/ExecaLike.md\ndescription: >-\n The slice of execa this executor uses (kept minimal for BYO substitution in\n tests).\n---\n\n# Interface: ExecaLike()\n\nDefined in: [src/batteries/media/engines/execa\\_executor.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/execa_executor.ts#L23)\n\nThe slice of execa this executor uses (kept minimal for BYO substitution in tests).\n\n```ts\nExecaLike(\n cmd: string,\n args: readonly string[],\n options: {\n cancelSignal?: AbortSignal;\n reject: false;\n stripFinalNewline?: boolean;\n timeout?: number;\n}): Promise<{\n exitCode?: number;\n failed: boolean;\n stderr?: unknown;\n stdout?: unknown;\n}>;\n```\n\nDefined in: [src/batteries/media/engines/execa\\_executor.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/execa_executor.ts#L24)\n\nThe slice of execa this executor uses (kept minimal for BYO substitution in tests).\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| `cmd` | `string` |\n| `args` | readonly `string`\\[] |\n| `options` | { `cancelSignal?`: `AbortSignal`; `reject`: `false`; `stripFinalNewline?`: `boolean`; `timeout?`: `number`; } |\n| `options.cancelSignal?` | `AbortSignal` |\n| `options.reject` | `false` |\n| `options.stripFinalNewline?` | `boolean` |\n| `options.timeout?` | `number` |\n\n## Returns\n\n`Promise`<{\n`exitCode?`: `number`;\n`failed`: `boolean`;\n`stderr?`: `unknown`;\n`stdout?`: `unknown`;\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/type-aliases/ExecaResolver","title":"Type Alias: ExecaResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/type-aliases/ExecaResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/execa_executor/type-aliases/ExecaResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/execa_executor/type-aliases/ExecaResolver.md\ndescription: Resolver forms accepted for the execa module.\n---\n\n# Type Alias: ExecaResolver\n\n```ts\ntype ExecaResolver =\n | ExecaLike\n | (() =>\n | ExecaLike\n | {\n execa: ExecaLike;\n }\n | Promise<\n | ExecaLike\n | {\n execa: ExecaLike;\n }\n >);\n```\n\nDefined in: [src/batteries/media/engines/execa\\_executor.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/execa_executor.ts#L42)\n\nResolver forms accepted for the execa module.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace","title":"@nhtio/adk/batteries/media/engines/fs\\_workspace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/fs_workspace.md'\ndescription: >-\n A {@link @nhtio/adk/batteries/media/contracts!ScratchWorkspace} implementation\n backed by the local filesystem via `node:fs/promises`.\n---\n\n# @nhtio/adk/batteries/media/engines/fs\\_workspace\n\nA [@nhtio/adk/batteries/media/contracts!ScratchWorkspace](../../contracts/interfaces/ScratchWorkspace.md) implementation backed by the\nlocal filesystem via `node:fs/promises`.\n\n## Remarks\n\nThe bundled filesystem workspace. `node:fs/promises` is acquired through an async resolver\n(default: a lazy dynamic import) so this module carries no static `node:*` import and the\nbuiltin loads only when a workspace is actually minted.\n\nThe factory requires an explicit `root` directory — there is no `os.tmpdir()` silent\ndefault. Each minted workspace is a fresh unique subdirectory of `root`, removed on\n`dispose()`. Any BYO implementation whose paths the paired `BinaryExecutor` can open\nsatisfies the same contract (tmpfs mounts, container volumes, sandbox dirs…).\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------------- | ------------------------------------------------------------------ |\n| [FsLike](interfaces/FsLike.md) | The slice of `node:fs/promises` the workspace uses. |\n| [FsScratchWorkspaceOptions](interfaces/FsScratchWorkspaceOptions.md) | Options for [fsScratchWorkspace](functions/fsScratchWorkspace.md). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------- | ------------------------------------------ |\n| [FsResolver](type-aliases/FsResolver.md) | Resolver forms accepted for the fs module. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| [fsScratchWorkspace](functions/fsScratchWorkspace.md) | Construct a [ScratchWorkspaceFactory](../../contracts/type-aliases/ScratchWorkspaceFactory.md) minting per-invocation directories under `root`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/functions/fsScratchWorkspace","title":"Function: fsScratchWorkspace()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/functions/fsScratchWorkspace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/functions/fsScratchWorkspace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/fs_workspace/functions/fsScratchWorkspace.md\n---\n\n# Function: fsScratchWorkspace()\n\n```ts\nfunction fsScratchWorkspace(\n options: FsScratchWorkspaceOptions,\n): ScratchWorkspaceFactory;\n```\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L86)\n\nConstruct a [ScratchWorkspaceFactory](../../../contracts/type-aliases/ScratchWorkspaceFactory.md) minting per-invocation directories under `root`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------- | ----------------------------------- |\n| `options` | [`FsScratchWorkspaceOptions`](../interfaces/FsScratchWorkspaceOptions.md) | The root directory and fs resolver. |\n\n## Returns\n\n[`ScratchWorkspaceFactory`](../../../contracts/type-aliases/ScratchWorkspaceFactory.md)\n\nA factory binary engines call once per invocation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsLike","title":"Interface: FsLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsLike.md\ndescription: 'The slice of `node:fs/promises` the workspace uses.'\n---\n\n# Interface: FsLike\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L23)\n\nThe slice of `node:fs/promises` the workspace uses.\n\n## Methods\n\n### mkdir()\n\n```ts\nmkdir(path: string, options: {\n recursive: true;\n}): Promise;\n```\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L25)\n\nCreate a directory (recursively).\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------- | -------------------------- |\n| `path` | `string` |\n| `options` | { `recursive`: `true`; } |\n| `options.recursive` | `true` |\n\n#### Returns\n\n`Promise`<`unknown`>\n\n***\n\n### readdir()\n\n```ts\nreaddir(path: string): Promise;\n```\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L31)\n\nList directory entries (basenames).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`string`\\[]>\n\n***\n\n### readFile()\n\n```ts\nreadFile(path: string): Promise>;\n```\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L29)\n\nRead a file's bytes.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`Uint8Array`<`ArrayBufferLike`>>\n\n***\n\n### rm()\n\n```ts\nrm(path: string, options: {\n force: true;\n recursive: true;\n}): Promise;\n```\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L33)\n\nRemove a path recursively, ignoring absence.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------- | ------------------------------------------- |\n| `path` | `string` |\n| `options` | { `force`: `true`; `recursive`: `true`; } |\n| `options.force` | `true` |\n| `options.recursive` | `true` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### writeFile()\n\n```ts\nwriteFile(path: string, data: Uint8Array): Promise;\n```\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L27)\n\nWrite bytes to a path.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------ |\n| `path` | `string` |\n| `data` | `Uint8Array` |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsScratchWorkspaceOptions","title":"Interface: FsScratchWorkspaceOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsScratchWorkspaceOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsScratchWorkspaceOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsScratchWorkspaceOptions.md\ndescription: 'Options for [`fsScratchWorkspace`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/fs_workspace/functions/fsScratchWorkspace).'\n---\n\n# Interface: FsScratchWorkspaceOptions\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L40)\n\nOptions for [fsScratchWorkspace](../functions/fsScratchWorkspace.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `fs?` | [`FsResolver`](../type-aliases/FsResolver.md) | The fs module or a resolver for it. Defaults to a lazy `import('node:fs/promises')`. | [src/batteries/media/engines/fs\\_workspace.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L44) |\n| `root` | `string` | The directory all workspaces are minted under. Required — no platform default. | [src/batteries/media/engines/fs\\_workspace.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L42) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/type-aliases/FsResolver","title":"Type Alias: FsResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/type-aliases/FsResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/fs_workspace/type-aliases/FsResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/fs_workspace/type-aliases/FsResolver.md\ndescription: Resolver forms accepted for the fs module.\n---\n\n# Type Alias: FsResolver\n\n```ts\ntype FsResolver = FsLike | (() => FsLike | Promise);\n```\n\nDefined in: [src/batteries/media/engines/fs\\_workspace.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/fs_workspace.ts#L37)\n\nResolver forms accepted for the fs module.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp","title":"@nhtio/adk/batteries/media/engines/jimp","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/jimp.md'\ndescription: >-\n A cross-environment image {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine} backed by Jimp (pure\n JavaScript — no native bindings, no binaries).\n---\n\n# @nhtio/adk/batteries/media/engines/jimp\n\nA cross-environment image [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md)\nbacked by Jimp (pure JavaScript — no native bindings, no binaries).\n\n## Remarks\n\nThe local-by-default raster engine: runs anywhere TypeScript runs. Declares one mutate\ncapability over png/jpeg/bmp/gif/tiff with resize (cover/contain approximations), rotate,\nflip, quality, and metadata stripping (Jimp re-encodes pixels, so EXIF never survives —\n`strip_metadata` is inherently satisfied), plus a generation edge: `EMPTY_MIME` → a blank\n1024×1024 white canvas in any supported encoding (resize in the same statement —\n`empty:png | image resize width=64`). For webp/avif output or native-speed processing,\ncompose a sharp-backed engine instead — the capability declaration is the seam.\n\n`jimp` is an optional peer dependency, lazily imported on first actual use (constructing\nthe engine — and therefore the pipeline — never loads it).\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------- | -------------------------------------------------- |\n| [JimpEngineOptions](interfaces/JimpEngineOptions.md) | Options for [jimpEngine](functions/jimpEngine.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------- | --------------------------------------- |\n| [jimpEngine](functions/jimpEngine.md) | Construct the Jimp-backed image engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp/functions/jimpEngine","title":"Function: jimpEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp/functions/jimpEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp/functions/jimpEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/jimp/functions/jimpEngine.md\n---\n\n# Function: jimpEngine()\n\n```ts\nfunction jimpEngine(options?: JimpEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/jimp.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/jimp.ts#L57)\n\nConstruct the Jimp-backed image engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------- | ---------------------------------- |\n| `options` | [`JimpEngineOptions`](../interfaces/JimpEngineOptions.md) | Optional module resolver override. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp/interfaces/JimpEngineOptions","title":"Interface: JimpEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp/interfaces/JimpEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/jimp/interfaces/JimpEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/jimp/interfaces/JimpEngineOptions.md\ndescription: 'Options for [`jimpEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/jimp/functions/jimpEngine).'\n---\n\n# Interface: JimpEngineOptions\n\nDefined in: [src/batteries/media/engines/jimp.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/jimp.ts#L35)\n\nOptions for [jimpEngine](../functions/jimpEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `jimp?` | () => `__module` | `Promise`<`__module`> | Override the module resolution (tests / custom builds). Default: `import('jimp')`. | [src/batteries/media/engines/jimp.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/jimp.ts#L37) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp","title":"@nhtio/adk/batteries/media/engines/sharp","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sharp.md'\ndescription: >-\n A Node-native image {@link @nhtio/adk/batteries/media/contracts!MediaEngine}\n backed by sharp (libvips bindings — fast, full-format).\n---\n\n# @nhtio/adk/batteries/media/engines/sharp\n\nA Node-native image [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md)\nbacked by sharp (libvips bindings — fast, full-format).\n\n## Remarks\n\nThe performance/fidelity engine for Node deployments: native speed plus webp/avif output\nand the full `fit` mode set, plus a generation edge — `EMPTY_MIME` → a blank 1024×1024\nwhite canvas in any supported encoding (resize in the same statement). sharp is permanently\nNode-only (native bindings); for a cross-environment engine compose the jimp implementation\ninstead — the capability declaration is the seam, and BYO instances adapt via\n[fromSharp](functions/fromSharp.md).\n\n`sharp` is an optional peer dependency, lazily imported on first actual use.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------ | ---------------------------------------------------- |\n| [SharpEngineOptions](interfaces/SharpEngineOptions.md) | Options for [sharpEngine](functions/sharpEngine.md). |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |\n| [fromSharp](functions/fromSharp.md) | Adapt an already-configured sharp module (your import, your build flags) to the engine contract — the BYO transformer. |\n| [sharpEngine](functions/sharpEngine.md) | Construct the sharp-backed image engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/functions/fromSharp","title":"Function: fromSharp()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/functions/fromSharp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/functions/fromSharp","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sharp/functions/fromSharp.md\n---\n\n# Function: fromSharp()\n\n```ts\nfunction fromSharp(sharp: typeof sharp): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/sharp.ts:234](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sharp.ts#L234)\n\nAdapt an already-configured sharp module (your import, your build flags) to the engine\ncontract — the BYO transformer.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------------- | -------------------------------- |\n| `sharp` | *typeof* `sharp` | The sharp function you imported. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/functions/sharpEngine","title":"Function: sharpEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/functions/sharpEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/functions/sharpEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sharp/functions/sharpEngine.md\n---\n\n# Function: sharpEngine()\n\n```ts\nfunction sharpEngine(options?: SharpEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/sharp.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sharp.ts#L214)\n\nConstruct the sharp-backed image engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------- | ---------------------------------- |\n| `options` | [`SharpEngineOptions`](../interfaces/SharpEngineOptions.md) | Optional module resolver override. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/interfaces/SharpEngineOptions","title":"Interface: SharpEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/interfaces/SharpEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sharp/interfaces/SharpEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sharp/interfaces/SharpEngineOptions.md\ndescription: 'Options for [`sharpEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sharp/functions/sharpEngine).'\n---\n\n# Interface: SharpEngineOptions\n\nDefined in: [src/batteries/media/engines/sharp.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sharp.ts#L36)\n\nOptions for [sharpEngine](../functions/sharpEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `sharp?` | () => | *typeof* `sharp` | { `default`: *typeof* `sharp`; } | `Promise`< | *typeof* `sharp` | { `default`: *typeof* `sharp`; }> | Override the module resolution (electron/custom builds). Default: `import('sharp')`. | [src/batteries/media/engines/sharp.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sharp.ts#L38) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs","title":"@nhtio/adk/batteries/media/engines/sheetjs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sheetjs.md'\ndescription: >-\n The SheetJS-backed spreadsheet {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine}: the in-process,\n cross-environment spreadsheet converter, generator, and structural editor.\n---\n\n# @nhtio/adk/batteries/media/engines/sheetjs\n\nThe SheetJS-backed spreadsheet [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md):\nthe in-process, cross-environment spreadsheet converter, generator, and structural editor.\n\n## Remarks\n\nSheetJS (the `xlsx` package) reads and writes the widest spreadsheet matrix of any pure-JS\nlibrary — XLSX/XLSM/XLSB, every XLS BIFF era, ODS/FODS, CSV, SYLK, DIF, DBF, HTML, RTF,\nApple NUMBERS — with no binary, no native bindings, in any environment. This engine exposes\nthat matrix three ways:\n\n* **convert**: any readable spreadsheet MIME → any writable format token.\n* **generate**: `EMPTY_MIME` → any writable token (a blank `Sheet1` workbook, written out).\n* **edit**: the `sheet.*` structural ops via CSF cell-object surgery. ⚠️ SheetJS Community\n Edition does NOT model cell styling — fonts, fills, and comments are STRIPPED by any edit\n or convert that round-trips a styled workbook (styling is a SheetJS Pro feature). For\n fidelity-preserving edits compose the exceljs engine FIRST in the engines array; this\n engine's edits are for unstyled/data workbooks and for breadth (it edits ODS, XLS, and\n every other readable format by normalizing through CSF).\n\n⚠️ **Install from the SheetJS CDN, not the npm registry.** The registry copy of `xlsx` is\nfrozen at 0.18.5 (2023) and carries CVE-2023-30533 and CVE-2024-22363; this engine requires\n`>=0.20.2`. Install: `pnpm add xlsx@https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz`\n(SheetJS recommends vendoring the tarball — see docs.sheetjs.com).\n\n`xlsx` is an optional peer dependency, lazily imported on first actual use. The NUMBERS\nwrite target additionally loads the ZAHL payload (`xlsx/dist/xlsx.zahl.mjs`, ~110 KB) on\nfirst request of that specific target.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | -------------------------------------------------------- |\n| [SheetjsEngineOptions](interfaces/SheetjsEngineOptions.md) | Options for [sheetjsEngine](functions/sheetjsEngine.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------- | ------------------------------------------------ |\n| [sheetjsEngine](functions/sheetjsEngine.md) | Construct the SheetJS-backed spreadsheet engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs/functions/sheetjsEngine","title":"Function: sheetjsEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs/functions/sheetjsEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs/functions/sheetjsEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sheetjs/functions/sheetjsEngine.md\n---\n\n# Function: sheetjsEngine()\n\n```ts\nfunction sheetjsEngine(options?: SheetjsEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/sheetjs.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sheetjs.ts#L140)\n\nConstruct the SheetJS-backed spreadsheet engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------- | ----------------------------------- |\n| `options` | [`SheetjsEngineOptions`](../interfaces/SheetjsEngineOptions.md) | Optional module resolver overrides. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs/interfaces/SheetjsEngineOptions","title":"Interface: SheetjsEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs/interfaces/SheetjsEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/sheetjs/interfaces/SheetjsEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sheetjs/interfaces/SheetjsEngineOptions.md\ndescription: 'Options for [`sheetjsEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/sheetjs/functions/sheetjsEngine).'\n---\n\n# Interface: SheetjsEngineOptions\n\nDefined in: [src/batteries/media/engines/sheetjs.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sheetjs.ts#L48)\n\nOptions for [sheetjsEngine](../functions/sheetjsEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `xlsx?` | () => `__module` | `Promise`<`__module`> | Override the module resolution (tests / custom builds). Default: `import('xlsx')`. | [src/batteries/media/engines/sheetjs.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sheetjs.ts#L50) |\n| `zahl?` | () => `unknown` | Override the ZAHL payload resolution for NUMBERS output (tests / custom builds). Default: `import('xlsx/dist/xlsx.zahl.mjs')`. | [src/batteries/media/engines/sheetjs.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/sheetjs.ts#L55) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice","title":"@nhtio/adk/batteries/media/engines/soffice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/soffice.md'\ndescription: >-\n The LibreOffice-backed {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine}: document, spreadsheet, and\n presentation conversion via the `soffice` binary.\n---\n\n# @nhtio/adk/batteries/media/engines/soffice\n\nThe LibreOffice-backed [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md): document,\nspreadsheet, and presentation conversion via the `soffice` binary.\n\n## Remarks\n\nDocument conversion is the one capability in the media battery with no mature\ncross-environment equivalent, so this engine is binary-backed by design. It composes the\ntwo BYO runtime contracts: a [@nhtio/adk/batteries/media/contracts!BinaryExecutor](../../contracts/interfaces/BinaryExecutor.md)\nruns the invocation (bundled: `execa_executor`) and a\n[@nhtio/adk/batteries/media/contracts!ScratchWorkspace](../../contracts/interfaces/ScratchWorkspace.md) exchanges bytes with it\n(bundled: `fs_workspace`). The executor and workspace must agree on path visibility —\nthat pairing is the consumer's composition decision.\n\nOne engine, one capability kind: the conversion matrix is declared as convert capability\ngroups (each format silo converts within itself plus to PDF/HTML; PDF converts to\nhtml/txt/docx/odt). The spreadsheet group covers ODS/legacy-xls to xlsx — what used to be\na separate \"normalize\" engine is just an edge in the matrix.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | -------------------------------------------------------- |\n| [SofficeEngineOptions](interfaces/SofficeEngineOptions.md) | Options for [sofficeEngine](functions/sofficeEngine.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------- | --------------------------------- |\n| [sofficeEngine](functions/sofficeEngine.md) | Construct the LibreOffice engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice/functions/sofficeEngine","title":"Function: sofficeEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice/functions/sofficeEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice/functions/sofficeEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/soffice/functions/sofficeEngine.md\n---\n\n# Function: sofficeEngine()\n\n```ts\nfunction sofficeEngine(options: SofficeEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/soffice.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/soffice.ts#L213)\n\nConstruct the LibreOffice engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------- | -------------------------------------------------- |\n| `options` | [`SofficeEngineOptions`](../interfaces/SofficeEngineOptions.md) | Binary path, executor, workspace factory, timeout. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine, declaring one convert capability group per format silo.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice/interfaces/SofficeEngineOptions","title":"Interface: SofficeEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice/interfaces/SofficeEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/soffice/interfaces/SofficeEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/soffice/interfaces/SofficeEngineOptions.md\ndescription: 'Options for [`sofficeEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/soffice/functions/sofficeEngine).'\n---\n\n# Interface: SofficeEngineOptions\n\nDefined in: [src/batteries/media/engines/soffice.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/soffice.ts#L34)\n\nOptions for [sofficeEngine](../functions/sofficeEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `executor` | [`BinaryExecutor`](../../../contracts/interfaces/BinaryExecutor.md) | Runs the soffice invocation. Required — no platform default. | [src/batteries/media/engines/soffice.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/soffice.ts#L38) |\n| `path` | `string` | Path (or resolvable name) of the soffice binary. | [src/batteries/media/engines/soffice.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/soffice.ts#L36) |\n| `timeoutMs?` | `number` | Per-invocation timeout. Default 120000. | [src/batteries/media/engines/soffice.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/soffice.ts#L42) |\n| `workspace` | [`ScratchWorkspaceFactory`](../../../contracts/type-aliases/ScratchWorkspaceFactory.md) | Mints a scratch dir per invocation whose paths the executor can open. Required. | [src/batteries/media/engines/soffice.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/soffice.ts#L40) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js","title":"@nhtio/adk/batteries/media/engines/tesseract\\_js","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/tesseract_js.md'\ndescription: >-\n A cross-environment OCR {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine} backed by tesseract.js (WASM\n Tesseract — Node and browsers, no binary).\n---\n\n# @nhtio/adk/batteries/media/engines/tesseract\\_js\n\nA cross-environment OCR [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md)\nbacked by tesseract.js (WASM Tesseract — Node and browsers, no binary).\n\n## Remarks\n\nThe local-by-default OCR engine. Language data files download on first use of each\nlanguage; point `langPath`/`cachePath` at a writable location to control where (the\nfactory requires `languages` up front so a deployment never silently fetches packs for\nlanguages it didn't plan for). Workers are created per recognize call and terminated in\n`finally` — slower than a pooled setup but leak-free by construction; consumers who need\npooling can BYO an engine that holds a worker.\n\n`tesseract.js` is an optional peer dependency, lazily imported on first actual use.\n\nDeclares one convert capability: `image/*` to `txt`/`hocr`/`json` (OCR is a format\nconversion — image in, text out). Language hints ride `request.options.languages`.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------ | ---------------------------------------------------------------- |\n| [TesseractJsEngineOptions](interfaces/TesseractJsEngineOptions.md) | Options for [tesseractJsEngine](functions/tesseractJsEngine.md). |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------- | -------------------------------------- |\n| [tesseractJsEngine](functions/tesseractJsEngine.md) | Construct the tesseract.js OCR engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js/functions/tesseractJsEngine","title":"Function: tesseractJsEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js/functions/tesseractJsEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js/functions/tesseractJsEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/tesseract_js/functions/tesseractJsEngine.md\n---\n\n# Function: tesseractJsEngine()\n\n```ts\nfunction tesseractJsEngine(options: TesseractJsEngineOptions): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/tesseract\\_js.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/tesseract_js.ts#L46)\n\nConstruct the tesseract.js OCR engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------- | --------------------------------------------- |\n| `options` | [`TesseractJsEngineOptions`](../interfaces/TesseractJsEngineOptions.md) | Languages (required) and data-path overrides. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js/interfaces/TesseractJsEngineOptions","title":"Interface: TesseractJsEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js/interfaces/TesseractJsEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/tesseract_js/interfaces/TesseractJsEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/tesseract_js/interfaces/TesseractJsEngineOptions.md\ndescription: 'Options for [`tesseractJsEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/tesseract_js/functions/tesseractJsEngine).'\n---\n\n# Interface: TesseractJsEngineOptions\n\nDefined in: [src/batteries/media/engines/tesseract\\_js.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/tesseract_js.ts#L29)\n\nOptions for [tesseractJsEngine](../functions/tesseractJsEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cachePath?` | `string` | Local cache directory for downloaded language data. | [src/batteries/media/engines/tesseract\\_js.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/tesseract_js.ts#L35) |\n| `langPath?` | `string` | Where language data is fetched from / cached (forwarded to createWorker). | [src/batteries/media/engines/tesseract\\_js.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/tesseract_js.ts#L33) |\n| `languages` | readonly `string`\\[] | Languages to load, e.g. `['eng']`. REQUIRED — language packs download on first use. | [src/batteries/media/engines/tesseract\\_js.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/tesseract_js.ts#L31) |\n| `tesseract?` | () => *typeof* `Tesseract` | `Promise`<*typeof* `Tesseract`> | Override the module resolution. Default: `import('tesseract.js')`. | [src/batteries/media/engines/tesseract\\_js.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/tesseract_js.ts#L37) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr","title":"@nhtio/adk/batteries/media/engines/transformers\\_asr","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/transformers_asr.md'\ndescription: >-\n A cross-environment transcription {@link\n @nhtio/adk/batteries/media/contracts!MediaEngine} backed by\n `@huggingface/transformers` Whisper (ONNX in Node, WASM/WebGPU in browsers).\n---\n\n# @nhtio/adk/batteries/media/engines/transformers\\_asr\n\nA cross-environment transcription [@nhtio/adk/batteries/media/contracts!MediaEngine](../../contracts/interfaces/MediaEngine.md)\nbacked by `@huggingface/transformers` Whisper (ONNX in Node, WASM/WebGPU in browsers).\n\n## Remarks\n\nThe local-by-default speech-to-text engine: no external API, no binary. Declares one\nconvert capability: the virtual `pcm` token to `txt`/`srt`/`vtt`/`json` (transcription is a\nformat conversion — PCM in, text out). The Whisper model id is REQUIRED — models are\nmulti-hundred-megabyte downloads on first use and the battery never triggers one silently\n(the loud-config rule). Input is 16 kHz mono PCM, exactly what the transcribe step\nsupplies; `lang`/`translate` ride `request.options`. `srt`/`vtt` output is assembled from\nchunk timestamps; `json` returns the chunk structure verbatim.\n\n`@huggingface/transformers` is an optional peer dependency, lazily imported on first\nactual use.\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| [TransformersAsrEngineOptions](interfaces/TransformersAsrEngineOptions.md) | Options for [transformersAsrEngine](functions/transformersAsrEngine.md). |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------- | ------------------------------------------------- |\n| [transformersAsrEngine](functions/transformersAsrEngine.md) | Construct the transformers.js Whisper ASR engine. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr/functions/transformersAsrEngine","title":"Function: transformersAsrEngine()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr/functions/transformersAsrEngine.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr/functions/transformersAsrEngine","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/transformers_asr/functions/transformersAsrEngine.md\n---\n\n# Function: transformersAsrEngine()\n\n```ts\nfunction transformersAsrEngine(\n options: TransformersAsrEngineOptions,\n): MediaEngine;\n```\n\nDefined in: [src/batteries/media/engines/transformers\\_asr.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/transformers_asr.ts#L84)\n\nConstruct the transformers.js Whisper ASR engine.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------- | ---------------------------------- |\n| `options` | [`TransformersAsrEngineOptions`](../interfaces/TransformersAsrEngineOptions.md) | Model id (required) and overrides. |\n\n## Returns\n\n[`MediaEngine`](../../../contracts/interfaces/MediaEngine.md)\n\nThe engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr/interfaces/TransformersAsrEngineOptions","title":"Interface: TransformersAsrEngineOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr/interfaces/TransformersAsrEngineOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/engines/transformers_asr/interfaces/TransformersAsrEngineOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/transformers_asr/interfaces/TransformersAsrEngineOptions.md\ndescription: 'Options for [`transformersAsrEngine`](https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/transformers_asr/functions/transformersAsrEngine).'\n---\n\n# Interface: TransformersAsrEngineOptions\n\nDefined in: [src/batteries/media/engines/transformers\\_asr.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/transformers_asr.ts#L44)\n\nOptions for [transformersAsrEngine](../functions/transformersAsrEngine.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `model` | `string` | The Whisper model id, e.g. `onnx-community/whisper-base`. REQUIRED — no default, no surprise downloads. | [src/batteries/media/engines/transformers\\_asr.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/transformers_asr.ts#L49) |\n| `pipelineOptions?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Extra options forwarded to `pipeline()` (device, dtype, cache\\_dir…). | [src/batteries/media/engines/transformers\\_asr.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/transformers_asr.ts#L53) |\n| `transformers?` | () => `__module` | `Promise`<`__module`> | Override the module resolution. Default: `import('@huggingface/transformers')`. | [src/batteries/media/engines/transformers\\_asr.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/engines/transformers_asr.ts#L51) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/forge","title":"@nhtio/adk/batteries/media/forge","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/forge.md'\ndescription: >-\n Agent glue: forge ADK tools from a media pipeline, so a model can drive local\n media work.\n---\n\n# @nhtio/adk/batteries/media/forge\n\nAgent glue: forge ADK tools from a media pipeline, so a model can drive local media work.\n\n## Remarks\n\nThe pipeline core (`@nhtio/adk/batteries/media`) is agent-agnostic; this module is the layer\nthat knows the ADK loop. [forgeMediaTools](functions/forgeMediaTools.md) mints `Tool` instances over a configured\n[@nhtio/adk/batteries/media!MediaPipeline](../interfaces/MediaPipeline.md) in one of two surfaces (the consumer picks\nper deployment):\n\n* `'composite'` — one `media_query` tool taking `{ media_id, q }` (a pipe expression — the\n headline LLM DSL) or `{ media_id, ops }` (structured form), plus `list_media`. The tool\n description embeds the engine-narrowed verb grammar so the model never sees a verb the\n deployment can't run. One round-trip for multi-step work.\n* `'granular'` — one narrow tool per available verb (`doc_select`, `sheet_update_cells`, …),\n each internally a one-verb plan. Friendlier to small models; bigger tool list.\n\nMedia flows in by reference: the model passes `media_id` values it discovered via the\n`list_media` tool (or inline id markers, where the LLM battery renders them); the resolver\nscans `ctx.turnMessages[].attachments` and `ctx.turnToolCalls[].results` by default. Outputs\nare persisted through `ctx.storeMediaBytes` and returned as `Media.toolGenerated(...)`, so\nfile results land on `ToolCall.results` as first-class media.\n\nProcessing failures return readable strings (`Error (CODE): …`) the model can act on; the\npipe DSL's own syntax/semantic errors render the same way, so a model can repair its\nstatement and retry. An optional [ToolGateFn](type-aliases/ToolGateFn.md) runs before every execution — the seam\nfor human-approval/RBAC flows built on `ctx.waitFor` (the ADK gates primitive).\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------- | ------------------------------------------------------------ |\n| [ForgeMediaToolsOptions](interfaces/ForgeMediaToolsOptions.md) | Options for [forgeMediaTools](functions/forgeMediaTools.md). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [MediaResolverFn](type-aliases/MediaResolverFn.md) | Resolves a `media_id` to a [@nhtio/adk!Media](../../../common/classes/Media.md) visible in the current dispatch. The default implementation scans turn messages' attachments and prior tool-call results. |\n| [ToolGateFn](type-aliases/ToolGateFn.md) | Optional per-call gate run before any pipeline execution. Throwing aborts the call and surfaces through the standard tool-error path. The canonical implementation awaits `ctx.waitFor({ reason: 'tool_approval', payload: call })` and throws on denial — WHO approves and HOW is the consumer's contract; this is the seam. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| [defaultResolveMedia](variables/defaultResolveMedia.md) | The default media resolver: scan `ctx.turnMessages[].attachments`, then `ctx.turnToolCalls[].results`, for a Media with the given id. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [foldVerb](functions/foldVerb.md) | Fold a verb token sequence to canonical form: lowercase, separators (space/`_`/`.`) normalized so `extract_text` ≡ `extract text` ≡ `extract.text` all match `extract.text`. |\n| [forgeMediaTools](functions/forgeMediaTools.md) | Forge agent tools over a configured media pipeline. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/forge/functions/foldVerb","title":"Function: foldVerb()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/functions/foldVerb.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/functions/foldVerb","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/forge/functions/foldVerb.md'\n---\n\n# Function: foldVerb()\n\n```ts\nfunction foldVerb(words: string[]): string | undefined;\n```\n\nDefined in: [src/batteries/media/verbs.ts:814](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L814)\n\nFold a verb token sequence to canonical form: lowercase, separators (space/`_`/`.`)\nnormalized so `extract_text` ≡ `extract text` ≡ `extract.text` all match `extract.text`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------- | ---------------------------------------------------------------------------- |\n| `words` | `string`\\[] | The verb word tokens as written (1 or 2 words, possibly containing `_`/`.`). |\n\n## Returns\n\n`string` | `undefined`\n\nThe canonical verb id when a fold-match exists, otherwise `undefined`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/forge/functions/forgeMediaTools","title":"Function: forgeMediaTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/functions/forgeMediaTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/functions/forgeMediaTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/forge/functions/forgeMediaTools.md\n---\n\n# Function: forgeMediaTools()\n\n```ts\nfunction forgeMediaTools(\n pipeline: MediaPipeline,\n options: ForgeMediaToolsOptions,\n): Record;\n```\n\nDefined in: [src/batteries/media/forge.ts:652](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L652)\n\nForge agent tools over a configured media pipeline.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | ------------------------------------------------------------------- | --------------------------------------- |\n| `pipeline` | [`MediaPipeline`](../../interfaces/MediaPipeline.md) | A pipeline from `createMediaPipeline`. |\n| `options` | [`ForgeMediaToolsOptions`](../interfaces/ForgeMediaToolsOptions.md) | Surface, resolver, gate, and overrides. |\n\n## Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Tool`](../../../../forge/classes/Tool.md)>\n\nThe minted tools, keyed by name.\n\n## Remarks\n\nThe minted set follows the pipeline's configured engines: in the composite surface the\n`media_query` grammar text only advertises available verbs; in the granular surface a tool\nis minted only for verbs whose engine (if any) is configured. Either way `list_media` is\nincluded — it is the model's entry point for discovering `media_id` values.\n\nThe returned record is keyed by tool name so consumers can register selectively or pass\n`Object.values(tools)` to `TurnRunnerConfig.tools`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/forge/interfaces/ForgeMediaToolsOptions","title":"Interface: ForgeMediaToolsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/interfaces/ForgeMediaToolsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/interfaces/ForgeMediaToolsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/forge/interfaces/ForgeMediaToolsOptions.md\ndescription: 'Options for [`forgeMediaTools`](https://adk.nht.io/api/@nhtio/adk/batteries/media/forge/functions/forgeMediaTools).'\n---\n\n# Interface: ForgeMediaToolsOptions\n\nDefined in: [src/batteries/media/forge.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L72)\n\nOptions for [forgeMediaTools](../functions/forgeMediaTools.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |\n| `gate?` | [`ToolGateFn`](../type-aliases/ToolGateFn.md) | Optional pre-execution gate (see [ToolGateFn](../type-aliases/ToolGateFn.md)). | [src/batteries/media/forge.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L78) |\n| `overrides?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, { `description?`: `string`; `name?`: `string`; }> | Per-tool name/description overrides, keyed by the minted tool's default name. | [src/batteries/media/forge.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L80) |\n| `resolveMedia?` | [`MediaResolverFn`](../type-aliases/MediaResolverFn.md) | Media-id resolution. Default: scan turn attachments + tool-call Media results. | [src/batteries/media/forge.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L76) |\n| `surface` | `\"composite\"` | `\"granular\"` | Which tool surface to mint. | [src/batteries/media/forge.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L74) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/forge/type-aliases/MediaResolverFn","title":"Type Alias: MediaResolverFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/type-aliases/MediaResolverFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/type-aliases/MediaResolverFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/forge/type-aliases/MediaResolverFn.md\ndescription: >-\n Resolves a `media_id` to a {@link @nhtio/adk!Media} visible in the current\n dispatch. The default implementation scans turn messages' attachments and\n prior tool-call results.\n---\n\n# Type Alias: MediaResolverFn\n\n```ts\ntype MediaResolverFn = (\n ctx: DispatchContext,\n mediaId: string,\n) => Media | undefined | Promise;\n```\n\nDefined in: [src/batteries/media/forge.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L55)\n\nResolves a `media_id` to a [@nhtio/adk!Media](../../../../common/classes/Media.md) visible in the current dispatch.\nThe default implementation scans turn messages' attachments and prior tool-call results.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------------------------------- |\n| `ctx` | [`DispatchContext`](../../../../types/interfaces/DispatchContext.md) |\n| `mediaId` | `string` |\n\n## Returns\n\n| [`Media`](../../../../common/classes/Media.md)\n| `undefined`\n| `Promise`<[`Media`](../../../../common/classes/Media.md) | `undefined`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/forge/type-aliases/ToolGateFn","title":"Type Alias: ToolGateFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/type-aliases/ToolGateFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/type-aliases/ToolGateFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/forge/type-aliases/ToolGateFn.md\ndescription: >-\n Optional per-call gate run before any pipeline execution. Throwing aborts the\n call and surfaces through the standard tool-error path. The canonical\n implementation awaits `ctx.waitFor({ reason: 'tool_approval', payload: call\n })` and throws on denial — WHO approves and HOW is the consumer's contract;\n this is the seam.\n---\n\n# Type Alias: ToolGateFn\n\n```ts\ntype ToolGateFn = (\n ctx: DispatchContext,\n call: {\n args: unknown;\n tool: string;\n },\n) => void | Promise;\n```\n\nDefined in: [src/batteries/media/forge.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L66)\n\nOptional per-call gate run before any pipeline execution. Throwing aborts the call and\nsurfaces through the standard tool-error path. The canonical implementation awaits\n`ctx.waitFor({ reason: 'tool_approval', payload: call })` and throws on denial — WHO\napproves and HOW is the consumer's contract; this is the seam.\n\n## Parameters\n\n| Parameter | Type |\n| ----------- | -------------------------------------------------------------------- |\n| `ctx` | [`DispatchContext`](../../../../types/interfaces/DispatchContext.md) |\n| `call` | { `args`: `unknown`; `tool`: `string`; } |\n| `call.args` | `unknown` |\n| `call.tool` | `string` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/forge/variables/defaultResolveMedia","title":"Variable: defaultResolveMedia","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/variables/defaultResolveMedia.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/forge/variables/defaultResolveMedia","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/forge/variables/defaultResolveMedia.md\ndescription: >-\n The default media resolver: scan `ctx.turnMessages[].attachments`, then\n `ctx.turnToolCalls[].results`, for a Media with the given id.\n---\n\n# Variable: defaultResolveMedia\n\n```ts\nconst defaultResolveMedia: MediaResolverFn;\n```\n\nDefined in: [src/batteries/media/forge.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/forge.ts#L91)\n\nThe default media resolver: scan `ctx.turnMessages[].attachments`, then\n`ctx.turnToolCalls[].results`, for a Media with the given id.\n\n## Param\n\n**ctx**\n\nThe dispatch context.\n\n## Param\n\n**mediaId**\n\nThe id to find.\n\n## Returns\n\nThe Media, or `undefined` when nothing in the turn carries that id.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/availableVerbs","title":"Function: availableVerbs()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/availableVerbs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/availableVerbs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/availableVerbs.md'\n---\n\n# Function: availableVerbs()\n\n```ts\nfunction availableVerbs(capabilities: CapabilityProbe): string[];\n```\n\nDefined in: [src/batteries/media/validate.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L69)\n\nThe folded verb forms available under a given capability configuration.\n\n## Parameters\n\n| Parameter | Type |\n| -------------- | ----------------------------------------------------- |\n| `capabilities` | [`CapabilityProbe`](../interfaces/CapabilityProbe.md) |\n\n## Returns\n\n`string`\\[]\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/buildEngineRegistry","title":"Function: buildEngineRegistry()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/buildEngineRegistry.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/buildEngineRegistry","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/buildEngineRegistry.md\n---\n\n# Function: buildEngineRegistry()\n\n```ts\nfunction buildEngineRegistry(\n engines: readonly MediaEngine[],\n selection?: readonly EngineSelectionMiddlewareFn[],\n): EngineRegistry;\n```\n\nDefined in: [src/batteries/media/registry.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L196)\n\nBuild the registry over a resolved, validated engine array.\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| ----------- | ------------------------------------------------------------------------------------------ | ------------- | ---------------------------------------------------------------------------- |\n| `engines` | readonly [`MediaEngine`](../contracts/interfaces/MediaEngine.md)\\[] | `undefined` | The engines, in supply (priority) order. |\n| `selection` | readonly [`EngineSelectionMiddlewareFn`](../type-aliases/EngineSelectionMiddlewareFn.md)\\[] | `[]` | Optional selection-middleware stages arbitrating multi-candidate dispatches. |\n\n## Returns\n\n[`EngineRegistry`](../interfaces/EngineRegistry.md)\n\nThe registry.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/createMediaPipeline","title":"Function: createMediaPipeline()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/createMediaPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/createMediaPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/createMediaPipeline.md\n---\n\n# Function: createMediaPipeline()\n\n```ts\nfunction createMediaPipeline(\n config?: MediaPipelineConfig,\n): Promise;\n```\n\nDefined in: [src/batteries/media/index.ts:305](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L305)\n\nCreate a media pipeline.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------- | ------------------------------------------------------------------------- |\n| `config` | [`MediaPipelineConfig`](../interfaces/MediaPipelineConfig.md) | Engines, selection stages, step interceptors, and the media-ref resolver. |\n\n## Returns\n\n`Promise`<[`MediaPipeline`](../interfaces/MediaPipeline.md)>\n\nThe callable [MediaPipeline](../interfaces/MediaPipeline.md).\n\n## Remarks\n\nConfig is validated eagerly, and so are the engines: every resolver in the array runs at\nconstruction (capability declarations drive verb narrowing, so they must be known up\nfront), each result is contract-checked, and failures throw\n`E_INVALID_MEDIA_PIPELINE_CONFIG` naming the offending index. Construction stays cheap —\nbundled engine modules import their heavy peer dependencies lazily inside capability\nmethods, on first actual use.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/familyOf","title":"Function: familyOf()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/familyOf.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/familyOf","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/familyOf.md'\n---\n\n# Function: familyOf()\n\n```ts\nfunction familyOf(mimeType: string): FormatFamily;\n```\n\nDefined in: [src/batteries/media/formats.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L101)\n\nClassify a MIME type into the verb table's broad format family.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | -------- | -------------------- |\n| `mimeType` | `string` | The media MIME type. |\n\n## Returns\n\n[`FormatFamily`](../type-aliases/FormatFamily.md)\n\nThe family used by verb-applicability checks.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/fromOps","title":"Function: fromOps()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/fromOps.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/fromOps","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/fromOps.md'\n---\n\n# Function: fromOps()\n\n```ts\nfunction fromOps(ops: MediaOp[]): MediaPlan;\n```\n\nDefined in: [src/batteries/media/plan.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L278)\n\nBuild a [MediaPlan](../interfaces/MediaPlan.md) from a JSON ops array. The inverse of [toOps](toOps.md).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------- | -------------- |\n| `ops` | [`MediaOp`](../interfaces/MediaOp.md)\\[] | The ops array. |\n\n## Returns\n\n[`MediaPlan`](../interfaces/MediaPlan.md)\n\nThe equivalent plan.\n\n## Remarks\n\nPerforms structural normalization only (verb-id folding via the caller's verb table happens\nin validation, not here). Steps carry no spans.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/isMediaRef","title":"Function: isMediaRef()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/isMediaRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/isMediaRef","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/isMediaRef.md'\n---\n\n# Function: isMediaRef()\n\n```ts\nfunction isMediaRef(value: unknown): value is MediaRef;\n```\n\nDefined in: [src/batteries/media/plan.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L118)\n\n`true` when `value` is a [MediaRef](../type-aliases/MediaRef.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is MediaRef`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/isRegExpRef","title":"Function: isRegExpRef()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/isRegExpRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/isRegExpRef","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/isRegExpRef.md'\n---\n\n# Function: isRegExpRef()\n\n```ts\nfunction isRegExpRef(value: unknown): value is RegExpRef;\n```\n\nDefined in: [src/batteries/media/plan.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L111)\n\n`true` when `value` is a [RegExpRef](../interfaces/RegExpRef.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is RegExpRef`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/lowerSegments","title":"Function: lowerSegments()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/lowerSegments.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/lowerSegments","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/lowerSegments.md'\n---\n\n# Function: lowerSegments()\n\n```ts\nfunction lowerSegments(segments: RawSegment[]): MediaPlan;\n```\n\nDefined in: [src/batteries/media/pipe.ts:355](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L355)\n\nLower raw segments to an (unvalidated) [MediaPlan](../interfaces/MediaPlan.md). Quoted-JSON arg parsing and\ntype/enum checks happen in the validator, which consumes the raw segments — this lowering\nexists for tooling that wants the structural plan without validation.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | --------------------------------------------- | ------------------------------------------ |\n| `segments` | [`RawSegment`](../interfaces/RawSegment.md)\\[] | Output of [parsePipeRaw](parsePipeRaw.md). |\n\n## Returns\n\n[`MediaPlan`](../interfaces/MediaPlan.md)\n\nThe structural plan (args carried as parsed, json args still strings).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/parsePipeRaw","title":"Function: parsePipeRaw()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/parsePipeRaw.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/parsePipeRaw","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/parsePipeRaw.md'\n---\n\n# Function: parsePipeRaw()\n\n```ts\nfunction parsePipeRaw(input: string): RawSegment[];\n```\n\nDefined in: [src/batteries/media/pipe.ts:343](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L343)\n\nParse a pipe expression into raw, position-bearing segments.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | -------------------- |\n| `input` | `string` | The pipe expression. |\n\n## Returns\n\n[`RawSegment`](../interfaces/RawSegment.md)\\[]\n\nThe raw segments.\n\n## Remarks\n\nPurely syntactic — verbs are fold-matched against the full verb table for canonicalization\nbut unknown verbs are NOT an error here (the validator reports them with did-you-mean and the\ndeployment's narrowed verb list). Pair with `validateSegments` for the validated path.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/replaceExtension","title":"Function: replaceExtension()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/replaceExtension.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/replaceExtension","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/replaceExtension.md\n---\n\n# Function: replaceExtension()\n\n```ts\nfunction replaceExtension(filename: string, ext: string): string;\n```\n\nDefined in: [src/batteries/media/formats.ts:174](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L174)\n\nReplace (or add) a filename's extension.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | -------- | ----------------------------------- |\n| `filename` | `string` | The original filename. |\n| `ext` | `string` | The new extension, without the dot. |\n\n## Returns\n\n`string`\n\nThe filename with the new extension.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/suggestVerbs","title":"Function: suggestVerbs()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/suggestVerbs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/suggestVerbs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/suggestVerbs.md'\n---\n\n# Function: suggestVerbs()\n\n```ts\nfunction suggestVerbs(input: string, candidates: readonly string[]): string[];\n```\n\nDefined in: [src/batteries/media/verbs.ts:851](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L851)\n\nSuggest the nearest verbs to an unknown input, for did-you-mean errors. Matches whole folded\nforms AND suffix words (`resize` suggests `image resize`), per the frozen error model.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------ | ------------------- | ----------------------------------------------------------------------------------------------- |\n| `input` | `string` | The unknown verb text as written. |\n| `candidates` | readonly `string`\\[] | The folded verb forms to search (pass the narrowed set to avoid suggesting unconfigured verbs). |\n\n## Returns\n\n`string`\\[]\n\nUp to three suggestions, best first.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/toOps","title":"Function: toOps()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/toOps.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/toOps","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/toOps.md'\n---\n\n# Function: toOps()\n\n```ts\nfunction toOps(plan: MediaPlan): MediaOp[];\n```\n\nDefined in: [src/batteries/media/plan.ts:265](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L265)\n\nRender a [MediaPlan](../interfaces/MediaPlan.md) to its JSON ops array. Total — every plan has an ops form.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------- | ------------------- |\n| `plan` | [`MediaPlan`](../interfaces/MediaPlan.md) | The plan to render. |\n\n## Returns\n\n[`MediaOp`](../interfaces/MediaOp.md)\\[]\n\nThe ops array (spans stripped).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/toPipe","title":"Function: toPipe()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/toPipe.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/toPipe","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/toPipe.md'\n---\n\n# Function: toPipe()\n\n```ts\nfunction toPipe(plan: MediaPlan): string;\n```\n\nDefined in: [src/batteries/media/plan.ts:248](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L248)\n\nRender a [MediaPlan](../interfaces/MediaPlan.md) to its canonical pipe string.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------- | ------------------- |\n| `plan` | [`MediaPlan`](../interfaces/MediaPlan.md) | The plan to render. |\n\n## Returns\n\n`string`\n\nThe canonical pipe expression.\n\n## Remarks\n\nTotal for every plan except those containing builder-variant media refs, which throw\n[E\\_MEDIA\\_NOT\\_PIPE\\_EXPRESSIBLE](../variables/E_MEDIA_NOT_PIPE_EXPRESSIBLE.md). Structured args render as quoted JSON. The output is\ncanonical: dot-namespaced verbs render as space-separated words, number runs compress to\nranges, strings quote per the frozen predicate.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/unsupportedForMutationReason","title":"Function: unsupportedForMutationReason()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/unsupportedForMutationReason.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/unsupportedForMutationReason","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/unsupportedForMutationReason.md\n---\n\n# Function: unsupportedForMutationReason()\n\n```ts\nfunction unsupportedForMutationReason(mimeType: string): string | undefined;\n```\n\nDefined in: [src/batteries/media/formats.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L119)\n\nReason a mutation verb cannot run against this MIME type, or `undefined` when mutation is\nallowed. Returns a reason string (not a throw) so callers compose model-actionable failures.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | -------- | -------------------- |\n| `mimeType` | `string` | The media MIME type. |\n\n## Returns\n\n`string` | `undefined`\n\nA human-readable reason, or `undefined` when mutation is supported.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/validateOps","title":"Function: validateOps()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/validateOps.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/validateOps","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/validateOps.md'\n---\n\n# Function: validateOps()\n\n```ts\nfunction validateOps(\n ops: readonly MediaOp[],\n options: ValidateOptions,\n): MediaPlan;\n```\n\nDefined in: [src/batteries/media/validate.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L309)\n\nValidate a JSON ops array into a [MediaPlan](../interfaces/MediaPlan.md). The same checks as the pipe path —\nverbs fold the same way, args validate against the same specs — so the two front-ends\nproduce identical plans for equivalent statements.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------- | ---------------------------------- |\n| `ops` | readonly [`MediaOp`](../interfaces/MediaOp.md)\\[] | The ops array. |\n| `options` | [`ValidateOptions`](../interfaces/ValidateOptions.md) | The deployment's capability probe. |\n\n## Returns\n\n[`MediaPlan`](../interfaces/MediaPlan.md)\n\nThe validated plan (no spans).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/functions/validateSegments","title":"Function: validateSegments()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/validateSegments.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/functions/validateSegments","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/validateSegments.md\n---\n\n# Function: validateSegments()\n\n```ts\nfunction validateSegments(\n segments: readonly RawSegment[],\n options: ValidateOptions,\n): MediaPlan;\n```\n\nDefined in: [src/batteries/media/validate.ts:286](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L286)\n\nValidate raw pipe segments into a [MediaPlan](../interfaces/MediaPlan.md).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------- | ------------------------------------------------------ | ---------------------------------- |\n| `segments` | readonly [`RawSegment`](../interfaces/RawSegment.md)\\[] | Output of `parsePipeRaw`. |\n| `options` | [`ValidateOptions`](../interfaces/ValidateOptions.md) | The deployment's capability probe. |\n\n## Returns\n\n[`MediaPlan`](../interfaces/MediaPlan.md)\n\nThe validated plan, spans preserved.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/AudioNamespace","title":"Interface: AudioNamespace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/AudioNamespace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/AudioNamespace","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/AudioNamespace.md'\ndescription: '`audio.*` verbs.'\n---\n\n# Interface: AudioNamespace\n\nDefined in: [src/batteries/media/builder.ts:440](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L440)\n\n`audio.*` verbs.\n\n## Methods\n\n### transcribe()\n\n```ts\ntranscribe(options?: {\n language?: string;\n out?: \"json\" | \"txt\" | \"srt\" | \"vtt\";\n translate?: boolean;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:446](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L446)\n\nTranscribe speech. Terminal: resolves to text (or srt/vtt/json per `out`).\n\n#### Parameters\n\n| Parameter | Type |\n| -------------------- | -------------------------------------------------------------------------------------------------------- |\n| `options` | { `language?`: `string`; `out?`: `\"json\"` | `\"txt\"` | `\"srt\"` | `\"vtt\"`; `translate?`: `boolean`; } |\n| `options.language?` | `string` |\n| `options.out?` | `\"json\"` | `\"txt\"` | `\"srt\"` | `\"vtt\"` |\n| `options.translate?` | `boolean` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/CapabilityProbe","title":"Interface: CapabilityProbe","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/CapabilityProbe.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/CapabilityProbe","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/CapabilityProbe.md\ndescription: >-\n The minimal synchronous capability probe the validator narrows against. The\n pipeline's engine registry implements it; tests stub it.\n---\n\n# Interface: CapabilityProbe\n\nDefined in: [src/batteries/media/validate.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L32)\n\nThe minimal synchronous capability probe the validator narrows against. The pipeline's\nengine registry implements it; tests stub it.\n\n## Extended by\n\n* [`EngineRegistry`](EngineRegistry.md)\n\n## Methods\n\n### hasConvert()\n\n```ts\nhasConvert(from?: string, to?: string): boolean;\n```\n\nDefined in: [src/batteries/media/validate.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L34)\n\n`true` when some engine declares a matching convert edge (omit either side for \"any\").\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `from?` | `string` |\n| `to?` | `string` |\n\n#### Returns\n\n`boolean`\n\n***\n\n### hasEdit()?\n\n```ts\noptional hasEdit(mime?: string, op?: string): boolean;\n```\n\nDefined in: [src/batteries/media/validate.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L41)\n\n`true` when some engine declares a matching edit capability (omit both for \"any\").\nOptional so existing probe stubs stay valid; absent means \"no edit engines\".\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `mime?` | `string` |\n| `op?` | `string` |\n\n#### Returns\n\n`boolean`\n\n***\n\n### hasMutate()\n\n```ts\nhasMutate(): boolean;\n```\n\nDefined in: [src/batteries/media/validate.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L36)\n\n`true` when some engine declares a mutate capability.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/CellUpdate","title":"Interface: CellUpdate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/CellUpdate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/CellUpdate","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/CellUpdate.md'\ndescription: A cell update for `sheet.updateCells`.\n---\n\n# Interface: CellUpdate\n\nDefined in: [src/batteries/media/builder.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L35)\n\nA cell update for `sheet.updateCells`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | ------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |\n| `address?` | `string` | A1-notation address, e.g. `B2`. Alternative to row/col. | [src/batteries/media/builder.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L37) |\n| `col?` | `string` | `number` | One-based column index, or a column letter. Pair with `row`. | [src/batteries/media/builder.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L41) |\n| `row?` | `number` | One-based row index. Pair with `col`. | [src/batteries/media/builder.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L39) |\n| `value` | `string` | `number` | `boolean` | `null` | The value to set. A leading `=` writes a formula. | [src/batteries/media/builder.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L43) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/EngineRegistry","title":"Interface: EngineRegistry","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/EngineRegistry.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/EngineRegistry","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/EngineRegistry.md'\ndescription: Ordered capability-filtered dispatch over the pipeline's engines.\n---\n\n# Interface: EngineRegistry\n\nDefined in: [src/batteries/media/registry.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L117)\n\nOrdered capability-filtered dispatch over the pipeline's engines.\n\n## Extends\n\n* [`CapabilityProbe`](CapabilityProbe.md)\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------------- | ---------- | ------------------------------------------------------------------ | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `engines` | `readonly` | readonly [`MediaEngine`](../contracts/interfaces/MediaEngine.md)\\[] | The resolved engines, in supply order (inspection/debugging). | [src/batteries/media/registry.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L119) |\n\n## Methods\n\n### convert()\n\n```ts\nconvert(request: ConvertRequest): Promise;\n```\n\nDefined in: [src/batteries/media/registry.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L135)\n\nConvert via the shortest capable path (direct edge = one hop). The selection rule picks\nthe engine for each executed hop; options are forwarded to every hop (engines ignore\nkeys they don't understand).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------- | ------------------------------------------- |\n| `request` | [`ConvertRequest`](../contracts/interfaces/ConvertRequest.md) | The input bytes, target token, and options. |\n\n#### Returns\n\n`Promise`<[`ConvertResult`](../contracts/interfaces/ConvertResult.md)>\n\nThe final hop's outputs.\n\n***\n\n### convertTargets()\n\n```ts\nconvertTargets(fromMime: string): readonly string[];\n```\n\nDefined in: [src/batteries/media/registry.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L126)\n\nEvery format token reachable from `fromMime` — directly or through a computed path of up\nto three hops. Drives \"supported targets\" error messages.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ---------- | -------- | -------------------- |\n| `fromMime` | `string` | The input MIME type. |\n\n#### Returns\n\nreadonly `string`\\[]\n\n***\n\n### edit()\n\n```ts\nedit(request: EditRequest): Promise;\n```\n\nDefined in: [src/batteries/media/registry.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L153)\n\nApply one structural document operation. Candidates are engines whose `over` matches the\ninput and whose `ops` include the requested op; the selection rule arbitrates between\nengines of differing fidelity (supply order wins by default).\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------- | -------------------------------------- |\n| `request` | [`EditRequest`](../contracts/interfaces/EditRequest.md) | The op, its args, and the input bytes. |\n\n#### Returns\n\n`Promise`<[`EditResult`](../contracts/interfaces/EditResult.md)>\n\nThe restructured bytes plus optional change counts.\n\n***\n\n### hasConvert()\n\n```ts\nhasConvert(from?: string, to?: string): boolean;\n```\n\nDefined in: [src/batteries/media/validate.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L34)\n\n`true` when some engine declares a matching convert edge (omit either side for \"any\").\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `from?` | `string` |\n| `to?` | `string` |\n\n#### Returns\n\n`boolean`\n\n#### Inherited from\n\n[`CapabilityProbe`](CapabilityProbe.md).[`hasConvert`](CapabilityProbe.md#hasconvert)\n\n***\n\n### hasEdit()?\n\n```ts\noptional hasEdit(mime?: string, op?: string): boolean;\n```\n\nDefined in: [src/batteries/media/validate.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L41)\n\n`true` when some engine declares a matching edit capability (omit both for \"any\").\nOptional so existing probe stubs stay valid; absent means \"no edit engines\".\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `mime?` | `string` |\n| `op?` | `string` |\n\n#### Returns\n\n`boolean`\n\n#### Inherited from\n\n[`CapabilityProbe`](CapabilityProbe.md).[`hasEdit`](CapabilityProbe.md#hasedit)\n\n***\n\n### hasMutate()\n\n```ts\nhasMutate(): boolean;\n```\n\nDefined in: [src/batteries/media/validate.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L36)\n\n`true` when some engine declares a mutate capability.\n\n#### Returns\n\n`boolean`\n\n#### Inherited from\n\n[`CapabilityProbe`](CapabilityProbe.md).[`hasMutate`](CapabilityProbe.md#hasmutate)\n\n***\n\n### mutate()\n\n```ts\nmutate(request: MutateRequest): Promise;\n```\n\nDefined in: [src/batteries/media/registry.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L144)\n\nApply a fused same-format transform. Candidates are engines whose `over` matches the\ninput, whose `ops` cover the requested operations, and — when a re-encode is requested —\nwhose `encodes` include the target.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------- | ------------------------------------- |\n| `request` | [`MutateRequest`](../contracts/interfaces/MutateRequest.md) | The fused operations and input bytes. |\n\n#### Returns\n\n`Promise`<[`EngineBytesResult`](../contracts/interfaces/EngineBytesResult.md)>\n\nThe transformed bytes.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/EngineSelectionContext","title":"Interface: EngineSelectionContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/EngineSelectionContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/EngineSelectionContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/EngineSelectionContext.md\ndescription: >-\n The request summary a selection stage sees: enough to implement content- and\n format-dependent rules without exposing dispatch internals.\n---\n\n# Interface: EngineSelectionContext\n\nDefined in: [src/batteries/media/registry.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L80)\n\nThe request summary a selection stage sees: enough to implement content- and\nformat-dependent rules without exposing dispatch internals.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `candidates` | [`MediaEngine`](../contracts/interfaces/MediaEngine.md)\\[] | The capable engines, in supply order. Stages may exclude or reorder (mutate in place or reassign); survivors are re-filtered against the original capable set, so a stage can never add an engine the capability filter rejected. | [src/batteries/media/registry.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L101) |\n| `kind` | `\"convert\"` | `\"mutate\"` | `\"edit\"` | Which capability is being dispatched. | [src/batteries/media/registry.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L82) |\n| `request` | { `bytes`: `Uint8Array`; `filename`: `string`; `mimeType`: `string`; `ops?`: readonly `string`\\[]; `to?`: `string`; } | The dispatch request (for convert under multi-hop, the CURRENT hop's input/target). | [src/batteries/media/registry.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L84) |\n| `request.bytes` | `Uint8Array` | The input bytes — content-dependent rules (e.g. workbook complexity) need them. | [src/batteries/media/registry.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L90) |\n| `request.filename` | `string` | The input filename. | [src/batteries/media/registry.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L88) |\n| `request.mimeType` | `string` | The input MIME type. | [src/batteries/media/registry.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L86) |\n| `request.ops?` | readonly `string`\\[] | The requested mutate operations. | [src/batteries/media/registry.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L94) |\n| `request.to?` | `string` | The convert target token, or the mutate `format.to` when a re-encode was requested. | [src/batteries/media/registry.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L92) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ImageNamespace","title":"Interface: ImageNamespace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ImageNamespace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ImageNamespace","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/ImageNamespace.md'\ndescription: '`image.*` verbs (the runtime fuses adjacent image steps into one engine pass).'\n---\n\n# Interface: ImageNamespace\n\nDefined in: [src/batteries/media/builder.ts:402](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L402)\n\n`image.*` verbs (the runtime fuses adjacent image steps into one engine pass).\n\n## Methods\n\n### annotate()\n\n```ts\nannotate(shapes: ImageAnnotation[]): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:434](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L434)\n\nDraw vector primitives and text over the image.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `shapes` | [`ImageAnnotation`](../contracts/type-aliases/ImageAnnotation.md)\\[] |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### flip()\n\n```ts\nflip(axis: \"both\" | \"horizontal\" | \"vertical\"): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:426](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L426)\n\nFlip.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------ |\n| `axis` | `\"both\"` | `\"horizontal\"` | `\"vertical\"` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### format()\n\n```ts\nformat(to: string, options?: {\n quality?: number;\n stripMetadata?: boolean;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:415](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L415)\n\nRe-encode to another format.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------------ | -------------------------------------------------------- |\n| `to` | `string` |\n| `options` | { `quality?`: `number`; `stripMetadata?`: `boolean`; } |\n| `options.quality?` | `number` |\n| `options.stripMetadata?` | `boolean` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### resize()\n\n```ts\nresize(options: ResizeOptions): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L408)\n\nResize.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------- |\n| `options` | [`ResizeOptions`](ResizeOptions.md) |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### rotate()\n\n```ts\nrotate(deg: 90 | 180 | 270): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:422](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L422)\n\nRotate clockwise.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------------------- |\n| `deg` | `90` | `180` | `270` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### stripMetadata()\n\n```ts\nstripMetadata(): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:430](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L430)\n\nStrip EXIF/ICC metadata.\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaOp","title":"Interface: MediaOp","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaOp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaOp","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/MediaOp.md'\ndescription: >-\n The JSON ops front-end's step shape — identical to [`MediaStep`](https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/MediaStep) minus the\n span.\n---\n\n# Interface: MediaOp\n\nDefined in: [src/batteries/media/plan.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L101)\n\nThe JSON ops front-end's step shape — identical to [MediaStep](MediaStep.md) minus the span.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`MediaArgValue`](../type-aliases/MediaArgValue.md)> | The verb's named args. | [src/batteries/media/plan.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L105) |\n| `verb` | `string` | The canonical (or foldable) verb id. | [src/batteries/media/plan.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L103) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPipeline","title":"Interface: MediaPipeline()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPipeline","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/MediaPipeline.md'\ndescription: >-\n The callable pipeline returned by [`createMediaPipeline`](https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/createMediaPipeline): `mp(payload)`\n opens a chainable builder; `mp.query(payload, q)` runs a pipe-string\n statement;\n---\n\n# Interface: MediaPipeline()\n\nDefined in: [src/batteries/media/index.ts:212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L212)\n\nThe callable pipeline returned by [createMediaPipeline](../functions/createMediaPipeline.md): `mp(payload)` opens a\nchainable builder; `mp.query(payload, q)` runs a pipe-string statement; `mp.ops(payload,\nops)` runs a JSON ops array. All three compile to the same plan and execute on the same\nruntime.\n\n```ts\nMediaPipeline(input: StepPayload): MediaChain;\n```\n\nDefined in: [src/batteries/media/index.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L214)\n\nOpen a fresh chainable builder over `input`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------- |\n| `input` | [`StepPayload`](StepPayload.md) |\n\n## Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------- | ---------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| `capabilities` | `readonly` | [`EngineRegistry`](EngineRegistry.md) | The deployment's engine registry (drives verb narrowing AND generation/edit dispatch — the runtime value has always been the registry; the declared type now says so). | [src/batteries/media/index.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L225) |\n| `engines` | `readonly` | readonly [`MediaEngine`](../contracts/interfaces/MediaEngine.md)\\[] | The resolved engines, in supply order — inspect ids and declared capabilities. | [src/batteries/media/index.ts:227](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L227) |\n\n## Methods\n\n### compile()\n\n```ts\ncompile(statement: string | MediaOp[]): MediaPlan;\n```\n\nDefined in: [src/batteries/media/index.ts:220](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L220)\n\nValidate a pipe string or ops array to a plan WITHOUT executing (dry-run/compile).\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------------- |\n| `statement` | `string` | [`MediaOp`](MediaOp.md)\\[] |\n\n#### Returns\n\n[`MediaPlan`](MediaPlan.md)\n\n***\n\n### ops()\n\n```ts\nops(\n input: StepPayload,\n ops: MediaOp[],\noptions?: RunOptions): Promise;\n```\n\nDefined in: [src/batteries/media/index.ts:218](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L218)\n\nValidate and execute a JSON ops array.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------- |\n| `input` | [`StepPayload`](StepPayload.md) |\n| `ops` | [`MediaOp`](MediaOp.md)\\[] |\n| `options?` | [`RunOptions`](RunOptions.md) |\n\n#### Returns\n\n`Promise`<[`StepResult`](../type-aliases/StepResult.md)>\n\n***\n\n### query()\n\n```ts\nquery(\n input: StepPayload,\n q: string,\noptions?: RunOptions): Promise;\n```\n\nDefined in: [src/batteries/media/index.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L216)\n\nParse, validate, and execute a pipe-string statement.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | ------------------------------- |\n| `input` | [`StepPayload`](StepPayload.md) |\n| `q` | `string` |\n| `options?` | [`RunOptions`](RunOptions.md) |\n\n#### Returns\n\n`Promise`<[`StepResult`](../type-aliases/StepResult.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPipelineConfig","title":"Interface: MediaPipelineConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPipelineConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPipelineConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/MediaPipelineConfig.md\ndescription: 'Configuration for [`createMediaPipeline`](https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/createMediaPipeline).'\n---\n\n# Interface: MediaPipelineConfig\n\nDefined in: [src/batteries/media/index.ts:178](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L178)\n\nConfiguration for [createMediaPipeline](../functions/createMediaPipeline.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| `engines?` | readonly [`EngineResolver`](../contracts/type-aliases/EngineResolver.md)<[`MediaEngine`](../contracts/interfaces/MediaEngine.md)>\\[] | The engine array, in priority order. Each entry is a [MediaEngine](../contracts/interfaces/MediaEngine.md) instance or a resolver returning one (async dynamic import is the canonical form). Engines self-declare their capabilities; verbs whose capability has no provider are not advertised and fail validation with a do-not-retry message if reached. Resolvers run eagerly at construction — bundled engines stay cheap because their heavy peers lazy-load inside capability methods. | [src/batteries/media/index.ts:186](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L186) |\n| `resolveRef?` | [`MediaRefResolver`](../type-aliases/MediaRefResolver.md) | Resolves `@id` media refs (merge/diff/replace targets). Required only when chains use multi-input verbs; the agent forge supplies a turn-state resolver automatically. | [src/batteries/media/index.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L203) |\n| `selection?` | [`EngineSelectionMiddlewareFn`](../type-aliases/EngineSelectionMiddlewareFn.md)\\[] | Selection-middleware stages arbitrating dispatches where several engines can perform the same transform. Stages may exclude or reorder candidates (quality heuristics, overrides); array order among survivors always breaks the tie. Most deployments need none. | [src/batteries/media/index.ts:192](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L192) |\n| `use?` | [`MediaStepMiddlewareFn`](../type-aliases/MediaStepMiddlewareFn.md)\\[] | Consumer step interceptors wrapping every step — the documented seam for DLP/AV byte scanning, caching (via `ctx.shortCircuit`), byte limits, and telemetry. The battery ships no built-in scanner/cache/limiter. | [src/batteries/media/index.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L198) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPlan","title":"Interface: MediaPlan","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPlan.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaPlan","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/MediaPlan.md'\ndescription: 'The neutral plan: an ordered, linear list of steps. No branching.'\n---\n\n# Interface: MediaPlan\n\nDefined in: [src/batteries/media/plan.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L95)\n\nThe neutral plan: an ordered, linear list of steps. No branching.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | ----------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `steps` | [`MediaStep`](MediaStep.md)\\[] | The ordered transform steps. | [src/batteries/media/plan.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L97) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaStep","title":"Interface: MediaStep","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaStep.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/MediaStep","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/MediaStep.md'\ndescription: 'One transform step: a canonical verb id plus its validated content args.'\n---\n\n# Interface: MediaStep\n\nDefined in: [src/batteries/media/plan.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L82)\n\nOne transform step: a canonical verb id plus its validated content args.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`MediaArgValue`](../type-aliases/MediaArgValue.md)> | Validated content args for this verb. | [src/batteries/media/plan.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L89) |\n| `span?` | [`SourceSpan`](SourceSpan.md) | Present when the step came from a pipe string; absent for builder/ops origins. | [src/batteries/media/plan.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L91) |\n| `verb` | `string` | Canonical verb id — dot-namespaced snake\\_case (`convert`, `select`, `extract.text`, `sheet.update_cells`, `image.resize`). | [src/batteries/media/plan.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L87) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RawArgValue","title":"Interface: RawArgValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RawArgValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RawArgValue","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/RawArgValue.md'\ndescription: 'A parsed-but-unvalidated arg value, before the verb''s arg schema refines it.'\n---\n\n# Interface: RawArgValue\n\nDefined in: [src/batteries/media/pipe.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L96)\n\nA parsed-but-unvalidated arg value, before the verb's arg schema refines it.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |\n| `quoted` | `boolean` | Whether the source token was a quoted string (drives json-arg parsing + name/index rules). | [src/batteries/media/pipe.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L100) |\n| `span` | [`SourceSpan`](SourceSpan.md) | Source position of the value token. | [src/batteries/media/pipe.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L102) |\n| `value` | [`MediaArgValue`](../type-aliases/MediaArgValue.md) | The lowered value. Quoted strings stay strings here; schema may JSON-parse `json` args. | [src/batteries/media/pipe.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L98) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RawSegment","title":"Interface: RawSegment","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RawSegment.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RawSegment","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/RawSegment.md'\ndescription: 'One parsed segment: verb words plus named args, all position-bearing.'\n---\n\n# Interface: RawSegment\n\nDefined in: [src/batteries/media/pipe.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L106)\n\nOne parsed segment: verb words plus named args, all position-bearing.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| `args` | `Map`<`string`, [`RawArgValue`](RawArgValue.md)> | The parsed named args, in source order. | [src/batteries/media/pipe.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L112) |\n| `known` | `boolean` | Whether `verb` resolved against the verb table. | [src/batteries/media/pipe.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L110) |\n| `span` | [`SourceSpan`](SourceSpan.md) | Source position of the verb token(s). | [src/batteries/media/pipe.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L114) |\n| `verb` | `string` | Canonical verb id when fold-matching succeeded, else the raw folded text. | [src/batteries/media/pipe.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/pipe.ts#L108) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RegExpRef","title":"Interface: RegExpRef","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RegExpRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RegExpRef","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/RegExpRef.md'\ndescription: A serializable regex reference. Never a live `RegExp` in the IR.\n---\n\n# Interface: RegExpRef\n\nDefined in: [src/batteries/media/plan.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L24)\n\nA serializable regex reference. Never a live `RegExp` in the IR.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | -------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `flags` | `string` | Sorted flag characters (canonicalized — `gi`, never `ig`). | [src/batteries/media/plan.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L28) |\n| `source` | `string` | The regex source, exactly as `RegExp.prototype.source` would report it. | [src/batteries/media/plan.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L26) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ResizeOptions","title":"Interface: ResizeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ResizeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ResizeOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/ResizeOptions.md'\ndescription: Options accepted by image resize.\n---\n\n# Interface: ResizeOptions\n\nDefined in: [src/batteries/media/builder.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L25)\n\nOptions accepted by image resize.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------- | ----------------------------------------------------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `fit?` | `\"fill\"` | `\"cover\"` | `\"contain\"` | `\"inside\"` | `\"outside\"` | Resize fit mode (default cover). | [src/batteries/media/builder.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L31) |\n| `height?` | `number` | Target height in pixels. | [src/batteries/media/builder.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L29) |\n| `width?` | `number` | Target width in pixels. | [src/batteries/media/builder.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L27) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RunOptions","title":"Interface: RunOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RunOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/RunOptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/RunOptions.md'\ndescription: Per-run options for `query`/`ops`.\n---\n\n# Interface: RunOptions\n\nDefined in: [src/batteries/media/index.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L170)\n\nPer-run options for `query`/`ops`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| `resolveRef?` | [`MediaRefResolver`](../type-aliases/MediaRefResolver.md) | Per-run media-ref resolution, overriding the construction-time resolver (the agent forge uses this to resolve `@id` refs against the current turn). | [src/batteries/media/index.ts:174](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L174) |\n| `signal?` | `AbortSignal` | Abort signal threaded into steps and engines. | [src/batteries/media/index.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L172) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SheetNamespace","title":"Interface: SheetNamespace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SheetNamespace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SheetNamespace","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/SheetNamespace.md'\ndescription: '`sheet.*` verbs, mirrored from the verb table.'\n---\n\n# Interface: SheetNamespace\n\nDefined in: [src/batteries/media/builder.ts:242](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L242)\n\n`sheet.*` verbs, mirrored from the verb table.\n\n## Methods\n\n### addColumns()\n\n```ts\naddColumns(options: {\n after?: number;\n before?: number;\n columns?: {\n header: string;\n values?: (string | number | boolean | null)[];\n }[];\n headers?: string[];\n sheet?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L263)\n\nInsert columns.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `options` | { `after?`: `number`; `before?`: `number`; `columns?`: { `header`: `string`; `values?`: (`string` | `number` | `boolean` | `null`)\\[]; }\\[]; `headers?`: `string`\\[]; `sheet?`: `string` | `number`; } |\n| `options.after?` | `number` |\n| `options.before?` | `number` |\n| `options.columns?` | { `header`: `string`; `values?`: (`string` | `number` | `boolean` | `null`)\\[]; }\\[] |\n| `options.headers?` | `string`\\[] |\n| `options.sheet?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### addRows()\n\n```ts\naddRows(rows: (string | number | boolean | null)[][], options?: {\n after?: number;\n before?: number;\n sheet?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:248](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L248)\n\nInsert rows.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------- | ------------------------------------------------------------------------------ |\n| `rows` | (`string` | `number` | `boolean` | `null`)\\[]\\[] |\n| `options` | { `after?`: `number`; `before?`: `number`; `sheet?`: `string` | `number`; } |\n| `options.after?` | `number` |\n| `options.before?` | `number` |\n| `options.sheet?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### addSheet()\n\n```ts\naddSheet(name: string, options?: {\n at?: number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:301](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L301)\n\nAdd a worksheet.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | ---------------------- |\n| `name` | `string` |\n| `options` | { `at?`: `number`; } |\n| `options.at?` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### deleteColumns()\n\n```ts\ndeleteColumns(columns: number[], options?: {\n sheet?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:293](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L293)\n\nDelete columns by 1-based index.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------- | ------------------------------------- |\n| `columns` | `number`\\[] |\n| `options` | { `sheet?`: `string` | `number`; } |\n| `options.sheet?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### deleteRows()\n\n```ts\ndeleteRows(rows: number[], options?: {\n sheet?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:289](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L289)\n\nDelete rows by 1-based index.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------- | ------------------------------------- |\n| `rows` | `number`\\[] |\n| `options` | { `sheet?`: `string` | `number`; } |\n| `options.sheet?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### removeSheet()\n\n```ts\nremoveSheet(sheet: string): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:305](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L305)\n\nRemove a worksheet (name-targeted).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `sheet` | `string` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### renameSheet()\n\n```ts\nrenameSheet(sheet: string, to: string): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:297](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L297)\n\nRename a worksheet (name-targeted).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `sheet` | `string` |\n| `to` | `string` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### reorderSheets()\n\n```ts\nreorderSheets(order: (string | number)[]): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L309)\n\nReorder worksheets by names and/or 1-based indices.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------ |\n| `order` | (`string` | `number`)\\[] |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### transformTable()\n\n```ts\ntransformTable(options: {\n drop?: string[];\n headerRow?: number;\n rename?: {\n from: string;\n to: string;\n }[];\n select?: string[];\n sheet?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:313](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L313)\n\nTable transforms by header name.\n\n#### Parameters\n\n| Parameter | Type |\n| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `options` | { `drop?`: `string`\\[]; `headerRow?`: `number`; `rename?`: { `from`: `string`; `to`: `string`; }\\[]; `select?`: `string`\\[]; `sheet?`: `string` | `number`; } |\n| `options.drop?` | `string`\\[] |\n| `options.headerRow?` | `number` |\n| `options.rename?` | { `from`: `string`; `to`: `string`; }\\[] |\n| `options.select?` | `string`\\[] |\n| `options.sheet?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### updateCells()\n\n```ts\nupdateCells(updates: CellUpdate[], options?: {\n sheet?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L282)\n\nUpdate cells.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------- | ------------------------------------- |\n| `updates` | [`CellUpdate`](CellUpdate.md)\\[] |\n| `options` | { `sheet?`: `string` | `number`; } |\n| `options.sheet?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SlidesNamespace","title":"Interface: SlidesNamespace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SlidesNamespace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SlidesNamespace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/SlidesNamespace.md\ndescription: '`slides.*` verbs.'\n---\n\n# Interface: SlidesNamespace\n\nDefined in: [src/batteries/media/builder.ts:334](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L334)\n\n`slides.*` verbs.\n\n## Methods\n\n### add()\n\n```ts\nadd(options?: {\n at?: number;\n layout?: string;\n title?: string;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:340](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L340)\n\nAdd a slide.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------- | --------------------------------------------------------------- |\n| `options` | { `at?`: `number`; `layout?`: `string`; `title?`: `string`; } |\n| `options.at?` | `number` |\n| `options.layout?` | `string` |\n| `options.title?` | `string` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### delete()\n\n```ts\ndelete(slides: number[]): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:388](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L388)\n\nDelete slides by 1-based index.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------- |\n| `slides` | `number`\\[] |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### duplicate()\n\n```ts\nduplicate(slide: number, options?: {\n at?: number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:396](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L396)\n\nDuplicate a slide.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | ---------------------- |\n| `slide` | `number` |\n| `options` | { `at?`: `number`; } |\n| `options.at?` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### reorder()\n\n```ts\nreorder(order: number[]): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:392](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L392)\n\nReorder slides.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------- |\n| `order` | `number`\\[] |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### updateChart()\n\n```ts\nupdateChart(data: unknown[][], options?: {\n slide?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:381](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L381)\n\nUpdate chart data on a slide.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------- | ------------------------------------- |\n| `data` | `unknown`\\[]\\[] |\n| `options` | { `slide?`: `string` | `number`; } |\n| `options.slide?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### updateImage()\n\n```ts\nupdateImage(withMedia: MediaChainRef, options?: {\n placeholder?: string;\n slide?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L367)\n\nReplace an image on a slide with another media.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------------- | --------------------------------------------------------------- |\n| `withMedia` | [`MediaChainRef`](../type-aliases/MediaChainRef.md) |\n| `options` | { `placeholder?`: `string`; `slide?`: `string` | `number`; } |\n| `options.placeholder?` | `string` |\n| `options.slide?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### updateTable()\n\n```ts\nupdateTable(updates: {\n col: number;\n row: number;\n value: string;\n}[], options?: {\n slide?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:357](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L357)\n\nUpdate table cells on a slide.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------- | ------------------------------------------------------------ |\n| `updates` | { `col`: `number`; `row`: `number`; `value`: `string`; }\\[] |\n| `options` | { `slide?`: `string` | `number`; } |\n| `options.slide?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n\n***\n\n### updateText()\n\n```ts\nupdateText(text: string, options?: {\n placeholder?: string;\n slide?: string | number;\n}): MediaChain;\n```\n\nDefined in: [src/batteries/media/builder.ts:347](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L347)\n\nUpdate text on a slide.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------------- | --------------------------------------------------------------- |\n| `text` | `string` |\n| `options` | { `placeholder?`: `string`; `slide?`: `string` | `number`; } |\n| `options.placeholder?` | `string` |\n| `options.slide?` | `string` | `number` |\n\n#### Returns\n\n[`MediaChain`](../classes/MediaChain.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SourceSpan","title":"Interface: SourceSpan","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SourceSpan.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/SourceSpan","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/SourceSpan.md'\ndescription: 'Source span carried by steps parsed from a pipe string, for error mapping.'\n---\n\n# Interface: SourceSpan\n\nDefined in: [src/batteries/media/plan.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L70)\n\nSource span carried by steps parsed from a pipe string, for error mapping.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | -------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| `col` | `number` | One-based column number. | [src/batteries/media/plan.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L76) |\n| `length` | `number` | Length of the spanned text in characters. | [src/batteries/media/plan.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L78) |\n| `line` | `number` | One-based line number. | [src/batteries/media/plan.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L74) |\n| `offset` | `number` | Zero-based character offset into the source string. | [src/batteries/media/plan.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L72) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/StepContext","title":"Interface: StepContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/StepContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/StepContext","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/StepContext.md'\ndescription: The mutable execution context threaded through interceptors and step impls.\n---\n\n# Interface: StepContext\n\nDefined in: [src/batteries/media/runtime.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L49)\n\nThe mutable execution context threaded through interceptors and step impls.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------- | ---------- | ------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `engines` | `readonly` | [`EngineRegistry`](EngineRegistry.md) | The deployment's engine registry — ordered, capability-filtered dispatch. | [src/batteries/media/runtime.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L68) |\n| `payload` | `public` | [`StepPayload`](StepPayload.md) | The input payload for this step. | [src/batteries/media/runtime.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L57) |\n| `plan` | `readonly` | [`MediaPlan`](MediaPlan.md) | The whole plan being executed. | [src/batteries/media/runtime.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L51) |\n| `signal?` | `readonly` | `AbortSignal` | Abort signal threaded from the caller. | [src/batteries/media/runtime.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L59) |\n| `stash` | `readonly` | `Map`<`string`, `unknown`> | Scratchpad shared across the execution (interceptors may stash timings, hashes…). | [src/batteries/media/runtime.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L61) |\n| `step` | `readonly` | [`MediaStep`](MediaStep.md) | The current step. | [src/batteries/media/runtime.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L55) |\n| `stepIndex` | `readonly` | `number` | Zero-based index of the current step. | [src/batteries/media/runtime.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L53) |\n\n## Methods\n\n### resolveRef()\n\n```ts\nresolveRef(id: string): Promise;\n```\n\nDefined in: [src/batteries/media/runtime.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L73)\n\nResolve another media participating in this step (merge/diff targets), by ref id.\nSupplied by the pipeline from its configured media resolver.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `id` | `string` |\n\n#### Returns\n\n`Promise`<[`StepPayload`](StepPayload.md)>\n\n***\n\n### shortCircuit()\n\n```ts\nshortCircuit(payload: StepPayload): never;\n```\n\nDefined in: [src/batteries/media/runtime.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L66)\n\nShort-circuit this step: skip the implementation and continue the chain with `bytes`\n(the cache idiom). Throws internally — call it, don't return it.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------- |\n| `payload` | [`StepPayload`](StepPayload.md) |\n\n#### Returns\n\n`never`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/StepPayload","title":"Interface: StepPayload","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/StepPayload.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/StepPayload","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/StepPayload.md'\ndescription: A single in-flight value travelling between steps.\n---\n\n# Interface: StepPayload\n\nDefined in: [src/batteries/media/runtime.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L30)\n\nA single in-flight value travelling between steps.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The raw content bytes. | [src/batteries/media/runtime.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L32) |\n| `filename` | `string` | The filename (extension informs format dispatch). | [src/batteries/media/runtime.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L36) |\n| `mimeType` | `string` | The content MIME type. | [src/batteries/media/runtime.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L34) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ValidateOptions","title":"Interface: ValidateOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ValidateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/ValidateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/ValidateOptions.md\ndescription: 'Options for [`validateSegments`](https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/validateSegments) / [`validateOps`](https://adk.nht.io/api/@nhtio/adk/batteries/media/functions/validateOps).'\n---\n\n# Interface: ValidateOptions\n\nDefined in: [src/batteries/media/validate.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L45)\n\nOptions for [validateSegments](../functions/validateSegments.md) / [validateOps](../functions/validateOps.md).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `capabilities` | [`CapabilityProbe`](CapabilityProbe.md) | The deployment's capabilities. Narrows advertised verbs + error suggestions. | [src/batteries/media/validate.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/validate.ts#L47) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/VerbArgSpec","title":"Interface: VerbArgSpec","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/VerbArgSpec.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/VerbArgSpec","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/VerbArgSpec.md'\ndescription: Declaration of one named arg on a verb.\n---\n\n# Interface: VerbArgSpec\n\nDefined in: [src/batteries/media/verbs.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L38)\n\nDeclaration of one named arg on a verb.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | ----------------------------------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| `description` | `string` | Model-facing description used in generated tool grammar text. | [src/batteries/media/verbs.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L50) |\n| `max?` | `number` | Inclusive maximum for numbers / per-element for number lists. | [src/batteries/media/verbs.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L48) |\n| `min?` | `number` | Inclusive minimum for numbers / per-element for number lists. | [src/batteries/media/verbs.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L46) |\n| `required?` | `boolean` | Whether the statement must supply this arg. | [src/batteries/media/verbs.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L42) |\n| `type` | [`VerbArgType`](../type-aliases/VerbArgType.md) | The arg's value type. | [src/batteries/media/verbs.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L40) |\n| `values?` | readonly `string`\\[] | Legal values when `type === 'enum'` (or per-element for list types). | [src/batteries/media/verbs.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L44) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/VerbSpec","title":"Interface: VerbSpec","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/VerbSpec.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/interfaces/VerbSpec","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/interfaces/VerbSpec.md'\ndescription: One verb table entry.\n---\n\n# Interface: VerbSpec\n\nDefined in: [src/batteries/media/verbs.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L76)\n\nOne verb table entry.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| `appliesTo` | readonly [`FormatFamily`](../type-aliases/FormatFamily.md)\\[] | Input families the verb applies to. | [src/batteries/media/verbs.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L90) |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`VerbArgSpec`](VerbArgSpec.md)> | Named args (named-only grammar; no positionals). | [src/batteries/media/verbs.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L82) |\n| `description` | `string` | Model-facing one-line description. | [src/batteries/media/verbs.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L80) |\n| `id` | `string` | Canonical id: dot-namespaced snake\\_case (`extract.text`, `sheet.update_cells`). | [src/batteries/media/verbs.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L78) |\n| `output` | [`VerbOutput`](../type-aliases/VerbOutput.md) | Output kind. May be refined by an `out`-style arg (documented per verb). | [src/batteries/media/verbs.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L92) |\n| `requires?` | [`VerbRequirement`](../type-aliases/VerbRequirement.md) | Capability the verb always requires, if any — gates whether the verb is advertised and accepted under a given engine configuration. Input-conditional needs are handled (and error-messaged) by the step implementation at runtime. | [src/batteries/media/verbs.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L88) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/ChainExecutor","title":"Type Alias: ChainExecutor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/ChainExecutor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/ChainExecutor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/ChainExecutor.md\ndescription: >-\n The function a builder calls to execute its accumulated ops. Bound by the\n pipeline.\n---\n\n# Type Alias: ChainExecutor\n\n```ts\ntype ChainExecutor = (ops: MediaOp[]) => Promise;\n```\n\nDefined in: [src/batteries/media/builder.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L22)\n\nThe function a builder calls to execute its accumulated ops. Bound by the pipeline.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------- |\n| `ops` | [`MediaOp`](../interfaces/MediaOp.md)\\[] |\n\n## Returns\n\n`Promise`<[`PlanResult`](PlanResult.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/ChainInput","title":"Type Alias: ChainInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/ChainInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/ChainInput","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/ChainInput.md'\ndescription: The input shapes `mp(...)` accepts.\n---\n\n# Type Alias: ChainInput\n\n```ts\ntype ChainInput = StepPayload;\n```\n\nDefined in: [src/batteries/media/builder.ts:472](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L472)\n\nThe input shapes `mp(...)` accepts.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/EngineSelectionMiddlewareFn","title":"Type Alias: EngineSelectionMiddlewareFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/EngineSelectionMiddlewareFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/EngineSelectionMiddlewareFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/EngineSelectionMiddlewareFn.md\ndescription: >-\n A selection-middleware stage — the seam for quality heuristics and implementor\n overrides when several engines can perform the same transform (e.g. route\n complex workbooks past a pure-JS converter to LibreOffice). Same onion shape\n as the battery's `use` interceptors; a fresh runner is minted per dispatch.\n Keep stages cheap or memoized: they run with bytes in hand on every dispatch.\n---\n\n# Type Alias: EngineSelectionMiddlewareFn\n\n```ts\ntype EngineSelectionMiddlewareFn = (\n ctx: EngineSelectionContext,\n next: NextFn,\n) => void | Promise;\n```\n\nDefined in: [src/batteries/media/registry.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/registry.ts#L111)\n\nA selection-middleware stage — the seam for quality heuristics and implementor overrides\nwhen several engines can perform the same transform (e.g. route complex workbooks past a\npure-JS converter to LibreOffice). Same onion shape as the battery's `use` interceptors;\na fresh runner is minted per dispatch. Keep stages cheap or memoized: they run with bytes\nin hand on every dispatch.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `ctx` | [`EngineSelectionContext`](../interfaces/EngineSelectionContext.md) |\n| `next` | `NextFn` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/FormatFamily","title":"Type Alias: FormatFamily","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/FormatFamily.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/FormatFamily","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/FormatFamily.md'\ndescription: Broad input families used for verb-applicability checks.\n---\n\n# Type Alias: FormatFamily\n\n```ts\ntype FormatFamily =\n | \"document\"\n | \"spreadsheet\"\n | \"presentation\"\n | \"image\"\n | \"audio\"\n | \"any\";\n```\n\nDefined in: [src/batteries/media/verbs.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L64)\n\nBroad input families used for verb-applicability checks.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgJson","title":"Type Alias: MediaArgJson","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgJson.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgJson","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/MediaArgJson.md'\ndescription: >-\n A structured (JSON-shaped) arg value. In the pipe surface these are written as\n quoted JSON (`updates='[{\"address\":\"B2\",\"value\":3}]'`); in ops they are plain\n JSON. `null` is legal only inside structured values (cell values), never as a\n top-level scalar.\n---\n\n# Type Alias: MediaArgJson\n\n```ts\ntype MediaArgJson =\n | string\n | number\n | boolean\n | null\n | MediaArgJson[]\n | {\n [key: string]: MediaArgJson;\n };\n```\n\nDefined in: [src/batteries/media/plan.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L51)\n\nA structured (JSON-shaped) arg value. In the pipe surface these are written as quoted JSON\n(`updates='[{\"address\":\"B2\",\"value\":3}]'`); in ops they are plain JSON. `null` is legal only\ninside structured values (cell values), never as a top-level scalar.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgScalar","title":"Type Alias: MediaArgScalar","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgScalar.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgScalar","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/MediaArgScalar.md\ndescription: Scalar arg values the flat pipe grammar can express directly.\n---\n\n# Type Alias: MediaArgScalar\n\n```ts\ntype MediaArgScalar = string | number | boolean | RegExpRef | MediaRef;\n```\n\nDefined in: [src/batteries/media/plan.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L44)\n\nScalar arg values the flat pipe grammar can express directly.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgValue","title":"Type Alias: MediaArgValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaArgValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/MediaArgValue.md\ndescription: The value space of a single verb arg in the IR.\n---\n\n# Type Alias: MediaArgValue\n\n```ts\ntype MediaArgValue = MediaArgScalar | MediaArgScalar[] | MediaArgJson;\n```\n\nDefined in: [src/batteries/media/plan.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L67)\n\nThe value space of a single verb arg in the IR.\n\n## Remarks\n\nFlat lists (`types=image,font` → `['image','font']`) are `MediaArgScalar[]`. Whether a\nvalue parsed from quoted JSON or a flat token is decided by the verb's arg schema — the IR\nstores the final shape only.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaChainRef","title":"Type Alias: MediaChainRef","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaChainRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaChainRef","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/MediaChainRef.md\ndescription: >-\n How other media are referenced from builder verbs: an id string or `{ mediaId\n }`.\n---\n\n# Type Alias: MediaChainRef\n\n```ts\ntype MediaChainRef =\n | string\n | {\n mediaId: string;\n };\n```\n\nDefined in: [src/batteries/media/builder.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/builder.ts#L50)\n\nHow other media are referenced from builder verbs: an id string or `{ mediaId }`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaRef","title":"Type Alias: MediaRef","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaRef","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/MediaRef.md'\ndescription: >-\n A reference to another media participating in a multi-input verb (`merge`,\n `diff`, `apply_patch`, `slides.update_image`).\n---\n\n# Type Alias: MediaRef\n\n```ts\ntype MediaRef =\n | {\n id: string;\n kind: \"id\";\n }\n | {\n kind: \"builder\";\n plan: MediaPlan;\n };\n```\n\nDefined in: [src/batteries/media/plan.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/plan.ts#L41)\n\nA reference to another media participating in a multi-input verb (`merge`, `diff`,\n`apply_patch`, `slides.update_image`).\n\n## Remarks\n\nThe `id` variant is the canonical model-facing form — the pipe syntax is an inline\n`@id` token (`merge with=@018f…`) and the ops form carries the same id. The `builder`\nvariant is implementor-only (a nested chain: `mp(a).diff(mp(b).convert('txt'))`) and is\nnot expressible in a flat pipe string.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaRefResolver","title":"Type Alias: MediaRefResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaRefResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaRefResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/MediaRefResolver.md\ndescription: >-\n Resolves a media-ref id to its payload — supplied by the consumer (or the\n agent forge).\n---\n\n# Type Alias: MediaRefResolver\n\n```ts\ntype MediaRefResolver = (id: string) => StepPayload | Promise;\n```\n\nDefined in: [src/batteries/media/index.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/index.ts#L167)\n\nResolves a media-ref id to its payload — supplied by the consumer (or the agent forge).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `id` | `string` |\n\n## Returns\n\n| [`StepPayload`](../interfaces/StepPayload.md)\n| `Promise`<[`StepPayload`](../interfaces/StepPayload.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaStepMiddlewareFn","title":"Type Alias: MediaStepMiddlewareFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaStepMiddlewareFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/MediaStepMiddlewareFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/MediaStepMiddlewareFn.md\ndescription: >-\n Consumer step interceptor — the `use` seam. Same onion shape as the tool\n batteries.\n---\n\n# Type Alias: MediaStepMiddlewareFn\n\n```ts\ntype MediaStepMiddlewareFn = (\n ctx: StepContext,\n next: NextFn,\n) => void | Promise;\n```\n\nDefined in: [src/batteries/media/runtime.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L80)\n\nConsumer step interceptor — the `use` seam. Same onion shape as the tool batteries.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------- |\n| `ctx` | [`StepContext`](../interfaces/StepContext.md) |\n| `next` | `NextFn` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/PlanResult","title":"Type Alias: PlanResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/PlanResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/PlanResult","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/PlanResult.md'\ndescription: The settled result of executing a whole plan.\n---\n\n# Type Alias: PlanResult\n\n```ts\ntype PlanResult = StepResult;\n```\n\nDefined in: [src/batteries/media/runtime.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L110)\n\nThe settled result of executing a whole plan.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/StepImpl","title":"Type Alias: StepImpl","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/StepImpl.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/StepImpl","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/StepImpl.md'\ndescription: One verb's implementation. Registered into the runtime's step registry.\n---\n\n# Type Alias: StepImpl\n\n```ts\ntype StepImpl = (ctx: StepContext) => Promise;\n```\n\nDefined in: [src/batteries/media/runtime.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L77)\n\nOne verb's implementation. Registered into the runtime's step registry.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------- |\n| `ctx` | [`StepContext`](../interfaces/StepContext.md) |\n\n## Returns\n\n`Promise`<[`StepResult`](StepResult.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/StepResult","title":"Type Alias: StepResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/StepResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/StepResult","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/StepResult.md'\ndescription: >-\n What a step produces. `media` continues the chain (or terminates as bytes);\n `media-list` and `data` are terminal-only shapes enforced by the plan\n compiler.\n---\n\n# Type Alias: StepResult\n\n```ts\ntype StepResult =\n | {\n kind: \"media\";\n payload: StepPayload;\n }\n | {\n kind: \"media-list\";\n payloads: StepPayload[];\n }\n | {\n asText?: string;\n data: unknown;\n kind: \"data\";\n };\n```\n\nDefined in: [src/batteries/media/runtime.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/runtime.ts#L43)\n\nWhat a step produces. `media` continues the chain (or terminates as bytes); `media-list`\nand `data` are terminal-only shapes enforced by the plan compiler.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbArgType","title":"Type Alias: VerbArgType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbArgType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbArgType","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/VerbArgType.md'\ndescription: The value type of a single declared arg.\n---\n\n# Type Alias: VerbArgType\n\n```ts\ntype VerbArgType =\n | \"string\"\n | \"number\"\n | \"boolean\"\n | \"enum\"\n | \"number-list\"\n | \"string-list\"\n | \"regex-or-string-list\"\n | \"name-or-index\"\n | \"media-ref\"\n | \"media-ref-list\"\n | \"json\";\n```\n\nDefined in: [src/batteries/media/verbs.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L24)\n\nThe value type of a single declared arg.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbOutput","title":"Type Alias: VerbOutput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbOutput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbOutput","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/VerbOutput.md'\ndescription: What awaiting a chain ending in this verb resolves to.\n---\n\n# Type Alias: VerbOutput\n\n```ts\ntype VerbOutput = \"media\" | \"media-list\" | \"text\" | \"json\";\n```\n\nDefined in: [src/batteries/media/verbs.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L73)\n\nWhat awaiting a chain ending in this verb resolves to.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbRequirement","title":"Type Alias: VerbRequirement","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbRequirement.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/type-aliases/VerbRequirement","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/type-aliases/VerbRequirement.md\ndescription: >-\n A verb's capability requirement against the deployment's engine registry.\n Verbs with no requirement are always advertised; input-conditional engine\n needs (e.g. `extract.text` needing OCR only for images) stay runtime checks\n inside the step implementation.\n---\n\n# Type Alias: VerbRequirement\n\n```ts\ntype VerbRequirement =\n | {\n capability: \"convert\";\n from?: string;\n to?: string;\n }\n | {\n capability: \"mutate\";\n }\n | {\n capability: \"edit\";\n op?: string;\n };\n```\n\nDefined in: [src/batteries/media/verbs.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L58)\n\nA verb's capability requirement against the deployment's engine registry. Verbs with no\nrequirement are always advertised; input-conditional engine needs (e.g. `extract.text`\nneeding OCR only for images) stay runtime checks inside the step implementation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_INVALID_MEDIA_PIPELINE_CONFIG","title":"Variable: E\\_INVALID\\_MEDIA\\_PIPELINE\\_CONFIG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_INVALID_MEDIA_PIPELINE_CONFIG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_INVALID_MEDIA_PIPELINE_CONFIG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_INVALID_MEDIA_PIPELINE_CONFIG.md\ndescription: >-\n Thrown when `createMediaPipeline` receives an invalid configuration — a\n malformed engine, a resolver that resolved to a value failing its contract\n guard, or an invalid option shape.\n---\n\n# Variable: E\\_INVALID\\_MEDIA\\_PIPELINE\\_CONFIG\n\n```ts\nconst E_INVALID_MEDIA_PIPELINE_CONFIG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L31)\n\nThrown when `createMediaPipeline` receives an invalid configuration — a malformed engine,\na resolver that resolved to a value failing its contract guard, or an invalid option shape.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_BAD_ARG","title":"Variable: E\\_MEDIA\\_BAD\\_ARG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_BAD_ARG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_BAD_ARG","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_BAD_ARG.md'\ndescription: >-\n Thrown when an arg value fails its declared type/enum/constraint — including\n descending ranges, invalid regex sources, malformed embedded JSON, and\n out-of-enum values.\n---\n\n# Variable: E\\_MEDIA\\_BAD\\_ARG\n\n```ts\nconst E_MEDIA_BAD_ARG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L80)\n\nThrown when an arg value fails its declared type/enum/constraint — including descending\nranges, invalid regex sources, malformed embedded JSON, and out-of-enum values.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_ENGINE_REQUIRED","title":"Variable: E\\_MEDIA\\_ENGINE\\_REQUIRED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_ENGINE_REQUIRED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_ENGINE_REQUIRED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_ENGINE_REQUIRED.md\ndescription: >-\n Thrown at plan validation when a verb (or the specific input it is applied to)\n requires an engine that is not configured on this pipeline. The message states\n which engine slot is missing and — when the failure is input-specific — that\n the verb should not be retried on this media in this deployment.\n---\n\n# Variable: E\\_MEDIA\\_ENGINE\\_REQUIRED\n\n```ts\nconst E_MEDIA_ENGINE_REQUIRED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L115)\n\nThrown at plan validation when a verb (or the specific input it is applied to) requires an\nengine that is not configured on this pipeline. The message states which engine slot is\nmissing and — when the failure is input-specific — that the verb should not be retried on\nthis media in this deployment.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_MISSING_ARG","title":"Variable: E\\_MEDIA\\_MISSING\\_ARG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_MISSING_ARG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_MISSING_ARG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_MISSING_ARG.md\ndescription: Thrown when a verb's required arg is absent from the statement.\n---\n\n# Variable: E\\_MEDIA\\_MISSING\\_ARG\n\n```ts\nconst E_MEDIA_MISSING_ARG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L89)\n\nThrown when a verb's required arg is absent from the statement.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_NOT_PIPE_EXPRESSIBLE","title":"Variable: E\\_MEDIA\\_NOT\\_PIPE\\_EXPRESSIBLE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_NOT_PIPE_EXPRESSIBLE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_NOT_PIPE_EXPRESSIBLE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_NOT_PIPE_EXPRESSIBLE.md\ndescription: >-\n Thrown by `toPipe()` when the plan contains constructs the flat pipe grammar\n cannot express — currently only nested-builder media refs. Quoted-JSON\n structured args DO render; use `toOps()` for a total serialization.\n---\n\n# Variable: E\\_MEDIA\\_NOT\\_PIPE\\_EXPRESSIBLE\n\n```ts\nconst E_MEDIA_NOT_PIPE_EXPRESSIBLE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L128)\n\nThrown by `toPipe()` when the plan contains constructs the flat pipe grammar cannot express —\ncurrently only nested-builder media refs. Quoted-JSON structured args DO render; use `toOps()`\nfor a total serialization.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_PIPE_SYNTAX","title":"Variable: E\\_MEDIA\\_PIPE\\_SYNTAX","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_PIPE_SYNTAX.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_PIPE_SYNTAX","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_PIPE_SYNTAX.md\ndescription: >-\n Thrown by `parsePipe` when the pipe expression fails to tokenize or parse. The\n message carries line/col position and a corrective exemplar.\n---\n\n# Variable: E\\_MEDIA\\_PIPE\\_SYNTAX\n\n```ts\nconst E_MEDIA_PIPE_SYNTAX: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L43)\n\nThrown by `parsePipe` when the pipe expression fails to tokenize or parse. The message carries\nline/col position and a corrective exemplar.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_FAILED","title":"Variable: E\\_MEDIA\\_STEP\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_FAILED.md\ndescription: >-\n Thrown by the step runtime when a step implementation fails mid-execution\n (corrupt input, engine error). Carries the underlying error as `cause`.\n---\n\n# Variable: E\\_MEDIA\\_STEP\\_FAILED\n\n```ts\nconst E_MEDIA_STEP_FAILED: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L140)\n\nThrown by the step runtime when a step implementation fails mid-execution (corrupt input,\nengine error). Carries the underlying error as `cause`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_UNAVAILABLE","title":"Variable: E\\_MEDIA\\_STEP\\_UNAVAILABLE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_UNAVAILABLE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_UNAVAILABLE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_STEP_UNAVAILABLE.md\ndescription: >-\n Thrown by the step runtime when a plan step has no registered implementation.\n Distinct from `E_MEDIA_ENGINE_REQUIRED`: this indicates the battery itself\n does not (yet) implement the verb, not that the consumer omitted an engine.\n---\n\n# Variable: E\\_MEDIA\\_STEP\\_UNAVAILABLE\n\n```ts\nconst E_MEDIA_STEP_UNAVAILABLE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L153)\n\nThrown by the step runtime when a plan step has no registered implementation. Distinct from\n`E_MEDIA_ENGINE_REQUIRED`: this indicates the battery itself does not (yet) implement the\nverb, not that the consumer omitted an engine.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_ARG","title":"Variable: E\\_MEDIA\\_UNKNOWN\\_ARG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_ARG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_ARG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_ARG.md\ndescription: >-\n Thrown when a statement passes an arg a verb does not declare. The message\n includes a did-you-mean suggestion and the verb's declared args.\n---\n\n# Variable: E\\_MEDIA\\_UNKNOWN\\_ARG\n\n```ts\nconst E_MEDIA_UNKNOWN_ARG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L68)\n\nThrown when a statement passes an arg a verb does not declare. The message includes a\ndid-you-mean suggestion and the verb's declared args.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_VERB","title":"Variable: E\\_MEDIA\\_UNKNOWN\\_VERB","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_VERB.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_VERB","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNKNOWN_VERB.md\ndescription: >-\n Thrown when a statement names a verb that does not exist in the verb table.\n The message includes a did-you-mean suggestion (Levenshtein over folded verb\n forms, including suffix-word matches) and the list of verbs available in this\n deployment.\n---\n\n# Variable: E\\_MEDIA\\_UNKNOWN\\_VERB\n\n```ts\nconst E_MEDIA_UNKNOWN_VERB: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L56)\n\nThrown when a statement names a verb that does not exist in the verb table. The message\nincludes a did-you-mean suggestion (Levenshtein over folded verb forms, including suffix-word\nmatches) and the list of verbs available in this deployment.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNSUPPORTED_OP","title":"Variable: E\\_MEDIA\\_UNSUPPORTED\\_OP","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNSUPPORTED_OP.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNSUPPORTED_OP","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/E_MEDIA_UNSUPPORTED_OP.md\ndescription: >-\n Thrown at plan validation when a verb cannot apply to the input's format\n family (e.g. a `sheet.*` verb on a PDF), or a namespace verb is used on the\n wrong media kind.\n---\n\n# Variable: E\\_MEDIA\\_UNSUPPORTED\\_OP\n\n```ts\nconst E_MEDIA_UNSUPPORTED_OP: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/media/exceptions.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/exceptions.ts#L101)\n\nThrown at plan validation when a verb cannot apply to the input's format family (e.g. a\n`sheet.*` verb on a PDF), or a namespace verb is used on the wrong media kind.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/EXT_TO_MIME","title":"Variable: EXT\\_TO\\_MIME","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/EXT_TO_MIME.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/EXT_TO_MIME","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/EXT_TO_MIME.md'\ndescription: A small extension → MIME lookup for filenames produced by transforms.\n---\n\n# Variable: EXT\\_TO\\_MIME\n\n```ts\nconst EXT_TO_MIME: Readonly>;\n```\n\nDefined in: [src/batteries/media/formats.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L131)\n\nA small extension → MIME lookup for filenames produced by transforms.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/FOLDED_VERBS","title":"Variable: FOLDED\\_VERBS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/FOLDED_VERBS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/FOLDED_VERBS","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/FOLDED_VERBS.md'\ndescription: >-\n All folded verb word-sequences, for the parser's longest-match verb\n recognition and for generated grammar text.\n---\n\n# Variable: FOLDED\\_VERBS\n\n```ts\nconst FOLDED_VERBS: readonly string[];\n```\n\nDefined in: [src/batteries/media/verbs.ts:840](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L840)\n\nAll folded verb word-sequences, for the parser's longest-match verb recognition and for\ngenerated grammar text.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/MIME","title":"Variable: MIME","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/MIME.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/MIME","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/MIME.md'\ndescription: Well-known MIME constants used across the battery.\n---\n\n# Variable: MIME\n\n```ts\nconst MIME: {\n AVIF: \"image/avif\";\n CSV: \"text/csv\";\n DBF: \"application/x-dbf\";\n DIF: \"application/x-dif\";\n DOC: \"application/msword\";\n DOCX: \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\";\n FODS: \"application/vnd.oasis.opendocument.spreadsheet-flat-xml\";\n HTML: \"text/html\";\n JPEG: \"image/jpeg\";\n JSON: \"application/json\";\n KEYNOTE: \"application/x-iwork-keynote-sffkey\";\n MD: \"text/markdown\";\n MP3: \"audio/mpeg\";\n NUMBERS: \"application/x-iwork-numbers-sffnumbers\";\n ODP: \"application/vnd.oasis.opendocument.presentation\";\n ODS: \"application/vnd.oasis.opendocument.spreadsheet\";\n ODT: \"application/vnd.oasis.opendocument.text\";\n PAGES: \"application/x-iwork-pages-sffpages\";\n PDF: \"application/pdf\";\n PNG: \"image/png\";\n PPT: \"application/vnd.ms-powerpoint\";\n PPTX: \"application/vnd.openxmlformats-officedocument.presentationml.presentation\";\n SYLK: \"application/x-sylk\";\n TIFF: \"image/tiff\";\n TXT: \"text/plain\";\n WAV: \"audio/wav\";\n WEBP: \"image/webp\";\n XLS: \"application/vnd.ms-excel\";\n XLSB: \"application/vnd.ms-excel.sheet.binary.macroEnabled.12\";\n XLSM: \"application/vnd.ms-excel.sheet.macroEnabled.12\";\n XLSX: \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\";\n YAML: \"application/yaml\";\n};\n```\n\nDefined in: [src/batteries/media/formats.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L19)\n\nWell-known MIME constants used across the battery.\n\n## Type Declaration\n\n| Name | Type | Default value | Defined in |\n| --------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `AVIF` | `\"image/avif\"` | `'image/avif'` | [src/batteries/media/formats.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L49) |\n| `CSV` | `\"text/csv\"` | `'text/csv'` | [src/batteries/media/formats.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L41) |\n| `DBF` | `\"application/x-dbf\"` | `'application/x-dbf'` | [src/batteries/media/formats.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L38) |\n| `DIF` | `\"application/x-dif\"` | `'application/x-dif'` | [src/batteries/media/formats.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L37) |\n| `DOC` | `\"application/msword\"` | `'application/msword'` | [src/batteries/media/formats.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L27) |\n| `DOCX` | `\"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"` | `'application/vnd.openxmlformats-officedocument.wordprocessingml.document'` | [src/batteries/media/formats.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L20) |\n| `FODS` | `\"application/vnd.oasis.opendocument.spreadsheet-flat-xml\"` | `'application/vnd.oasis.opendocument.spreadsheet-flat-xml'` | [src/batteries/media/formats.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L35) |\n| `HTML` | `\"text/html\"` | `'text/html'` | [src/batteries/media/formats.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L42) |\n| `JPEG` | `\"image/jpeg\"` | `'image/jpeg'` | [src/batteries/media/formats.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L46) |\n| `JSON` | `\"application/json\"` | `'application/json'` | [src/batteries/media/formats.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L43) |\n| `KEYNOTE` | `\"application/x-iwork-keynote-sffkey\"` | `'application/x-iwork-keynote-sffkey'` | [src/batteries/media/formats.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L32) |\n| `MD` | `\"text/markdown\"` | `'text/markdown'` | [src/batteries/media/formats.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L40) |\n| `MP3` | `\"audio/mpeg\"` | `'audio/mpeg'` | [src/batteries/media/formats.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L51) |\n| `NUMBERS` | `\"application/x-iwork-numbers-sffnumbers\"` | `'application/x-iwork-numbers-sffnumbers'` | [src/batteries/media/formats.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L31) |\n| `ODP` | `\"application/vnd.oasis.opendocument.presentation\"` | `'application/vnd.oasis.opendocument.presentation'` | [src/batteries/media/formats.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L25) |\n| `ODS` | `\"application/vnd.oasis.opendocument.spreadsheet\"` | `'application/vnd.oasis.opendocument.spreadsheet'` | [src/batteries/media/formats.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L24) |\n| `ODT` | `\"application/vnd.oasis.opendocument.text\"` | `'application/vnd.oasis.opendocument.text'` | [src/batteries/media/formats.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L23) |\n| `PAGES` | `\"application/x-iwork-pages-sffpages\"` | `'application/x-iwork-pages-sffpages'` | [src/batteries/media/formats.ts:30](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L30) |\n| `PDF` | `\"application/pdf\"` | `'application/pdf'` | [src/batteries/media/formats.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L26) |\n| `PNG` | `\"image/png\"` | `'image/png'` | [src/batteries/media/formats.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L45) |\n| `PPT` | `\"application/vnd.ms-powerpoint\"` | `'application/vnd.ms-powerpoint'` | [src/batteries/media/formats.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L29) |\n| `PPTX` | `\"application/vnd.openxmlformats-officedocument.presentationml.presentation\"` | `'application/vnd.openxmlformats-officedocument.presentationml.presentation'` | [src/batteries/media/formats.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L22) |\n| `SYLK` | `\"application/x-sylk\"` | `'application/x-sylk'` | [src/batteries/media/formats.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L36) |\n| `TIFF` | `\"image/tiff\"` | `'image/tiff'` | [src/batteries/media/formats.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L48) |\n| `TXT` | `\"text/plain\"` | `'text/plain'` | [src/batteries/media/formats.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L39) |\n| `WAV` | `\"audio/wav\"` | `'audio/wav'` | [src/batteries/media/formats.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L50) |\n| `WEBP` | `\"image/webp\"` | `'image/webp'` | [src/batteries/media/formats.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L47) |\n| `XLS` | `\"application/vnd.ms-excel\"` | `'application/vnd.ms-excel'` | [src/batteries/media/formats.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L28) |\n| `XLSB` | `\"application/vnd.ms-excel.sheet.binary.macroEnabled.12\"` | `'application/vnd.ms-excel.sheet.binary.macroEnabled.12'` | [src/batteries/media/formats.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L34) |\n| `XLSM` | `\"application/vnd.ms-excel.sheet.macroEnabled.12\"` | `'application/vnd.ms-excel.sheet.macroEnabled.12'` | [src/batteries/media/formats.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L33) |\n| `XLSX` | `\"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\"` | `'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'` | [src/batteries/media/formats.ts:21](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L21) |\n| `YAML` | `\"application/yaml\"` | `'application/yaml'` | [src/batteries/media/formats.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/formats.ts#L44) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/VERB_INDEX","title":"Variable: VERB\\_INDEX","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/VERB_INDEX.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/VERB_INDEX","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/VERB_INDEX.md'\ndescription: 'Map of canonical verb id → spec, for direct lookup.'\n---\n\n# Variable: VERB\\_INDEX\n\n```ts\nconst VERB_INDEX: ReadonlyMap;\n```\n\nDefined in: [src/batteries/media/verbs.ts:805](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L805)\n\nMap of canonical verb id → spec, for direct lookup.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/media/variables/VERBS","title":"Variable: VERBS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/VERBS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/media/variables/VERBS","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/media/variables/VERBS.md'\ndescription: >-\n The canonical verb table. Order is presentation order in generated grammar\n text.\n---\n\n# Variable: VERBS\n\n```ts\nconst VERBS: readonly VerbSpec[];\n```\n\nDefined in: [src/batteries/media/verbs.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/media/verbs.ts#L127)\n\nThe canonical verb table. Order is presentation order in generated grammar text.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration","title":"@nhtio/adk/batteries/orchestration","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration.md'\ndescription: >-\n The orchestration battery — plan lifecycle, execution, and the model-facing\n tool forge.\n---\n\n# @nhtio/adk/batteries/orchestration\n\nThe orchestration battery — plan lifecycle, execution, and the model-facing tool forge.\n\n## Remarks\n\nThis is the battery's BARREL and its single entry point: the assembly gate where the\nwork-package pieces (validation, approval, the executor, templates, rendering, the raw\nviews, the outline reader and the tool forge) are wired together. It is the one place a\nprecondition can be enforced for every operation, which is why the encoder requirement and\nevaluator loading live here rather than scattered across the modules that happen to need them.\n\n### Why `createOrchestration` is async\n\nConstruction is the last moment a deployment can fail LOUDLY and EARLY. Four things are\nresolved here, before any plan is created, frozen or approved:\n\n1. **The encoder is required.** `@nhtio/encoder` is declared an OPTIONAL PEER of the whole\n package — peer metadata is package-wide, not subpath-scoped, so making it required would\n force it on every consumer including the many who never import orchestration. The\n requirement is enforced where it CAN be: at construction, by eagerly\n `await import('@nhtio/encoder')` and throwing [E\\_ORCH\\_ENCODER\\_REQUIRED](variables/E_ORCH_ENCODER_REQUIRED.md) (naming the\n package and its install command) if it is absent. Failing here means no plan is ever created,\n frozen or approved in a deployment missing the encoder — the property that actually matters.\n It is genuinely required because the digest comes from a lossless canonical encoding, and\n digests are load-bearing in every lifecycle transition, approval binding and `claimRun` —\n even an in-memory store needs them.\n2. **Encodables are registered once.** `registerOrchestrationEncodables()` is called here,\n once, because `registerClass` is a global registry and decoding an unregistered class throws.\n3. **Every configured evaluator cell is loaded.** `await load()` runs on each cell supplied at\n construction, so a missing optional peer surfaces HERE rather than part-way through a freeze.\n A cell supplied per-run is loaded at that point, with the same named error.\n4. **Every registered template is validated.** `validateTemplate` runs on each template and a\n blocking issue throws, so a misconfigured deployment fails at boot with a named error rather\n than at first instantiation months later.\n\n### Dependency precedence\n\nResolved HERE and stated once so it cannot drift: **per-run wins field by field over\nconstruction**; anything absent from both is a named error if the plan needs it. `evaluators`\nMERGE BY CELL `id` — a per-run cell replaces the configured one with the same id, others\nsurvive — because a run legitimately swaps one cell while keeping the rest. Everything else\nreplaces wholesale.\n\n### Environment neutrality\n\nThe barrel stays environment-neutral: there is no `node:*` anywhere in its module graph. The\nLua cell (`./cells/lua`) imports `node:worker_threads` and is therefore NOT re-exported here —\nit is reachable only via its own deep subpath.\n\nThe conformance suite (`./conformance`) is excluded for the same reason in a different\ndimension: it imports `vitest`, which is an OPTIONAL peer dependency. A barrel re-export makes\nthat import part of every consumer's module graph, so `import '@nhtio/adk/batteries/orchestration'`\nfails with `ERR_MODULE_NOT_FOUND` for anyone who has not installed a test runner — which is\nevery production consumer. It is reachable only via its own deep subpath, from a test\nenvironment where `vitest` is present. This matches `batteries/vector`, whose conformance suite\nis likewise vitest-based and likewise subpath-only. (`batteries/sandbox` DOES re-export its\nsuite from its barrel, and that is fine: it asserts through a local `assert` helper and imports\nno test framework at all. The rule is about the `vitest` import, not about conformance suites.)\n\nThe structured and jexl cells, the types, the exceptions, the store contract and the in-memory\nstore, and the raw/render/outline functions are all re-exported.\n\n### How the deep subpaths are named\n\nEvery module carrying an `@module` tag becomes one published entry, and the entry key is its\nFULL path from `src/` — `batteries/orchestration/forge`, not `forge`. The build derives the map\nby scanning for those tags (`getEntries` in `bin/utils`), and the emitted declaration sits at\nthe matching path, so `dist/batteries/orchestration/types.d.ts` and `dist/types.d.ts` are\ndifferent files reached by different specifiers.\n\nStated because the leaf basenames repeat and that looks alarming: this battery ships `forge`\nand `types`, and so do the root package and several other batteries — 25 modules end in\n`/types` today, four in `/forge`. None of them collide, because nothing is keyed on the\nbasename. A module tagged here can never overwrite `@nhtio/adk/forge`.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [AllPredicate](interfaces/AllPredicate.md) | A predicate that is satisfied only when EVERY member is satisfied. |\n| [AnyPredicate](interfaces/AnyPredicate.md) | A predicate that is satisfied when AT LEAST ONE member is satisfied. |\n| [NotPredicate](interfaces/NotPredicate.md) | A predicate that is satisfied exactly when its single member is NOT satisfied. |\n| [PlanLock](interfaces/PlanLock.md) | A single execution lease on one plan. |\n| [PlanLockFactory](interfaces/PlanLockFactory.md) | Creates and restores `PlanLock` instances for a deployment. |\n| [PlanStore](interfaces/PlanStore.md) | The one contract for plans and runs — not a second store. **Every method is async**; nothing here is sync-or-async. A durable plan store is I/O by nature, the lifecycle transition is inherently a round-trip, and the cell seam is async too, so a uniform `Promise` surface is one less thing for eleven work packages to get inconsistently right. |\n| [PredicateLeaf](interfaces/PredicateLeaf.md) | A leaf predicate: read `path` from the readable context and compare it with `op`. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [AppendResult](type-aliases/AppendResult.md) | The outcome of an `appendOps` call. On success it carries the new revision and digest; on failure it names whether the plan was not `editable` (frozen) or the log had moved past `expectedRevision`, and carries the actual state so a stale writer learns what happened. |\n| [ClaimRunResult](type-aliases/ClaimRunResult.md) | The outcome of a `claimRun` call. On success it carries the run id and whether this call resumed an existing run; on failure it names whether the plan was not `executable`, its digest had moved, a run was already claimed, the named run did not exist, or the named run was already settled — carrying the existing run id where one exists. |\n| [CreateResult](type-aliases/CreateResult.md) | The outcome of minting a plan (`createPlan` / `clonePlan`). On success it carries the new plan's revision and digest; on failure it names which precondition was violated. |\n| [ParsePredicateResult](type-aliases/ParsePredicateResult.md) | The result of [parseStructuredPredicate](functions/parseStructuredPredicate.md): either a validated predicate, or a model-addressed reason naming the fix. |\n| [PredicateOp](type-aliases/PredicateOp.md) | The closed set of comparison operators a structured predicate leaf may name. |\n| [StructuredPredicate](type-aliases/StructuredPredicate.md) | The structured predicate IR — the value a branch/select node's `predicate` field holds when the structured cell interprets it. |\n| [TransitionRequest](type-aliases/TransitionRequest.md) | The transition request, as a DISCRIMINATED UNION over the legal pairs — so an illegal target genuinely is a type error at the call site, rather than a claim the signature does not back. `expected.state` is fixed per variant (it is implied by `from`), and `approval` is required exactly where it is meaningful. A BYO store receiving a malformed request over a wire still answers `illegal_transition` at runtime; the type is the first line, not the only one. |\n| [TransitionResult](type-aliases/TransitionResult.md) | The outcome of a `transition` call. On success it carries the new revision; on failure it names whether the plan was not in the expected state, its digest had moved, or the request was not a legal pair — carrying the actual state/digest so a caller that lost can read what happened. |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [createOrchestration](variables/createOrchestration.md) | THE battery's single entry point. Everything public is reached through the [Orchestration](types/interfaces/Orchestration.md) object it returns, so it is the one place a precondition can be enforced for every operation. |\n| [E\\_ORCH\\_CELL\\_UNAVAILABLE](variables/E_ORCH_CELL_UNAVAILABLE.md) | An orchestration cell is unavailable. |\n| [E\\_ORCH\\_ENCODER\\_REQUIRED](variables/E_ORCH_ENCODER_REQUIRED.md) | A required orchestration encoder is not configured. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [isAllPredicate](functions/isAllPredicate.md) | Type guard for [AllPredicate](interfaces/AllPredicate.md). An `all` combinator is a plain object whose sole discriminator key `all` holds an array of structured predicates. |\n| [isAnyPredicate](functions/isAnyPredicate.md) | Type guard for [AnyPredicate](interfaces/AnyPredicate.md). An `any` combinator is a plain object whose sole discriminator key `any` holds an array of structured predicates. |\n| [isNotPredicate](functions/isNotPredicate.md) | Type guard for [NotPredicate](interfaces/NotPredicate.md). A `not` combinator is a plain object whose sole discriminator key `not` holds a single structured predicate. |\n| [isPredicateLeaf](functions/isPredicateLeaf.md) | Type guard for [PredicateLeaf](interfaces/PredicateLeaf.md). A leaf is a plain object carrying a string `path` and a string `op`; the `op` is narrowed to `PredicateOp` only when it is a member of the closed set. |\n| [isStructuredPredicate](functions/isStructuredPredicate.md) | Type guard for the whole [StructuredPredicate](type-aliases/StructuredPredicate.md) union. A value is a structured predicate iff it is one of the four shapes. Because the combinator shapes are discriminated by their single key and a leaf by `path`/`op`, the four guards are mutually exclusive. |\n| [loadOnce](functions/loadOnce.md) | Wraps a cell's `load()` so it is idempotent and converts a failed lazy `await import()` into `E_ORCH_CELL_UNAVAILABLE`. |\n| [parseStructuredPredicate](functions/parseStructuredPredicate.md) | Validates an untrusted `EncodableValue` into the structured predicate IR. |\n\n## References\n\n### ApprovalRecord\n\nRe-exports [ApprovalRecord](types/interfaces/ApprovalRecord.md)\n\n***\n\n### ArgValue\n\nRe-exports [ArgValue](types/type-aliases/ArgValue.md)\n\n***\n\n### ArtifactClassLike\n\nRe-exports [ArtifactClassLike](types/interfaces/ArtifactClassLike.md)\n\n***\n\n### ArtifactMethodDescriptor\n\nRe-exports [ArtifactMethodDescriptor](types/interfaces/ArtifactMethodDescriptor.md)\n\n***\n\n### ArtifactTable\n\nRe-exports [ArtifactTable](types/type-aliases/ArtifactTable.md)\n\n***\n\n### AuthorityClaim\n\nRe-exports [AuthorityClaim](types/interfaces/AuthorityClaim.md)\n\n***\n\n### AuthorityVerb\n\nRe-exports [AuthorityVerb](types/type-aliases/AuthorityVerb.md)\n\n***\n\n### BranchId\n\nRe-exports [BranchId](types/interfaces/BranchId.md)\n\n***\n\n### branchKey\n\nRe-exports [branchKey](ops/functions/branchKey.md)\n\n***\n\n### BranchNodeDefinition\n\nRe-exports [BranchNodeDefinition](types/interfaces/BranchNodeDefinition.md)\n\n***\n\n### CallInvokerFn\n\nRe-exports [CallInvokerFn](types/type-aliases/CallInvokerFn.md)\n\n***\n\n### CallNodeDefinition\n\nRe-exports [CallNodeDefinition](types/interfaces/CallNodeDefinition.md)\n\n***\n\n### ClonedFrom\n\nRe-exports [ClonedFrom](types/interfaces/ClonedFrom.md)\n\n***\n\n### computeAuthoritySet\n\nRe-exports [computeAuthoritySet](../../../../batteries/orchestration/approval/functions/computeAuthoritySet.md)\n\n***\n\n### createDispatchReasoner\n\nRe-exports [createDispatchReasoner](dispatch_reasoner/functions/createDispatchReasoner.md)\n\n***\n\n### createJexlCell\n\nRe-exports [createJexlCell](../../../../batteries/orchestration/cells/jexl/functions/createJexlCell.md)\n\n***\n\n### CreateOrchestration\n\nRe-exports [CreateOrchestration](types/type-aliases/CreateOrchestration.md)\n\n***\n\n### createStructuredCell\n\nRe-exports [createStructuredCell](../../../../batteries/orchestration/cells/structured/functions/createStructuredCell.md)\n\n***\n\n### DeclaredField\n\nRe-exports [DeclaredField](types/type-aliases/DeclaredField.md)\n\n***\n\n### decodeOutputSchema\n\nRe-exports [decodeOutputSchema](../../../../batteries/orchestration/reason/functions/decodeOutputSchema.md)\n\n***\n\n### EdgeHandle\n\nRe-exports [EdgeHandle](types/type-aliases/EdgeHandle.md)\n\n***\n\n### effectiveToolMethods\n\nRe-exports [effectiveToolMethods](../../common/functions/effectiveToolMethods.md)\n\n***\n\n### EncodableValue\n\nRe-exports [EncodableValue](types/type-aliases/EncodableValue.md)\n\n***\n\n### EntryNodeDefinition\n\nRe-exports [EntryNodeDefinition](types/interfaces/EntryNodeDefinition.md)\n\n***\n\n### entryNodes\n\nRe-exports [entryNodes](plan/functions/entryNodes.md)\n\n***\n\n### ExecutePlanFn\n\nRe-exports [ExecutePlanFn](types/type-aliases/ExecutePlanFn.md)\n\n***\n\n### findCycle\n\nRe-exports [findCycle](plan/functions/findCycle.md)\n\n***\n\n### foldOps\n\nRe-exports [foldOps](ops/functions/foldOps.md)\n\n***\n\n### foldRun\n\nRe-exports [foldRun](runs/functions/foldRun.md)\n\n***\n\n### ForgeOrchestrationOptions\n\nRe-exports [ForgeOrchestrationOptions](forge/interfaces/ForgeOrchestrationOptions.md)\n\n***\n\n### ForgeOrchestrationRuntime\n\nRe-exports [ForgeOrchestrationRuntime](forge/interfaces/ForgeOrchestrationRuntime.md)\n\n***\n\n### forgeOrchestrationTools\n\nRe-exports [forgeOrchestrationTools](forge/functions/forgeOrchestrationTools.md)\n\n***\n\n### FrameRef\n\nRe-exports [FrameRef](types/interfaces/FrameRef.md)\n\n***\n\n### FreezeInputs\n\nRe-exports [FreezeInputs](types/interfaces/FreezeInputs.md)\n\n***\n\n### handleAppliesTo\n\nRe-exports [handleAppliesTo](plan/functions/handleAppliesTo.md)\n\n***\n\n### immediateDominator\n\nRe-exports [immediateDominator](plan/functions/immediateDominator.md)\n\n***\n\n### incoming\n\nRe-exports [incoming](plan/functions/incoming.md)\n\n***\n\n### InMemoryPlanStore\n\nRe-exports [InMemoryPlanStore](in_memory/classes/InMemoryPlanStore.md)\n\n***\n\n### InstantiatedFrom\n\nRe-exports [InstantiatedFrom](types/interfaces/InstantiatedFrom.md)\n\n***\n\n### InstantiateResult\n\nRe-exports [InstantiateResult](types/type-aliases/InstantiateResult.md)\n\n***\n\n### instantiateTemplate\n\nRe-exports [instantiateTemplate](templates/functions/instantiateTemplate.md)\n\n***\n\n### InterruptionCause\n\nRe-exports [InterruptionCause](types/type-aliases/InterruptionCause.md)\n\n***\n\n### InvocableTools\n\nRe-exports [InvocableTools](types/interfaces/InvocableTools.md)\n\n***\n\n### isPlanEdge\n\nRe-exports [isPlanEdge](plan/functions/isPlanEdge.md)\n\n***\n\n### isPlanNode\n\nRe-exports [isPlanNode](plan/functions/isPlanNode.md)\n\n***\n\n### isValidEdgeId\n\nRe-exports [isValidEdgeId](plan/functions/isValidEdgeId.md)\n\n***\n\n### isValidNodeId\n\nRe-exports [isValidNodeId](plan/functions/isValidNodeId.md)\n\n***\n\n### JexlCellOptions\n\nRe-exports [JexlCellOptions](../../../../batteries/orchestration/cells/jexl/interfaces/JexlCellOptions.md)\n\n***\n\n### JexlTransform\n\nRe-exports [JexlTransform](../../../../batteries/orchestration/cells/jexl/type-aliases/JexlTransform.md)\n\n***\n\n### JoinNodeDefinition\n\nRe-exports [JoinNodeDefinition](types/interfaces/JoinNodeDefinition.md)\n\n***\n\n### joinPromptParts\n\nRe-exports [joinPromptParts](../../../../batteries/orchestration/reason/functions/joinPromptParts.md)\n\n***\n\n### JoinState\n\nRe-exports [JoinState](types/interfaces/JoinState.md)\n\n***\n\n### MediaLike\n\nRe-exports [MediaLike](types/interfaces/MediaLike.md)\n\n***\n\n### nodeById\n\nRe-exports [nodeById](plan/functions/nodeById.md)\n\n***\n\n### NodeId\n\nRe-exports [NodeId](types/type-aliases/NodeId.md)\n\n***\n\n### NodeOutcome\n\nRe-exports [NodeOutcome](types/type-aliases/NodeOutcome.md)\n\n***\n\n### NodeOutput\n\nRe-exports [NodeOutput](types/interfaces/NodeOutput.md)\n\n***\n\n### NodeRef\n\nRe-exports [NodeRef](encoding/classes/NodeRef.md)\n\n***\n\n### Orchestration\n\nRe-exports [Orchestration](types/interfaces/Orchestration.md)\n\n***\n\n### outgoing\n\nRe-exports [outgoing](plan/functions/outgoing.md)\n\n***\n\n### OutputItem\n\nRe-exports [OutputItem](types/interfaces/OutputItem.md)\n\n***\n\n### OutputTable\n\nRe-exports [OutputTable](types/type-aliases/OutputTable.md)\n\n***\n\n### ParamRef\n\nRe-exports [ParamRef](encoding/classes/ParamRef.md)\n\n***\n\n### PendingFrame\n\nRe-exports [PendingFrame](types/interfaces/PendingFrame.md)\n\n***\n\n### PhaseEntry\n\nRe-exports [PhaseEntry](types/interfaces/PhaseEntry.md)\n\n***\n\n### PlanBounds\n\nRe-exports [PlanBounds](types/interfaces/PlanBounds.md)\n\n***\n\n### PlanDiff\n\nRe-exports [PlanDiff](types/interfaces/PlanDiff.md)\n\n***\n\n### planDigest\n\nRe-exports [planDigest](encoding/functions/planDigest.md)\n\n***\n\n### PlanEdge\n\nRe-exports [PlanEdge](types/interfaces/PlanEdge.md)\n\n***\n\n### PlanId\n\nRe-exports [PlanId](types/type-aliases/PlanId.md)\n\n***\n\n### PlanIssue\n\nRe-exports [PlanIssue](types/interfaces/PlanIssue.md)\n\n***\n\n### PlanNode\n\nRe-exports [PlanNode](types/type-aliases/PlanNode.md)\n\n***\n\n### PlanNodeKind\n\nRe-exports [PlanNodeKind](types/type-aliases/PlanNodeKind.md)\n\n***\n\n### PlanOp\n\nRe-exports [PlanOp](types/type-aliases/PlanOp.md)\n\n***\n\n### planOutline\n\nRe-exports [planOutline](../../../../batteries/orchestration/outline/functions/planOutline.md)\n\n***\n\n### PlanOutline\n\nRe-exports [PlanOutline](types/interfaces/PlanOutline.md)\n\n***\n\n### PlanProvenance\n\nRe-exports [PlanProvenance](types/type-aliases/PlanProvenance.md)\n\n***\n\n### planRead\n\nRe-exports [planRead](../../../../batteries/orchestration/outline/functions/planRead.md)\n\n***\n\n### PlanSlice\n\nRe-exports [PlanSlice](types/interfaces/PlanSlice.md)\n\n***\n\n### PlanState\n\nRe-exports [PlanState](types/type-aliases/PlanState.md)\n\n***\n\n### PlanSummary\n\nRe-exports [PlanSummary](types/interfaces/PlanSummary.md)\n\n***\n\n### PlanTemplate\n\nRe-exports [PlanTemplate](types/interfaces/PlanTemplate.md)\n\n***\n\n### PredicateContext\n\nRe-exports [PredicateContext](types/interfaces/PredicateContext.md)\n\n***\n\n### PredicateEvaluator\n\nRe-exports [PredicateEvaluator](types/interfaces/PredicateEvaluator.md)\n\n***\n\n### PredicateVerdict\n\nRe-exports [PredicateVerdict](types/type-aliases/PredicateVerdict.md)\n\n***\n\n### PromptPart\n\nRe-exports [PromptPart](types/type-aliases/PromptPart.md)\n\n***\n\n### rawDiff\n\nRe-exports [rawDiff](raw/functions/rawDiff.md)\n\n***\n\n### rawOps\n\nRe-exports [rawOps](raw/functions/rawOps.md)\n\n***\n\n### rawPlan\n\nRe-exports [rawPlan](raw/functions/rawPlan.md)\n\n***\n\n### RawPlanView\n\nRe-exports [RawPlanView](types/interfaces/RawPlanView.md)\n\n***\n\n### reachableFrom\n\nRe-exports [reachableFrom](plan/functions/reachableFrom.md)\n\n***\n\n### readPath\n\nRe-exports [readPath](plan/functions/readPath.md)\n\n***\n\n### ReasonerFn\n\nRe-exports [ReasonerFn](types/type-aliases/ReasonerFn.md)\n\n***\n\n### ReasonNodeDefinition\n\nRe-exports [ReasonNodeDefinition](types/interfaces/ReasonNodeDefinition.md)\n\n***\n\n### registerOrchestrationEncodables\n\nRe-exports [registerOrchestrationEncodables](encoding/functions/registerOrchestrationEncodables.md)\n\n***\n\n### renderPlan\n\nRe-exports [renderPlan](render/functions/renderPlan.md)\n\n***\n\n### RenderPlanOptions\n\nRe-exports [RenderPlanOptions](render/type-aliases/RenderPlanOptions.md)\n\n***\n\n### routesBetween\n\nRe-exports [routesBetween](plan/functions/routesBetween.md)\n\n***\n\n### RouteSegment\n\nRe-exports [RouteSegment](types/type-aliases/RouteSegment.md)\n\n***\n\n### RunDeps\n\nRe-exports [RunDeps](types/interfaces/RunDeps.md)\n\n***\n\n### RunEvent\n\nRe-exports [RunEvent](types/type-aliases/RunEvent.md)\n\n***\n\n### RunOptions\n\nRe-exports [RunOptions](types/interfaces/RunOptions.md)\n\n***\n\n### RunProjection\n\nRe-exports [RunProjection](types/interfaces/RunProjection.md)\n\n***\n\n### SelectNodeDefinition\n\nRe-exports [SelectNodeDefinition](types/interfaces/SelectNodeDefinition.md)\n\n***\n\n### SpooledArtifactLike\n\nRe-exports [SpooledArtifactLike](types/interfaces/SpooledArtifactLike.md)\n\n***\n\n### stripInstructionTags\n\nRe-exports [stripInstructionTags](../../../../batteries/orchestration/reason/functions/stripInstructionTags.md)\n\n***\n\n### TemplateArgValue\n\nRe-exports [TemplateArgValue](types/type-aliases/TemplateArgValue.md)\n\n***\n\n### TemplateDefinitionOf\n\nRe-exports [TemplateDefinitionOf](types/type-aliases/TemplateDefinitionOf.md)\n\n***\n\n### TemplateNode\n\nRe-exports [TemplateNode](types/type-aliases/TemplateNode.md)\n\n***\n\n### ToolResult\n\nRe-exports [ToolResult](types/type-aliases/ToolResult.md)\n\n***\n\n### TransformNodeDefinition\n\nRe-exports [TransformNodeDefinition](types/interfaces/TransformNodeDefinition.md)\n\n***\n\n### validateReasonerOutput\n\nRe-exports [validateReasonerOutput](../../../../batteries/orchestration/reason/functions/validateReasonerOutput.md)\n\n***\n\n### validateTemplate\n\nRe-exports [validateTemplate](templates/functions/validateTemplate.md)\n\n***\n\n### wrapInstruction\n\nRe-exports [wrapInstruction](../../../../batteries/orchestration/reason/functions/wrapInstruction.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/conformance","title":"@nhtio/adk/batteries/orchestration/conformance","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/conformance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/conformance","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/conformance.md'\ndescription: 'The shared conformance suite for [`PlanStore`](https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/PlanStore) backends.'\n---\n\n# @nhtio/adk/batteries/orchestration/conformance\n\nThe shared conformance suite for [PlanStore](../interfaces/PlanStore.md) backends.\n\nA consumer who owns their own plan store imports [runPlanStoreConformance](functions/runPlanStoreConformance.md) and drives it\nwith a factory that mints a fresh store per case. Each case is a contract assertion written\nagainst the [PlanStore](../interfaces/PlanStore.md) interface only — never against in-memory internals — so a passing\nsuite proves the backend honours the same contract the shipped reference implementation does.\n\nPublic, deep-import-only (`@nhtio/adk/batteries/orchestration/conformance`). The suite has no\ntest-runner dependency: callers invoke and await it from any test framework.\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| [runPlanStoreConformance](functions/runPlanStoreConformance.md) | Run the framework-free PlanStore conformance suite against a consumer implementation. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/conformance/functions/runPlanStoreConformance","title":"Function: runPlanStoreConformance()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/conformance/functions/runPlanStoreConformance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/conformance/functions/runPlanStoreConformance","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/conformance/functions/runPlanStoreConformance.md\n---\n\n# Function: runPlanStoreConformance()\n\n```ts\nfunction runPlanStoreConformance(\n label: string,\n makeStore: () => PlanStore | Promise,\n): Promise;\n```\n\nDefined in: [src/batteries/orchestration/conformance.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/conformance.ts#L93)\n\nRun the framework-free PlanStore conformance suite against a consumer implementation.\n\nEach check creates a fresh store through `makeStore`, and the returned promise rejects when any\ncontract assertion fails. Consumers can await this function from Vitest, node:test, Jest, Mocha,\nor another runner without importing a test framework from the conformance module.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |\n| `label` | `string` | Human-readable name used to identify the implementation under test. |\n| `makeStore` | () => | [`PlanStore`](../../interfaces/PlanStore.md) | `Promise`<[`PlanStore`](../../interfaces/PlanStore.md)> | Factory returning a fresh PlanStore for each conformance check; it may be async. |\n\n## Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner","title":"@nhtio/adk/batteries/orchestration/dispatch\\_reasoner","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner.md'\n---\n\n# @nhtio/adk/batteries/orchestration/dispatch\\_reasoner\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------- | -------------------------------------------------------------- |\n| [createDispatchReasoner](functions/createDispatchReasoner.md) | Builds a reasoner that answers through a forced tool dispatch. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner/functions/createDispatchReasoner","title":"Function: createDispatchReasoner()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner/functions/createDispatchReasoner.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner/functions/createDispatchReasoner","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/dispatch_reasoner/functions/createDispatchReasoner.md\n---\n\n# Function: createDispatchReasoner()\n\n```ts\nfunction createDispatchReasoner(options: {\n executor: DispatchExecutorFn;\n spoolStore?: InMemorySpoolStore;\n toolName?: string;\n}): ReasonerFn;\n```\n\nDefined in: [src/batteries/orchestration/dispatch\\_reasoner.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/dispatch_reasoner.ts#L104)\n\nBuilds a reasoner that answers through a forced tool dispatch.\n\nA reasoning node must return a structured, schema-validated result, but\n[DispatchRunner.dispatch](../../../../dispatch_runner/classes/DispatchRunner.md#dispatch) resolves to `void`. This helper bridges that\ngap by wiring the node's output schema onto a forced tool's `inputSchema` and\ncapturing the arguments the model submits to that tool. Because the tool's\ninput schema is the node's output schema, validation rejects malformed\narguments before the handler ever runs, so the model cannot answer with\nunstructured prose.\n\nThe captured value is read from a closure after the dispatch resolves; the\nvoid return value is irrelevant. If the tool is never called, the dispatch is\na halting failure and this function throws rather than fabricating or\nreturning a partial result.\n\nThe boundary this draws is deliberate: the battery owns the forced-tool protocol and the retry\nbound, and the CONSUMER owns the model. `DispatchRunner` takes an injected executor rather than\na model identifier, so a consumer wires whichever provider they already use and this helper\nnever grows credential handling.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `options` | { `executor`: [`DispatchExecutorFn`](../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md); `spoolStore?`: [`InMemorySpoolStore`](../../../storage/in_memory/classes/InMemorySpoolStore.md); `toolName?`: `string`; } | Configuration for the reasoner. |\n| `options.executor` | [`DispatchExecutorFn`](../../../../dispatch_runner/type-aliases/DispatchExecutorFn.md) | The consumer's LLM call, invoked by the runner on every iteration. |\n| `options.spoolStore?` | [`InMemorySpoolStore`](../../../storage/in_memory/classes/InMemorySpoolStore.md) | Store used to spool large results. Defaults to a fresh [InMemorySpoolStore](../../../storage/in_memory/classes/InMemorySpoolStore.md) so a large reasoning result always has somewhere to go. |\n| `options.toolName?` | `string` | Name of the forced capture tool. Defaults to `'submit_reasoning'`. |\n\n## Returns\n\n[`ReasonerFn`](../../types/type-aliases/ReasonerFn.md)\n\nA [ReasonerFn](../../types/type-aliases/ReasonerFn.md) that resolves to the validated reasoning\nresult or throws if no valid result could be captured.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding","title":"@nhtio/adk/batteries/orchestration/encoding","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/encoding.md'\ndescription: >-\n Encoding battery for orchestration: the reference classes the IR is built\n from, their `@nhtio/encoder` registration, and the plan digest every approval\n binds to.\n---\n\n# @nhtio/adk/batteries/orchestration/encoding\n\nEncoding battery for orchestration: the reference classes the IR is built from, their\n`@nhtio/encoder` registration, and the plan digest every approval binds to.\n\n## Remarks\n\nThis module owns three things:\n\n1. `NodeRef` and `ParamRef` — the two CLASSES the IR uses for references and template holes.\n They are classes, not records with a marker field, for a reason stated in their TSDoc: a\n plain record can wear `{kind: 'nodeRef', …}` — it is an ordinary encodable record — so a\n marker property cannot separate a reference from a literal that merely looks like one, and a\n resolver keying on it would silently rewrite the literal. `instanceof` is unforgeable.\n2. `registerOrchestrationEncodables()` — the one call that makes `decode()` able to rebuild\n these classes. It MUST run before any `decode()`.\n3. `planDigest()` — the canonical, LOSSLESS digest of a `RawPlanView`. Every approval binds to\n this digest, so it must never collide across semantically-different plans.\n\n## Classes\n\n| Class | Description |\n| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [NodeRef](classes/NodeRef.md) | A serializable reference to another node's output — a CLASS, not a record. |\n| [ParamRef](classes/ParamRef.md) | A hole in a template's staged values, substituted at instantiation. A CLASS for the same reason `NodeRef` is: a look-alike record must not be mistaken for a hole. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------------------- | -------------------------------------------------------------------- |\n| [planDigest](functions/planDigest.md) | Compute the canonical, LOSSLESS digest of a `RawPlanView`. |\n| [registerOrchestrationEncodables](functions/registerOrchestrationEncodables.md) | Register `NodeRef` and `ParamRef` with the `@nhtio/encoder` decoder. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/classes/NodeRef","title":"Class: NodeRef","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/classes/NodeRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/classes/NodeRef","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/encoding/classes/NodeRef.md\ndescription: 'A serializable reference to another node''s output — a CLASS, not a record.'\n---\n\n# Class: NodeRef\n\nDefined in: [src/batteries/orchestration/encoding.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L42)\n\nA serializable reference to another node's output — a CLASS, not a record.\n\n## Remarks\n\nWhy a class rather than a record with a marker field: a plain record can wear\n`{kind: 'nodeRef', node, select, …}` — it is an ordinary encodable record — so a marker\nproperty cannot separate a reference from a literal that happens to look like one, and a\nresolver keying on it would silently rewrite the literal. `instanceof` is unforgeable: no\nrecord can satisfy `NodeRef.isNodeRef`, and the encoder round-trips instances as\n`custom:NodeRef` rather than as records. Same mechanism core uses for `Media`/`Tokenizable`.\n\n`branchId` identifies WHICH EXECUTION of `node` to read — the same path identity `NodeOutput`\nand `FrameRef` carry. Omitted means \"do not filter\".\n\n## Constructors\n\n### Constructor\n\n```ts\nnew NodeRef(\n node: string,\n select:\n | \"last\"\n | \"first\"\n | \"all\"\n | {\n index: number;\n},\n path?: string,\n branchId?: BranchId): NodeRef;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L68)\n\nConstruct a `NodeRef`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| `node` | `string` | The id of the node whose output this reference reads. |\n| `select` | | `\"last\"` | `\"first\"` | `\"all\"` | { `index`: `number`; } | Which item of that node's output to take: 'first', 'last', 'all', or an explicit {index}. |\n| `path?` | `string` | An optional dot-path into the selected item's value. |\n| `branchId?` | [`BranchId`](../../types/interfaces/BranchId.md) | Which execution of the node to read, as a path identity; omitted means \"do not filter\". |\n\n#### Returns\n\n`NodeRef`\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `branchId?` | [`BranchId`](../../types/interfaces/BranchId.md) | WHICH EXECUTION of the node to read, as a path identity. **Remarks** This is NOT an outgoing branch of that node: a node fanning out to two successors still runs once and produces one output; what creates several outputs for one node is that node being REACHED by several paths. Omitted means \"do not filter\" — fine when exactly one path reaches the node, and refused at freeze when more than one does. | [src/batteries/orchestration/encoding.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L58) |\n| `node` | `string` | The id of the node whose output this reference reads. | [src/batteries/orchestration/encoding.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L44) |\n| `path?` | `string` | An optional dot-path into the selected item's value. | [src/batteries/orchestration/encoding.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L48) |\n| `select` | | `\"last\"` | `\"first\"` | `\"all\"` | { `index`: `number`; } | Which item of that node's output to take: 'first', 'last', 'all', or an explicit {index}. | [src/batteries/orchestration/encoding.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L46) |\n\n## Methods\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: Record;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L86)\n\nEmit a plain snapshot of the fields for the encoder.\n\n#### Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: NodeRef;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L91)\n\nRebuild an instance from a NodeRef.\\[ENCODE\\_METHOD] snapshot.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `data` | `unknown` |\n\n#### Returns\n\n`NodeRef`\n\n***\n\n### isNodeRef()\n\n```ts\nstatic isNodeRef(v: unknown): v is NodeRef;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L81)\n\n`instanceof` guard — a look-alike record cannot pass.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n#### Returns\n\n`v is NodeRef`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/classes/ParamRef","title":"Class: ParamRef","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/classes/ParamRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/classes/ParamRef","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/encoding/classes/ParamRef.md\ndescription: >-\n A hole in a template's staged values, substituted at instantiation. A CLASS\n for the same reason `NodeRef` is: a look-alike record must not be mistaken for\n a hole.\n---\n\n# Class: ParamRef\n\nDefined in: [src/batteries/orchestration/encoding.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L107)\n\nA hole in a template's staged values, substituted at instantiation. A CLASS for the same\nreason `NodeRef` is: a look-alike record must not be mistaken for a hole.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew ParamRef(path: string): ParamRef;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L116)\n\nConstruct a `ParamRef`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------------------- |\n| `path` | `string` | The declared template `params` entry this hole names. |\n\n#### Returns\n\n`ParamRef`\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | -------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `path` | `string` | Must name a declared template `params` entry (checked at construction). | [src/batteries/orchestration/encoding.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L109) |\n\n## Methods\n\n### \\[ENCODE\\_METHOD]\\()\n\n```ts\nENCODE_METHOD: Record;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L126)\n\nEmit a plain snapshot of the fields for the encoder.\n\n#### Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>\n\n***\n\n### \\[DECODE\\_METHOD]\\()\n\n```ts\nstatic DECODE_METHOD: ParamRef;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L131)\n\nRebuild an instance from a ParamRef.\\[ENCODE\\_METHOD] snapshot.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `data` | `unknown` |\n\n#### Returns\n\n`ParamRef`\n\n***\n\n### isParamRef()\n\n```ts\nstatic isParamRef(v: unknown): v is ParamRef;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L121)\n\n`instanceof` guard — a look-alike record cannot pass.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n#### Returns\n\n`v is ParamRef`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/functions/planDigest","title":"Function: planDigest()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/functions/planDigest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/functions/planDigest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/encoding/functions/planDigest.md\n---\n\n# Function: planDigest()\n\n```ts\nfunction planDigest(view: RawPlanView): string;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:228](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L228)\n\nCompute the canonical, LOSSLESS digest of a `RawPlanView`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------ | -------------------------------------- |\n| `view` | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | The folded plan content at a revision. |\n\n## Returns\n\n`string`\n\nA hex sha256 digest over the canonical, lossless encoding of `view`.\n\n## Remarks\n\nEvery approval binds to this digest, so it must be a faithful fingerprint of the plan content\nthe operator actually saw — never a lossy one that could authorise a plan they did not see.\n\nThe strategy: recursively sort PLAIN-OBJECT keys only (leaving every encoder-owned value —\n`Date`, `RegExp`, `Map`, `Set`, typed arrays, `ArrayBuffer`, `DataView`, bigint, luxon values,\nand `NodeRef`/`ParamRef` instances — untouched), then `sha256(encode(sortedSkeleton))`. The\nencoder is the authority on how each value serialises, and it round-trips the reference classes\nand the whole `EncodableValue` domain losslessly, so the digest is stable across key order while\nremaining collision-free across semantically-different plans.\n\nThis is the second of the two digest strategies considered. The first — `canonicalStringify`\nfrom `src/lib/utils/canonical_json.ts` — was rejected because it walks objects with\n`Object.keys`, and `Date`, `RegExp`, `Map` and `Set` have no enumerable own keys, so it collapses\neach to `{}`. That is proven to collide: `{pattern: /^inv-\\d+$/i, when: , m: Map{k=>1}}`\nand `{pattern: /^cust-\\d+$/, when: , m: Map{z=>9}}` both canonicalise to\n`{\"m\":{},\"pattern\":{},\"when\":{}}`. An approval bound to that digest would authorise a plan the\noperator never saw. This implementation sorts only plain-object keys and never replaces the\nencoder's representation of the values it owns.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/functions/registerOrchestrationEncodables","title":"Function: registerOrchestrationEncodables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/functions/registerOrchestrationEncodables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/encoding/functions/registerOrchestrationEncodables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/encoding/functions/registerOrchestrationEncodables.md\n---\n\n# Function: registerOrchestrationEncodables()\n\n```ts\nfunction registerOrchestrationEncodables(): void;\n```\n\nDefined in: [src/batteries/orchestration/encoding.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/encoding.ts#L153)\n\nRegister `NodeRef` and `ParamRef` with the `@nhtio/encoder` decoder.\n\n## Returns\n\n`void`\n\n## Remarks\n\n**MUST run before any `decode()` — but createOrchestration already calls it**, so a\nconsumer who constructs through the battery's entry point never needs to. Call it directly only\nwhen you reach the deep subpaths without constructing an `Orchestration` (decoding a persisted\nplan in a worker, say).\n\n**MUST run before any `decode()`.** `registerClass` writes to a GLOBAL registry, and decoding\nan unregistered class throws — the decoder must map a `custom:NodeRef`/`custom:ParamRef` wire\ntag back to a constructor. Idempotent: safe to call more than once (re-registering a class is a\nno-op overwrite). Encoding never needs this; only decoding does.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge","title":"@nhtio/adk/batteries/orchestration/forge","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/forge.md'\ndescription: The model-facing tool forge for the orchestration battery.\n---\n\n# @nhtio/adk/batteries/orchestration/forge\n\nThe model-facing tool forge for the orchestration battery.\n\n## Remarks\n\nThis file is the ONLY place the wire↔IR conversion happens, and the ONLY place a model-facing\ntool is constructed for orchestration. A tool call cannot transmit a class instance, so on the\nwire a reference is `{$ref: {node, select, path?, branchId?}}` and a template hole is\n`{$param: {path}}` — single-key wrappers whose keys are RESERVED — and the IR uses real\n[NodeRef](../encoding/classes/NodeRef.md)/[ParamRef](../encoding/classes/ParamRef.md) instances. hydrateRefs converts wire→IR on the way in\nand dehydrateRefs converts IR→wire on the way out, so a model reading a plan back sees\nthe same `$ref`/`$param` shape it writes. Nothing else in the battery ever sees the wire form.\n\nThree surfaces, three threat models:\n\n* **Tier A — `'front'`**, what a conversational agent sees: `list_templates`,\n `instantiate_plan`, `author_plan`. The from-scratch path passes the owner's request VERBATIM\n and UNPARSED — pre-parsing their words into categories is what discarded\n \"at the Holly Springs Walgreens\" in the prior art — and every return is RENDERED PROSE, never\n raw JSON, because a model that re-reads its own JSON echo tends to re-plan rather than\n continue.\n* **Tier B — `'authoring'`**, graph mechanics, exposed only inside an authoring sub-dispatch:\n `create_plan`, `add_node`, `set_node_config`, `connect_nodes`, `remove_node`,\n `disconnect_edge`, `clone_plan`, `get_plan`, `validate_plan`, `freeze_plan`,\n `unfreeze_plan`, `submit_plan`, `plan_status`, `raw_plan`, `raw_diff`, plus the scoped\n reading pair `plan_outline` / `plan_read`.\n* **Tier C is NOT a tool tier** — it is `runtime.invocable`, the allowlist of what a staged\n `call` may invoke. Deliberately separate from the agent's tool surface: adding an agent tool\n never adds it here. The allowlist and the registry are the SAME object — the prior art's\n worst wart was ten names listed against a registry with zero callers, so author-time\n validation passed and fire-time threw \"not registered\". There is no second list.\n\nMutation tools return SCOPED PROSE, not the whole projected plan. The prior art returned\neverything so the model always re-read current state; that was written for a large window and\nis precisely the context problem here — 40 nodes echoed on every edit. Each mutation returns\nwhat changed, what it now connects to, and any new issues, BOUNDED regardless of plan size.\n\n`submit_plan`/`freeze_plan` call [freezePlan](../validation/functions/freezePlan.md) and surface each refusal with its\nmodel-addressed message. The prior art's \"the dry run produced no finding\" refusal is ABSENT —\nthere is no dry run — and the reachability plus unedited-placeholder checks carry the weight it\nused to.\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| [ForgeOrchestrationOptions](interfaces/ForgeOrchestrationOptions.md) | Tier selection and optional per-tool overrides + a mutating-tool gate. |\n| [ForgeOrchestrationRuntime](interfaces/ForgeOrchestrationRuntime.md) | The runtime a forge call is handed: the store, the tier-C allowlist, the wired predicate cells, and any registered templates. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| [forgeOrchestrationTools](functions/forgeOrchestrationTools.md) | Forge the model-facing orchestration tools for a configured runtime and tier. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/functions/forgeOrchestrationTools","title":"Function: forgeOrchestrationTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/functions/forgeOrchestrationTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/functions/forgeOrchestrationTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/forge/functions/forgeOrchestrationTools.md\n---\n\n# Function: forgeOrchestrationTools()\n\n```ts\nfunction forgeOrchestrationTools(\n runtime: ForgeOrchestrationRuntime,\n options: ForgeOrchestrationOptions,\n): Record;\n```\n\nDefined in: [src/batteries/orchestration/forge.ts:619](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L619)\n\nForge the model-facing orchestration tools for a configured runtime and tier.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| `runtime` | [`ForgeOrchestrationRuntime`](../interfaces/ForgeOrchestrationRuntime.md) | The store, tier-C allowlist, predicate cells, templates, and actor identity. |\n| `options` | [`ForgeOrchestrationOptions`](../interfaces/ForgeOrchestrationOptions.md) | Tier, per-tool overrides, and an optional mutating-tool gate. |\n\n## Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Tool`](../../../../forge/classes/Tool.md)>\n\nThe forged tools, keyed by name.\n\n## Remarks\n\nReturns a `Record` keyed by the (post-override) tool name. Tier A (`'front'`)\nyields the three conversational tools; tier B (`'authoring'`) yields the graph-mechanics tools.\nTier C is `runtime.invocable`, not a tool tier, and is the SAME object the tool registry is.\n\nWhere a `gate` is supplied it is run via [runToolGate](../../../tools/_shared/functions/runToolGate.md) before any MUTATING tool executes;\nread-only tools are not gated. The wire↔IR conversion (hydrateRefs/\ndehydrateRefs) happens inside this function and nowhere else.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationOptions","title":"Interface: ForgeOrchestrationOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationOptions.md\ndescription: Tier selection and optional per-tool overrides + a mutating-tool gate.\n---\n\n# Interface: ForgeOrchestrationOptions\n\nDefined in: [src/batteries/orchestration/forge.ts:594](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L594)\n\nTier selection and optional per-tool overrides + a mutating-tool gate.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `gate?` | [`ToolGateFn`](../../../tools/_shared/type-aliases/ToolGateFn.md) | Optional gate run before any MUTATING tool executes. Throwing aborts the call. | [src/batteries/orchestration/forge.ts:600](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L600) |\n| `overrides?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, { `description?`: `string`; `name?`: `string`; }> | Optional names and descriptions keyed by their default tool name. | [src/batteries/orchestration/forge.ts:598](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L598) |\n| `tier` | `\"front\"` | `\"authoring\"` | `'front'` for the conversational surface, `'authoring'` for the graph-mechanics surface. | [src/batteries/orchestration/forge.ts:596](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L596) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationRuntime","title":"Interface: ForgeOrchestrationRuntime","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationRuntime.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationRuntime","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/forge/interfaces/ForgeOrchestrationRuntime.md\ndescription: >-\n The runtime a forge call is handed: the store, the tier-C allowlist, the wired\n predicate cells, and any registered templates.\n---\n\n# Interface: ForgeOrchestrationRuntime\n\nDefined in: [src/batteries/orchestration/forge.ts:580](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L580)\n\nThe runtime a forge call is handed: the store, the tier-C allowlist, the wired predicate cells, and any registered templates.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `actorId` | `string` | The identity under which minted ops are authored. | [src/batteries/orchestration/forge.ts:590](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L590) |\n| `evaluators` | [`PredicateEvaluator`](../../types/interfaces/PredicateEvaluator.md)\\[] | The wired predicate cells; a needed-but-absent cell refuses at freeze. | [src/batteries/orchestration/forge.ts:586](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L586) |\n| `invocable` | [`InvocableTools`](../../types/interfaces/InvocableTools.md) | The tier-C allowlist a staged `call` may invoke — the SAME object the tool registry is, never a second list. | [src/batteries/orchestration/forge.ts:584](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L584) |\n| `store` | [`PlanStore`](../../interfaces/PlanStore.md) | The plan store all tools read and mutate. | [src/batteries/orchestration/forge.ts:582](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L582) |\n| `templates?` | [`PlanTemplate`](../../types/interfaces/PlanTemplate.md)\\[] | Consumer-defined plan shapes a model can instantiate. | [src/batteries/orchestration/forge.ts:588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/forge.ts#L588) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isAllPredicate","title":"Function: isAllPredicate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isAllPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isAllPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/isAllPredicate.md\n---\n\n# Function: isAllPredicate()\n\n```ts\nfunction isAllPredicate(v: unknown): v is AllPredicate;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L85)\n\nType guard for [AllPredicate](../interfaces/AllPredicate.md). An `all` combinator is a plain object whose sole\ndiscriminator key `all` holds an array of structured predicates.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n## Returns\n\n`v is AllPredicate`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isAnyPredicate","title":"Function: isAnyPredicate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isAnyPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isAnyPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/isAnyPredicate.md\n---\n\n# Function: isAnyPredicate()\n\n```ts\nfunction isAnyPredicate(v: unknown): v is AnyPredicate;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L96)\n\nType guard for [AnyPredicate](../interfaces/AnyPredicate.md). An `any` combinator is a plain object whose sole\ndiscriminator key `any` holds an array of structured predicates.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n## Returns\n\n`v is AnyPredicate`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isNotPredicate","title":"Function: isNotPredicate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isNotPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isNotPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/isNotPredicate.md\n---\n\n# Function: isNotPredicate()\n\n```ts\nfunction isNotPredicate(v: unknown): v is NotPredicate;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L107)\n\nType guard for [NotPredicate](../interfaces/NotPredicate.md). A `not` combinator is a plain object whose sole\ndiscriminator key `not` holds a single structured predicate.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n## Returns\n\n`v is NotPredicate`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isPredicateLeaf","title":"Function: isPredicateLeaf()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isPredicateLeaf.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isPredicateLeaf","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/isPredicateLeaf.md\n---\n\n# Function: isPredicateLeaf()\n\n```ts\nfunction isPredicateLeaf(v: unknown): v is PredicateLeaf;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L73)\n\nType guard for [PredicateLeaf](../interfaces/PredicateLeaf.md). A leaf is a plain object carrying a string `path` and a\nstring `op`; the `op` is narrowed to `PredicateOp` only when it is a member of the closed set.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n## Returns\n\n`v is PredicateLeaf`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isStructuredPredicate","title":"Function: isStructuredPredicate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isStructuredPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/isStructuredPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/isStructuredPredicate.md\n---\n\n# Function: isStructuredPredicate()\n\n```ts\nfunction isStructuredPredicate(v: unknown): v is StructuredPredicate;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L118)\n\nType guard for the whole [StructuredPredicate](../type-aliases/StructuredPredicate.md) union. A value is a structured predicate\niff it is one of the four shapes. Because the combinator shapes are discriminated by their\nsingle key and a leaf by `path`/`op`, the four guards are mutually exclusive.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n## Returns\n\n`v is StructuredPredicate`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/loadOnce","title":"Function: loadOnce()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/loadOnce.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/loadOnce","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/loadOnce.md\n---\n\n# Function: loadOnce()\n\n```ts\nfunction loadOnce(id: string, loader: () => Promise): () => Promise;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:389](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L389)\n\nWraps a cell's `load()` so it is idempotent and converts a failed lazy `await import()` into\n`E_ORCH_CELL_UNAVAILABLE`.\n\nA cell's `load()` is expected to resolve an optional ESM peer through a lazy `await import()`.\nThat import can fail (the package is not installed), and the failure must surface as a named\n`E_ORCH_CELL_UNAVAILABLE` whose message names the missing package and its install command —\nnot as a raw module-resolution error the author cannot act on. This helper also makes `load()`\nidempotent: the wrapped loader runs at most once, and every subsequent call resolves with the\nsame outcome, so a cell can be loaded once and reused across many plans without re-importing.\n\nThe helper is deliberately minimal — it is a single idempotence + error-mapping wrapper, not a\nplugin registry. A cell that needs to register itself with a consumer's registry does so in its\nown `load()` body, before or after calling the wrapped loader.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------- | ---------------------------------------------------------------- |\n| `id` | `string` | The cell's id, used to name the missing package in the error. |\n| `loader` | () => `Promise`<`void`> | The cell's actual load body (typically a lazy `await import()`). |\n\n## Returns\n\nA wrapped loader that is idempotent and maps import failure to\n`E_ORCH_CELL_UNAVAILABLE`.\n\n() => `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/parseStructuredPredicate","title":"Function: parseStructuredPredicate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/parseStructuredPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/functions/parseStructuredPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/parseStructuredPredicate.md\n---\n\n# Function: parseStructuredPredicate()\n\n```ts\nfunction parseStructuredPredicate(\n value: unknown,\n depth?: number,\n): ParsePredicateResult;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L205)\n\nValidates an untrusted `EncodableValue` into the structured predicate IR.\n\nThis is the single authority that turns a branch/select node's `predicate` field (typed\n`EncodableValue` in the IR) into a [StructuredPredicate](../type-aliases/StructuredPredicate.md). It never throws: every failure\nreturns `{ok: false, reason}` where `reason` is MODEL-ADDRESSED — it names the offending field\nand the fix (for example, which operator is unknown and what the legal set is), so an authoring\nmodel can correct the plan in one pass.\n\nThe value is validated structurally, not by type alone: a leaf requires a string `path` and a\nclosed-set `op`; `truthy`/`exists` must not carry a `value` while every other operator must;\ncombinators require arrays of already-valid predicates (`all`/`any`) or a single one (`not`).\nA value that is none of the four shapes is refused with a reason naming the shape it most\nresembles, so the author knows what to change.\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | --------- | ------------- | ------------------------------------------------------------------------- |\n| `value` | `unknown` | `undefined` | The untrusted value to validate, as read from a plan's `predicate` field. |\n| `depth` | `number` | `0` | - |\n\n## Returns\n\n[`ParsePredicateResult`](../type-aliases/ParsePredicateResult.md)\n\nA discriminated result: `{ok: true, predicate}` on success, or `{ok: false, reason}`\nnaming the fix on failure.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/in_memory","title":"@nhtio/adk/batteries/orchestration/in\\_memory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/in_memory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/in_memory","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/in_memory.md'\n---\n\n# @nhtio/adk/batteries/orchestration/in\\_memory\n\n## Classes\n\n| Class | Description |\n| ------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| [InMemoryPlanStore](classes/InMemoryPlanStore.md) | The reference in-memory implementation of the [PlanStore](../interfaces/PlanStore.md) contract. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/in_memory/classes/InMemoryPlanStore","title":"Class: InMemoryPlanStore","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/in_memory/classes/InMemoryPlanStore.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/in_memory/classes/InMemoryPlanStore","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/in_memory/classes/InMemoryPlanStore.md\ndescription: 'The reference in-memory implementation of the [`PlanStore`](https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/PlanStore) contract.'\n---\n\n# Class: InMemoryPlanStore\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L66)\n\nThe reference in-memory implementation of the [PlanStore](../../interfaces/PlanStore.md) contract.\n\nEvery operation is asynchronous and returns a structured result rather than throwing for the\nexpected, precondition-style failures the contract names — so a caller can branch on the\noutcome without exception handling. Lifecycle transitions and run claiming are atomic with\nrespect to the single-threaded event loop: a plan is mutated only through these methods, so no\ninterleaving can observe a half-applied change.\n\nThe store commits; it does not validate. Deciding whether a plan is well-formed, whether an\nevaluator is wired, or whether a tool is on the allowlist is battery knowledge this class has\nno access to, so those checks live upstream and this class only records the outcome.\n\n## Implements\n\n* [`PlanStore`](../../interfaces/PlanStore.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew InMemoryPlanStore(): InMemoryPlanStore;\n```\n\n#### Returns\n\n`InMemoryPlanStore`\n\n## Methods\n\n### appendOps()\n\n```ts\nappendOps(\n planId: string,\n ops: PlanOp[],\nexpectedRevision?: number): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L185)\n\nAppend ops to a plan's log.\n\nThe plan must be `editable`; this is checked in the same operation as the append, which is\nwhat keeps `reviewable` and `executable` plans frozen at the only boundary that can enforce\nit. Without the check, ops could change a frozen plan's content and digest while its stored\nstate stayed frozen, and an executable plan's approval would remain bound to a prior digest —\na plan executable with content nobody approved.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |\n| `planId` | `string` | The plan to append to. |\n| `ops` | [`PlanOp`](../../types/type-aliases/PlanOp.md)\\[] | The ops to append. |\n| `expectedRevision?` | `number` | If given, the log must still be at this revision (optimistic concurrency for a single author); omit it for the multi-writer CRDT case. |\n\n#### Returns\n\n`Promise`<[`AppendResult`](../../type-aliases/AppendResult.md)>\n\nA success result carrying the new revision and digest, or `not_editable` /\n`revision_moved` with the actual state.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`appendOps`](../../interfaces/PlanStore.md#appendops)\n\n***\n\n### appendRunEvents()\n\n```ts\nappendRunEvents(\n planId: string,\n runId: string,\nevents: RunEvent[]): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:424](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L424)\n\nAppend a batch of run events atomically.\n\nThe whole array is committed as one batch, so the commit protocol can land `node_settled`,\nevery `edge_taken`, and the new `frontier_snapshot` in a single commit.\n\nA run is marked TERMINALLY settled only by `run_settled{outcome: 'completed'}`. `aborted` and\n`halted` are STOPPING POINTS, not endings: the interruption taxonomy classifies a turn abort\nas resumable with the frontier intact and the same digest, and a halted run is resumable once\nwhatever halted it is addressed. Marking those terminal made `claimRun(resumeRunId)` answer\n`run_already_settled` and `resumeRunId` unusable for the exact cases it exists to serve.\n\nA run that later resumes and completes is settled then, which is the point at which no\nfurther work can follow.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------- | ---------------------------- |\n| `planId` | `string` | The plan the run belongs to. |\n| `runId` | `string` | The run to append to. |\n| `events` | [`RunEvent`](../../types/type-aliases/RunEvent.md)\\[] | The events to append. |\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`appendRunEvents`](../../interfaces/PlanStore.md#appendrunevents)\n\n***\n\n### claimRun()\n\n```ts\nclaimRun(\n planId: string,\n expectedDigest: string,\nresumeRunId?: string): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:370](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L370)\n\nClaim a run for a plan.\n\nThe plan must be `executable` at `expectedDigest`. Without a resume id, a run is started only\nif none was ever claimed; with a resume id, that specific run is re-entered only if it exists\nand is not settled. This is what enforces one plan, at most one run, ever.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ---------------- | -------- | ------------------------------- |\n| `planId` | `string` | The plan to run. |\n| `expectedDigest` | `string` | The digest the plan must be at. |\n| `resumeRunId?` | `string` | Optional id of a run to resume. |\n\n#### Returns\n\n`Promise`<[`ClaimRunResult`](../../type-aliases/ClaimRunResult.md)>\n\nA success result carrying the run id and whether it was resumed, or a structured\nfailure.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`claimRun`](../../interfaces/PlanStore.md#claimrun)\n\n***\n\n### clonePlan()\n\n```ts\nclonePlan(\n sourcePlanId: string,\n newPlanId: string,\natRevision?: number): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L122)\n\nClone an existing plan into a new id, seeded with the source's folded state at a given\nrevision.\n\nThe clone is minted in `editable` and inherits no approval and no run — it is cold by\nconstruction. Its provenance records the parent, the parent's digest, the parent's revision,\nand the node ids that had settled `ok` when the clone was taken (or `[]` if the source never\nran). The operation is atomic: either the clone exists complete or not at all.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| -------------- | -------- | --------------------------------------------------------------------------- |\n| `sourcePlanId` | `string` | The plan to clone from. |\n| `newPlanId` | `string` | The id for the new plan. |\n| `atRevision?` | `number` | The source revision to clone at; defaults to the source's current revision. |\n\n#### Returns\n\n`Promise`<[`CreateResult`](../../type-aliases/CreateResult.md)>\n\nA success result carrying the clone's revision and digest, or `source_missing` /\n`revision_missing` / `duplicate_id`.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`clonePlan`](../../interfaces/PlanStore.md#cloneplan)\n\n***\n\n### createPlan()\n\n```ts\ncreatePlan(planId: string, meta?: {\n label?: string;\n provenance?: InstantiatedFrom;\n}): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L81)\n\nMint a new plan in the `editable` state at revision 0.\n\nThe op log is genuinely empty: revision 0 is the fold seed, not an implied op, so `readOps`\nreturns `[]` and the first authoring op produces revision 1. Instantiation lineage is\npersisted when supplied.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------------ | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |\n| `planId` | `string` | The id of the new plan. |\n| `meta?` | { `label?`: `string`; `provenance?`: [`InstantiatedFrom`](../../types/interfaces/InstantiatedFrom.md); } | Optional label and instantiation lineage to attach. |\n| `meta.label?` | `string` | - |\n| `meta.provenance?` | [`InstantiatedFrom`](../../types/interfaces/InstantiatedFrom.md) | - |\n\n#### Returns\n\n`Promise`<[`CreateResult`](../../type-aliases/CreateResult.md)>\n\nA success result carrying the new plan's revision and digest, or `duplicate_id` if\nthe id is already taken.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`createPlan`](../../interfaces/PlanStore.md#createplan)\n\n***\n\n### list()\n\n```ts\nlist(filter?: {\n state?: PlanState;\n}): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:292](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L292)\n\nList plans, optionally filtered by lifecycle state.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------------- | --------------------------------------------------------------------- | ---------------------- |\n| `filter?` | { `state?`: [`PlanState`](../../types/type-aliases/PlanState.md); } | Optional state filter. |\n| `filter.state?` | [`PlanState`](../../types/type-aliases/PlanState.md) | - |\n\n#### Returns\n\n`Promise`<[`PlanSummary`](../../types/interfaces/PlanSummary.md)\\[]>\n\nA summary of each matching plan.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`list`](../../interfaces/PlanStore.md#list)\n\n***\n\n### readApproval()\n\n```ts\nreadApproval(planId: string): Promise<\n | ApprovalRecord\n| undefined>;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L282)\n\nRead the approval record bound to a plan's current digest.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ---------------------- |\n| `planId` | `string` | The plan to read from. |\n\n#### Returns\n\n`Promise`<\n| [`ApprovalRecord`](../../types/interfaces/ApprovalRecord.md)\n| `undefined`>\n\nThe approval, or `undefined` if the plan has not been approved.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`readApproval`](../../interfaces/PlanStore.md#readapproval)\n\n***\n\n### readOps()\n\n```ts\nreadOps(planId: string, opts?: {\n sinceLamport?: number;\n throughRevision?: number;\n}): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:224](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L224)\n\nRead the ops of a plan's log.\n\n`sinceLamport` filters by clock; `throughRevision` bounds the result to a revision prefix\n(the first N ops in sorted order), which is what a historical view needs. A revision the log\nnever reached is rejected rather than silently returning everything.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ----------------------- | -------------------------------------------------------------- | --------------------------- |\n| `planId` | `string` | The plan to read from. |\n| `opts?` | { `sinceLamport?`: `number`; `throughRevision?`: `number`; } | Optional filtering options. |\n| `opts.sinceLamport?` | `number` | - |\n| `opts.throughRevision?` | `number` | - |\n\n#### Returns\n\n`Promise`<[`PlanOp`](../../types/type-aliases/PlanOp.md)\\[]>\n\nThe matching ops.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`readOps`](../../interfaces/PlanStore.md#readops)\n\n***\n\n### readProvenance()\n\n```ts\nreadProvenance(planId: string): Promise<\n | PlanProvenance\n| undefined>;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:254](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L254)\n\nRead the provenance of a plan.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ---------------------- |\n| `planId` | `string` | The plan to read from. |\n\n#### Returns\n\n`Promise`<\n| [`PlanProvenance`](../../types/type-aliases/PlanProvenance.md)\n| `undefined`>\n\nThe provenance, or `undefined` for a plan that is not a clone or was not\ninstantiated.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`readProvenance`](../../interfaces/PlanStore.md#readprovenance)\n\n***\n\n### readRunEvents()\n\n```ts\nreadRunEvents(planId: string, runId?: string): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:446](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L446)\n\nRead the events of a run.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | --------------------------------------------------- |\n| `planId` | `string` | The plan the run belongs to. |\n| `runId?` | `string` | The run to read; omitted reads the plan's only run. |\n\n#### Returns\n\n`Promise`<[`RunEvent`](../../types/type-aliases/RunEvent.md)\\[]>\n\nThe events.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`readRunEvents`](../../interfaces/PlanStore.md#readrunevents)\n\n***\n\n### readState()\n\n```ts\nreadState(planId: string): Promise<{\n digest: string;\n revision: number;\n state: PlanState;\n}>;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L264)\n\nRead the current lifecycle state, digest, and revision of a plan.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ---------------------- |\n| `planId` | `string` | The plan to read from. |\n\n#### Returns\n\n`Promise`<{\n`digest`: `string`;\n`revision`: `number`;\n`state`: [`PlanState`](../../types/type-aliases/PlanState.md);\n}>\n\nThe state, digest, and revision.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`readState`](../../interfaces/PlanStore.md#readstate)\n\n***\n\n### transition()\n\n```ts\ntransition(planId: string, t: TransitionRequest): Promise;\n```\n\nDefined in: [src/batteries/orchestration/in\\_memory.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/in_memory.ts#L326)\n\nPerform the single atomic lifecycle transition.\n\nThe plan must be in the state `t.from` implies and at `t.expectedDigest`; the pair must be a\nlegal transition. For `reviewable` → `executable`, the approval is persisted in the same\noperation. No policy is evaluated here — the battery validates, the store commits.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------- | ----------------------- |\n| `planId` | `string` | The plan to transition. |\n| `t` | [`TransitionRequest`](../../type-aliases/TransitionRequest.md) | The transition request. |\n\n#### Returns\n\n`Promise`<[`TransitionResult`](../../type-aliases/TransitionResult.md)>\n\nA success result carrying the new revision, or `state_mismatch` / `digest_mismatch`\nwith the actual state and digest, or `illegal_transition` for a request the type system did\nnot police.\n\n#### Implementation of\n\n[`PlanStore`](../../interfaces/PlanStore.md).[`transition`](../../interfaces/PlanStore.md#transition)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/AllPredicate","title":"Interface: AllPredicate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/AllPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/AllPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/AllPredicate.md\ndescription: A predicate that is satisfied only when EVERY member is satisfied.\n---\n\n# Interface: AllPredicate\n\nDefined in: [src/batteries/orchestration/predicates.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L41)\n\nA predicate that is satisfied only when EVERY member is satisfied.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------- | ----------------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `all` | [`StructuredPredicate`](../type-aliases/StructuredPredicate.md)\\[] | The member predicates; all must be satisfied. | [src/batteries/orchestration/predicates.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L43) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/AnyPredicate","title":"Interface: AnyPredicate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/AnyPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/AnyPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/AnyPredicate.md\ndescription: A predicate that is satisfied when AT LEAST ONE member is satisfied.\n---\n\n# Interface: AnyPredicate\n\nDefined in: [src/batteries/orchestration/predicates.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L47)\n\nA predicate that is satisfied when AT LEAST ONE member is satisfied.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `any` | [`StructuredPredicate`](../type-aliases/StructuredPredicate.md)\\[] | The member predicates; at least one must be satisfied. | [src/batteries/orchestration/predicates.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L49) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/NotPredicate","title":"Interface: NotPredicate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/NotPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/NotPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/NotPredicate.md\ndescription: A predicate that is satisfied exactly when its single member is NOT satisfied.\n---\n\n# Interface: NotPredicate\n\nDefined in: [src/batteries/orchestration/predicates.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L53)\n\nA predicate that is satisfied exactly when its single member is NOT satisfied.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------- | --------------------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `not` | [`StructuredPredicate`](../type-aliases/StructuredPredicate.md) | The member predicate; its negation is the result. | [src/batteries/orchestration/predicates.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L55) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLock","title":"Interface: PlanLock","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLock.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLock","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLock.md\ndescription: A single execution lease on one plan.\n---\n\n# Interface: PlanLock\n\nDefined in: [src/batteries/orchestration/locks.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L49)\n\nA single execution lease on one plan.\n\nA `PlanLock` is a TTL lease (coordination, not mutual exclusion — see the module docs). It is\nheld by the process driving a run and released when the run settles or the lease expires. It\ndoes not fence: a partitioned or GC-stalled holder can continue past expiry while a second\nexecutor legitimately acquires the lease, so a node may still be double-invoked; the per-node\n`onIndeterminate` policy plus `replaySafe` are the real defence against that ambiguity.\n\n## Methods\n\n### acquire()\n\n```ts\nacquire(o?: {\n retry?: {\n attempts?: number;\n delay?: number;\n timeout?: string | number;\n };\n}): Promise;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L59)\n\nAcquire the lease, retrying on contention.\n\nReturns `true` when this process now holds the lease, `false` when it could not acquire it\nwithin the retry budget. `retry.timeout` bounds the whole attempt (a number of milliseconds\nor a duration string), `retry.delay` is the pause between attempts, and `retry.attempts`\ncaps the number of tries. A caller that gets `false` must treat the run as executing\nelsewhere and not start a duplicate.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------- | --------------------------------------------------------------------------------------------------- |\n| `o?` | { `retry?`: { `attempts?`: `number`; `delay?`: `number`; `timeout?`: `string` | `number`; }; } |\n| `o.retry?` | { `attempts?`: `number`; `delay?`: `number`; `timeout?`: `string` | `number`; } |\n| `o.retry.attempts?` | `number` |\n| `o.retry.delay?` | `number` |\n| `o.retry.timeout?` | `string` | `number` |\n\n#### Returns\n\n`Promise`<`boolean`>\n\n***\n\n### acquireImmediately()\n\n```ts\nacquireImmediately(): Promise;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L69)\n\nAcquire the lease with a single, non-retrying attempt.\n\nReturns `true` when this process now holds the lease, `false` when it is held elsewhere.\nUseful for a fast, best-effort check before committing to a run.\n\n#### Returns\n\n`Promise`<`boolean`>\n\n***\n\n### extend()\n\n```ts\nextend(duration?: string | number): Promise;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L97)\n\nExtend the lease's TTL.\n\nExists so a long `call` node keeps its lease alive past the original TTL. `duration` is the\nnew remaining time (a number of milliseconds or a duration string); when omitted, the lease\nis extended by its configured TTL. A no-op if this process no longer holds the lease.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | -------------------- |\n| `duration?` | `string` | `number` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### getOwner()\n\n```ts\ngetOwner(): string;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L120)\n\nThe identity of the current holder, or an empty string when the lease is free.\n\nSynchronous and best-effort — it reflects the last observed state, not a fresh read.\n\n#### Returns\n\n`string`\n\n***\n\n### getRemainingTime()\n\n```ts\ngetRemainingTime(): Promise;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L105)\n\nThe lease's remaining time-to-live in milliseconds.\n\nExists so a long `call` node can decide whether to `extend()` before the lease lapses. A\nnon-positive value means the lease has expired (or is held elsewhere).\n\n#### Returns\n\n`Promise`<`number`>\n\n***\n\n### isLocked()\n\n```ts\nisLocked(): Promise;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L113)\n\nWhether the lease is currently held (by any process).\n\nA best-effort liveness probe; it does not tell the caller whether THIS process holds the\nlease, and it is subject to the same partition/GC blind spot as every TTL lease.\n\n#### Returns\n\n`Promise`<`boolean`>\n\n***\n\n### release()\n\n```ts\nrelease(): Promise;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L78)\n\nRelease the lease.\n\nIdempotent and safe to call when the lease is already expired or held by another process —\nit must not release a lease this process does not hold. Called when a run settles or is\nabandoned.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### run()\n\n```ts\nrun(fn: () => Promise): Promise<[boolean, T]>;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L88)\n\nRun `fn` while holding the lease.\n\nReturns `[executed, result]` as a tuple: `[false]` when the lease is held elsewhere, so a\nsecond process reports \"already executing elsewhere\" rather than starting a duplicate; on\nsuccess it returns `[true, result]` with `fn`'s resolved value. The lease is released when\n`fn` settles, whether it resolves or rejects.\n\n#### Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `T` |\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ---------------------- |\n| `fn` | () => `Promise`<`T`> |\n\n#### Returns\n\n`Promise`<\\[`boolean`, `T`]>\n\n***\n\n### serialize()\n\n```ts\nserialize(): string;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L129)\n\nSerialize the lease to a string.\n\nExists so a lease can be handed from the process that started a run to the one resuming it:\nthe resuming process passes the serialized lease to `PlanLockFactory.restoreLock` and\ncontinues holding the same lease rather than racing to re-acquire it.\n\n#### Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLockFactory","title":"Interface: PlanLockFactory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLockFactory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLockFactory","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/PlanLockFactory.md\ndescription: Creates and restores `PlanLock` instances for a deployment.\n---\n\n# Interface: PlanLockFactory\n\nDefined in: [src/batteries/orchestration/locks.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L140)\n\nCreates and restores `PlanLock` instances for a deployment.\n\nA BYO seam: a consumer can satisfy it with Verrou directly (memory / Redis / Postgres drivers)\nor with anything else; the battery adds no dependency. Supplying a factory makes concurrent\nexecution UNLIKELY rather than impossible — it does not fence, and a partitioned holder can\nstill double-invoke a node (see the module docs).\n\n## Methods\n\n### createLock()\n\n```ts\ncreateLock(key: string, ttl?: string | number): PlanLock;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L145)\n\nCreate a new lease for `key`, with an optional TTL (a number of milliseconds or a duration\nstring). The lease is not acquired until `acquire`/`acquireImmediately`/`run` is called.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------- |\n| `key` | `string` |\n| `ttl?` | `string` | `number` |\n\n#### Returns\n\n[`PlanLock`](PlanLock.md)\n\n***\n\n### restoreLock()\n\n```ts\nrestoreLock(serialized: string): PlanLock;\n```\n\nDefined in: [src/batteries/orchestration/locks.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/locks.ts#L154)\n\nRehydrate a lease from a string produced by `PlanLock.serialize`.\n\nExists so a lease can be handed from the process that started a run to the one resuming it,\nletting the resuming process continue holding the same lease rather than racing to re-acquire\nit. The restored lock must behave as the original for the remainder of its TTL.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | -------- |\n| `serialized` | `string` |\n\n#### Returns\n\n[`PlanLock`](PlanLock.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanStore","title":"Interface: PlanStore","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanStore.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PlanStore","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/PlanStore.md\ndescription: >-\n The one contract for plans and runs — not a second store. **Every method is\n async**; nothing here is sync-or-async. A durable plan store is I/O by nature,\n the lifecycle transition is inherently a round-trip, and the cell seam is\n async too, so a uniform `Promise` surface is one less thing for eleven work\n packages to get inconsistently right.\n---\n\n# Interface: PlanStore\n\nDefined in: [src/batteries/orchestration/store.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L22)\n\nThe one contract for plans and runs — not a second store. **Every method is async**; nothing\nhere is sync-or-async. A durable plan store is I/O by nature, the lifecycle transition is\ninherently a round-trip, and the cell seam is async too, so a uniform `Promise` surface is one\nless thing for eleven work packages to get inconsistently right.\n\nThe store commits; it does not validate. Deciding \"is an evaluator wired\", \"is this tool on the\ntier-C allowlist\", or \"does this reference taint a call arg\" requires battery knowledge a BYO\nstore has no access to, and putting it here would force every store implementor to reimplement\nthe validator. So the split is: **the battery validates, the store commits.**\n\n## Methods\n\n### appendOps()\n\n```ts\nappendOps(\n planId: string,\n ops: PlanOp[],\nexpectedRevision?: number): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L69)\n\nAppend ops. **Rejects unless the plan is `editable`**, checked in the SAME COMMIT as the\nappend — this is what makes `reviewable` and `executable` actually frozen, at the only\nboundary that can enforce it. `transition()` cannot enforce this because it is not on the\nappend path: without the check, ops could change a frozen plan's content and digest while its\nstored state stayed frozen, and in the `executable` case the `ApprovalRecord` would remain\nbound to the PRIOR digest — making the plan executable with content that was never approved.\nIt returns `not_editable` with the actual state rather than throwing, so a stale writer learns\nwhat happened.\n\n`expectedRevision`, when given, additionally rejects if the log has moved (optimistic\nconcurrency for a single author); omit it for the multi-writer CRDT case, where convergence\nis the concurrency story.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------------- | --------------------------------------------- |\n| `planId` | `string` |\n| `ops` | [`PlanOp`](../types/type-aliases/PlanOp.md)\\[] |\n| `expectedRevision?` | `number` |\n\n#### Returns\n\n`Promise`<[`AppendResult`](../type-aliases/AppendResult.md)>\n\n***\n\n### appendRunEvents()\n\n```ts\nappendRunEvents(\n planId: string,\n runId: string,\nevents: RunEvent[]): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L139)\n\nOrdered, atomic-as-a-batch, and scoped to the claimed run. Takes an ARRAY and commits it\natomically as a batch, because the commit protocol depends on it: `node_settled` + every\n`edge_taken` + the new `frontier_snapshot` are ONE commit. A backend that cannot do this is\nnot conforming.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------- |\n| `planId` | `string` |\n| `runId` | `string` |\n| `events` | [`RunEvent`](../types/type-aliases/RunEvent.md)\\[] |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### claimRun()\n\n```ts\nclaimRun(\n planId: string,\n expectedDigest: string,\nresumeRunId?: string): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L131)\n\nClaim the plan's ONE run, or RE-ENTER it to resume. Conditional and durable: requires the\nplan `executable` at `expectedDigest`. Without `resumeRunId` it starts a run and succeeds\nonly if none has ever been claimed. With `resumeRunId` it re-enters that specific run and\nsucceeds only if that run exists and is not already settled — this is the contractual\ndifference between a permitted re-entry and a prohibited second run, which a start-only\noperation could not express.\n\n\"Settled\" here means COMPLETED, and the distinction is load-bearing. `aborted` and `halted`\nare stopping points, not endings: the interruption taxonomy classifies a turn abort as\nresumable with the frontier intact at the same digest, so a store that treats every\n`run_settled` as terminal makes `resumeRunId` answer `run_already_settled` for exactly the\ncases it exists to serve. A conforming store must admit re-entry after `aborted`/`halted`\nand refuse it after `completed`.\n\nThis — not the optional lock — is what enforces \"one plan, at most one run, ever\": the lock\nseam is an availability measure a deployment may omit, so the invariant cannot rest on it.\nThe executor MUST claim before invoking any node.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------------- | -------- |\n| `planId` | `string` |\n| `expectedDigest` | `string` |\n| `resumeRunId?` | `string` |\n\n#### Returns\n\n`Promise`<[`ClaimRunResult`](../type-aliases/ClaimRunResult.md)>\n\n***\n\n### clonePlan()\n\n```ts\nclonePlan(\n sourcePlanId: string,\n newPlanId: string,\natRevision?: number): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L53)\n\nMint `newPlanId` in `editable`, seeded with the folded state of `sourcePlanId` at\n`atRevision` (default: its current revision), carrying provenance\n`{parent, parentDigest, parentRevision}`. Inherits NO approval and NO run — a clone is cold\nby construction. Atomic: either the clone exists complete, or not at all.\n\n#### Parameters\n\n| Parameter | Type |\n| -------------- | -------- |\n| `sourcePlanId` | `string` |\n| `newPlanId` | `string` |\n| `atRevision?` | `number` |\n\n#### Returns\n\n`Promise`<[`CreateResult`](../type-aliases/CreateResult.md)>\n\n***\n\n### createPlan()\n\n```ts\ncreatePlan(planId: string, meta?: {\n label?: string;\n provenance?: InstantiatedFrom;\n}): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L35)\n\nMint a new plan in `editable` at **revision 0 with a genuinely EMPTY op log**. Rejects a\nduplicate id.\n\nBounds are **genesis content, not an op**: the fold starts from `DEFAULT_PLAN_BOUNDS` and\n`set_bounds` ops override it. An earlier draft said the log \"begins with an implied\n`set_bounds`\", which was incoherent — a `PlanOp` requires `opId`/`actorId`/`lamport`/`at` and\n`createPlan` has none of those to mint, and it left `readOps`, `throughRevision` and\n`rawDiff` ambiguous about whether revision 0 contained an op. So: `readOps` on a fresh plan\nreturns `[]`, revision 0 is the empty fold, and the first authoring op makes revision 1. The\nfold's *seed* is a constant; the log is exclusively authored ops.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------------ | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `planId` | `string` | - |\n| `meta?` | { `label?`: `string`; `provenance?`: [`InstantiatedFrom`](../types/interfaces/InstantiatedFrom.md); } | - |\n| `meta.label?` | `string` | - |\n| `meta.provenance?` | [`InstantiatedFrom`](../types/interfaces/InstantiatedFrom.md) | Instantiation lineage, when the plan comes from a template. The store persists it and `readProvenance` returns it — without this parameter `instantiate()` had nowhere to write it, since `PlanOp` cannot carry provenance and `clonePlan` writes only clone lineage. |\n\n#### Returns\n\n`Promise`<[`CreateResult`](../type-aliases/CreateResult.md)>\n\n***\n\n### list()\n\n```ts\nlist(filter?: {\n state?: PlanState;\n}): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L170)\n\nSummaries of every plan, optionally filtered by lifecycle state.\n\n#### Parameters\n\n| Parameter | Type |\n| --------------- | ------------------------------------------------------------------ |\n| `filter?` | { `state?`: [`PlanState`](../types/type-aliases/PlanState.md); } |\n| `filter.state?` | [`PlanState`](../types/type-aliases/PlanState.md) |\n\n#### Returns\n\n`Promise`<[`PlanSummary`](../types/interfaces/PlanSummary.md)\\[]>\n\n***\n\n### readApproval()\n\n```ts\nreadApproval(planId: string): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:167](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L167)\n\nThe approval record persisted with the `reviewable → executable` transition, if the plan is\n`executable`.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `planId` | `string` |\n\n#### Returns\n\n`Promise`<[`ApprovalRecord`](../types/interfaces/ApprovalRecord.md) | `undefined`>\n\n#### Remarks\n\n**The DIGEST on this record is bound; the AUTHORITY SET is only as trustworthy as the caller\nthat wrote it.** `transition` proves the plan is at `expectedDigest` before it commits, so a\nrecord whose `digest` disagrees with the plan cannot be persisted. It does NOT — and cannot —\ncheck that `authoritySet` matches the plan's reachable claims: recomputing that set requires\nwalking the graph and knowing what a `call` node is, which is battery knowledge a BYO store\ndoes not have. That check lives in approvePlan, which recomputes the set and asserts\nset-equality BEFORE calling `transition`.\n\nSo a caller that bypasses `approvePlan` and calls `transition` directly can persist a record\nclaiming an authority set the plan never had. **That forged set grants nothing**: the executor\nnever reads `authoritySet`, and what a run may actually invoke is bounded by the tier-C\n`InvocableTools` allowlist enforced at freeze. The damage is to the AUDIT TRAIL — anyone\nreading this record back is told the operator approved something they did not.\n\nTreat `approvePlan` as the only supported way to reach `executable`. If you display or audit\nthis record, recompute the authority set from the plan with `computeAuthoritySet` rather than\ntrusting the stored copy.\n\n***\n\n### readOps()\n\n```ts\nreadOps(planId: string, opts?: {\n sinceLamport?: number;\n throughRevision?: number;\n}): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L77)\n\nRead the op log. `sinceLamport` filters by clock; `throughRevision` bounds it to a REVISION\nPREFIX, which is what `rawPlan({revision})` and `rawDiff(a, b)` need — a Lamport value is not\na revision selector, and without this a conforming store could not serve a historical view at\nall. Rejects a revision the log never reached rather than silently returning everything.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------------- | -------------------------------------------------------------- |\n| `planId` | `string` |\n| `opts?` | { `sinceLamport?`: `number`; `throughRevision?`: `number`; } |\n| `opts.sinceLamport?` | `number` |\n| `opts.throughRevision?` | `number` |\n\n#### Returns\n\n`Promise`<[`PlanOp`](../types/type-aliases/PlanOp.md)\\[]>\n\n***\n\n### readProvenance()\n\n```ts\nreadProvenance(planId: string): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L83)\n\nClone lineage, for `RawPlanView.provenance`. `undefined` for a plan that is not a clone.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `planId` | `string` |\n\n#### Returns\n\n`Promise`<[`PlanProvenance`](../types/type-aliases/PlanProvenance.md) | `undefined`>\n\n***\n\n### readRunEvents()\n\n```ts\nreadRunEvents(planId: string, runId?: string): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L142)\n\nThe claimed run's event log. `runId` omitted reads the plan's only run.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `planId` | `string` |\n| `runId?` | `string` |\n\n#### Returns\n\n`Promise`<[`RunEvent`](../types/type-aliases/RunEvent.md)\\[]>\n\n***\n\n### readState()\n\n```ts\nreadState(planId: string): Promise<{\n digest: string;\n revision: number;\n state: PlanState;\n}>;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L110)\n\nThe plan's lifecycle state NOW, alongside its current digest and revision. `state` is not a\n`PlanOp`, so it cannot be folded from the log; it lives here, and a historical revision has\nnone to report. `readState` exists because `list({state})` needs a durable, race-safe state\nread.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `planId` | `string` |\n\n#### Returns\n\n`Promise`<{\n`digest`: `string`;\n`revision`: `number`;\n`state`: [`PlanState`](../types/type-aliases/PlanState.md);\n}>\n\n***\n\n### transition()\n\n```ts\ntransition(planId: string, t: TransitionRequest): Promise;\n```\n\nDefined in: [src/batteries/orchestration/store.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L102)\n\nThe ONE atomic lifecycle operation, and deliberately a NARROW one: it proves the plan is in\n`expected.state` at `expectedDigest`, checks the target is a legal successor, and applies it —\npersisting `approval` in the SAME COMMIT for `reviewable → executable`. It returns the losing\noutcome rather than throwing, so a caller that lost can read what actually happened.\n\nA store does NOT evaluate policy. It cannot: deciding \"is an evaluator wired\", \"is this tool\non the tier-C allowlist\", or \"does this reference taint a call arg\" requires battery knowledge\na BYO store has no access to, and putting it here would force every store implementor to\nreimplement the validator. So the split is: **the battery validates, the store commits.**\n\nThe digest is what makes that safe rather than racy: the battery validates content at digest\nD and the store commits only if the plan is still at D, so a concurrent edit invalidates the\ntransition instead of slipping past an already-passed check. A direct caller bypassing\n`freezePlan` can still reach `transition` — that is a misuse the docs name, not a hole the\nstore can close, exactly as a direct `appendOps` caller can bypass the authoring tools.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------- |\n| `planId` | `string` |\n| `t` | [`TransitionRequest`](../type-aliases/TransitionRequest.md) |\n\n#### Returns\n\n`Promise`<[`TransitionResult`](../type-aliases/TransitionResult.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PredicateLeaf","title":"Interface: PredicateLeaf","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PredicateLeaf.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/interfaces/PredicateLeaf","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/interfaces/PredicateLeaf.md\ndescription: >-\n A leaf predicate: read `path` from the readable context and compare it with\n `op`.\n---\n\n# Interface: PredicateLeaf\n\nDefined in: [src/batteries/orchestration/predicates.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L31)\n\nA leaf predicate: read `path` from the readable context and compare it with `op`.\n\n`value` is optional because `truthy` and `exists` are unary — they need no right-hand side.\nFor every other operator `parseStructuredPredicate` requires `value` to be present.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `op` | [`PredicateOp`](../type-aliases/PredicateOp.md) | The comparison operator. `truthy`/`exists` are unary and must not carry `value`. | [src/batteries/orchestration/predicates.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L35) |\n| `path` | `string` | The dot-path into the readable context to read and compare. | [src/batteries/orchestration/predicates.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L33) |\n| `value?` | [`EncodableValue`](../types/type-aliases/EncodableValue.md) | The right-hand side to compare against. Required for every operator except `truthy`/`exists`. | [src/batteries/orchestration/predicates.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L37) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops","title":"@nhtio/adk/batteries/orchestration/ops","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/ops.md'\ndescription: The op-log fold and the branch-key renderer for orchestration.\n---\n\n# @nhtio/adk/batteries/orchestration/ops\n\nThe op-log fold and the branch-key renderer for orchestration.\n\n## Remarks\n\nThis module owns two things:\n\n1. `foldOps` — the DETERMINISTIC fold that turns a plan's op log into a `RawPlanView`. The plan\n IS the fold of its op log: two actors folding the same op set must reach the same state, and\n ops may arrive out of order or twice. The fold never throws on a malformed-but-well-typed\n log; it surfaces `PlanIssue`s instead.\n2. `branchKey` — the canonical, INJECTIVE string form of a `BranchId` route, used to key\n `OutputTable`, identify `NodeRef.branchId`, order join contributors, and make duplicate\n arrivals idempotent.\n\n## Functions\n\n| Function | Description |\n| ----------------------------------- | ------------------------------------------------------------------------ |\n| [branchKey](functions/branchKey.md) | The canonical, INJECTIVE string form of a `BranchId` route. |\n| [foldOps](functions/foldOps.md) | Fold an op log into a `RawPlanView`, deterministically and convergently. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops/functions/branchKey","title":"Function: branchKey()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops/functions/branchKey.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops/functions/branchKey","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/ops/functions/branchKey.md\n---\n\n# Function: branchKey()\n\n```ts\nfunction branchKey(b: BranchId): string;\n```\n\nDefined in: [src/batteries/orchestration/ops.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/ops.ts#L322)\n\nThe canonical, INJECTIVE string form of a `BranchId` route.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------ | -------------------- |\n| `b` | [`BranchId`](../../types/interfaces/BranchId.md) | The route to render. |\n\n## Returns\n\n`string`\n\nThe length-prefixed, separator-free canonical string.\n\n## Remarks\n\n`branchKey` keys `OutputTable`, identifies `NodeRef.branchId`, orders join contributors, and\nmakes duplicate arrivals idempotent — so a collision would overwrite one node's output with\nanother's or merge unrelated barriers. It MUST therefore be injective.\n\nNaive delimiter-joining is NOT injective: an edge id containing the delimiter (`a>b`) collides\nwith two segments (`a`, `b`), and an id shaped like `join:x(y)` collides with a join segment. So\nthe rendering is LENGTH-PREFIXED, concatenated with no separator:\n\n* an edge segment renders as `` `e${id.length}:${id}` ``;\n* a join segment renders as `` `j${nodeId.length}:${nodeId}(${of.map(len-prefixed).join('')})` ``.\n\nLength-prefixing is injective regardless of content: a parser reads the length, then exactly\nthat many characters for the id, so no delimiter can be forged and no two distinct routes render\nto the same string. The `e`/`j` prefixes keep edge and join segments disjoint, and the join's\n`of` ids are themselves length-prefixed so the closing `)` is unambiguous.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops/functions/foldOps","title":"Function: foldOps()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops/functions/foldOps.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/ops/functions/foldOps","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/ops/functions/foldOps.md\n---\n\n# Function: foldOps()\n\n```ts\nfunction foldOps(\n planId: string,\n ops: readonly PlanOp[],\n provenance?: PlanProvenance,\n): {\n issues: PlanIssue[];\n view: RawPlanView;\n};\n```\n\nDefined in: [src/batteries/orchestration/ops.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/ops.ts#L165)\n\nFold an op log into a `RawPlanView`, deterministically and convergently.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------- |\n| `planId` | `string` | The plan's id, carried into the view. |\n| `ops` | readonly [`PlanOp`](../../types/type-aliases/PlanOp.md)\\[] | The op log to fold. May be empty, out of order, or contain duplicates. |\n| `provenance?` | [`PlanProvenance`](../../types/type-aliases/PlanProvenance.md) | Optional lineage (clone/template), carried into the view and covered by the digest. |\n\n## Returns\n\n```ts\n{\n issues: PlanIssue[];\n view: RawPlanView;\n}\n```\n\nThe folded view and any issues the fold surfaced.\n\n| Name | Type | Defined in |\n| -------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `issues` | [`PlanIssue`](../../types/interfaces/PlanIssue.md)\\[] | [src/batteries/orchestration/ops.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/ops.ts#L169) |\n| `view` | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [src/batteries/orchestration/ops.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/ops.ts#L169) |\n\n## Remarks\n\nThe plan is the fold of its op log. Two actors folding the same op set must reach the same\nstate, and ops may arrive out of order or twice. The fold is therefore a pure function of the\nop SET: it sorts by the three-part key `(lamport, actorId, opId)` — see byKey for why\nall three parts are required — and applies the ops in that total order. Because the highest-key\nop touching any element is applied last, the result is LWW (last-writer-wins) and identical for\nevery arrival order.\n\n**Ops are strictly read-only input.** The fold never mutates the caller's op objects: on\n`add_node` and `set_node_definition` it copies the plain-object/array SPINE of the node or\ndefinition (carrying every encoder-owned value — `Date`, `RegExp`, `Map`, `Set`, typed arrays,\nbigint, `NodeRef`/`ParamRef` instances — across by reference), and `set_node_field`/\n`set_node_phase` write only onto those copies. So a `PlanStore` can serve historical views from\nthe same op log without a read-only projection silently altering it.\n\n**Bounds are the fold SEED, not an op.** The fold starts from `DEFAULT_PLAN_BOUNDS`, so an empty\nlog folds to revision 0 with a complete view and a stable digest, and the first authoring op\nmakes revision 1. `revision` is the number of ops folded. `set_bounds` ops override the seed by\nLWW thereafter.\n\n**Element semantics.** `add_node`/`remove_node` and `add_edge`/`remove_edge` are LWW-ELEMENT,\nnot add-wins: the highest-key op touching an element decides whether it exists. Add-wins is\ndeliberately NOT attempted — it needs causal context a scalar lamport cannot provide. A\n`remove_node` also records its `incidentEdgeIds`, so removal cascades to those edges\norder-independently. `set_node_field` is LWW per field on the same three-part key (its value may\ncontain a `NodeRef`, so it accepts `ArgValue`); `set_node_definition` replaces a whole\ndefinition by LWW; `set_node_phase` sets a phase, with `null` clearing it; `set_bounds` overrides\nthe seed by LWW.\n\n**The fold surfaces issues rather than throwing.** It never throws on a malformed-but-well-typed\nlog:\n\n* An edge whose `from` or `to` node does not exist after folding is DROPPED and surfaced as a\n `dangling_edge` issue — a dangling edge is never what anyone wanted.\n* Two `add_edge` ops with the SAME id but different endpoints: LWW decides, the loser is dropped,\n and the issue names BOTH so the author renames one. The second is not refused at append time —\n that would make the fold order-dependent, and two offline writers can each legally append\n before their logs meet.\n* An op referencing an unknown nodeId is surfaced as an `unknown_node` issue, not thrown.\n\nThe `digest` is computed via `planDigest(view)` with the digest field itself empty when hashing,\nso it cannot depend on itself.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan","title":"@nhtio/adk/batteries/orchestration/plan","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan.md'\ndescription: 'The IR''s runtime helpers: pure, graph-shaped predicates and guards.'\n---\n\n# @nhtio/adk/batteries/orchestration/plan\n\nThe IR's runtime helpers: pure, graph-shaped predicates and guards.\n\n## Remarks\n\nThis module is the shared vocabulary that WP 04's freeze validation and WP 07's executor both\ncall. It performs NO validation policy itself and throws nothing — it answers questions about a\ngraph. Every export is a pure function over `{nodes, edges}` (a `RawPlanView` or any structural\nsubset carrying those two arrays), so the same code path serves a full folded view and a\nhand-built slice.\n\nThe functions here are deliberately small and single-purpose. Policy — \"exactly one entry\",\n\"the graph is acyclic\", \"every join is a diamond\" — lives in the freeze validator, which\ncomposes these primitives; the executor composes them to decide what fires next. Neither\nreimplements a graph walk.\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [PlanGraphView](interfaces/PlanGraphView.md) | The minimal structural surface these helpers read. A `RawPlanView` satisfies it; so does any `{nodes, edges}` subset. Accepting the subset keeps the helpers usable on slices and test fixtures without forcing a full view. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------- | ----------------------------------------------------------------------------- |\n| [entryNodes](functions/entryNodes.md) | Every node of kind `'entry'`. |\n| [findCycle](functions/findCycle.md) | Find a cycle in the graph, over EVERY edge handle. |\n| [handleAppliesTo](functions/handleAppliesTo.md) | Whether an edge handle may be used on an edge leaving a node of a given kind. |\n| [immediateDominator](functions/immediateDominator.md) | The immediate dominator of a node, relative to an entry. |\n| [incoming](functions/incoming.md) | The edges entering a node. |\n| [isPlanEdge](functions/isPlanEdge.md) | True when `v` is a well-shaped `PlanEdge`. |\n| [isPlanNode](functions/isPlanNode.md) | True when `v` is a well-shaped `PlanNode`. |\n| [isValidEdgeId](functions/isValidEdgeId.md) | Whether a string is a valid edge id. |\n| [isValidNodeId](functions/isValidNodeId.md) | Whether a string is a valid node id. |\n| [nodeById](functions/nodeById.md) | Look up a node by id. |\n| [outgoing](functions/outgoing.md) | The edges leaving a node. |\n| [reachableFrom](functions/reachableFrom.md) | The forward closure from a start node over ALL edge handles. |\n| [readPath](functions/readPath.md) | Read a dot-path from a value, with a per-segment prototype-pollution guard. |\n| [routesBetween](functions/routesBetween.md) | All distinct simple paths from one node to another. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/entryNodes","title":"Function: entryNodes()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/entryNodes.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/entryNodes","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/entryNodes.md\n---\n\n# Function: entryNodes()\n\n```ts\nfunction entryNodes(view: RawPlanView | PlanGraphView): PlanNode[];\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L151)\n\nEvery node of kind `'entry'`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n\n## Returns\n\n[`PlanNode`](../../types/type-aliases/PlanNode.md)\\[]\n\nEvery node whose `kind` is `'entry'`, in view order.\n\n## Remarks\n\nWhether exactly one exists is WP 04's rule, not this function's. The executor calls this to\nfind what to materialise; the freeze validator calls it to enforce the exactly-one invariant.\nReturning an array (rather than a single node) keeps this a pure question about the graph and\nlets the caller decide what a count of zero or more than one means.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/findCycle","title":"Function: findCycle()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/findCycle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/findCycle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/findCycle.md\n---\n\n# Function: findCycle()\n\n```ts\nfunction findCycle(view: RawPlanView | PlanGraphView):\n | {\n edgeId: string;\n from: string;\n to: string;\n }\n | undefined;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L207)\n\nFind a cycle in the graph, over EVERY edge handle.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n\n## Returns\n\n| {\n`edgeId`: `string`;\n`from`: `string`;\n`to`: `string`;\n}\n| `undefined`\n\nThe closing edge of the first cycle found, or `undefined` when acyclic.\n\n## Remarks\n\nA topological sort over all edges — `error` and `default` included — because an error edge back\nto an ancestor is still a cycle: it can still execute, so it can still loop. A diamond fan-in\n(two distinct paths reaching one node) is NOT a cycle and is not reported. The function returns\nthe CLOSING edge — the edge whose `to` is already on the current path — so a caller can name it\nin an issue. Returns `undefined` when the graph is acyclic.\n\nThe algorithm is an iterative DFS with three node states (unvisited / on-stack / done). When a\nback edge is found, the edge that closes the cycle is returned immediately.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/handleAppliesTo","title":"Function: handleAppliesTo()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/handleAppliesTo.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/handleAppliesTo","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/handleAppliesTo.md\n---\n\n# Function: handleAppliesTo()\n\n```ts\nfunction handleAppliesTo(kind: PlanNodeKind, handle: EdgeHandle): boolean;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L448)\n\nWhether an edge handle may be used on an edge leaving a node of a given kind.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------- | ------------------------ |\n| `kind` | [`PlanNodeKind`](../../types/type-aliases/PlanNodeKind.md) | The source node's kind. |\n| `handle` | [`EdgeHandle`](../../types/type-aliases/EdgeHandle.md) | The edge handle to test. |\n\n## Returns\n\n`boolean`\n\nTrue when the handle is legal for that node kind.\n\n## Remarks\n\nThe applicability table, exactly:\n\n* `entry` → `'always'`\n* `call` | `reason` | `transform` → `'always'` | `'error'`\n* `branch` → `'match'` | `'no_match'` | `'default'` | `'error'`\n* `select` → `case_${string}` | `'default'` | `'error'`\n* `join` → `'always'` | `'error'`\n\nThis is a pure question about the graph; the freeze validator enforces it as policy. The\nexecutor uses it to decide which handles may fire for a settled node's outcome.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/immediateDominator","title":"Function: immediateDominator()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/immediateDominator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/immediateDominator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/immediateDominator.md\n---\n\n# Function: immediateDominator()\n\n```ts\nfunction immediateDominator(\n view: RawPlanView | PlanGraphView,\n entryId: string,\n nodeId: string,\n): string | undefined;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:326](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L326)\n\nThe immediate dominator of a node, relative to an entry.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n| `entryId` | `string` | The entry node id. |\n| `nodeId` | `string` | The node whose immediate dominator to find. |\n\n## Returns\n\n`string` | `undefined`\n\nThe immediate dominator's id, or `undefined` when none exists.\n\n## Remarks\n\nThe standard iterative dominator algorithm (Cooper–Harvey–Kennedy). A node `d` dominates `n`\nwhen every path from `entryId` to `n` passes through `d`; the immediate dominator is the unique\nstrict dominator closest to `n`. A join's FORK is its immediate dominator — which is what makes\ndiamond joins decidable: the fork is known statically, so correlation and `required` are\ncomputable at freeze.\n\nReturns `undefined` when `nodeId` is the entry itself (a node does not dominate itself in the\nimmediate sense) or when `nodeId` is unreachable from `entryId` (no dominator exists).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/incoming","title":"Function: incoming()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/incoming.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/incoming","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/incoming.md\n---\n\n# Function: incoming()\n\n```ts\nfunction incoming(\n view: RawPlanView | PlanGraphView,\n nodeId: string,\n): PlanEdge[];\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L135)\n\nThe edges entering a node.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n| `nodeId` | `string` | The target node id. |\n\n## Returns\n\n[`PlanEdge`](../../types/interfaces/PlanEdge.md)\\[]\n\nEvery edge whose `to` is `nodeId`, in view order.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanEdge","title":"Function: isPlanEdge()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanEdge.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanEdge","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanEdge.md\n---\n\n# Function: isPlanEdge()\n\n```ts\nfunction isPlanEdge(v: unknown): v is PlanEdge;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L95)\n\nTrue when `v` is a well-shaped `PlanEdge`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `v` | `unknown` | The value to test. |\n\n## Returns\n\n`v is PlanEdge`\n\nTrue when `v` is a `PlanEdge`.\n\n## Remarks\n\nA shape guard, not a validator. `handle` must be one of the closed `EdgeHandle` values — the\nfive literal handles, or a `case_${string}` (the `case_` prefix is reserved for `select` cases,\nso any string starting with `case_` is a legal handle). `id`, `from` and `to` must be strings.\nExtra fields are tolerated.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanNode","title":"Function: isPlanNode()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanNode.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanNode","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/isPlanNode.md\n---\n\n# Function: isPlanNode()\n\n```ts\nfunction isPlanNode(v: unknown): v is PlanNode;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L62)\n\nTrue when `v` is a well-shaped `PlanNode`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `v` | `unknown` | The value to test. |\n\n## Returns\n\n`v is PlanNode`\n\nTrue when `v` is a `PlanNode`.\n\n## Remarks\n\nA shape guard, not a validator: it checks the closed union of `kind` values and the presence of\nthe `id`/`definition` fields, and does not descend into the definition (whose shape is the\nfreeze validator's job). `kind` must be one of the seven closed values; anything else is not a\nplan node. `id` must be a string; `definition` must be a non-null object. Extra fields are\ntolerated — a node may carry `phase`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidEdgeId","title":"Function: isValidEdgeId()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidEdgeId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidEdgeId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidEdgeId.md\n---\n\n# Function: isValidEdgeId()\n\n```ts\nfunction isValidEdgeId(id: string): boolean;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:529](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L529)\n\nWhether a string is a valid edge id.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------- |\n| `id` | `string` | The string to test. |\n\n## Returns\n\n`boolean`\n\nTrue when `id` is a valid edge id.\n\n## Remarks\n\nAn edge id must match `/^[A-Za-z0-9_-]{1,64}$/` — no delimiter, no colon, no parenthesis — so\n`branchKey` cannot be forged. This is the same charset rule the freeze validator enforces; this\nguard is the pure predicate it calls. The length cap (1–64) bounds the length-prefixed route\nrendering.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidNodeId","title":"Function: isValidNodeId()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidNodeId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidNodeId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/isValidNodeId.md\n---\n\n# Function: isValidNodeId()\n\n```ts\nfunction isValidNodeId(id: string): boolean;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:514](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L514)\n\nWhether a string is a valid node id.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------- |\n| `id` | `string` | The string to test. |\n\n## Returns\n\n`boolean`\n\nTrue when `id` is a valid node id.\n\n## Remarks\n\nA valid node id is snake\\_case: lowercase ASCII letters, digits and underscores, with no `/` and\nno leading `.`. The `/` and leading-`.` rules are load-bearing: a path-shaped id gets copied by\nsmall models as a citation, which cost a real 35–57 dispatch re-cite loop in this repo. Keeping\nnode ids out of path shape means a model cannot mistake one for a file path and re-cite it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/nodeById","title":"Function: nodeById()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/nodeById.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/nodeById","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/nodeById.md\n---\n\n# Function: nodeById()\n\n```ts\nfunction nodeById(\n view: RawPlanView | PlanGraphView,\n id: string,\n): PlanNode | undefined;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L115)\n\nLook up a node by id.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n| `id` | `string` | The node id to find. |\n\n## Returns\n\n[`PlanNode`](../../types/type-aliases/PlanNode.md) | `undefined`\n\nThe node, or `undefined` when no node carries that id.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/outgoing","title":"Function: outgoing()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/outgoing.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/outgoing","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/outgoing.md\n---\n\n# Function: outgoing()\n\n```ts\nfunction outgoing(\n view: RawPlanView | PlanGraphView,\n nodeId: string,\n): PlanEdge[];\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L125)\n\nThe edges leaving a node.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n| `nodeId` | `string` | The source node id. |\n\n## Returns\n\n[`PlanEdge`](../../types/interfaces/PlanEdge.md)\\[]\n\nEvery edge whose `from` is `nodeId`, in view order.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/reachableFrom","title":"Function: reachableFrom()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/reachableFrom.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/reachableFrom","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/reachableFrom.md\n---\n\n# Function: reachableFrom()\n\n```ts\nfunction reachableFrom(\n view: RawPlanView | PlanGraphView,\n startId: string,\n): Set;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:168](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L168)\n\nThe forward closure from a start node over ALL edge handles.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | ----------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n| `startId` | `string` | The node to start from. |\n\n## Returns\n\n[`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>\n\nThe set of node ids reachable from `startId`, including `startId` itself.\n\n## Remarks\n\n`error` and `default` edges are included: a node reachable only over an error edge is still\nreachable, because the executor can still execute it. The closure is the set of nodes reachable\nby following any outgoing edge transitively. The start node itself is included. A node with no\noutgoing edges contributes nothing further.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/readPath","title":"Function: readPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/readPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/readPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/readPath.md\n---\n\n# Function: readPath()\n\n```ts\nfunction readPath(value: unknown, path: string): unknown;\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:490](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L490)\n\nRead a dot-path from a value, with a per-segment prototype-pollution guard.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------------------------- |\n| `value` | `unknown` | The value to read from. |\n| `path` | `string` | A dot-separated path, e.g. `'a.b.c'`. |\n\n## Returns\n\n`unknown`\n\nThe value at the path, or `undefined` when the path is missing or refused.\n\n## Remarks\n\nThis is the prototype-pollution guard, so it is strict. Each path segment is checked against\n`__proto__`, `prototype` and `constructor` BEFORE it is used as a key; any of those is refused\n(returns `undefined`) rather than followed. This prevents a crafted path like\n`a.__proto__.polluted` or `constructor.prototype.x` from reaching the prototype chain. A\nmissing path — a segment that is absent, or a non-object intermediate — returns `undefined`.\n\nThe guard is per-segment, not just on the whole path, because a path is split on `.` and each\nsegment is a separate key access; a single check on the joined string would miss a segment\nsmuggled past an object boundary. Empty segments (from a leading/trailing dot or a double dot)\nare treated as missing and return `undefined`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/routesBetween","title":"Function: routesBetween()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/routesBetween.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/functions/routesBetween","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/functions/routesBetween.md\n---\n\n# Function: routesBetween()\n\n```ts\nfunction routesBetween(\n view: RawPlanView | PlanGraphView,\n fromId: string,\n toId: string,\n): string[][];\n```\n\nDefined in: [src/batteries/orchestration/plan.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L270)\n\nAll distinct simple paths from one node to another.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------- |\n| `view` | | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | [`PlanGraphView`](../interfaces/PlanGraphView.md) | The graph to search. |\n| `fromId` | `string` | The start node id. |\n| `toId` | `string` | The target node id. |\n\n## Returns\n\n`string`\\[]\\[]\n\nEvery distinct simple path from `fromId` to `toId`, truncated at MAX\\_ROUTES.\n\n## Remarks\n\nA simple path is a route that visits no node twice. This is used to derive a join's `required`\n(the number of fork→join routes) and to validate the diamond topology. The result is a list of\nnode-id sequences, each starting at `fromId` and ending at `toId`.\n\n**Blowup guard.** The number of simple paths in a DAG can be exponential in the node count, so\nthis enumerates at most MAX\\_ROUTES paths and stops. A caller that needs an exact count\n(a join's `required`) must treat a truncated result as \"too many to count\" and refuse the graph\nrather than trust a partial count — the freeze validator does exactly that. The cap is a\ndocumented safety valve, not a correctness knob.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/interfaces/PlanGraphView","title":"Interface: PlanGraphView","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/interfaces/PlanGraphView.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/plan/interfaces/PlanGraphView","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/plan/interfaces/PlanGraphView.md\ndescription: >-\n The minimal structural surface these helpers read. A `RawPlanView` satisfies\n it; so does any `{nodes, edges}` subset. Accepting the subset keeps the\n helpers usable on slices and test fixtures without forcing a full view.\n---\n\n# Interface: PlanGraphView\n\nDefined in: [src/batteries/orchestration/plan.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L27)\n\nThe minimal structural surface these helpers read. A `RawPlanView` satisfies it; so does any\n`{nodes, edges}` subset. Accepting the subset keeps the helpers usable on slices and test\nfixtures without forcing a full view.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `edges` | readonly [`PlanEdge`](../../types/interfaces/PlanEdge.md)\\[] | Every edge in the graph being examined, over all handles. | [src/batteries/orchestration/plan.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L31) |\n| `nodes` | readonly [`PlanNode`](../../types/type-aliases/PlanNode.md)\\[] | Every node in the graph being examined, in no significant order. | [src/batteries/orchestration/plan.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/plan.ts#L29) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw","title":"@nhtio/adk/batteries/orchestration/raw","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/raw.md'\ndescription: The machine-readable reading surface for a plan's op log.\n---\n\n# @nhtio/adk/batteries/orchestration/raw\n\nThe machine-readable reading surface for a plan's op log.\n\n## Remarks\n\nThe prose views (`render`, `outline`) are for humans and for model re-consumption: they adapt\ntheir audience, frame trust, and narrate. A UI showing \"here is what changed and what will be\napplied\" needs machine-readable state instead, and the op log makes that well-defined. This\nmodule is that surface.\n\nThree properties this view has that the prose views deliberately do NOT:\n\n1. **It is NOT audience-adapted.** It is data — no narrative, no trust framing, no prose. A\n `RawPlanView` is the folded content of the log, and nothing more.\n2. **It is STABLE.** A given revision folds to the same bytes forever, which is what makes a\n digest meaningful. The fold is a pure function of the op set (see `foldOps`), so the same\n prefix always yields the same view and the same digest.\n3. **It is reachable both ways.** As a plain exported function, for a UI talking to a\n `PlanStore` directly and never going through an agent; and later as a tool, so a model can\n read the same data through the same seam.\n\n**`RawPlanView` carries NO lifecycle `state`, and that is deliberate.** Lifecycle state is not\na `PlanOp`, so it cannot be folded from the log, and a historical revision therefore has no\nrecoverable state to report. A view at revision 7 answers \"what did the CONTENT look like\nthen\", not \"what state was it in then\". `state` is a property of the plan NOW — read it from\n`store.readState()`. Do not add a `state` field.\n\n## Functions\n\n| Function | Description |\n| ------------------------------- | ------------------------------------------------------------- |\n| [rawDiff](functions/rawDiff.md) | A STRUCTURAL delta between two folded states of a plan. |\n| [rawOps](functions/rawOps.md) | Read the plan's raw op log. |\n| [rawPlan](functions/rawPlan.md) | Fold the plan's op log up to a revision into a `RawPlanView`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawDiff","title":"Function: rawDiff()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawDiff.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawDiff","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/raw/functions/rawDiff.md\n---\n\n# Function: rawDiff()\n\n```ts\nfunction rawDiff(\n store: PlanStore,\n planId: string,\n a: number | \"current\",\n b: number | \"current\",\n): Promise;\n```\n\nDefined in: [src/batteries/orchestration/raw.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/raw.ts#L119)\n\nA STRUCTURAL delta between two folded states of a plan.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------- | -------------------------------------------------- |\n| `store` | [`PlanStore`](../../interfaces/PlanStore.md) | The plan store to read from. |\n| `planId` | `string` | The plan to diff. |\n| `a` | `number` | `\"current\"` | The \"from\" side: a revision number or `'current'`. |\n| `b` | `number` | `\"current\"` | The \"to\" side: a revision number or `'current'`. |\n\n## Returns\n\n`Promise`<[`PlanDiff`](../../types/interfaces/PlanDiff.md)>\n\nThe structural delta between the two folded states.\n\n## Remarks\n\n`rawDiff(a, b)` compares two folded states, NOT an event log. It resolves each side to a\nrevision (`'current'` means the plan's present revision), folds both prefixes, and compares the\nresulting content structurally:\n\n* `nodesAdded` / `nodesRemoved` are keyed by node id.\n* `nodesChanged` names the CHANGED FIELD PATHS with before/after values, typed `ArgValue` — a\n changed field may hold a `NodeRef`, so a narrower type would make a legitimate change\n unrepresentable.\n* `edgesAdded` / `edgesRemoved` are keyed by edge id; an edge whose endpoints or handle changed\n counts as removed-then-added, since its identity is its id.\n* Both digests are carried so a UI can label either side.\n\nBecause this is a FINAL-STATE diff, a node edited and then reverted across the compared span\nproduces NO row — the two states are identical at that node, and there is nothing to report.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawOps","title":"Function: rawOps()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawOps.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawOps","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/raw/functions/rawOps.md\n---\n\n# Function: rawOps()\n\n```ts\nfunction rawOps(\n store: PlanStore,\n planId: string,\n opts?: {\n sinceLamport?: number;\n throughRevision?: number;\n },\n): Promise;\n```\n\nDefined in: [src/batteries/orchestration/raw.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/raw.ts#L86)\n\nRead the plan's raw op log.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------------------- | -------------------------------------------------------------- | ------------------------------------------- |\n| `store` | [`PlanStore`](../../interfaces/PlanStore.md) | The plan store to read from. |\n| `planId` | `string` | The plan to read. |\n| `opts?` | { `sinceLamport?`: `number`; `throughRevision?`: `number`; } | Optional filters. |\n| `opts.sinceLamport?` | `number` | Only ops with `lamport >= sinceLamport`. |\n| `opts.throughRevision?` | `number` | Only ops up to and including this revision. |\n\n## Returns\n\n`Promise`<[`PlanOp`](../../types/type-aliases/PlanOp.md)\\[]>\n\nThe matching ops, in the store's order.\n\n## Remarks\n\nThe op log is the source of truth the fold reads; this returns the ops themselves, optionally\nfiltered. `sinceLamport` filters by clock (a Lamport value is not a revision selector — use\n`throughRevision` to bound by revision). `throughRevision` bounds the result to a REVISION\nPREFIX, which is what `rawPlan({revision})` and `rawDiff(a, b)` need. A revision the log never\nreached is rejected by the store rather than silently returning everything.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawPlan","title":"Function: rawPlan()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawPlan.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/raw/functions/rawPlan","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/raw/functions/rawPlan.md\n---\n\n# Function: rawPlan()\n\n```ts\nfunction rawPlan(\n store: PlanStore,\n planId: string,\n opts?: {\n revision?: number;\n },\n): Promise;\n```\n\nDefined in: [src/batteries/orchestration/raw.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/raw.ts#L59)\n\nFold the plan's op log up to a revision into a `RawPlanView`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------- |\n| `store` | [`PlanStore`](../../interfaces/PlanStore.md) | The plan store to read from. |\n| `planId` | `string` | The plan to read. |\n| `opts?` | { `revision?`: `number`; } | Optional revision selector. |\n| `opts.revision?` | `number` | Fold only the op prefix through this revision. Omitted folds the present log. |\n\n## Returns\n\n`Promise`<[`RawPlanView`](../../types/interfaces/RawPlanView.md)>\n\nThe folded content view at the requested revision.\n\n## Remarks\n\nThe plan IS the fold of its op log, so this is the canonical way to read plan CONTENT. With no\n`revision`, it folds the plan's present log. With `{revision: N}`, it serves a HISTORICAL view:\nit reads the op prefix `throughRevision: N` and folds exactly that prefix, so the result is\nwhat the content looked like at revision N. A revision the log never reached is REJECTED by\nthe store (which throws rather than silently returning everything) — this function never\nguesses or truncates.\n\n`provenance` (clone/template lineage) is read from `store.readProvenance(planId)` and carried\ninto the view, where it is covered by the digest.\n\nThe returned view carries NO lifecycle `state` — see the module doc. `state` is a property of\nthe plan NOW and lives on `store.readState()`, not here.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render","title":"@nhtio/adk/batteries/orchestration/render","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/render.md'\ndescription: >-\n Prose projection of a plan — the review surface an operator reads at the\n approval gate, and the re-consumption surface a model reads for a plan it did\n not author.\n---\n\n# @nhtio/adk/batteries/orchestration/render\n\nProse projection of a plan — the review surface an operator reads at the approval gate, and the\nre-consumption surface a model reads for a plan it did not author.\n\n## Remarks\n\nThere is NO dry run in this design. This prose IS the review surface, and that is what makes the\noperator view load-bearing rather than cosmetic: an operator who approves a plan they cannot\nfully see is the failure this replaces. So for `audience: 'operator'` with `view: 'as_planned'`,\nbrevity is NOT a virtue — every side effect with its tool and arguments, every authority claim,\nevery condition with its exact predicate, in traversal order, with branch structure legible.\n\nArguments at approval time are STAGED, NOT RESOLVED, and the renderer says which. A `NodeRef`\nresolves from the `OutputTable`, which only exists during a run; approval happens before any run\nand there is no dry run to populate it. So a literal argument renders as its value, and a\n`NodeRef` renders as its PROVENANCE — never as a fabricated value, never silently as though it\nwere known. The operator is approving what the plan will do with whatever its sources produce,\nand the AUTHORITY CLAIM is the bound on that — which IS fully known at approval time. The\n`as_executed` view is where arguments appear resolved, because by then they are.\n\nThe operator view is a SEPARATE DISPLAY PROJECTION, not the execution payload: no model-written\nfree text rendered as if it were fact, no raw machine identifiers where a human-readable label\nexists. The model view (`audience: 'model'`) is the inverse: exact identifiers, the same surface\nforms a model would cite back, so a model can re-consume a plan it did not author without a\nparaphrase hop.\n\nProperties:\n\n* **DETERMINISTIC.** Same plan + same options ⇒ byte-identical output. The traversal order is\n fixed (entry-first, then graph order, with branch structure rendered by handle), value\n formatting is total, and nothing reads a clock, a store, or a global.\n* **TOTAL.** Every node kind renders. The node-kind switch is exhaustiveness-checked with\n `const exhaustive: never = kind`, so a new node kind cannot silently render as nothing.\n\nIt is NOT reversible — there is no prose parser, and `render(parse(s)) === s` is not promised,\nbecause `parse` does not exist. The renderer is a one-way display projection.\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------ | -------------------------------------------------- |\n| [RenderPlanOptions](type-aliases/RenderPlanOptions.md) | Options for [renderPlan](functions/renderPlan.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [renderPlan](functions/renderPlan.md) | Render a plan as prose — the review surface an operator reads at the approval gate, or the re-consumption surface a model reads for a plan it did not author. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render/functions/renderPlan","title":"Function: renderPlan()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render/functions/renderPlan.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render/functions/renderPlan","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/render/functions/renderPlan.md\n---\n\n# Function: renderPlan()\n\n```ts\nfunction renderPlan(plan: RawPlanView, options: RenderPlanOptions): string;\n```\n\nDefined in: [src/batteries/orchestration/render.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/render.ts#L113)\n\nRender a plan as prose — the review surface an operator reads at the approval gate, or the\nre-consumption surface a model reads for a plan it did not author.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| `plan` | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | the [RawPlanView](../../types/interfaces/RawPlanView.md) to render. |\n| `options` | [`RenderPlanOptions`](../type-aliases/RenderPlanOptions.md) | audience, view, and (for `as_executed`) the [RunProjection](../../types/interfaces/RunProjection.md) to resolve against. |\n\n## Returns\n\n`string`\n\nthe prose projection, as a single string.\n\n## Remarks\n\nA PURE function of its arguments — no store access, no I/O, no clock. That is what keeps it\ntestable and deterministic: the same plan plus the same options yields byte-identical output,\nand a snapshot test is a complete regression contract. It reads no `PlanStore`, resolves no\nlive values, and registers nothing.\n\nThe `as_planned` view renders staged arguments as their provenance (a `NodeRef` names the node\nand selection it reads, never a fabricated value); the `as_executed` view resolves them against\n`run.outputs`. The operator view renders every side effect with its tool and arguments, every\nauthority claim, every condition with its exact predicate, and ends with a deduplicated\ntotal-authority summary grouped by capability; the model view renders exact identifiers.\n\nDETERMINISTIC and TOTAL — see the module doc. Not reversible.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render/type-aliases/RenderPlanOptions","title":"Type Alias: RenderPlanOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render/type-aliases/RenderPlanOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/render/type-aliases/RenderPlanOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/render/type-aliases/RenderPlanOptions.md\ndescription: 'Options for [`renderPlan`](https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/render/functions/renderPlan).'\n---\n\n# Type Alias: RenderPlanOptions\n\n```ts\ntype RenderPlanOptions =\n | {\n audience: Audience;\n view: \"as_planned\";\n }\n | {\n audience: Audience;\n run: RunProjection;\n view: \"as_executed\";\n };\n```\n\nDefined in: [src/batteries/orchestration/render.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/render.ts#L85)\n\nOptions for [renderPlan](../functions/renderPlan.md).\n\n## Remarks\n\nThe union encodes the two real read modes: `as_planned` carries no run (it is the approval-gate\nview, before any execution), and `as_executed` requires a `RunProjection` so arguments can be\nresolved from its `outputs` and node states can be annotated.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/runs","title":"@nhtio/adk/batteries/orchestration/runs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/runs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/runs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/runs.md'\ndescription: 'The run-event fold: turn a persisted run log into a `RunProjection`.'\n---\n\n# @nhtio/adk/batteries/orchestration/runs\n\nThe run-event fold: turn a persisted run log into a `RunProjection`.\n\n## Functions\n\n| Function | Description |\n| ------------------------------- | -------------------------------------------------------------------------------------------------- |\n| [foldRun](functions/foldRun.md) | Fold a sequence of run events into a single [RunProjection](../types/interfaces/RunProjection.md). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/runs/functions/foldRun","title":"Function: foldRun()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/runs/functions/foldRun.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/runs/functions/foldRun","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/runs/functions/foldRun.md\n---\n\n# Function: foldRun()\n\n```ts\nfunction foldRun(events: RunEvent[]): RunProjection;\n```\n\nDefined in: [src/batteries/orchestration/runs.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/runs.ts#L33)\n\nFold a sequence of run events into a single [RunProjection](../../types/interfaces/RunProjection.md).\n\nThe projection is derived entirely from the events themselves — no graph, no store, and no\nside channel. It is deterministic and total: the same event list always folds to the same\nprojection.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------- | ------------------------------- |\n| `events` | [`RunEvent`](../../types/type-aliases/RunEvent.md)\\[] | The ordered run events to fold. |\n\n## Returns\n\n[`RunProjection`](../../types/interfaces/RunProjection.md)\n\nThe projected state of the run.\n\n## Throws\n\nIf the first event is not `run_started` (a malformed event list).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates","title":"@nhtio/adk/batteries/orchestration/templates","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/templates.md'\ndescription: Template validation and instantiation for orchestration.\n---\n\n# @nhtio/adk/batteries/orchestration/templates\n\nTemplate validation and instantiation for orchestration.\n\n## Remarks\n\nA template is a consumer-defined plan *shape* — written in TypeScript, registered with\n`createOrchestration` at construction, and therefore versioned with the consuming application.\nIt needs no store seeding and can be **validated once at boot** rather than once per\ninstantiation, so a misconfigured deployment fails at startup with a named issue rather than at\nthe first use months later.\n\nWhy templates exist at all is the small-model story: a small model working on a forty-node plan\ndoes far better filling in five declared parameters than authoring forty nodes. The template is\nthe static part of that bargain — the consumer writes the shape, the model fills the holes.\n\nA template is **not** a plan. It has no lifecycle, no digest, no run, and cannot be approved.\nOnly its instantiations are plans, which is what keeps \"one plan id, at most one run\" intact\nwhen the same template is instantiated fifty times: each instantiation is an independent plan\nwith its own id and digest.\n\nThe two exported functions are the whole surface:\n\n* [validateTemplate](functions/validateTemplate.md) — runs at **construction**. Every issue it returns is decidable and\n total *because* a registered template is immutable: the graph cannot change after the check,\n so the answer cannot go stale. The most important check is the laundering rule (below).\n* [instantiateTemplate](functions/instantiateTemplate.md) — validates the arguments a model offers against the declared\n `params`, mints a fresh plan, substitutes every hole, and appends the graph as authored ops.\n\n## The laundering rule\n\nA `ParamRef` reaching a `call` node's `args` is refused unless a node on **every route** to that\ncall declares the corresponding field in `declassifies`. This is the taint story made static:\na substituted parameter value is like entry input — untrusted — and it may reach a `reason`\nprompt but not a `call` node's args unless a node on every path to the call has declassified it.\n\nThe check lives over the **template, not over an instantiation**, and that is the whole reason\nit can be total: it runs at construction, once, over a graph that is immutable from that moment.\n\n**The narrower invariant, stated honestly:** *a template cannot launder its own parameters.* It\ndoes **not** claim that a substituted value's template origin is tracked through arbitrary later\nedits — nothing in a freely-mutable graph can track that. Once instantiated, the result is an\nordinary `editable` plan and a substituted value is an ordinary literal; a later `set_node_field`\nrouting that literal into a `call` arg is exactly as visible as in any hand-authored plan, which\nis to say: it is in the operator's rendered prose, and the operator approves it. That is the\nhonest boundary, and it is the same one every hand-authored plan already has.\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------- | --------------------------------------------------------------------------- |\n| [instantiateTemplate](functions/instantiateTemplate.md) | Instantiate a template into a fresh, ordinary `editable` plan. |\n| [validateTemplate](functions/validateTemplate.md) | Validate a template against the invocable allowlist, once, at construction. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates/functions/instantiateTemplate","title":"Function: instantiateTemplate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates/functions/instantiateTemplate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates/functions/instantiateTemplate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/templates/functions/instantiateTemplate.md\n---\n\n# Function: instantiateTemplate()\n\n```ts\nfunction instantiateTemplate(\n store: PlanStore,\n tpl: PlanTemplate,\n args: Record,\n actorId: string,\n): Promise;\n```\n\nDefined in: [src/batteries/orchestration/templates.ts:437](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/templates.ts#L437)\n\nInstantiate a template into a fresh, ordinary `editable` plan.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| `store` | [`PlanStore`](../../interfaces/PlanStore.md) | The plan store to write into. |\n| `tpl` | [`PlanTemplate`](../../types/interfaces/PlanTemplate.md) | The registered template to materialise. |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](../../types/type-aliases/EncodableValue.md)> | The concrete values, keyed by declared param `path`, to substitute for holes. |\n| `actorId` | `string` | The identity under which the minted ops are authored. |\n\n## Returns\n\n`Promise`<[`InstantiateResult`](../../types/type-aliases/InstantiateResult.md)>\n\nThe instantiation result.\n\n## Remarks\n\nA template holds **op inputs without identity**: a `PlanOp` requires `opId`/`actorId`/`lamport`/\n`at`, and no static literal can carry those — the same reason bounds are a fold seed rather than\nan implied op. So instantiation **mints** that identity here, under the passed `actorId`, with a\nmonotonic lamport.\n\nThe steps, in order:\n\n1. **Validate `args` against `params`** — types (plus `maxBytes` on strings) and enum\n membership. On failure it returns `{ok: false, reason: 'invalid_args', detail}` naming the\n offending param and what was expected, rather than minting a broken plan.\n2. **`store.createPlan(planId, {provenance: {kind: 'template', template: tpl.id, args}})`** — the\n provenance is persisted by the store and returned by `readProvenance`, for the renderer and\n for audit. It is **not** a taint mechanism (see the module TSDoc).\n3. **Substitute every `ParamRef`** with the corresponding argument value, then append\n `add_node` / `add_edge` / `set_bounds` ops.\n\nThe result is an **ordinary `editable` plan**: no inherited approval, no special state, nothing\ndownstream needs to know it came from a template. Two instantiations of one template yield\nindependent plans with different ids and digests.\n\n`planId` is minted (not a parameter), because a fresh plan needs a fresh id — a caller does not\npre-choose one. If the mint races a duplicate, an error is thrown rather than returning a broken\nor mislabelled result.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates/functions/validateTemplate","title":"Function: validateTemplate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates/functions/validateTemplate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/templates/functions/validateTemplate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/templates/functions/validateTemplate.md\n---\n\n# Function: validateTemplate()\n\n```ts\nfunction validateTemplate(\n tpl: PlanTemplate,\n invocable: InvocableTools,\n): PlanIssue[];\n```\n\nDefined in: [src/batteries/orchestration/templates.ts:316](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/templates.ts#L316)\n\nValidate a template against the invocable allowlist, once, at construction.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | ------------------------------------------------------------ | ------------------------------------------------ |\n| `tpl` | [`PlanTemplate`](../../types/interfaces/PlanTemplate.md) | The template to validate. |\n| `invocable` | [`InvocableTools`](../../types/interfaces/InvocableTools.md) | The tier-C allowlist a staged `call` may invoke. |\n\n## Returns\n\n[`PlanIssue`](../../types/interfaces/PlanIssue.md)\\[]\n\nEvery blocking issue the template raises; an empty array means it is safe to register.\n\n## Remarks\n\nEvery issue returned here is a blocking refusal: a deployment whose template fails this check\nshould fail to boot, not fail at the first instantiation months later. This is the whole point\nof validating over the immutable template rather than over each (mutable) instantiation.\n\nThe checks:\n\n1. **Undeclared holes.** A `ParamRef` whose `path` does not name a declared `params` entry is\n refused — a template cannot substitute a parameter it never declared.\n2. **Unknown tools.** A `call` node naming a tool absent from `invocable.has(tool)` is refused,\n and the message names what *is* available so the author can fix it.\n3. **The laundering check.** A `ParamRef` reaching a `call` node's `args` is refused unless a\n node on every route to that call declares the corresponding field in `declassifies`. See the\n module TSDoc for the honest, narrower invariant this enforces — *a template cannot launder\n its own parameters* — and why nothing more is claimed.\n\nThe route enumeration is capped at MAX\\_ROUTES paths. A template with more distinct\nsimple paths than that cannot prove that *every* route declassifies, and is conservatively\nrefused rather than trusted on a partial count.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/AppendResult","title":"Type Alias: AppendResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/AppendResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/AppendResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/AppendResult.md\ndescription: >-\n The outcome of an `appendOps` call. On success it carries the new revision and\n digest; on failure it names whether the plan was not `editable` (frozen) or\n the log had moved past `expectedRevision`, and carries the actual state so a\n stale writer learns what happened.\n---\n\n# Type Alias: AppendResult\n\n```ts\ntype AppendResult =\n | {\n digest: string;\n ok: true;\n revision: number;\n }\n | {\n actual: {\n revision: number;\n state: PlanState;\n };\n ok: false;\n reason: \"not_editable\" | \"revision_moved\";\n };\n```\n\nDefined in: [src/batteries/orchestration/store.ts:186](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L186)\n\nThe outcome of an `appendOps` call. On success it carries the new revision and digest; on\nfailure it names whether the plan was not `editable` (frozen) or the log had moved past\n`expectedRevision`, and carries the actual state so a stale writer learns what happened.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/ClaimRunResult","title":"Type Alias: ClaimRunResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/ClaimRunResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/ClaimRunResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/ClaimRunResult.md\ndescription: >-\n The outcome of a `claimRun` call. On success it carries the run id and whether\n this call resumed an existing run; on failure it names whether the plan was\n not `executable`, its digest had moved, a run was already claimed, the named\n run did not exist, or the named run was already settled — carrying the\n existing run id where one exists.\n---\n\n# Type Alias: ClaimRunResult\n\n```ts\ntype ClaimRunResult =\n | {\n ok: true;\n resumed: boolean;\n runId: string;\n }\n | {\n existingRunId?: string;\n ok: false;\n reason:\n | \"not_executable\"\n | \"digest_mismatch\"\n | \"run_already_claimed\"\n | \"run_not_found\"\n | \"run_already_settled\";\n };\n```\n\nDefined in: [src/batteries/orchestration/store.ts:232](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L232)\n\nThe outcome of a `claimRun` call. On success it carries the run id and whether this call\nresumed an existing run; on failure it names whether the plan was not `executable`, its digest\nhad moved, a run was already claimed, the named run did not exist, or the named run was already\nsettled — carrying the existing run id where one exists.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/CreateResult","title":"Type Alias: CreateResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/CreateResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/CreateResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/CreateResult.md\ndescription: >-\n The outcome of minting a plan (`createPlan` / `clonePlan`). On success it\n carries the new plan's revision and digest; on failure it names which\n precondition was violated.\n---\n\n# Type Alias: CreateResult\n\n```ts\ntype CreateResult =\n | {\n digest: string;\n ok: true;\n planId: string;\n revision: number;\n }\n | {\n ok: false;\n reason: \"duplicate_id\" | \"source_missing\" | \"revision_missing\";\n };\n```\n\nDefined in: [src/batteries/orchestration/store.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L177)\n\nThe outcome of minting a plan (`createPlan` / `clonePlan`). On success it carries the new\nplan's revision and digest; on failure it names which precondition was violated.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/ParsePredicateResult","title":"Type Alias: ParsePredicateResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/ParsePredicateResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/ParsePredicateResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/ParsePredicateResult.md\ndescription: >-\n The result of [`parseStructuredPredicate`](https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/functions/parseStructuredPredicate): either a validated predicate,\n or a model-addressed reason naming the fix.\n---\n\n# Type Alias: ParsePredicateResult\n\n```ts\ntype ParsePredicateResult =\n | {\n ok: true;\n predicate: StructuredPredicate;\n }\n | {\n ok: false;\n reason: string;\n };\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L170)\n\nThe result of [parseStructuredPredicate](../functions/parseStructuredPredicate.md): either a validated predicate, or a\nmodel-addressed reason naming the fix.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/PredicateOp","title":"Type Alias: PredicateOp","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/PredicateOp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/PredicateOp","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/PredicateOp.md\ndescription: The closed set of comparison operators a structured predicate leaf may name.\n---\n\n# Type Alias: PredicateOp\n\n```ts\ntype PredicateOp =\n | \"eq\"\n | \"ne\"\n | \"lt\"\n | \"lte\"\n | \"gt\"\n | \"gte\"\n | \"in\"\n | \"contains\"\n | \"truthy\"\n | \"exists\";\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L13)\n\nThe closed set of comparison operators a structured predicate leaf may name.\n\n`truthy` and `exists` take no `value`; every other operator requires one. The set is CLOSED —\n`parseStructuredPredicate` refuses any other string with a model-addressed reason naming the\nlegal set, so a branch/select author cannot smuggle an operator no cell implements.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/StructuredPredicate","title":"Type Alias: StructuredPredicate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/StructuredPredicate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/StructuredPredicate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/StructuredPredicate.md\ndescription: >-\n The structured predicate IR — the value a branch/select node's `predicate`\n field holds when the structured cell interprets it.\n---\n\n# Type Alias: StructuredPredicate\n\n```ts\ntype StructuredPredicate =\n | PredicateLeaf\n | AllPredicate\n | AnyPredicate\n | NotPredicate;\n```\n\nDefined in: [src/batteries/orchestration/predicates.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/predicates.ts#L67)\n\nThe structured predicate IR — the value a branch/select node's `predicate` field holds when the\nstructured cell interprets it.\n\nA discriminated union of four shapes: a leaf (`{path, op, value?}`), and the three combinators\n`{all}`, `{any}`, `{not}`. The combinator shapes are discriminated by their single key, and a\nleaf by the presence of `path`/`op`. `parseStructuredPredicate` is the single authority that\nturns an untrusted `EncodableValue` into this IR.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionRequest","title":"Type Alias: TransitionRequest","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionRequest.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionRequest","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionRequest.md\ndescription: >-\n The transition request, as a DISCRIMINATED UNION over the legal pairs — so an\n illegal target genuinely is a type error at the call site, rather than a claim\n the signature does not back. `expected.state` is fixed per variant (it is\n implied by `from`), and `approval` is required exactly where it is meaningful.\n A BYO store receiving a malformed request over a wire still answers\n `illegal_transition` at runtime; the type is the first line, not the only one.\n---\n\n# Type Alias: TransitionRequest\n\n```ts\ntype TransitionRequest =\n | {\n expectedDigest: string;\n from: \"editable\";\n to: \"reviewable\";\n }\n | {\n expectedDigest: string;\n from: \"reviewable\";\n to: \"editable\";\n }\n | {\n approval: ApprovalRecord;\n expectedDigest: string;\n from: \"reviewable\";\n to: \"executable\";\n };\n```\n\nDefined in: [src/batteries/orchestration/store.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L201)\n\nThe transition request, as a DISCRIMINATED UNION over the legal pairs — so an illegal target\ngenuinely is a type error at the call site, rather than a claim the signature does not back.\n`expected.state` is fixed per variant (it is implied by `from`), and `approval` is required\nexactly where it is meaningful. A BYO store receiving a malformed request over a wire still\nanswers `illegal_transition` at runtime; the type is the first line, not the only one.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionResult","title":"Type Alias: TransitionResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/type-aliases/TransitionResult.md\ndescription: >-\n The outcome of a `transition` call. On success it carries the new revision; on\n failure it names whether the plan was not in the expected state, its digest\n had moved, or the request was not a legal pair — carrying the actual\n state/digest so a caller that lost can read what happened.\n---\n\n# Type Alias: TransitionResult\n\n```ts\ntype TransitionResult =\n | {\n ok: true;\n revision: number;\n }\n | {\n actual: {\n digest: string;\n state: PlanState;\n };\n ok: false;\n reason: \"state_mismatch\" | \"digest_mismatch\";\n }\n | {\n from: PlanState;\n ok: false;\n reason: \"illegal_transition\";\n to: PlanState;\n };\n```\n\nDefined in: [src/batteries/orchestration/store.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/store.ts#L216)\n\nThe outcome of a `transition` call. On success it carries the new revision; on failure it names\nwhether the plan was not in the expected state, its digest had moved, or the request was not a\nlegal pair — carrying the actual state/digest so a caller that lost can read what happened.\n\n## Union Members\n\n### Type Literal\n\n```ts\n{\n ok: true;\n revision: number;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n actual: {\n digest: string;\n state: PlanState;\n }\n ok: false;\n reason: \"state_mismatch\" | \"digest_mismatch\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n from: PlanState;\n ok: false;\n reason: \"illegal_transition\";\n to: PlanState;\n}\n```\n\nFor a BYO store handed a request the type system did not police (e.g. over a wire).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types","title":"@nhtio/adk/batteries/orchestration/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types.md'\ndescription: >-\n The orchestration battery's shared type contracts — the normative source for\n every type more than one part of the battery touches.\n---\n\n# @nhtio/adk/batteries/orchestration/types\n\nThe orchestration battery's shared type contracts — the normative source for every type more\nthan one part of the battery touches.\n\n## Remarks\n\nA type belongs here when two or more modules read or write it. Anything with no dependents —\na cell's internal AST, the in-memory store's private index, a renderer's line-wrapping helper\n— is deliberately left to its implementation rather than fixed here.\n\nTwo conventions in this file are load-bearing and easy to undo by accident. Discrimination is\nby CLASS, not by a `kind` field: `NodeRef` and `ParamRef` are registered encoder classes whose\n`is*` guards are `instanceof` checks, because a plain record can wear `{kind: 'nodeRef'}` and a\nresolver keying on that would silently rewrite a literal. And `EncodableValue` is a deliberate\nSUBSET of the encoder's own `Encodable` — it omits `Function`, `Error` and consumer-defined\ncustom classes, so a staged argument cannot carry a closure that serialises by source text or\na class the battery cannot register on the consumer's behalf.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | --------------- | ---------------------------------------------------- |\n| [ApprovalRecord](interfaces/ApprovalRecord.md) | An operator's decision, bound to exactly the content they were shown. The digest is lossless, so two plans that differ in any staged value cannot share one — which is what stops an approval authorising a plan that was never rendered. |\n| [ArtifactClassLike](interfaces/ArtifactClassLike.md) | An artifact CLASS, structurally. Carries only its OWN descriptors — the base seven are on an ancestor, per core's shadowing rule — so the battery must walk the chain rather than read this one array. `effectiveToolMethods` is the only place that walk happens. |\n| [ArtifactMethodDescriptor](interfaces/ArtifactMethodDescriptor.md) | Structural, per CONTRIBUTING §13 — the battery does not import the core classes. Note `argsSchema`: an earlier draft omitted it while claiming freeze validates a step's args against it, so the type could not support the check it was cited for. `serialise` likewise, since the transform runtime needs the descriptor's own formatter rather than a guess. |\n| [AuthorityClaim](interfaces/AuthorityClaim.md) | One unit of authority a `call` node claims. Approval binds the canonicalised union of every claim in the plan, so what an operator approved and what may run are the same set. |\n| [BranchId](interfaces/BranchId.md) | A path identity: the route from `entry` to a frame, kept as the route itself. |\n| [BranchNodeDefinition](interfaces/BranchNodeDefinition.md) | A two-way branch: the predicate's verdict picks the `match` or `no_match` handle. |\n| [CallNodeDefinition](interfaces/CallNodeDefinition.md) | A staged tool invocation — the node kind the whole staging environment exists to gate. |\n| [ClonedFrom](interfaces/ClonedFrom.md) | A clone's lineage. |\n| [EntryNodeDefinition](interfaces/EntryNodeDefinition.md) | The one place external input enters the graph. |\n| [FrameRef](interfaces/FrameRef.md) | Identifies one execution of one node: the node, and the path that reached it. `kind` rides along so the fold can classify without the graph (only a `call` frame can be indeterminate). `viaEdgeId` is the edge that produced this frame — `undefined` for the entry frame, which no edge produced. `branchId` is the path identity and is what makes a frame unique. |\n| [FreezeInputs](interfaces/FreezeInputs.md) | What freeze validation needs that is NOT derivable from the plan itself. |\n| [InstantiatedFrom](interfaces/InstantiatedFrom.md) | Instantiation lineage, for the renderer and for audit. **Not a taint mechanism** — see below. |\n| [InvocableTools](interfaces/InvocableTools.md) | The Tier-C boundary: which of the consumer's tools a staged `call` may invoke, and what each returns. Supplied by the consumer, because they are the only party that knows. |\n| [JoinNodeDefinition](interfaces/JoinNodeDefinition.md) | A join is a **DIAMOND join only**: it closes a fan-out that a single ancestor opened. The restriction is what makes joins implementable, and it is stated over the DIVERGENCE POINT, not over the immediate predecessors. |\n| [JoinState](interfaces/JoinState.md) | A join's partial barrier. |\n| [MediaLike](interfaces/MediaLike.md) | A media value, structurally. Refused at freeze for a node whose `output` declares fields. |\n| [NodeOutput](interfaces/NodeOutput.md) | What a node produced on one path. Always an ARRAY, even for a single result. |\n| [Orchestration](interfaces/Orchestration.md) | The public surface. Each member is specified in its own section; this is the assembly. |\n| [OutputItem](interfaces/OutputItem.md) | One unit of a node's output. Items, after n8n — a node may emit several. The field is named `json` for continuity with that lineage, but its values are `EncodableValue`, so a tool may legitimately return a `Date`, a `RegExp`, a `Map` — the same domain a staged argument may hold, which is what lets an output feed an argument without a lossy hop. It is NOT restricted to JSON-representable values, and an earlier draft's \"JSON-shaped only\" gloss was wrong. |\n| [PendingFrame](interfaces/PendingFrame.md) | A live frame: its identity, its branch-local value table, and its branch-local artifact table. `artifacts` is cloned on fan-out exactly like `outputs` and is what a `transform` reads its source instance from; it persists as handles, so a snapshot carries pointers, never bytes. |\n| [PhaseEntry](interfaces/PhaseEntry.md) | One phase's entry in an outline. Carries exact surface forms, never paraphrase. |\n| [PlanBounds](interfaces/PlanBounds.md) | The resource envelope. Plan CONTENT, so it is digested and an operator approves it. |\n| [PlanDiff](interfaces/PlanDiff.md) | Structural delta between two folded states — what a diff UI renders. |\n| [PlanEdge](interfaces/PlanEdge.md) | A directed edge. Its `handle` decides when it fires; the graph alone orders execution. |\n| [PlanIssue](interfaces/PlanIssue.md) | One finding from validation. Model-addressed, because a model is what usually acts on it. |\n| [PlanOutline](interfaces/PlanOutline.md) | ONE flat level. Entries carry exact surface forms, not paraphrase. |\n| [PlanSlice](interfaces/PlanSlice.md) | A slice. Self-locating: it carries enough neighbourhood to keep linking without re-reading. |\n| [PlanSummary](interfaces/PlanSummary.md) | A plan's headline, for listings. Carries `state`, which `RawPlanView` deliberately does not. |\n| [PlanTemplate](interfaces/PlanTemplate.md) | A consumer-defined plan shape, written in TypeScript and registered at construction — so it versions with the consuming application, needs no store seeding, and can be validated once at boot rather than per instantiation. |\n| [PredicateContext](interfaces/PredicateContext.md) | What a cell may read when evaluating. Deliberately narrow: outputs and the frame, nothing live. |\n| [PredicateEvaluator](interfaces/PredicateEvaluator.md) | A predicate cell: the seam that lets a `branch`/`select` interpret its own predicate form without this battery specifying an expression language. |\n| [RawPlanView](interfaces/RawPlanView.md) | The folded plan CONTENT at a revision. `rawPlan()` returns this; the renderer and validator read it. Note there is deliberately no `state` field: lifecycle state is not a `PlanOp`, so it cannot be folded from the log, and a historical revision therefore has no recoverable lifecycle state to report. `state` is a property of the plan NOW — read it from `PlanStore.readState()`, which is where it lives. A `RawPlanView` at revision 7 answers \"what did the content look like then\", not \"what state was it in then\". |\n| [ReasonNodeDefinition](interfaces/ReasonNodeDefinition.md) | A reason node ENDS IN A TOOL CALL, and that tool call IS its output — it never returns prose to be parsed. `outputSchema` becomes the forced tool's `inputSchema`, so the model physically cannot answer unstructured: the validator rejects malformed args and the battery retries within `maxAttempts`. The captured, validated args are the node's `OutputItem.json`. Note this node carries a Schema, NOT DeclaredField\\[] — a validator expresses nested objects and unions that DeclaredField cannot, and it is what the forced tool needs anyway. |\n| [RunDeps](interfaces/RunDeps.md) | The execution dependencies. Supplied at construction, per run, or both. |\n| [RunOptions](interfaces/RunOptions.md) | Per-run inputs. Every `RunDeps` member is OPTIONAL here: `createOrchestration` already holds whatever was configured, so a caller repeats only what it wants to override. `Orchestration`'s `executePlan` is therefore this shape, not the fully-required `RunDeps` — an earlier draft made every dependency mandatory per run while also calling construction the assembly point, which meant a caller had to repeat what it had just configured and left the override rule undefined. |\n| [RunProjection](interfaces/RunProjection.md) | What `foldRun` returns: the whole answer to \"where did it stop and what happened\". |\n| [SelectNodeDefinition](interfaces/SelectNodeDefinition.md) | An n-way switch: the verdict names a case, or falls to the required `default` handle. |\n| [SpooledArtifactLike](interfaces/SpooledArtifactLike.md) | A spooled artifact instance, structurally — per CONTRIBUTING §13, the battery does not import the core classes. This is the value a `call` may return and a `transform` reads its methods from. |\n| [TransformNodeDefinition](interfaces/TransformNodeDefinition.md) | A `transform` node converts one node's output into the shape a downstream node needs — the bridge between what ADK tools actually return (`string | Uint8Array | SpooledArtifact | Media[]`) and the pathable fields a `NodeRef` reads. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ArgValue](type-aliases/ArgValue.md) | A staged argument: any encodable value, or a reference to another node's output. |\n| [ArtifactTable](type-aliases/ArtifactTable.md) | Live artifact instances produced by `call` nodes, keyed **identically** to `OutputTable` (`${nodeId}:${branchKey(branchId)}`) so a `transform`'s `source: NodeRef` addresses one with no second addressing scheme. This is the channel a `transform` receives its instance through — see `TransformNodeDefinition`, which explains why the value dataflow cannot carry it. |\n| [AuthorityVerb](type-aliases/AuthorityVerb.md) | The closed verb set. Closed so an authority set is comparable, not merely readable. |\n| [CallInvokerFn](type-aliases/CallInvokerFn.md) | Returns the tool's result **in the shape the tool actually produced** — the same union an ADK `ToolHandler` returns (`src/lib/classes/tool.ts:57`). An earlier draft had this return `OutputItem[]`, which quietly obliged every consumer to invent a conversion the plan never specified: a tool returning a JSON-in-a-string, or a `SpooledArtifact` handle, has no obvious mapping to pathable fields, and three implementors would have chosen three. |\n| [CreateOrchestration](type-aliases/CreateOrchestration.md) | THE battery's single entry point. Everything public is reached through the object it returns, so it is the one place a precondition can be enforced for every operation — which is why the encoder check lives here (see Serialization). |\n| [DeclaredField](type-aliases/DeclaredField.md) | One field a node promises to produce, or that an entry/template accepts. Declaring a field is what makes it addressable by a `NodeRef.path` and checkable at freeze rather than at run time. |\n| [EdgeHandle](type-aliases/EdgeHandle.md) | An edge's firing condition, drawn from the outcome of its source node. |\n| [EncodableValue](type-aliases/EncodableValue.md) | The value space of a staged argument and of a node's output: a DELIBERATE SUBSET of `@nhtio/encoder`'s `Encodable`, declared structurally here rather than re-exported. |\n| [ExecutePlanFn](type-aliases/ExecutePlanFn.md) | Starts or resumes a run. Takes no entry argument — the entry node is unique by freeze invariant and its output is materialised from `RunOptions.input`. |\n| [InstantiateResult](type-aliases/InstantiateResult.md) | The outcome of instantiating a template. Failure is a value, not a throw — a model reads it. |\n| [InterruptionCause](type-aliases/InterruptionCause.md) | Why a run stopped short of completing. Closed, so a caller can handle every case it must. |\n| [NodeId](type-aliases/NodeId.md) | A node's identity within one plan. Validated snake\\_case with no `/` and no leading `.`, so it can never be mistaken for a path or copied as a citation. |\n| [NodeOutcome](type-aliases/NodeOutcome.md) | How one frame settled. The three cases are exhaustive — a frame that has not settled has none. |\n| [OutputTable](type-aliases/OutputTable.md) | Append-only, keyed `${nodeId}:${branchKey(branchId)}` — path-unique, which is what makes a NodeRef resolve. Always build the key with `branchKey`, never by interpolating the object. |\n| [PlanId](type-aliases/PlanId.md) | A plan's stable identity, unique per store and never reused across a clone. |\n| [PlanNode](type-aliases/PlanNode.md) | A node: its identity and phase, plus exactly one kind-specific definition. |\n| [PlanNodeKind](type-aliases/PlanNodeKind.md) | The closed set of node kinds. Each has its own definition type, and freeze validates per kind. |\n| [PlanOp](type-aliases/PlanOp.md) | One authoring edit. Every op carries actor and lamport identity, and the fold is deterministic over any arrival order — so two offline authors' logs converge when they meet. |\n| [PlanProvenance](type-aliases/PlanProvenance.md) | A clone's lineage. `completedAtClone` is the part that is not derivable later: the renderer must warn that \"the parent already completed X, Y, Z, and approving this repeats them\", and the parent's id/digest/revision identify CONTENT, not execution — a plan at that revision may never have run, may be halted, or may have completed a subset. So `clonePlan` snapshots the parent's completed node ids at clone time, which also makes the warning stable if the parent's run is later re-read or the parent is archived. |\n| [PlanState](type-aliases/PlanState.md) | The three lifecycle states, in the only order they may be traversed. |\n| [PredicateVerdict](type-aliases/PredicateVerdict.md) | A cell's decision, in the shape the node kind that asked for it expects. |\n| [PromptPart](type-aliases/PromptPart.md) | A prompt is a SEQUENCE of literal text and references — never a string with an embedded DSL. |\n| [ReasonerFn](type-aliases/ReasonerFn.md) | The `reason` node's dispatcher. See ReasonNodeDefinition: it terminates in a tool call. |\n| [RouteSegment](type-aliases/RouteSegment.md) | A PATH identity — the route from `entry` to a frame, kept as the ROUTE ITSELF, not a hash of it, so ancestry questions are answered by reading the value. (An earlier draft hashed it and then tried to correlate joins by \"longest common prefix of the ids\", which computes nothing: a hash has no prefix relation to what it hashes.) |\n| [RunEvent](type-aliases/RunEvent.md) | The persisted wire contract. `foldRun` derives an entire `RunProjection` from a list of these with no graph, no store and no side channel, which is what makes resume a pure function of the log rather than of surviving process state. |\n| [TemplateArgValue](type-aliases/TemplateArgValue.md) | A plan node whose staged values may additionally contain template holes. |\n| [TemplateDefinitionOf](type-aliases/TemplateDefinitionOf.md) | Structurally identical to the node definitions, with `ArgValue` widened to `TemplateArgValue`. |\n| [TemplateNode](type-aliases/TemplateNode.md) | A `PlanNode` whose definition may additionally contain template holes. |\n| [ToolResult](type-aliases/ToolResult.md) | Exactly what an ADK tool handler may return. The battery narrows it, never guesses at it. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [DEFAULT\\_PLAN\\_BOUNDS](variables/DEFAULT_PLAN_BOUNDS.md) | The canonical initial bounds — the **fold's seed**, not an op. `foldOps` starts from these, so a plan at revision 0 (an empty log) has a complete `RawPlanView` and a well-defined digest, and `set_bounds` ops override it thereafter. Without a fixed seed each implementor would invent a default or leave bounds absent, and since bounds are plan CONTENT that would give the same logical plan different digests across stores — breaking approval binding and store conformance. Every member stays required, so an override is total and cannot half-specify. |\n\n## References\n\n### branchKey\n\nRe-exports [branchKey](../ops/functions/branchKey.md)\n\n***\n\n### effectiveToolMethods\n\nRe-exports [effectiveToolMethods](../../../common/functions/effectiveToolMethods.md)\n\n***\n\n### foldRun\n\nRe-exports [foldRun](../runs/functions/foldRun.md)\n\n***\n\n### NodeRef\n\nRe-exports [NodeRef](../encoding/classes/NodeRef.md)\n\n***\n\n### ParamRef\n\nRe-exports [ParamRef](../encoding/classes/ParamRef.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ApprovalRecord","title":"Interface: ApprovalRecord","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ApprovalRecord.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ApprovalRecord","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/ApprovalRecord.md\ndescription: >-\n An operator's decision, bound to exactly the content they were shown. The\n digest is lossless, so two plans that differ in any staged value cannot share\n one — which is what stops an approval authorising a plan that was never\n rendered.\n---\n\n# Interface: ApprovalRecord\n\nDefined in: [src/batteries/orchestration/types.ts:1542](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1542)\n\nAn operator's decision, bound to exactly the content they were shown. The digest is lossless, so\ntwo plans that differ in any staged value cannot share one — which is what stops an approval\nauthorising a plan that was never rendered.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `authoritySet` | [`AuthorityClaim`](AuthorityClaim.md)\\[] | Canonicalised: deduped and lexicographically sorted, so set equality is a byte comparison. | [src/batteries/orchestration/types.ts:1548](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1548) |\n| `decidedAt` | `string` | When, ISO-8601. | [src/batteries/orchestration/types.ts:1552](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1552) |\n| `decidedBy` | `string` | Who decided. | [src/batteries/orchestration/types.ts:1550](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1550) |\n| `digest` | `string` | The content digest approved. A later revision does not inherit this approval. | [src/batteries/orchestration/types.ts:1546](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1546) |\n| `disposition` | `\"approved\"` | A denial is not recorded as an approval; it is ABSENT. So this has exactly one inhabitant. | [src/batteries/orchestration/types.ts:1554](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1554) |\n| `planId` | `string` | The plan approved. | [src/batteries/orchestration/types.ts:1544](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1544) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactClassLike","title":"Interface: ArtifactClassLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactClassLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactClassLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactClassLike.md\ndescription: >-\n An artifact CLASS, structurally. Carries only its OWN descriptors — the base\n seven are on an ancestor, per core's shadowing rule — so the battery must walk\n the chain rather than read this one array. `effectiveToolMethods` is the only\n place that walk happens.\n---\n\n# Interface: ArtifactClassLike\n\nDefined in: [src/batteries/orchestration/types.ts:962](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L962)\n\nAn artifact CLASS, structurally. Carries only its OWN descriptors — the base seven are on an\nancestor, per core's shadowing rule — so the battery must walk the chain rather than read this\none array. `effectiveToolMethods` is the only place that walk happens.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------ | ---------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `toolMethods?` | `readonly` | readonly [`ArtifactMethodDescriptor`](ArtifactMethodDescriptor.md)\\[] | This class's OWN descriptors only. Core's `toolMethods` SHADOWS rather than concatenates, so reading this array directly yields the leaf set — use `effectiveToolMethods` to get the union. | [src/batteries/orchestration/types.ts:967](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L967) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactMethodDescriptor","title":"Interface: ArtifactMethodDescriptor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactMethodDescriptor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactMethodDescriptor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/ArtifactMethodDescriptor.md\ndescription: >-\n Structural, per CONTRIBUTING §13 — the battery does not import the core\n classes. Note `argsSchema`: an earlier draft omitted it while claiming freeze\n validates a step's args against it, so the type could not support the check it\n was cited for. `serialise` likewise, since the transform runtime needs the\n descriptor's own formatter rather than a guess.\n---\n\n# Interface: ArtifactMethodDescriptor\n\nDefined in: [src/batteries/orchestration/types.ts:939](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L939)\n\nStructural, per CONTRIBUTING §13 — the battery does not import the core classes. Note\n`argsSchema`: an earlier draft omitted it while claiming freeze validates a step's args against\nit, so the type could not support the check it was cited for. `serialise` likewise, since the\ntransform runtime needs the descriptor's own formatter rather than a guess.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `argsSchema?` | `ObjectSchema`<`any`> | The method's argument schema. Freeze validates a step's `args` against it. | [src/batteries/orchestration/types.ts:947](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L947) |\n| `description` | `string` | The model-facing description, as core wrote it. | [src/batteries/orchestration/types.ts:945](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L945) |\n| `method` | `string` | Instance method this descriptor invokes (`'json_get'`, `'head'`). Not what a step names. | [src/batteries/orchestration/types.ts:943](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L943) |\n| `name` | `string` | Absolute, LLM-facing tool name (`'artifact_json_get'`). What a `steps[].name` cites. | [src/batteries/orchestration/types.ts:941](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L941) |\n| `serialise?` | (`result`: `unknown`) => `string` | The descriptor's own formatter, consulted at exactly ONE point: converting a FINAL result into a string for an `emit: {as:'value'}` field whose declared type is `string`. Never used when chaining steps — that would flatten the structure a following `emit: {as:'rows'}` needs. Where absent, the battery calls core's exported `defaultSerialise` rather than reimplementing it. | [src/batteries/orchestration/types.ts:954](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L954) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/AuthorityClaim","title":"Interface: AuthorityClaim","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/AuthorityClaim.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/AuthorityClaim","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/AuthorityClaim.md\ndescription: >-\n One unit of authority a `call` node claims. Approval binds the canonicalised\n union of every claim in the plan, so what an operator approved and what may\n run are the same set.\n---\n\n# Interface: AuthorityClaim\n\nDefined in: [src/batteries/orchestration/types.ts:1099](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1099)\n\nOne unit of authority a `call` node claims. Approval binds the canonicalised union of every claim\nin the plan, so what an operator approved and what may run are the same set.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | --------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `capability` | `string` | What kind of thing may be acted on. | [src/batteries/orchestration/types.ts:1101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1101) |\n| `scope` | `string` | Which instances of it. | [src/batteries/orchestration/types.ts:1103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1103) |\n| `verb` | [`AuthorityVerb`](../type-aliases/AuthorityVerb.md) | What may be done to them. | [src/batteries/orchestration/types.ts:1105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1105) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchId","title":"Interface: BranchId","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchId.md\ndescription: 'A path identity: the route from `entry` to a frame, kept as the route itself.'\n---\n\n# Interface: BranchId\n\nDefined in: [src/batteries/orchestration/types.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L223)\n\nA path identity: the route from `entry` to a frame, kept as the route itself.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `segments` | [`RouteSegment`](../type-aliases/RouteSegment.md)\\[] | The route, in traversal order. Empty for the entry frame. A join segment carries the correlation prefix before it — see the type's own remarks for why that prefix is load-bearing. | [src/batteries/orchestration/types.ts:228](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L228) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchNodeDefinition","title":"Interface: BranchNodeDefinition","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchNodeDefinition.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchNodeDefinition","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/BranchNodeDefinition.md\ndescription: >-\n A two-way branch: the predicate's verdict picks the `match` or `no_match`\n handle.\n---\n\n# Interface: BranchNodeDefinition\n\nDefined in: [src/batteries/orchestration/types.ts:613](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L613)\n\nA two-way branch: the predicate's verdict picks the `match` or `no_match` handle.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `evaluator` | `string` | Which `PredicateEvaluator` cell interprets `predicate`. Refused at freeze if not wired. | [src/batteries/orchestration/types.ts:615](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L615) |\n| `predicate` | [`EncodableValue`](../type-aliases/EncodableValue.md) | The cell's own predicate form. `EncodableValue` so the whole plan stays persistable. | [src/batteries/orchestration/types.ts:617](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L617) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/CallNodeDefinition","title":"Interface: CallNodeDefinition","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/CallNodeDefinition.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/CallNodeDefinition","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/CallNodeDefinition.md\ndescription: >-\n A staged tool invocation — the node kind the whole staging environment exists\n to gate.\n---\n\n# Interface: CallNodeDefinition\n\nDefined in: [src/batteries/orchestration/types.ts:361](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L361)\n\nA staged tool invocation — the node kind the whole staging environment exists to gate.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`ArgValue`](../type-aliases/ArgValue.md)> | The staged arguments. A value may be a literal or a `NodeRef` to another node's output. | [src/batteries/orchestration/types.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L365) |\n| `authority` | [`AuthorityClaim`](AuthorityClaim.md)\\[] | What this call is authorised to do. Approval binds the canonicalised union of these. | [src/batteries/orchestration/types.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L371) |\n| `declassifies?` | `string`\\[] | Output field paths this tool is trusted to have SANITISED — the only way taint is cleared. Omitted (the default) means this node declassifies nothing. See the taint rules: type validation is not sanitisation, so declassification must be asserted, never inferred. | [src/batteries/orchestration/types.ts:388](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L388) |\n| `onIndeterminate` | `\"retry\"` | `\"halt\"` | `\"skip\"` | What to do when this call was entered but never settled — a resume cannot tell whether the side effect happened. Required, and a decision about THIS call, which is why it is separate from `replaySafe`. | [src/batteries/orchestration/types.ts:382](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L382) |\n| `onMissingValue` | `\"fail\"` | `\"omit\"` | What to do when a `NodeRef` resolves to nothing. Required, no default. | [src/batteries/orchestration/types.ts:369](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L369) |\n| `output` | [`DeclaredField`](../type-aliases/DeclaredField.md)\\[] | The fields this call promises to produce, so downstream `NodeRef`s are checkable at freeze. | [src/batteries/orchestration/types.ts:367](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L367) |\n| `replaySafe` | `boolean` | Whether re-invoking this tool with the same arguments is safe. Required, and a fact about the TOOL — not a decision about this call, which is what `onIndeterminate` records. | [src/batteries/orchestration/types.ts:376](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L376) |\n| `tool` | `string` | The tool to invoke. Refused at freeze unless `InvocableTools.has(tool)` — the Tier-C boundary. | [src/batteries/orchestration/types.ts:363](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L363) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ClonedFrom","title":"Interface: ClonedFrom","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ClonedFrom.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ClonedFrom","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/ClonedFrom.md\ndescription: A clone's lineage.\n---\n\n# Interface: ClonedFrom\n\nDefined in: [src/batteries/orchestration/types.ts:1405](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1405)\n\nA clone's lineage.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `completedAtClone` | `string`\\[] | Node ids the parent had settled `ok` when the clone was taken; `[]` if it never ran. | [src/batteries/orchestration/types.ts:1413](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1413) |\n| `parent` | `string` | The plan cloned from. | [src/batteries/orchestration/types.ts:1407](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1407) |\n| `parentDigest` | `string` | The parent's content digest at clone time. | [src/batteries/orchestration/types.ts:1409](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1409) |\n| `parentRevision` | `number` | The parent's revision at clone time. | [src/batteries/orchestration/types.ts:1411](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1411) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/EntryNodeDefinition","title":"Interface: EntryNodeDefinition","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/EntryNodeDefinition.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/EntryNodeDefinition","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/EntryNodeDefinition.md\ndescription: The one place external input enters the graph.\n---\n\n# Interface: EntryNodeDefinition\n\nDefined in: [src/batteries/orchestration/types.ts:334](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L334)\n\nThe one place external input enters the graph.\n\n## Remarks\n\nTOPOLOGY INVARIANTS, all enforced at freeze: EXACTLY ONE `entry` node — zero means nothing can\nstart, more than one means `executePlan` cannot tell which to materialise, and it takes no entry\nargument by design. The entry node has NO incoming edges. Every other node is reachable from it.\nThe graph is acyclic over every handle, `error` and `default` included. Every `join` is a\nDIAMOND (see `JoinNodeDefinition`). Every edge id matches `/^[A-Za-z0-9_-]{1,64}$/`.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | [`DeclaredField`](../type-aliases/DeclaredField.md)\\[] | The fields a run's `input` must supply. Validated before any node runs. | [src/batteries/orchestration/types.ts:336](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L336) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/FrameRef","title":"Interface: FrameRef","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/FrameRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/FrameRef","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/FrameRef.md\ndescription: >-\n Identifies one execution of one node: the node, and the path that reached it.\n `kind` rides along so the fold can classify without the graph (only a `call`\n frame can be indeterminate). `viaEdgeId` is the edge that produced this frame\n — `undefined` for the entry frame, which no edge produced. `branchId` is the\n path identity and is what makes a frame unique.\n---\n\n# Interface: FrameRef\n\nDefined in: [src/batteries/orchestration/types.ts:766](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L766)\n\nIdentifies one execution of one node: the node, and the path that reached it. `kind` rides\nalong so the fold can classify without the graph (only a `call` frame can be indeterminate).\n`viaEdgeId` is the edge that produced this frame — `undefined` for the entry frame, which no\nedge produced. `branchId` is the path identity and is what makes a frame unique.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `branchId` | [`BranchId`](BranchId.md) | The path that reached it. This is what makes a frame unique. | [src/batteries/orchestration/types.ts:772](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L772) |\n| `kind` | [`PlanNodeKind`](../type-aliases/PlanNodeKind.md) | Rides along so the fold can classify without the graph — only a `call` can be indeterminate. | [src/batteries/orchestration/types.ts:770](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L770) |\n| `nodeId` | `string` | Which node. | [src/batteries/orchestration/types.ts:768](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L768) |\n| `viaEdgeId` | `string` | `undefined` | The edge that produced this frame. `undefined` for the entry frame, which no edge produced. | [src/batteries/orchestration/types.ts:774](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L774) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/FreezeInputs","title":"Interface: FreezeInputs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/FreezeInputs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/FreezeInputs","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/FreezeInputs.md\ndescription: What freeze validation needs that is NOT derivable from the plan itself.\n---\n\n# Interface: FreezeInputs\n\nDefined in: [src/batteries/orchestration/types.ts:1381](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1381)\n\nWhat freeze validation needs that is NOT derivable from the plan itself.\n\n## Remarks\n\nResolved the same way as `RunDeps`: construction supplies the defaults, a call may override\nfield by field, evaluators merge by cell id. `Orchestration.freezePlan` therefore takes\n`Partial` and `validation.ts`'s internal entry point takes this fully-resolved\nshape — the resolution happens once, at the assembly point.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ----------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `evaluators` | [`PredicateEvaluator`](PredicateEvaluator.md)\\[] | The wired cells. A `branch`/`select` naming an absent cell is refused here. | [src/batteries/orchestration/types.ts:1385](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1385) |\n| `invocable` | [`InvocableTools`](InvocableTools.md) | The Tier-C allowlist, and the source of each tool's declared return class. | [src/batteries/orchestration/types.ts:1383](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1383) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/InstantiatedFrom","title":"Interface: InstantiatedFrom","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/InstantiatedFrom.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/InstantiatedFrom","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/InstantiatedFrom.md\ndescription: >-\n Instantiation lineage, for the renderer and for audit. **Not a taint\n mechanism** — see below.\n---\n\n# Interface: InstantiatedFrom\n\nDefined in: [src/batteries/orchestration/types.ts:1419](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1419)\n\nInstantiation lineage, for the renderer and for audit. **Not a taint mechanism** — see below.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](../type-aliases/EncodableValue.md)> | The arguments substituted for its holes. | [src/batteries/orchestration/types.ts:1423](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1423) |\n| `template` | `string` | The template's id. | [src/batteries/orchestration/types.ts:1421](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1421) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/InvocableTools","title":"Interface: InvocableTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/InvocableTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/InvocableTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/InvocableTools.md\ndescription: >-\n The Tier-C boundary: which of the consumer's tools a staged `call` may invoke,\n and what each returns. Supplied by the consumer, because they are the only\n party that knows.\n---\n\n# Interface: InvocableTools\n\nDefined in: [src/batteries/orchestration/types.ts:1336](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1336)\n\nThe Tier-C boundary: which of the consumer's tools a staged `call` may invoke, and what each\nreturns. Supplied by the consumer, because they are the only party that knows.\n\n## Methods\n\n### has()\n\n```ts\nhas(tool: string): boolean;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1338](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1338)\n\n`true` if a staged `call` may invoke this tool unattended. The Tier-C boundary.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `tool` | `string` |\n\n#### Returns\n\n`boolean`\n\n***\n\n### names()\n\n```ts\nnames(): readonly string[];\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1340](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1340)\n\nFor a model-addressed refusal that names what IS available.\n\n#### Returns\n\nreadonly `string`\\[]\n\n***\n\n### returns()\n\n```ts\nreturns(tool: string):\n | {\n kind: \"text\";\n}\n | {\n kind: \"bytes\";\n}\n | {\n kind: \"media\";\n}\n | {\n artifactClass: ArtifactClassLike;\n kind: \"artifact\";\n}\n | undefined;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1363](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1363)\n\nWhat this tool returns, so freeze can validate a downstream `transform` against it. The\nconsumer knows: an ADK `Tool` carries `artifactConstructor` — a `() => SpooledArtifact\nsubclass` closure they already wrote (`src/lib/classes/tool.ts:103`) — so\n`{kind:'artifact', artifactClass: tool.artifactConstructor()}` is a declaration they can\nmake correctly with no new bookkeeping. `undefined` for a tool the consumer has not\ndeclared: a `transform` over such a node is then refused at freeze (naming the tool), rather\nthan the battery guessing a class it cannot know.\n\n**It carries the CLASS, not a descriptor array, and that is the fix for a real trap.** Core's\n`toolMethods` static SHADOWS rather than concatenates — `SpooledJsonArtifact.toolMethods` is\nits seven JSON descriptors only, with the base seven composed at the `forgeTools` layer\ninstead (`spooled_artifact.ts:232-240`). A seam taking a descriptor array would therefore\nhave been handed the leaf set by every consumer reading `.toolMethods`, and freeze would\nrefuse `artifact_head` on a JSON artifact while the plan advertised it. Handing over the\nclass moves the union into the battery, where `effectiveToolMethods` computes it once.\n\nThis is also the channel the transform freeze-check needs, and an earlier draft claimed the\ncheck without providing any channel at all — no IR field and no seam exposed a tool's\nartifact class, so the \"refuse a step absent from the source class, naming the legal set\"\nrule was unbuildable.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `tool` | `string` |\n\n#### Returns\n\n| {\n`kind`: `\"text\"`;\n}\n| {\n`kind`: `\"bytes\"`;\n}\n| {\n`kind`: `\"media\"`;\n}\n| {\n`artifactClass`: [`ArtifactClassLike`](ArtifactClassLike.md);\n`kind`: `\"artifact\"`;\n}\n| `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinNodeDefinition","title":"Interface: JoinNodeDefinition","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinNodeDefinition.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinNodeDefinition","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinNodeDefinition.md\ndescription: >-\n A join is a **DIAMOND join only**: it closes a fan-out that a single ancestor\n opened. The restriction is what makes joins implementable, and it is stated\n over the DIVERGENCE POINT, not over the immediate predecessors.\n---\n\n# Interface: JoinNodeDefinition\n\nDefined in: [src/batteries/orchestration/types.ts:686](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L686)\n\nA join is a **DIAMOND join only**: it closes a fan-out that a single ancestor opened. The\nrestriction is what makes joins implementable, and it is stated over the DIVERGENCE POINT, not\nover the immediate predecessors.\n\nFreeze-enforced topology, checked by walking the graph:\n\n* The join's **fork** is its immediate dominator. `entry → a; a → b; a → c; b → j; c → j` is the\n canonical diamond and its fork is `a`. (An earlier draft required all incoming edges to share\n one *immediate source*, which refused exactly this graph while admitting only a degenerate\n double-edge. The fork is the right notion.)\n* **The fork must actually diverge toward the join: there must be MORE THAN ONE distinct\n fork→join route.** Without this the rule accepts two degenerate shapes that are not diamonds\n at all: `entry → a → join` (a one-route \"barrier\" that is just a pass-through), and\n `fork → left|right → shared → join`, where the paths have already reconverged at `shared`, so\n the immediate dominator slides down to `shared` and the join again sees one route. Both are\n refused: a `join` whose fork→join route count is 1 is a `join` that should not exist, and the\n error says so.\n* **No reconvergence inside the diamond**: the fork→join region must contain no node with\n in-degree > 1 other than the join itself. This is what makes \"the immediate dominator is the\n divergence point\" true rather than accidental, and it removes the second degenerate case above\n at its root.\n* Every route from the fork to the join is join-free: no nested join inside the diamond, so the\n contributor set cannot itself depend on another barrier.\n* `required` is not authored. It IS the number of distinct routes from fork to join, computable\n at freeze because the region is acyclic, join-free and reconvergence-free.\n\nFour consequences, each an unresolvable problem under general DAG joins:\n\n1. **Correlation is decidable from the first arrival**, because the fork is known statically:\n the barrier key is the arriving route truncated at the fork (see `JoinState.correlationKey`).\n2. **Late arrivals cannot occur**: `required` equals the route count, so the barrier fires when\n every route has arrived and never before. No fired-barrier state, no dropped work, no second\n firing.\n3. **The join's identity is a GRAPH CONSTANT**: `of` is the sorted list of ALL its incoming edge\n ids — known at freeze, independent of which predicates fired — so a downstream `NodeRef` to\n a post-join node is authorable.\n4. **Its output is deterministic and its SHAPE is specified**: one `OutputItem` per **arrival**\n — which equals the incoming-edge count exactly because the reconvergence-free rule makes\n every fork→join route traverse a distinct incoming edge, so \"per arrival\" and \"per edge\"\n cannot disagree. Sorted by `via` then `branch` for a total order. Each carries\n `{ via: , from: , branch: }`. A join\n contributes no data of its own — it is a barrier — so its items are *provenance*, which is\n the only thing it actually knows. A downstream `NodeRef` to the join therefore reads which\n routes converged (useful in a predicate: \"did the retry path contribute?\"), while the\n contributing nodes' real outputs are read by referencing those nodes directly, which the\n successor's unioned `OutputTable` makes possible. Leaving the shape unstated would let one\n implementation emit `{}` and another wrap arrival tables — incompatible observable APIs.\n\nInteraction with branching, stated because it is the sharp edge: a `branch`/`select` INSIDE a\ndiamond can leave a route unfired, so the barrier never completes. That is not a hang — the\nexecutor settles the run `halted` with `{kind:'join_unsatisfiable', nodeId}` once no live frame\ncan still reach it. An author who wants \"proceed with whichever finished\" wants a `select` on a\nprior result, not a partial join; the plan says so rather than offering a quorum knob whose\nsemantics it cannot pin down.\n\nThe successor frame's `OutputTable` is the UNION of the arrivals' tables; keys are\n`${nodeId}:${branchKey}`, path-unique, so the union cannot collide and needs no merge policy.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ---------------------------------- | ---------- | ----------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind?` | `readonly` | `\"diamond\"` | Nothing to configure. `required` and the fork are both derived from the graph. | [src/batteries/orchestration/types.ts:688](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L688) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinState","title":"Interface: JoinState","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinState.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinState","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/JoinState.md\ndescription: A join's partial barrier.\n---\n\n# Interface: JoinState\n\nDefined in: [src/batteries/orchestration/types.ts:860](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L860)\n\nA join's partial barrier.\n\n**Correlation is decidable from ONE arrival**, and the diamond restriction is what buys it: the\njoin's **fork** is known at freeze, so the barrier key is the arriving route **truncated at the\nfork** — the prefix of segments up to and including the one that entered the fork:\n`` correlationKey = `${nodeId}@${branchKey(truncateAtFork(arriving, fork))}` ``.\nEvery sibling route passes through the same fork by the topology rule, so every sibling\ntruncates to the same prefix; and two different *executions* of the fork (reached by different\nouter routes) truncate to different prefixes, so their barriers stay separate.\n\nTwo rules that do NOT work, recorded because both were tried: the longest common prefix of the\n*contributors* is unknown when the first arrival lands, and \"drop the last segment\" gives the\nimmediate predecessor's route — which differs per sibling on a real diamond\n(`a→b→j` truncates to `e1`, `a→c→j` to `e2`). Truncating at a statically-known fork is what\nmakes all three properties hold at once.\n\nThis is also why `BranchId` keeps its route rather than a hash: the rule needs the structure.\nAnd why edge ids alone are insufficient: two arrivals over the same incoming edge from different\nfork executions differ only in earlier segments.\n\n`arrivals` records what landed; the barrier fires when `arrivals.length` equals `required`, and\na repeat of the same `(branchKey, edgeId)` pair is idempotent. Because the threshold IS the\nfork→join route count, there is no late-arrival case. The merged frame's identity is the\ncorrelation prefix + `{ join: nodeId, of: sorted(ALL incoming edge ids) }` — see `BranchId` for\nwhy the prefix must be retained, and note `of` being a graph constant is what makes a downstream\n`NodeRef` to a post-join node authorable at freeze.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `arrivals` | { `artifacts`: [`ArtifactTable`](../type-aliases/ArtifactTable.md); `branch`: [`BranchId`](BranchId.md); `edgeId`: `string`; `outputs`: [`OutputTable`](../type-aliases/OutputTable.md); }\\[] | Each arrival carries the branch-local `OutputTable` **and `ArtifactTable`** it arrived with. Without these a resumed half-satisfied join could not build its successor's dataflow context: the contributing branches' outputs and artifact handles were consumed into the barrier and are nowhere else in the frontier. `artifacts` is here for exactly the reason `outputs` is — a `transform` downstream of a join must still reach an instance a contributing branch produced. | [src/batteries/orchestration/types.ts:877](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L877) |\n| `correlationKey` | `string` | The barrier's identity: `` `${nodeId}@${branchKey(truncateAtFork(arriving, fork))}` ``. Every sibling route truncates to the same prefix; two executions of the fork truncate to different ones, so their barriers stay separate. See this type's remarks for the two rules that do not work and why. | [src/batteries/orchestration/types.ts:869](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L869) |\n| `nodeId` | `string` | The join this barrier belongs to. | [src/batteries/orchestration/types.ts:862](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L862) |\n| `required` | `number` | The join's in-degree. Not authored — derived from the graph, so it cannot disagree with it. | [src/batteries/orchestration/types.ts:884](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L884) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/MediaLike","title":"Interface: MediaLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/MediaLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/MediaLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/MediaLike.md\ndescription: >-\n A media value, structurally. Refused at freeze for a node whose `output`\n declares fields.\n---\n\n# Interface: MediaLike\n\nDefined in: [src/batteries/orchestration/types.ts:989](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L989)\n\nA media value, structurally. Refused at freeze for a node whose `output` declares fields.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------- | ---------- | -------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `mimeType` | `readonly` | `string` | The media's MIME type — the only member the battery reads. | [src/batteries/orchestration/types.ts:991](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L991) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/NodeOutput","title":"Interface: NodeOutput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/NodeOutput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/NodeOutput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/NodeOutput.md\ndescription: 'What a node produced on one path. Always an ARRAY, even for a single result.'\n---\n\n# Interface: NodeOutput\n\nDefined in: [src/batteries/orchestration/types.ts:244](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L244)\n\nWhat a node produced on one path. Always an ARRAY, even for a single result.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `branchId` | [`BranchId`](BranchId.md) | Which execution of the node produced this — the path that reached it. | [src/batteries/orchestration/types.ts:248](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L248) |\n| `items` | [`OutputItem`](OutputItem.md)\\[] | Always an array, even for a single result. | [src/batteries/orchestration/types.ts:246](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L246) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/Orchestration","title":"Interface: Orchestration","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/Orchestration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/Orchestration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/Orchestration.md\ndescription: >-\n The public surface. Each member is specified in its own section; this is the\n assembly.\n---\n\n# Interface: Orchestration\n\nDefined in: [src/batteries/orchestration/types.ts:1269](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1269)\n\nThe public surface. Each member is specified in its own section; this is the assembly.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `executePlan` | `public` | [`ExecutePlanFn`](../type-aliases/ExecutePlanFn.md) | Start or resume the plan's one run. A plan id admits at most one run, ever. | [src/batteries/orchestration/types.ts:1305](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1305) |\n| `raw` | `public` | { `diff`: (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`, `a`: `number` | `\"current\"`, `b`: `number` | `\"current\"`) => `Promise`<[`PlanDiff`](PlanDiff.md)>; `ops`: (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`, `opts?`: { `sinceLamport?`: `number`; `throughRevision?`: `number`; }) => `Promise`<[`PlanOp`](../type-aliases/PlanOp.md)\\[]>; `outline`: (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`) => `Promise`<[`PlanOutline`](PlanOutline.md)>; `plan`: (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`, `opts?`: { `revision?`: `number`; }) => `Promise`<[`RawPlanView`](RawPlanView.md)>; } | The structured views, for diff-rendering UIs rather than for reading. | [src/batteries/orchestration/types.ts:1313](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1313) |\n| `raw.diff` | `public` | (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`, `a`: `number` | `\"current\"`, `b`: `number` | `\"current\"`) => `Promise`<[`PlanDiff`](PlanDiff.md)> | - | [src/batteries/orchestration/types.ts:1316](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1316) |\n| `raw.ops` | `public` | (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`, `opts?`: { `sinceLamport?`: `number`; `throughRevision?`: `number`; }) => `Promise`<[`PlanOp`](../type-aliases/PlanOp.md)\\[]> | - | [src/batteries/orchestration/types.ts:1315](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1315) |\n| `raw.outline` | `public` | (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`) => `Promise`<[`PlanOutline`](PlanOutline.md)> | - | [src/batteries/orchestration/types.ts:1317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1317) |\n| `raw.plan` | `public` | (`store`: [`PlanStore`](../../interfaces/PlanStore.md), `planId`: `string`, `opts?`: { `revision?`: `number`; }) => `Promise`<[`RawPlanView`](RawPlanView.md)> | - | [src/batteries/orchestration/types.ts:1314](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1314) |\n| `render` | `public` | (`plan`: [`RawPlanView`](RawPlanView.md), `options`: [`RenderPlanOptions`](../../render/type-aliases/RenderPlanOptions.md)) => `string` | Prose rendering — what an operator actually reads before approving. | [src/batteries/orchestration/types.ts:1311](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1311) |\n| `store` | `readonly` | [`PlanStore`](../../interfaces/PlanStore.md) | The backing store, exposed so a consumer can list, read history and clone without a second handle. | [src/batteries/orchestration/types.ts:1329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1329) |\n\n## Methods\n\n### approvePlan()\n\n```ts\napprovePlan(planId: string, record: ApprovalRecord): Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1303](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1303)\n\nThe permission gate: it IS the `reviewable → executable` transition, so \"approved\" and\n\"executable\" are one fact. Refused unless the record's digest and authority set match the\nfrozen plan exactly — approving content that was never shown is the failure this prevents.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------- |\n| `planId` | `string` |\n| `record` | [`ApprovalRecord`](ApprovalRecord.md) |\n\n#### Returns\n\n`Promise`<[`TransitionResult`](../../type-aliases/TransitionResult.md)>\n\n***\n\n### freezePlan()\n\n```ts\nfreezePlan(planId: string, inputs?: Partial): Promise<{\n issues: PlanIssue[];\n ok: boolean;\n}>;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1294)\n\n`inputs` is optional because `createOrchestration` already holds `invocable` and any\nconfigured `evaluators`; a caller passes it only to override, with the same field-by-field\nprecedence as `RunOptions` (evaluators merging by cell id).\n\n**A supplied `invocable` REPLACES the configured allowlist wholesale — it is not intersected\nwith it.** That is deliberate: `evaluators` merge because two cells with different ids are\nadditive, while two allowlists are a single answer to \"what may a staged call invoke\", and\nsilently intersecting them would make the effective allowlist something neither the assembly\nnor the caller wrote.\n\nThe consequence is worth stating plainly: passing a WIDER `invocable` here freezes a plan\nagainst that wider set, so a plan naming a tool outside the assembly's allowlist can reach\n`executable`. This is a HOST-ONLY capability — the forged tools always pass the assembly's\nown `invocable`, so no model can reach this parameter — but if you expose `freezePlan` to\nanything less trusted than your own assembly code, pass no `inputs` at all.\n\nFreeze needs them because a\n`branch`/`select` with no wired cell, or a `call` naming a tool outside tier C, is refused\nthere — so a plan whose cell is supplied per-run must supply it here too, and that is the\npoint of the override. An earlier draft exported `freezePlan(planId)` while specifying\n`freezePlan(planId, inputs: FreezeInputs)` elsewhere, which left WP 04 and WP 12 without one\ncontract to implement.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `planId` | `string` |\n| `inputs?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`FreezeInputs`](FreezeInputs.md)> |\n\n#### Returns\n\n`Promise`<{\n`issues`: [`PlanIssue`](PlanIssue.md)\\[];\n`ok`: `boolean`;\n}>\n\n***\n\n### instantiate()\n\n```ts\ninstantiate(templateId: string, args: Record): Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1307](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1307)\n\nMint a new `editable` plan from a registered template with `args` substituted for its holes.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `templateId` | `string` |\n| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](../type-aliases/EncodableValue.md)> |\n\n#### Returns\n\n`Promise`<[`InstantiateResult`](../type-aliases/InstantiateResult.md)>\n\n***\n\n### templates()\n\n```ts\ntemplates(): readonly {\n id: string;\n params: DeclaredField[];\n summary: string;\n}[];\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1309](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1309)\n\nThe registered templates, as a model sees them: what to name, what it does, what to fill.\n\n#### Returns\n\nreadonly {\n`id`: `string`;\n`params`: [`DeclaredField`](../type-aliases/DeclaredField.md)\\[];\n`summary`: `string`;\n}\\[]\n\n***\n\n### tools()\n\n```ts\ntools(tier: \"front\" | \"authoring\"): Record;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1324](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1324)\n\nThe forge. Tier A (`front`) withholds graph mechanics; tier B (`authoring`) exposes them.\nThere is no tier C here — that is `invocable`, the consumer's own tools, which this battery\ngates rather than forges.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------- |\n| `tier` | `\"front\"` | `\"authoring\"` |\n\n#### Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Tool`](../../../../forge/classes/Tool.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/OutputItem","title":"Interface: OutputItem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/OutputItem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/OutputItem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/OutputItem.md\ndescription: >-\n One unit of a node's output. Items, after n8n — a node may emit several. The\n field is named `json` for continuity with that lineage, but its values are\n `EncodableValue`, so a tool may legitimately return a `Date`, a `RegExp`, a\n `Map` — the same domain a staged argument may hold, which is what lets an\n output feed an argument without a lossy hop. It is NOT restricted to\n JSON-representable values, and an earlier draft's \"JSON-shaped only\" gloss was\n wrong.\n---\n\n# Interface: OutputItem\n\nDefined in: [src/batteries/orchestration/types.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L164)\n\nOne unit of a node's output. Items, after n8n — a node may emit several. The field is named\n`json` for continuity with that lineage, but its values are `EncodableValue`, so a tool may\nlegitimately return a `Date`, a `RegExp`, a `Map` — the same domain a staged argument may hold,\nwhich is what lets an output feed an argument without a lossy hop. It is NOT restricted to\nJSON-representable values, and an earlier draft's \"JSON-shaped only\" gloss was wrong.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `json` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](../type-aliases/EncodableValue.md)> | The item's fields, addressable by a `NodeRef.path`. Named `json` for continuity with the n8n lineage, but its values are `EncodableValue` — a `Date`, `RegExp` or `Map` is legitimate here. | [src/batteries/orchestration/types.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L169) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PendingFrame","title":"Interface: PendingFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PendingFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PendingFrame","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PendingFrame.md\ndescription: >-\n A live frame: its identity, its branch-local value table, and its branch-local\n artifact table. `artifacts` is cloned on fan-out exactly like `outputs` and is\n what a `transform` reads its source instance from; it persists as handles, so\n a snapshot carries pointers, never bytes.\n---\n\n# Interface: PendingFrame\n\nDefined in: [src/batteries/orchestration/types.ts:820](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L820)\n\nA live frame: its identity, its branch-local value table, and its branch-local artifact table.\n`artifacts` is cloned on fan-out exactly like `outputs` and is what a `transform` reads its\nsource instance from; it persists as handles, so a snapshot carries pointers, never bytes.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `artifacts` | [`ArtifactTable`](../type-aliases/ArtifactTable.md) | The branch-local artifact table — where a `transform` reads its source instance. Cloned on fan-out exactly like `outputs`, and persisted as handles, so a snapshot carries pointers, never bytes. | [src/batteries/orchestration/types.ts:830](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L830) |\n| `frame` | [`FrameRef`](FrameRef.md) | Which execution of which node this frame is. | [src/batteries/orchestration/types.ts:822](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L822) |\n| `outputs` | [`OutputTable`](../type-aliases/OutputTable.md) | The branch-local value table this frame sees. Cloned on fan-out. | [src/batteries/orchestration/types.ts:824](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L824) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PhaseEntry","title":"Interface: PhaseEntry","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PhaseEntry.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PhaseEntry","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PhaseEntry.md\ndescription: >-\n One phase's entry in an outline. Carries exact surface forms, never\n paraphrase.\n---\n\n# Interface: PhaseEntry\n\nDefined in: [src/batteries/orchestration/types.ts:729](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L729)\n\nOne phase's entry in an outline. Carries exact surface forms, never paraphrase.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `issueCount` | `number` | How many issues fall in this phase, so a reader knows where to look without reading all. | [src/batteries/orchestration/types.ts:739](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L739) |\n| `nodeIds` | `string`\\[] | VERBATIM node ids — this is what a `NodeRef` must cite, so it cannot be abbreviated. | [src/batteries/orchestration/types.ts:735](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L735) |\n| `phase` | `string` | The phase label. | [src/batteries/orchestration/types.ts:731](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L731) |\n| `summary` | `string` | One line. | [src/batteries/orchestration/types.ts:733](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L733) |\n| `tools` | `string`\\[] | Verbatim tool names of this phase's `call` nodes. | [src/batteries/orchestration/types.ts:737](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L737) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanBounds","title":"Interface: PlanBounds","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanBounds.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanBounds","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanBounds.md\ndescription: >-\n The resource envelope. Plan CONTENT, so it is digested and an operator\n approves it.\n---\n\n# Interface: PlanBounds\n\nDefined in: [src/batteries/orchestration/types.ts:1145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1145)\n\nThe resource envelope. Plan CONTENT, so it is digested and an operator approves it.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `maxConcurrentFrames` | `number` | Cap on simultaneously live frames. | [src/batteries/orchestration/types.ts:1153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1153) |\n| `maxEdges` | `number` | Cap on edges. | [src/batteries/orchestration/types.ts:1149](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1149) |\n| `maxEncodedBytes` | `number` | Cap on the encoded plan size in bytes — the bound on staged byte payloads. | [src/batteries/orchestration/types.ts:1155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1155) |\n| `maxNodes` | `number` | Cap on nodes. Also bounds route length, since a route cannot revisit a node. | [src/batteries/orchestration/types.ts:1147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1147) |\n| `maxSteps` | `number` | Cap on total node executions in a run — the bound on fan-out breadth times depth. | [src/batteries/orchestration/types.ts:1151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1151) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanDiff","title":"Interface: PlanDiff","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanDiff.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanDiff","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanDiff.md\ndescription: Structural delta between two folded states — what a diff UI renders.\n---\n\n# Interface: PlanDiff\n\nDefined in: [src/batteries/orchestration/types.ts:1518](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1518)\n\nStructural delta between two folded states — what a diff UI renders.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `edgesAdded` | [`PlanEdge`](PlanEdge.md)\\[] | Edges present in `to` and absent from `from`. | [src/batteries/orchestration/types.ts:1532](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1532) |\n| `edgesRemoved` | [`PlanEdge`](PlanEdge.md)\\[] | Edges present in `from` and absent from `to`. | [src/batteries/orchestration/types.ts:1534](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1534) |\n| `from` | { `digest`: `string`; `revision`: `number`; } | The revision compared from. | [src/batteries/orchestration/types.ts:1520](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1520) |\n| `from.digest` | `string` | - | [src/batteries/orchestration/types.ts:1520](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1520) |\n| `from.revision` | `number` | - | [src/batteries/orchestration/types.ts:1520](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1520) |\n| `nodesAdded` | [`PlanNode`](../type-aliases/PlanNode.md)\\[] | Nodes present in `to` and absent from `from`. | [src/batteries/orchestration/types.ts:1524](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1524) |\n| `nodesChanged` | { `fields`: { `after`: [`ArgValue`](../type-aliases/ArgValue.md); `before`: [`ArgValue`](../type-aliases/ArgValue.md); `path`: `string`; }\\[]; `nodeId`: `string`; }\\[] | `ArgValue`, not `EncodableValue` — a changed field may hold a `NodeRef`, and typing it narrower would make a legitimate change unrepresentable in the diff (the `set_node_field` correction has to propagate here too). | [src/batteries/orchestration/types.ts:1530](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1530) |\n| `nodesRemoved` | [`PlanNode`](../type-aliases/PlanNode.md)\\[] | Nodes present in `from` and absent from `to`. | [src/batteries/orchestration/types.ts:1526](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1526) |\n| `to` | { `digest`: `string`; `revision`: `number`; } | The revision compared to. | [src/batteries/orchestration/types.ts:1522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1522) |\n| `to.digest` | `string` | - | [src/batteries/orchestration/types.ts:1522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1522) |\n| `to.revision` | `number` | - | [src/batteries/orchestration/types.ts:1522](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1522) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanEdge","title":"Interface: PlanEdge","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanEdge.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanEdge","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanEdge.md\ndescription: >-\n A directed edge. Its `handle` decides when it fires; the graph alone orders\n execution.\n---\n\n# Interface: PlanEdge\n\nDefined in: [src/batteries/orchestration/types.ts:287](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L287)\n\nA directed edge. Its `handle` decides when it fires; the graph alone orders execution.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `from` | `string` | Source node. | [src/batteries/orchestration/types.ts:296](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L296) |\n| `handle` | [`EdgeHandle`](../type-aliases/EdgeHandle.md) | When this edge fires, given the source's outcome. | [src/batteries/orchestration/types.ts:300](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L300) |\n| `id` | `string` | The edge's identity. Matches `/^[A-Za-z0-9_-]{1,64}$/` so `branchKey` cannot be forged. Uniqueness is a FREEZE-time invariant, not an append-time one: refusing \"whichever arrived second\" would make the op fold order-dependent, so a same-id collision resolves by LWW on `(lamport, actorId, opId)` and the losing edge is surfaced as a submit-time issue naming both. | [src/batteries/orchestration/types.ts:294](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L294) |\n| `to` | `string` | Target node. | [src/batteries/orchestration/types.ts:298](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L298) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanIssue","title":"Interface: PlanIssue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanIssue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanIssue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanIssue.md\ndescription: >-\n One finding from validation. Model-addressed, because a model is what usually\n acts on it.\n---\n\n# Interface: PlanIssue\n\nDefined in: [src/batteries/orchestration/types.ts:1504](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1504)\n\nOne finding from validation. Model-addressed, because a model is what usually acts on it.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ---------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `code` | `string` | Stable code, e.g. `'missing_authority'`, `'dangling_edge'`. Safe to branch on. | [src/batteries/orchestration/types.ts:1506](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1506) |\n| `edgeId?` | `string` | The edge at fault, where one is implicated. | [src/batteries/orchestration/types.ts:1512](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1512) |\n| `message` | `string` | Model-addressed prose that NAMES THE FIX, not merely the fault. | [src/batteries/orchestration/types.ts:1508](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1508) |\n| `nodeId?` | `string` | The node at fault, where one is implicated. | [src/batteries/orchestration/types.ts:1510](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1510) |\n| `severity` | `\"blocking\"` | `\"advisory\"` | `blocking` refuses the freeze; `advisory` is surfaced and allowed through. | [src/batteries/orchestration/types.ts:1514](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1514) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanOutline","title":"Interface: PlanOutline","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanOutline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanOutline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanOutline.md\ndescription: 'ONE flat level. Entries carry exact surface forms, not paraphrase.'\n---\n\n# Interface: PlanOutline\n\nDefined in: [src/batteries/orchestration/types.ts:714](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L714)\n\nONE flat level. Entries carry exact surface forms, not paraphrase.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `digest` | `string` | The content digest at the revision outlined. | [src/batteries/orchestration/types.ts:720](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L720) |\n| `nodeCount` | `number` | Total nodes, so a reader knows what the phase entries account for. | [src/batteries/orchestration/types.ts:722](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L722) |\n| `phases` | [`PhaseEntry`](PhaseEntry.md)\\[] | One entry per phase label, in authoring order. | [src/batteries/orchestration/types.ts:724](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L724) |\n| `planId` | `string` | The plan this outlines. | [src/batteries/orchestration/types.ts:716](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L716) |\n| `state` | [`PlanState`](../type-aliases/PlanState.md) | Its lifecycle state NOW — read from the store, not folded from the log. | [src/batteries/orchestration/types.ts:718](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L718) |\n| `unphased` | [`PhaseEntry`](PhaseEntry.md) | `undefined` | Nodes with no `phase`, addressed exactly the same way. `undefined` when every node has one. | [src/batteries/orchestration/types.ts:726](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L726) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSlice","title":"Interface: PlanSlice","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSlice.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSlice","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSlice.md\ndescription: >-\n A slice. Self-locating: it carries enough neighbourhood to keep linking\n without re-reading.\n---\n\n# Interface: PlanSlice\n\nDefined in: [src/batteries/orchestration/types.ts:742](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L742)\n\nA slice. Self-locating: it carries enough neighbourhood to keep linking without re-reading.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `boundary` | { `incoming`: `string`\\[]; `outgoing`: `string`\\[]; } | Immediate predecessors/successors of the slice, by id, so linking needs no second read. | [src/batteries/orchestration/types.ts:748](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L748) |\n| `boundary.incoming` | `string`\\[] | - | [src/batteries/orchestration/types.ts:748](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L748) |\n| `boundary.outgoing` | `string`\\[] | - | [src/batteries/orchestration/types.ts:748](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L748) |\n| `issues` | [`PlanIssue`](PlanIssue.md)\\[] | Issues falling within this slice. | [src/batteries/orchestration/types.ts:750](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L750) |\n| `nodes` | [`PlanNode`](../type-aliases/PlanNode.md)\\[] | The nodes in this slice, in full. | [src/batteries/orchestration/types.ts:744](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L744) |\n| `phase?` | `string` | The phase this slice was taken from, when it was taken by phase. | [src/batteries/orchestration/types.ts:746](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L746) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSummary","title":"Interface: PlanSummary","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSummary.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSummary","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanSummary.md\ndescription: >-\n A plan's headline, for listings. Carries `state`, which `RawPlanView`\n deliberately does not.\n---\n\n# Interface: PlanSummary\n\nDefined in: [src/batteries/orchestration/types.ts:1484](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1484)\n\nA plan's headline, for listings. Carries `state`, which `RawPlanView` deliberately does not.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `digest` | `string` | The current content digest. | [src/batteries/orchestration/types.ts:1490](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1490) |\n| `label?` | `string` | An author-supplied label, when one was set. | [src/batteries/orchestration/types.ts:1496](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1496) |\n| `nodeCount` | `number` | How many nodes it holds. | [src/batteries/orchestration/types.ts:1494](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1494) |\n| `planId` | `string` | The plan. | [src/batteries/orchestration/types.ts:1486](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1486) |\n| `provenance?` | [`PlanProvenance`](../type-aliases/PlanProvenance.md) | Where the plan came from, when it was not authored from scratch. | [src/batteries/orchestration/types.ts:1498](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1498) |\n| `revision` | `number` | The current revision. | [src/batteries/orchestration/types.ts:1492](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1492) |\n| `state` | [`PlanState`](../type-aliases/PlanState.md) | Its lifecycle state NOW. | [src/batteries/orchestration/types.ts:1488](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1488) |\n| `updatedAt` | `string` | When the plan last changed, ISO-8601. | [src/batteries/orchestration/types.ts:1500](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1500) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanTemplate","title":"Interface: PlanTemplate","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanTemplate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanTemplate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PlanTemplate.md\ndescription: >-\n A consumer-defined plan shape, written in TypeScript and registered at\n construction — so it versions with the consuming application, needs no store\n seeding, and can be validated once at boot rather than per instantiation.\n---\n\n# Interface: PlanTemplate\n\nDefined in: [src/batteries/orchestration/types.ts:1211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1211)\n\nA consumer-defined plan shape, written in TypeScript and registered at construction — so it\nversions with the consuming application, needs no store seeding, and can be validated once at\nboot rather than per instantiation.\n\nNote what a template holds: **op INPUTS without identity**. A `PlanOp` requires\n`opId`/`actorId`/`lamport`/`at`, none of which a static literal can carry (the same reason\nbounds are a fold seed rather than an implied op). Instantiation mints that identity.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `bounds?` | [`PlanBounds`](PlanBounds.md) | Omitted ⇒ `DEFAULT_PLAN_BOUNDS`. | [src/batteries/orchestration/types.ts:1230](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1230) |\n| `edges` | [`PlanEdge`](PlanEdge.md)\\[] | The shape's edges. Identical to a plan's — an edge holds no staged values, so no hole can sit in one. | [src/batteries/orchestration/types.ts:1228](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1228) |\n| `id` | `string` | Stable identity — what a model names to instantiate. | [src/batteries/orchestration/types.ts:1213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1213) |\n| `nodes` | [`TemplateNode`](../type-aliases/TemplateNode.md)\\[] | The shape. NOT `PlanNode[]` — a template's staged values may hold a `ParamRef`, which `ArgValue` deliberately excludes, so a consumer writing a template in TypeScript could not place a hole without a cast. `TemplateNode` widens exactly that one axis. | [src/batteries/orchestration/types.ts:1223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1223) |\n| `params` | [`DeclaredField`](../type-aliases/DeclaredField.md)\\[] | Declared holes, same type as the entry node's input — so a model fills a form, not a graph. | [src/batteries/orchestration/types.ts:1217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1217) |\n| `summary` | `string` | One line, shown by `list_templates`. | [src/batteries/orchestration/types.ts:1215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1215) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateContext","title":"Interface: PredicateContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateContext.md\ndescription: >-\n What a cell may read when evaluating. Deliberately narrow: outputs and the\n frame, nothing live.\n---\n\n# Interface: PredicateContext\n\nDefined in: [src/batteries/orchestration/types.ts:1084](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1084)\n\nWhat a cell may read when evaluating. Deliberately narrow: outputs and the frame, nothing live.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `frame` | [`FrameRef`](FrameRef.md) | Which execution of which node is being decided. | [src/batteries/orchestration/types.ts:1088](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1088) |\n| `outputs` | [`OutputTable`](../type-aliases/OutputTable.md) | The frame's branch-local value table. | [src/batteries/orchestration/types.ts:1086](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1086) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateEvaluator","title":"Interface: PredicateEvaluator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateEvaluator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateEvaluator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/PredicateEvaluator.md\ndescription: >-\n A predicate cell: the seam that lets a `branch`/`select` interpret its own\n predicate form without this battery specifying an expression language.\n---\n\n# Interface: PredicateEvaluator\n\nDefined in: [src/batteries/orchestration/types.ts:1070](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1070)\n\nA predicate cell: the seam that lets a `branch`/`select` interpret its own predicate form without\nthis battery specifying an expression language.\n\n## Extended by\n\n* [`LuaCell`](../../../../../../batteries/orchestration/cells/lua/interfaces/LuaCell.md)\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `readonly` | `string` | How a node names this cell in `evaluator`. Cells merge by this id across construction and run. | [src/batteries/orchestration/types.ts:1072](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1072) |\n\n## Methods\n\n### evaluate()\n\n```ts\nevaluate(node: PlanNode, ctx: PredicateContext): Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1081](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1081)\n\nDecide the node's outcome. Called once per frame reaching the node.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------- |\n| `node` | [`PlanNode`](../type-aliases/PlanNode.md) |\n| `ctx` | [`PredicateContext`](PredicateContext.md) |\n\n#### Returns\n\n`Promise`<[`PredicateVerdict`](../type-aliases/PredicateVerdict.md)>\n\n***\n\n### load()\n\n```ts\nload(): Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1077](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1077)\n\nAcquire whatever the cell needs — typically an optional peer. Awaited at construction, so a\nmissing peer fails at boot with a named error rather than part-way through a freeze.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### validate()\n\n```ts\nvalidate(node: PlanNode): Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1079](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1079)\n\nReject a predicate shape this cell cannot use. Called at freeze, so refusal precedes approval.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------- |\n| `node` | [`PlanNode`](../type-aliases/PlanNode.md) |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RawPlanView","title":"Interface: RawPlanView","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RawPlanView.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RawPlanView","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/RawPlanView.md\ndescription: >-\n The folded plan CONTENT at a revision. `rawPlan()` returns this; the renderer\n and validator read it. Note there is deliberately no `state` field: lifecycle\n state is not a `PlanOp`, so it cannot be folded from the log, and a historical\n revision therefore has no recoverable lifecycle state to report. `state` is a\n property of the plan NOW — read it from `PlanStore.readState()`, which is\n where it lives. A `RawPlanView` at revision 7 answers \"what did the content\n look like then\", not \"what state was it in then\".\n---\n\n# Interface: RawPlanView\n\nDefined in: [src/batteries/orchestration/types.ts:1462](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1462)\n\nThe folded plan CONTENT at a revision. `rawPlan()` returns this; the renderer and validator\nread it. Note there is deliberately no `state` field: lifecycle state is not a `PlanOp`, so it\ncannot be folded from the log, and a historical revision therefore has no recoverable\nlifecycle state to report. `state` is a property of the plan NOW — read it from\n`PlanStore.readState()`, which is where it lives. A `RawPlanView` at revision 7 answers \"what\ndid the content look like then\", not \"what state was it in then\".\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `bounds` | [`PlanBounds`](PlanBounds.md) | The bounds at that revision, seeded from `DEFAULT_PLAN_BOUNDS` and overridden by `set_bounds`. | [src/batteries/orchestration/types.ts:1478](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1478) |\n| `digest` | `string` | The content digest at this revision. Lossless, not a canonicalisation — see the digest rules. | [src/batteries/orchestration/types.ts:1468](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1468) |\n| `edges` | [`PlanEdge`](PlanEdge.md)\\[] | The edges at that revision. | [src/batteries/orchestration/types.ts:1474](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1474) |\n| `nodes` | [`PlanNode`](../type-aliases/PlanNode.md)\\[] | The nodes at that revision. | [src/batteries/orchestration/types.ts:1472](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1472) |\n| `planId` | `string` | The plan. | [src/batteries/orchestration/types.ts:1464](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1464) |\n| `provenance?` | [`PlanProvenance`](../type-aliases/PlanProvenance.md) | Where the plan came from, when it was not authored from scratch. | [src/batteries/orchestration/types.ts:1480](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1480) |\n| `revision` | `number` | Which revision this view folded to. | [src/batteries/orchestration/types.ts:1470](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1470) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ReasonNodeDefinition","title":"Interface: ReasonNodeDefinition","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ReasonNodeDefinition.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/ReasonNodeDefinition","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/ReasonNodeDefinition.md\ndescription: >-\n A reason node ENDS IN A TOOL CALL, and that tool call IS its output — it never\n returns prose to be parsed. `outputSchema` becomes the forced tool's\n `inputSchema`, so the model physically cannot answer unstructured: the\n validator rejects malformed args and the battery retries within `maxAttempts`.\n The captured, validated args are the node's `OutputItem.json`. Note this node\n carries a Schema, NOT DeclaredField[] — a validator expresses nested objects\n and unions that DeclaredField cannot, and it is what the forced tool needs\n anyway.\n---\n\n# Interface: ReasonNodeDefinition\n\nDefined in: [src/batteries/orchestration/types.ts:408](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L408)\n\nA reason node ENDS IN A TOOL CALL, and that tool call IS its output — it never returns prose\nto be parsed. `outputSchema` becomes the forced tool's `inputSchema`, so the model physically\ncannot answer unstructured: the validator rejects malformed args and the battery retries\nwithin `maxAttempts`. The captured, validated args are the node's `OutputItem.json`.\nNote this node carries a Schema, NOT DeclaredField\\[] — a validator expresses nested objects\nand unions that DeclaredField cannot, and it is what the forced tool needs anyway.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `maxAttempts` | `number` | Bounds the retry loop when the model's forced-tool args fail validation. Required, no default. | [src/batteries/orchestration/types.ts:427](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L427) |\n| `outputSchema` | `string` | The output schema as an ENCODED STRING, not a live `Schema`. A live validation schema is NOT `Encodable` — encoding one throws `E_UNENCODABLE_VALUE: Value of type symbol (Symbol(override)) is not encodable` — so embedding it would make the plan unpersistable. The repo already solved this exact problem in `Tool` (src/lib/classes/tool.ts:449-490): `[ENCODE_METHOD]` stores `encodeSchema(this.#inputSchema)` and `[DECODE_METHOD]` rebuilds it. NOTE the real export names — `@nhtio/validation` exports `encode` and `decode`, and tool.ts:7 aliases them at the import: `import { validator, encode as encodeSchema, decode as decodeSchema } from '@nhtio/validation'`. There is no export literally named `encodeSchema`. Use the same aliasing so the call sites read unambiguously next to the encoder's own `encode`/`decode`. | [src/batteries/orchestration/types.ts:425](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L425) |\n| `prompt` | [`PromptPart`](../type-aliases/PromptPart.md)\\[] | The prompt as a sequence of literal text and references, joined immediately before dispatch. | [src/batteries/orchestration/types.ts:410](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L410) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunDeps","title":"Interface: RunDeps","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunDeps.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunDeps","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunDeps.md\ndescription: 'The execution dependencies. Supplied at construction, per run, or both.'\n---\n\n# Interface: RunDeps\n\nDefined in: [src/batteries/orchestration/types.ts:1014](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1014)\n\nThe execution dependencies. Supplied at construction, per run, or both.\n\nPRECEDENCE, stated once so it cannot drift: **per-run wins, field by field, over construction**;\nanything absent from both is a construction-time error if the plan needs it. `evaluators` merges\nby cell `id` (a per-run cell replaces the configured one with the same id, others survive)\nbecause a run legitimately swaps one cell while keeping the rest. Everything else replaces\nwholesale.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `evaluators` | [`PredicateEvaluator`](PredicateEvaluator.md)\\[] | The predicate cells. A plan needing a cell that is absent is refused at freeze, not at run. | [src/batteries/orchestration/types.ts:1020](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1020) |\n| `invokeCall` | [`CallInvokerFn`](../type-aliases/CallInvokerFn.md) | How a `call` node actually invokes its tool. The consumer owns resolution and execution. | [src/batteries/orchestration/types.ts:1016](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1016) |\n| `locks?` | [`PlanLockFactory`](../../interfaces/PlanLockFactory.md) | Optional execution lease. Best-effort COORDINATION, not mutual exclusion: a TTL lease without a fencing token cannot exclude a partitioned holder. | [src/batteries/orchestration/types.ts:1025](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1025) |\n| `reason` | [`ReasonerFn`](../type-aliases/ReasonerFn.md) | How a `reason` node dispatches to a model. | [src/batteries/orchestration/types.ts:1018](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1018) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunOptions","title":"Interface: RunOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunOptions.md\ndescription: >-\n Per-run inputs. Every `RunDeps` member is OPTIONAL here: `createOrchestration`\n already holds whatever was configured, so a caller repeats only what it wants\n to override. `Orchestration`'s `executePlan` is therefore this shape, not the\n fully-required `RunDeps` — an earlier draft made every dependency mandatory\n per run while also calling construction the assembly point, which meant a\n caller had to repeat what it had just configured and left the override rule\n undefined.\n---\n\n# Interface: RunOptions\n\nDefined in: [src/batteries/orchestration/types.ts:1035](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1035)\n\nPer-run inputs. Every `RunDeps` member is OPTIONAL here: `createOrchestration` already holds\nwhatever was configured, so a caller repeats only what it wants to override. `Orchestration`'s\n`executePlan` is therefore this shape, not the fully-required `RunDeps` — an earlier draft made\nevery dependency mandatory per run while also calling construction the assembly point, which\nmeant a caller had to repeat what it had just configured and left the override rule undefined.\n\n## Extends\n\n* [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`RunDeps`](RunDeps.md)>\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `evaluators?` | [`PredicateEvaluator`](PredicateEvaluator.md)\\[] | The predicate cells. A plan needing a cell that is absent is refused at freeze, not at run. | [`RunDeps`](RunDeps.md).[`evaluators`](RunDeps.md#property-evaluators) | [src/batteries/orchestration/types.ts:1020](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1020) |\n| `indeterminate?` | `undefined` | Deliberately uninhabited. Indeterminate policy is per-node (`CallNodeDefinition.onIndeterminate`) and never a run-level default — the decision belongs with the call whose side effect is at stake. | - | [src/batteries/orchestration/types.ts:1050](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1050) |\n| `input` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](../type-aliases/EncodableValue.md)> | The run's input, materialised as the entry node's output before any other node runs. This is the taint origin: every value here is tainted, and provenance propagates from it. Input that fails validation aborts the run before any side effect — never a partially-started run. | - | [src/batteries/orchestration/types.ts:1041](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1041) |\n| `invokeCall?` | [`CallInvokerFn`](../type-aliases/CallInvokerFn.md) | How a `call` node actually invokes its tool. The consumer owns resolution and execution. | [`RunDeps`](RunDeps.md).[`invokeCall`](RunDeps.md#property-invokecall) | [src/batteries/orchestration/types.ts:1016](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1016) |\n| `locks?` | [`PlanLockFactory`](../../interfaces/PlanLockFactory.md) | Optional execution lease. Best-effort COORDINATION, not mutual exclusion: a TTL lease without a fencing token cannot exclude a partitioned holder. | [`RunDeps`](RunDeps.md).[`locks`](RunDeps.md#property-locks) | [src/batteries/orchestration/types.ts:1025](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1025) |\n| `reason?` | [`ReasonerFn`](../type-aliases/ReasonerFn.md) | How a `reason` node dispatches to a model. | [`RunDeps`](RunDeps.md).[`reason`](RunDeps.md#property-reason) | [src/batteries/orchestration/types.ts:1018](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1018) |\n| `resumeRunId?` | `string` | Resume an interrupted run rather than start one. | - | [src/batteries/orchestration/types.ts:1043](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1043) |\n| `signal?` | `AbortSignal` | Cancels the run. Surfaces as a `turn_abort` interruption. | - | [src/batteries/orchestration/types.ts:1045](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1045) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunProjection","title":"Interface: RunProjection","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunProjection.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunProjection","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/RunProjection.md\ndescription: >-\n What `foldRun` returns: the whole answer to \"where did it stop and what\n happened\".\n---\n\n# Interface: RunProjection\n\nDefined in: [src/batteries/orchestration/types.ts:1586](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1586)\n\nWhat `foldRun` returns: the whole answer to \"where did it stop and what happened\".\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `digest` | `string` | The plan digest the run started against. | [src/batteries/orchestration/types.ts:1590](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1590) |\n| `edgesTaken` | { `edgeId`: `string`; `evidence?`: [`EncodableValue`](../type-aliases/EncodableValue.md); `handle`: [`EdgeHandle`](../type-aliases/EdgeHandle.md); }\\[] | Every edge that fired, with whatever evidence the predicate recorded. | [src/batteries/orchestration/types.ts:1619](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1619) |\n| `frameStatus` | `ReadonlyMap`<`string`, `\"failed\"` | `\"skipped\"` | `\"running\"` | `\"done\"`> | Keyed by FRAME, not by NodeId: a node may run on several branches and several runs, so one node can simultaneously have a settled frame and an entered-but-unsettled one. The key is `${nodeId}:${branchKey(branchId)}`. `nodeStatusById` is the convenience rollup — a node is `running` if any frame is, `failed` if any frame failed, `done` only if every frame settled. | [src/batteries/orchestration/types.ts:1597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1597) |\n| `frontier` | { `frames`: [`PendingFrame`](PendingFrame.md)\\[]; `joins`: [`JoinState`](JoinState.md)\\[]; } | DELIBERATELY no run-wide `artifacts` counterpart. `outputs` is run-wide because a `RunProjection` is the audit answer to \"what did each node produce\", and its values are plain data. Artifact instances are *branch-local execution state*, not results: they are read by the `transform` running on the branch that produced them, and they live on `PendingFrame.artifacts` and `JoinState.arrivals[].artifacts`, which the `frontier` already carries. A run-wide table would additionally force every artifact of every completed branch to be rebound on every fold — resolver calls, and for in-memory readers base64 bytes — to answer a question nothing asks. | [src/batteries/orchestration/types.ts:1614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1614) |\n| `frontier.frames` | [`PendingFrame`](PendingFrame.md)\\[] | - | [src/batteries/orchestration/types.ts:1614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1614) |\n| `frontier.joins` | [`JoinState`](JoinState.md)\\[] | - | [src/batteries/orchestration/types.ts:1614](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1614) |\n| `indeterminate` | [`FrameRef`](FrameRef.md)\\[] | Entered without settling AND of kind `call` — the indeterminate set, exactly. Other kinds are re-entered unconditionally (see the commit protocol), so they never appear here. | [src/batteries/orchestration/types.ts:1617](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1617) |\n| `interruption?` | [`InterruptionCause`](../type-aliases/InterruptionCause.md) | Why it stopped, when it stopped short. | [src/batteries/orchestration/types.ts:1627](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1627) |\n| `nodeStatusById` | `ReadonlyMap`<`string`, `\"failed\"` | `\"skipped\"` | `\"running\"` | `\"done\"` | `\"pending\"`> | The per-node rollup: `running` if any frame is, `failed` if any failed, `done` only if every frame settled. | [src/batteries/orchestration/types.ts:1602](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1602) |\n| `outcome` | `\"completed\"` | `\"halted\"` | `\"aborted\"` | `\"running\"` | Where the run stands. `running` is what a fold reports for a log with no `run_settled` — it does NOT assert the process is alive, because a dead process's log is byte-identical to a live in-flight one. The difference is liveness, not history, and `foldRun` reads only history. | [src/batteries/orchestration/types.ts:1625](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1625) |\n| `outputs` | [`OutputTable`](../type-aliases/OutputTable.md) | Every `ok` settlement's output, run-wide. Plain data, unlike the artifact tables. | [src/batteries/orchestration/types.ts:1604](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1604) |\n| `runId` | `string` | The run. Folded from `run_started`, so it needs no side channel. | [src/batteries/orchestration/types.ts:1588](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1588) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/SelectNodeDefinition","title":"Interface: SelectNodeDefinition","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/SelectNodeDefinition.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/SelectNodeDefinition","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/SelectNodeDefinition.md\ndescription: >-\n An n-way switch: the verdict names a case, or falls to the required `default`\n handle.\n---\n\n# Interface: SelectNodeDefinition\n\nDefined in: [src/batteries/orchestration/types.ts:620](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L620)\n\nAn n-way switch: the verdict names a case, or falls to the required `default` handle.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `cases` | `string`\\[] | The legal case labels. Each names a `case_${label}` handle. | [src/batteries/orchestration/types.ts:626](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L626) |\n| `evaluator` | `string` | Which `PredicateEvaluator` cell interprets `predicate`. Refused at freeze if not wired. | [src/batteries/orchestration/types.ts:622](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L622) |\n| `predicate` | [`EncodableValue`](../type-aliases/EncodableValue.md) | The cell's own predicate form. `EncodableValue` so the whole plan stays persistable. | [src/batteries/orchestration/types.ts:624](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L624) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/SpooledArtifactLike","title":"Interface: SpooledArtifactLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/SpooledArtifactLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/SpooledArtifactLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/SpooledArtifactLike.md\ndescription: >-\n A spooled artifact instance, structurally — per CONTRIBUTING §13, the battery\n does not import the core classes. This is the value a `call` may return and a\n `transform` reads its methods from.\n---\n\n# Interface: SpooledArtifactLike\n\nDefined in: [src/batteries/orchestration/types.ts:982](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L982)\n\nA spooled artifact instance, structurally — per CONTRIBUTING §13, the battery does not import\nthe core classes. This is the value a `call` may return and a `transform` reads its methods from.\n\n## Indexable\n\n```ts\n[method: string]: unknown\n```\n\nThe descriptor-named instance methods, invoked by a `transform` step.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ------------------------------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `constructor` | `readonly` | [`ArtifactClassLike`](ArtifactClassLike.md) | The class, for `effectiveToolMethods`. NOT a pre-unioned descriptor list — see above. | [src/batteries/orchestration/types.ts:984](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L984) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/TransformNodeDefinition","title":"Interface: TransformNodeDefinition","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/TransformNodeDefinition.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/interfaces/TransformNodeDefinition","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/TransformNodeDefinition.md\ndescription: >-\n A `transform` node converts one node's output into the shape a downstream node\n needs — the bridge between what ADK tools actually return (`string |\n Uint8Array | SpooledArtifact | Media[]`) and the pathable fields a `NodeRef`\n reads.\n---\n\n# Interface: TransformNodeDefinition\n\nDefined in: [src/batteries/orchestration/types.ts:597](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L597)\n\nA `transform` node converts one node's output into the shape a downstream node needs — the\nbridge between what ADK tools actually return (`string | Uint8Array | SpooledArtifact | Media[]`)\nand the pathable fields a `NodeRef` reads.\n\n**It invents no mapping language.** Each step names a descriptor from the artifact classes' OWN\n`toolMethods` registry (`src/lib/classes/spooled_artifact.ts:56-70` — `{name, method,\ndescription, argsSchema?, serialise?}`), which is exactly the declarative surface `forgeTools`\nalready drives for the model.\n\n**ONE VOCABULARY, stated once: a step names the descriptor's `name`** — the absolute,\nLLM-facing identifier (`artifact_json_get`, `artifact_head`), which is why the field is called\n`name` and not `method`: it is byte-equal to the `ArtifactMethodDescriptor` field it must match.\nThe battery then invokes that descriptor's own `method` (`json_get`, `head`) on the instance.\nSo the rule is: **the plan names what the model sees; the battery invokes what the descriptor\nsays.** An earlier draft called the field `method` while its examples used `name` values, so\ntwo WPs and the test fixture read one contract two incompatible ways — and the two sets are\ndisjoint strings (`artifact_json_get` ≠ `json_get`), so half the examples were wrong either\nway. `name` is the right half to keep: it is documented as \"Absolute tool name as exposed to\nthe LLM\", it is the identifier a model has already seen in a tool catalogue, and it is unique\nacross a class chain in a way `method` is not guaranteed to be. Note also that three base\n`method` values are camelCase (`byteLength`, `lineCount`, `estimateTokens`) while every `name`\nis snake\\_case — one more reason authoring against `name` is the stabler surface.\n\nThe vocabulary is therefore `artifact_json_get`/`_pluck`/`_filter`/`_slice`,\n`artifact_md_sections`/`_frontmatter`/`_headings`, `artifact_head`/`_tail`/`_grep`/`_cat` and\nthe rest of the base seven, plus whatever a consumer's own `SpooledArtifact` subclass adds — a\nbattery-specific expression language would have been a second surface to specify, validate and\nlint, and this needs none.\n\n**Class-aware, and EXTENSIBLE for free.** The source class comes from\n`InvocableTools.returns(tool)` — the consumer's declaration of what each tool returns, which is\nthe only party that knows. Freeze validates `steps[].name` against the class's **effective**\ndescriptor set and `args` against the descriptor's own `argsSchema`, so an `artifact_json_get`\non a Markdown artifact or a bad path is refused before approval. Where `returns()` yields\n`undefined`, freeze refuses the transform naming the undeclared tool — the battery does not\nguess a class.\n\n**`toolMethods` SHADOWS, so the effective set must be computed — the battery does it, not the\nconsumer.** This is the trap that makes `returns()` carry the CLASS rather than a descriptor\narray. `spooled_artifact.ts:232-240` states it outright: *\"Each `toolMethods` array lists\n**only** its own class's descriptors — subclasses do not concatenate inherited descriptors.\"*\n`SpooledJsonArtifact.toolMethods` is its seven JSON descriptors and nothing else; the base\nseven are composed at a different layer entirely (`SpooledJsonArtifact.forgeTools` calls\n`SpooledArtifact.forgeTools(ctx)` and merges registries). So `instance.constructor.toolMethods`\nreturns the LEAF set only, and an earlier draft that took a descriptor array from the consumer\nadvertised a vocabulary including `artifact_head`/`_tail`/`_grep`/`_cat` that freeze would then\nhave refused on every JSON or Markdown artifact — a stated invariant the seam could not uphold.\nThere is no helper in core that unions the chain.\n\nSo the battery ships one, and it is the only place the union is computed —\n`effectiveToolMethods(ctor)`, declared below alongside `ArtifactClassLike`.\n\nIt collects each class's OWN `toolMethods` (`Object.getOwnPropertyDescriptor`, so an inherited\nstatic is not counted twice) from the leaf up through `Object.getPrototypeOf`, and dedupes by\n`name` with **nearest class wins** — matching the `Tool.onCollision = 'replace'` semantics core\nalready documents for the same overlap. WP 01 owns it; WP 04 (freeze) and WP 07 (the transform\nruntime) both call it, and it is exported so a consumer and the tests can assert the same set.\n\nThe consequence for the consumer is that they declare a class, not a list — which is the\ndeclaration they can actually get right, since `Tool.artifactConstructor` is exactly a\n`() => SpooledArtifact subclass` closure they already wrote.\n\nTwo consequences worth stating: freeze validates against a **declaration**, so a consumer whose\ndeclaration disagrees with the tool's actual return gets a node failure at run time (the\ntransform's own output validation catches it) rather than a silent wrong answer; and\n`{kind: 'text'}` needs no transform at all when the node declares a single field.\n\nBecause the vocabulary IS the registry rather than a list this battery maintains, a new\n`SpooledArtifact` subclass becomes usable in a `transform` the moment it exists, with no\norchestration change at all: a future `SpooledYamlArtifact` declaring\n`artifact_yaml_get`/`_keys` is immediately a legal `transform` source, its args validated by its\nown `argsSchema`, its docs generated from its own descriptors. The same holds for a consumer's\nprivate subclass — the battery never needs to know the format. This is the concrete reason to\nprefer the registry over a mapping DSL: a DSL would have to grow a YAML accessor; this does not.\n\n**This is what makes a handle useful in a plan.** A `call` returning a `SpooledArtifact` keeps\nits bytes out of the plan; a `transform` reads exactly the slice the next node needs and emits\nstructured `OutputItem`s. No **plan content** holds a reference to bytes — the instance lives in\nrun state and the artifact is consumed on the branch that produced it — so the no-media-handles\nrule survives intact in the sense that actually matters: nothing inside the approved digest\npoints at a store. See the content-vs-execution-state boundary stated with that rule.\n\n### How the transform actually RECEIVES the artifact — the `artifacts` channel\n\nThe methods a step names are real async instance methods reading through a `SpoolReader`\n(`SpooledJsonArtifact.json_get` calls `this.#resolveRecords()` against its reader), so they\ncannot be invoked on a plain value. `OutputItem.json` is `EncodableValue`-only by design and\n`NodeRef` resolution yields `item.json`, so **the dataflow path that carries values cannot\ncarry the instance.** An earlier draft specified the node's purpose without ever naming the\nchannel that feeds it, which left WP 07 an interface with no implementable input and made the\nresume note (\"its source artifact must still be resolvable\") a fallback assigned to a condition\nno mechanism could satisfy.\n\n**The mechanism already exists in core, and it is a HANDLE, not a side table.** A\n`SpooledArtifact` is itself encoder-round-trippable: `[ENCODE_METHOD]` emits\n`{reader: ReaderDescriptor}` — a `{tag, locator}` pointer, *never* the bytes\n(`spooled_artifact.ts:287-315`) — and `[DECODE_METHOD]` re-binds it through\n`resolveSpoolReader(descriptor)`, the registry whose resolver closure re-injects the live\nbinding (a flydrive `Disk`, an OPFS root, `fetch`) a locator cannot carry\n(`src/lib/contracts/reader_resolvers.ts`). Subclasses override the snapshot to add their own\ndiscriminator, so a decoded `SpooledJsonArtifact` comes back as a `SpooledJsonArtifact`.\n**This is verified in-repo, not inferred:** `tests/unit/encoding/round_trip.cross.spec.ts:190-198`\n— *\"SpooledArtifact round-trips as an in-memory handle and re-reads its bytes\"* — plus a\ndurable-reader case with a consumer-registered resolver at :261-278. The whole file is green\n(15/15).\n\nSo the channel is a second, **non-encodable-by-value but handle-encodable** table alongside\n`OutputTable`, keyed identically:\n\n`ArtifactTable` (declared in Shared contracts alongside `OutputTable`) —\n`ReadonlyMap`, keyed `${nodeId}:${branchKey(branchId)}`, the SAME\nkey as `OutputTable`, so a `transform`'s `source: NodeRef` addresses one without a second\naddressing scheme.\n\n* **Populated at `call` settlement.** When `CallInvokerFn` returns a `SpooledArtifactLike`, the\n executor records the *declared-output* `NodeOutput` in `OutputTable` as usual **and** the\n instance in `ArtifactTable` under the same key. A `call` whose result is a `string` puts\n nothing here.\n* **Carried on the frame.** `PendingFrame` gains `artifacts: ArtifactTable`, branch-local and\n cloned on fan-out exactly like `outputs`, and `edge_taken` carries it for the same reason it\n carries `outputs`: a successor must receive its own branch's accumulation.\n* **Persisted as HANDLES.** `PendingFrame.artifacts` and `edge_taken.artifacts` encode via each\n artifact's own `[ENCODE_METHOD]`, so the run log holds `{tag, locator}` pointers and never\n bytes — which is precisely the property the no-bytes-in-plan-state rule wanted, now achieved\n by the same mechanism core already uses rather than by refusing to persist anything.\n* **Resume rebinds through the resolver registry**, which is what makes the previously-unsatisfiable\n resume note true: a resumed `transform` decodes its source handle and gets a working instance\n **iff** a resolver for that `tag` is registered. Two honest consequences, both stated rather\n than papered over:\n · The **`registerSpoolReaderResolver` requirement is load-bearing for resume**, not\n optional hygiene. In-memory and fetch resolvers auto-register with the encoding battery;\n a durable store's resolver the consumer must register themselves, because only they hold\n the live binding (already a verified fact in this plan's table). A missing resolver throws\n `E_NO_READER_RESOLVER`, which the transform surfaces as an ordinary node failure naming\n the tag — the specified mechanism the earlier \"producing turn is gone\" note lacked.\n · An **in-memory reader's locator carries its own bytes base64-encoded** (per\n `ReaderDescriptor`'s own contract), so an in-memory artifact survives resume but counts\n against `PlanBounds.maxEncodedBytes` — the reason a durable spool store is the right\n choice for a plan whose calls produce large artifacts. Stated, not enforced: this is a\n deployment decision, not something the battery can pick.\n\n### What a step's result feeds the next step\n\nChaining passes the **raw method return value**, never a serialised form. `serialise` is\n`(result: unknown) => string`, so chaining through it would flatten exactly the structure a\nfollowing `emit: {as:'rows'}` needs as an array. Note this is not hypothetical laxity: **no\ndescriptor in any of the three core classes actually carries `serialise`** (verified: 7/7/8\ndescriptors, none), so an unstated rule would have been guessed differently by every\nimplementor.\n\n`serialise` is therefore consulted at exactly one point — converting a **final** result into a\nstring for an `emit: {as:'value'}` field whose `DeclaredField` type is `string` — and where the\ndescriptor supplies none, the battery calls core's **exported** `defaultSerialise`\n(`spooled_artifact.ts:129`, documented *\"Exported for reuse by subclass `forgeTools`\noverrides\"*) rather than reimplementing its rules (string as-is; `string[]` newline-joined with\n`'(empty list)'` when empty; `number` via `String`; `undefined` → `'(undefined)'`; otherwise\n`JSON.stringify(v, null, 2)`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `emit` | | { `as`: `\"value\"`; `field`: `string`; } | { `as`: `\"rows\"`; } | How the final result becomes items. `rows` expects an array and emits one item per element. | [src/batteries/orchestration/types.ts:607](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L607) |\n| `output` | [`DeclaredField`](../type-aliases/DeclaredField.md)\\[] | What downstream nodes may reference — validated against the emitted items, as for `call`. | [src/batteries/orchestration/types.ts:609](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L609) |\n| `source` | [`NodeRef`](../../encoding/classes/NodeRef.md) | Which node's output to read. Its declared artifact class determines the legal methods. | [src/batteries/orchestration/types.ts:599](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L599) |\n| `steps` | { `args?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](../type-aliases/EncodableValue.md)>; `name`: `string`; }\\[] | Applied in order; each step's result feeds the next. `name` is the DESCRIPTOR'S `name` — the absolute LLM-facing tool name (`artifact_json_get`), never the instance method name (`json_get`). Validated at freeze against `effectiveToolMethods(sourceClass)`. | [src/batteries/orchestration/types.ts:605](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L605) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArgValue","title":"Type Alias: ArgValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArgValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArgValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArgValue.md\ndescription: >-\n A staged argument: any encodable value, or a reference to another node's\n output.\n---\n\n# Type Alias: ArgValue\n\n```ts\ntype ArgValue =\n | EncodableValue\n | NodeRef\n | ArgValue[]\n | {\n [k: string]: ArgValue;\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L139)\n\nA staged argument: any encodable value, or a reference to another node's output.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArtifactTable","title":"Type Alias: ArtifactTable","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArtifactTable.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArtifactTable","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ArtifactTable.md\ndescription: >-\n Live artifact instances produced by `call` nodes, keyed **identically** to\n `OutputTable` (`${nodeId}:${branchKey(branchId)}`) so a `transform`'s `source:\n NodeRef` addresses one with no second addressing scheme. This is the channel a\n `transform` receives its instance through — see `TransformNodeDefinition`,\n which explains why the value dataflow cannot carry it.\n---\n\n# Type Alias: ArtifactTable\n\n```ts\ntype ArtifactTable = ReadonlyMap;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:265](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L265)\n\nLive artifact instances produced by `call` nodes, keyed **identically** to `OutputTable`\n(`${nodeId}:${branchKey(branchId)}`) so a `transform`'s `source: NodeRef` addresses one with no\nsecond addressing scheme. This is the channel a `transform` receives its instance through — see\n`TransformNodeDefinition`, which explains why the value dataflow cannot carry it.\n\nAn entry exists only where `CallInvokerFn` returned a `SpooledArtifactLike`; a `string`-returning\ncall contributes nothing. Persisted as encoder HANDLES (`{tag, locator}` via each artifact's own\n`[ENCODE_METHOD]`), never bytes, and rebound on resume through `resolveSpoolReader` — so\nregistering a durable store's reader resolver is load-bearing for resume, not optional hygiene.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/AuthorityVerb","title":"Type Alias: AuthorityVerb","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/AuthorityVerb.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/AuthorityVerb","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/AuthorityVerb.md\ndescription: >-\n The closed verb set. Closed so an authority set is comparable, not merely\n readable.\n---\n\n# Type Alias: AuthorityVerb\n\n```ts\ntype AuthorityVerb = \"list\" | \"read\" | \"create\" | \"update\" | \"delete\";\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1108)\n\nThe closed verb set. Closed so an authority set is comparable, not merely readable.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CallInvokerFn","title":"Type Alias: CallInvokerFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CallInvokerFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CallInvokerFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CallInvokerFn.md\ndescription: >-\n Returns the tool's result **in the shape the tool actually produced** — the\n same union an ADK `ToolHandler` returns (`src/lib/classes/tool.ts:57`). An\n earlier draft had this return `OutputItem[]`, which quietly obliged every\n consumer to invent a conversion the plan never specified: a tool returning a\n JSON-in-a-string, or a `SpooledArtifact` handle, has no obvious mapping to\n pathable fields, and three implementors would have chosen three.\n---\n\n# Type Alias: CallInvokerFn\n\n```ts\ntype CallInvokerFn = (req: {\n args: Record;\n signal?: AbortSignal;\n tool: string;\n}) => Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:925](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L925)\n\nReturns the tool's result **in the shape the tool actually produced** — the same union an ADK\n`ToolHandler` returns (`src/lib/classes/tool.ts:57`). An earlier draft had this return\n`OutputItem[]`, which quietly obliged every consumer to invent a conversion the plan never\nspecified: a tool returning a JSON-in-a-string, or a `SpooledArtifact` handle, has no obvious\nmapping to pathable fields, and three implementors would have chosen three.\n\nSo the invoker just invokes, and the conversion is explicit in the graph:\n· a `string` result the node declares as one field → available directly;\n· anything needing extraction (a JSON string, an artifact, a markdown document) → a\n`transform` node names the artifact method that extracts it.\n`Media`/`Uint8Array` results are refused at freeze for a node whose `output` declares fields —\nbytes are not pathable and the IR holds no media handles.\n\n## Parameters\n\n| Parameter | Type |\n| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `req` | { `args`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](EncodableValue.md)>; `signal?`: `AbortSignal`; `tool`: `string`; } |\n| `req.args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](EncodableValue.md)> |\n| `req.signal?` | `AbortSignal` |\n| `req.tool` | `string` |\n\n## Returns\n\n`Promise`<[`ToolResult`](ToolResult.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CreateOrchestration","title":"Type Alias: CreateOrchestration","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CreateOrchestration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CreateOrchestration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/CreateOrchestration.md\ndescription: >-\n THE battery's single entry point. Everything public is reached through the\n object it returns, so it is the one place a precondition can be enforced for\n every operation — which is why the encoder check lives here (see\n Serialization).\n---\n\n# Type Alias: CreateOrchestration\n\n```ts\ntype CreateOrchestration = (config: {\n deps?: Partial;\n invocable: InvocableTools;\n store: PlanStore;\n templates?: PlanTemplate[];\n}) => Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1192](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1192)\n\nTHE battery's single entry point. Everything public is reached through the object it returns, so\nit is the one place a precondition can be enforced for every operation — which is why the\nencoder check lives here (see Serialization).\n\nIt is `async` because it eagerly `await import('@nhtio/encoder')`, throwing\n`E_ORCH_ENCODER_REQUIRED` (naming the package and install command) before any plan can exist.\nIt also `await`s `load()` on every supplied evaluator cell, so a missing optional peer surfaces\nat construction rather than at freeze. A cell supplied per-run instead is loaded at that point,\nwith the same named error.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |\n| `config` | { `deps?`: [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`RunDeps`](../interfaces/RunDeps.md)>; `invocable`: [`InvocableTools`](../interfaces/InvocableTools.md); `store`: [`PlanStore`](../../interfaces/PlanStore.md); `templates?`: [`PlanTemplate`](../interfaces/PlanTemplate.md)\\[]; } | - |\n| `config.deps?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`RunDeps`](../interfaces/RunDeps.md)> | Defaults for every run. A run may override any field — see `RunOptions` for precedence. |\n| `config.invocable` | [`InvocableTools`](../interfaces/InvocableTools.md) | - |\n| `config.store` | [`PlanStore`](../../interfaces/PlanStore.md) | - |\n| `config.templates?` | [`PlanTemplate`](../interfaces/PlanTemplate.md)\\[] | Consumer-defined plan shapes a model can instantiate. Validated at construction. |\n\n## Returns\n\n`Promise`<[`Orchestration`](../interfaces/Orchestration.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/DeclaredField","title":"Type Alias: DeclaredField","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/DeclaredField.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/DeclaredField","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/DeclaredField.md\ndescription: >-\n One field a node promises to produce, or that an entry/template accepts.\n Declaring a field is what makes it addressable by a `NodeRef.path` and\n checkable at freeze rather than at run time.\n---\n\n# Type Alias: DeclaredField\n\n```ts\ntype DeclaredField =\n | {\n maxBytes?: number;\n path: string;\n type: \"string\";\n }\n | {\n path: string;\n type: \"number\";\n }\n | {\n path: string;\n type: \"boolean\";\n }\n | {\n path: string;\n type: \"enum\";\n values: string[];\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L318)\n\nOne field a node promises to produce, or that an entry/template accepts. Declaring a field is\nwhat makes it addressable by a `NodeRef.path` and checkable at freeze rather than at run time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EdgeHandle","title":"Type Alias: EdgeHandle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EdgeHandle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EdgeHandle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EdgeHandle.md\ndescription: 'An edge''s firing condition, drawn from the outcome of its source node.'\n---\n\n# Type Alias: EdgeHandle\n\n```ts\ntype EdgeHandle =\n | \"always\"\n | \"match\"\n | \"no_match\"\n | \"default\"\n | \"error\"\n | `case_${string}`;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:284](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L284)\n\nAn edge's firing condition, drawn from the outcome of its source node.\n\n## Remarks\n\nApplicability is by source kind and is enforced at freeze; any other pairing is refused:\n`entry` → `always`; `call`/`reason`/`transform` → `always` | `error`; `branch` → `match` |\n`no_match` | `default` | `error`; `select` → `case_${string}` | `default` | `error` (a\n`default` edge is REQUIRED); `join` → `always` | `error`.\n\nOn a node settling, EVERY edge whose handle applies fires, each exactly once — so `always` fires\nalongside `match`/`case_*` on success, and duplicates of one handle are legal fan-out. On a\nFAILURE outcome only `error` edges fire; `always` does NOT — an `always` edge is a success-path\nedge, not a finally. `default` fires only when no `match`/`case_*` matched.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EncodableValue","title":"Type Alias: EncodableValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EncodableValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EncodableValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/EncodableValue.md\ndescription: >-\n The value space of a staged argument and of a node's output: a DELIBERATE\n SUBSET of `@nhtio/encoder`'s `Encodable`, declared structurally here rather\n than re-exported.\n---\n\n# Type Alias: EncodableValue\n\n```ts\ntype EncodableValue =\n | string\n | number\n | boolean\n | null\n | undefined\n | bigint\n | Date\n | RegExp\n | DateTime\n | Duration\n | Interval\n | ArrayBuffer\n | DataView\n | Int8Array\n | Uint8Array\n | Uint8ClampedArray\n | Int16Array\n | Uint16Array\n | Int32Array\n | Uint32Array\n | Float32Array\n | Float64Array\n | BigInt64Array\n | BigUint64Array\n | EncodableValue[]\n | {\n [key: string]: EncodableValue;\n }\n | Map\n | Set;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L68)\n\nThe value space of a staged argument and of a node's output: a DELIBERATE SUBSET of\n`@nhtio/encoder`'s `Encodable`, declared structurally here rather than re-exported.\n\nWhy a subset. The encoder's own `Encodable`\n(`nhtio-encoder/src/private/types.ts:46-69`) also admits `Error` and its subclasses,\n`PhoneModel`, `Function`, arbitrary call signatures, and `CustomEncodable`. Re-exporting it\nwould (a) let a live function into a staged tool argument — the encoder serialises functions by\nSOURCE TEXT, so closures silently lose their bindings, and a plan is exactly the wrong place\nfor that; (b) admit consumer-defined `CustomEncodable` classes whose decode requires\n`registerClass` calls this battery cannot make on the consumer's behalf, so a plan could\nencode successfully and then fail hydration; and (c) undermine `predicate: EncodableValue`,\nwhich is meant to exclude live evaluator objects by domain.\n\nThe subset below is closed, digest-safe, and hydratable with only\n`registerOrchestrationEncodables()`:\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ExecutePlanFn","title":"Type Alias: ExecutePlanFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ExecutePlanFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ExecutePlanFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ExecutePlanFn.md\ndescription: >-\n Starts or resumes a run. Takes no entry argument — the entry node is unique by\n freeze invariant and its output is materialised from `RunOptions.input`.\n---\n\n# Type Alias: ExecutePlanFn\n\n```ts\ntype ExecutePlanFn = (\n planId: PlanId,\n options: RunOptions,\n) => Promise;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1056](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1056)\n\nStarts or resumes a run. Takes no entry argument — the entry node is unique by freeze invariant\nand its output is materialised from `RunOptions.input`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------- |\n| `planId` | [`PlanId`](PlanId.md) |\n| `options` | [`RunOptions`](../interfaces/RunOptions.md) |\n\n## Returns\n\n`Promise`<[`RunProjection`](../interfaces/RunProjection.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InstantiateResult","title":"Type Alias: InstantiateResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InstantiateResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InstantiateResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InstantiateResult.md\ndescription: >-\n The outcome of instantiating a template. Failure is a value, not a throw — a\n model reads it.\n---\n\n# Type Alias: InstantiateResult\n\n```ts\ntype InstantiateResult =\n | {\n issues: PlanIssue[];\n ok: true;\n planId: PlanId;\n }\n | {\n detail: string;\n ok: false;\n reason: \"unknown_template\" | \"invalid_args\";\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1264)\n\nThe outcome of instantiating a template. Failure is a value, not a throw — a model reads it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InterruptionCause","title":"Type Alias: InterruptionCause","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InterruptionCause.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InterruptionCause","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/InterruptionCause.md\ndescription: >-\n Why a run stopped short of completing. Closed, so a caller can handle every\n case it must.\n---\n\n# Type Alias: InterruptionCause\n\n```ts\ntype InterruptionCause =\n | {\n kind: \"turn_abort\";\n }\n | {\n kind: \"operator_stop\";\n }\n | {\n kind: \"gate_timeout\";\n }\n | {\n kind: \"process_death\";\n }\n | {\n kind: \"budget_exhausted\";\n settled: number;\n }\n | {\n detail: string;\n kind: \"deviation_abort\";\n }\n | {\n handled: false;\n kind: \"node_failed\";\n nodeId: NodeId;\n }\n | {\n kind: \"predicate_unevaluatable\";\n nodeId: NodeId;\n }\n | {\n kind: \"join_unsatisfiable\";\n nodeId: NodeId;\n }\n | {\n kind: \"output_schema_violation\";\n nodeId: NodeId;\n }\n | {\n claim: AuthorityClaim;\n kind: \"authority_revoked\";\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1558](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1558)\n\nWhy a run stopped short of completing. Closed, so a caller can handle every case it must.\n\n## Union Members\n\n### Type Literal\n\n```ts\n{\n kind: \"turn_abort\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"operator_stop\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"gate_timeout\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"process_death\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"budget_exhausted\";\n settled: number;\n}\n```\n\nThe run hit `maxSteps` — its own declared settlement budget — and stopped.\n\n***\n\n### Type Literal\n\n```ts\n{\n detail: string;\n kind: \"deviation_abort\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n handled: false;\n kind: \"node_failed\";\n nodeId: NodeId;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"predicate_unevaluatable\";\n nodeId: NodeId;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"join_unsatisfiable\";\n nodeId: NodeId;\n}\n```\n\nA join can no longer be satisfied: no live frame can still reach it.\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"output_schema_violation\";\n nodeId: NodeId;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n claim: AuthorityClaim;\n kind: \"authority_revoked\";\n}\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeId","title":"Type Alias: NodeId","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeId.md\ndescription: >-\n A node's identity within one plan. Validated snake_case with no `/` and no\n leading `.`, so it can never be mistaken for a path or copied as a citation.\n---\n\n# Type Alias: NodeId\n\n```ts\ntype NodeId = string;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L48)\n\nA node's identity within one plan. Validated snake\\_case with no `/` and no leading `.`, so it can\nnever be mistaken for a path or copied as a citation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeOutcome","title":"Type Alias: NodeOutcome","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeOutcome.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeOutcome","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/NodeOutcome.md\ndescription: >-\n How one frame settled. The three cases are exhaustive — a frame that has not\n settled has none.\n---\n\n# Type Alias: NodeOutcome\n\n```ts\ntype NodeOutcome =\n | {\n output: NodeOutput;\n status: \"ok\";\n }\n | {\n error: {\n message: string;\n name: string;\n };\n handled: boolean;\n status: \"failed\";\n }\n | {\n reason: \"indeterminate_skip\";\n status: \"skipped\";\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:755](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L755)\n\nHow one frame settled. The three cases are exhaustive — a frame that has not settled has none.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/OutputTable","title":"Type Alias: OutputTable","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/OutputTable.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/OutputTable","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/OutputTable.md\ndescription: >-\n Append-only, keyed `${nodeId}:${branchKey(branchId)}` — path-unique, which is\n what makes a NodeRef resolve. Always build the key with `branchKey`, never by\n interpolating the object.\n---\n\n# Type Alias: OutputTable\n\n```ts\ntype OutputTable = ReadonlyMap;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:252](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L252)\n\nAppend-only, keyed `${nodeId}:${branchKey(branchId)}` — path-unique, which is what makes a\nNodeRef resolve. Always build the key with `branchKey`, never by interpolating the object.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanId","title":"Type Alias: PlanId","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanId.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanId","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanId.md\ndescription: 'A plan''s stable identity, unique per store and never reused across a clone.'\n---\n\n# Type Alias: PlanId\n\n```ts\ntype PlanId = string;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L43)\n\nA plan's stable identity, unique per store and never reused across a clone.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNode","title":"Type Alias: PlanNode","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNode.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNode","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNode.md\ndescription: 'A node: its identity and phase, plus exactly one kind-specific definition.'\n---\n\n# Type Alias: PlanNode\n\n```ts\ntype PlanNode = PlanNodeBase &\n | {\n definition: EntryNodeDefinition;\n kind: \"entry\";\n}\n | {\n definition: CallNodeDefinition;\n kind: \"call\";\n}\n | {\n definition: ReasonNodeDefinition;\n kind: \"reason\";\n}\n | {\n definition: TransformNodeDefinition;\n kind: \"transform\";\n}\n | {\n definition: BranchNodeDefinition;\n kind: \"branch\";\n}\n | {\n definition: SelectNodeDefinition;\n kind: \"select\";\n}\n | {\n definition: JoinNodeDefinition;\n kind: \"join\";\n};\n```\n\nDefined in: [src/batteries/orchestration/types.ts:701](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L701)\n\nA node: its identity and phase, plus exactly one kind-specific definition.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNodeKind","title":"Type Alias: PlanNodeKind","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNodeKind.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNodeKind","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanNodeKind.md\ndescription: >-\n The closed set of node kinds. Each has its own definition type, and freeze\n validates per kind.\n---\n\n# Type Alias: PlanNodeKind\n\n```ts\ntype PlanNodeKind =\n | \"entry\"\n | \"call\"\n | \"reason\"\n | \"transform\"\n | \"branch\"\n | \"select\"\n | \"join\";\n```\n\nDefined in: [src/batteries/orchestration/types.ts:269](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L269)\n\nThe closed set of node kinds. Each has its own definition type, and freeze validates per kind.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanOp","title":"Type Alias: PlanOp","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanOp.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanOp","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanOp.md\ndescription: >-\n One authoring edit. Every op carries actor and lamport identity, and the fold\n is deterministic over any arrival order — so two offline authors' logs\n converge when they meet.\n---\n\n# Type Alias: PlanOp\n\n```ts\ntype PlanOp = OpBase &\n | {\n node: PlanNode;\n op: \"add_node\";\n}\n | {\n incidentEdgeIds: string[];\n nodeId: NodeId;\n op: \"remove_node\";\n}\n | {\n nodeId: NodeId;\n op: \"set_node_field\";\n path: string;\n value: ArgValue;\n}\n | {\n definition: PlanNode[\"definition\"];\n nodeId: NodeId;\n op: \"set_node_definition\";\n}\n | {\n nodeId: NodeId;\n op: \"set_node_phase\";\n phase: string | null;\n}\n | {\n edge: PlanEdge;\n op: \"add_edge\";\n}\n | {\n edgeId: string;\n op: \"remove_edge\";\n}\n | {\n bounds: PlanBounds;\n op: \"set_bounds\";\n};\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1122)\n\nOne authoring edit. Every op carries actor and lamport identity, and the fold is deterministic\nover any arrival order — so two offline authors' logs converge when they meet.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanProvenance","title":"Type Alias: PlanProvenance","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanProvenance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanProvenance","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanProvenance.md\ndescription: >-\n A clone's lineage. `completedAtClone` is the part that is not derivable later:\n the renderer must warn that \"the parent already completed X, Y, Z, and\n approving this repeats them\", and the parent's id/digest/revision identify\n CONTENT, not execution — a plan at that revision may never have run, may be\n halted, or may have completed a subset. So `clonePlan` snapshots the parent's\n completed node ids at clone time, which also makes the warning stable if the\n parent's run is later re-read or the parent is archived.\n---\n\n# Type Alias: PlanProvenance\n\n```ts\ntype PlanProvenance =\n | ({\n kind: \"clone\";\n } & ClonedFrom)\n | ({\n kind: \"template\";\n } & InstantiatedFrom);\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1400](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1400)\n\nA clone's lineage. `completedAtClone` is the part that is not derivable later: the renderer must\nwarn that \"the parent already completed X, Y, Z, and approving this repeats them\", and the\nparent's id/digest/revision identify CONTENT, not execution — a plan at that revision may never\nhave run, may be halted, or may have completed a subset. So `clonePlan` snapshots the parent's\ncompleted node ids at clone time, which also makes the warning stable if the parent's run is\nlater re-read or the parent is archived.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanState","title":"Type Alias: PlanState","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanState.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanState","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PlanState.md\ndescription: 'The three lifecycle states, in the only order they may be traversed.'\n---\n\n# Type Alias: PlanState\n\n```ts\ntype PlanState = \"editable\" | \"reviewable\" | \"executable\";\n```\n\nDefined in: [src/batteries/orchestration/types.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L41)\n\nThe three lifecycle states, in the only order they may be traversed.\n\n## Remarks\n\nThe permission gate IS the `reviewable → executable` transition, which is what makes \"approved\"\nand \"executable\" one fact rather than two that can disagree. `editable` admits free mutation;\n`reviewable` is frozen content awaiting a decision; `executable` is approved and may run at most\nonce. There is no path back — recovery from a spent or rejected plan is `clonePlan`, which mints\na fresh `editable` plan.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PredicateVerdict","title":"Type Alias: PredicateVerdict","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PredicateVerdict.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PredicateVerdict","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PredicateVerdict.md\ndescription: 'A cell''s decision, in the shape the node kind that asked for it expects.'\n---\n\n# Type Alias: PredicateVerdict\n\n```ts\ntype PredicateVerdict =\n | {\n kind: \"branch\";\n matched: boolean;\n }\n | {\n caseLabel: string | null;\n kind: \"select\";\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1091](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1091)\n\nA cell's decision, in the shape the node kind that asked for it expects.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PromptPart","title":"Type Alias: PromptPart","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PromptPart.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PromptPart","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/PromptPart.md\ndescription: >-\n A prompt is a SEQUENCE of literal text and references — never a string with an\n embedded DSL.\n---\n\n# Type Alias: PromptPart\n\n```ts\ntype PromptPart =\n | {\n text: string;\n }\n | NodeRef;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:399](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L399)\n\nA prompt is a SEQUENCE of literal text and references — never a string with an embedded DSL.\n\n## Remarks\n\nSame reasoning as `ArgValue`: this repo represents references structurally so they are checkable\nat freeze and need no parser. The battery joins the parts, substituting each ref's resolved\nvalue, immediately before calling `ReasonerFn`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ReasonerFn","title":"Type Alias: ReasonerFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ReasonerFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ReasonerFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ReasonerFn.md\ndescription: >-\n The `reason` node's dispatcher. See ReasonNodeDefinition: it terminates in a\n tool call.\n---\n\n# Type Alias: ReasonerFn\n\n```ts\ntype ReasonerFn = (req: {\n maxAttempts: number;\n outputSchema: Schema;\n prompt: string;\n signal?: AbortSignal;\n}) => Promise>;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1059](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1059)\n\nThe `reason` node's dispatcher. See ReasonNodeDefinition: it terminates in a tool call.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------ | ------------------------------------------------------------------------------------------------------ |\n| `req` | { `maxAttempts`: `number`; `outputSchema`: `Schema`; `prompt`: `string`; `signal?`: `AbortSignal`; } |\n| `req.maxAttempts` | `number` |\n| `req.outputSchema` | `Schema` |\n| `req.prompt` | `string` |\n| `req.signal?` | `AbortSignal` |\n\n## Returns\n\n`Promise`<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`EncodableValue`](EncodableValue.md)>>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RouteSegment","title":"Type Alias: RouteSegment","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RouteSegment.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RouteSegment","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RouteSegment.md\ndescription: >-\n A PATH identity — the route from `entry` to a frame, kept as the ROUTE ITSELF,\n not a hash of it, so ancestry questions are answered by reading the value. (An\n earlier draft hashed it and then tried to correlate joins by \"longest common\n prefix of the ids\", which computes nothing: a hash has no prefix relation to\n what it hashes.)\n---\n\n# Type Alias: RouteSegment\n\n```ts\ntype RouteSegment =\n | {\n edge: string;\n }\n | {\n join: NodeId;\n of: string[];\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L221)\n\nA PATH identity — the route from `entry` to a frame, kept as the ROUTE ITSELF, not a hash of it,\nso ancestry questions are answered by reading the value. (An earlier draft hashed it and then\ntried to correlate joins by \"longest common prefix of the ids\", which computes nothing: a hash\nhas no prefix relation to what it hashes.)\n\nA route is a list of SEGMENTS. A segment is either one traversed edge, or a join — which is what\nmakes the structure total: a join has no single parent route, but a node *after* a join still\nneeds a route relative to something. An earlier draft gave a join `{edges: [], joinOf}`, which\nreset the route to empty and made every post-join frame's `edges` relative to nothing, so two\ndifferent post-join paths collided.\n\n* **Entry frame:** `{ segments: [] }`.\n* **Produced by an edge:** parent's `segments` + `{ edge: edgeId }`.\n* **Produced by a JOIN:** the **correlation prefix** (the arriving route truncated at the fork —\n the same prefix `JoinState.correlationKey` is built from) + `{ join: nodeId, of: sorted(ALL\n incoming edge ids) }`. Subsequent edges then extend it normally.\n\n Retaining that prefix is load-bearing: `of` is a graph constant, so a join segment ALONE is\n the same value for every execution of the join. If the route were reset to just that segment,\n two executions of the fork reached by different outer routes would produce identical merged\n identities and collide in `OutputTable` — even though their barriers correctly stayed\n separate. The prefix is exactly the coordinate that distinguishes them, and it is already\n computed for correlation, so nothing new is needed.\n\n`branchKey` is the canonical string form used for map keys and in events. It MUST be injective,\nbecause it keys `OutputTable`, identifies `NodeRef.branchId`, orders join contributors, and makes\nduplicate arrivals idempotent — a collision would overwrite one node's output with another's or\nmerge unrelated barriers. Naive delimiter-joining is NOT injective: an edge id containing the\ndelimiter (`a>b`) collides with two segments (`a`, `b`), and an id shaped like `join:x(y)`\ncollides with a join segment.\n\nTwo mutually-reinforcing measures, both required:\n\n1. **Freeze validates edge ids** against `/^[A-Za-z0-9_-]{1,64}$/` — no delimiter, no colon, no\n parenthesis, so the grammar below cannot be forged. Node ids already carry an equivalent\n charset rule (see the re-cite-loop guard), and edge ids are minted by the same authoring\n tools, so this costs authors nothing.\n2. **The rendering is length-prefixed**, not delimiter-joined: each segment renders as\n `` `e${id.length}:${id}` `` or `` `j${nodeId.length}:${nodeId}(${of.map(len-prefix).join('')})` ``,\n concatenated with no separator. Length-prefixing is injective regardless of content, so the\n charset rule is defence in depth rather than the sole guarantee.\n\nBounded by the acyclicity invariant plus `PlanBounds.maxNodes` — a route cannot revisit a node,\nso it cannot exceed the node count.\n\nWhy no run coordinate: a plan has at most one run ever (decision 10) and the graph is acyclic,\nso a node executes exactly once per route reaching it. And why not an edge ordinal: given\n`entry→a`, `entry→b`, `a→c`, `b→c`, both incoming edges of `c` are ordinal 0 among their own\nsource's outgoing edges, so two distinct frames would collide.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RunEvent","title":"Type Alias: RunEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RunEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RunEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/RunEvent.md\ndescription: >-\n The persisted wire contract. `foldRun` derives an entire `RunProjection` from\n a list of these with no graph, no store and no side channel, which is what\n makes resume a pure function of the log rather than of surviving process\n state.\n---\n\n# Type Alias: RunEvent\n\n```ts\ntype RunEvent =\n | {\n at: string;\n digest: string;\n kind: \"run_started\";\n runId: string;\n }\n | {\n at: string;\n frame: FrameRef;\n kind: \"node_entered\";\n }\n | {\n at: string;\n frame: FrameRef;\n kind: \"node_settled\";\n outcome: NodeOutcome;\n }\n | {\n artifacts: ArtifactTable;\n at: string;\n edgeId: string;\n evidence?: EncodableValue;\n from: FrameRef;\n handle: EdgeHandle;\n kind: \"edge_taken\";\n outputs: OutputTable;\n to: FrameRef;\n }\n | {\n at: string;\n frames: PendingFrame[];\n joins: JoinState[];\n kind: \"frontier_snapshot\";\n }\n | {\n at: string;\n cause: InterruptionCause;\n frame?: FrameRef;\n kind: \"run_interrupted\";\n }\n | {\n at: string;\n kind: \"run_settled\";\n outcome: \"completed\" | \"halted\" | \"aborted\";\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:782](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L782)\n\nThe persisted wire contract. `foldRun` derives an entire `RunProjection` from a list of these\nwith no graph, no store and no side channel, which is what makes resume a pure function of the\nlog rather than of surviving process state.\n\n## Union Members\n\n### Type Literal\n\n```ts\n{\n at: string;\n digest: string;\n kind: \"run_started\";\n runId: string;\n}\n```\n\nCarries `runId` so `foldRun` can produce it from events alone, with no side channel.\n\n***\n\n### Type Literal\n\n```ts\n{\n at: string;\n frame: FrameRef;\n kind: \"node_entered\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n at: string;\n frame: FrameRef;\n kind: \"node_settled\";\n outcome: NodeOutcome;\n}\n```\n\nCarries the OUTPUT, not merely a status — this is what the resume fold rebuilds from.\n\n***\n\n### Type Literal\n\n```ts\n{\n artifacts: ArtifactTable;\n at: string;\n edgeId: string;\n evidence?: EncodableValue;\n from: FrameRef;\n handle: EdgeHandle;\n kind: \"edge_taken\";\n outputs: OutputTable;\n to: FrameRef;\n}\n```\n\nCarries the frame it PRODUCED **and that frame's branch-local `outputs`**, so the fold can\nrebuild a complete `PendingFrame` without the graph. Carrying only `from`/`to` was not enough:\na `PendingFrame` needs the accumulated branch-local table, and the global outputs fold cannot\nsupply it — a successor must receive precisely its own branch's accumulation, not every output\nrecorded run-wide, which after a fan-out or a join are different things.\n\nSize note, since this duplicates state: the table holds `NodeOutput` values already present\nin earlier `node_settled` events, so an implementation may persist it as the list of\n`${nodeId}:${branchKey}` keys and rehydrate the values from those settlements. The contract is\nthe *content*; the encoding is the store's business.\n\n***\n\n### Type Literal\n\n```ts\n{\n at: string;\n frames: PendingFrame[];\n joins: JoinState[];\n kind: \"frontier_snapshot\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n at: string;\n cause: InterruptionCause;\n frame?: FrameRef;\n kind: \"run_interrupted\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n at: string;\n kind: \"run_settled\";\n outcome: \"completed\" | \"halted\" | \"aborted\";\n}\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateArgValue","title":"Type Alias: TemplateArgValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateArgValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateArgValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateArgValue.md\ndescription: A plan node whose staged values may additionally contain template holes.\n---\n\n# Type Alias: TemplateArgValue\n\n```ts\ntype TemplateArgValue =\n | ArgValue\n | ParamRef\n | TemplateArgValue[]\n | {\n [k: string]: TemplateArgValue;\n };\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1234](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1234)\n\nA plan node whose staged values may additionally contain template holes.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateDefinitionOf","title":"Type Alias: TemplateDefinitionOf\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateDefinitionOf.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateDefinitionOf","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateDefinitionOf.md\ndescription: >-\n Structurally identical to the node definitions, with `ArgValue` widened to\n `TemplateArgValue`.\n---\n\n# Type Alias: TemplateDefinitionOf\\\n\n```ts\ntype TemplateDefinitionOf = {\n [K in keyof D]: D[K] extends ArgValue\n ? TemplateArgValue\n : D[K] extends Record\n ? Record\n : D[K] extends PromptPart[]\n ? ({ text: string } | NodeRef | ParamRef)[]\n : D[K];\n};\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1244](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1244)\n\nStructurally identical to the node definitions, with `ArgValue` widened to `TemplateArgValue`.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `D` |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateNode","title":"Type Alias: TemplateNode","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateNode.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateNode","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/TemplateNode.md\ndescription: A `PlanNode` whose definition may additionally contain template holes.\n---\n\n# Type Alias: TemplateNode\n\n```ts\ntype TemplateNode = Omit & {\n definition: TemplateDefinitionOf;\n};\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1240](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1240)\n\nA `PlanNode` whose definition may additionally contain template holes.\n\n## Type Declaration\n\n| Name | Type | Defined in |\n| ------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `definition` | [`TemplateDefinitionOf`](TemplateDefinitionOf.md)<[`PlanNode`](PlanNode.md)\\[`\"definition\"`]> | [src/batteries/orchestration/types.ts:1241](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1241) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ToolResult","title":"Type Alias: ToolResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ToolResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ToolResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/type-aliases/ToolResult.md\ndescription: >-\n Exactly what an ADK tool handler may return. The battery narrows it, never\n guesses at it.\n---\n\n# Type Alias: ToolResult\n\n```ts\ntype ToolResult =\n | string\n | Uint8Array\n | SpooledArtifactLike\n | MediaLike\n | MediaLike[];\n```\n\nDefined in: [src/batteries/orchestration/types.ts:932](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L932)\n\nExactly what an ADK tool handler may return. The battery narrows it, never guesses at it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/variables/DEFAULT_PLAN_BOUNDS","title":"Variable: DEFAULT\\_PLAN\\_BOUNDS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/variables/DEFAULT_PLAN_BOUNDS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/types/variables/DEFAULT_PLAN_BOUNDS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/variables/DEFAULT_PLAN_BOUNDS.md\ndescription: >-\n The canonical initial bounds — the **fold's seed**, not an op. `foldOps`\n starts from these, so a plan at revision 0 (an empty log) has a complete\n `RawPlanView` and a well-defined digest, and `set_bounds` ops override it\n thereafter. Without a fixed seed each implementor would invent a default or\n leave bounds absent, and since bounds are plan CONTENT that would give the\n same logical plan different digests across stores — breaking approval binding\n and store conformance. Every member stays required, so an override is total\n and cannot half-specify.\n---\n\n# Variable: DEFAULT\\_PLAN\\_BOUNDS\n\n```ts\nconst DEFAULT_PLAN_BOUNDS: PlanBounds;\n```\n\nDefined in: [src/batteries/orchestration/types.ts:1166](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/types.ts#L1166)\n\nThe canonical initial bounds — the **fold's seed**, not an op. `foldOps` starts from these, so a\nplan at revision 0 (an empty log) has a complete `RawPlanView` and a well-defined digest, and\n`set_bounds` ops override it thereafter. Without a fixed seed each implementor would invent a\ndefault or leave bounds absent, and since bounds are plan CONTENT that would give the same\nlogical plan different digests across stores — breaking approval binding and store conformance.\nEvery member stays required, so an override is total and cannot half-specify.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation","title":"@nhtio/adk/batteries/orchestration/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/validation.md'\ndescription: Submit-time validation and the lifecycle machine.\n---\n\n# @nhtio/adk/batteries/orchestration/validation\n\nSubmit-time validation and the lifecycle machine.\n\n## Remarks\n\nThis module owns the freeze gate: it folds a plan's op log into a `RawPlanView`, runs every\nsubmit check over that folded graph, and — only on a clean pass — commits the\n`editable → reviewable` transition. It is the \"the battery validates, the store commits\" split\nmade concrete: every check here is battery policy a bring-your-own store has no business\nreimplementing, and the store's `transition` is the only boundary that can atomically move the\nlifecycle state.\n\nThe two exported functions are the whole surface:\n\n* [collectIssues](functions/collectIssues.md) — the pure-ish validator. Given a folded view and the injected\n `FreezeInputs` (the tier-C allowlist and the wired predicate cells), it returns every\n `PlanIssue` the graph raises. It never throws on a well-typed-but-invalid plan; a malformed\n definition surfaces as an issue, not a crash.\n* [freezePlan](functions/freezePlan.md) — the lifecycle entry point. It folds the log, runs [collectIssues](functions/collectIssues.md),\n and only when no issue is `blocking` calls `store.transition(editable → reviewable,\n {expectedDigest})`. The digest is what makes the commit safe rather than racy: content is\n validated at digest D and the store commits only if the plan is still at D, so a concurrent\n edit invalidates the transition instead of slipping past an already-passed check.\n\nEvery refusal is a `PlanIssue` with a stable `code`, a model-addressed `message` naming the fix,\nthe `nodeId`/`edgeId` where applicable, and a `severity`. Blocking issues refuse the freeze;\nadvisory issues are surfaced for the author but do not stop the transition.\n\nThe checks are grouped into three families, each documented at its call site:\ntopology (entry, reachability, acyclicity, the diamond-join rule, id and handle rules),\nreferences and dataflow (dangling refs, undeclared fields, join-crossing selections, ambiguous\nreferences, taint), and per-node shape (call, transform, branch/select, encodability, scaffold\nplaceholders, unreachable calls).\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| [collectIssues](functions/collectIssues.md) | Run every submit check over a folded plan view. |\n| [freezePlan](functions/freezePlan.md) | Freeze a plan: fold the log, validate, and commit the `editable → reviewable` transition. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation/functions/collectIssues","title":"Function: collectIssues()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation/functions/collectIssues.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation/functions/collectIssues","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/validation/functions/collectIssues.md\n---\n\n# Function: collectIssues()\n\n```ts\nfunction collectIssues(\n view: RawPlanView,\n inputs: FreezeInputs,\n): Promise;\n```\n\nDefined in: [src/batteries/orchestration/validation.ts:465](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/validation.ts#L465)\n\nRun every submit check over a folded plan view.\n\nThe checks are grouped into three families:\n\n**Topology** — exactly one `entry` with no incoming edges; every other node reachable from it;\nacyclicity over every handle (a diamond fan-in is not a cycle); every `join` a diamond (its fork\nis its immediate dominator, more than one fork→join route, no reconvergence, no nested join);\nedge ids valid and unique; node ids valid; handle applicability per source kind; a `select`\nmust carry a `default` edge.\n\n**References and dataflow** — a `NodeRef` naming a missing node or an undeclared field; a\n`first`/`last` selection resolved across a `join`; an omitted `branchId` where more than one path\nreaches the referenced node; taint (a tainted reference may reach a `reason` prompt but not a\n`call` node's args, with declassification only via a `call` node's `declassifies`); staged\nvalues outside the encodable subset and cyclic values inside it.\n\n**Per-node shape** — a `call` naming a tool outside the allowlist, with `replaySafe`/\n`onIndeterminate` unset, or the retry-unsafe-repeat contradiction; a `branch`/`select` with no\nwired evaluator cell (and `load()`/`validate()` on every wired cell); a `transform` naming a\nstep absent from the source class's effective method set, with args failing the descriptor's\nschema, or whose source tool's return class is undeclared; a `Media`/`Uint8Array`-returning tool\nfeeding a field-declaring node; an unedited scaffold placeholder; an unreachable `call` node.\n\nThis function never throws on a well-typed-but-invalid plan. A malformed definition surfaces as\nan issue rather than a crash, and every evaluator interaction is wrapped so a failing cell\nreports an issue instead of propagating.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------- | -------------------------------------------------------- |\n| `view` | [`RawPlanView`](../../types/interfaces/RawPlanView.md) | The folded plan content to validate. |\n| `inputs` | [`FreezeInputs`](../../types/interfaces/FreezeInputs.md) | The injected tier-C allowlist and wired predicate cells. |\n\n## Returns\n\n`Promise`<[`PlanIssue`](../../types/interfaces/PlanIssue.md)\\[]>\n\nEvery issue the graph raises, blocking and advisory.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation/functions/freezePlan","title":"Function: freezePlan()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation/functions/freezePlan.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/validation/functions/freezePlan","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/validation/functions/freezePlan.md\n---\n\n# Function: freezePlan()\n\n```ts\nfunction freezePlan(\n store: PlanStore,\n planId: string,\n inputs: FreezeInputs,\n): Promise<{\n issues: PlanIssue[];\n ok: boolean;\n}>;\n```\n\nDefined in: [src/batteries/orchestration/validation.ts:962](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/validation.ts#L962)\n\nFreeze a plan: fold the log, validate, and commit the `editable → reviewable` transition.\n\nThe op log is folded into a `RawPlanView`, the fold's own issues are carried over (minus the\nfold's advisory `duplicate_edge_id`, which [collectIssues](collectIssues.md) reports as a blocking check),\nand [collectIssues](collectIssues.md) runs over the folded graph. Only when no issue is `blocking` is the\nstore's `transition` called, passing the folded digest as `expectedDigest`.\n\nThe digest is what makes the commit safe rather than racy: content is validated at digest D and\nthe store commits only if the plan is still at D, so a concurrent edit invalidates the\ntransition instead of slipping past an already-passed check. If the transition is rejected\n(the digest moved or the state is not `editable`), a `transition_rejected` blocking issue is\nappended and the freeze reports failure.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------------------------------------------------------- | -------------------------------------------------------------- |\n| `store` | [`PlanStore`](../../interfaces/PlanStore.md) | The plan store holding the plan. |\n| `planId` | `string` | Identity of the plan to freeze. |\n| `inputs` | [`FreezeInputs`](../../types/interfaces/FreezeInputs.md) | The fully-resolved tier-C allowlist and wired predicate cells. |\n\n## Returns\n\n`Promise`<{\n`issues`: [`PlanIssue`](../../types/interfaces/PlanIssue.md)\\[];\n`ok`: `boolean`;\n}>\n\nWhether the freeze succeeded, and every issue the plan raised.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/createOrchestration","title":"Variable: createOrchestration","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/createOrchestration.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/createOrchestration","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/variables/createOrchestration.md\ndescription: >-\n THE battery's single entry point. Everything public is reached through the\n [`Orchestration`](https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/types/interfaces/Orchestration) object it returns, so it is the one place a precondition\n can be enforced for every operation.\n---\n\n# Variable: createOrchestration\n\n```ts\nconst createOrchestration: CreateOrchestration;\n```\n\nDefined in: [src/batteries/orchestration/index.ts:388](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/index.ts#L388)\n\nTHE battery's single entry point. Everything public is reached through the\n[Orchestration](../types/interfaces/Orchestration.md) object it returns, so it is the one place a precondition can be enforced\nfor every operation.\n\nConstruction is async because it eagerly resolves the `@nhtio/encoder` optional peer (throwing\n[E\\_ORCH\\_ENCODER\\_REQUIRED](E_ORCH_ENCODER_REQUIRED.md) if absent), registers the orchestration encodables once, loads\nevery configured evaluator cell (so a missing optional peer surfaces here rather than at\nfreeze), and validates every registered template (so a misconfigured deployment fails at boot\nwith a named error rather than at first instantiation).\n\n**You do not need to call `registerOrchestrationEncodables()` yourself if you construct through\nthis function** — it runs here, before any plan can exist, so `decode()` can rebuild `NodeRef`\nand `ParamRef` from that moment on. Call it directly only when you reach the deep subpaths\nWITHOUT constructing an `Orchestration`: decoding a persisted plan in a worker that never builds\none, for instance. It is idempotent, so calling it anyway is harmless.\n\nSee the module doc for the full rationale and the dependency-precedence rules.\n\n## Param\n\n**config**\n\nThe store, tier-C allowlist, optional run-dependency defaults, and optional\nconsumer-defined plan templates.\n\n## Returns\n\nThe assembled [Orchestration](../types/interfaces/Orchestration.md) surface.\n\n## Throws\n\nif `@nhtio/encoder` is not installed.\n\n## Throws\n\nif a configured evaluator cell's optional peer is missing.\n\n## Throws\n\nif a registered template has a blocking validation issue.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_CELL_UNAVAILABLE","title":"Variable: E\\_ORCH\\_CELL\\_UNAVAILABLE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_CELL_UNAVAILABLE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_CELL_UNAVAILABLE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_CELL_UNAVAILABLE.md\ndescription: An orchestration cell is unavailable.\n---\n\n# Variable: E\\_ORCH\\_CELL\\_UNAVAILABLE\n\n```ts\nconst E_ORCH_CELL_UNAVAILABLE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/orchestration/exceptions.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/exceptions.ts#L12)\n\nAn orchestration cell is unavailable.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_ENCODER_REQUIRED","title":"Variable: E\\_ORCH\\_ENCODER\\_REQUIRED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_ENCODER_REQUIRED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_ENCODER_REQUIRED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/variables/E_ORCH_ENCODER_REQUIRED.md\ndescription: A required orchestration encoder is not configured.\n---\n\n# Variable: E\\_ORCH\\_ENCODER\\_REQUIRED\n\n```ts\nconst E_ORCH_ENCODER_REQUIRED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/orchestration/exceptions.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/orchestration/exceptions.ts#L4)\n\nA required orchestration encoder is not configured.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox","title":"@nhtio/adk/batteries/sandbox","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox.md'\n---\n\n# @nhtio/adk/batteries/sandbox\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------------------- | ------------------------------------------------------------------- |\n| [DefaultArtifactMinter](classes/DefaultArtifactMinter.md) | A pure minter with optional, lazily loaded consumer formats. |\n| [SandboxEpoch](classes/SandboxEpoch.md) | Opaque epoch issued by the sandbox manager and consumed by readers. |\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |\n| [ArtifactMinter](interfaces/ArtifactMinter.md) | Artifact-class registry. Format constructors are lazy so unused parsers are never loaded. |\n| [BinarySandbox](interfaces/BinarySandbox.md) | Command wrapping contract used by the executor adapter. |\n| [ConformanceMutations](interfaces/ConformanceMutations.md) | Optional mutation fixture for adapters that expose filesystem mutators. |\n| [ConformanceSources](interfaces/ConformanceSources.md) | The adapter surfaces the shared conformance battery exercises. |\n| [CreateSandboxOptions](interfaces/CreateSandboxOptions.md) | Options for [createSandbox](functions/createSandbox.md). |\n| [DerivedRules](interfaces/DerivedRules.md) | Backend-derived rules used for admission and drift checks, not a model-facing policy. |\n| [EvaluateJavascriptConfig](interfaces/EvaluateJavascriptConfig.md) | Configuration for the JavaScript guest battery. |\n| [GuestGlobal](interfaces/GuestGlobal.md) | A declared capability kept in the host runner. |\n| [GuestHandle](interfaces/GuestHandle.md) | A guest evaluation handle; timeout kills and rejects rather than fabricating a result. |\n| [GuestLimits](interfaces/GuestLimits.md) | Limits for a hostile guest: exactly seven fields, resolved before spawning and passed to both realms. |\n| [GuestRuntime](interfaces/GuestRuntime.md) | Runtime boundary for a hardened guest realm; limits and capability declarations cross the boundary. |\n| [GuestRuntimeLike](interfaces/GuestRuntimeLike.md) | Minimal runtime seam used by the tool and by browser/Node adapters. |\n| [HostcallQuotas](interfaces/HostcallQuotas.md) | Per-evaluation host RPC quotas, separate from the seven guest limits. |\n| [PathTranslator](interfaces/PathTranslator.md) | Model-path boundary: normalises ergonomic paths while refusing unambiguous host escapes. |\n| [PreflightOptions](interfaces/PreflightOptions.md) | Inputs to the construction-time environment admission check. |\n| [RunShellCommandOptions](interfaces/RunShellCommandOptions.md) | Configuration for the streaming shell-command tool. |\n| [SandboxCallDefaults](interfaces/SandboxCallDefaults.md) | Defaults visible as model-facing tool arguments; guest limits are intentionally separate. |\n| [SandboxConformanceReport](interfaces/SandboxConformanceReport.md) | Result metadata from mutation conformance, including operations that were not exercised. |\n| [SandboxedExecutorOptions](interfaces/SandboxedExecutorOptions.md) | Configuration for the sandboxed binary executor. |\n| [SandboxFileSystem](interfaces/SandboxFileSystem.md) | Filesystem capability with no copy primitive; traversal is complete and terminal-framed. |\n| [SandboxHandle](interfaces/SandboxHandle.md) | A live sandbox session: the object every sandbox tool is built against. |\n| [SandboxMediaOptions](interfaces/SandboxMediaOptions.md) | Arguments for [createSandboxMedia](functions/createSandboxMedia.md). |\n| [SandboxMediaReaderOptions](interfaces/SandboxMediaReaderOptions.md) | Arguments for [createSandboxMediaReader](functions/createSandboxMediaReader.md). |\n| [SandboxObservabilityOptions](interfaces/SandboxObservabilityOptions.md) | Dependencies used to create the redacting firehose. |\n| [SandboxPolicy](interfaces/SandboxPolicy.md) | Assembly-facing policy. Reads allow by default; writes and network deny by default. |\n| [SandboxPolicyEnforcer](interfaces/SandboxPolicyEnforcer.md) | Policy boundary. `run` resolves on spawn and exposes live streams plus a later completion promise. |\n| [SandboxPreflight](interfaces/SandboxPreflight.md) | Immutable decision retained by a sandbox handle for its entire lifetime. |\n| [SandboxSearch](interfaces/SandboxSearch.md) | Search capability; every result is lazy, complete, and terminal-framed. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ArtifactFormat](type-aliases/ArtifactFormat.md) | A format declaration accepted by the default minter. |\n| [Done](type-aliases/Done.md) | Terminal traversal protocol. Done is mandatory so end-of-stream cannot masquerade as completion. |\n| [FramedSource](type-aliases/FramedSource.md) | A framed adapter surface exercised by the shared protocol battery. |\n| [GuestLogEvent](type-aliases/GuestLogEvent.md) | One log event exactly as the trusted guest bootstrap's logger posts it. |\n| [GuestLogFraming](type-aliases/GuestLogFraming.md) | Delivery and emission framing for guest logs. |\n| [GuestOutcome](type-aliases/GuestOutcome.md) | Settled guest evaluation; partial encoding is still successful execution. |\n| [GuestThrown](type-aliases/GuestThrown.md) | A thrown guest value, preserving whether encoder representation was complete. |\n| [HitFrame](type-aliases/HitFrame.md) | Content-hit frames contain the whole matched line, followed by exactly one [Done](type-aliases/Done.md). |\n| [ListFrame](type-aliases/ListFrame.md) | List item frames followed by exactly one [Done](type-aliases/Done.md). |\n| [MimeResolver](type-aliases/MimeResolver.md) | MIME resolver; `undefined` means the resolver declines and a later resolver may decide. |\n| [ModelPath](type-aliases/ModelPath.md) | Presentation/normalisation brand only; this is NOT a containment guarantee. Every filesystem use must still pass through PathTranslator.toRelative(). |\n| [ModelWriteRoot](type-aliases/ModelWriteRoot.md) | Opaque model-facing write root; constructed only by the path layer. |\n| [PathFrame](type-aliases/PathFrame.md) | Path-search item frames followed by exactly one [Done](type-aliases/Done.md). |\n| [SandboxEpochIsLive](type-aliases/SandboxEpochIsLive.md) | The capability needed to decide whether a sandbox handle is still alive. |\n| [SandboxEvent](type-aliases/SandboxEvent.md) | Typed records emitted by the sandbox's single audit firehose. |\n| [SandboxEventSink](type-aliases/SandboxEventSink.md) | Consumer callback for sandbox audit events. |\n| [SandboxNarrator](type-aliases/SandboxNarrator.md) | Model-facing narration seam; implementations must be total over [SandboxOutcome](type-aliases/SandboxOutcome.md). |\n| [SandboxOutcome](type-aliases/SandboxOutcome.md) | Exhaustive model-facing sandbox outcome. |\n| [SandboxPathRejection](type-aliases/SandboxPathRejection.md) | Why a path was rejected outright, before any normalisation. |\n| [SandboxPlatform](type-aliases/SandboxPlatform.md) | Platform identity supplied by the construction site. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |\n| [ALLOWED\\_RIPGREP\\_FLAGS](variables/ALLOWED_RIPGREP_FLAGS.md) | Flags emitted by the sandbox's own ripgrep adapter. |\n| [artifactMinterSchema](variables/artifactMinterSchema.md) | Duck-type schema. |\n| [assertPosixBinShell](variables/assertPosixBinShell.md) | Alias used by the SRT adapter at construction time. |\n| [DEFAULT\\_MIME\\_PEEK\\_BYTES](variables/DEFAULT_MIME_PEEK_BYTES.md) | The default prefix available to a custom resolver. |\n| [defaultArtifactMinter](variables/defaultArtifactMinter.md) | The shared default registry. Its format thunks remain lazy until selected. |\n| [defaultMimeResolver](variables/defaultMimeResolver.md) | The default resolver, also exported under the concise name used by consumers. |\n| [defaultSandboxNarrator](variables/defaultSandboxNarrator.md) | Existence-blind default narrator; not-found and denied-by-policy intentionally share wording. |\n| [DOUBLE\\_DASH\\_BINARIES](variables/DOUBLE_DASH_BINARIES.md) | Binaries for which passing `--` terminates option parsing. |\n| [E\\_INVALID\\_SANDBOX\\_CONFIG](variables/E_INVALID_SANDBOX_CONFIG.md) | Invalid sandbox configuration. |\n| [E\\_SANDBOX\\_DEPENDENCY\\_MISSING](variables/E_SANDBOX_DEPENDENCY_MISSING.md) | Sandbox dependency is missing or unavailable at assembly time. |\n| [E\\_SANDBOX\\_FAILED](variables/E_SANDBOX_FAILED.md) | Sandbox operational failure presented to the model. |\n| [E\\_SANDBOX\\_GATE\\_REQUIRED](variables/E_SANDBOX_GATE_REQUIRED.md) | A required approval gate was not supplied. |\n| [E\\_SANDBOX\\_NARROWING\\_UNSUPPORTED](variables/E_SANDBOX_NARROWING_UNSUPPORTED.md) | A requested policy narrowing cannot be represented by the backend. |\n| [E\\_SANDBOX\\_NOT\\_INITIALIZED](variables/E_SANDBOX_NOT_INITIALIZED.md) | Sandbox operation was attempted before initialization. |\n| [E\\_SANDBOX\\_PATH\\_ESCAPE](variables/E_SANDBOX_PATH_ESCAPE.md) | Thrown when a model-supplied path is an UNAMBIGUOUS escape or an unsupported form. |\n| [E\\_SANDBOX\\_POLICY\\_CONFLICT](variables/E_SANDBOX_POLICY_CONFLICT.md) | Requested policy conflicts with another enforced policy. |\n| [E\\_SANDBOX\\_REFUSED](variables/E_SANDBOX_REFUSED.md) | Sandbox refusal presented to the model. |\n| [E\\_SANDBOX\\_UNSUPPORTED\\_ENV](variables/E_SANDBOX_UNSUPPORTED_ENV.md) | Sandbox environment is unsupported. |\n| [E\\_SES\\_EVALUATION\\_TIMEOUT](variables/E_SES_EVALUATION_TIMEOUT.md) | A guest evaluation exceeded its tool-selected deadline. |\n| [E\\_SES\\_HOST\\_LOCKDOWN\\_REQUIRED](variables/E_SES_HOST_LOCKDOWN_REQUIRED.md) | In-process SES evaluation requires hardening the complete host realm. |\n| [E\\_SES\\_LOCKDOWN\\_REQUIRED](variables/E_SES_LOCKDOWN_REQUIRED.md) | SES lockdown was unavailable or did not harden the guest realm. |\n| [escapeShellArgs](variables/escapeShellArgs.md) | Compatibility alias for consumers that describe this operation as escaping. |\n| [escapeShellValue](variables/escapeShellValue.md) | Compatibility alias for consumers that describe this operation as escaping. |\n| [extensionMimeResolver](variables/extensionMimeResolver.md) | Resolve a MIME type from a filename, without sniffing bytes. |\n| [guestLimitFloors](variables/guestLimitFloors.md) | Minimum representable guest values. |\n| [guestLimitsDefaults](variables/guestLimitsDefaults.md) | Default guest values, each paired with its own floor. |\n| [guestLimitsSchema](variables/guestLimitsSchema.md) | Schema enforcing every guest field's own floor. |\n| [guestRuntimeSchema](variables/guestRuntimeSchema.md) | Duck-type schema. |\n| [hostcallQuotasDefaults](variables/hostcallQuotasDefaults.md) | Default host quotas. |\n| [hostcallQuotasSchema](variables/hostcallQuotasSchema.md) | Schema enforcing every host quota floor. |\n| [mimeResolverSchema](variables/mimeResolverSchema.md) | MIME resolver schema. |\n| [pathTranslatorSchema](variables/pathTranslatorSchema.md) | Duck-type schema. |\n| [POSIX\\_SHELLS](variables/POSIX_SHELLS.md) | Shells for which SRT's POSIX quote() and the `-c` invocation contract agree. |\n| [runSandboxPreflight](variables/runSandboxPreflight.md) | Compatibility alias for the construction-site call in WP-A1. |\n| [SANDBOX\\_EXTENSION\\_MIME](variables/SANDBOX_EXTENSION_MIME.md) | Extension to MIME mappings used by the default resolver. |\n| [sandboxFileSystemSchema](variables/sandboxFileSystemSchema.md) | Duck-type schema. |\n| [sandboxPolicyEnforcerSchema](variables/sandboxPolicyEnforcerSchema.md) | Duck-type schema. |\n| [sandboxPolicySchema](variables/sandboxPolicySchema.md) | Closed structural schema for [SandboxPolicy](interfaces/SandboxPolicy.md). |\n| [sandboxSearchSchema](variables/sandboxSearchSchema.md) | Duck-type schema. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [artifactConstructorForPath](functions/artifactConstructorForPath.md) | Select the default artifact constructor for a path. |\n| [assertAllowedRipgrepFlag](functions/assertAllowedRipgrepFlag.md) | Validate a flag emitted by a trusted adapter, not a model-supplied value. |\n| [assertArgvValue](functions/assertArgvValue.md) | Reject an argv value which would otherwise be interpreted as an option. |\n| [asyncValidateOrThrow](functions/asyncValidateOrThrow.md) | Validates `value` against `schema` asynchronously and returns the coerced result typed as `T`. |\n| [binaryHonorsDoubleDash](functions/binaryHonorsDoubleDash.md) | Whether a binary in the table can receive the argv terminator. |\n| [classifySandboxPathRejection](functions/classifySandboxPathRejection.md) | Classify an unambiguous host escape, or `undefined` when the path is acceptable. |\n| [constructorFromMinter](functions/constructorFromMinter.md) | Select a constructor from a caller-provided minter, never throwing on bad metadata. |\n| [createCompartmentRuntime](functions/createCompartmentRuntime.md) | Construct a minimal SES-backed in-process guest. |\n| [createEvaluateJavascriptTool](functions/createEvaluateJavascriptTool.md) | Assemble the SES JavaScript evaluation tool. |\n| [createExistingSymlinkGuard](functions/createExistingSymlinkGuard.md) | Create a symlink guard for paths whose final component may not exist yet. Stat failures are treated as absence, matching the sandbox regular-file helpers. |\n| [createGuestRunner](functions/createGuestRunner.md) | Host runner that retains capability implementations and exposes only enumerated names. |\n| [createGuestRuntime](functions/createGuestRuntime.md) | In-process runtime factory for environments where SES is available. |\n| [createModelPath](functions/createModelPath.md) | Create a presentation/normalisation path only; this is NOT a containment guarantee. Every filesystem use must still pass through PathTranslator.toRelative(). |\n| [createModelWriteRoot](functions/createModelWriteRoot.md) | Construct the model root representation used in model-facing outcomes. |\n| [createPathTranslator](functions/createPathTranslator.md) | Create a translator that applies the five-step, workspace-relative path policy. |\n| [createRunShellCommandTool](functions/createRunShellCommandTool.md) | Assemble the factory-style `run_shell_command` tool. It is intentionally not a bulk-registered battery value. `cwd` is a model-supplied workspace-relative path and receives the complete PathTranslator gauntlet, including symlink refusal; the default is the workspace root. |\n| [createSandbox](functions/createSandbox.md) | Admit one process-global sandbox. Drift is detection, not prevention: SRT consults its proxies per request, so a widening can affect an already-spawned child for its lifetime. |\n| [createSandboxEpoch](functions/createSandboxEpoch.md) | Issue a fresh epoch token without requiring a type assertion. |\n| [createSandboxMedia](functions/createSandboxMedia.md) | Construct the staged media value returned by a mutating sandbox operation. |\n| [createSandboxMediaReader](functions/createSandboxMediaReader.md) | Create a non-describable, replayable reader over a sandbox file. |\n| [createSandboxObservability](functions/createSandboxObservability.md) | Build the one event surface consumed by WP-A1's sandbox handle. |\n| [emitBypass](functions/emitBypass.md) | Emit a loud audit-only bypass report. |\n| [emitDriftCheck](functions/emitDriftCheck.md) | Emit a drift result, including an explicit network-domain skip when requested. |\n| [emitFallback](functions/emitFallback.md) | Emit the permanent loud report for an unsandboxed invocation. |\n| [emitFsNodeVersion](functions/emitFsNodeVersion.md) | Emit the SRT version used by the in-process evaluator. |\n| [implementsArtifactMinter](functions/implementsArtifactMinter.md) | Structural guard. |\n| [implementsGuestLimits](functions/implementsGuestLimits.md) | Guard for resolved guest limits. |\n| [implementsGuestRuntime](functions/implementsGuestRuntime.md) | Structural guard. |\n| [implementsHostcallQuotas](functions/implementsHostcallQuotas.md) | Guard for resolved host quotas. |\n| [implementsMimeResolver](functions/implementsMimeResolver.md) | MIME resolver guard. |\n| [implementsPathTranslator](functions/implementsPathTranslator.md) | Structural guard. |\n| [implementsSandboxFileSystem](functions/implementsSandboxFileSystem.md) | Structural guard. |\n| [implementsSandboxPolicy](functions/implementsSandboxPolicy.md) | Duck-type guard for [SandboxPolicy](interfaces/SandboxPolicy.md). |\n| [implementsSandboxPolicyEnforcer](functions/implementsSandboxPolicyEnforcer.md) | Structural guard. |\n| [implementsSandboxSearch](functions/implementsSandboxSearch.md) | Structural guard. |\n| [isGuestOutcome](functions/isGuestOutcome.md) | Type-only terminal outcome helper. |\n| [isRejectedSandboxPath](functions/isRejectedSandboxPath.md) | Return whether a path is an unambiguous host escape before normalisation. |\n| [normalizeSandboxPath](functions/normalizeSandboxPath.md) | Normalise a model path; leading separators denote the sandbox root. |\n| [passesSchema](functions/passesSchema.md) | Returns `true` if `value` satisfies `schema` without throwing. |\n| [preflightSandbox](functions/preflightSandbox.md) | Run the once-only, fail-closed environment gauntlet used by `createSandbox()`. |\n| [probeSandboxSpawn](functions/probeSandboxSpawn.md) | Probe spawning after policy admission, rather than as part of preflight. |\n| [quoteShellArgs](functions/quoteShellArgs.md) | Quote argv using SRT's maintained POSIX implementation. |\n| [quoteShellValue](functions/quoteShellValue.md) | Quote one command string as one shell argument. |\n| [reportSandboxBypass](functions/reportSandboxBypass.md) | Emit a bypass through the canonical sink for consumers that do not retain the adapter. |\n| [resolveGuestLimits](functions/resolveGuestLimits.md) | Resolve and validate all seven guest limits exactly once. |\n| [resolveHostcallQuotas](functions/resolveHostcallQuotas.md) | Resolve and validate all three hostcall quotas exactly once. |\n| [resolveMime](functions/resolveMime.md) | Run a resolver and fall back to the extension resolver when it declines. The callback supplied to consumer code is always bounded by `maxPeekBytes`. |\n| [runSandboxConformance](functions/runSandboxConformance.md) | Run protocol and, when supplied, optional filesystem mutation checks. |\n| [sandboxedExecutor](functions/sandboxedExecutor.md) | Create a BinaryExecutor that wraps invocations unless an explicitly audited bypass applies. |\n| [validateAbsoluteBinaryPath](functions/validateAbsoluteBinaryPath.md) | Validate a configurable binary path without checking whether the binary exists. |\n| [validateBinShell](functions/validateBinShell.md) | Validate the shell selected by the Node SRT adapter. |\n| [validateOrThrow](functions/validateOrThrow.md) | Validates `value` against `schema` synchronously and returns the coerced result typed as `T`. |\n\n## References\n\n### createSandboxTools\n\nRe-exports [createSandboxTools](tools/functions/createSandboxTools.md)\n\n***\n\n### forgeSandboxTools\n\nRe-exports [forgeSandboxTools](tools/variables/forgeSandboxTools.md)\n\n***\n\n### narratingPath\n\nRe-exports [narratingPath](tools/functions/narratingPath.md)\n\n***\n\n### sandboxToolDescriptions\n\nRe-exports [sandboxToolDescriptions](tools/variables/sandboxToolDescriptions.md)\n\n***\n\n### SandboxToolsOptions\n\nRe-exports [SandboxToolsOptions](tools/interfaces/SandboxToolsOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/classes/DefaultArtifactMinter","title":"Class: DefaultArtifactMinter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/classes/DefaultArtifactMinter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/classes/DefaultArtifactMinter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/classes/DefaultArtifactMinter.md\ndescription: 'A pure minter with optional, lazily loaded consumer formats.'\n---\n\n# Class: DefaultArtifactMinter\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L35)\n\nA pure minter with optional, lazily loaded consumer formats.\n\n## Implements\n\n* [`ArtifactMinter`](../interfaces/ArtifactMinter.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew DefaultArtifactMinter(formats?: readonly ArtifactFormat[]): DefaultArtifactMinter;\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L38)\n\n#### Parameters\n\n| Parameter | Type | Default value |\n| --------- | ---------------------------------------------------------------- | ------------- |\n| `formats` | readonly [`ArtifactFormat`](../type-aliases/ArtifactFormat.md)\\[] | `[]` |\n\n#### Returns\n\n`DefaultArtifactMinter`\n\n## Methods\n\n### constructorForMime()\n\n```ts\nconstructorForMime(mime: string | undefined): Promise;\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L52)\n\nResolve the constructor for a MIME type; unknown types use the base artifact.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------- |\n| `mime` | `string` | `undefined` |\n\n#### Returns\n\n`Promise`<[`SpooledArtifactConstructor`](../../../forge/type-aliases/SpooledArtifactConstructor.md)>\n\n***\n\n### constructorForPath()\n\n```ts\nconstructorForPath(path: string, mime?: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L67)\n\nResolve the constructor from a MIME type, then an extension, without validating content.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n| `mime?` | `string` |\n\n#### Returns\n\n`Promise`<[`SpooledArtifactConstructor`](../../../forge/type-aliases/SpooledArtifactConstructor.md)>\n\n***\n\n### formats()\n\n```ts\nformats(): Promise;\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L43)\n\nReturn format metadata without invoking any constructor thunk.\n\n#### Returns\n\n`Promise`<[`ArtifactFormat`](../type-aliases/ArtifactFormat.md)\\[]>\n\n#### Implementation of\n\n[`ArtifactMinter`](../interfaces/ArtifactMinter.md).[`formats`](../interfaces/ArtifactMinter.md#formats)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/classes/SandboxEpoch","title":"Class: SandboxEpoch","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/classes/SandboxEpoch.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/classes/SandboxEpoch","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/classes/SandboxEpoch.md'\ndescription: Opaque epoch issued by the sandbox manager and consumed by readers.\n---\n\n# Class: SandboxEpoch\n\nDefined in: [src/batteries/sandbox/types.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L29)\n\nOpaque epoch issued by the sandbox manager and consumed by readers.\n\n## Methods\n\n### issue()\n\n```ts\nstatic issue(): SandboxEpoch;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L42)\n\nIssue a fresh epoch token for a sandbox manager.\n\n#### Returns\n\n`SandboxEpoch`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/artifactConstructorForPath","title":"Function: artifactConstructorForPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/artifactConstructorForPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/artifactConstructorForPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/artifactConstructorForPath.md\n---\n\n# Function: artifactConstructorForPath()\n\n```ts\nfunction artifactConstructorForPath(\n path: string,\n mime?: string,\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L78)\n\nSelect the default artifact constructor for a path.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n| `mime?` | `string` |\n\n## Returns\n\n`Promise`<[`SpooledArtifactConstructor`](../../../forge/type-aliases/SpooledArtifactConstructor.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/assertAllowedRipgrepFlag","title":"Function: assertAllowedRipgrepFlag()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/assertAllowedRipgrepFlag.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/assertAllowedRipgrepFlag","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/assertAllowedRipgrepFlag.md\n---\n\n# Function: assertAllowedRipgrepFlag()\n\n```ts\nfunction assertAllowedRipgrepFlag(flag: string): string;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L93)\n\nValidate a flag emitted by a trusted adapter, not a model-supplied value.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `flag` | `string` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/assertArgvValue","title":"Function: assertArgvValue()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/assertArgvValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/assertArgvValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/assertArgvValue.md\n---\n\n# Function: assertArgvValue()\n\n```ts\nfunction assertArgvValue(value: string): string;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L74)\n\nReject an argv value which would otherwise be interpreted as an option.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `value` | `string` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/asyncValidateOrThrow","title":"Function: asyncValidateOrThrow()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/asyncValidateOrThrow.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/asyncValidateOrThrow","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/asyncValidateOrThrow.md\n---\n\n# Function: asyncValidateOrThrow()\n\n```ts\nfunction asyncValidateOrThrow(\n schema: Schema,\n value: unknown,\n convert?: boolean,\n): Promise;\n```\n\nDefined in: [src/lib/utils/validation.ts:136](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/utils/validation.ts#L136)\n\nValidates `value` against `schema` asynchronously and returns the coerced result typed as `T`.\n\n## Type Parameters\n\n| Type Parameter | Description |\n| -------------- | ------------------------------------------------------------ |\n| `T` | The expected type of the validated and coerced return value. |\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `schema` | `Schema` | `undefined` | The schema to validate against. |\n| `value` | `unknown` | `undefined` | The value to validate. |\n| `convert` | `boolean` | `false` | When `true`, the validator coerces values to their target types (e.g. string `\"1\"` → number `1`). Defaults to `false` to prevent silent type coercion. |\n\n## Returns\n\n`Promise`<`T`>\n\nThe validated (and optionally coerced) value typed as `T`.\n\n## Remarks\n\nCollects all field errors before throwing. Prefer this over [validateOrThrow](validateOrThrow.md) when the\nschema includes async custom validators.\n\n## Throws\n\nValidationException when `value` does not satisfy `schema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/binaryHonorsDoubleDash","title":"Function: binaryHonorsDoubleDash()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/binaryHonorsDoubleDash.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/binaryHonorsDoubleDash","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/binaryHonorsDoubleDash.md\n---\n\n# Function: binaryHonorsDoubleDash()\n\n```ts\nfunction binaryHonorsDoubleDash(binary: string): boolean;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L87)\n\nWhether a binary in the table can receive the argv terminator.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `binary` | `string` |\n\n## Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/classifySandboxPathRejection","title":"Function: classifySandboxPathRejection()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/classifySandboxPathRejection.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/classifySandboxPathRejection","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/classifySandboxPathRejection.md\n---\n\n# Function: classifySandboxPathRejection()\n\n```ts\nfunction classifySandboxPathRejection(\n input: string,\n): SandboxPathRejection | undefined;\n```\n\nDefined in: [src/batteries/sandbox/paths.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/paths.ts#L28)\n\nClassify an unambiguous host escape, or `undefined` when the path is acceptable.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------------------------------ |\n| `input` | `string` | The model-supplied path, exactly as given. |\n\n## Returns\n\n| [`SandboxPathRejection`](../type-aliases/SandboxPathRejection.md)\n| `undefined`\n\nThe rejection reason, or `undefined` to continue normalising.\n\n## Remarks\n\nThe REASON is returned, not just a boolean, because the narrated outcome carries it and the model\nacts on it: \"paths are workspace-relative\" is useless advice for a NUL byte, and a UNC form needs\na different correction from a `~`. Reporting every rejection as `escape` collapses five distinct\nmistakes into one unhelpful message.\n\nORDER IS LOAD-BEARING and matches the plan's step 1. Recognition runs on the CANONICAL separator\nrepresentation (both `/` and `\\` treated as separators) but still BEFORE any stripping, so a\nslash-mixed form like `/\\server\\share` cannot slip past a naive prefix test and then become a\nroot-relative path once separators are collapsed. UNC is distinguished from merely-repeated\nleading separators by having a NON-EMPTY first segment. Nothing is percent-decoded and nothing is\ncase-folded: a literal `%2e%2e` is a filename, not traversal.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/constructorFromMinter","title":"Function: constructorFromMinter()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/constructorFromMinter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/constructorFromMinter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/constructorFromMinter.md\n---\n\n# Function: constructorFromMinter()\n\n```ts\nfunction constructorFromMinter(\n minter: ArtifactMinter,\n mime: string | undefined,\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L82)\n\nSelect a constructor from a caller-provided minter, never throwing on bad metadata.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------- |\n| `minter` | [`ArtifactMinter`](../interfaces/ArtifactMinter.md) |\n| `mime` | `string` | `undefined` |\n\n## Returns\n\n`Promise`<[`SpooledArtifactConstructor`](../../../forge/type-aliases/SpooledArtifactConstructor.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createCompartmentRuntime","title":"Function: createCompartmentRuntime()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createCompartmentRuntime.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createCompartmentRuntime","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createCompartmentRuntime.md\n---\n\n# Function: createCompartmentRuntime()\n\n```ts\nfunction createCompartmentRuntime(\n globals: Record unknown>,\n limits: GuestLimits,\n modules?: Record,\n hostLockdown?: boolean,\n): Promise<{\n evaluate: Promise;\n kill: Promise;\n}>;\n```\n\nDefined in: [src/batteries/sandbox/js/compartment.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/compartment.ts#L33)\n\nConstruct a minimal SES-backed in-process guest.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| `globals` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, (...`args`: `unknown`\\[]) => `unknown`> | `undefined` |\n| `limits` | [`GuestLimits`](../interfaces/GuestLimits.md) | `undefined` |\n| `modules` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | `{}` |\n| `hostLockdown` | `boolean` | `true` |\n\n## Returns\n\n`Promise`<{\n`evaluate`: `Promise`<[`GuestOutcome`](../type-aliases/GuestOutcome.md)>;\n`kill`: `Promise`<`void`>;\n}>\n\n## Remarks\n\nIn Node, SES lockdown is process-global: this hardens the whole host realm, not\nonly the guest. Guest-scoped isolation requires a worker or child runtime.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createEvaluateJavascriptTool","title":"Function: createEvaluateJavascriptTool()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createEvaluateJavascriptTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createEvaluateJavascriptTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createEvaluateJavascriptTool.md\n---\n\n# Function: createEvaluateJavascriptTool()\n\n```ts\nfunction createEvaluateJavascriptTool(config: EvaluateJavascriptConfig): Tool;\n```\n\nDefined in: [src/batteries/sandbox/js/tool.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/tool.ts#L12)\n\nAssemble the SES JavaScript evaluation tool.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------- |\n| `config` | [`EvaluateJavascriptConfig`](../interfaces/EvaluateJavascriptConfig.md) |\n\n## Returns\n\n[`Tool`](../../../forge/classes/Tool.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createExistingSymlinkGuard","title":"Function: createExistingSymlinkGuard()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createExistingSymlinkGuard.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createExistingSymlinkGuard","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createExistingSymlinkGuard.md\n---\n\n# Function: createExistingSymlinkGuard()\n\n```ts\nfunction createExistingSymlinkGuard(\n root: string,\n fileSystem: SandboxFileSystem,\n): (relative: string) => Promise;\n```\n\nDefined in: [src/batteries/sandbox/paths.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/paths.ts#L62)\n\nCreate a symlink guard for paths whose final component may not exist yet.\nStat failures are treated as absence, matching the sandbox regular-file helpers.\n\n## Parameters\n\n| Parameter | Type |\n| ------------ | --------------------------------------------------------- |\n| `root` | `string` |\n| `fileSystem` | [`SandboxFileSystem`](../interfaces/SandboxFileSystem.md) |\n\n## Returns\n\n(`relative`: `string`) => `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createGuestRunner","title":"Function: createGuestRunner()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createGuestRunner.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createGuestRunner","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createGuestRunner.md\n---\n\n# Function: createGuestRunner()\n\n```ts\nfunction createGuestRunner(\n globals: Record,\n limits?: GuestLimits,\n modules?: Record,\n hostLockdown?: boolean,\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/js/runner.ts:7](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/runner.ts#L7)\n\nHost runner that retains capability implementations and exposes only enumerated names.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| `globals` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`GuestGlobal`](../interfaces/GuestGlobal.md)> | `undefined` |\n| `limits` | [`GuestLimits`](../interfaces/GuestLimits.md) | `...` |\n| `modules` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | `{}` |\n| `hostLockdown` | `boolean` | `true` |\n\n## Returns\n\n`Promise`<[`GuestRuntimeLike`](../interfaces/GuestRuntimeLike.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createGuestRuntime","title":"Function: createGuestRuntime()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createGuestRuntime.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createGuestRuntime","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createGuestRuntime.md\n---\n\n# Function: createGuestRuntime()\n\n```ts\nfunction createGuestRuntime(\n globals: Record unknown>,\n limits: GuestLimits,\n modules?: Record,\n hostLockdown?: boolean,\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/js/service.ts:6](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/service.ts#L6)\n\nIn-process runtime factory for environments where SES is available.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| `globals` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, (...`args`: `unknown`\\[]) => `unknown`> | `undefined` |\n| `limits` | [`GuestLimits`](../interfaces/GuestLimits.md) | `undefined` |\n| `modules` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | `{}` |\n| `hostLockdown` | `boolean` | `true` |\n\n## Returns\n\n`Promise`<[`GuestRuntimeLike`](../interfaces/GuestRuntimeLike.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createModelPath","title":"Function: createModelPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createModelPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createModelPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createModelPath.md\n---\n\n# Function: createModelPath()\n\n```ts\nfunction createModelPath(value: string): ModelPath;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L17)\n\nCreate a presentation/normalisation path only; this is NOT a containment guarantee.\nEvery filesystem use must still pass through PathTranslator.toRelative().\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `value` | `string` |\n\n## Returns\n\n[`ModelPath`](../type-aliases/ModelPath.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createModelWriteRoot","title":"Function: createModelWriteRoot()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createModelWriteRoot.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createModelWriteRoot","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createModelWriteRoot.md\n---\n\n# Function: createModelWriteRoot()\n\n```ts\nfunction createModelWriteRoot(value: string): ModelWriteRoot;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L26)\n\nConstruct the model root representation used in model-facing outcomes.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `value` | `string` |\n\n## Returns\n\n[`ModelWriteRoot`](../type-aliases/ModelWriteRoot.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createPathTranslator","title":"Function: createPathTranslator()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createPathTranslator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createPathTranslator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createPathTranslator.md\n---\n\n# Function: createPathTranslator()\n\n```ts\nfunction createPathTranslator(\n root: string,\n fileSystem: SandboxFileSystem,\n): PathTranslator;\n```\n\nDefined in: [src/batteries/sandbox/paths.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/paths.ts#L84)\n\nCreate a translator that applies the five-step, workspace-relative path policy.\n\n## Parameters\n\n| Parameter | Type |\n| ------------ | --------------------------------------------------------- |\n| `root` | `string` |\n| `fileSystem` | [`SandboxFileSystem`](../interfaces/SandboxFileSystem.md) |\n\n## Returns\n\n[`PathTranslator`](../interfaces/PathTranslator.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createRunShellCommandTool","title":"Function: createRunShellCommandTool()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createRunShellCommandTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createRunShellCommandTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createRunShellCommandTool.md\n---\n\n# Function: createRunShellCommandTool()\n\n```ts\nfunction createRunShellCommandTool(options: RunShellCommandOptions): Tool;\n```\n\nDefined in: [src/batteries/sandbox/tool.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L60)\n\nAssemble the factory-style `run_shell_command` tool. It is intentionally not a bulk-registered\nbattery value. `cwd` is a model-supplied workspace-relative path and receives the complete\nPathTranslator gauntlet, including symlink refusal; the default is the workspace root.\n\nThe command spawns first, then stdout and stderr are drained concurrently and merged in arrival\norder into one stream and one `storeRetrievableBytes` call. Diagnostics are polled while drains\nrun and written as `[sandbox] denied: …` at their observation point (\"observed after\", not\n\"caused by\"). The command is never accumulated here. `timeout_seconds` defaults to 300 and is\na tool argument. Non-zero exits, violations, timeouts, and post-spawn I/O failures return the\nsingular artifact; failures meaning the command never ran throw instead.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `options` | [`RunShellCommandOptions`](../interfaces/RunShellCommandOptions.md) |\n\n## Returns\n\n[`Tool`](../../../forge/classes/Tool.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandbox","title":"Function: createSandbox()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandbox.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandbox","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandbox.md'\n---\n\n# Function: createSandbox()\n\n```ts\nfunction createSandbox(options: CreateSandboxOptions): Promise;\n```\n\nDefined in: [src/batteries/sandbox/manager.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L221)\n\nAdmit one process-global sandbox. Drift is detection, not prevention: SRT consults its\nproxies per request, so a widening can affect an already-spawned child for its lifetime.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------- |\n| `options` | [`CreateSandboxOptions`](../interfaces/CreateSandboxOptions.md) |\n\n## Returns\n\n`Promise`<[`SandboxHandle`](../interfaces/SandboxHandle.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxEpoch","title":"Function: createSandboxEpoch()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxEpoch.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxEpoch","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandboxEpoch.md\n---\n\n# Function: createSandboxEpoch()\n\n```ts\nfunction createSandboxEpoch(): SandboxEpoch;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L47)\n\nIssue a fresh epoch token without requiring a type assertion.\n\n## Returns\n\n[`SandboxEpoch`](../classes/SandboxEpoch.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMedia","title":"Function: createSandboxMedia()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMedia.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMedia","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMedia.md\n---\n\n# Function: createSandboxMedia()\n\n```ts\nfunction createSandboxMedia(options: SandboxMediaOptions): Media;\n```\n\nDefined in: [src/batteries/sandbox/media\\_reader.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L87)\n\nConstruct the staged media value returned by a mutating sandbox operation.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------- | ---------------------------------------- |\n| `options` | [`SandboxMediaOptions`](../interfaces/SandboxMediaOptions.md) | File-reader and media labelling options. |\n\n## Returns\n\n[`Media`](../../../common/classes/Media.md)\n\nA staged [Media](../../../common/classes/Media.md) value.\n\n## Remarks\n\nThe shipped Media factories supply the conservative modality hazard and keep the trust-tier\nchoice explicit at this call site. The reader remains deliberately non-describable.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMediaReader","title":"Function: createSandboxMediaReader()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMediaReader.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMediaReader","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMediaReader.md\n---\n\n# Function: createSandboxMediaReader()\n\n```ts\nfunction createSandboxMediaReader(\n options: SandboxMediaReaderOptions,\n): MediaReader;\n```\n\nDefined in: [src/batteries/sandbox/media\\_reader.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L50)\n\nCreate a non-describable, replayable reader over a sandbox file.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------- |\n| `options` | [`SandboxMediaReaderOptions`](../interfaces/SandboxMediaReaderOptions.md) | The sandbox filesystem, translated path, epoch, and liveness predicate. |\n\n## Returns\n\n[`MediaReader`](../../../common/interfaces/MediaReader.md)\n\nA file-backed [MediaReader](../../../common/interfaces/MediaReader.md).\n\n## Remarks\n\nEvery operation checks the owning epoch, stats the path, and refuses anything whose filesystem\nkind is not `file` before opening it. Every stream call then asks the injected filesystem for a\nfresh stream; this reader deliberately has no byte cap and does not import a host filesystem.\nThe reader omits `describe()` because approval-bound sandbox capabilities must not cross a\nserialisation boundary.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxObservability","title":"Function: createSandboxObservability()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxObservability.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/createSandboxObservability","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandboxObservability.md\n---\n\n# Function: createSandboxObservability()\n\n```ts\nfunction createSandboxObservability(\n options: SandboxObservabilityOptions,\n): SandboxEventSink;\n```\n\nDefined in: [src/batteries/sandbox/observability.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L83)\n\nBuild the one event surface consumed by WP-A1's sandbox handle.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------- |\n| `options` | [`SandboxObservabilityOptions`](../interfaces/SandboxObservabilityOptions.md) |\n\n## Returns\n\n[`SandboxEventSink`](../type-aliases/SandboxEventSink.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitBypass","title":"Function: emitBypass()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitBypass.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitBypass","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/emitBypass.md'\n---\n\n# Function: emitBypass()\n\n```ts\nfunction emitBypass(\n sink: SandboxEventSink,\n command: string,\n path?: string,\n): void;\n```\n\nDefined in: [src/batteries/sandbox/observability.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L90)\n\nEmit a loud audit-only bypass report.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------- |\n| `sink` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) |\n| `command` | `string` |\n| `path?` | `string` |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitDriftCheck","title":"Function: emitDriftCheck()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitDriftCheck.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitDriftCheck","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/emitDriftCheck.md\n---\n\n# Function: emitDriftCheck()\n\n```ts\nfunction emitDriftCheck(\n sink: SandboxEventSink,\n outcome: \"failed\" | \"skipped\" | \"passed\",\n details?: {\n networkDomainsSkipped?: boolean;\n path?: string;\n reason?: string;\n },\n): void;\n```\n\nDefined in: [src/batteries/sandbox/observability.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L111)\n\nEmit a drift result, including an explicit network-domain skip when requested.\n\n## Parameters\n\n| Parameter | Type |\n| -------------------------------- | ---------------------------------------------------------------------------------- |\n| `sink` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) |\n| `outcome` | `\"failed\"` | `\"skipped\"` | `\"passed\"` |\n| `details?` | { `networkDomainsSkipped?`: `boolean`; `path?`: `string`; `reason?`: `string`; } |\n| `details.networkDomainsSkipped?` | `boolean` |\n| `details.path?` | `string` |\n| `details.reason?` | `string` |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitFallback","title":"Function: emitFallback()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitFallback.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitFallback","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/emitFallback.md'\n---\n\n# Function: emitFallback()\n\n```ts\nfunction emitFallback(\n sink: SandboxEventSink,\n handleId: string,\n reason: string,\n path?: string,\n): void;\n```\n\nDefined in: [src/batteries/sandbox/observability.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L95)\n\nEmit the permanent loud report for an unsandboxed invocation.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | --------------------------------------------------------- |\n| `sink` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) |\n| `handleId` | `string` |\n| `reason` | `string` |\n| `path?` | `string` |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitFsNodeVersion","title":"Function: emitFsNodeVersion()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitFsNodeVersion.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/emitFsNodeVersion","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/emitFsNodeVersion.md\n---\n\n# Function: emitFsNodeVersion()\n\n```ts\nfunction emitFsNodeVersion(sink: SandboxEventSink, version: string): void;\n```\n\nDefined in: [src/batteries/sandbox/observability.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L130)\n\nEmit the SRT version used by the in-process evaluator.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------- |\n| `sink` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) |\n| `version` | `string` |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsArtifactMinter","title":"Function: implementsArtifactMinter()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsArtifactMinter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsArtifactMinter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsArtifactMinter.md\n---\n\n# Function: implementsArtifactMinter()\n\n```ts\nfunction implementsArtifactMinter(value: unknown): value is ArtifactMinter;\n```\n\nDefined in: [src/batteries/sandbox/contracts/artifact\\_minter.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/artifact_minter.ts#L23)\n\nStructural guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is ArtifactMinter`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestLimits","title":"Function: implementsGuestLimits()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestLimits.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestLimits","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestLimits.md\n---\n\n# Function: implementsGuestLimits()\n\n```ts\nfunction implementsGuestLimits(value: unknown): value is GuestLimits;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L320)\n\nGuard for resolved guest limits.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is GuestLimits`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestRuntime","title":"Function: implementsGuestRuntime()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestRuntime.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestRuntime","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsGuestRuntime.md\n---\n\n# Function: implementsGuestRuntime()\n\n```ts\nfunction implementsGuestRuntime(value: unknown): value is GuestRuntime;\n```\n\nDefined in: [src/batteries/sandbox/contracts/guest\\_runtime.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/guest_runtime.ts#L27)\n\nStructural guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is GuestRuntime`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsHostcallQuotas","title":"Function: implementsHostcallQuotas()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsHostcallQuotas.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsHostcallQuotas","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsHostcallQuotas.md\n---\n\n# Function: implementsHostcallQuotas()\n\n```ts\nfunction implementsHostcallQuotas(value: unknown): value is HostcallQuotas;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L329)\n\nGuard for resolved host quotas.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is HostcallQuotas`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsMimeResolver","title":"Function: implementsMimeResolver()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsMimeResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsMimeResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsMimeResolver.md\n---\n\n# Function: implementsMimeResolver()\n\n```ts\nfunction implementsMimeResolver(v: unknown): v is MimeResolver;\n```\n\nDefined in: [src/batteries/sandbox/contracts/mime\\_resolver.ts:16](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/mime_resolver.ts#L16)\n\nMIME resolver guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `v` | `unknown` |\n\n## Returns\n\n`v is MimeResolver`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsPathTranslator","title":"Function: implementsPathTranslator()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsPathTranslator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsPathTranslator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsPathTranslator.md\n---\n\n# Function: implementsPathTranslator()\n\n```ts\nfunction implementsPathTranslator(value: unknown): value is PathTranslator;\n```\n\nDefined in: [src/batteries/sandbox/contracts/path\\_translator.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/path_translator.ts#L34)\n\nStructural guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is PathTranslator`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxFileSystem","title":"Function: implementsSandboxFileSystem()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxFileSystem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxFileSystem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxFileSystem.md\n---\n\n# Function: implementsSandboxFileSystem()\n\n```ts\nfunction implementsSandboxFileSystem(\n value: unknown,\n): value is SandboxFileSystem;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L55)\n\nStructural guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is SandboxFileSystem`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicy","title":"Function: implementsSandboxPolicy()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicy.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicy","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicy.md\n---\n\n# Function: implementsSandboxPolicy()\n\n```ts\nfunction implementsSandboxPolicy(value: unknown): value is SandboxPolicy;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:291](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L291)\n\nDuck-type guard for [SandboxPolicy](../interfaces/SandboxPolicy.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is SandboxPolicy`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicyEnforcer","title":"Function: implementsSandboxPolicyEnforcer()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicyEnforcer.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicyEnforcer","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxPolicyEnforcer.md\n---\n\n# Function: implementsSandboxPolicyEnforcer()\n\n```ts\nfunction implementsSandboxPolicyEnforcer(\n value: unknown,\n): value is SandboxPolicyEnforcer;\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L76)\n\nStructural guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is SandboxPolicyEnforcer`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxSearch","title":"Function: implementsSandboxSearch()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxSearch.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxSearch","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/implementsSandboxSearch.md\n---\n\n# Function: implementsSandboxSearch()\n\n```ts\nfunction implementsSandboxSearch(value: unknown): value is SandboxSearch;\n```\n\nDefined in: [src/batteries/sandbox/contracts/search.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/search.ts#L65)\n\nStructural guard.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is SandboxSearch`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/isGuestOutcome","title":"Function: isGuestOutcome()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/isGuestOutcome.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/isGuestOutcome","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/isGuestOutcome.md\n---\n\n# Function: isGuestOutcome()\n\n```ts\nfunction isGuestOutcome(value: unknown): value is GuestOutcome;\n```\n\nDefined in: [src/batteries/sandbox/js/runner.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/runner.ts#L25)\n\nType-only terminal outcome helper.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is GuestOutcome`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/isRejectedSandboxPath","title":"Function: isRejectedSandboxPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/isRejectedSandboxPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/isRejectedSandboxPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/isRejectedSandboxPath.md\n---\n\n# Function: isRejectedSandboxPath()\n\n```ts\nfunction isRejectedSandboxPath(input: string): boolean;\n```\n\nDefined in: [src/batteries/sandbox/paths.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/paths.ts#L39)\n\nReturn whether a path is an unambiguous host escape before normalisation.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `input` | `string` |\n\n## Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/normalizeSandboxPath","title":"Function: normalizeSandboxPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/normalizeSandboxPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/normalizeSandboxPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/normalizeSandboxPath.md\n---\n\n# Function: normalizeSandboxPath()\n\n```ts\nfunction normalizeSandboxPath(input: string): string;\n```\n\nDefined in: [src/batteries/sandbox/paths.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/paths.ts#L46)\n\nNormalise a model path; leading separators denote the sandbox root.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `input` | `string` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/passesSchema","title":"Function: passesSchema()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/passesSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/passesSchema","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/passesSchema.md'\n---\n\n# Function: passesSchema()\n\n```ts\nfunction passesSchema(schema: Schema, value: unknown): boolean;\n```\n\nDefined in: [src/lib/utils/validation.ts:16](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/utils/validation.ts#L16)\n\nReturns `true` if `value` satisfies `schema` without throwing.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------------------- |\n| `schema` | `Schema` | The schema to validate against. |\n| `value` | `unknown` | The value to test. |\n\n## Returns\n\n`boolean`\n\n`true` when `value` passes the schema; `false` otherwise.\n\n## Remarks\n\nAborts on the first validation error. Use [validateOrThrow](validateOrThrow.md) or\n[asyncValidateOrThrow](asyncValidateOrThrow.md) when you need the full set of field errors.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/preflightSandbox","title":"Function: preflightSandbox()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/preflightSandbox.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/preflightSandbox","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/preflightSandbox.md\n---\n\n# Function: preflightSandbox()\n\n```ts\nfunction preflightSandbox(options: PreflightOptions): Promise;\n```\n\nDefined in: [src/batteries/sandbox/preflight.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L60)\n\nRun the once-only, fail-closed environment gauntlet used by `createSandbox()`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------- |\n| `options` | [`PreflightOptions`](../interfaces/PreflightOptions.md) |\n\n## Returns\n\n`Promise`<[`SandboxPreflight`](../interfaces/SandboxPreflight.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/probeSandboxSpawn","title":"Function: probeSandboxSpawn()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/probeSandboxSpawn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/probeSandboxSpawn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/probeSandboxSpawn.md\n---\n\n# Function: probeSandboxSpawn()\n\n```ts\nfunction probeSandboxSpawn(\n enforcer: SandboxPolicyEnforcer,\n policy: SandboxPolicy,\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/preflight.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L103)\n\nProbe spawning after policy admission, rather than as part of preflight.\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ----------------------------------------------------------------- |\n| `enforcer` | [`SandboxPolicyEnforcer`](../interfaces/SandboxPolicyEnforcer.md) |\n| `policy` | [`SandboxPolicy`](../interfaces/SandboxPolicy.md) |\n\n## Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/quoteShellArgs","title":"Function: quoteShellArgs()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/quoteShellArgs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/quoteShellArgs","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/quoteShellArgs.md\n---\n\n# Function: quoteShellArgs()\n\n```ts\nfunction quoteShellArgs(args: readonly string[]): Promise;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L108)\n\nQuote argv using SRT's maintained POSIX implementation.\n\nThe import is deliberately lazy: SRT is an optional peer and is ESM-only.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------- |\n| `args` | readonly `string`\\[] |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/quoteShellValue","title":"Function: quoteShellValue()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/quoteShellValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/quoteShellValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/quoteShellValue.md\n---\n\n# Function: quoteShellValue()\n\n```ts\nfunction quoteShellValue(value: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L121)\n\nQuote one command string as one shell argument.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `value` | `string` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/reportSandboxBypass","title":"Function: reportSandboxBypass()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/reportSandboxBypass.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/reportSandboxBypass","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/reportSandboxBypass.md\n---\n\n# Function: reportSandboxBypass()\n\n```ts\nfunction reportSandboxBypass(sink: SandboxEventSink, command: string): void;\n```\n\nDefined in: [src/batteries/sandbox/executor.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L54)\n\nEmit a bypass through the canonical sink for consumers that do not retain the adapter.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------- |\n| `sink` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) |\n| `command` | `string` |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveGuestLimits","title":"Function: resolveGuestLimits()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveGuestLimits.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveGuestLimits","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/resolveGuestLimits.md\n---\n\n# Function: resolveGuestLimits()\n\n```ts\nfunction resolveGuestLimits(value?: Partial): GuestLimits;\n```\n\nDefined in: [src/batteries/sandbox/js/validation.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/validation.ts#L28)\n\nResolve and validate all seven guest limits exactly once.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `value?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`GuestLimits`](../interfaces/GuestLimits.md)> |\n\n## Returns\n\n[`GuestLimits`](../interfaces/GuestLimits.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveHostcallQuotas","title":"Function: resolveHostcallQuotas()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveHostcallQuotas.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveHostcallQuotas","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/resolveHostcallQuotas.md\n---\n\n# Function: resolveHostcallQuotas()\n\n```ts\nfunction resolveHostcallQuotas(value?: Partial): HostcallQuotas;\n```\n\nDefined in: [src/batteries/sandbox/js/validation.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/validation.ts#L31)\n\nResolve and validate all three hostcall quotas exactly once.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `value?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`HostcallQuotas`](../interfaces/HostcallQuotas.md)> |\n\n## Returns\n\n[`HostcallQuotas`](../interfaces/HostcallQuotas.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveMime","title":"Function: resolveMime()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveMime.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/resolveMime","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/resolveMime.md'\n---\n\n# Function: resolveMime()\n\n```ts\nfunction resolveMime(\n path: string,\n resolver?: MimeResolver,\n options?: {\n declared?: string;\n maxPeekBytes?: number;\n peek?: (bytes: number) => Promise>;\n },\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/defaults/extension\\_mime.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/extension_mime.ts#L99)\n\nRun a resolver and fall back to the extension resolver when it declines.\nThe callback supplied to consumer code is always bounded by `maxPeekBytes`.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `path` | `string` |\n| `resolver?` | [`MimeResolver`](../type-aliases/MimeResolver.md) |\n| `options?` | { `declared?`: `string`; `maxPeekBytes?`: `number`; `peek?`: (`bytes`: `number`) => `Promise`<`Uint8Array`<`ArrayBufferLike`>>; } |\n| `options.declared?` | `string` |\n| `options.maxPeekBytes?` | `number` |\n| `options.peek?` | (`bytes`: `number`) => `Promise`<`Uint8Array`<`ArrayBufferLike`>> |\n\n## Returns\n\n`Promise`<`string` | `undefined`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/runSandboxConformance","title":"Function: runSandboxConformance()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/runSandboxConformance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/runSandboxConformance","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/runSandboxConformance.md\n---\n\n# Function: runSandboxConformance()\n\n## Call Signature\n\n```ts\nfunction runSandboxConformance(sources: ConformanceSources): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L121)\n\nRun protocol and, when supplied, optional filesystem mutation checks.\n\n### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------- |\n| `sources` | [`ConformanceSources`](../interfaces/ConformanceSources.md) |\n\n### Returns\n\n`Promise`<`void`>\n\n## Call Signature\n\n```ts\nfunction runSandboxConformance(\n sources: ConformanceSources,\n mutations: ConformanceMutations,\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L122)\n\nRun protocol and, when supplied, optional filesystem mutation checks.\n\n### Parameters\n\n| Parameter | Type |\n| ----------- | --------------------------------------------------------------- |\n| `sources` | [`ConformanceSources`](../interfaces/ConformanceSources.md) |\n| `mutations` | [`ConformanceMutations`](../interfaces/ConformanceMutations.md) |\n\n### Returns\n\n`Promise`<[`SandboxConformanceReport`](../interfaces/SandboxConformanceReport.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/sandboxedExecutor","title":"Function: sandboxedExecutor()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/sandboxedExecutor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/sandboxedExecutor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/sandboxedExecutor.md\n---\n\n# Function: sandboxedExecutor()\n\n```ts\nfunction sandboxedExecutor(options: SandboxedExecutorOptions): BinaryExecutor;\n```\n\nDefined in: [src/batteries/sandbox/executor.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L41)\n\nCreate a BinaryExecutor that wraps invocations unless an explicitly audited bypass applies.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------- |\n| `options` | [`SandboxedExecutorOptions`](../interfaces/SandboxedExecutorOptions.md) |\n\n## Returns\n\n[`BinaryExecutor`](../../media/contracts/interfaces/BinaryExecutor.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateAbsoluteBinaryPath","title":"Function: validateAbsoluteBinaryPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateAbsoluteBinaryPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateAbsoluteBinaryPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/validateAbsoluteBinaryPath.md\n---\n\n# Function: validateAbsoluteBinaryPath()\n\n```ts\nfunction validateAbsoluteBinaryPath(\n value: string | undefined,\n optionName: string,\n): string | undefined;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L57)\n\nValidate a configurable binary path without checking whether the binary exists.\n\n## Parameters\n\n| Parameter | Type |\n| ------------ | ----------------------- |\n| `value` | `string` | `undefined` |\n| `optionName` | `string` |\n\n## Returns\n\n`string` | `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateBinShell","title":"Function: validateBinShell()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateBinShell.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateBinShell","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/validateBinShell.md\n---\n\n# Function: validateBinShell()\n\n```ts\nfunction validateBinShell(value?: string): string;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L38)\n\nValidate the shell selected by the Node SRT adapter.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | -------- | ------------- |\n| `value` | `string` | `'/bin/bash'` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateOrThrow","title":"Function: validateOrThrow()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateOrThrow.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/functions/validateOrThrow","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/validateOrThrow.md\n---\n\n# Function: validateOrThrow()\n\n```ts\nfunction validateOrThrow(\n schema: Schema,\n value: unknown,\n convert?: boolean,\n): T;\n```\n\nDefined in: [src/lib/utils/validation.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/lib/utils/validation.ts#L113)\n\nValidates `value` against `schema` synchronously and returns the coerced result typed as `T`.\n\n## Type Parameters\n\n| Type Parameter | Description |\n| -------------- | --------------------------------------------------------- |\n| `T` | The expected type of `value` after successful validation. |\n\n## Parameters\n\n| Parameter | Type | Default value | Description |\n| --------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `schema` | `Schema` | `undefined` | The schema to validate against. |\n| `value` | `unknown` | `undefined` | The value to validate. |\n| `convert` | `boolean` | `false` | When `true`, the validator coerces values to their target types (e.g. string `\"1\"` → number `1`). Defaults to `false` to prevent silent type coercion. |\n\n## Returns\n\n`T`\n\nThe validated (and optionally coerced) value typed as `T`.\n\n## Remarks\n\nCollects all field errors before throwing. Use [asyncValidateOrThrow](asyncValidateOrThrow.md) for schemas that\ninclude async custom validators.\n\n## Throws\n\nValidationException when `value` does not satisfy `schema`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ArtifactMinter","title":"Interface: ArtifactMinter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ArtifactMinter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ArtifactMinter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/ArtifactMinter.md\ndescription: >-\n Artifact-class registry. Format constructors are lazy so unused parsers are\n never loaded.\n---\n\n# Interface: ArtifactMinter\n\nDefined in: [src/batteries/sandbox/contracts/artifact\\_minter.ts:5](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/artifact_minter.ts#L5)\n\nArtifact-class registry. Format constructors are lazy so unused parsers are never loaded.\n\n## Methods\n\n### formats()\n\n```ts\nformats(): Promise<{\n ctor: () => Promise;\n extensions: string[];\n id: string;\n mime: string[];\n}[]>;\n```\n\nDefined in: [src/batteries/sandbox/contracts/artifact\\_minter.ts:7](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/artifact_minter.ts#L7)\n\nReturn available formats and async constructors.\n\n#### Returns\n\n`Promise`<{\n`ctor`: () => `Promise`<`unknown`>;\n`extensions`: `string`\\[];\n`id`: `string`;\n`mime`: `string`\\[];\n}\\[]>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/BinarySandbox","title":"Interface: BinarySandbox","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/BinarySandbox.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/BinarySandbox","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/BinarySandbox.md\ndescription: Command wrapping contract used by the executor adapter.\n---\n\n# Interface: BinarySandbox\n\nDefined in: [src/batteries/sandbox/executor.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L10)\n\nCommand wrapping contract used by the executor adapter.\n\n## Methods\n\n### wrap()\n\n```ts\nwrap(invocation: BinaryInvocation & {\n command: string;\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/executor.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L12)\n\nWrap an invocation without executing it.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | ------------------------------------------------------------------------------------------------------- |\n| `invocation` | [`BinaryInvocation`](../../media/contracts/interfaces/BinaryInvocation.md) & { `command`: `string`; } |\n\n#### Returns\n\n`Promise`<[`BinaryInvocation`](../../media/contracts/interfaces/BinaryInvocation.md) & {\n`command`: `string`;\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceMutations","title":"Interface: ConformanceMutations","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceMutations.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceMutations","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceMutations.md\ndescription: Optional mutation fixture for adapters that expose filesystem mutators.\n---\n\n# Interface: ConformanceMutations\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L42)\n\nOptional mutation fixture for adapters that expose filesystem mutators.\n\n## Methods\n\n### delete()?\n\n```ts\noptional delete(path: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L54)\n\nRemove a fixture; the optional operation must also resolve when the path is already absent.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### freePath()\n\n```ts\nfreePath(options?: {\n directory?: \"default\" | \"other\";\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L46)\n\nA fresh absent path with an existing parent, allowing rename checks without requiring mkdir.\n\n#### Parameters\n\n| Parameter | Type |\n| -------------------- | --------------------------------------------- |\n| `options?` | { `directory?`: `\"default\"` | `\"other\"`; } |\n| `options.directory?` | `\"default\"` | `\"other\"` |\n\n#### Returns\n\n`Promise`<`string`>\n\n***\n\n### makeFile()\n\n```ts\nmakeFile(text: string, options?: {\n directory?: \"default\" | \"other\";\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L44)\n\nA fresh disposable path in the selected existing directory, so checks cannot collide with repository files.\n\n#### Parameters\n\n| Parameter | Type |\n| -------------------- | --------------------------------------------- |\n| `text` | `string` |\n| `options?` | { `directory?`: `\"default\"` | `\"other\"`; } |\n| `options.directory?` | `\"default\"` | `\"other\"` |\n\n#### Returns\n\n`Promise`<`string`>\n\n***\n\n### mkdir()?\n\n```ts\noptional mkdir(path: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L58)\n\nCreate the requested directory hierarchy and accept an already-existing directory.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### read()\n\n```ts\nread(path: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L50)\n\nRead fixture content after a mutation, proving that the operation preserved or wrote the expected text.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<`string`>\n\n***\n\n### rename()?\n\n```ts\noptional rename(from: string, to: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L56)\n\nMove a fixture and overwrite an existing destination, matching the filesystem contract.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `from` | `string` |\n| `to` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### stat()\n\n```ts\nstat(path: string): Promise<{\n kind: string;\n size: number;\n version: string;\n}>;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L48)\n\nObserve the post-mutation metadata, including entry kind for directory checks.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<{\n`kind`: `string`;\n`size`: `number`;\n`version`: `string`;\n}>\n\n***\n\n### write()\n\n```ts\nwrite(path: string, text: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L52)\n\nReplace fixture content and make the new text observable through a subsequent read.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n| `text` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceSources","title":"Interface: ConformanceSources","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceSources.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceSources","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/ConformanceSources.md\ndescription: The adapter surfaces the shared conformance battery exercises.\n---\n\n# Interface: ConformanceSources\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L20)\n\nThe adapter surfaces the shared conformance battery exercises.\n\n## Remarks\n\nA DUCK-TYPE GUARD CANNOT CHECK BEHAVIOUR, which is why this suite exists. `implementsX()` proves a\nbackend has the right method names; it cannot prove the iterable is lazy, that it emits the mandatory\nterminal frame, or that `signal` actually aborts mid-stream. Without those checks a conformant-LOOKING\nOPFS adapter could silently impose limits the Node one does not, and the boundary would differ by\nenvironment.\n\nEvery framed surface must be lazy, emit each `item` frame (there is no count cap to stop at), then\nEXACTLY ONE terminal `done` frame matching one union arm exactly. **A stream that ends without `done`\nis a protocol violation** the tools classify as `io-failure` — never as \"no overflow\", because\nsilence is precisely what an unannounced truncation looks like.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `findPaths` | [`FramedSource`](../type-aliases/FramedSource.md)<[`PathFrame`](../type-aliases/PathFrame.md)> | Name search: `item` frames carrying a path, then one terminal frame. | [src/batteries/sandbox/conformance/index.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L24) |\n| `list` | [`FramedSource`](../type-aliases/FramedSource.md)<[`ListFrame`](../type-aliases/ListFrame.md)> | Directory traversal: `item` frames carrying a path and entry kind, then one terminal frame. | [src/batteries/sandbox/conformance/index.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L22) |\n| `searchContent` | [`FramedSource`](../type-aliases/FramedSource.md)<[`HitFrame`](../type-aliases/HitFrame.md)> | Content search: `item` frames carrying path, line, and the WHOLE matched line — no per-hit cut. | [src/batteries/sandbox/conformance/index.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L26) |\n\n## Methods\n\n### read()\n\n```ts\nread(): Promise>>;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L28)\n\nMust hand back a FRESH stream per call: readers are replayable, not single-use.\n\n#### Returns\n\n`Promise`<`ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>>\n\n***\n\n### stat()\n\n```ts\nstat(): Promise<{\n size: number;\n version: string;\n}>;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L38)\n\nMetadata, including the opaque change token.\n\n#### Returns\n\n`Promise`<{\n`size`: `number`;\n`version`: `string`;\n}>\n\n#### Remarks\n\n`version` is compared for equality and never parsed, and only ONE direction is sound: a CHANGED\ntoken is evidence the file may have changed, while an UNCHANGED token is NOT evidence it did not —\na same-size write inside the timestamp resolution preserves it. The suite asserts the safe\ndirection only.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/CreateSandboxOptions","title":"Interface: CreateSandboxOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/CreateSandboxOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/CreateSandboxOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/CreateSandboxOptions.md\ndescription: 'Options for [`createSandbox`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandbox).'\n---\n\n# Interface: CreateSandboxOptions\n\nDefined in: [src/batteries/sandbox/manager.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L80)\n\nOptions for [createSandbox](../functions/createSandbox.md).\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| -------------------------------------------------------------------------- | ---------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `allowUnsandboxedFallback?` | `readonly` | `boolean` | Permit degraded operation when the environment cannot provide OS containment. **Remarks** Fires only for pre-execution conditions resolved once at construction — a platform the backend cannot sandbox that we still run on, dependency errors, or an absent optional peer. It NEVER fires for a violation (a violation means the sandbox worked), and native Windows is refused outright rather than degraded. When it fires the handle is permanently marked and every invocation emits a loud observability event. Execution STILL goes through `enforcer.run`; this option never runs a command unsandboxed, and the tool descriptions tell the model it has no OS containment. | [src/batteries/sandbox/manager.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L114) |\n| `enforcer` | `readonly` | [`SandboxPolicyEnforcer`](SandboxPolicyEnforcer.md) | The boundary itself. Node's SRT-backed enforcer lives on the `sandbox/node` subpath. | [src/batteries/sandbox/manager.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L92) |\n| `fsNodeVersion?` | `readonly` | `string` | Recorded on observability events so a rules-versus-backend mismatch is diagnosable without a bisect. | [src/batteries/sandbox/manager.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L120) |\n| `onSandbox?` | `readonly` | (`event`: [`SandboxEvent`](../type-aliases/SandboxEvent.md)) => `void` | Observability firehose: bypasses, fallbacks, drift outcomes, and the SRT version rules came from. | [src/batteries/sandbox/manager.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L102) |\n| `optionalPeerPresent?` | `readonly` | `boolean` | Whether the optional peer resolved; feeds the preflight decision above. | [src/batteries/sandbox/manager.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L118) |\n| `policy` | `readonly` | [`SandboxPolicy`](SandboxPolicy.md) | ADK-owned policy vocabulary, mapped to the backend's config inside the enforcer. **Remarks** The per-axis defaults DIFFER and are not a symmetry worth \"fixing\": reads default to ALLOW (absent `denyRead` means everything is readable, and `allowRead` re-permits WITHIN a deny), while writes default to DENY and network is an allow-list. A checker that unified them would disagree with the OS by construction. | [src/batteries/sandbox/manager.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L90) |\n| `probeSpawn?` | `readonly` | `boolean` | Opt in to a real child-spawn liveness check during construction. | [src/batteries/sandbox/manager.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L122) |\n| `strictMode?` | `readonly` | `boolean` | Ignore the per-call escape entirely, matching the reference consumer's strict mode. | [src/batteries/sandbox/manager.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L116) |\n| `translator?` | `readonly` | [`PathTranslator`](PathTranslator.md) | Model-path translation, and the redaction used on every observability event. **Remarks** Supply it if you want host identifiers scrubbed from the event stream — no battery-generated surface should carry the sandbox root, home directory, or user name. | [src/batteries/sandbox/manager.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L100) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/DerivedRules","title":"Interface: DerivedRules","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/DerivedRules.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/DerivedRules","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/DerivedRules.md'\ndescription: >-\n Backend-derived rules used for admission and drift checks, not a model-facing\n policy.\n---\n\n# Interface: DerivedRules\n\nDefined in: [src/batteries/sandbox/types.ts:83](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L83)\n\nBackend-derived rules used for admission and drift checks, not a model-facing policy.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `filesystemDisabled` | `readonly` | `boolean` | Whether the live sandbox has filesystem policy switched off entirely. **Remarks** A kill switch, and the drift check treats it asymmetrically: `true → false` is a NARROWING and therefore permitted, while `false → true` is DRIFT — it bypasses every filesystem rule while every set comparison still passes, which is precisely why it is compared on its own rather than inferred from the path lists. | [src/batteries/sandbox/types.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L119) |\n| `mandatoryDeny` | `readonly` | { `allowGitConfig`: `boolean`; `dotGitWasDirectory?`: `boolean`; `entries`: readonly `string`\\[]; `form`: `\"glob\"` | `\"expanded-paths\"`; `searchDepth`: `number`; } | Reproduced mandatory denies, with provenance because SRT does not expose this derivation. | [src/batteries/sandbox/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L103) |\n| `mandatoryDeny.allowGitConfig` | `readonly` | `boolean` | - | [src/batteries/sandbox/types.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L106) |\n| `mandatoryDeny.dotGitWasDirectory?` | `readonly` | `boolean` | - | [src/batteries/sandbox/types.ts:108](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L108) |\n| `mandatoryDeny.entries` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L105) |\n| `mandatoryDeny.form` | `readonly` | `\"glob\"` | `\"expanded-paths\"` | - | [src/batteries/sandbox/types.ts:104](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L104) |\n| `mandatoryDeny.searchDepth` | `readonly` | `number` | - | [src/batteries/sandbox/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L107) |\n| `matcher` | `readonly` | { `caseInsensitive`: `boolean`; `platform`: `\"darwin\"` | `\"linux\"`; `readGlobs`: `\"native\"` | `\"expanded\"`; `writeGlobs`: `\"native\"` | `\"dropped\"`; } | Platform matcher; there is intentionally no `win32` arm. | [src/batteries/sandbox/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L85) |\n| `matcher.caseInsensitive` | `readonly` | `boolean` | Linux mandatory-deny files are folded; ordinary policy lists are not. | [src/batteries/sandbox/types.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L88) |\n| `matcher.platform` | `readonly` | `\"darwin\"` | `\"linux\"` | - | [src/batteries/sandbox/types.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L86) |\n| `matcher.readGlobs` | `readonly` | `\"native\"` | `\"expanded\"` | - | [src/batteries/sandbox/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L89) |\n| `matcher.writeGlobs` | `readonly` | `\"native\"` | `\"dropped\"` | - | [src/batteries/sandbox/types.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L90) |\n| `network` | `readonly` | { `allowedDomains`: readonly `string`\\[]; `deniedDomains`: readonly `string`\\[]; `disabled`: `boolean`; `strictAllowlist`: `boolean`; } | `disabled` is an ADK provenance discriminator, not an SRT field. | [src/batteries/sandbox/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L121) |\n| `network.allowedDomains` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L123) |\n| `network.deniedDomains` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L124) |\n| `network.disabled` | `readonly` | `boolean` | - | [src/batteries/sandbox/types.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L122) |\n| `network.strictAllowlist` | `readonly` | `boolean` | - | [src/batteries/sandbox/types.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L125) |\n| `read` | `readonly` | { `allowWithinDeny`: readonly `string`\\[]; `denyOnly`: readonly `string`\\[]; } | Reads are deny-then-allow; allowWithinDeny wins. | [src/batteries/sandbox/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L93) |\n| `read.allowWithinDeny` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L95) |\n| `read.denyOnly` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L94) |\n| `undecidableGlobs` | `readonly` | readonly `string`\\[] | Glob forms this derivation could not compile, distinct from pairwise undecidability. | [src/batteries/sandbox/types.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L130) |\n| `unknownKeys` | `readonly` | readonly `string`\\[] | Unknown upstream keys are drift signals and fail closed. | [src/batteries/sandbox/types.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L128) |\n| `write` | `readonly` | { `allowOnly`: readonly `string`\\[]; `denyWithinAllow`: readonly `string`\\[]; } | Writes are allow-only; denyWithinAllow wins. | [src/batteries/sandbox/types.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L98) |\n| `write.allowOnly` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L99) |\n| `write.denyWithinAllow` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L100) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/EvaluateJavascriptConfig","title":"Interface: EvaluateJavascriptConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/EvaluateJavascriptConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/EvaluateJavascriptConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/EvaluateJavascriptConfig.md\ndescription: Configuration for the JavaScript guest battery.\n---\n\n# Interface: EvaluateJavascriptConfig\n\nDefined in: [src/batteries/sandbox/js/ses\\_contracts.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L25)\n\nConfiguration for the JavaScript guest battery.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `gate` | `readonly` | (`ctx`: `unknown`, `call`: { `args`: `unknown`; `tool`: `string`; }) => `void` | `Promise`<`void`> | Required approval callback for every evaluation. **Remarks** Evaluation is a capability-bearing operation, so construction rejects its omission; invoking the gate is a real suspension and a harness with no decider waits indefinitely. | [src/batteries/sandbox/js/ses\\_contracts.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L33) |\n| `globals?` | `readonly` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`GuestGlobal`](GuestGlobal.md)>> | Named host capabilities exposed to the guest. **Remarks** These are declarations, never bare functions: functions cannot cross structured clone. Each name becomes an in-guest asynchronous stub that posts a `hostcall`, even when the host implementation itself is synchronous. | [src/batteries/sandbox/js/ses\\_contracts.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L42) |\n| `hostcallQuotas?` | `readonly` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`HostcallQuotas`](HostcallQuotas.md)> | Hostcall quotas, resolved once by the tool factory. **Remarks** Defaults are merged and floors validated; invalid values name the field, value, and bound in `E_INVALID_SANDBOX_CONFIG`. The enforcing layer receives resolved quotas rather than inventing its own defaults. | [src/batteries/sandbox/js/ses\\_contracts.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L68) |\n| `hostLockdown?` | `readonly` | `boolean` | Whether to apply lockdown to the host realm for the default in-process SES runtime. **Remarks** In Node, `lockdown()` is process-global and irreversible: it hardens the whole host realm, not only this guest. `false` is an explicit opt-out that refuses in-process evaluation; supply a worker or child runtime for guest-only isolation. | [src/batteries/sandbox/js/ses\\_contracts.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L77) |\n| `limits?` | `readonly` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`GuestLimits`](GuestLimits.md)> | Guest resource limits, resolved once by the tool factory. **Remarks** Defaults are merged and floors validated; invalid values name the field, value, and bound in `E_INVALID_SANDBOX_CONFIG`. The enforcing runtime receives the fully resolved limits and never re-derives a default. | [src/batteries/sandbox/js/ses\\_contracts.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L59) |\n| `modules?` | `readonly` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>> | Allow-listed module specifiers and their host-side values. **Remarks** Specifiers are re-checked inside the guest. Injecting a module grants the guest whatever that module can reach, and transitive import graphs are deliberately not policed. | [src/batteries/sandbox/js/ses\\_contracts.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L50) |\n| `runtime?` | `readonly` | [`GuestRuntimeLike`](GuestRuntimeLike.md) | Runtime seam used instead of the default SES runtime, typically by an adapter. | [src/batteries/sandbox/js/ses\\_contracts.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L79) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestGlobal","title":"Interface: GuestGlobal","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestGlobal.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestGlobal","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/GuestGlobal.md'\ndescription: A declared capability kept in the host runner.\n---\n\n# Interface: GuestGlobal\n\nDefined in: [src/batteries/sandbox/js/ses\\_contracts.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L4)\n\nA declared capability kept in the host runner.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cancellation` | `readonly` | `\"killable\"` | `\"cooperative\"` | `\"atomic\"` | Completion policy for an in-flight capability call. **Remarks** This is required with no default. `killable` kills its child, `cooperative` is best-effort, and `atomic` must finish before recycling; guessing `cooperative` for a capability that spawns a child is unsafe. | [src/batteries/sandbox/js/ses\\_contracts.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L22) |\n| `fn` | `readonly` | (`args`: `unknown`\\[], `signal`: `AbortSignal`) => `unknown` | Host implementation invoked by the guest-facing capability stub. **Remarks** The signal is lifecycle-scoped, not per call: expiry of `hostcallTimeoutMs` does not fire it. Arguments and results must be structured-clone/codec serialisable, and every guest call is asynchronous even when this host function is synchronous. | [src/batteries/sandbox/js/ses\\_contracts.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L13) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestHandle","title":"Interface: GuestHandle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestHandle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestHandle","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/GuestHandle.md'\ndescription: >-\n A guest evaluation handle; timeout kills and rejects rather than fabricating a\n result.\n---\n\n# Interface: GuestHandle\n\nDefined in: [src/batteries/sandbox/types.ts:208](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L208)\n\nA guest evaluation handle; timeout kills and rejects rather than fabricating a result.\n\n## Methods\n\n### evaluate()\n\n```ts\nevaluate(source: string, o: {\n timeoutMs: number;\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:210](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L210)\n\nEvaluate source with the model-visible deadline.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | ---------------------------- |\n| `source` | `string` |\n| `o` | { `timeoutMs`: `number`; } |\n| `o.timeoutMs` | `number` |\n\n#### Returns\n\n`Promise`<[`GuestOutcome`](../type-aliases/GuestOutcome.md)>\n\n***\n\n### kill()\n\n```ts\nkill(): Promise;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:212](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L212)\n\nTerminate the guest process or worker.\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestLimits","title":"Interface: GuestLimits","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestLimits.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestLimits","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/GuestLimits.md'\ndescription: >-\n Limits for a hostile guest: exactly seven fields, resolved before spawning and\n passed to both realms.\n---\n\n# Interface: GuestLimits\n\nDefined in: [src/batteries/sandbox/types.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L146)\n\nLimits for a hostile guest: exactly seven fields, resolved before spawning and passed to both realms.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `codecMaxDepth` | `number` | Codec traversal depth. Default 32; floor 4. | [src/batteries/sandbox/types.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L150) |\n| `codecMaxNodes` | `number` | Codec node count. Default 10\\_000; floor 16. | [src/batteries/sandbox/types.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L151) |\n| `logDrainMs` | `number` | Post-settlement sequence drain. Default 250ms; floor 0, where zero means do not wait. | [src/batteries/sandbox/types.ts:149](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L149) |\n| `maxHostcallBytes` | `number` | Producer-side hostcall/hostresult envelope cap. Default 1\\_000\\_000; floor 4096. | [src/batteries/sandbox/types.ts:152](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L152) |\n| `maxLogEventBytes` | `number` | Per-event UTF-8 cap. Default 8192; floor 32 leaves room for the cut marker. | [src/batteries/sandbox/types.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L147) |\n| `maxLogEvents` | `number` | Retained event count. Default 1000; floor 1 because framing consumes an event. | [src/batteries/sandbox/types.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L148) |\n| `maxTerminalPayloadBytes` | `number` | Guest terminal envelope cap. Default 10\\_000\\_000; floor 4096. | [src/batteries/sandbox/types.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L153) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntime","title":"Interface: GuestRuntime","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntime.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntime","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntime.md'\ndescription: >-\n Runtime boundary for a hardened guest realm; limits and capability\n declarations cross the boundary.\n---\n\n# Interface: GuestRuntime\n\nDefined in: [src/batteries/sandbox/contracts/guest\\_runtime.ts:6](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/guest_runtime.ts#L6)\n\nRuntime boundary for a hardened guest realm; limits and capability declarations cross the boundary.\n\n## Methods\n\n### spawn()\n\n```ts\nspawn(o: {\n globals: readonly {\n kind: \"async-fn\";\n name: string;\n }[];\n limits: GuestLimits;\n modules: string[];\n signal?: AbortSignal;\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/guest\\_runtime.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/guest_runtime.ts#L8)\n\nSpawn a guest with fully resolved hostile-realm limits and async capability stubs.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `o` | { `globals`: readonly { `kind`: `\"async-fn\"`; `name`: `string`; }\\[]; `limits`: [`GuestLimits`](GuestLimits.md); `modules`: `string`\\[]; `signal?`: `AbortSignal`; } |\n| `o.globals` | readonly { `kind`: `\"async-fn\"`; `name`: `string`; }\\[] |\n| `o.limits` | [`GuestLimits`](GuestLimits.md) |\n| `o.modules` | `string`\\[] |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<[`GuestHandle`](GuestHandle.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntimeLike","title":"Interface: GuestRuntimeLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntimeLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntimeLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/GuestRuntimeLike.md\ndescription: Minimal runtime seam used by the tool and by browser/Node adapters.\n---\n\n# Interface: GuestRuntimeLike\n\nDefined in: [src/batteries/sandbox/js/ses\\_contracts.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L82)\n\nMinimal runtime seam used by the tool and by browser/Node adapters.\n\n## Methods\n\n### spawn()\n\n```ts\nspawn(o: {\n globals: readonly {\n kind: \"async-fn\";\n name: string;\n }[];\n limits: GuestLimits;\n modules: string[];\n signal?: AbortSignal;\n}): Promise<{\n evaluate: Promise;\n kill: Promise;\n}>;\n```\n\nDefined in: [src/batteries/sandbox/js/ses\\_contracts.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/ses_contracts.ts#L90)\n\nStart an isolated guest with the declared modules, globals, limits, and lifecycle signal.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `o` | { `globals`: readonly { `kind`: `\"async-fn\"`; `name`: `string`; }\\[]; `limits`: [`GuestLimits`](GuestLimits.md); `modules`: `string`\\[]; `signal?`: `AbortSignal`; } | Fully resolved runtime inputs and the names/shapes of injected capabilities; functions themselves do not cross the boundary. |\n| `o.globals` | readonly { `kind`: `\"async-fn\"`; `name`: `string`; }\\[] | - |\n| `o.limits` | [`GuestLimits`](GuestLimits.md) | - |\n| `o.modules` | `string`\\[] | - |\n| `o.signal?` | `AbortSignal` | - |\n\n#### Returns\n\n`Promise`<{\n`evaluate`: `Promise`<[`GuestOutcome`](../type-aliases/GuestOutcome.md)>;\n`kill`: `Promise`<`void`>;\n}>\n\nA guest handle whose evaluation can be timed out and whose process can be killed.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/HostcallQuotas","title":"Interface: HostcallQuotas","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/HostcallQuotas.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/HostcallQuotas","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/HostcallQuotas.md\ndescription: 'Per-evaluation host RPC quotas, separate from the seven guest limits.'\n---\n\n# Interface: HostcallQuotas\n\nDefined in: [src/batteries/sandbox/types.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L157)\n\nPer-evaluation host RPC quotas, separate from the seven guest limits.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `hostcallTimeoutMs` | `number` | Per-call deadline in milliseconds; default 10\\_000, floor 1. | [src/batteries/sandbox/types.ts:158](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L158) |\n| `maxConcurrentHostcalls` | `number` | Simultaneous accepted calls; default 8, floor 1. | [src/batteries/sandbox/types.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L160) |\n| `maxHostcallsPerEvaluation` | `number` | Accepted calls per evaluation; default 1000, floor 1. | [src/batteries/sandbox/types.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L159) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/PathTranslator","title":"Interface: PathTranslator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/PathTranslator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/PathTranslator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/PathTranslator.md\ndescription: >-\n Model-path boundary: normalises ergonomic paths while refusing unambiguous\n host escapes.\n---\n\n# Interface: PathTranslator\n\nDefined in: [src/batteries/sandbox/contracts/path\\_translator.ts:5](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/path_translator.ts#L5)\n\nModel-path boundary: normalises ergonomic paths while refusing unambiguous host escapes.\n\n## Methods\n\n### assertNoSymlinkComponents()\n\n```ts\nassertNoSymlinkComponents(relative: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/path\\_translator.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/path_translator.ts#L13)\n\nThe translator always inspects the resolved path and every parent for symlink components.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | -------- |\n| `relative` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### redact()\n\n```ts\nredact(text: string): string;\n```\n\nDefined in: [src/batteries/sandbox/contracts/path\\_translator.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/path_translator.ts#L11)\n\nScrub root and common host identifiers from battery-generated text.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `text` | `string` |\n\n#### Returns\n\n`string`\n\n***\n\n### toBackendPath()\n\n```ts\ntoBackendPath(relative: string): string;\n```\n\nDefined in: [src/batteries/sandbox/contracts/path\\_translator.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/path_translator.ts#L9)\n\nConvert a validated relative path to an opaque backend locator.\n\n#### Parameters\n\n| Parameter | Type |\n| ---------- | -------- |\n| `relative` | `string` |\n\n#### Returns\n\n`string`\n\n***\n\n### toRelative()\n\n```ts\ntoRelative(modelPath: string): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/path\\_translator.ts:7](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/path_translator.ts#L7)\n\nValidate and convert a model path; leading separators mean the sandbox root.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | -------- |\n| `modelPath` | `string` |\n\n#### Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/PreflightOptions","title":"Interface: PreflightOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/PreflightOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/PreflightOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/PreflightOptions.md\ndescription: Inputs to the construction-time environment admission check.\n---\n\n# Interface: PreflightOptions\n\nDefined in: [src/batteries/sandbox/preflight.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L23)\n\nInputs to the construction-time environment admission check.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| -------------------------------------------------------------------------- | ---------- | --------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `allowUnsandboxedFallback?` | `readonly` | `boolean` | Explicit opt-in to run without OS containment when a pre-execution condition applies. | [src/batteries/sandbox/preflight.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L29) |\n| `enforcer` | `readonly` | [`SandboxPolicyEnforcer`](SandboxPolicyEnforcer.md) | Policy backend to admit. | [src/batteries/sandbox/preflight.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L25) |\n| `fsNodeVersion?` | `readonly` | `string` | Path redaction is performed by the observability sink, not by this admission check. | [src/batteries/sandbox/preflight.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L37) |\n| `onSandbox?` | `readonly` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) | Receives dependency warnings; warnings never make admission fail. | [src/batteries/sandbox/preflight.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L35) |\n| `optionalPeerPresent?` | `readonly` | `boolean` | Whether the optional SRT peer was resolved. Defaults to true for injected test enforcers. | [src/batteries/sandbox/preflight.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L33) |\n| `platform?` | `readonly` | `string` | Platform override, primarily for hermetic tests. | [src/batteries/sandbox/preflight.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L27) |\n| `strictMode?` | `readonly` | `boolean` | Claude Code's strict mode: per-call escape/bypass is ignored by the consumer. | [src/batteries/sandbox/preflight.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L31) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/RunShellCommandOptions","title":"Interface: RunShellCommandOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/RunShellCommandOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/RunShellCommandOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/RunShellCommandOptions.md\ndescription: Configuration for the streaming shell-command tool.\n---\n\n# Interface: RunShellCommandOptions\n\nDefined in: [src/batteries/sandbox/tool.ts:15](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L15)\n\nConfiguration for the streaming shell-command tool.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| -------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| `allowedCommands?` | `readonly` | readonly `string`\\[] | Optional command-name allow-list. | [src/batteries/sandbox/tool.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L25) |\n| `description?` | `readonly` | `string` | Optional tool description override. | [src/batteries/sandbox/tool.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L40) |\n| `env?` | `readonly` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>> | Environment variables to add to every command this tool spawns. **Remarks** ADDITIVE, and applied LAST — over both the host variables the enforcer allow-listed and SRT's own proxy/CA plumbing. It is not the host-inheritance control: the enforcer decides what the child inherits (`envAllowList` / `inheritHostEnv` on the Node adapter), and this cannot re-admit a variable the enforcer withheld except by supplying the value literally here. Anything put here is readable by the model — `run_shell_command` runs commands the model chose, and `env` is one of them — so pass configuration, not credentials. | [src/batteries/sandbox/tool.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L38) |\n| `gate?` | `readonly` | [`ToolGateFn`](../../tools/_shared/type-aliases/ToolGateFn.md) | Required human/policy approval gate. | [src/batteries/sandbox/tool.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L23) |\n| `narrate?` | `readonly` | [`SandboxNarrator`](../type-aliases/SandboxNarrator.md) | Injectable model-facing outcome renderer. | [src/batteries/sandbox/tool.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L42) |\n| `policy` | `readonly` | [`SandboxPolicy`](SandboxPolicy.md) | Policy applied to the spawned command. | [src/batteries/sandbox/tool.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L19) |\n| `sandbox` | `readonly` | [`SandboxPolicyEnforcer`](SandboxPolicyEnforcer.md) | Streaming policy enforcer; unlike BinaryExecutor this exposes live stdout/stderr. | [src/batteries/sandbox/tool.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L17) |\n| `translator` | `readonly` | [`PathTranslator`](PathTranslator.md) | Model-path translator for the working directory. | [src/batteries/sandbox/tool.ts:21](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tool.ts#L21) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxCallDefaults","title":"Interface: SandboxCallDefaults","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxCallDefaults.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxCallDefaults","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxCallDefaults.md\ndescription: >-\n Defaults visible as model-facing tool arguments; guest limits are\n intentionally separate.\n---\n\n# Interface: SandboxCallDefaults\n\nDefined in: [src/batteries/sandbox/types.ts:216](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L216)\n\nDefaults visible as model-facing tool arguments; guest limits are intentionally separate.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------------------- | -------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `evaluateTimeoutSeconds` | `number` | Default JavaScript timeout: 30 seconds. | [src/batteries/sandbox/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L219) |\n| `maxDepth` | `number` | Default traversal depth: 20. | [src/batteries/sandbox/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L217) |\n| `shellTimeoutSeconds` | `number` | Default shell timeout: 300 seconds. | [src/batteries/sandbox/types.ts:218](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L218) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxConformanceReport","title":"Interface: SandboxConformanceReport","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxConformanceReport.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxConformanceReport","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxConformanceReport.md\ndescription: >-\n Result metadata from mutation conformance, including operations that were not\n exercised.\n---\n\n# Interface: SandboxConformanceReport\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L62)\n\nResult metadata from mutation conformance, including operations that were not exercised.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------- | ---------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `skipped` | `string`\\[] | Names each skipped mutation group rather than silently presenting it as passed. | [src/batteries/sandbox/conformance/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L64) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxedExecutorOptions","title":"Interface: SandboxedExecutorOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxedExecutorOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxedExecutorOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxedExecutorOptions.md\ndescription: Configuration for the sandboxed binary executor.\n---\n\n# Interface: SandboxedExecutorOptions\n\nDefined in: [src/batteries/sandbox/executor.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L18)\n\nConfiguration for the sandboxed binary executor.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| -------------------------------------------- | ---------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `bypass?` | `readonly` | (`cmd`: `string`) => `boolean` | Command-only opt-out. This is deliberately never passed argv to the predicate. | [src/batteries/sandbox/executor.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L24) |\n| `inner` | `readonly` | [`BinaryExecutor`](../../media/contracts/interfaces/BinaryExecutor.md) | Underlying executor receiving the wrapped invocation. | [src/batteries/sandbox/executor.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L22) |\n| `onSandbox?` | `readonly` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) | Loud audit sink; bypass is observability, not enforcement. | [src/batteries/sandbox/executor.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L26) |\n| `sandbox` | `readonly` | [`BinarySandbox`](BinarySandbox.md) | Command wrapper used for non-bypassed invocations. | [src/batteries/sandbox/executor.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/executor.ts#L20) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxFileSystem","title":"Interface: SandboxFileSystem","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxFileSystem.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxFileSystem","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxFileSystem.md\ndescription: >-\n Filesystem capability with no copy primitive; traversal is complete and\n terminal-framed.\n---\n\n# Interface: SandboxFileSystem\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:6](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L6)\n\nFilesystem capability with no copy primitive; traversal is complete and terminal-framed.\n\n## Methods\n\n### delete()?\n\n```ts\noptional delete(path: string, o?: {\n signal?: AbortSignal;\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L27)\n\nDelete a path. Deletion is idempotent: deleting an absent path resolves.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------- |\n| `path` | `string` |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### list()\n\n```ts\nlist(path: string, o: {\n maxDepth: number;\n signal?: AbortSignal;\n}): AsyncIterable;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L17)\n\nLazily yield every item, followed by exactly one mandatory done frame.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------ | ----------------------------------------------------- |\n| `path` | `string` |\n| `o` | { `maxDepth`: `number`; `signal?`: `AbortSignal`; } |\n| `o.maxDepth` | `number` |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`AsyncIterable`<[`ListFrame`](../type-aliases/ListFrame.md)>\n\n***\n\n### mkdir()?\n\n```ts\noptional mkdir(path: string, o?: {\n signal?: AbortSignal;\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L34)\n\nCreate a directory.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------- |\n| `path` | `string` |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### read()\n\n```ts\nread(path: string, o?: {\n signal?: AbortSignal;\n}): Promise>>;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L19)\n\nOpen a fresh, replayable byte stream; non-regular kinds are refused by adapters.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------- |\n| `path` | `string` |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>>\n\n***\n\n### rename()?\n\n```ts\noptional rename(\n from: string,\n to: string,\n o?: {\n signal?: AbortSignal;\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L32)\n\nMove a path. MUST overwrite an existing destination (POSIX move semantics).\nDev-tools relies on this behaviour when breaking rename cycles.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------- |\n| `from` | `string` |\n| `to` | `string` |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### stat()\n\n```ts\nstat(path: string): Promise<{\n dev?: number;\n ino?: number;\n kind: \"other\" | \"file\" | \"dir\" | \"symlink\";\n mtimeMs?: number;\n size: number;\n version: string;\n}>;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L8)\n\nReturn metadata. A changed version token is evidence of change; equality is not a no-change guarantee.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `path` | `string` |\n\n#### Returns\n\n`Promise`<{\n`dev?`: `number`;\n`ino?`: `number`;\n`kind`: `\"other\"` | `\"file\"` | `\"dir\"` | `\"symlink\"`;\n`mtimeMs?`: `number`;\n`size`: `number`;\n`version`: `string`;\n}>\n\n***\n\n### write()\n\n```ts\nwrite(\n path: string,\n bytes:\n | Uint8Array\n | ReadableStream>,\n o?: {\n signal?: AbortSignal;\n}): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:21](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L21)\n\nWrite bytes without imposing a battery-level size cap.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | --------------------------------------------------------------------------------------------- |\n| `path` | `string` |\n| `bytes` | | `Uint8Array`<`ArrayBufferLike`> | `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>> |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxHandle","title":"Interface: SandboxHandle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxHandle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxHandle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxHandle.md\ndescription: 'A live sandbox session: the object every sandbox tool is built against.'\n---\n\n# Interface: SandboxHandle\n\nDefined in: [src/batteries/sandbox/manager.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L28)\n\nA live sandbox session: the object every sandbox tool is built against.\n\n## Remarks\n\nTHIS IS A PROCESS-GLOBAL CAPABILITY WEARING A PER-HANDLE API, and the shape is a promise narrowed\nrather than a promise kept. `SandboxManager` is a singleton, so the first `createSandbox()` in a\nprocess establishes the policy and a later one may only NARROW it — a request that is not a subset\nthrows `E_SANDBOX_POLICY_CONFLICT` naming both. One policy per process is the safe deployment;\nmulti-tenant agents with different policies want separate processes.\n\nEvery `run()` re-validates against the admission baseline before spawning, so a widening of the live\npolicy is DETECTED. Detection is not prevention: SRT's proxies consult policy per request, so a\nwidening already affects an in-flight child for its whole lifetime.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------------- | ---------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `effectivePolicy` | `readonly` | () => [`DerivedRules`](DerivedRules.md) | `undefined` | The live DERIVED rules — not the `SandboxPolicy` that was requested. **Remarks** A policy cannot express what the drift check has to compare (`denyOnly`/`allowWithinDeny`, the unioned default write paths, Linux-expanded read globs, the profile-only mandatory denies), so returning one here would compare the wrong thing and pass while the live sandbox had widened. Under ADOPTION this re-derives from the live manager on every call; an owned session is cached. | [src/batteries/sandbox/manager.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L46) |\n| `epoch` | `readonly` | [`SandboxEpoch`](../classes/SandboxEpoch.md) | Opaque token issued at construction and invalidated by [SandboxHandle.dispose](#dispose). **Remarks** File-backed readers hold this rather than a filesystem reference, which is what makes disposal deterministic: a staged reader outliving its TURN is legitimate, outliving its HANDLE is not. | [src/batteries/sandbox/manager.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L36) |\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/sandbox/manager.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L76)\n\nQuiesce the session: it does not abandon in-flight work.\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\nRejects new work with `E_SANDBOX_NOT_INITIALIZED`, aborts in-flight invocations through their\nsignals, kills spawned children, then releases the enforcer. On an ADOPTED session this is a\nreported NO-OP — resetting a manager we did not create would strip ACEs a host application\ndepends on.\n\n***\n\n### isEpochLive()\n\n```ts\nisEpochLive(epoch: SandboxEpoch): boolean;\n```\n\nDefined in: [src/batteries/sandbox/manager.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L66)\n\nPredicate consumed by file-backed readers; disposal makes the epoch unusable.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------- |\n| `epoch` | [`SandboxEpoch`](../classes/SandboxEpoch.md) |\n\n#### Returns\n\n`boolean`\n\n***\n\n### narrow()\n\n```ts\nnarrow(policy: SandboxPolicy): Promise;\n```\n\nDefined in: [src/batteries/sandbox/manager.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L64)\n\nNarrow the session policy for subsequent operations.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `policy` | [`SandboxPolicy`](SandboxPolicy.md) | Must be a subset per the per-axis rules; reads are deny-then-allow while writes are allow-only, so \"narrower\" is not symmetric. Throws `E_SANDBOX_NARROWING_UNSUPPORTED` naming the axis where the platform cannot narrow it. |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### run()\n\n```ts\nrun(options: {\n argv: string[];\n correlationId: string;\n cwd: string;\n env?: Record;\n policy: SandboxPolicy;\n signal?: AbortSignal;\n}): Promise<{\n completed: Promise<{\n exitCode: number;\n failed: boolean;\n }>;\n stderr: ReadableStream>;\n stdout: ReadableStream>;\n}>;\n```\n\nDefined in: [src/batteries/sandbox/manager.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/manager.ts#L56)\n\nSpawn under this session's policy, optionally narrowed for the single invocation.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `options` | { `argv`: `string`\\[]; `correlationId`: `string`; `cwd`: `string`; `env?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>; `policy`: [`SandboxPolicy`](SandboxPolicy.md); `signal?`: `AbortSignal`; } | - |\n| `options.argv` | `string`\\[] | - |\n| `options.correlationId` | `string` | - |\n| `options.cwd` | `string` | - |\n| `options.env?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | An ADDITIVE per-call overlay on the child's environment, applied LAST. **Remarks** NOT the host-inheritance control. What a child inherits from the host is the ADAPTER's decision (the Node/SRT one denies by default and takes an allow-list at construction); this field only adds to whatever that produced, and an adapter MUST NOT let it silently widen what the deployment allowed. Leaving these semantics unstated is how the Node adapter came to spread the entire `process.env` into every child while this field sat unused. |\n| `options.policy` | [`SandboxPolicy`](SandboxPolicy.md) | - |\n| `options.signal?` | `AbortSignal` | Lifecycle cancellation for this child. Implementations must kill the spawned child and settle `completed` when this signal aborts. |\n\n#### Returns\n\n`Promise`<{\n`completed`: `Promise`<{\n`exitCode`: `number`;\n`failed`: `boolean`;\n}>;\n`stderr`: `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>;\n`stdout`: `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>;\n}>\n\n#### Remarks\n\nResolves as soon as the child is SPAWNED, handing back live `stdout`/`stderr` streams plus a\nseparate `completed` promise. Drain BOTH concurrently: pipe buffers are per-fd, so draining one to\ncompletion first can block the other and hang the child. A non-zero exit is data on `completed`,\nnever a rejection.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaOptions","title":"Interface: SandboxMediaOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaOptions.md\ndescription: 'Arguments for [`createSandboxMedia`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMedia).'\n---\n\n# Interface: SandboxMediaOptions\n\nDefined in: [src/batteries/sandbox/media\\_reader.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L64)\n\nArguments for [createSandboxMedia](../functions/createSandboxMedia.md).\n\n## Extends\n\n* [`SandboxMediaReaderOptions`](SandboxMediaReaderOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ----------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `epoch` | [`SandboxEpoch`](../classes/SandboxEpoch.md) | The epoch held by the sandbox handle when this reader was issued. | [`SandboxMediaReaderOptions`](SandboxMediaReaderOptions.md).[`epoch`](SandboxMediaReaderOptions.md#property-epoch) | [src/batteries/sandbox/media\\_reader.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L17) |\n| `filename` | `string` | Model-visible source filename. | - | [src/batteries/sandbox/media\\_reader.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L70) |\n| `fileSystem` | [`SandboxFileSystem`](SandboxFileSystem.md) | The filesystem capability belonging to the sandbox handle. | [`SandboxMediaReaderOptions`](SandboxMediaReaderOptions.md).[`fileSystem`](SandboxMediaReaderOptions.md#property-filesystem) | [src/batteries/sandbox/media\\_reader.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L13) |\n| `isEpochLive` | [`SandboxEpochIsLive`](../type-aliases/SandboxEpochIsLive.md) | Predicate owned by the sandbox manager; this reader never issues or invalidates epochs. | [`SandboxMediaReaderOptions`](SandboxMediaReaderOptions.md).[`isEpochLive`](SandboxMediaReaderOptions.md#property-isepochlive) | [src/batteries/sandbox/media\\_reader.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L19) |\n| `kind` | `\"document\"` | `\"audio\"` | `\"image\"` | `\"video\"` | Media modality assigned by the stage operation. | - | [src/batteries/sandbox/media\\_reader.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L66) |\n| `mimeType` | `string` | MIME type resolved by the stage operation. | - | [src/batteries/sandbox/media\\_reader.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L68) |\n| `path` | `string` | The already translated backend path. | [`SandboxMediaReaderOptions`](SandboxMediaReaderOptions.md).[`path`](SandboxMediaReaderOptions.md#property-path) | [src/batteries/sandbox/media\\_reader.ts:15](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L15) |\n| `source?` | `string` | Optional provenance label retained on the Media value. | - | [src/batteries/sandbox/media\\_reader.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L74) |\n| `trustTier` | `\"first-party\"` | `\"third-party-public\"` | `\"third-party-private\"` | Configuration-supplied provenance tier. | - | [src/batteries/sandbox/media\\_reader.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L72) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaReaderOptions","title":"Interface: SandboxMediaReaderOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaReaderOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaReaderOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxMediaReaderOptions.md\ndescription: 'Arguments for [`createSandboxMediaReader`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/functions/createSandboxMediaReader).'\n---\n\n# Interface: SandboxMediaReaderOptions\n\nDefined in: [src/batteries/sandbox/media\\_reader.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L11)\n\nArguments for [createSandboxMediaReader](../functions/createSandboxMediaReader.md).\n\n## Extended by\n\n* [`SandboxMediaOptions`](SandboxMediaOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `epoch` | [`SandboxEpoch`](../classes/SandboxEpoch.md) | The epoch held by the sandbox handle when this reader was issued. | [src/batteries/sandbox/media\\_reader.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L17) |\n| `fileSystem` | [`SandboxFileSystem`](SandboxFileSystem.md) | The filesystem capability belonging to the sandbox handle. | [src/batteries/sandbox/media\\_reader.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L13) |\n| `isEpochLive` | [`SandboxEpochIsLive`](../type-aliases/SandboxEpochIsLive.md) | Predicate owned by the sandbox manager; this reader never issues or invalidates epochs. | [src/batteries/sandbox/media\\_reader.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L19) |\n| `path` | `string` | The already translated backend path. | [src/batteries/sandbox/media\\_reader.ts:15](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L15) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxObservabilityOptions","title":"Interface: SandboxObservabilityOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxObservabilityOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxObservabilityOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxObservabilityOptions.md\ndescription: Dependencies used to create the redacting firehose.\n---\n\n# Interface: SandboxObservabilityOptions\n\nDefined in: [src/batteries/sandbox/observability.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L43)\n\nDependencies used to create the redacting firehose.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------------- | ---------- | --------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `pathTranslator` | `readonly` | [`PathTranslator`](PathTranslator.md) | Translator used for every path-bearing event field. | [src/batteries/sandbox/observability.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L45) |\n| `sink` | `readonly` | [`SandboxEventSink`](../type-aliases/SandboxEventSink.md) | Destination for already-redacted events. | [src/batteries/sandbox/observability.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L47) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicy","title":"Interface: SandboxPolicy","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicy.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicy","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicy.md\ndescription: >-\n Assembly-facing policy. Reads allow by default; writes and network deny by\n default.\n---\n\n# Interface: SandboxPolicy\n\nDefined in: [src/batteries/sandbox/types.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L50)\n\nAssembly-facing policy. Reads allow by default; writes and network deny by default.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `filesystem` | `readonly` | { `allowGitConfig?`: `boolean`; `allowRead?`: readonly `string`\\[]; `allowWrite?`: readonly `string`\\[]; `denyRead?`: readonly `string`\\[]; `denyWrite?`: readonly `string`\\[]; `disabled?`: `boolean`; `gitSafeDirectories?`: readonly `string`\\[]; `mandatoryDenySearchDepth?`: `number`; } | Filesystem rules; `disabled` is a kill switch and deliberately does not unify axis defaults. | [src/batteries/sandbox/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L52) |\n| `filesystem.allowGitConfig?` | `readonly` | `boolean` | Whether `.git/config` is included in the mandatory deny set. | [src/batteries/sandbox/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L58) |\n| `filesystem.allowRead?` | `readonly` | readonly `string`\\[] | Read rules use deny-then-allow precedence. | [src/batteries/sandbox/types.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L54) |\n| `filesystem.allowWrite?` | `readonly` | readonly `string`\\[] | Write rules use allow-only semantics; deny wins inside the allow list. | [src/batteries/sandbox/types.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L56) |\n| `filesystem.denyRead?` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L55) |\n| `filesystem.denyWrite?` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L57) |\n| `filesystem.disabled?` | `readonly` | `boolean` | When true, no filesystem rules apply. | [src/batteries/sandbox/types.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L53) |\n| `filesystem.gitSafeDirectories?` | `readonly` | readonly `string`\\[] | Git safe directories passed to spawned children. | [src/batteries/sandbox/types.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L59) |\n| `filesystem.mandatoryDenySearchDepth?` | `readonly` | `number` | Linux mandatory-deny scan depth. | [src/batteries/sandbox/types.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L60) |\n| `network` | `readonly` | { `allowedDomains?`: readonly `string`\\[]; `deniedDomainReasons?`: [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>>; `deniedDomains?`: readonly `string`\\[]; `disabled?`: `boolean`; } | Network rules. An absent allow list means deny all unless disabled. **Remarks** `disabled` means that SRT's network configuration key is omitted entirely. SRT decides whether to create a network namespace from the presence of that key; its `NetworkConfigSchema` has no schema-valid allow-all domain pattern (`\"*\"` is explicitly rejected). Consequently disabled means no network namespace restriction, rather than an allow-all domain entry. | [src/batteries/sandbox/types.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L71) |\n| `network.allowedDomains?` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L74) |\n| `network.deniedDomainReasons?` | `readonly` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>> | Model-readable reasons for denied domains. | [src/batteries/sandbox/types.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L76) |\n| `network.deniedDomains?` | `readonly` | readonly `string`\\[] | - | [src/batteries/sandbox/types.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L75) |\n| `network.disabled?` | `readonly` | `boolean` | Omit SRT's network key, avoiding `--unshare-net`, when true. | [src/batteries/sandbox/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L73) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicyEnforcer","title":"Interface: SandboxPolicyEnforcer","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicyEnforcer.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicyEnforcer","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicyEnforcer.md\ndescription: >-\n Policy boundary. `run` resolves on spawn and exposes live streams plus a later\n completion promise.\n---\n\n# Interface: SandboxPolicyEnforcer\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:6](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L6)\n\nPolicy boundary. `run` resolves on spawn and exposes live streams plus a later completion promise.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ---------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `adopted?` | `readonly` | `boolean` | Whether this adapter adopted an already-enabled process-global sandbox rather than initializing it. | [src/batteries/sandbox/contracts/policy\\_enforcer.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L10) |\n\n## Methods\n\n### checkDependencies()\n\n```ts\ncheckDependencies(): Promise<{\n errors: string[];\n warnings: string[];\n}>;\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L12)\n\nProbe external prerequisites. A non-empty `errors` throws `E_SANDBOX_DEPENDENCY_MISSING`; `warnings` are surfaced through observability and are NOT fatal.\n\n#### Returns\n\n`Promise`<{\n`errors`: `string`\\[];\n`warnings`: `string`\\[];\n}>\n\n***\n\n### diagnosticsFor()\n\n```ts\ndiagnosticsFor(correlationId: string): string[];\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L51)\n\nRetrieve diagnostics by correlation id, never by command text.\n\n#### Parameters\n\n| Parameter | Type |\n| --------------- | -------- |\n| `correlationId` | `string` |\n\n#### Returns\n\n`string`\\[]\n\n***\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L53)\n\nRelease what this enforcer OWNS. A no-op when it adopted a foreign sandbox — tearing down a manager we did not initialize would strip ACEs a host app depends on.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### effectivePolicy()\n\n```ts\neffectivePolicy(): DerivedRules | undefined;\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L49)\n\nReturn the opaque derived snapshot used for drift validation.\n\n#### Returns\n\n[`DerivedRules`](DerivedRules.md) | `undefined`\n\n***\n\n### isSupported()\n\n```ts\nisSupported(): boolean;\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L8)\n\nWhether this enforcer can enforce on the current platform. `false` (a browser tab, where SRT does not exist) raises `E_SANDBOX_UNSUPPORTED_ENV` at construction rather than degrading — a shim that enforces nothing reads as sandboxed.\n\n#### Returns\n\n`boolean`\n\n***\n\n### run()\n\n```ts\nrun(op: {\n argv: string[];\n correlationId: string;\n cwd: string;\n env?: Record;\n policy: SandboxPolicy;\n signal?: AbortSignal;\n}): Promise<{\n completed: Promise<{\n exitCode: number;\n failed: boolean;\n }>;\n stderr: ReadableStream>;\n stdout: ReadableStream>;\n}>;\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L22)\n\nSpawn under a narrowing policy; a non-zero exit is data, not a rejected promise.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `op` | { `argv`: `string`\\[]; `correlationId`: `string`; `cwd`: `string`; `env?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>; `policy`: [`SandboxPolicy`](SandboxPolicy.md); `signal?`: `AbortSignal`; } | - |\n| `op.argv` | `string`\\[] | - |\n| `op.correlationId` | `string` | - |\n| `op.cwd` | `string` | - |\n| `op.env?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | An ADDITIVE per-call overlay on the child's environment, applied LAST. **Remarks** NOT the host-inheritance control. What a child inherits from the host is the ADAPTER's decision (the Node/SRT one denies by default and takes an allow-list at construction); this field only adds to whatever that produced, and an adapter MUST NOT let it silently widen what the deployment allowed. Leaving these semantics unstated is how the Node adapter came to spread the entire `process.env` into every child while this field sat unused. |\n| `op.policy` | [`SandboxPolicy`](SandboxPolicy.md) | - |\n| `op.signal?` | `AbortSignal` | Lifecycle cancellation for this child. Implementations must kill the spawned child and settle `completed` when this signal aborts. |\n\n#### Returns\n\n`Promise`<{\n`completed`: `Promise`<{\n`exitCode`: `number`;\n`failed`: `boolean`;\n}>;\n`stderr`: `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>;\n`stdout`: `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>;\n}>\n\n#### Remarks\n\nWhen `op.signal` aborts, an implementation MUST terminate the spawned child (including a\nchild hidden behind a sandbox wrapper) and settle `completed`; it MUST NOT leave the child\nrunning after the lifecycle owner has cancelled the invocation. The returned streams may end\nas a consequence of termination, but `completed` remains the authoritative settlement signal.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPreflight","title":"Interface: SandboxPreflight","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPreflight.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPreflight","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPreflight.md\ndescription: Immutable decision retained by a sandbox handle for its entire lifetime.\n---\n\n# Interface: SandboxPreflight\n\nDefined in: [src/batteries/sandbox/preflight.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L41)\n\nImmutable decision retained by a sandbox handle for its entire lifetime.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `allowUnsandboxedFallback` | `readonly` | `boolean` | Whether the construction opted into fallback. | [src/batteries/sandbox/preflight.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L43) |\n| `dependencyWarnings` | `readonly` | readonly `string`\\[] | Non-fatal dependency diagnostics. | [src/batteries/sandbox/preflight.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L49) |\n| `fallbackFired` | `readonly` | `boolean` | Whether one of the permitted pre-execution conditions fired. | [src/batteries/sandbox/preflight.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L45) |\n| `fsNodeVersion?` | `readonly` | `string` | Version provenance for fs\\_node, when supplied by the backend. | [src/batteries/sandbox/preflight.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L51) |\n| `strictMode` | `readonly` | `boolean` | Whether per-call bypasses must be ignored. | [src/batteries/sandbox/preflight.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L47) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxSearch","title":"Interface: SandboxSearch","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxSearch.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxSearch","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxSearch.md\ndescription: 'Search capability; every result is lazy, complete, and terminal-framed.'\n---\n\n# Interface: SandboxSearch\n\nDefined in: [src/batteries/sandbox/contracts/search.ts:6](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/search.ts#L6)\n\nSearch capability; every result is lazy, complete, and terminal-framed.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------------ | ---------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `supportsFollow?` | `readonly` | `boolean` | Whether this adapter can CONTAIN symlinked descendants when `follow` is enabled. `rg --follow` traverses links whose targets never pass through the path translator, so an uncontained backend turns `follow: true` into an unbounded read of wherever they point. The tools layer cannot inspect what is behind this interface, so an adapter declares it: omitted or `false` means the forged `search_files`/`find_files` schemas REJECT `follow: true` outright rather than accepting it and failing at execution. Set it only if you have verified containment; the bundled ripgrep adapter has not, and does not set it. | [src/batteries/sandbox/contracts/search.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/search.ts#L17) |\n\n## Methods\n\n### findPaths()\n\n```ts\nfindPaths(o: {\n follow?: boolean;\n glob: string;\n hidden?: boolean;\n iglob?: string;\n limit: number;\n maxDepth: number;\n noIgnore?: boolean;\n root: string;\n signal?: AbortSignal;\n}): AsyncIterable;\n```\n\nDefined in: [src/batteries/sandbox/contracts/search.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/search.ts#L35)\n\nLazily yield every matching path, then one done frame.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| `o` | { `follow?`: `boolean`; `glob`: `string`; `hidden?`: `boolean`; `iglob?`: `string`; `limit`: `number`; `maxDepth`: `number`; `noIgnore?`: `boolean`; `root`: `string`; `signal?`: `AbortSignal`; } | - |\n| `o.follow?` | `boolean` | - |\n| `o.glob` | `string` | - |\n| `o.hidden?` | `boolean` | - |\n| `o.iglob?` | `string` | - |\n| `o.limit` | `number` | Maximum results to yield. MUST be an integer >= 1; adapters reject anything else. |\n| `o.maxDepth` | `number` | - |\n| `o.noIgnore?` | `boolean` | - |\n| `o.root` | `string` | - |\n| `o.signal?` | `AbortSignal` | - |\n\n#### Returns\n\n`AsyncIterable`<[`PathFrame`](../type-aliases/PathFrame.md)>\n\n***\n\n### searchContent()\n\n```ts\nsearchContent(o: {\n follow?: boolean;\n glob?: string;\n hidden?: boolean;\n iglob?: string;\n ignoreCase?: boolean;\n limit: number;\n literal?: boolean;\n maxDepth: number;\n noIgnore?: boolean;\n pattern: string;\n root: string;\n signal?: AbortSignal;\n}): AsyncIterable;\n```\n\nDefined in: [src/batteries/sandbox/contracts/search.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/search.ts#L19)\n\nLazily yield every whole matching line, then one done frame.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| `o` | { `follow?`: `boolean`; `glob?`: `string`; `hidden?`: `boolean`; `iglob?`: `string`; `ignoreCase?`: `boolean`; `limit`: `number`; `literal?`: `boolean`; `maxDepth`: `number`; `noIgnore?`: `boolean`; `pattern`: `string`; `root`: `string`; `signal?`: `AbortSignal`; } | - |\n| `o.follow?` | `boolean` | - |\n| `o.glob?` | `string` | - |\n| `o.hidden?` | `boolean` | - |\n| `o.iglob?` | `string` | - |\n| `o.ignoreCase?` | `boolean` | - |\n| `o.limit` | `number` | Maximum results to yield. MUST be an integer >= 1; adapters reject anything else. |\n| `o.literal?` | `boolean` | - |\n| `o.maxDepth` | `number` | - |\n| `o.noIgnore?` | `boolean` | - |\n| `o.pattern` | `string` | - |\n| `o.root` | `string` | - |\n| `o.signal?` | `AbortSignal` | - |\n\n#### Returns\n\n`AsyncIterable`<[`HitFrame`](../type-aliases/HitFrame.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools","title":"@nhtio/adk/batteries/sandbox/tools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/tools.md'\n---\n\n# @nhtio/adk/batteries/sandbox/tools\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------- | ------------------------------------------------------------------------ |\n| [SandboxToolsOptions](interfaces/SandboxToolsOptions.md) | Options for constructing the sandbox's eight untrusted filesystem tools. |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |\n| [forgeSandboxTools](variables/forgeSandboxTools.md) | Alias for [createSandboxTools](functions/createSandboxTools.md), used by tool-forging integrations. |\n| [sandboxToolDescriptions](variables/sandboxToolDescriptions.md) | Human-readable descriptions shared by the sandbox's workspace tools. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------- | ------------------------------------------------------------------- |\n| [createSandboxTools](functions/createSandboxTools.md) | Construct the sandbox's file, media, directory, and search tools. |\n| [narratingPath](functions/narratingPath.md) | Run a `PathTranslator` operation and narrate any refusal it raises. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/functions/createSandboxTools","title":"Function: createSandboxTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/functions/createSandboxTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/functions/createSandboxTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/tools/functions/createSandboxTools.md\n---\n\n# Function: createSandboxTools()\n\n```ts\nfunction createSandboxTools(\n options: SandboxToolsOptions,\n): Promise[]>;\n```\n\nDefined in: [src/batteries/sandbox/tools/index.ts:293](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L293)\n\nConstruct the sandbox's file, media, directory, and search tools.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------- | -------------------------------------------------------- |\n| `options` | [`SandboxToolsOptions`](../interfaces/SandboxToolsOptions.md) | Capabilities and configuration for the sandbox tool set. |\n\n## Returns\n\n`Promise`<[`Tool`](../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)>\\[]>\n\nThe eight tools registered for a sandbox handle.\n\n## Remarks\n\nAll returned tools are untrusted and gate their operations, including reads. The factory\nkeeps the supplied handle, filesystem, path translator, search backend, and configuration\ntogether so the tools cannot accidentally bypass the sandbox boundary.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/functions/narratingPath","title":"Function: narratingPath()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/functions/narratingPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/functions/narratingPath","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/tools/functions/narratingPath.md\n---\n\n# Function: narratingPath()\n\n```ts\nfunction narratingPath(\n operation: () => T | Promise,\n input: string,\n): Promise;\n```\n\nDefined in: [src/batteries/sandbox/tools/index.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L132)\n\nRun a `PathTranslator` operation and narrate any refusal it raises.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `T` |\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | ----------------------------- | ---------------------------------------------------- |\n| `operation` | () => `T` | `Promise`<`T`> | The translator call. |\n| `input` | `string` | The model-supplied path, echoed back in the outcome. |\n\n## Returns\n\n`Promise`<`T`>\n\nThe operation's result.\n\n## Remarks\n\nEVERY translator call must go through here, not just the obvious `toRelative`. `toBackendPath` and\n`assertNoSymlinkComponents` both reject — the latter is the symlinked-component refusal, which is a\nsecurity control — and a bare call lets that escape as the translator's native error, bypassing the\nnarrator seam the whole battery depends on. The model then receives an unactionable message for the\none class of failure it could actually correct.\n\nAn already-narrated exception passes through untouched, so wrapping a call that itself narrates is\nsafe and the outcome is never rendered twice.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/interfaces/SandboxToolsOptions","title":"Interface: SandboxToolsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/interfaces/SandboxToolsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/interfaces/SandboxToolsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/tools/interfaces/SandboxToolsOptions.md\ndescription: Options for constructing the sandbox's eight untrusted filesystem tools.\n---\n\n# Interface: SandboxToolsOptions\n\nDefined in: [src/batteries/sandbox/tools/index.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L37)\n\nOptions for constructing the sandbox's eight untrusted filesystem tools.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `artifactMinter?` | [`ArtifactMinter`](../../interfaces/ArtifactMinter.md) | Factory for artifacts returned by file-query tools; defaults to the battery minter. | [src/batteries/sandbox/tools/index.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L70) |\n| `fileSystem` | [`SandboxFileSystem`](../../interfaces/SandboxFileSystem.md) | The filesystem capability used for stat, traversal, reads, and writes. | [src/batteries/sandbox/tools/index.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L48) |\n| `gate` | `Gate` | Required approval callback for every tool, including reads and searches. **Remarks** A read of `.env` is an exfiltration event, and `search_files` is a secret-discovery primitive, so construction rejects a missing gate with `E_SANDBOX_GATE_REQUIRED`. Calling the gate is a real suspension: a harness without a decider leaves the turn waiting rather than silently allowing the operation. | [src/batteries/sandbox/tools/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L60) |\n| `handle` | [`SandboxHandle`](../../interfaces/SandboxHandle.md) | The handle that owns this tool set and issues its reader epoch. **Remarks** File-backed readers retain this epoch and check it before every operation. After [SandboxHandle.dispose](../../interfaces/SandboxHandle.md#dispose) they fail with `E_SANDBOX_NOT_INITIALIZED` rather than falling through to the host filesystem. | [src/batteries/sandbox/tools/index.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L46) |\n| `mimeResolver?` | [`MimeResolver`](../../type-aliases/MimeResolver.md) | Resolves MIME types while staging a file; defaults to the extension resolver. | [src/batteries/sandbox/tools/index.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L72) |\n| `pathTranslator` | [`PathTranslator`](../../interfaces/PathTranslator.md) | Translates model-visible paths into the sandbox backend and back. | [src/batteries/sandbox/tools/index.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L50) |\n| `registeredTools?` | readonly `string`\\[] | Tools which are not registered are not named in descriptions. | [src/batteries/sandbox/tools/index.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L84) |\n| `search?` | [`SandboxSearch`](../../interfaces/SandboxSearch.md) | Search backend for `search_files` and `find_files`. **Remarks** These tools spawn `rg` through the sandbox enforcer and are OS-enforced; they do not have the in-process filesystem tools' weaker enforcement boundary. | [src/batteries/sandbox/tools/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L68) |\n| `trustTier` | `\"first-party\"` | `\"third-party-public\"` | `\"third-party-private\"` | Configuration-supplied provenance for staged media. **Remarks** This value cannot be inferred from `source`: core requires an explicit trust tier and batteries must not auto-classify content. | [src/batteries/sandbox/tools/index.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L82) |\n| `writeRoot` | `string` | Explicit host write root; it is never inferred. | [src/batteries/sandbox/tools/index.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L74) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/variables/forgeSandboxTools","title":"Variable: forgeSandboxTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/variables/forgeSandboxTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/variables/forgeSandboxTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/tools/variables/forgeSandboxTools.md\ndescription: 'Alias for [`createSandboxTools`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/tools/functions/createSandboxTools), used by tool-forging integrations.'\n---\n\n# Variable: forgeSandboxTools\n\n```ts\nconst forgeSandboxTools: (\n options: SandboxToolsOptions,\n) => Promise[]> = createSandboxTools;\n```\n\nDefined in: [src/batteries/sandbox/tools/index.ts:681](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L681)\n\nAlias for [createSandboxTools](../functions/createSandboxTools.md), used by tool-forging integrations.\n\nConstruct the sandbox's file, media, directory, and search tools.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------- | -------------------------------------------------------- |\n| `options` | [`SandboxToolsOptions`](../interfaces/SandboxToolsOptions.md) | Capabilities and configuration for the sandbox tool set. |\n\n## Returns\n\n`Promise`<[`Tool`](../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)>\\[]>\n\nThe eight tools registered for a sandbox handle.\n\n## Remarks\n\nAll returned tools are untrusted and gate their operations, including reads. The factory\nkeeps the supplied handle, filesystem, path translator, search backend, and configuration\ntogether so the tools cannot accidentally bypass the sandbox boundary.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/variables/sandboxToolDescriptions","title":"Variable: sandboxToolDescriptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/variables/sandboxToolDescriptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/tools/variables/sandboxToolDescriptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/tools/variables/sandboxToolDescriptions.md\ndescription: Human-readable descriptions shared by the sandbox's workspace tools.\n---\n\n# Variable: sandboxToolDescriptions\n\n```ts\nconst sandboxToolDescriptions: {\n open: string;\n save: string;\n stage: string;\n};\n```\n\nDefined in: [src/batteries/sandbox/tools/index.ts:276](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L276)\n\nHuman-readable descriptions shared by the sandbox's workspace tools.\n\n## Type Declaration\n\n| Name | Type | Default value | Defined in |\n| ----------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `open` | `string` | `'Read a file from disk into the turn to query, not to change. Use artifact_* tools; use stage_file to change it.'` | [src/batteries/sandbox/tools/index.ts:277](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L277) |\n| `save` | `string` | `'Write to a file on disk: save bytes already in this turn, produced by media verbs; you cannot author content here. This overwrites and makes a stage_file edit real.'` | [src/batteries/sandbox/tools/index.ts:280](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L280) |\n| `stage` | `string` | `'Change a file: use stage_file, then media verbs and save_media; mutations are in memory until saved. Use open_file to read or grep first; no artifact_* tools attach.'` | [src/batteries/sandbox/tools/index.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/tools/index.ts#L278) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ArtifactFormat","title":"Type Alias: ArtifactFormat","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ArtifactFormat.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ArtifactFormat","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/ArtifactFormat.md\ndescription: A format declaration accepted by the default minter.\n---\n\n# Type Alias: ArtifactFormat\n\n```ts\ntype ArtifactFormat = {\n ctor: () => Promise;\n extensions: string[];\n id: string;\n mime: string[];\n};\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L8)\n\nA format declaration accepted by the default minter.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | ---------------------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `ctor` | () => `Promise`<`unknown`> | Lazy constructor loader; it is called only after the format is selected. | [src/batteries/sandbox/defaults/default\\_minter.ts:16](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L16) |\n| `extensions` | `string`\\[] | Filename extensions handled by the format. | [src/batteries/sandbox/defaults/default\\_minter.ts:14](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L14) |\n| `id` | `string` | Stable identifier for the format. | [src/batteries/sandbox/defaults/default\\_minter.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L10) |\n| `mime` | `string`\\[] | MIME types handled by the format. | [src/batteries/sandbox/defaults/default\\_minter.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L12) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/Done","title":"Type Alias: Done","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/Done.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/Done","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/Done.md'\ndescription: >-\n Terminal traversal protocol. Done is mandatory so end-of-stream cannot\n masquerade as completion.\n---\n\n# Type Alias: Done\n\n```ts\ntype Done =\n | {\n complete: true;\n kind: \"done\";\n }\n | {\n atDepth: number;\n bound: \"maxDepth\";\n complete: false;\n kind: \"done\";\n omitted: \"unexplored\";\n }\n | {\n bound: \"limit\";\n complete: false;\n kind: \"done\";\n omitted: \"over-limit\";\n shown: number;\n };\n```\n\nDefined in: [src/batteries/sandbox/types.ts:134](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L134)\n\nTerminal traversal protocol. Done is mandatory so end-of-stream cannot masquerade as completion.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/FramedSource","title":"Type Alias: FramedSource\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/FramedSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/FramedSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/FramedSource.md\ndescription: A framed adapter surface exercised by the shared protocol battery.\n---\n\n# Type Alias: FramedSource\\\n\n```ts\ntype FramedSource = (\n signal?: AbortSignal,\n onStart?: () => void,\n) => AsyncIterable;\n```\n\nDefined in: [src/batteries/sandbox/conformance/index.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/conformance/index.ts#L4)\n\nA framed adapter surface exercised by the shared protocol battery.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `T` |\n\n## Parameters\n\n| Parameter | Type |\n| ---------- | ------------- |\n| `signal?` | `AbortSignal` |\n| `onStart?` | () => `void` |\n\n## Returns\n\n`AsyncIterable`<`T`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogEvent","title":"Type Alias: GuestLogEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogEvent.md\ndescription: One log event exactly as the trusted guest bootstrap's logger posts it.\n---\n\n# Type Alias: GuestLogEvent\n\n```ts\ntype GuestLogEvent = {\n seq: number;\n text: string;\n truncated: boolean;\n};\n```\n\nDefined in: [src/batteries/sandbox/types.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L185)\n\nOne log event exactly as the trusted guest bootstrap's logger posts it.\n\n## Remarks\n\nThe logger — our code inside the guest, never the snippet — stamps each event with a monotonic\nper-call sequence and UTF-8-truncates it to `maxLogEventBytes` BEFORE posting. Bounding in the\nguest is the load-bearing half: a host-side byte count is applied after structured clone has\nalready materialised the string, so a single oversized `console.log` would be in host memory\nbefore any accounting could react.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `seq` | `number` | Monotonic per-call sequence, authored by the bootstrap logger — never by the snippet. It is what lets the host prove delivery completeness against the declared `logCount`. | [src/batteries/sandbox/types.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L187) |\n| `text` | `string` | The logged text, already UTF-8-truncated in the guest when it exceeded `maxLogEventBytes`. | [src/batteries/sandbox/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L189) |\n| `truncated` | `boolean` | `true` when this event was cut to fit `maxLogEventBytes`; the host renders it with the pinned sentinel suffix so a clipped line is never read as a complete one. | [src/batteries/sandbox/types.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L191) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogFraming","title":"Type Alias: GuestLogFraming","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogFraming.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogFraming","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestLogFraming.md\ndescription: Delivery and emission framing for guest logs.\n---\n\n# Type Alias: GuestLogFraming\n\n```ts\ntype GuestLogFraming =\n | {\n logsComplete: true;\n }\n | ({\n logsComplete: false;\n logsThrough: number;\n } & {\n logs: GuestLogEvent[];\n logsCapped: boolean;\n });\n```\n\nDefined in: [src/batteries/sandbox/types.ts:194](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L194)\n\nDelivery and emission framing for guest logs.\n\n## Type Declaration\n\n| Name | Type | Defined in |\n| ------------ | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `logs` | [`GuestLogEvent`](GuestLogEvent.md)\\[] | [src/batteries/sandbox/types.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L198) |\n| `logsCapped` | `boolean` | [src/batteries/sandbox/types.ts:199](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L199) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestOutcome","title":"Type Alias: GuestOutcome","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestOutcome.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestOutcome","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestOutcome.md\ndescription: Settled guest evaluation; partial encoding is still successful execution.\n---\n\n# Type Alias: GuestOutcome\n\n```ts\ntype GuestOutcome =\n | {\n durationMs: number;\n encoding: \"encoder\" | \"partial\";\n ok: true;\n result: unknown;\n }\n | ({\n durationMs: number;\n ok: false;\n thrown: GuestThrown;\n } & GuestLogFraming);\n```\n\nDefined in: [src/batteries/sandbox/types.ts:202](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L202)\n\nSettled guest evaluation; partial encoding is still successful execution.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestThrown","title":"Type Alias: GuestThrown","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestThrown.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestThrown","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/GuestThrown.md\ndescription: 'A thrown guest value, preserving whether encoder representation was complete.'\n---\n\n# Type Alias: GuestThrown\n\n```ts\ntype GuestThrown =\n | {\n kind: \"error\";\n message?: string;\n messageTruncated?: boolean;\n stack?: string;\n stackTruncated?: boolean;\n }\n | {\n encoded: unknown;\n encoding: \"encoder\" | \"partial\";\n kind: \"value\";\n }\n | {\n kind: \"opaque\";\n };\n```\n\nDefined in: [src/batteries/sandbox/types.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L164)\n\nA thrown guest value, preserving whether encoder representation was complete.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/HitFrame","title":"Type Alias: HitFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/HitFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/HitFrame","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/HitFrame.md'\ndescription: >-\n Content-hit frames contain the whole matched line, followed by exactly one\n [`Done`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/Done).\n---\n\n# Type Alias: HitFrame\n\n```ts\ntype HitFrame =\n | {\n kind: \"item\";\n line: number;\n path: string;\n text: string;\n }\n | Done;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L143)\n\nContent-hit frames contain the whole matched line, followed by exactly one [Done](Done.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ListFrame","title":"Type Alias: ListFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ListFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ListFrame","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/ListFrame.md'\ndescription: 'List item frames followed by exactly one [`Done`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/Done).'\n---\n\n# Type Alias: ListFrame\n\n```ts\ntype ListFrame =\n | {\n entryKind: \"file\" | \"dir\";\n kind: \"item\";\n path: string;\n }\n | Done;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L139)\n\nList item frames followed by exactly one [Done](Done.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/MimeResolver","title":"Type Alias: MimeResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/MimeResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/MimeResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/MimeResolver.md\ndescription: >-\n MIME resolver; `undefined` means the resolver declines and a later resolver\n may decide.\n---\n\n# Type Alias: MimeResolver\n\n```ts\ntype MimeResolver = (ctx: {\n declared?: string;\n path: string;\n peek: (bytes: number) => Promise;\n}) => string | undefined | Promise;\n```\n\nDefined in: [src/batteries/sandbox/contracts/mime\\_resolver.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/mime_resolver.ts#L4)\n\nMIME resolver; `undefined` means the resolver declines and a later resolver may decide.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |\n| `ctx` | { `declared?`: `string`; `path`: `string`; `peek`: (`bytes`: `number`) => `Promise`<`Uint8Array`>; } | - |\n| `ctx.declared?` | `string` | - |\n| `ctx.path` | `string` | - |\n| `ctx.peek` | (`bytes`: `number`) => `Promise`<`Uint8Array`> | Read a bounded prefix only; this callback cannot read the whole file. |\n\n## Returns\n\n`string` | `undefined` | `Promise`<`string` | `undefined`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelPath","title":"Type Alias: ModelPath","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelPath.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelPath","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelPath.md'\ndescription: >-\n Presentation/normalisation brand only; this is NOT a containment guarantee.\n Every filesystem use must still pass through PathTranslator.toRelative().\n---\n\n# Type Alias: ModelPath\n\n```ts\ntype ModelPath = string & {\n __sandboxModelPath: unique symbol;\n};\n```\n\nDefined in: [src/batteries/sandbox/types.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L10)\n\nPresentation/normalisation brand only; this is NOT a containment guarantee.\nEvery filesystem use must still pass through PathTranslator.toRelative().\n\n## Type Declaration\n\n| Name | Type | Defined in |\n| -------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `__sandboxModelPath` | unique `symbol` | [src/batteries/sandbox/types.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L10) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelWriteRoot","title":"Type Alias: ModelWriteRoot","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelWriteRoot.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelWriteRoot","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/ModelWriteRoot.md\ndescription: Opaque model-facing write root; constructed only by the path layer.\n---\n\n# Type Alias: ModelWriteRoot\n\n```ts\ntype ModelWriteRoot = ModelPath & {\n __sandboxModelWriteRoot: unique symbol;\n};\n```\n\nDefined in: [src/batteries/sandbox/types.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L12)\n\nOpaque model-facing write root; constructed only by the path layer.\n\n## Type Declaration\n\n| Name | Type | Defined in |\n| ------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `__sandboxModelWriteRoot` | unique `symbol` | [src/batteries/sandbox/types.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L12) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/PathFrame","title":"Type Alias: PathFrame","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/PathFrame.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/PathFrame","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/PathFrame.md'\ndescription: 'Path-search item frames followed by exactly one [`Done`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/Done).'\n---\n\n# Type Alias: PathFrame\n\n```ts\ntype PathFrame =\n | {\n kind: \"item\";\n path: string;\n }\n | Done;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L141)\n\nPath-search item frames followed by exactly one [Done](Done.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEpochIsLive","title":"Type Alias: SandboxEpochIsLive","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEpochIsLive.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEpochIsLive","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEpochIsLive.md\ndescription: The capability needed to decide whether a sandbox handle is still alive.\n---\n\n# Type Alias: SandboxEpochIsLive\n\n```ts\ntype SandboxEpochIsLive = (epoch: SandboxEpoch) => boolean;\n```\n\nDefined in: [src/batteries/sandbox/media\\_reader.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/media_reader.ts#L8)\n\nThe capability needed to decide whether a sandbox handle is still alive.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------- |\n| `epoch` | [`SandboxEpoch`](../classes/SandboxEpoch.md) |\n\n## Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEvent","title":"Type Alias: SandboxEvent","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEvent.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEvent","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEvent.md\ndescription: Typed records emitted by the sandbox's single audit firehose.\n---\n\n# Type Alias: SandboxEvent\n\n```ts\ntype SandboxEvent =\n | {\n command: string;\n kind: \"bypass\";\n loud: true;\n path?: string;\n }\n | {\n handleId: string;\n kind: \"unsandboxed-fallback\";\n loud: true;\n path?: string;\n reason: string;\n }\n | {\n comparison?: \"network-domains\";\n kind: \"drift-check\";\n outcome: \"passed\" | \"failed\" | \"skipped\";\n path?: string;\n reason?: string;\n }\n | {\n kind: \"fs-node-version\";\n version: string;\n }\n | {\n kind: \"dependency-warnings\";\n warnings: readonly string[];\n };\n```\n\nDefined in: [src/batteries/sandbox/observability.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L11)\n\nTyped records emitted by the sandbox's single audit firehose.\n\n## Union Members\n\n### Type Literal\n\n```ts\n{\n command: string;\n kind: \"bypass\";\n loud: true;\n path?: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n handleId: string;\n kind: \"unsandboxed-fallback\";\n loud: true;\n path?: string;\n reason: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n comparison?: \"network-domains\";\n kind: \"drift-check\";\n outcome: \"passed\" | \"failed\" | \"skipped\";\n path?: string;\n reason?: string;\n}\n```\n\n| Name | Type | Description | Defined in |\n| ------------- | --------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `comparison?` | `\"network-domains\"` | `skipped` is specifically the network-domain comparison, not adoption. | [src/batteries/sandbox/observability.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L31) |\n| `kind` | `\"drift-check\"` | - | [src/batteries/sandbox/observability.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L26) |\n| `outcome` | `\"passed\"` | `\"failed\"` | `\"skipped\"` | - | [src/batteries/sandbox/observability.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L27) |\n| `path?` | `string` | - | [src/batteries/sandbox/observability.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L29) |\n| `reason?` | `string` | - | [src/batteries/sandbox/observability.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L28) |\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"fs-node-version\";\n version: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"dependency-warnings\";\n warnings: readonly string[];\n}\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEventSink","title":"Type Alias: SandboxEventSink","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEventSink.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEventSink","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxEventSink.md\ndescription: Consumer callback for sandbox audit events.\n---\n\n# Type Alias: SandboxEventSink\n\n```ts\ntype SandboxEventSink = (event: SandboxEvent) => void;\n```\n\nDefined in: [src/batteries/sandbox/observability.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/observability.ts#L40)\n\nConsumer callback for sandbox audit events.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------- |\n| `event` | [`SandboxEvent`](SandboxEvent.md) |\n\n## Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxNarrator","title":"Type Alias: SandboxNarrator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxNarrator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxNarrator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxNarrator.md\ndescription: >-\n Model-facing narration seam; implementations must be total over {@link\n SandboxOutcome}.\n---\n\n# Type Alias: SandboxNarrator\n\n```ts\ntype SandboxNarrator = (outcome: SandboxOutcome) => string;\n```\n\nDefined in: [src/batteries/sandbox/narrator.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/narrator.ts#L36)\n\nModel-facing narration seam; implementations must be total over [SandboxOutcome](SandboxOutcome.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------- |\n| `outcome` | [`SandboxOutcome`](SandboxOutcome.md) |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxOutcome","title":"Type Alias: SandboxOutcome","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxOutcome.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxOutcome","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxOutcome.md\ndescription: Exhaustive model-facing sandbox outcome.\n---\n\n# Type Alias: SandboxOutcome\n\n```ts\ntype SandboxOutcome =\n | {\n kind: \"not-found\";\n path: string;\n }\n | {\n axis: \"read\" | \"write\";\n kind: \"denied-by-policy\";\n path: string;\n }\n | {\n kind: \"gate-declined\";\n note?: string;\n }\n | {\n kind: \"gate-unavailable\";\n reason: \"timeout\" | \"error\";\n }\n | {\n bound: \"maxTerminalPayloadBytes\";\n kind: \"over-budget\";\n limit: number;\n observedAtLeast: number;\n }\n | {\n atDepth: number;\n bound: \"maxDepth\";\n kind: \"scope-limited\";\n shown: number;\n }\n | {\n bound: \"limit\";\n kind: \"result-limited\";\n limit: number;\n shown: number;\n }\n | {\n kind: \"not-a-regular-file\";\n kind_: string;\n path: string;\n }\n | {\n kind: \"is-a-directory\";\n path: string;\n }\n | {\n input: string;\n kind: \"path-rejected\";\n reason: \"escape\" | \"absolute-host\" | \"home\" | \"unc\" | \"device\" | \"nul\";\n }\n | {\n kind: \"outside-write-root\";\n path: ModelPath;\n writeRoot: ModelWriteRoot;\n }\n | {\n exitCode: number;\n kind: \"sandbox-violation\";\n violations: readonly string[];\n }\n | {\n exitCode: number;\n kind: \"nonzero-exit\";\n }\n | {\n kind: \"no-matches\";\n pattern: string;\n scope: string;\n }\n | {\n kind: \"unknown-media\";\n mediaId: string;\n }\n | {\n detail: string;\n kind: \"invalid-pattern\";\n pattern: string;\n }\n | {\n kind: \"not-a-directory\";\n path: string;\n }\n | {\n detail: string;\n kind: \"io-failure\";\n path?: string;\n }\n | {\n kind: \"aborted\";\n }\n | {\n bound: \"timeout_seconds\";\n kind: \"timed-out\";\n limitSeconds: number;\n };\n```\n\nDefined in: [src/batteries/sandbox/narrator.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/narrator.ts#L4)\n\nExhaustive model-facing sandbox outcome.\n\n## Union Members\n\n### Type Literal\n\n```ts\n{\n kind: \"not-found\";\n path: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n axis: \"read\" | \"write\";\n kind: \"denied-by-policy\";\n path: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"gate-declined\";\n note?: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"gate-unavailable\";\n reason: \"timeout\" | \"error\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n bound: \"maxTerminalPayloadBytes\";\n kind: \"over-budget\";\n limit: number;\n observedAtLeast: number;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n atDepth: number;\n bound: \"maxDepth\";\n kind: \"scope-limited\";\n shown: number;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n bound: \"limit\";\n kind: \"result-limited\";\n limit: number;\n shown: number;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"not-a-regular-file\";\n kind_: string;\n path: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"is-a-directory\";\n path: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n input: string;\n kind: \"path-rejected\";\n reason: \"escape\" | \"absolute-host\" | \"home\" | \"unc\" | \"device\" | \"nul\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"outside-write-root\";\n path: ModelPath;\n writeRoot: ModelWriteRoot;\n}\n```\n\nModel-facing root, conventionally `/`; NEVER the configured absolute host path.\n\n***\n\n### Type Literal\n\n```ts\n{\n exitCode: number;\n kind: \"sandbox-violation\";\n violations: readonly string[];\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n exitCode: number;\n kind: \"nonzero-exit\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"no-matches\";\n pattern: string;\n scope: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"unknown-media\";\n mediaId: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n detail: string;\n kind: \"invalid-pattern\";\n pattern: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"not-a-directory\";\n path: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n detail: string;\n kind: \"io-failure\";\n path?: string;\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n kind: \"aborted\";\n}\n```\n\n***\n\n### Type Literal\n\n```ts\n{\n bound: \"timeout_seconds\";\n kind: \"timed-out\";\n limitSeconds: number;\n}\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPathRejection","title":"Type Alias: SandboxPathRejection","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPathRejection.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPathRejection","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPathRejection.md\ndescription: 'Why a path was rejected outright, before any normalisation.'\n---\n\n# Type Alias: SandboxPathRejection\n\n```ts\ntype SandboxPathRejection = \"nul\" | \"home\" | \"absolute-host\" | \"device\" | \"unc\";\n```\n\nDefined in: [src/batteries/sandbox/paths.ts:7](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/paths.ts#L7)\n\nWhy a path was rejected outright, before any normalisation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPlatform","title":"Type Alias: SandboxPlatform","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPlatform.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPlatform","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/type-aliases/SandboxPlatform.md\ndescription: Platform identity supplied by the construction site.\n---\n\n# Type Alias: SandboxPlatform\n\n```ts\ntype SandboxPlatform = \"darwin\" | \"linux\" | \"win32\" | string;\n```\n\nDefined in: [src/batteries/sandbox/preflight.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L20)\n\nPlatform identity supplied by the construction site.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/ALLOWED_RIPGREP_FLAGS","title":"Variable: ALLOWED\\_RIPGREP\\_FLAGS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/ALLOWED_RIPGREP_FLAGS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/ALLOWED_RIPGREP_FLAGS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/ALLOWED_RIPGREP_FLAGS.md\ndescription: Flags emitted by the sandbox's own ripgrep adapter.\n---\n\n# Variable: ALLOWED\\_RIPGREP\\_FLAGS\n\n```ts\nconst ALLOWED_RIPGREP_FLAGS: readonly [\n \"--files\",\n \"--ignore-case\",\n \"--fixed-strings\",\n \"--hidden\",\n \"--follow\",\n \"--no-ignore\",\n \"--glob\",\n \"--iglob\",\n \"--max-depth\",\n \"--json\",\n];\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L22)\n\nFlags emitted by the sandbox's own ripgrep adapter.\n\n## Remarks\n\nEVERY flag the adapter actually emits must appear here, or the adapter rejects its own argv and the\ncapability fails for every invocation. `--json` is `searchContent`'s output format and is exactly such\na flag; omitting it made content search unusable while name search (which does not use it) worked.\nThe argv TERMINATOR `--` is deliberately absent: it is not a flag, and it is filtered out before\nvalidation rather than admitted here, so this list stays a list of flags.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/artifactMinterSchema","title":"Variable: artifactMinterSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/artifactMinterSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/artifactMinterSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/artifactMinterSchema.md\ndescription: Duck-type schema.\n---\n\n# Variable: artifactMinterSchema\n\n```ts\nconst artifactMinterSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/contracts/artifact\\_minter.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/artifact_minter.ts#L13)\n\nDuck-type schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/assertPosixBinShell","title":"Variable: assertPosixBinShell","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/assertPosixBinShell.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/assertPosixBinShell","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/assertPosixBinShell.md\ndescription: Alias used by the SRT adapter at construction time.\n---\n\n# Variable: assertPosixBinShell\n\n```ts\nconst assertPosixBinShell: (value: string) => string = validateBinShell;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L54)\n\nAlias used by the SRT adapter at construction time.\n\nValidate the shell selected by the Node SRT adapter.\n\n## Parameters\n\n| Parameter | Type | Default value |\n| --------- | -------- | ------------- |\n| `value` | `string` | `'/bin/bash'` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/DEFAULT_MIME_PEEK_BYTES","title":"Variable: DEFAULT\\_MIME\\_PEEK\\_BYTES","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/DEFAULT_MIME_PEEK_BYTES.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/DEFAULT_MIME_PEEK_BYTES","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/DEFAULT_MIME_PEEK_BYTES.md\ndescription: The default prefix available to a custom resolver.\n---\n\n# Variable: DEFAULT\\_MIME\\_PEEK\\_BYTES\n\n```ts\nconst DEFAULT_MIME_PEEK_BYTES: 512 = 512;\n```\n\nDefined in: [src/batteries/sandbox/defaults/extension\\_mime.ts:5](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/extension_mime.ts#L5)\n\nThe default prefix available to a custom resolver.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultArtifactMinter","title":"Variable: defaultArtifactMinter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultArtifactMinter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultArtifactMinter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/defaultArtifactMinter.md\ndescription: The shared default registry. Its format thunks remain lazy until selected.\n---\n\n# Variable: defaultArtifactMinter\n\n```ts\nconst defaultArtifactMinter: DefaultArtifactMinter;\n```\n\nDefined in: [src/batteries/sandbox/defaults/default\\_minter.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/default_minter.ts#L75)\n\nThe shared default registry. Its format thunks remain lazy until selected.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultMimeResolver","title":"Variable: defaultMimeResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultMimeResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultMimeResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/defaultMimeResolver.md\ndescription: 'The default resolver, also exported under the concise name used by consumers.'\n---\n\n# Variable: defaultMimeResolver\n\n```ts\nconst defaultMimeResolver: MimeResolver = extensionMimeResolver;\n```\n\nDefined in: [src/batteries/sandbox/defaults/extension\\_mime.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/extension_mime.ts#L93)\n\nThe default resolver, also exported under the concise name used by consumers.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultSandboxNarrator","title":"Variable: defaultSandboxNarrator","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultSandboxNarrator.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/defaultSandboxNarrator","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/defaultSandboxNarrator.md\ndescription: >-\n Existence-blind default narrator; not-found and denied-by-policy intentionally\n share wording.\n---\n\n# Variable: defaultSandboxNarrator\n\n```ts\nconst defaultSandboxNarrator: SandboxNarrator;\n```\n\nDefined in: [src/batteries/sandbox/narrator.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/narrator.ts#L72)\n\nExistence-blind default narrator; not-found and denied-by-policy intentionally share wording.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/DOUBLE_DASH_BINARIES","title":"Variable: DOUBLE\\_DASH\\_BINARIES","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/DOUBLE_DASH_BINARIES.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/DOUBLE_DASH_BINARIES","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/DOUBLE_DASH_BINARIES.md\ndescription: Binaries for which passing `--` terminates option parsing.\n---\n\n# Variable: DOUBLE\\_DASH\\_BINARIES\n\n```ts\nconst DOUBLE_DASH_BINARIES: readonly [\"cp\", \"rg\"];\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L10)\n\nBinaries for which passing `--` terminates option parsing.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_INVALID_SANDBOX_CONFIG","title":"Variable: E\\_INVALID\\_SANDBOX\\_CONFIG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_INVALID_SANDBOX_CONFIG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_INVALID_SANDBOX_CONFIG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_INVALID_SANDBOX_CONFIG.md\ndescription: Invalid sandbox configuration.\n---\n\n# Variable: E\\_INVALID\\_SANDBOX\\_CONFIG\n\n```ts\nconst E_INVALID_SANDBOX_CONFIG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:3](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L3)\n\nInvalid sandbox configuration.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_DEPENDENCY_MISSING","title":"Variable: E\\_SANDBOX\\_DEPENDENCY\\_MISSING","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_DEPENDENCY_MISSING.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_DEPENDENCY_MISSING","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_DEPENDENCY_MISSING.md\ndescription: Sandbox dependency is missing or unavailable at assembly time.\n---\n\n# Variable: E\\_SANDBOX\\_DEPENDENCY\\_MISSING\n\n```ts\nconst E_SANDBOX_DEPENDENCY_MISSING: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L19)\n\nSandbox dependency is missing or unavailable at assembly time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_FAILED","title":"Variable: E\\_SANDBOX\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_FAILED.md\ndescription: Sandbox operational failure presented to the model.\n---\n\n# Variable: E\\_SANDBOX\\_FAILED\n\n```ts\nconst E_SANDBOX_FAILED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L67)\n\nSandbox operational failure presented to the model.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_GATE_REQUIRED","title":"Variable: E\\_SANDBOX\\_GATE\\_REQUIRED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_GATE_REQUIRED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_GATE_REQUIRED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_GATE_REQUIRED.md\ndescription: A required approval gate was not supplied.\n---\n\n# Variable: E\\_SANDBOX\\_GATE\\_REQUIRED\n\n```ts\nconst E_SANDBOX_GATE_REQUIRED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L51)\n\nA required approval gate was not supplied.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NARROWING_UNSUPPORTED","title":"Variable: E\\_SANDBOX\\_NARROWING\\_UNSUPPORTED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NARROWING_UNSUPPORTED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NARROWING_UNSUPPORTED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NARROWING_UNSUPPORTED.md\ndescription: A requested policy narrowing cannot be represented by the backend.\n---\n\n# Variable: E\\_SANDBOX\\_NARROWING\\_UNSUPPORTED\n\n```ts\nconst E_SANDBOX_NARROWING_UNSUPPORTED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L43)\n\nA requested policy narrowing cannot be represented by the backend.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NOT_INITIALIZED","title":"Variable: E\\_SANDBOX\\_NOT\\_INITIALIZED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NOT_INITIALIZED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NOT_INITIALIZED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_NOT_INITIALIZED.md\ndescription: Sandbox operation was attempted before initialization.\n---\n\n# Variable: E\\_SANDBOX\\_NOT\\_INITIALIZED\n\n```ts\nconst E_SANDBOX_NOT_INITIALIZED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L27)\n\nSandbox operation was attempted before initialization.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_PATH_ESCAPE","title":"Variable: E\\_SANDBOX\\_PATH\\_ESCAPE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_PATH_ESCAPE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_PATH_ESCAPE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_PATH_ESCAPE.md\ndescription: >-\n Thrown when a model-supplied path is an UNAMBIGUOUS escape or an unsupported\n form.\n---\n\n# Variable: E\\_SANDBOX\\_PATH\\_ESCAPE\n\n```ts\nconst E_SANDBOX_PATH_ESCAPE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L84)\n\nThrown when a model-supplied path is an UNAMBIGUOUS escape or an unsupported form.\n\n## Remarks\n\nOnly the refuse-outright set of LLM-operator rule 1 reaches this: a NUL byte anywhere, a leading\n`~`, any leading drive letter, a device/verbatim prefix, a UNC form, and a `../` that still escapes\nafter lexical resolution. A leading `/` does NOT — it normalises to the sandbox root, because the\nmodel's world IS the sandbox and refusing it would punish the model for a distinction we\ndeliberately hid from it. Message template is bare `'%s'` so the narrator text arrives unprefixed.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_POLICY_CONFLICT","title":"Variable: E\\_SANDBOX\\_POLICY\\_CONFLICT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_POLICY_CONFLICT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_POLICY_CONFLICT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_POLICY_CONFLICT.md\ndescription: Requested policy conflicts with another enforced policy.\n---\n\n# Variable: E\\_SANDBOX\\_POLICY\\_CONFLICT\n\n```ts\nconst E_SANDBOX_POLICY_CONFLICT: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L35)\n\nRequested policy conflicts with another enforced policy.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_REFUSED","title":"Variable: E\\_SANDBOX\\_REFUSED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_REFUSED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_REFUSED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_REFUSED.md\ndescription: Sandbox refusal presented to the model.\n---\n\n# Variable: E\\_SANDBOX\\_REFUSED\n\n```ts\nconst E_SANDBOX_REFUSED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L59)\n\nSandbox refusal presented to the model.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_UNSUPPORTED_ENV","title":"Variable: E\\_SANDBOX\\_UNSUPPORTED\\_ENV","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_UNSUPPORTED_ENV.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_UNSUPPORTED_ENV","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SANDBOX_UNSUPPORTED_ENV.md\ndescription: Sandbox environment is unsupported.\n---\n\n# Variable: E\\_SANDBOX\\_UNSUPPORTED\\_ENV\n\n```ts\nconst E_SANDBOX_UNSUPPORTED_ENV: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/exceptions.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/exceptions.ts#L11)\n\nSandbox environment is unsupported.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_EVALUATION_TIMEOUT","title":"Variable: E\\_SES\\_EVALUATION\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_EVALUATION_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_EVALUATION_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SES_EVALUATION_TIMEOUT.md\ndescription: A guest evaluation exceeded its tool-selected deadline.\n---\n\n# Variable: E\\_SES\\_EVALUATION\\_TIMEOUT\n\n```ts\nconst E_SES_EVALUATION_TIMEOUT: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/js/exceptions.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/exceptions.ts#L20)\n\nA guest evaluation exceeded its tool-selected deadline.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_HOST_LOCKDOWN_REQUIRED","title":"Variable: E\\_SES\\_HOST\\_LOCKDOWN\\_REQUIRED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_HOST_LOCKDOWN_REQUIRED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_HOST_LOCKDOWN_REQUIRED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SES_HOST_LOCKDOWN_REQUIRED.md\ndescription: In-process SES evaluation requires hardening the complete host realm.\n---\n\n# Variable: E\\_SES\\_HOST\\_LOCKDOWN\\_REQUIRED\n\n```ts\nconst E_SES_HOST_LOCKDOWN_REQUIRED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/js/exceptions.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/exceptions.ts#L12)\n\nIn-process SES evaluation requires hardening the complete host realm.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_LOCKDOWN_REQUIRED","title":"Variable: E\\_SES\\_LOCKDOWN\\_REQUIRED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_LOCKDOWN_REQUIRED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/E_SES_LOCKDOWN_REQUIRED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/E_SES_LOCKDOWN_REQUIRED.md\ndescription: SES lockdown was unavailable or did not harden the guest realm.\n---\n\n# Variable: E\\_SES\\_LOCKDOWN\\_REQUIRED\n\n```ts\nconst E_SES_LOCKDOWN_REQUIRED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/sandbox/js/exceptions.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/js/exceptions.ts#L4)\n\nSES lockdown was unavailable or did not harden the guest realm.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/escapeShellArgs","title":"Variable: escapeShellArgs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/escapeShellArgs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/escapeShellArgs","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/escapeShellArgs.md\ndescription: Compatibility alias for consumers that describe this operation as escaping.\n---\n\n# Variable: escapeShellArgs\n\n```ts\nconst escapeShellArgs: (args: readonly string[]) => Promise =\n quoteShellArgs;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L124)\n\nCompatibility alias for consumers that describe this operation as escaping.\n\nQuote argv using SRT's maintained POSIX implementation.\n\nThe import is deliberately lazy: SRT is an optional peer and is ESM-only.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------- |\n| `args` | readonly `string`\\[] |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/escapeShellValue","title":"Variable: escapeShellValue","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/escapeShellValue.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/escapeShellValue","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/escapeShellValue.md\ndescription: Compatibility alias for consumers that describe this operation as escaping.\n---\n\n# Variable: escapeShellValue\n\n```ts\nconst escapeShellValue: (value: string) => Promise = quoteShellValue;\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L126)\n\nCompatibility alias for consumers that describe this operation as escaping.\n\nQuote one command string as one shell argument.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `value` | `string` |\n\n## Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/extensionMimeResolver","title":"Variable: extensionMimeResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/extensionMimeResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/extensionMimeResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/extensionMimeResolver.md\ndescription: 'Resolve a MIME type from a filename, without sniffing bytes.'\n---\n\n# Variable: extensionMimeResolver\n\n```ts\nconst extensionMimeResolver: MimeResolver;\n```\n\nDefined in: [src/batteries/sandbox/defaults/extension\\_mime.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/extension_mime.ts#L87)\n\nResolve a MIME type from a filename, without sniffing bytes.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitFloors","title":"Variable: guestLimitFloors","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitFloors.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitFloors","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/guestLimitFloors.md\ndescription: Minimum representable guest values.\n---\n\n# Variable: guestLimitFloors\n\n```ts\nconst guestLimitFloors: GuestLimits;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:233](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L233)\n\nMinimum representable guest values.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsDefaults","title":"Variable: guestLimitsDefaults","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsDefaults.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsDefaults","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsDefaults.md\ndescription: 'Default guest values, each paired with its own floor.'\n---\n\n# Variable: guestLimitsDefaults\n\n```ts\nconst guestLimitsDefaults: GuestLimits;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L223)\n\nDefault guest values, each paired with its own floor.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsSchema","title":"Variable: guestLimitsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/guestLimitsSchema.md\ndescription: Schema enforcing every guest field's own floor.\n---\n\n# Variable: guestLimitsSchema\n\n```ts\nconst guestLimitsSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:318](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L318)\n\nSchema enforcing every guest field's own floor.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestRuntimeSchema","title":"Variable: guestRuntimeSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestRuntimeSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/guestRuntimeSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/guestRuntimeSchema.md\ndescription: Duck-type schema.\n---\n\n# Variable: guestRuntimeSchema\n\n```ts\nconst guestRuntimeSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/contracts/guest\\_runtime.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/guest_runtime.ts#L17)\n\nDuck-type schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasDefaults","title":"Variable: hostcallQuotasDefaults","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasDefaults.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasDefaults","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasDefaults.md\ndescription: Default host quotas.\n---\n\n# Variable: hostcallQuotasDefaults\n\n```ts\nconst hostcallQuotasDefaults: HostcallQuotas;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L243)\n\nDefault host quotas.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasSchema","title":"Variable: hostcallQuotasSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/hostcallQuotasSchema.md\ndescription: Schema enforcing every host quota floor.\n---\n\n# Variable: hostcallQuotasSchema\n\n```ts\nconst hostcallQuotasSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:323](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L323)\n\nSchema enforcing every host quota floor.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/mimeResolverSchema","title":"Variable: mimeResolverSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/mimeResolverSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/mimeResolverSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/mimeResolverSchema.md\ndescription: MIME resolver schema.\n---\n\n# Variable: mimeResolverSchema\n\n```ts\nconst mimeResolverSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/contracts/mime\\_resolver.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/mime_resolver.ts#L11)\n\nMIME resolver schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/pathTranslatorSchema","title":"Variable: pathTranslatorSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/pathTranslatorSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/pathTranslatorSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/pathTranslatorSchema.md\ndescription: Duck-type schema.\n---\n\n# Variable: pathTranslatorSchema\n\n```ts\nconst pathTranslatorSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/contracts/path\\_translator.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/path_translator.ts#L17)\n\nDuck-type schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/POSIX_SHELLS","title":"Variable: POSIX\\_SHELLS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/POSIX_SHELLS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/POSIX_SHELLS","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/POSIX_SHELLS.md'\ndescription: Shells for which SRT's POSIX quote() and the `-c` invocation contract agree.\n---\n\n# Variable: POSIX\\_SHELLS\n\n```ts\nconst POSIX_SHELLS: readonly [\"sh\", \"bash\", \"dash\", \"zsh\", \"ksh\"];\n```\n\nDefined in: [src/batteries/sandbox/escape.ts:4](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/escape.ts#L4)\n\nShells for which SRT's POSIX quote() and the `-c` invocation contract agree.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/runSandboxPreflight","title":"Variable: runSandboxPreflight","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/runSandboxPreflight.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/runSandboxPreflight","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/runSandboxPreflight.md\ndescription: Compatibility alias for the construction-site call in WP-A1.\n---\n\n# Variable: runSandboxPreflight\n\n```ts\nconst runSandboxPreflight: (\n options: PreflightOptions,\n) => Promise = preflightSandbox;\n```\n\nDefined in: [src/batteries/sandbox/preflight.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/preflight.ts#L100)\n\nCompatibility alias for the construction-site call in WP-A1.\n\nRun the once-only, fail-closed environment gauntlet used by `createSandbox()`.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------- |\n| `options` | [`PreflightOptions`](../interfaces/PreflightOptions.md) |\n\n## Returns\n\n`Promise`<[`SandboxPreflight`](../interfaces/SandboxPreflight.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/SANDBOX_EXTENSION_MIME","title":"Variable: SANDBOX\\_EXTENSION\\_MIME","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/SANDBOX_EXTENSION_MIME.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/SANDBOX_EXTENSION_MIME","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/SANDBOX_EXTENSION_MIME.md\ndescription: Extension to MIME mappings used by the default resolver.\n---\n\n# Variable: SANDBOX\\_EXTENSION\\_MIME\n\n```ts\nconst SANDBOX_EXTENSION_MIME: Readonly>;\n```\n\nDefined in: [src/batteries/sandbox/defaults/extension\\_mime.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/defaults/extension_mime.ts#L8)\n\nExtension to MIME mappings used by the default resolver.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxFileSystemSchema","title":"Variable: sandboxFileSystemSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxFileSystemSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxFileSystemSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/sandboxFileSystemSchema.md\ndescription: Duck-type schema.\n---\n\n# Variable: sandboxFileSystemSchema\n\n```ts\nconst sandboxFileSystemSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/contracts/file\\_system.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/file_system.ts#L38)\n\nDuck-type schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicyEnforcerSchema","title":"Variable: sandboxPolicyEnforcerSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicyEnforcerSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicyEnforcerSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicyEnforcerSchema.md\ndescription: Duck-type schema.\n---\n\n# Variable: sandboxPolicyEnforcerSchema\n\n```ts\nconst sandboxPolicyEnforcerSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/contracts/policy\\_enforcer.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/policy_enforcer.ts#L57)\n\nDuck-type schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicySchema","title":"Variable: sandboxPolicySchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicySchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicySchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/sandboxPolicySchema.md\ndescription: 'Closed structural schema for [`SandboxPolicy`](https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/interfaces/SandboxPolicy).'\n---\n\n# Variable: sandboxPolicySchema\n\n```ts\nconst sandboxPolicySchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/types.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/types.ts#L249)\n\nClosed structural schema for [SandboxPolicy](../interfaces/SandboxPolicy.md).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxSearchSchema","title":"Variable: sandboxSearchSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxSearchSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/sandbox/variables/sandboxSearchSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/sandbox/variables/sandboxSearchSchema.md\ndescription: Duck-type schema.\n---\n\n# Variable: sandboxSearchSchema\n\n```ts\nconst sandboxSearchSchema: AnySchema;\n```\n\nDefined in: [src/batteries/sandbox/contracts/search.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/sandbox/contracts/search.ts#L50)\n\nDuck-type schema.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills","title":"@nhtio/adk/batteries/skills","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills.md'\ndescription: 'Stateful skill discovery, activation, and deactivation for ADK agents.'\n---\n\n# @nhtio/adk/batteries/skills\n\nStateful skill discovery, activation, and deactivation for ADK agents.\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CatalogEntry](interfaces/CatalogEntry.md) | A winning catalog candidate or a losing candidate retained for provenance. |\n| [DiscoveredSkill](interfaces/DiscoveredSkill.md) | Discovery result. Carries the ROUTING METADATA — `name` and `description` — because that is what `list_skills` shows the model and what it chooses on; requiring `descriptor()` to obtain it would mean loading every skill's module just to list the catalog. |\n| [ForgeSkillToolsOptions](interfaces/ForgeSkillToolsOptions.md) | Deployment-time controls for the lifecycle tools forged by [forgeSkillTools](functions/forgeSkillTools.md). |\n| [LoadResult](interfaces/LoadResult.md) | Immediate lifecycle outcome, including the objects registered in this dispatch. |\n| [ProjectedSkill](interfaces/ProjectedSkill.md) | The per-context projection of one initialized skill. |\n| [RefreshResult](interfaces/RefreshResult.md) | Result of catalog refresh, including versions that now differ from loaded state. |\n| [SkillArtifactRegistry](interfaces/SkillArtifactRegistry.md) | Resolved artifact kinds plus the consumer-owned skill/tool binding table. |\n| [SkillBinaryOutput](interfaces/SkillBinaryOutput.md) | Bytes-with-a-content-type: the framework-agnostic path to typed binary. |\n| [SkillDescriptor](interfaces/SkillDescriptor.md) | Live, source-owned definition resolved when a catalog entry is loaded. |\n| [SkillIsolatedTool](interfaces/SkillIsolatedTool.md) | Tier-2 tool whose source is evaluated inside the configured guest runtime. |\n| [SkillIsolationConfig](interfaces/SkillIsolationConfig.md) | Tier-2 guest capabilities and termination/timeout controls. |\n| [SkillManager](interfaces/SkillManager.md) | Stateful skill lifecycle; construct one manager per conversation or session. |\n| [SkillManagerConfig](interfaces/SkillManagerConfig.md) | Inputs that determine discovery, projection, and the explicit containment exceptions. |\n| [SkillMiddlewareOptions](interfaces/SkillMiddlewareOptions.md) | Options for the standalone skills middleware factories. |\n| [SkillMiddlewareSet](interfaces/SkillMiddlewareSet.md) | The four pipeline hooks needed to hydrate, reconcile, observe, and strip skill state. |\n| [SkillRetrievableOutput](interfaces/SkillRetrievableOutput.md) | A framework-agnostic retrievable descriptor. `content` is plain text; the host spools it. |\n| [SkillScriptConfig](interfaces/SkillScriptConfig.md) | Tier-3 execution controls, workspace, policy, and output/time ceilings. |\n| [SkillScriptParam](interfaces/SkillScriptParam.md) | One validated value in the fixed argv contract presented to a script. |\n| [SkillScriptSpec](interfaces/SkillScriptSpec.md) | A model-selectable script bundled with a skill and invoked with declared arguments only. |\n| [SkillSource](interfaces/SkillSource.md) | Runtime-neutral source seam for discovery, metadata, body bytes, and bundled files. |\n| [SkillWorkspace](interfaces/SkillWorkspace.md) | Skill-scoped materialization service used by tier-3 scripts. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SkillLoadChannel](type-aliases/SkillLoadChannel.md) | Controls whether a loaded body is represented by a handle or rendered inline per dispatch. |\n| [SkillOutputKind](type-aliases/SkillOutputKind.md) | The output kind a descriptor may DECLARE for a tool. When present, a runtime shape that disagrees is a detectable failure rather than a silent reinterpretation; when absent, the wrapper sniffs. |\n| [SkillRef](type-aliases/SkillRef.md) | A discovered skill plus manager-assigned provenance. This is what the battery passes around. |\n| [SkillSourceResolver](type-aliases/SkillSourceResolver.md) | A source instance or lazy/default export resolver used during manager construction. |\n| [SkillTrustTier](type-aliases/SkillTrustTier.md) | The skill trust tiers the battery threads through, shared by scripts and typed output. |\n| [SpooledKindResolver](type-aliases/SpooledKindResolver.md) | An artifact constructor or lazy/default-export resolver for a named skill result kind. |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_SKILLS\\_CONFIG](variables/E_INVALID_SKILLS_CONFIG.md) | Fatal construction error for invalid or unsafe-to-resolve manager configuration. |\n| [E\\_SKILL\\_ALREADY\\_LOADED](variables/E_SKILL_ALREADY_LOADED.md) | Raised when load would initialize a skill that is already initialized. |\n| [E\\_SKILL\\_ARTIFACT\\_UNAVAILABLE](variables/E_SKILL_ARTIFACT_UNAVAILABLE.md) | Raised when the selected artifact kind was not registered. |\n| [E\\_SKILL\\_MANIFEST\\_INVALID](variables/E_SKILL_MANIFEST_INVALID.md) | Raised when source metadata or a descriptor violates the identity/version contract. |\n| [E\\_SKILL\\_NOT\\_FOUND](variables/E_SKILL_NOT_FOUND.md) | Raised when load, refresh, or unload names no winning catalog entry. |\n| [E\\_SKILL\\_NOT\\_LOADED](variables/E_SKILL_NOT_LOADED.md) | Raised when unload or a loaded-only operation targets an uninitialized skill. |\n| [E\\_SKILL\\_SCRIPT\\_DENIED](variables/E_SKILL_SCRIPT_DENIED.md) | Explicit 403 refusal by the script policy; this is distinct from a failed gate. |\n| [E\\_SKILL\\_SCRIPT\\_FAILED](variables/E_SKILL_SCRIPT_FAILED.md) | Raised when a skill script completes with a nonzero exit code and the deployment leaves `SkillScriptConfig.failOnNonzeroExit` at its default (`true`). The message carries the script name, the exit code, and the retrievable id of the spooled output so the failure is still inspectable. A deployment whose scripts use exit codes as ordinary signalling sets `failOnNonzeroExit: false` and receives the acknowledgement string instead. |\n| [E\\_SKILL\\_SCRIPT\\_GATE\\_UNAVAILABLE](variables/E_SKILL_SCRIPT_GATE_UNAVAILABLE.md) | 503 when the script gate fails for any reason other than an explicit denial; never misroutes an engine failure as 403. |\n| [E\\_SKILL\\_SCRIPT\\_POLICY\\_WIDENED](variables/E_SKILL_SCRIPT_POLICY_WIDENED.md) | Raised when script policy derivation would widen permissions beyond the declared boundary. |\n| [E\\_SKILL\\_SCRIPT\\_TIMEOUT](variables/E_SKILL_SCRIPT_TIMEOUT.md) | Raised when a script exceeds its configured execution deadline. |\n| [E\\_SKILL\\_SOURCE\\_PATH\\_REJECTED](variables/E_SKILL_SOURCE_PATH_REJECTED.md) | Raised when a requested bundled path is unsafe or outside the source namespace. |\n| [E\\_SKILL\\_TOOL\\_BAD\\_RESPONSE](variables/E_SKILL_TOOL_BAD_RESPONSE.md) | Raised when a skill tool returns a value that fails response validation. |\n| [E\\_SKILL\\_TOOL\\_COLLISION](variables/E_SKILL_TOOL_COLLISION.md) | Raised when a skill tool name collides with another registered tool. |\n| [E\\_SKILL\\_TOOL\\_DUPLICATE](variables/E_SKILL_TOOL_DUPLICATE.md) | Raised when one skill declares the same tool name more than once. |\n| [E\\_SKILL\\_TOOL\\_FAILED](variables/E_SKILL_TOOL_FAILED.md) | Raised when a skill tool handler fails during execution. |\n| [E\\_SKILL\\_WORKSPACE\\_FAILED](variables/E_SKILL_WORKSPACE_FAILED.md) | Raised when materialization or disposal of a skill workspace fails. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [createSkillArtifactRegistry](functions/createSkillArtifactRegistry.md) | Resolve all optional artifact classes eagerly. The built-in raw kind is always available; optional artifact batteries are intentionally not imported here. |\n| [createSkillManager](functions/createSkillManager.md) | Create a skills manager. Construct one manager per conversation/session, alongside its runner; share source objects when discovery caching is desired, but never share loaded manager state. |\n| [createSkillMiddlewareSet](functions/createSkillMiddlewareSet.md) | Build the stable four-middleware skills integration surface. |\n| [forgeSkillTools](functions/forgeSkillTools.md) | Forge the five stateful lifecycle tools for one skill manager. |\n| [implementsSkillSource](functions/implementsSkillSource.md) | Duck-guard for the synchronous portion of a source contract. `discover()` returns an async iterable and cannot be duck-checked beyond \"is a function\", so a value passing this guard may still violate the protocol. `runSkillSourceConformance`, from `@nhtio/adk/batteries/skills/conformance`, is the real protocol check. |\n| [parseSkillMd](functions/parseSkillMd.md) | Parse an agentskills.io-shaped SKILL.md for source authors. The manager's load path never calls this helper: sources own descriptor and body authority. Malformed frontmatter degrades to an empty object when it is not a delimited YAML block; malformed YAML is a manifest error. |\n| [renderError](functions/renderError.md) | Render skill runtime errors for the model; configuration errors remain fatal. |\n| [skillsDispatchInputMiddleware](functions/skillsDispatchInputMiddleware.md) | Create the dispatch-input middleware that reconciles skill projections. |\n| [skillsDispatchOutputMiddleware](functions/skillsDispatchOutputMiddleware.md) | Create the dispatch-output middleware that observes and reconciles skill state. |\n| [skillsTurnInputMiddleware](functions/skillsTurnInputMiddleware.md) | Create the turn-input middleware that refreshes and projects loaded skills. |\n| [skillsTurnOutputMiddleware](functions/skillsTurnOutputMiddleware.md) | Create the turn-output middleware that removes this set's skill projections. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/conformance","title":"@nhtio/adk/batteries/skills/conformance","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/conformance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/conformance","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/conformance.md'\ndescription: 'Conformance suite for [`SkillSource`](https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillSource) implementations.'\n---\n\n# @nhtio/adk/batteries/skills/conformance\n\nConformance suite for [SkillSource](../interfaces/SkillSource.md) implementations.\n\nThis is a deep-import-only entrypoint. It has no test-framework dependency and is not\nre-exported by the skills barrel.\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------- | ------------------------------------------------------------------ |\n| [runSkillSourceConformance](functions/runSkillSourceConformance.md) | Run the common SkillSource contract checks against a fresh source. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/conformance/functions/runSkillSourceConformance","title":"Function: runSkillSourceConformance()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/conformance/functions/runSkillSourceConformance.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/conformance/functions/runSkillSourceConformance","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/conformance/functions/runSkillSourceConformance.md\n---\n\n# Function: runSkillSourceConformance()\n\n```ts\nfunction runSkillSourceConformance(\n label: string,\n makeSource: () => SkillSource | Promise,\n): Promise;\n```\n\nDefined in: [src/batteries/skills/conformance/index.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/conformance/index.ts#L18)\n\nRun the common SkillSource contract checks against a fresh source.\n\n## Parameters\n\n| Parameter | Type |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------- |\n| `label` | `string` |\n| `makeSource` | () => | [`SkillSource`](../../interfaces/SkillSource.md) | `Promise`<[`SkillSource`](../../interfaces/SkillSource.md)> |\n\n## Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillArtifactRegistry","title":"Function: createSkillArtifactRegistry()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillArtifactRegistry.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillArtifactRegistry","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/createSkillArtifactRegistry.md\n---\n\n# Function: createSkillArtifactRegistry()\n\n```ts\nfunction createSkillArtifactRegistry(\n config: Pick,\n): Promise;\n```\n\nDefined in: [src/batteries/skills/artifacts.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/artifacts.ts#L45)\n\nResolve all optional artifact classes eagerly. The built-in raw kind is always available;\noptional artifact batteries are intentionally not imported here.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `config` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<[`SkillManagerConfig`](../interfaces/SkillManagerConfig.md), `\"artifactKinds\"` | `\"artifactBindings\"`> |\n\n## Returns\n\n`Promise`<[`SkillArtifactRegistry`](../interfaces/SkillArtifactRegistry.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillManager","title":"Function: createSkillManager()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillManager.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillManager","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/createSkillManager.md\n---\n\n# Function: createSkillManager()\n\n```ts\nfunction createSkillManager(config: SkillManagerConfig): Promise;\n```\n\nDefined in: [src/batteries/skills/manager.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/manager.ts#L84)\n\nCreate a skills manager. Construct one manager per conversation/session, alongside its runner;\nshare source objects when discovery caching is desired, but never share loaded manager state.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------- |\n| `config` | [`SkillManagerConfig`](../interfaces/SkillManagerConfig.md) |\n\n## Returns\n\n`Promise`<[`SkillManager`](../interfaces/SkillManager.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillMiddlewareSet","title":"Function: createSkillMiddlewareSet()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillMiddlewareSet.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/createSkillMiddlewareSet","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/createSkillMiddlewareSet.md\n---\n\n# Function: createSkillMiddlewareSet()\n\n```ts\nfunction createSkillMiddlewareSet(\n manager: SkillManager,\n options?: SkillMiddlewareOptions,\n): SkillMiddlewareSet;\n```\n\nDefined in: [src/batteries/skills/middleware.ts:290](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/middleware.ts#L290)\n\nBuild the stable four-middleware skills integration surface.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `manager` | [`SkillManager`](../interfaces/SkillManager.md) |\n| `options` | [`SkillMiddlewareOptions`](../interfaces/SkillMiddlewareOptions.md) |\n\n## Returns\n\n[`SkillMiddlewareSet`](../interfaces/SkillMiddlewareSet.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/forgeSkillTools","title":"Function: forgeSkillTools()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/forgeSkillTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/forgeSkillTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/forgeSkillTools.md\n---\n\n# Function: forgeSkillTools()\n\n```ts\nfunction forgeSkillTools(\n manager: SkillManager,\n options?: ForgeSkillToolsOptions,\n): Record;\n```\n\nDefined in: [src/batteries/skills/forge.ts:17](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/forge.ts#L17)\n\nForge the five stateful lifecycle tools for one skill manager.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `manager` | [`SkillManager`](../interfaces/SkillManager.md) |\n| `options` | [`ForgeSkillToolsOptions`](../interfaces/ForgeSkillToolsOptions.md) |\n\n## Returns\n\n[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Tool`](../../../forge/classes/Tool.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/implementsSkillSource","title":"Function: implementsSkillSource()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/implementsSkillSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/implementsSkillSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/implementsSkillSource.md\n---\n\n# Function: implementsSkillSource()\n\n```ts\nfunction implementsSkillSource(value: unknown): value is SkillSource;\n```\n\nDefined in: [src/batteries/skills/contracts.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L93)\n\nDuck-guard for the synchronous portion of a source contract. `discover()` returns an async\niterable and cannot be duck-checked beyond \"is a function\", so a value passing this guard may\nstill violate the protocol. `runSkillSourceConformance`, from\n`@nhtio/adk/batteries/skills/conformance`, is the real protocol check.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is SkillSource`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/parseSkillMd","title":"Function: parseSkillMd()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/parseSkillMd.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/parseSkillMd","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/parseSkillMd.md'\n---\n\n# Function: parseSkillMd()\n\n```ts\nfunction parseSkillMd(text: string): {\n body: string;\n frontmatter: Record;\n};\n```\n\nDefined in: [src/batteries/skills/manifest.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/manifest.ts#L10)\n\nParse an agentskills.io-shaped SKILL.md for source authors. The manager's load path never calls\nthis helper: sources own descriptor and body authority. Malformed frontmatter degrades to an\nempty object when it is not a delimited YAML block; malformed YAML is a manifest error.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `text` | `string` |\n\n## Returns\n\n```ts\n{\n body: string;\n frontmatter: Record;\n}\n```\n\n| Name | Type | Defined in |\n| ------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |\n| `body` | `string` | [src/batteries/skills/manifest.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/manifest.ts#L12) |\n| `frontmatter` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | [src/batteries/skills/manifest.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/manifest.ts#L12) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/renderError","title":"Function: renderError()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/renderError.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/renderError","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/renderError.md'\n---\n\n# Function: renderError()\n\n```ts\nfunction renderError(err: unknown): string;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L150)\n\nRender skill runtime errors for the model; configuration errors remain fatal.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `err` | `unknown` |\n\n## Returns\n\n`string`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsDispatchInputMiddleware","title":"Function: skillsDispatchInputMiddleware()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsDispatchInputMiddleware.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsDispatchInputMiddleware","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/skillsDispatchInputMiddleware.md\n---\n\n# Function: skillsDispatchInputMiddleware()\n\n```ts\nfunction skillsDispatchInputMiddleware(\n manager: SkillManager,\n options?: SkillMiddlewareOptions,\n): DispatchPipelineMiddlewareFn;\n```\n\nDefined in: [src/batteries/skills/middleware.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/middleware.ts#L247)\n\nCreate the dispatch-input middleware that reconciles skill projections.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `manager` | [`SkillManager`](../interfaces/SkillManager.md) |\n| `options` | [`SkillMiddlewareOptions`](../interfaces/SkillMiddlewareOptions.md) |\n\n## Returns\n\n[`DispatchPipelineMiddlewareFn`](../../../dispatch_runner/type-aliases/DispatchPipelineMiddlewareFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsDispatchOutputMiddleware","title":"Function: skillsDispatchOutputMiddleware()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsDispatchOutputMiddleware.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsDispatchOutputMiddleware","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/skillsDispatchOutputMiddleware.md\n---\n\n# Function: skillsDispatchOutputMiddleware()\n\n```ts\nfunction skillsDispatchOutputMiddleware(\n manager: SkillManager,\n options?: SkillMiddlewareOptions,\n): DispatchPipelineMiddlewareFn;\n```\n\nDefined in: [src/batteries/skills/middleware.ts:283](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/middleware.ts#L283)\n\nCreate the dispatch-output middleware that observes and reconciles skill state.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `manager` | [`SkillManager`](../interfaces/SkillManager.md) |\n| `options` | [`SkillMiddlewareOptions`](../interfaces/SkillMiddlewareOptions.md) |\n\n## Returns\n\n[`DispatchPipelineMiddlewareFn`](../../../dispatch_runner/type-aliases/DispatchPipelineMiddlewareFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsTurnInputMiddleware","title":"Function: skillsTurnInputMiddleware()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsTurnInputMiddleware.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsTurnInputMiddleware","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/skillsTurnInputMiddleware.md\n---\n\n# Function: skillsTurnInputMiddleware()\n\n```ts\nfunction skillsTurnInputMiddleware(\n manager: SkillManager,\n options?: SkillMiddlewareOptions,\n): TurnPipelineMiddlewareFn;\n```\n\nDefined in: [src/batteries/skills/middleware.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/middleware.ts#L159)\n\nCreate the turn-input middleware that refreshes and projects loaded skills.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `manager` | [`SkillManager`](../interfaces/SkillManager.md) |\n| `options` | [`SkillMiddlewareOptions`](../interfaces/SkillMiddlewareOptions.md) |\n\n## Returns\n\n[`TurnPipelineMiddlewareFn`](../../../turn_runner/type-aliases/TurnPipelineMiddlewareFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsTurnOutputMiddleware","title":"Function: skillsTurnOutputMiddleware()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsTurnOutputMiddleware.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/functions/skillsTurnOutputMiddleware","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/functions/skillsTurnOutputMiddleware.md\n---\n\n# Function: skillsTurnOutputMiddleware()\n\n```ts\nfunction skillsTurnOutputMiddleware(\n manager: SkillManager,\n options?: SkillMiddlewareOptions,\n): TurnPipelineMiddlewareFn;\n```\n\nDefined in: [src/batteries/skills/middleware.ts:208](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/middleware.ts#L208)\n\nCreate the turn-output middleware that removes this set's skill projections.\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `manager` | [`SkillManager`](../interfaces/SkillManager.md) |\n| `options` | [`SkillMiddlewareOptions`](../interfaces/SkillMiddlewareOptions.md) |\n\n## Returns\n\n[`TurnPipelineMiddlewareFn`](../../../turn_runner/type-aliases/TurnPipelineMiddlewareFn.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/in_memory","title":"@nhtio/adk/batteries/skills/in\\_memory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/in_memory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/in_memory","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/in_memory.md'\ndescription: Reference in-memory SkillSource for tests and small deployments.\n---\n\n# @nhtio/adk/batteries/skills/in\\_memory\n\nReference in-memory SkillSource for tests and small deployments.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------- | ---------------------------------------------------------------- |\n| [InMemorySkillSource](classes/InMemorySkillSource.md) | A mutable, deterministic SkillSource backed by SKILL.md strings. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/in_memory/classes/InMemorySkillSource","title":"Class: InMemorySkillSource","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/in_memory/classes/InMemorySkillSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/in_memory/classes/InMemorySkillSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/in_memory/classes/InMemorySkillSource.md\ndescription: 'A mutable, deterministic SkillSource backed by SKILL.md strings.'\n---\n\n# Class: InMemorySkillSource\n\nDefined in: [src/batteries/skills/in\\_memory/index.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L29)\n\nA mutable, deterministic SkillSource backed by SKILL.md strings.\n\n## Implements\n\n* [`SkillSource`](../../interfaces/SkillSource.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew InMemorySkillSource(id: string, entries: readonly {\n descriptor: SkillDescriptor;\n files?: Readonly>>;\n id: string;\n manifest: string;\n version: string;\n}[]): InMemorySkillSource;\n```\n\nDefined in: [src/batteries/skills/in\\_memory/index.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L34)\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `string` |\n| `entries` | readonly { `descriptor`: [`SkillDescriptor`](../../interfaces/SkillDescriptor.md); `files?`: [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string` | `Uint8Array`<`ArrayBufferLike`>>>; `id`: `string`; `manifest`: `string`; `version`: `string`; }\\[] |\n\n#### Returns\n\n`InMemorySkillSource`\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------- | ---------- | -------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `readonly` | `string` | Source provenance stamped onto every discovered reference. | [src/batteries/skills/in\\_memory/index.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L31) |\n\n## Methods\n\n### descriptor()\n\n```ts\ndescriptor(ref: SkillRef): Promise;\n```\n\nDefined in: [src/batteries/skills/in\\_memory/index.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L76)\n\nReturns the live descriptor for a discovered id.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------- |\n| `ref` | [`SkillRef`](../../type-aliases/SkillRef.md) |\n\n#### Returns\n\n`Promise`<[`SkillDescriptor`](../../interfaces/SkillDescriptor.md)>\n\n#### Implementation of\n\n[`SkillSource`](../../interfaces/SkillSource.md).[`descriptor`](../../interfaces/SkillSource.md#descriptor)\n\n***\n\n### discover()\n\n```ts\ndiscover(): AsyncIterable;\n```\n\nDefined in: [src/batteries/skills/in\\_memory/index.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L71)\n\nYields the precomputed routing metadata without loading descriptors.\n\n#### Returns\n\n`AsyncIterable`<[`DiscoveredSkill`](../../interfaces/DiscoveredSkill.md)>\n\n#### Implementation of\n\n[`SkillSource`](../../interfaces/SkillSource.md).[`discover`](../../interfaces/SkillSource.md#discover)\n\n***\n\n### list()\n\n```ts\nlist(ref: SkillRef): Promise;\n```\n\nDefined in: [src/batteries/skills/in\\_memory/index.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L100)\n\nEnumerate bundled files for materialization.\nMUST include every path named by a `SkillScriptSpec`, and MUST NOT include the body.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------- |\n| `ref` | [`SkillRef`](../../type-aliases/SkillRef.md) |\n\n#### Returns\n\n`Promise`\\\n\n#### Implementation of\n\n[`SkillSource`](../../interfaces/SkillSource.md).[`list`](../../interfaces/SkillSource.md#list)\n\n***\n\n### read()\n\n```ts\nread(ref: SkillRef, path?: string): Promise>>;\n```\n\nDefined in: [src/batteries/skills/in\\_memory/index.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L82)\n\nRead a file from the skill. **An omitted `path` means the skill BODY** — the `SKILL.md`\nequivalent — whatever the source calls it internally. Every channel needs the body.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------- |\n| `ref` | [`SkillRef`](../../type-aliases/SkillRef.md) |\n| `path?` | `string` |\n\n#### Returns\n\n`Promise`<`ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>>\n\n#### Implementation of\n\n[`SkillSource`](../../interfaces/SkillSource.md).[`read`](../../interfaces/SkillSource.md#read)\n\n***\n\n### stat()\n\n```ts\nstat(ref: SkillRef, path?: string): Promise<{\n size: number;\n version: string;\n}>;\n```\n\nDefined in: [src/batteries/skills/in\\_memory/index.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/in_memory/index.ts#L92)\n\nReports byte size and current entry version for the body or a bundled file.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------------------------------------------- |\n| `ref` | [`SkillRef`](../../type-aliases/SkillRef.md) |\n| `path?` | `string` |\n\n#### Returns\n\n`Promise`<{\n`size`: `number`;\n`version`: `string`;\n}>\n\n#### Implementation of\n\n[`SkillSource`](../../interfaces/SkillSource.md).[`stat`](../../interfaces/SkillSource.md#stat)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/CatalogEntry","title":"Interface: CatalogEntry","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/CatalogEntry.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/CatalogEntry","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/CatalogEntry.md'\ndescription: A winning catalog candidate or a losing candidate retained for provenance.\n---\n\n# Interface: CatalogEntry\n\nDefined in: [src/batteries/skills/types.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L201)\n\nA winning catalog candidate or a losing candidate retained for provenance.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| -------------------------------------------------------- | ---------- | ----------------------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `loaded` | `readonly` | `boolean` | Whether this catalog candidate is manager-initialized, as consumed by list\\_skills. | [src/batteries/skills/types.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L205) |\n| `ref` | `readonly` | [`SkillRef`](../type-aliases/SkillRef.md) | Discovery metadata consumed by list\\_skills and routing. | [src/batteries/skills/types.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L203) |\n| `shadowedBy?` | `readonly` | [`SkillRef`](../type-aliases/SkillRef.md) | The winning candidate that shadows this losing entry, when applicable. | [src/batteries/skills/types.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L207) |\n| `updateAvailable?` | `readonly` | `boolean` | Whether discovery found a newer version than the initialized record. | [src/batteries/skills/types.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L209) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/DiscoveredSkill","title":"Interface: DiscoveredSkill","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/DiscoveredSkill.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/DiscoveredSkill","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/DiscoveredSkill.md\ndescription: >-\n Discovery result. Carries the ROUTING METADATA — `name` and `description` —\n because that is what `list_skills` shows the model and what it chooses on;\n requiring `descriptor()` to obtain it would mean loading every skill's module\n just to list the catalog.\n---\n\n# Interface: DiscoveredSkill\n\nDefined in: [src/batteries/skills/contracts.ts:8](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L8)\n\nDiscovery result. Carries the ROUTING METADATA — `name` and `description` — because that is\nwhat `list_skills` shows the model and what it chooses on; requiring `descriptor()` to obtain\nit would mean loading every skill's module just to list the catalog.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `compatibility?` | `string` | Free-form compatibility note; surfaced but deliberately not parsed or enforced. | [src/batteries/skills/contracts.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L18) |\n| `description` | `string` | Routing text shown to the model without loading the skill body. | [src/batteries/skills/contracts.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L22) |\n| `id` | `string` | Stable source-assigned identity used for catalog routing and load operations. | [src/batteries/skills/contracts.ts:10](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L10) |\n| `license?` | `string` | agentskills.io passthrough, surfaced pre-load. Optional: a source may not have them. | [src/batteries/skills/contracts.ts:14](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L14) |\n| `metadata?` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>> | Client-specific agentskills.io properties surfaced before load for provenance and audit. | [src/batteries/skills/contracts.ts:16](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L16) |\n| `name` | `string` | Human-facing name used in routing metadata. | [src/batteries/skills/contracts.ts:20](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L20) |\n| `version` | `string` | Source version used to detect an available update without loading the descriptor. | [src/batteries/skills/contracts.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L12) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/ForgeSkillToolsOptions","title":"Interface: ForgeSkillToolsOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/ForgeSkillToolsOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/ForgeSkillToolsOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/ForgeSkillToolsOptions.md\ndescription: >-\n Deployment-time controls for the lifecycle tools forged by {@link\n forgeSkillTools}.\n---\n\n# Interface: ForgeSkillToolsOptions\n\nDefined in: [src/batteries/skills/forge.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/forge.ts#L9)\n\nDeployment-time controls for the lifecycle tools forged by [forgeSkillTools](../functions/forgeSkillTools.md).\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ---------------------------------- | ---------- | -------------------------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| `gate?` | `readonly` | [`ToolGateFn`](../../tools/_shared/type-aliases/ToolGateFn.md) | The gate used for lifecycle mutations. | [src/batteries/skills/forge.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/forge.ts#L11) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/LoadResult","title":"Interface: LoadResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/LoadResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/LoadResult","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/LoadResult.md'\ndescription: >-\n Immediate lifecycle outcome, including the objects registered in this\n dispatch.\n---\n\n# Interface: LoadResult\n\nDefined in: [src/batteries/skills/types.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L223)\n\nImmediate lifecycle outcome, including the objects registered in this dispatch.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `channel` | `readonly` | [`SkillLoadChannel`](../type-aliases/SkillLoadChannel.md) | Channel used to project its body. | [src/batteries/skills/types.ts:227](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L227) |\n| `id` | `readonly` | `string` | Identifier of the skill initialized by the operation. | [src/batteries/skills/types.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L225) |\n| `retrievable?` | `readonly` | [`Retrievable`](../../../common/classes/Retrievable.md) | Body retrievable added to the context. | [src/batteries/skills/types.ts:231](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L231) |\n| `tools` | `readonly` | readonly [`Tool`](../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../spooled_artifact/classes/SpooledArtifact.md)>\\[] | Tools registered as part of the load. | [src/batteries/skills/types.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L229) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/ProjectedSkill","title":"Interface: ProjectedSkill","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/ProjectedSkill.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/ProjectedSkill","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/ProjectedSkill.md\ndescription: The per-context projection of one initialized skill.\n---\n\n# Interface: ProjectedSkill\n\nDefined in: [src/batteries/skills/types.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L213)\n\nThe per-context projection of one initialized skill.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `readonly` | `string` | Skill identity visible in this context's registry. | [src/batteries/skills/types.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L215) |\n| `retrievable?` | `readonly` | [`Retrievable`](../../../common/classes/Retrievable.md) | The projected retrievable body. | [src/batteries/skills/types.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L217) |\n| `tools` | `readonly` | readonly [`Tool`](../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../spooled_artifact/classes/SpooledArtifact.md)>\\[] | Tools projected for this turn. | [src/batteries/skills/types.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L219) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/RefreshResult","title":"Interface: RefreshResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/RefreshResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/RefreshResult","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/RefreshResult.md'\ndescription: >-\n Result of catalog refresh, including versions that now differ from loaded\n state.\n---\n\n# Interface: RefreshResult\n\nDefined in: [src/batteries/skills/types.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L235)\n\nResult of catalog refresh, including versions that now differ from loaded state.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `ids` | `readonly` | readonly `string`\\[] | Skill ids rediscovered or refreshed. | [src/batteries/skills/types.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L237) |\n| `updateAvailable` | `readonly` | readonly `string`\\[] | Entries whose source version differs from loaded state. | [src/batteries/skills/types.ts:239](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L239) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillArtifactRegistry","title":"Interface: SkillArtifactRegistry","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillArtifactRegistry.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillArtifactRegistry","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillArtifactRegistry.md\ndescription: Resolved artifact kinds plus the consumer-owned skill/tool binding table.\n---\n\n# Interface: SkillArtifactRegistry\n\nDefined in: [src/batteries/skills/artifacts.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/artifacts.ts#L9)\n\nResolved artifact kinds plus the consumer-owned skill/tool binding table.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `bindings` | `readonly` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>>>> | Explicit skill-to-tool-to-kind mappings; these override descriptor advice. | [src/batteries/skills/artifacts.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/artifacts.ts#L13) |\n| `kinds` | `readonly` | `ReadonlyMap`<`string`, [`SpooledArtifactConstructor`](../../../forge/type-aliases/SpooledArtifactConstructor.md)> | Constructors keyed by the kind name accepted in bindings and descriptors. | [src/batteries/skills/artifacts.ts:11](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/artifacts.ts#L11) |\n\n## Methods\n\n### resolve()\n\n```ts\nresolve(\n skillId: string,\n toolName: string,\n descriptor?: Pick): SpooledArtifactConstructor;\n```\n\nDefined in: [src/batteries/skills/artifacts.ts:15](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/artifacts.ts#L15)\n\nSelects the binding, then descriptor advice, then the raw built-in kind.\n\n#### Parameters\n\n| Parameter | Type |\n| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `skillId` | `string` |\n| `toolName` | `string` |\n| `descriptor?` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<[`SkillDescriptor`](SkillDescriptor.md), `\"artifactKind\"`> |\n\n#### Returns\n\n[`SpooledArtifactConstructor`](../../../forge/type-aliases/SpooledArtifactConstructor.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillBinaryOutput","title":"Interface: SkillBinaryOutput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillBinaryOutput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillBinaryOutput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillBinaryOutput.md\ndescription: 'Bytes-with-a-content-type: the framework-agnostic path to typed binary.'\n---\n\n# Interface: SkillBinaryOutput\n\nDefined in: [src/batteries/skills/output.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L55)\n\nBytes-with-a-content-type: the framework-agnostic path to typed binary.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------ | ---------- | ------------ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `readonly` | `Uint8Array` | The raw bytes. The host wraps them in a reader via `ctx.storeMediaBytes`. | [src/batteries/skills/output.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L57) |\n| `filename?` | `readonly` | `string` | Optional filename; a stable default derived from the tool name is used when omitted. | [src/batteries/skills/output.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L61) |\n| `mimeType` | `readonly` | `string` | MIME type of the bytes; the `MediaKind` and modality hazard are inferred from it. | [src/batteries/skills/output.ts:59](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L59) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillDescriptor","title":"Interface: SkillDescriptor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillDescriptor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillDescriptor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillDescriptor.md\ndescription: 'Live, source-owned definition resolved when a catalog entry is loaded.'\n---\n\n# Interface: SkillDescriptor\n\nDefined in: [src/batteries/skills/types.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L25)\n\nLive, source-owned definition resolved when a catalog entry is loaded.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ---------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| `artifactKind?` | `readonly` | `string` | Advisory default artifact kind; an explicit registry binding takes precedence. | [src/batteries/skills/types.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L41) |\n| `channel?` | `readonly` | [`SkillLoadChannel`](../type-aliases/SkillLoadChannel.md) | Per-skill override of the manager's body projection channel. | [src/batteries/skills/types.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L35) |\n| `compatibility?` | `readonly` | `string` | Free-form compatibility note surfaced to consumers, never enforced by the battery. | [src/batteries/skills/types.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L58) |\n| `description` | `readonly` | `string` | Resident routing text; the body remains unloaded until explicitly requested. | [src/batteries/skills/types.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L31) |\n| `id` | `readonly` | `string` | Must match the discovered ref; descriptors cannot rename a catalog entry. | [src/batteries/skills/types.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L27) |\n| `isolatedTools?` | `readonly` | readonly [`SkillIsolatedTool`](SkillIsolatedTool.md)\\[] | Tier-2 source tools executed through the configured guest runtime. | [src/batteries/skills/types.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L52) |\n| `license?` | `readonly` | `string` | agentskills.io license passthrough surfaced for audit. | [src/batteries/skills/types.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L54) |\n| `metadata?` | `readonly` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>> | Client-specific agentskills.io properties carried without interpretation. | [src/batteries/skills/types.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L56) |\n| `name` | `readonly` | `string` | Display name paired with the routing description. | [src/batteries/skills/types.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L29) |\n| `scripts?` | `readonly` | readonly [`SkillScriptSpec`](SkillScriptSpec.md)\\[] | Tier-3 scripts; their declared paths are materialized and their argv is battery-built. | [src/batteries/skills/types.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L50) |\n| `toolOutputs?` | `readonly` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`SkillOutputKind`](../type-aliases/SkillOutputKind.md)>> | Optional per-tool declaration of the output shape a module tool produces (`'text'`, `'binary'`, `'media'`, or `'retrievable'`). When set, a runtime return whose sniffed shape disagrees fails `E_SKILL_TOOL_BAD_RESPONSE` rather than being silently reinterpreted; when omitted, the wrapper sniffs the returned shape. Keyed by the tool's own name. | [src/batteries/skills/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L48) |\n| `tools?` | `readonly` | readonly [`Tool`](../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../spooled_artifact/classes/SpooledArtifact.md)>\\[] | First-party live tools to gate, rewrap, and register on load. | [src/batteries/skills/types.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L39) |\n| `trustTier?` | `readonly` | [`RetrievableTrustTier`](../../../common/type-aliases/RetrievableTrustTier.md) | Trust envelope applied when the body is projected into context. | [src/batteries/skills/types.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L37) |\n| `version` | `readonly` | `string` | Version checked against discovery to prevent loading stale or mismatched data. | [src/batteries/skills/types.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L33) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolatedTool","title":"Interface: SkillIsolatedTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolatedTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolatedTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolatedTool.md\ndescription: Tier-2 tool whose source is evaluated inside the configured guest runtime.\n---\n\n# Interface: SkillIsolatedTool\n\nDefined in: [src/batteries/skills/types.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L127)\n\nTier-2 tool whose source is evaluated inside the configured guest runtime.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ---------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `description` | `readonly` | `string` | Model-visible operation description. | [src/batteries/skills/types.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L131) |\n| `name` | `readonly` | `string` | Model-visible tool name. | [src/batteries/skills/types.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L129) |\n| `params?` | `readonly` | readonly [`SkillScriptParam`](SkillScriptParam.md)\\[] | Declared JSON arguments validated before source evaluation. | [src/batteries/skills/types.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L133) |\n| `source` | `readonly` | `string` | A complete async arrow expression: `async (args) => { ... }`. | [src/batteries/skills/types.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L135) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolationConfig","title":"Interface: SkillIsolationConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolationConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolationConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillIsolationConfig.md\ndescription: Tier-2 guest capabilities and termination/timeout controls.\n---\n\n# Interface: SkillIsolationConfig\n\nDefined in: [src/batteries/skills/types.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L139)\n\nTier-2 guest capabilities and termination/timeout controls.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |\n| `defaultTimeoutSeconds` | `number` | Timeout applied when a call omits one. | [src/batteries/skills/types.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L156) |\n| `globals?` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`GuestGlobal`](../../sandbox/interfaces/GuestGlobal.md)>> | Capability implementations made available to isolated skill code. | [src/batteries/skills/types.ts:141](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L141) |\n| `limits?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<[`GuestLimits`](../../sandbox/interfaces/GuestLimits.md)> | Guest resource limits layered onto the runtime defaults. | [src/batteries/skills/types.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L145) |\n| `maxTimeoutSeconds` | `number` | Maximum evaluation timeout the model may request. | [src/batteries/skills/types.ts:154](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L154) |\n| `modules?` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>> | Modules exposed to the guest runtime. | [src/batteries/skills/types.ts:143](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L143) |\n| `resolveGuest?` | (`o`: { `globals`: [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`GuestGlobal`](../../sandbox/interfaces/GuestGlobal.md)>>; `limits`: [`GuestLimits`](../../sandbox/interfaces/GuestLimits.md); `modules`: [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>>; `signal?`: `AbortSignal`; }) => | [`GuestRuntimeLike`](../../sandbox/interfaces/GuestRuntimeLike.md) | `Promise`<[`GuestRuntimeLike`](../../sandbox/interfaces/GuestRuntimeLike.md)> | Structural safety seam: without it, in-process forging requires unsafe opt-in. | [src/batteries/skills/types.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L147) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillManager","title":"Interface: SkillManager","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillManager.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillManager","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillManager.md'\ndescription: Stateful skill lifecycle; construct one manager per conversation or session.\n---\n\n# Interface: SkillManager\n\nDefined in: [src/batteries/skills/types.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L251)\n\nStateful skill lifecycle; construct one manager per conversation or session.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------------------- | ---------- | --------------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `middleware` | `readonly` | [`SkillMiddlewareSet`](SkillMiddlewareSet.md) | Middleware set with stable shape; functionality is derived from manager configuration. | [src/batteries/skills/types.ts:271](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L271) |\n| `unsafe` | `readonly` | readonly `string`\\[] | Explicitly enabled containment controls, derived from the manager configuration. | [src/batteries/skills/types.ts:269](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L269) |\n\n## Methods\n\n### catalog()\n\n```ts\ncatalog(): readonly CatalogEntry[];\n```\n\nDefined in: [src/batteries/skills/types.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L253)\n\nSynchronous resolved catalog, including losing candidates and update flags.\n\n#### Returns\n\nreadonly [`CatalogEntry`](CatalogEntry.md)\\[]\n\n***\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/skills/types.ts:267](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L267)\n\nDisposes skill workspaces and drops all projections, including when middleware is skipped.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### load()\n\n```ts\nload(id: string, ctx: DispatchContext): Promise;\n```\n\nDefined in: [src/batteries/skills/types.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L263)\n\nInitializes and immediately projects a skill's body and tools for this dispatch.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------- |\n| `id` | `string` |\n| `ctx` | [`DispatchContext`](../../../types/interfaces/DispatchContext.md) |\n\n#### Returns\n\n`Promise`<[`LoadResult`](LoadResult.md)>\n\n***\n\n### loaded()\n\n```ts\nloaded(): readonly string[];\n```\n\nDefined in: [src/batteries/skills/types.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L255)\n\nInitialized manager state, independent of any turn context.\n\n#### Returns\n\nreadonly `string`\\[]\n\n***\n\n### projected()\n\n```ts\nprojected(ctx:\n | TurnContext\n | DispatchContext): readonly ProjectedSkill[];\n```\n\nDefined in: [src/batteries/skills/types.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L257)\n\nSkills actually projected into this context and callable in this turn.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `ctx` | | [`TurnContext`](../../../types/interfaces/TurnContext.md) | [`DispatchContext`](../../../types/interfaces/DispatchContext.md) |\n\n#### Returns\n\nreadonly [`ProjectedSkill`](ProjectedSkill.md)\\[]\n\n***\n\n### refresh()\n\n```ts\nrefresh(id?: string): Promise;\n```\n\nDefined in: [src/batteries/skills/types.ts:259](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L259)\n\nCatalog-only rediscovery; never swaps an initialized version.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `id?` | `string` |\n\n#### Returns\n\n`Promise`<[`RefreshResult`](RefreshResult.md)>\n\n***\n\n### refreshAndProject()\n\n```ts\nrefreshAndProject(ctx:\n | TurnContext\n| DispatchContext, id?: string): Promise;\n```\n\nDefined in: [src/batteries/skills/types.ts:261](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L261)\n\nExplicitly re-reads and swaps the loaded version, then projects it into this context.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `ctx` | | [`TurnContext`](../../../types/interfaces/TurnContext.md) | [`DispatchContext`](../../../types/interfaces/DispatchContext.md) |\n| `id?` | `string` |\n\n#### Returns\n\n`Promise`<[`RefreshResult`](RefreshResult.md)>\n\n***\n\n### unload()\n\n```ts\nunload(id: string, ctx: DispatchContext): Promise;\n```\n\nDefined in: [src/batteries/skills/types.ts:265](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L265)\n\nRemoves a skill from initialized state and unregisters its projected tools.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------- |\n| `id` | `string` |\n| `ctx` | [`DispatchContext`](../../../types/interfaces/DispatchContext.md) |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillManagerConfig","title":"Interface: SkillManagerConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillManagerConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillManagerConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillManagerConfig.md\ndescription: >-\n Inputs that determine discovery, projection, and the explicit containment\n exceptions.\n---\n\n# Interface: SkillManagerConfig\n\nDefined in: [src/batteries/skills/types.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L160)\n\nInputs that determine discovery, projection, and the explicit containment exceptions.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `artifactBindings?` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`>>>> | Explicit skill/tool artifact bindings, taking precedence over descriptor advice. | [src/batteries/skills/types.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L170) |\n| `artifactKinds?` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`SpooledKindResolver`](../type-aliases/SpooledKindResolver.md)>> | Named artifact constructors resolved eagerly at manager creation. | [src/batteries/skills/types.ts:168](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L168) |\n| `autoRefresh?` | `boolean` | Refreshes the catalog at turn input without swapping loaded versions. | [src/batteries/skills/types.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L176) |\n| `defaultChannel?` | [`SkillLoadChannel`](../type-aliases/SkillLoadChannel.md) | Fallback body projection channel when a descriptor does not choose one. | [src/batteries/skills/types.ts:166](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L166) |\n| `gate` | [`ToolGateFn`](../../tools/_shared/type-aliases/ToolGateFn.md) | Required gate for lifecycle and skill-tool execution. | [src/batteries/skills/types.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L164) |\n| `isolation?` | [`SkillIsolationConfig`](SkillIsolationConfig.md) | Enables tier-2 isolated tools. | [src/batteries/skills/types.ts:174](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L174) |\n| `scripts?` | [`SkillScriptConfig`](SkillScriptConfig.md) | Enables tier-3 script tools and their skill-scoped workspace. | [src/batteries/skills/types.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L172) |\n| `sources` | readonly [`SkillSourceResolver`](../type-aliases/SkillSourceResolver.md)\\[] | Ordered sources; earlier candidates win id collisions. | [src/batteries/skills/types.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L162) |\n| `unsafe?` | { `isolatedToolsInProcess?`: `true`; `scriptsPermissivePolicy?`: [`SandboxPolicy`](../../sandbox/interfaces/SandboxPolicy.md); `ungatedSkillTools?`: `true`; } | Explicitly named containment controls; each opt-in loses a corresponding safety boundary. | [src/batteries/skills/types.ts:178](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L178) |\n| `unsafe.isolatedToolsInProcess?` | `true` | Permit tier-2 code in the default in-process guest, whose kill is a no-op. | [src/batteries/skills/types.ts:180](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L180) |\n| `unsafe.scriptsPermissivePolicy?` | [`SandboxPolicy`](../../sandbox/interfaces/SandboxPolicy.md) | Replace the derived narrow script policy with caller-supplied permissive policy. | [src/batteries/skills/types.ts:182](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L182) |\n| `unsafe.ungatedSkillTools?` | `true` | Skip the mandatory gate around skill-supplied tools. | [src/batteries/skills/types.ts:184](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L184) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareOptions","title":"Interface: SkillMiddlewareOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareOptions.md\ndescription: Options for the standalone skills middleware factories.\n---\n\n# Interface: SkillMiddlewareOptions\n\nDefined in: [src/batteries/skills/middleware.ts:12](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/middleware.ts#L12)\n\nOptions for the standalone skills middleware factories.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ------------------------------------------------ | ---------- | --------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `autoRefresh?` | `readonly` | `boolean` | Re-discover the catalog before hydrating each non-empty turn. | [src/batteries/skills/middleware.ts:14](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/middleware.ts#L14) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareSet","title":"Interface: SkillMiddlewareSet","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareSet.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareSet","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillMiddlewareSet.md\ndescription: >-\n The four pipeline hooks needed to hydrate, reconcile, observe, and strip skill\n state.\n---\n\n# Interface: SkillMiddlewareSet\n\nDefined in: [src/batteries/skills/types.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L189)\n\nThe four pipeline hooks needed to hydrate, reconcile, observe, and strip skill state.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |\n| `dispatchInput` | [`DispatchPipelineMiddlewareFn`](../../../dispatch_runner/type-aliases/DispatchPipelineMiddlewareFn.md) | Reconciles skill-owned tools before dispatch execution. | [src/batteries/skills/types.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L195) |\n| `dispatchOutput` | [`DispatchPipelineMiddlewareFn`](../../../dispatch_runner/type-aliases/DispatchPipelineMiddlewareFn.md) | Observes changes after dispatch execution; it is not the commit point. | [src/batteries/skills/types.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L197) |\n| `turnInput` | [`TurnPipelineMiddlewareFn`](../../../turn_runner/type-aliases/TurnPipelineMiddlewareFn.md) | Hydrates initialized skills onto a fresh turn context. | [src/batteries/skills/types.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L191) |\n| `turnOutput` | [`TurnPipelineMiddlewareFn`](../../../turn_runner/type-aliases/TurnPipelineMiddlewareFn.md) | Strips projected skill state at the head of turn-output, before any downstream middleware. | [src/batteries/skills/types.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L193) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillRetrievableOutput","title":"Interface: SkillRetrievableOutput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillRetrievableOutput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillRetrievableOutput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillRetrievableOutput.md\ndescription: >-\n A framework-agnostic retrievable descriptor. `content` is plain text; the host\n spools it.\n---\n\n# Interface: SkillRetrievableOutput\n\nDefined in: [src/batteries/skills/output.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L65)\n\nA framework-agnostic retrievable descriptor. `content` is plain text; the host spools it.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |\n| `retrievable` | `readonly` | { `content`: `string`; `inline?`: `boolean`; `kind?`: `string`; `score?`: `number`; `source?`: `string`; } | The retrievable to construct. Its text is spooled behind a handle and its tier is floored. | [src/batteries/skills/output.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L67) |\n| `retrievable.content` | `readonly` | `string` | Plain text the model can cite, search, and hold a handle to. | [src/batteries/skills/output.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L69) |\n| `retrievable.inline?` | `readonly` | `boolean` | Render inline rather than as a handle; defaults to `false`. | [src/batteries/skills/output.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L77) |\n| `retrievable.kind?` | `readonly` | `string` | Optional semantic label (e.g. `'reference'`, `'policy'`); defaults to `'skill-tool'`. | [src/batteries/skills/output.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L73) |\n| `retrievable.score?` | `readonly` | `number` | Optional relevance score in `[0, 1]`. | [src/batteries/skills/output.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L75) |\n| `retrievable.source?` | `readonly` | `string` | Optional provenance string (URL, document path, knowledge-base id). | [src/batteries/skills/output.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L71) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptConfig","title":"Interface: SkillScriptConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptConfig.md\ndescription: 'Tier-3 execution controls, workspace, policy, and output/time ceilings.'\n---\n\n# Interface: SkillScriptConfig\n\nDefined in: [src/batteries/skills/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L93)\n\nTier-3 execution controls, workspace, policy, and output/time ceilings.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `defaultTimeoutSeconds` | `number` | Default timeout used when the model omits one. | [src/batteries/skills/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L109) |\n| `failOnNonzeroExit?` | `boolean` | Whether a nonzero child exit code is a tool failure. Default (or omitted) `true`: a script that exits nonzero throws [E\\_SKILL\\_SCRIPT\\_FAILED](../variables/E_SKILL_SCRIPT_FAILED.md), so a host can detect a broken or rejected script programmatically rather than parsing the exit code out of the acknowledgement string. Set `false` to keep the plain acknowledgement behaviour — any completed run, whatever its exit code, returns the success string — for skills whose scripts use exit codes as ordinary signalling rather than pass/fail. Output is spooled either way; on the failure path the retrievable id is carried in the error. | [src/batteries/skills/types.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L123) |\n| `handle` | [`SandboxHandle`](../../sandbox/interfaces/SandboxHandle.md) | Child-process handle used to execute scripts under the derived policy. | [src/batteries/skills/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L95) |\n| `hostEnvIsolated` | `boolean` | Declares whether the interpreter cannot inherit host environment variables. | [src/batteries/skills/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L113) |\n| `interpreterReadPaths` | readonly `string`\\[] | Host files interpreters may read in addition to the materialized skill root. | [src/batteries/skills/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L105) |\n| `interpreters` | [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, readonly `string`\\[]>> | Allowlisted interpreter argv prefixes keyed by [SkillScriptSpec.interpreter](SkillScriptSpec.md#property-interpreter). | [src/batteries/skills/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L103) |\n| `maxOutputBytes` | `number` | Output ceiling preventing unbounded child-process results. | [src/batteries/skills/types.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L111) |\n| `maxTimeoutSeconds` | `number` | Hard upper bound for model-requested script timeouts. | [src/batteries/skills/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L107) |\n| `policy` | [`SandboxPolicy`](../../sandbox/interfaces/SandboxPolicy.md) | Baseline policy narrowed to the skill's declared capabilities. | [src/batteries/skills/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L99) |\n| `translator` | [`PathTranslator`](../../sandbox/interfaces/PathTranslator.md) | Maps source paths into the sandbox namespace. | [src/batteries/skills/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L101) |\n| `workspace` | [`SkillWorkspace`](SkillWorkspace.md) | Materializes bundled files and disposes roots when the skill leaves the loaded set. | [src/batteries/skills/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L97) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptParam","title":"Interface: SkillScriptParam","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptParam.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptParam","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptParam.md\ndescription: One validated value in the fixed argv contract presented to a script.\n---\n\n# Interface: SkillScriptParam\n\nDefined in: [src/batteries/skills/contracts.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L46)\n\nOne validated value in the fixed argv contract presented to a script.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | --------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `description` | `readonly` | `string` | Argument guidance shown to the model. | [src/batteries/skills/contracts.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L50) |\n| `flag?` | `readonly` | `string` | Rendered as `--flag value` when set, otherwise positionally in declaration order. | [src/batteries/skills/contracts.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L58) |\n| `name` | `readonly` | `string` | Argument name used in validation and argv construction. | [src/batteries/skills/contracts.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L48) |\n| `required?` | `readonly` | `boolean` | Whether omission is rejected before the child process is started. | [src/batteries/skills/contracts.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L56) |\n| `type` | `readonly` | `\"string\"` | `\"number\"` | `\"boolean\"` | `\"enum\"` | Validation/rendering kind; enum values are constrained separately. | [src/batteries/skills/contracts.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L52) |\n| `values?` | `readonly` | readonly `string`\\[] | Allowed values, required when [SkillScriptParam.type](#property-type) is `enum`. | [src/batteries/skills/contracts.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L54) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptSpec","title":"Interface: SkillScriptSpec","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptSpec.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptSpec","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillScriptSpec.md\ndescription: >-\n A model-selectable script bundled with a skill and invoked with declared\n arguments only.\n---\n\n# Interface: SkillScriptSpec\n\nDefined in: [src/batteries/skills/contracts.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L32)\n\nA model-selectable script bundled with a skill and invoked with declared arguments only.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `description` | `readonly` | `string` | Instructions shown alongside the script choice. | [src/batteries/skills/contracts.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L38) |\n| `interpreter` | `readonly` | `string` | Interpreter key resolved through the deployment's interpreter allowlist. | [src/batteries/skills/contracts.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L40) |\n| `name` | `readonly` | `string` | Enum member exposed to the model when selecting this script. | [src/batteries/skills/contracts.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L34) |\n| `params?` | `readonly` | readonly [`SkillScriptParam`](SkillScriptParam.md)\\[] | Declared parameters, passed only in declaration order after the script path. | [src/batteries/skills/contracts.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L42) |\n| `path` | `readonly` | `string` | Source-relative bundled path; it must also be returned by [SkillSource.list](SkillSource.md#list). | [src/batteries/skills/contracts.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L36) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillSource","title":"Interface: SkillSource","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillSource","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillSource.md'\ndescription: >-\n Runtime-neutral source seam for discovery, metadata, body bytes, and bundled\n files.\n---\n\n# Interface: SkillSource\n\nDefined in: [src/batteries/skills/contracts.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L62)\n\nRuntime-neutral source seam for discovery, metadata, body bytes, and bundled files.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `id` | `readonly` | `string` | Stable provenance label; the manager rejects duplicate source ids at configuration time. | [src/batteries/skills/contracts.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L64) |\n\n## Methods\n\n### descriptor()\n\n```ts\ndescriptor(ref: SkillRef, o?: {\n signal?: AbortSignal;\n}): Promise;\n```\n\nDefined in: [src/batteries/skills/contracts.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L68)\n\nResolves the live descriptor and tools only when a manager operation loads the skill.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ----------------------------------------- |\n| `ref` | [`SkillRef`](../type-aliases/SkillRef.md) |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`unknown`>\n\n***\n\n### discover()\n\n```ts\ndiscover(o?: {\n signal?: AbortSignal;\n}): AsyncIterable;\n```\n\nDefined in: [src/batteries/skills/contracts.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L66)\n\nAsynchronously yields discovery metadata; protocol conformance is checked by the suite, not the duck-guard.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------- |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`AsyncIterable`<[`DiscoveredSkill`](DiscoveredSkill.md)>\n\n***\n\n### list()?\n\n```ts\noptional list(ref: SkillRef): Promise;\n```\n\nDefined in: [src/batteries/skills/contracts.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L84)\n\nEnumerate bundled files for materialization.\nMUST include every path named by a `SkillScriptSpec`, and MUST NOT include the body.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------- |\n| `ref` | [`SkillRef`](../type-aliases/SkillRef.md) |\n\n#### Returns\n\n`Promise`\\\n\n***\n\n### read()\n\n```ts\nread(\n ref: SkillRef,\n path?: string,\n o?: {\n signal?: AbortSignal;\n}): Promise>>;\n```\n\nDefined in: [src/batteries/skills/contracts.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L73)\n\nRead a file from the skill. **An omitted `path` means the skill BODY** — the `SKILL.md`\nequivalent — whatever the source calls it internally. Every channel needs the body.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ----------------------------------------- |\n| `ref` | [`SkillRef`](../type-aliases/SkillRef.md) |\n| `path?` | `string` |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>>\n\n***\n\n### stat()\n\n```ts\nstat(ref: SkillRef, path?: string): Promise<{\n size: number;\n version: string;\n}>;\n```\n\nDefined in: [src/batteries/skills/contracts.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L79)\n\nReturns source size and version for a body or bundled file without returning its bytes.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------- |\n| `ref` | [`SkillRef`](../type-aliases/SkillRef.md) |\n| `path?` | `string` |\n\n#### Returns\n\n`Promise`<{\n`size`: `number`;\n`version`: `string`;\n}>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillWorkspace","title":"Interface: SkillWorkspace","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillWorkspace.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/interfaces/SkillWorkspace","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/interfaces/SkillWorkspace.md\ndescription: Skill-scoped materialization service used by tier-3 scripts.\n---\n\n# Interface: SkillWorkspace\n\nDefined in: [src/batteries/skills/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L67)\n\nSkill-scoped materialization service used by tier-3 scripts.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------------------- | ---------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |\n| `fileSystem` | `readonly` | [`SandboxFileSystem`](../../sandbox/interfaces/SandboxFileSystem.md) | Filesystem view used by the sandbox policy and script runner. | [src/batteries/skills/types.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L87) |\n| `root` | `readonly` | `string` | Workspace base used to resolve materializations; individual returned roots remain authoritative. | [src/batteries/skills/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L89) |\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(root: string): Promise;\n```\n\nDefined in: [src/batteries/skills/types.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L85)\n\nRemove one materialization, identified by its returned root rather than by SkillRef. A\nprepare-then-swap refresh can have two live materializations of the same skill at once, and\na workspace using randomized paths cannot distinguish them from the ref and could delete the\nwrong one.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `root` | `string` |\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### materialize()\n\n```ts\nmaterialize(\n skill: SkillRef,\n files: AsyncIterable<{\n bytes: ReadableStream>;\n path: string;\n}>,\n o?: {\n signal?: AbortSignal;\n}): Promise;\n```\n\nDefined in: [src/batteries/skills/types.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L74)\n\nWrite files and return the authoritative absolute materialized root. Callers must use the\nreturned root rather than reconstructing `${root}/${id}`: ids are external data, two sources\nmay offer the same id, and an implementation may add a version or random path segment (and\nMUST do so on id collision).\n\n#### Parameters\n\n| Parameter | Type |\n| ----------- | ---------------------------------------------------------------------------------------------------------- |\n| `skill` | [`SkillRef`](../type-aliases/SkillRef.md) |\n| `files` | `AsyncIterable`<{ `bytes`: `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>>; `path`: `string`; }> |\n| `o?` | { `signal?`: `AbortSignal`; } |\n| `o.signal?` | `AbortSignal` |\n\n#### Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillLoadChannel","title":"Type Alias: SkillLoadChannel","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillLoadChannel.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillLoadChannel","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/type-aliases/SkillLoadChannel.md\ndescription: >-\n Controls whether a loaded body is represented by a handle or rendered inline\n per dispatch.\n---\n\n# Type Alias: SkillLoadChannel\n\n```ts\ntype SkillLoadChannel = \"handle\" | \"inline\";\n```\n\nDefined in: [src/batteries/skills/contracts.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L29)\n\nControls whether a loaded body is represented by a handle or rendered inline per dispatch.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillOutputKind","title":"Type Alias: SkillOutputKind","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillOutputKind.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillOutputKind","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/type-aliases/SkillOutputKind.md\ndescription: >-\n The output kind a descriptor may DECLARE for a tool. When present, a runtime\n shape that disagrees is a detectable failure rather than a silent\n reinterpretation; when absent, the wrapper sniffs.\n---\n\n# Type Alias: SkillOutputKind\n\n```ts\ntype SkillOutputKind = \"text\" | \"binary\" | \"media\" | \"retrievable\";\n```\n\nDefined in: [src/batteries/skills/output.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L52)\n\nThe output kind a descriptor may DECLARE for a tool. When present, a runtime shape that disagrees\nis a detectable failure rather than a silent reinterpretation; when absent, the wrapper sniffs.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillRef","title":"Type Alias: SkillRef","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillRef.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillRef","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/skills/type-aliases/SkillRef.md'\ndescription: >-\n A discovered skill plus manager-assigned provenance. This is what the battery\n passes around.\n---\n\n# Type Alias: SkillRef\n\n```ts\ntype SkillRef = DiscoveredSkill & {\n sourceId: string;\n};\n```\n\nDefined in: [src/batteries/skills/contracts.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L26)\n\nA discovered skill plus manager-assigned provenance. This is what the battery passes around.\n\n## Type Declaration\n\n| Name | Type | Defined in |\n| ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| `sourceId` | `string` | [src/batteries/skills/contracts.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/contracts.ts#L26) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillSourceResolver","title":"Type Alias: SkillSourceResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillSourceResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillSourceResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/type-aliases/SkillSourceResolver.md\ndescription: >-\n A source instance or lazy/default export resolver used during manager\n construction.\n---\n\n# Type Alias: SkillSourceResolver\n\n```ts\ntype SkillSourceResolver =\n | SkillSource\n | (() =>\n | SkillSource\n | {\n default: SkillSource;\n }\n | Promise<\n | SkillSource\n | {\n default: SkillSource;\n }\n >);\n```\n\nDefined in: [src/batteries/skills/types.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L62)\n\nA source instance or lazy/default export resolver used during manager construction.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillTrustTier","title":"Type Alias: SkillTrustTier","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillTrustTier.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SkillTrustTier","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/type-aliases/SkillTrustTier.md\ndescription: >-\n The skill trust tiers the battery threads through, shared by scripts and typed\n output.\n---\n\n# Type Alias: SkillTrustTier\n\n```ts\ntype SkillTrustTier =\n | \"first-party\"\n | \"third-party-public\"\n | \"third-party-private\";\n```\n\nDefined in: [src/batteries/skills/output.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/output.ts#L34)\n\nThe skill trust tiers the battery threads through, shared by scripts and typed output.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SpooledKindResolver","title":"Type Alias: SpooledKindResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SpooledKindResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/type-aliases/SpooledKindResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/type-aliases/SpooledKindResolver.md\ndescription: >-\n An artifact constructor or lazy/default-export resolver for a named skill\n result kind.\n---\n\n# Type Alias: SpooledKindResolver\n\n```ts\ntype SpooledKindResolver =\n | SpooledArtifactConstructor\n | (() =>\n | SpooledArtifactConstructor\n | {\n default: SpooledArtifactConstructor;\n }\n | Promise<\n | SpooledArtifactConstructor\n | {\n default: SpooledArtifactConstructor;\n }\n >);\n```\n\nDefined in: [src/batteries/skills/types.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/types.ts#L243)\n\nAn artifact constructor or lazy/default-export resolver for a named skill result kind.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_INVALID_SKILLS_CONFIG","title":"Variable: E\\_INVALID\\_SKILLS\\_CONFIG","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_INVALID_SKILLS_CONFIG.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_INVALID_SKILLS_CONFIG","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_INVALID_SKILLS_CONFIG.md\ndescription: >-\n Fatal construction error for invalid or unsafe-to-resolve manager\n configuration.\n---\n\n# Variable: E\\_INVALID\\_SKILLS\\_CONFIG\n\n```ts\nconst E_INVALID_SKILLS_CONFIG: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:5](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L5)\n\nFatal construction error for invalid or unsafe-to-resolve manager configuration.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ALREADY_LOADED","title":"Variable: E\\_SKILL\\_ALREADY\\_LOADED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ALREADY_LOADED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ALREADY_LOADED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ALREADY_LOADED.md\ndescription: Raised when load would initialize a skill that is already initialized.\n---\n\n# Variable: E\\_SKILL\\_ALREADY\\_LOADED\n\n```ts\nconst E_SKILL_ALREADY_LOADED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:21](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L21)\n\nRaised when load would initialize a skill that is already initialized.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ARTIFACT_UNAVAILABLE","title":"Variable: E\\_SKILL\\_ARTIFACT\\_UNAVAILABLE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ARTIFACT_UNAVAILABLE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ARTIFACT_UNAVAILABLE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_ARTIFACT_UNAVAILABLE.md\ndescription: Raised when the selected artifact kind was not registered.\n---\n\n# Variable: E\\_SKILL\\_ARTIFACT\\_UNAVAILABLE\n\n```ts\nconst E_SKILL_ARTIFACT_UNAVAILABLE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L77)\n\nRaised when the selected artifact kind was not registered.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_MANIFEST_INVALID","title":"Variable: E\\_SKILL\\_MANIFEST\\_INVALID","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_MANIFEST_INVALID.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_MANIFEST_INVALID","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_MANIFEST_INVALID.md\ndescription: >-\n Raised when source metadata or a descriptor violates the identity/version\n contract.\n---\n\n# Variable: E\\_SKILL\\_MANIFEST\\_INVALID\n\n```ts\nconst E_SKILL_MANIFEST_INVALID: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L37)\n\nRaised when source metadata or a descriptor violates the identity/version contract.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_FOUND","title":"Variable: E\\_SKILL\\_NOT\\_FOUND","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_FOUND.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_FOUND","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_FOUND.md\ndescription: 'Raised when load, refresh, or unload names no winning catalog entry.'\n---\n\n# Variable: E\\_SKILL\\_NOT\\_FOUND\n\n```ts\nconst E_SKILL_NOT_FOUND: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:13](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L13)\n\nRaised when load, refresh, or unload names no winning catalog entry.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_LOADED","title":"Variable: E\\_SKILL\\_NOT\\_LOADED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_LOADED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_LOADED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_NOT_LOADED.md\ndescription: Raised when unload or a loaded-only operation targets an uninitialized skill.\n---\n\n# Variable: E\\_SKILL\\_NOT\\_LOADED\n\n```ts\nconst E_SKILL_NOT_LOADED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L29)\n\nRaised when unload or a loaded-only operation targets an uninitialized skill.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_DENIED","title":"Variable: E\\_SKILL\\_SCRIPT\\_DENIED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_DENIED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_DENIED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_DENIED.md\ndescription: >-\n Explicit 403 refusal by the script policy; this is distinct from a failed\n gate.\n---\n\n# Variable: E\\_SKILL\\_SCRIPT\\_DENIED\n\n```ts\nconst E_SKILL_SCRIPT_DENIED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L93)\n\nExplicit 403 refusal by the script policy; this is distinct from a failed gate.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_FAILED","title":"Variable: E\\_SKILL\\_SCRIPT\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_FAILED.md\ndescription: >-\n Raised when a skill script completes with a nonzero exit code and the\n deployment leaves `SkillScriptConfig.failOnNonzeroExit` at its default\n (`true`). The message carries the script name, the exit code, and the\n retrievable id of the spooled output so the failure is still inspectable. A\n deployment whose scripts use exit codes as ordinary signalling sets\n `failOnNonzeroExit: false` and receives the acknowledgement string instead.\n---\n\n# Variable: E\\_SKILL\\_SCRIPT\\_FAILED\n\n```ts\nconst E_SKILL_SCRIPT_FAILED: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L131)\n\nRaised when a skill script completes with a nonzero exit code and the deployment leaves\n`SkillScriptConfig.failOnNonzeroExit` at its default (`true`). The message carries the script\nname, the exit code, and the retrievable id of the spooled output so the failure is still\ninspectable. A deployment whose scripts use exit codes as ordinary signalling sets\n`failOnNonzeroExit: false` and receives the acknowledgement string instead.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_GATE_UNAVAILABLE","title":"Variable: E\\_SKILL\\_SCRIPT\\_GATE\\_UNAVAILABLE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_GATE_UNAVAILABLE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_GATE_UNAVAILABLE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_GATE_UNAVAILABLE.md\ndescription: >-\n 503 when the script gate fails for any reason other than an explicit denial;\n never misroutes an engine failure as 403.\n---\n\n# Variable: E\\_SKILL\\_SCRIPT\\_GATE\\_UNAVAILABLE\n\n```ts\nconst E_SKILL_SCRIPT_GATE_UNAVAILABLE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L101)\n\n503 when the script gate fails for any reason other than an explicit denial; never misroutes an engine failure as 403.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_POLICY_WIDENED","title":"Variable: E\\_SKILL\\_SCRIPT\\_POLICY\\_WIDENED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_POLICY_WIDENED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_POLICY_WIDENED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_POLICY_WIDENED.md\ndescription: >-\n Raised when script policy derivation would widen permissions beyond the\n declared boundary.\n---\n\n# Variable: E\\_SKILL\\_SCRIPT\\_POLICY\\_WIDENED\n\n```ts\nconst E_SKILL_SCRIPT_POLICY_WIDENED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L109)\n\nRaised when script policy derivation would widen permissions beyond the declared boundary.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_TIMEOUT","title":"Variable: E\\_SKILL\\_SCRIPT\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SCRIPT_TIMEOUT.md\ndescription: Raised when a script exceeds its configured execution deadline.\n---\n\n# Variable: E\\_SKILL\\_SCRIPT\\_TIMEOUT\n\n```ts\nconst E_SKILL_SCRIPT_TIMEOUT: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:117](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L117)\n\nRaised when a script exceeds its configured execution deadline.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SOURCE_PATH_REJECTED","title":"Variable: E\\_SKILL\\_SOURCE\\_PATH\\_REJECTED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SOURCE_PATH_REJECTED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SOURCE_PATH_REJECTED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_SOURCE_PATH_REJECTED.md\ndescription: >-\n Raised when a requested bundled path is unsafe or outside the source\n namespace.\n---\n\n# Variable: E\\_SKILL\\_SOURCE\\_PATH\\_REJECTED\n\n```ts\nconst E_SKILL_SOURCE_PATH_REJECTED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L85)\n\nRaised when a requested bundled path is unsafe or outside the source namespace.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_BAD_RESPONSE","title":"Variable: E\\_SKILL\\_TOOL\\_BAD\\_RESPONSE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_BAD_RESPONSE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_BAD_RESPONSE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_BAD_RESPONSE.md\ndescription: Raised when a skill tool returns a value that fails response validation.\n---\n\n# Variable: E\\_SKILL\\_TOOL\\_BAD\\_RESPONSE\n\n```ts\nconst E_SKILL_TOOL_BAD_RESPONSE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L69)\n\nRaised when a skill tool returns a value that fails response validation.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_COLLISION","title":"Variable: E\\_SKILL\\_TOOL\\_COLLISION","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_COLLISION.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_COLLISION","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_COLLISION.md\ndescription: Raised when a skill tool name collides with another registered tool.\n---\n\n# Variable: E\\_SKILL\\_TOOL\\_COLLISION\n\n```ts\nconst E_SKILL_TOOL_COLLISION: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L45)\n\nRaised when a skill tool name collides with another registered tool.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_DUPLICATE","title":"Variable: E\\_SKILL\\_TOOL\\_DUPLICATE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_DUPLICATE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_DUPLICATE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_DUPLICATE.md\ndescription: Raised when one skill declares the same tool name more than once.\n---\n\n# Variable: E\\_SKILL\\_TOOL\\_DUPLICATE\n\n```ts\nconst E_SKILL_TOOL_DUPLICATE: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L53)\n\nRaised when one skill declares the same tool name more than once.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_FAILED","title":"Variable: E\\_SKILL\\_TOOL\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_TOOL_FAILED.md\ndescription: Raised when a skill tool handler fails during execution.\n---\n\n# Variable: E\\_SKILL\\_TOOL\\_FAILED\n\n```ts\nconst E_SKILL_TOOL_FAILED: CreatedException<[string, string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L61)\n\nRaised when a skill tool handler fails during execution.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_WORKSPACE_FAILED","title":"Variable: E\\_SKILL\\_WORKSPACE\\_FAILED","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_WORKSPACE_FAILED.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/skills/variables/E_SKILL_WORKSPACE_FAILED","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/skills/variables/E_SKILL_WORKSPACE_FAILED.md\ndescription: Raised when materialization or disposal of a skill workspace fails.\n---\n\n# Variable: E\\_SKILL\\_WORKSPACE\\_FAILED\n\n```ts\nconst E_SKILL_WORKSPACE_FAILED: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/skills/exceptions.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/skills/exceptions.ts#L139)\n\nRaised when materialization or disposal of a skill workspace fails.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists","title":"@nhtio/adk/batteries/specialists","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/specialists.md'\ndescription: Environment-neutral aggregate barrel for bundled specialist batteries.\n---\n\n# @nhtio/adk/batteries/specialists\n\nEnvironment-neutral aggregate barrel for bundled specialist batteries.\n\n## Remarks\n\nAggregate barrel for the specialists domain: on-device specialist models — speech-to-text\n(STT), OCR, and image captioning — that run *alongside* the LLM in the same runtime, Node\n**and** browser, rather than delegating to a cloud endpoint. There is no cloud-hosted specialist\nengine by design: the whole point of this domain is local media understanding a BYO executor can\nrun without another network hop, mirroring how `@nhtio/adk/batteries/embeddings` favors\nenvironment-neutral, locally-runnable engines.\n\nThis barrel re-exports each modality's own aggregate barrel in full:\n\n* `@nhtio/adk/batteries/specialists/stt` — speech-to-text (transformers.js/Whisper today).\n* `@nhtio/adk/batteries/specialists/ocr` — optical character recognition (tesseract.js today).\n* `@nhtio/adk/batteries/specialists/caption` — image captioning (transformers.js today).\n* `@nhtio/adk/batteries/specialists/_shared` — the structural contracts and normalization helpers\n (`SpecialistMediaLike`, `isPcmInput`, `toBytes`, `defaultDecodeAudio`, etc.) shared across all\n three modalities.\n\nUnlike `@nhtio/adk/batteries/embeddings`, which excludes its browser/WebGPU-only WebLLM engine\nfrom this level of barrel (reachable only via its own subpath), **every** specialist engine today\nis environment-neutral — Node and browser both, no WebGPU requirement — so all three modality\nbarrels are re-exported here in full with nothing held back. Should a browser-only specialist\nengine be added later, it would be excluded from this barrel for the same reason WebLLM is\nexcluded from the embeddings one, and reachable only through its own subpath.\n\nEach adapter class mirrors the embeddings adapters' shape and lifecycle: constructed with\noptions validated by that engine's own Zod schema, exposing the modality's single-purpose method\n(`transcribe`, `recognize`, `describe`), and reporting model-load progress through the shared\n[@nhtio/adk/batteries/specialists/ocr!BatteryLifecycleHooks](../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md) contract.\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTesseractJsModule\n\nRe-exports [CreateTesseractJsModule](ocr/tesseract_js/types/type-aliases/CreateTesseractJsModule.md)\n\n***\n\n### CreateTesseractJsWorker\n\nRe-exports [CreateTesseractJsWorker](ocr/tesseract_js/types/type-aliases/CreateTesseractJsWorker.md)\n\n***\n\n### CreateTransformersJsCaptionPipeline\n\nRe-exports [CreateTransformersJsCaptionPipeline](caption/transformers_js/types/type-aliases/CreateTransformersJsCaptionPipeline.md)\n\n***\n\n### CreateTransformersJsSttPipeline\n\nRe-exports [CreateTransformersJsSttPipeline](../type-aliases/CreateTransformersJsSttPipeline.md)\n\n***\n\n### DecodeAudioFn\n\nRe-exports [DecodeAudioFn](_shared/type-aliases/DecodeAudioFn.md)\n\n***\n\n### defaultDecodeAudio\n\nRe-exports [defaultDecodeAudio](_shared/variables/defaultDecodeAudio.md)\n\n***\n\n### DescribeOptions\n\nRe-exports [DescribeOptions](caption/transformers_js/types/interfaces/DescribeOptions.md)\n\n***\n\n### DescribeResult\n\nRe-exports [DescribeResult](caption/transformers_js/types/interfaces/DescribeResult.md)\n\n***\n\n### E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS](ocr/tesseract_js/exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS](caption/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS](../variables/E_INVALID_TRANSFORMERS_JS_STT_OPTIONS.md)\n\n***\n\n### E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR](ocr/tesseract_js/exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR](caption/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR](../variables/E_TRANSFORMERS_JS_STT_ENGINE_ERROR.md)\n\n***\n\n### isPcmInput\n\nRe-exports [isPcmInput](_shared/functions/isPcmInput.md)\n\n***\n\n### RecognizeOptions\n\nRe-exports [RecognizeOptions](ocr/tesseract_js/types/interfaces/RecognizeOptions.md)\n\n***\n\n### RecognizeResult\n\nRe-exports [RecognizeResult](ocr/tesseract_js/types/interfaces/RecognizeResult.md)\n\n***\n\n### SpecialistAudioInput\n\nRe-exports [SpecialistAudioInput](_shared/type-aliases/SpecialistAudioInput.md)\n\n***\n\n### SpecialistBytesInput\n\nRe-exports [SpecialistBytesInput](_shared/interfaces/SpecialistBytesInput.md)\n\n***\n\n### SpecialistImageInput\n\nRe-exports [SpecialistImageInput](_shared/type-aliases/SpecialistImageInput.md)\n\n***\n\n### SpecialistMediaLike\n\nRe-exports [SpecialistMediaLike](_shared/interfaces/SpecialistMediaLike.md)\n\n***\n\n### SpecialistPcmInput\n\nRe-exports [SpecialistPcmInput](_shared/interfaces/SpecialistPcmInput.md)\n\n***\n\n### SttSegment\n\nRe-exports [SttSegment](../interfaces/SttSegment.md)\n\n***\n\n### TesseractJsModule\n\nRe-exports [TesseractJsModule](ocr/tesseract_js/types/type-aliases/TesseractJsModule.md)\n\n***\n\n### TesseractJsOcrAdapter\n\nRe-exports [TesseractJsOcrAdapter](ocr/tesseract_js/adapter/classes/TesseractJsOcrAdapter.md)\n\n***\n\n### TesseractJsOcrAdapterOptions\n\nRe-exports [TesseractJsOcrAdapterOptions](ocr/tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions.md)\n\n***\n\n### tesseractJsOcrOptionsSchema\n\nRe-exports [tesseractJsOcrOptionsSchema](ocr/tesseract_js/validation/variables/tesseractJsOcrOptionsSchema.md)\n\n***\n\n### TesseractJsWorker\n\nRe-exports [TesseractJsWorker](ocr/tesseract_js/types/type-aliases/TesseractJsWorker.md)\n\n***\n\n### toBytes\n\nRe-exports [toBytes](_shared/functions/toBytes.md)\n\n***\n\n### TranscribeOptions\n\nRe-exports [TranscribeOptions](../interfaces/TranscribeOptions.md)\n\n***\n\n### TranscribeResult\n\nRe-exports [TranscribeResult](../interfaces/TranscribeResult.md)\n\n***\n\n### TransformersJsCaptionAdapter\n\nRe-exports [TransformersJsCaptionAdapter](caption/transformers_js/adapter/classes/TransformersJsCaptionAdapter.md)\n\n***\n\n### TransformersJsCaptionAdapterOptions\n\nRe-exports [TransformersJsCaptionAdapterOptions](caption/transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions.md)\n\n***\n\n### TransformersJsCaptionDataType\n\nRe-exports [TransformersJsCaptionDataType](caption/transformers_js/types/type-aliases/TransformersJsCaptionDataType.md)\n\n***\n\n### TransformersJsCaptionDeviceType\n\nRe-exports [TransformersJsCaptionDeviceType](caption/transformers_js/types/type-aliases/TransformersJsCaptionDeviceType.md)\n\n***\n\n### TransformersJsCaptionModelSource\n\nRe-exports [TransformersJsCaptionModelSource](caption/transformers_js/types/type-aliases/TransformersJsCaptionModelSource.md)\n\n***\n\n### transformersJsCaptionOptionsSchema\n\nRe-exports [transformersJsCaptionOptionsSchema](caption/transformers_js/validation/variables/transformersJsCaptionOptionsSchema.md)\n\n***\n\n### TransformersJsCaptionPipeline\n\nRe-exports [TransformersJsCaptionPipeline](caption/transformers_js/types/type-aliases/TransformersJsCaptionPipeline.md)\n\n***\n\n### TransformersJsCaptionProgressCallback\n\nRe-exports [TransformersJsCaptionProgressCallback](caption/transformers_js/types/type-aliases/TransformersJsCaptionProgressCallback.md)\n\n***\n\n### TransformersJsSttAdapter\n\nRe-exports [TransformersJsSttAdapter](../classes/TransformersJsSttAdapter.md)\n\n***\n\n### TransformersJsSttAdapterOptions\n\nRe-exports [TransformersJsSttAdapterOptions](../interfaces/TransformersJsSttAdapterOptions.md)\n\n***\n\n### transformersJsSttAdapterOptionsSchema\n\nRe-exports [transformersJsSttAdapterOptionsSchema](../variables/transformersJsSttAdapterOptionsSchema.md)\n\n***\n\n### TransformersJsSttDataType\n\nRe-exports [TransformersJsSttDataType](../type-aliases/TransformersJsSttDataType.md)\n\n***\n\n### TransformersJsSttDeviceType\n\nRe-exports [TransformersJsSttDeviceType](../type-aliases/TransformersJsSttDeviceType.md)\n\n***\n\n### TransformersJsSttModelSource\n\nRe-exports [TransformersJsSttModelSource](../type-aliases/TransformersJsSttModelSource.md)\n\n***\n\n### TransformersJsSttPipeline\n\nRe-exports [TransformersJsSttPipeline](../type-aliases/TransformersJsSttPipeline.md)\n\n***\n\n### TransformersJsSttProgressCallback\n\nRe-exports [TransformersJsSttProgressCallback](../type-aliases/TransformersJsSttProgressCallback.md)\n\n***\n\n### validateTesseractJsOcrOptions\n\nRenames and re-exports [validateOptions](ocr/tesseract_js/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsCaptionOptions\n\nRenames and re-exports [validateOptions](caption/transformers_js/validation/functions/validateOptions.md)\n\n***\n\n### validateTransformersJsSttOptions\n\nRe-exports [validateTransformersJsSttOptions](../functions/validateTransformersJsSttOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared","title":"@nhtio/adk/batteries/specialists/\\_shared","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared.md'\ndescription: >-\n Structural contracts and normalization helpers shared by the on-device\n specialist batteries (STT / OCR / caption).\n---\n\n# @nhtio/adk/batteries/specialists/\\_shared\n\nStructural contracts and normalization helpers shared by the on-device specialist batteries\n(STT / OCR / caption).\n\n## Remarks\n\nThis module imports **nothing** from `@nhtio/adk` core — not even a type-only import — per\nCONTRIBUTING.md → Design Decisions → #13 \"Battery design — no concrete core-class coupling\",\ntier 2 (locally-declared structural duck-types). A specialist adapter is *handed* media at\nruntime (an image to caption, an audio clip to transcribe) but never constructs a `Media`\nitself, so it has no genuine reason to import the class: [SpecialistMediaLike](interfaces/SpecialistMediaLike.md) declares\nthe exact shape it reads (`mimeType` + `asBytes()`), and a real core `Media` instance satisfies\nit automatically, with zero import edge between the specialists domain and core.\n\n[defaultDecodeAudio](variables/defaultDecodeAudio.md) is the one capability a specialist adapter cannot perform itself\n(turning arbitrary container bytes into PCM) — it lazily imports the optional `audio-decode`\npeer (already a package dependency, mirroring `src/batteries/media/engines/audio_decode.ts`)\nrather than requiring every consumer to inject a decoder. Consumers who want a different decode\npath (or want to avoid the peer entirely) inject their own [DecodeAudioFn](type-aliases/DecodeAudioFn.md).\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SpecialistBytesInput](interfaces/SpecialistBytesInput.md) | Raw bytes plus an optional MIME type — the plain-object form of image/document input. |\n| [SpecialistMediaLike](interfaces/SpecialistMediaLike.md) | Structural duck-type of core `Media`: the exact shape a specialist adapter reads off a media value — its declared MIME type, and an async accessor for its raw bytes. |\n| [SpecialistPcmInput](interfaces/SpecialistPcmInput.md) | Already-decoded mono PCM audio at a known sample rate — bypasses container decoding entirely. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [DecodeAudioFn](type-aliases/DecodeAudioFn.md) | Injected audio-decode seam: turns encoded container bytes into mono PCM at the container's source sample rate. Consumers may swap this for their own decoder (a different codec library, a cached/pre-warmed instance, or a test double) without the specialists domain ever depending on a concrete implementation. |\n| [SpecialistAudioInput](type-aliases/SpecialistAudioInput.md) | Any of the forms a specialist adapter accepts as audio input: an encoded container (any [SpecialistImageInput](type-aliases/SpecialistImageInput.md) form — bytes, bytes+mime, or media-like) that the adapter decodes via a [DecodeAudioFn](type-aliases/DecodeAudioFn.md), or pre-decoded [SpecialistPcmInput](interfaces/SpecialistPcmInput.md) that skips decoding. |\n| [SpecialistImageInput](type-aliases/SpecialistImageInput.md) | Any of the three forms a specialist adapter accepts as image/document input: a bare `Uint8Array` (MIME type unknown), a [SpecialistBytesInput](interfaces/SpecialistBytesInput.md) record (bytes + declared MIME), or a [SpecialistMediaLike](interfaces/SpecialistMediaLike.md) (a real `Media` or any duck-typed equivalent). |\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [defaultDecodeAudio](variables/defaultDecodeAudio.md) | Default [DecodeAudioFn](type-aliases/DecodeAudioFn.md): lazily imports the optional `audio-decode` peer, decodes the container, then downmixes to mono via [downmixToMono](../../../lib/utils/audio/functions/downmixToMono.md). |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [isPcmInput](functions/isPcmInput.md) | Narrows `input` to [SpecialistPcmInput](interfaces/SpecialistPcmInput.md) — `true` when it carries a `Float32Array` `pcm` field and a numeric `sampleRate` field. |\n| [toBytes](functions/toBytes.md) | Normalizes any [SpecialistImageInput](type-aliases/SpecialistImageInput.md) form to plain bytes plus an optional MIME type. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/functions/isPcmInput","title":"Function: isPcmInput()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/functions/isPcmInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/functions/isPcmInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/functions/isPcmInput.md\n---\n\n# Function: isPcmInput()\n\n```ts\nfunction isPcmInput(input: unknown): input is SpecialistPcmInput;\n```\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L81)\n\nNarrows `input` to [SpecialistPcmInput](../interfaces/SpecialistPcmInput.md) — `true` when it carries a `Float32Array` `pcm`\nfield and a numeric `sampleRate` field.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------------------------------------------------------------------------------------ |\n| `input` | `unknown` | The value to test (typically a [SpecialistAudioInput](../type-aliases/SpecialistAudioInput.md)). |\n\n## Returns\n\n`input is SpecialistPcmInput`\n\nWhether `input` is already-decoded PCM rather than an encoded container.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/functions/toBytes","title":"Function: toBytes()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/functions/toBytes.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/functions/toBytes","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/functions/toBytes.md\n---\n\n# Function: toBytes()\n\n```ts\nfunction toBytes(input: SpecialistImageInput): Promise<{\n bytes: Uint8Array;\n mimeType?: string;\n}>;\n```\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L101)\n\nNormalizes any [SpecialistImageInput](../type-aliases/SpecialistImageInput.md) form to plain bytes plus an optional MIME type.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------- | ---------------------------------------------- |\n| `input` | [`SpecialistImageInput`](../type-aliases/SpecialistImageInput.md) | The image/document input in any accepted form. |\n\n## Returns\n\n`Promise`<{\n`bytes`: `Uint8Array`;\n`mimeType?`: `string`;\n}>\n\nThe normalized bytes and MIME type (MIME `undefined` only for the bare-`Uint8Array` form).\n\n## Remarks\n\nA bare `Uint8Array` passes through with `mimeType: undefined` (the caller declared no MIME).\nA [SpecialistBytesInput](../interfaces/SpecialistBytesInput.md) passes its `bytes`/`mimeType` through unchanged. A\n[SpecialistMediaLike](../interfaces/SpecialistMediaLike.md) is resolved by awaiting `asBytes()` and reading `mimeType` off it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistBytesInput","title":"Interface: SpecialistBytesInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistBytesInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistBytesInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistBytesInput.md\ndescription: >-\n Raw bytes plus an optional MIME type — the plain-object form of image/document\n input.\n---\n\n# Interface: SpecialistBytesInput\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L45)\n\nRaw bytes plus an optional MIME type — the plain-object form of image/document input.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ------------ | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `bytes` | `Uint8Array` | The raw encoded bytes (e.g. a PNG/JPEG/PDF page image). | [src/batteries/specialists/\\_shared/index.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L47) |\n| `mimeType?` | `string` | The MIME type of `bytes`, when known. | [src/batteries/specialists/\\_shared/index.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L49) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistMediaLike","title":"Interface: SpecialistMediaLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistMediaLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistMediaLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistMediaLike.md\ndescription: >-\n Structural duck-type of core `Media`: the exact shape a specialist adapter\n reads off a media value — its declared MIME type, and an async accessor for\n its raw bytes.\n---\n\n# Interface: SpecialistMediaLike\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:37](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L37)\n\nStructural duck-type of core `Media`: the exact shape a specialist adapter reads off a media\nvalue — its declared MIME type, and an async accessor for its raw bytes.\n\n## Remarks\n\nA real `@nhtio/adk` `Media` instance satisfies this interface structurally (it has both a\n`mimeType` string property and an `asBytes(): Promise` method), so callers can pass\na `Media` straight through without the specialists domain ever importing the class. See the\nmodule remarks for why this is a deliberate decoupling choice (CONTRIBUTING.md Design Decision\n\\#13, tier 2).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ----------------------------------------- | -------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `mimeType` | `string` | The media's declared MIME type, e.g. `'image/png'` or `'audio/wav'`. | [src/batteries/specialists/\\_shared/index.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L39) |\n\n## Methods\n\n### asBytes()\n\n```ts\nasBytes(): Promise>;\n```\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L41)\n\nResolves the media's raw bytes.\n\n#### Returns\n\n`Promise`<`Uint8Array`<`ArrayBufferLike`>>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistPcmInput","title":"Interface: SpecialistPcmInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistPcmInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistPcmInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistPcmInput.md\ndescription: >-\n Already-decoded mono PCM audio at a known sample rate — bypasses container\n decoding entirely.\n---\n\n# Interface: SpecialistPcmInput\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L60)\n\nAlready-decoded mono PCM audio at a known sample rate — bypasses container decoding entirely.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------- | -------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `pcm` | `Float32Array` | Mono PCM samples. | [src/batteries/specialists/\\_shared/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L62) |\n| `sampleRate` | `number` | The sample rate of `pcm`, in Hz. | [src/batteries/specialists/\\_shared/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L64) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/DecodeAudioFn","title":"Type Alias: DecodeAudioFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/DecodeAudioFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/DecodeAudioFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/DecodeAudioFn.md\ndescription: >-\n Injected audio-decode seam: turns encoded container bytes into mono PCM at the\n container's source sample rate. Consumers may swap this for their own decoder\n (a different codec library, a cached/pre-warmed instance, or a test double)\n without the specialists domain ever depending on a concrete implementation.\n---\n\n# Type Alias: DecodeAudioFn\n\n```ts\ntype DecodeAudioFn = (bytes: Uint8Array) => Promise<{\n pcm: Float32Array;\n sampleRate: number;\n}>;\n```\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L122)\n\nInjected audio-decode seam: turns encoded container bytes into mono PCM at the container's\nsource sample rate. Consumers may swap this for their own decoder (a different codec library, a\ncached/pre-warmed instance, or a test double) without the specialists domain ever depending on a\nconcrete implementation.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------ | ----------------------------------------------------- |\n| `bytes` | `Uint8Array` | The encoded audio container bytes (wav/mp3/flac/etc). |\n\n## Returns\n\n`Promise`<{\n`pcm`: `Float32Array`;\n`sampleRate`: `number`;\n}>\n\nThe decoded mono PCM samples and the source sample rate, in Hz.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistAudioInput","title":"Type Alias: SpecialistAudioInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistAudioInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistAudioInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistAudioInput.md\ndescription: >-\n Any of the forms a specialist adapter accepts as audio input: an encoded\n container (any [`SpecialistImageInput`](https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistImageInput) form — bytes, bytes+mime, or\n media-like) that the adapter decodes via a [`DecodeAudioFn`](https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/DecodeAudioFn), or\n pre-decoded [`SpecialistPcmInput`](https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistPcmInput) that skips decoding.\n---\n\n# Type Alias: SpecialistAudioInput\n\n```ts\ntype SpecialistAudioInput = SpecialistImageInput | SpecialistPcmInput;\n```\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L72)\n\nAny of the forms a specialist adapter accepts as audio input: an encoded container (any\n[SpecialistImageInput](SpecialistImageInput.md) form — bytes, bytes+mime, or media-like) that the adapter decodes\nvia a [DecodeAudioFn](DecodeAudioFn.md), or pre-decoded [SpecialistPcmInput](../interfaces/SpecialistPcmInput.md) that skips decoding.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistImageInput","title":"Type Alias: SpecialistImageInput","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistImageInput.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistImageInput","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/SpecialistImageInput.md\ndescription: >-\n Any of the three forms a specialist adapter accepts as image/document input: a\n bare `Uint8Array` (MIME type unknown), a [`SpecialistBytesInput`](https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistBytesInput) record\n (bytes + declared MIME), or a [`SpecialistMediaLike`](https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/interfaces/SpecialistMediaLike) (a real `Media` or\n any duck-typed equivalent).\n---\n\n# Type Alias: SpecialistImageInput\n\n```ts\ntype SpecialistImageInput =\n | Uint8Array\n | SpecialistBytesInput\n | SpecialistMediaLike;\n```\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L57)\n\nAny of the three forms a specialist adapter accepts as image/document input: a bare\n`Uint8Array` (MIME type unknown), a [SpecialistBytesInput](../interfaces/SpecialistBytesInput.md) record (bytes + declared\nMIME), or a [SpecialistMediaLike](../interfaces/SpecialistMediaLike.md) (a real `Media` or any duck-typed equivalent).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/variables/defaultDecodeAudio","title":"Variable: defaultDecodeAudio","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/variables/defaultDecodeAudio.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/_shared/variables/defaultDecodeAudio","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/variables/defaultDecodeAudio.md\ndescription: >-\n Default [`DecodeAudioFn`](https://adk.nht.io/api/@nhtio/adk/batteries/specialists/_shared/type-aliases/DecodeAudioFn): lazily imports the optional `audio-decode`\n peer, decodes the container, then downmixes to mono via [`downmixToMono`](https://adk.nht.io/api/@nhtio/adk/lib/utils/audio/functions/downmixToMono).\n---\n\n# Variable: defaultDecodeAudio\n\n```ts\nconst defaultDecodeAudio: DecodeAudioFn;\n```\n\nDefined in: [src/batteries/specialists/\\_shared/index.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/_shared/index.ts#L165)\n\nDefault [DecodeAudioFn](../type-aliases/DecodeAudioFn.md): lazily imports the optional `audio-decode` peer, decodes the\ncontainer, then downmixes to mono via [downmixToMono](../../../../lib/utils/audio/functions/downmixToMono.md).\n\n## Remarks\n\n`audio-decode` resolves to one of two shapes depending on codec/environment: an\nAudioBuffer-compatible object (`numberOfChannels` + `getChannelData()`) or a plain\n`{ channelData: Float32Array[], sampleRate }` record (e.g. the wav path in Node). Both are\nnormalized identically to how `src/batteries/media/engines/audio_decode.ts` handles them,\nlifted into this standalone function rather than shared code (that engine's own copy stays\nuntouched — it belongs to the media battery, not to specialists).\n\n## Param\n\n**bytes**\n\nThe encoded audio container bytes.\n\n## Returns\n\nThe decoded mono PCM samples and the source sample rate, in Hz.\n\n## Throws\n\nAn `Error` naming the install command when the `audio-decode` peer is not installed.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption","title":"@nhtio/adk/batteries/specialists/caption","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption.md'\ndescription: Caption (image-to-text) specialist modality barrel.\n---\n\n# @nhtio/adk/batteries/specialists/caption\n\nCaption (image-to-text) specialist modality barrel.\n\n## Remarks\n\nRe-exports every caption adapter battery. Today that's the transformers.js (ONNX, dual-environment)\nadapter; future adapters for this modality are added here alongside it.\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTransformersJsCaptionPipeline\n\nRe-exports [CreateTransformersJsCaptionPipeline](transformers_js/types/type-aliases/CreateTransformersJsCaptionPipeline.md)\n\n***\n\n### DescribeOptions\n\nRe-exports [DescribeOptions](transformers_js/types/interfaces/DescribeOptions.md)\n\n***\n\n### DescribeResult\n\nRe-exports [DescribeResult](transformers_js/types/interfaces/DescribeResult.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS](transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md)\n\n***\n\n### TransformersJsCaptionAdapter\n\nRe-exports [TransformersJsCaptionAdapter](transformers_js/adapter/classes/TransformersJsCaptionAdapter.md)\n\n***\n\n### TransformersJsCaptionAdapterOptions\n\nRe-exports [TransformersJsCaptionAdapterOptions](transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions.md)\n\n***\n\n### TransformersJsCaptionDataType\n\nRe-exports [TransformersJsCaptionDataType](transformers_js/types/type-aliases/TransformersJsCaptionDataType.md)\n\n***\n\n### TransformersJsCaptionDeviceType\n\nRe-exports [TransformersJsCaptionDeviceType](transformers_js/types/type-aliases/TransformersJsCaptionDeviceType.md)\n\n***\n\n### TransformersJsCaptionModelSource\n\nRe-exports [TransformersJsCaptionModelSource](transformers_js/types/type-aliases/TransformersJsCaptionModelSource.md)\n\n***\n\n### transformersJsCaptionOptionsSchema\n\nRe-exports [transformersJsCaptionOptionsSchema](transformers_js/validation/variables/transformersJsCaptionOptionsSchema.md)\n\n***\n\n### TransformersJsCaptionPipeline\n\nRe-exports [TransformersJsCaptionPipeline](transformers_js/types/type-aliases/TransformersJsCaptionPipeline.md)\n\n***\n\n### TransformersJsCaptionProgressCallback\n\nRe-exports [TransformersJsCaptionProgressCallback](transformers_js/types/type-aliases/TransformersJsCaptionProgressCallback.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](transformers_js/validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js","title":"@nhtio/adk/batteries/specialists/caption/transformers\\_js","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js.md\ndescription: >-\n transformers.js Caption specialist battery — dual-environment ONNX\n image-to-text.\n---\n\n# @nhtio/adk/batteries/specialists/caption/transformers\\_js\n\ntransformers.js Caption specialist battery — dual-environment ONNX image-to-text.\n\n## Remarks\n\nEnvironment-neutral (Node + browser, ONNX Runtime auto-selected). Re-exports the adapter class, the\nvalidation schema + `validateOptions` wrapper, every option / pipeline type alias, and the\nbattery-scoped exceptions.\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTransformersJsCaptionPipeline\n\nRe-exports [CreateTransformersJsCaptionPipeline](types/type-aliases/CreateTransformersJsCaptionPipeline.md)\n\n***\n\n### DescribeOptions\n\nRe-exports [DescribeOptions](types/interfaces/DescribeOptions.md)\n\n***\n\n### DescribeResult\n\nRe-exports [DescribeResult](types/interfaces/DescribeResult.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS](exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR](exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md)\n\n***\n\n### TransformersJsCaptionAdapter\n\nRe-exports [TransformersJsCaptionAdapter](adapter/classes/TransformersJsCaptionAdapter.md)\n\n***\n\n### TransformersJsCaptionAdapterOptions\n\nRe-exports [TransformersJsCaptionAdapterOptions](types/interfaces/TransformersJsCaptionAdapterOptions.md)\n\n***\n\n### TransformersJsCaptionDataType\n\nRe-exports [TransformersJsCaptionDataType](types/type-aliases/TransformersJsCaptionDataType.md)\n\n***\n\n### TransformersJsCaptionDeviceType\n\nRe-exports [TransformersJsCaptionDeviceType](types/type-aliases/TransformersJsCaptionDeviceType.md)\n\n***\n\n### TransformersJsCaptionModelSource\n\nRe-exports [TransformersJsCaptionModelSource](types/type-aliases/TransformersJsCaptionModelSource.md)\n\n***\n\n### transformersJsCaptionOptionsSchema\n\nRe-exports [transformersJsCaptionOptionsSchema](validation/variables/transformersJsCaptionOptionsSchema.md)\n\n***\n\n### TransformersJsCaptionPipeline\n\nRe-exports [TransformersJsCaptionPipeline](types/type-aliases/TransformersJsCaptionPipeline.md)\n\n***\n\n### TransformersJsCaptionProgressCallback\n\nRe-exports [TransformersJsCaptionProgressCallback](types/type-aliases/TransformersJsCaptionProgressCallback.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter","title":"@nhtio/adk/batteries/specialists/caption/transformers\\_js/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter.md\ndescription: >-\n transformers.js (ONNX, dual-environment) Caption (image-to-text) specialist\n adapter battery.\n---\n\n# @nhtio/adk/batteries/specialists/caption/transformers\\_js/adapter\n\ntransformers.js (ONNX, dual-environment) Caption (image-to-text) specialist adapter battery.\n\n## Remarks\n\nImage-captioning battery backed by transformers.js's `image-to-text` pipeline (the documented\nreference model is `Xenova/vit-gpt2-image-captioning`). **Environment-neutral** — runs in Node (via\n`onnxruntime-node`) and the browser (via `onnxruntime-web` / WebGPU), auto-selected by the package;\nthere is no WebGPU requirement.\n\nSame shape as the transformers.js Embeddings battery: eager constructor validation, a required\n`model` (no default), a lazily-imported/single-flight peer, `preload()` / `reset()` / `dispose()`,\nand the shared lifecycle hooks.\n\n**Image input:** [@nhtio/adk/batteries/specialists/\\_shared!toBytes](../../../_shared/functions/toBytes.md) normalizes the accepted\n[@nhtio/adk/batteries/specialists/\\_shared!SpecialistImageInput](../../../_shared/type-aliases/SpecialistImageInput.md) forms (bytes / bytes+mime /\nmedia-like) to plain bytes + an optional MIME type. Those bytes become a plain `Blob` — the\n`image-to-text` pipeline's `ImageInput` union directly accepts `Blob` (verified against the\ninstalled `@huggingface/transformers` 4.2.0 type declarations, alongside `string | RawImage | URL |\nHTMLCanvasElement | OffscreenCanvas`), so building a `Blob` needs no peer import at all — `Blob` is a\ncross-env global (Node 18+ and every browser). This keeps the adapter's hot path peer-free until the\npipeline itself is resolved, and means fake-pipeline unit tests never load `@huggingface/transformers`.\n\n`@huggingface/transformers` is an optional peer dependency, imported lazily (only inside\nmakeDefaultCreatePipeline, i.e. only when no `pipeline`/`createPipeline` override is supplied).\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------- |\n| [TransformersJsCaptionAdapter](classes/TransformersJsCaptionAdapter.md) | Caption (image-to-text) adapter for transformers.js's `image-to-text` pipeline. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter/classes/TransformersJsCaptionAdapter","title":"Class: TransformersJsCaptionAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter/classes/TransformersJsCaptionAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter/classes/TransformersJsCaptionAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/adapter/classes/TransformersJsCaptionAdapter.md\ndescription: >-\n Caption (image-to-text) adapter for transformers.js's `image-to-text`\n pipeline.\n---\n\n# Class: TransformersJsCaptionAdapter\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L93)\n\nCaption (image-to-text) adapter for transformers.js's `image-to-text` pipeline.\n\n## Remarks\n\nReusable: construct once, call [TransformersJsCaptionAdapter.describe](#describe) as many times as\nneeded. The pipeline is resolved lazily on first use (or via [preload](#preload)) and cached with\nsingle-flight semantics so concurrent calls share one load.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew TransformersJsCaptionAdapter(options: unknown): TransformersJsCaptionAdapter;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L110)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`TransformersJsCaptionAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md) when invalid.\n\n## Methods\n\n### describe()\n\n```ts\ndescribe(input: SpecialistImageInput, opts?: DescribeOptions): Promise;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L215)\n\nGenerates a caption for an image.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | [`SpecialistImageInput`](../../../../_shared/type-aliases/SpecialistImageInput.md) | The image in any [@nhtio/adk/batteries/specialists/\\_shared!SpecialistImageInput](../../../../_shared/type-aliases/SpecialistImageInput.md) form (bytes / bytes+mime / media-like). |\n| `opts?` | [`DescribeOptions`](../../types/interfaces/DescribeOptions.md) | Per-call options (`maxNewTokens`, forwarded as `max_new_tokens`; omitted when unset). |\n\n#### Returns\n\n`Promise`<[`DescribeResult`](../../types/interfaces/DescribeResult.md)>\n\nThe normalized `{ text }` caption result.\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR](../../exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md) when the call fails or\nthe pipeline returns no usable caption text (an empty/missing caption is treated as an engine\nfailure, not a valid empty result — a captioner that produces nothing didn't do its job).\n\n***\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:140](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L140)\n\nRelease the loaded model's ONNX sessions + GPU/wasm buffers, then drop the cached pipeline.\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\n`reset()` only nulls the JS reference; the native ONNX Runtime sessions and WebGPU/wasm device memory\nstay alive until GC. `ImageToTextPipeline` extends `Pipeline`, which exposes `dispose()` — this\nawaits it so the memory is reclaimed between loads, swallows a disposal error (teardown must not\nthrow), and finishes with `reset()`. Idempotent.\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L116)\n\nInstance availability probe (honours an injected `isAvailable`).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L121)\n\nEagerly loads (and caches) the pipeline so the first `describe` call is fast. Idempotent.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L126)\n\nDrops the cached pipeline and in-flight load so the next call reloads.\n\n#### Returns\n\n`void`\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/adapter.ts:102](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/adapter.ts#L102)\n\nWhether this battery is available. transformers.js is environment-neutral (Node + browser), so\nthis is `true` whenever the runtime can import the peer — there is no WebGPU requirement.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions","title":"@nhtio/adk/batteries/specialists/caption/transformers\\_js/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions.md\ndescription: >-\n Battery-scoped exception constructors for the transformers.js Caption\n specialist adapter.\n---\n\n# @nhtio/adk/batteries/specialists/caption/transformers\\_js/exceptions\n\nBattery-scoped exception constructors for the transformers.js Caption specialist adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the transformers.js (`@huggingface/transformers`) Caption\n(image-to-text) adapter, minted via `createException` from `@nhtio/adk/factories`. Categories mirror\nthe embeddings/STT specialist batteries one-to-one — only the engine-specific failure differs.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS](variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `transformersJsCaptionOptionsSchema` — e.g. a missing/empty `model` or an unknown option key. Fatal: config bugs fail loud, not at describe time. |\n| [E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR](variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md) | Thrown when the transformers.js pipeline fails to load (e.g. the `@huggingface/transformers` peer is not installed), the `image-to-text` call throws, or the result is malformed/empty (a captioner that returns no text is an engine failure, not a valid empty caption). Non-fatal. Printf arg: `[detail]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS","title":"Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `transformersJsCaptionOptionsSchema` — e.g. a missing/empty `model` or an\n unknown option key. Fatal: config bugs fail loud, not at describe time.\n---\n\n# Variable: E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS\n\n```ts\nconst E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/exceptions.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/exceptions.ts#L19)\n\nThrown when the resolved adapter options fail validation against\n`transformersJsCaptionOptionsSchema` — e.g. a missing/empty `model` or an unknown option key.\nFatal: config bugs fail loud, not at describe time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR","title":"Variable: E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/exceptions/variables/E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR.md\ndescription: >-\n Thrown when the transformers.js pipeline fails to load (e.g. the\n `@huggingface/transformers` peer is not installed), the `image-to-text` call\n throws, or the result is malformed/empty (a captioner that returns no text is\n an engine failure, not a valid empty caption). Non-fatal. Printf arg:\n `[detail]`.\n---\n\n# Variable: E\\_TRANSFORMERS\\_JS\\_CAPTION\\_ENGINE\\_ERROR\n\n```ts\nconst E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/exceptions.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/exceptions.ts#L33)\n\nThrown when the transformers.js pipeline fails to load (e.g. the `@huggingface/transformers` peer\nis not installed), the `image-to-text` call throws, or the result is malformed/empty (a captioner\nthat returns no text is an engine failure, not a valid empty caption). Non-fatal. Printf arg:\n`[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types","title":"@nhtio/adk/batteries/specialists/caption/transformers\\_js/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types.md\ndescription: >-\n Option and pipeline types for the transformers.js Caption (image-to-text)\n specialist adapter.\n---\n\n# @nhtio/adk/batteries/specialists/caption/transformers\\_js/types\n\nOption and pipeline types for the transformers.js Caption (image-to-text) specialist adapter.\n\n## Remarks\n\nMirrors `src/batteries/embeddings/transformers_js/types.ts` in shape and style: a lazily-imported,\nenvironment-neutral `@huggingface/transformers` peer, an injectable pipeline/factory seam, a\n`modelSource` resolver, and the shared lifecycle-hooks contract. `device`/`dtype`/`modelSource`/\n`onInitProgress` are **local aliases** of `@huggingface/transformers` types, never direct re-exports\nof the externalized peer.\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [DescribeOptions](interfaces/DescribeOptions.md) | Per-call options for [@nhtio/adk/batteries/specialists/caption/transformers\\_js!TransformersJsCaptionAdapter.describe](../adapter/classes/TransformersJsCaptionAdapter.md#describe). |\n| [DescribeResult](interfaces/DescribeResult.md) | The normalized result of a caption request. |\n| [TransformersJsCaptionAdapterOptions](interfaces/TransformersJsCaptionAdapterOptions.md) | Constructor options for the transformers.js Caption (image-to-text) adapter. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | ----- | ----- | --- |\n| [CreateTransformersJsCaptionPipeline](type-aliases/CreateTransformersJsCaptionPipeline.md) | Factory for lazily creating an image-to-text pipeline. Defaults to a dynamic import of `@huggingface/transformers` + `pipeline('image-to-text', …)`; override to inject a pre-built pipeline or a test double. |\n| [TransformersJsCaptionDataType](type-aliases/TransformersJsCaptionDataType.md) | Quantization/precision dtype: `'auto' | 'fp32' | 'fp16' | 'q8' | 'q4' | …`. |\n| [TransformersJsCaptionDeviceType](type-aliases/TransformersJsCaptionDeviceType.md) | Inference device: `'auto' | 'webgpu' | 'wasm' | 'cpu' | 'gpu' | …`. |\n| [TransformersJsCaptionModelSource](type-aliases/TransformersJsCaptionModelSource.md) | Custom model-source resolver — the dual-environment seam for serving model files from OPFS, a different source, or bundled bytes (see the LLM battery's `model_source` module). Called once per file; return bytes / a path-or-URL string / a `Response`, or `undefined` to fall through to HF. |\n| [TransformersJsCaptionPipeline](type-aliases/TransformersJsCaptionPipeline.md) | The transformers.js `image-to-text` pipeline this battery drives. |\n| [TransformersJsCaptionProgressCallback](type-aliases/TransformersJsCaptionProgressCallback.md) | Model-load progress callback. |\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeOptions","title":"Interface: DescribeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeOptions.md\ndescription: >-\n Per-call options for {@link\n @nhtio/adk/batteries/specialists/caption/transformers_js!TransformersJsCaptionAdapter.describe}.\n---\n\n# Interface: DescribeOptions\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L113)\n\nPer-call options for [@nhtio/adk/batteries/specialists/caption/transformers\\_js!TransformersJsCaptionAdapter.describe](../../adapter/classes/TransformersJsCaptionAdapter.md#describe).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------- | -------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `maxNewTokens?` | `number` | Generation budget forwarded to the pipeline as `max_new_tokens`. Omitted when unset. | [src/batteries/specialists/caption/transformers\\_js/types.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L115) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeResult","title":"Interface: DescribeResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/DescribeResult.md\ndescription: The normalized result of a caption request.\n---\n\n# Interface: DescribeResult\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L119)\n\nThe normalized result of a caption request.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------- | -------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `text` | `string` | The generated caption text. | [src/batteries/specialists/caption/transformers\\_js/types.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L121) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions","title":"Interface: TransformersJsCaptionAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/interfaces/TransformersJsCaptionAdapterOptions.md\ndescription: Constructor options for the transformers.js Caption (image-to-text) adapter.\n---\n\n# Interface: TransformersJsCaptionAdapterOptions\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L89)\n\nConstructor options for the transformers.js Caption (image-to-text) adapter.\n\n## Remarks\n\n`model` is required — there is no default. The documented reference model is\n`Xenova/vit-gpt2-image-captioning`.\n\n## Extends\n\n* [`BatteryLifecycleHooks`](../../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createPipeline?` | [`CreateTransformersJsCaptionPipeline`](../type-aliases/CreateTransformersJsCaptionPipeline.md) | Override the pipeline factory. Default: `pipeline('image-to-text', …)` via dynamic import. | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L95) |\n| `device?` | | `\"auto\"` | `\"gpu\"` | `\"cpu\"` | `\"wasm\"` | `\"webgpu\"` | `\"cuda\"` | `\"dml\"` | `\"coreml\"` | `\"webnn\"` | `\"webnn-npu\"` | `\"webnn-gpu\"` | `\"webnn-cpu\"` | Inference device forwarded to `pipeline()`. Default: transformers.js environment default. | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L97) |\n| `dtype?` | | `\"auto\"` | `\"fp32\"` | `\"fp16\"` | `\"q8\"` | `\"int8\"` | `\"uint8\"` | `\"q4\"` | `\"bnb4\"` | `\"q4f16\"` | `\"q2\"` | `\"q2f16\"` | `\"q1\"` | `\"q1f16\"` | Quantization/precision dtype forwarded to `pipeline()`. | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L99) |\n| `isAvailable?` | () => `boolean` | Override the availability probe. Default: `true` whenever the peer is importable (env-neutral). | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L109) |\n| `model` | `string` | The image-to-text model id, e.g. `Xenova/vit-gpt2-image-captioning`. Required — no default. | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L91) |\n| `modelSource?` | [`TransformersJsCaptionModelSource`](../type-aliases/TransformersJsCaptionModelSource.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 [TransformersJsCaptionModelSource](../type-aliases/TransformersJsCaptionModelSource.md). | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L105) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `onInitProgress?` | `ProgressCallback` | Called with model-load progress reports while weights download/compile. | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L107) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `pipeline?` | [`TransformersJsCaptionPipeline`](../type-aliases/TransformersJsCaptionPipeline.md) | A pre-built pipeline. When provided, the battery uses it directly and skips lazy creation. | - | [src/batteries/specialists/caption/transformers\\_js/types.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L93) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/CreateTransformersJsCaptionPipeline","title":"Type Alias: CreateTransformersJsCaptionPipeline","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/CreateTransformersJsCaptionPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/CreateTransformersJsCaptionPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/CreateTransformersJsCaptionPipeline.md\ndescription: >-\n Factory for lazily creating an image-to-text pipeline. Defaults to a dynamic\n import of `@huggingface/transformers` + `pipeline('image-to-text', …)`;\n override to inject a pre-built pipeline or a test double.\n---\n\n# Type Alias: CreateTransformersJsCaptionPipeline\n\n```ts\ntype CreateTransformersJsCaptionPipeline = (input: {\n device?: TransformersJsCaptionDeviceType;\n dtype?: TransformersJsCaptionDataType;\n model: string;\n onInitProgress?: TransformersJsCaptionProgressCallback;\n}) => Promise;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L75)\n\nFactory for lazily creating an image-to-text pipeline. Defaults to a dynamic import of\n`@huggingface/transformers` + `pipeline('image-to-text', …)`; override to inject a pre-built\npipeline or a test double.\n\n## Parameters\n\n| Parameter | Type |\n| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `device?`: [`TransformersJsCaptionDeviceType`](TransformersJsCaptionDeviceType.md); `dtype?`: [`TransformersJsCaptionDataType`](TransformersJsCaptionDataType.md); `model`: `string`; `onInitProgress?`: [`TransformersJsCaptionProgressCallback`](TransformersJsCaptionProgressCallback.md); } |\n| `input.device?` | [`TransformersJsCaptionDeviceType`](TransformersJsCaptionDeviceType.md) |\n| `input.dtype?` | [`TransformersJsCaptionDataType`](TransformersJsCaptionDataType.md) |\n| `input.model` | `string` |\n| `input.onInitProgress?` | [`TransformersJsCaptionProgressCallback`](TransformersJsCaptionProgressCallback.md) |\n\n## Returns\n\n`Promise`<[`TransformersJsCaptionPipeline`](TransformersJsCaptionPipeline.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDataType","title":"Type Alias: TransformersJsCaptionDataType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDataType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDataType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDataType.md\ndescription: 'Quantization/precision dtype: `''auto''|''fp32''|''fp16''|''q8''|''q4''|…`.'\n---\n\n# Type Alias: TransformersJsCaptionDataType\n\n```ts\ntype TransformersJsCaptionDataType = TransformersDataType;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L31)\n\nQuantization/precision dtype: `'auto'|'fp32'|'fp16'|'q8'|'q4'|…`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDeviceType","title":"Type Alias: TransformersJsCaptionDeviceType","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDeviceType.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDeviceType","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionDeviceType.md\ndescription: 'Inference device: `''auto''|''webgpu''|''wasm''|''cpu''|''gpu''|…`.'\n---\n\n# Type Alias: TransformersJsCaptionDeviceType\n\n```ts\ntype TransformersJsCaptionDeviceType = TransformersDeviceType;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L33)\n\nInference device: `'auto'|'webgpu'|'wasm'|'cpu'|'gpu'|…`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionModelSource","title":"Type Alias: TransformersJsCaptionModelSource","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionModelSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionModelSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionModelSource.md\ndescription: >-\n Custom model-source resolver — the dual-environment seam for serving model\n files from OPFS, a different source, or bundled bytes (see the LLM battery's\n `model_source` module). Called once per file; return bytes / a path-or-URL\n string / a `Response`, or `undefined` to fall through to HF.\n---\n\n# Type Alias: TransformersJsCaptionModelSource\n\n```ts\ntype TransformersJsCaptionModelSource = (req: {\n filename: string;\n repo: string;\n}) =>\n | Promise\n | Uint8Array\n | string\n | Response\n | undefined;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L60)\n\nCustom model-source resolver — the dual-environment seam for serving model files from OPFS, a\ndifferent source, or bundled bytes (see the LLM battery's `model_source` module). Called once per\nfile; return bytes / a path-or-URL string / a `Response`, or `undefined` to fall through to HF.\n\n## Parameters\n\n| Parameter | Type |\n| -------------- | --------------------------------------------- |\n| `req` | { `filename`: `string`; `repo`: `string`; } |\n| `req.filename` | `string` |\n| `req.repo` | `string` |\n\n## Returns\n\n| `Promise`<`Uint8Array` | `string` | `Response` | `undefined`>\n| `Uint8Array`\n| `string`\n| `Response`\n| `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionPipeline","title":"Type Alias: TransformersJsCaptionPipeline","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionPipeline.md\ndescription: The transformers.js `image-to-text` pipeline this battery drives.\n---\n\n# Type Alias: TransformersJsCaptionPipeline\n\n```ts\ntype TransformersJsCaptionPipeline = (\n image: unknown,\n options?: {\n max_new_tokens?: number;\n },\n) => Promise<\n | {\n generated_text: string;\n }[]\n | {\n generated_text: string;\n }[][]\n | {\n generated_text: string;\n }\n>;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L48)\n\nThe transformers.js `image-to-text` pipeline this battery drives.\n\n## Parameters\n\n| Parameter | Type |\n| ------------------------- | ---------------------------------- |\n| `image` | `unknown` |\n| `options?` | { `max_new_tokens?`: `number`; } |\n| `options.max_new_tokens?` | `number` |\n\n## Returns\n\n`Promise`<\n| {\n`generated_text`: `string`;\n}\\[]\n| {\n`generated_text`: `string`;\n}\\[]\\[]\n| {\n`generated_text`: `string`;\n}>\n\n## Remarks\n\nLocally shaped (not a re-export of `ImageToTextPipeline`) so this module never imports\n`@huggingface/transformers` as a value — only as a type, resolved lazily at runtime. Accepts\nwhatever image value the adapter builds (a `Blob`, per [TransformersJsCaptionAdapterOptions](../interfaces/TransformersJsCaptionAdapterOptions.md)'s\nadapter — see the adapter module remarks for why a `Blob` needs no peer import) and an options bag;\nreturns either a single-result array, a nested array (batch of images), or a bare single-result\nobject, each shaped `{ generated_text: string }`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionProgressCallback","title":"Type Alias: TransformersJsCaptionProgressCallback","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionProgressCallback.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionProgressCallback","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/types/type-aliases/TransformersJsCaptionProgressCallback.md\ndescription: Model-load progress callback.\n---\n\n# Type Alias: TransformersJsCaptionProgressCallback\n\n```ts\ntype TransformersJsCaptionProgressCallback = ProgressCallback;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/types.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/types.ts#L35)\n\nModel-load progress callback.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation","title":"@nhtio/adk/batteries/specialists/caption/transformers\\_js/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation.md\ndescription: >-\n Runtime validation schema and wrapper for transformers.js Caption adapter\n options.\n---\n\n# @nhtio/adk/batteries/specialists/caption/transformers\\_js/validation\n\nRuntime validation schema and wrapper for transformers.js Caption adapter options.\n\n## Remarks\n\nValidates `TransformersJsCaptionAdapterOptions` at construction time. Throws\n`E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS` on failure. `model` is required; unknown top-level keys\nare rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| [transformersJsCaptionOptionsSchema](variables/transformersJsCaptionOptionsSchema.md) | Validator schema for `TransformersJsCaptionAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | -------------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `transformersJsCaptionOptionsSchema`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): TransformersJsCaptionAdapterOptions;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/validation.ts:55](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/validation.ts#L55)\n\nValidates an arbitrary input against `transformersJsCaptionOptionsSchema`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`TransformersJsCaptionAdapterOptions`](../../types/interfaces/TransformersJsCaptionAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TRANSFORMERS\\_JS\\_CAPTION\\_OPTIONS](../../exceptions/variables/E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS.md) when invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/variables/transformersJsCaptionOptionsSchema","title":"Variable: transformersJsCaptionOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/variables/transformersJsCaptionOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/variables/transformersJsCaptionOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/caption/transformers_js/validation/variables/transformersJsCaptionOptionsSchema.md\ndescription: >-\n Validator schema for `TransformersJsCaptionAdapterOptions`. Rejects unknown\n top-level keys.\n---\n\n# Variable: transformersJsCaptionOptionsSchema\n\n```ts\nconst transformersJsCaptionOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/specialists/caption/transformers\\_js/validation.ts:18](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/caption/transformers_js/validation.ts#L18)\n\nValidator schema for `TransformersJsCaptionAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr","title":"@nhtio/adk/batteries/specialists/ocr","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr.md'\ndescription: Environment-neutral aggregate barrel for bundled OCR specialist batteries.\n---\n\n# @nhtio/adk/batteries/specialists/ocr\n\nEnvironment-neutral aggregate barrel for bundled OCR specialist batteries.\n\n## Remarks\n\nAggregate barrel for the OCR specialist batteries. Today this re-exports the tesseract.js\nbattery — environment-neutral (Node + browser, no native binary), so it's reachable from this\nshared modality barrel same as the other environment-neutral specialist batteries. Deep-import\n`@nhtio/adk/batteries/specialists/ocr/tesseract_js` directly if you only need that one battery.\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTesseractJsModule\n\nRe-exports [CreateTesseractJsModule](tesseract_js/types/type-aliases/CreateTesseractJsModule.md)\n\n***\n\n### CreateTesseractJsWorker\n\nRe-exports [CreateTesseractJsWorker](tesseract_js/types/type-aliases/CreateTesseractJsWorker.md)\n\n***\n\n### E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS](tesseract_js/exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md)\n\n***\n\n### E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR](tesseract_js/exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md)\n\n***\n\n### RecognizeOptions\n\nRe-exports [RecognizeOptions](tesseract_js/types/interfaces/RecognizeOptions.md)\n\n***\n\n### RecognizeResult\n\nRe-exports [RecognizeResult](tesseract_js/types/interfaces/RecognizeResult.md)\n\n***\n\n### TesseractJsModule\n\nRe-exports [TesseractJsModule](tesseract_js/types/type-aliases/TesseractJsModule.md)\n\n***\n\n### TesseractJsOcrAdapter\n\nRe-exports [TesseractJsOcrAdapter](tesseract_js/adapter/classes/TesseractJsOcrAdapter.md)\n\n***\n\n### TesseractJsOcrAdapterOptions\n\nRe-exports [TesseractJsOcrAdapterOptions](tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions.md)\n\n***\n\n### tesseractJsOcrOptionsSchema\n\nRe-exports [tesseractJsOcrOptionsSchema](tesseract_js/validation/variables/tesseractJsOcrOptionsSchema.md)\n\n***\n\n### TesseractJsWorker\n\nRe-exports [TesseractJsWorker](tesseract_js/types/type-aliases/TesseractJsWorker.md)\n\n***\n\n### validateTesseractJsOcrOptions\n\nRenames and re-exports [validateOptions](tesseract_js/validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js","title":"@nhtio/adk/batteries/specialists/ocr/tesseract\\_js","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js.md'\ndescription: tesseract.js OCR specialist adapter battery — dual-environment WASM Tesseract.\n---\n\n# @nhtio/adk/batteries/specialists/ocr/tesseract\\_js\n\ntesseract.js OCR specialist adapter battery — dual-environment WASM Tesseract.\n\n## Remarks\n\nEnvironment-neutral (Node + browser, no native binary) — a construct-once specialist adapter\nholding a single cached worker (see the adapter's module remarks for the deliberate divergence\nfrom the per-call-worker `MediaEngine`). Re-exports the adapter class, the validation schema +\n`validateOptions` wrapper, every option/result type alias, and the battery-scoped exceptions.\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTesseractJsModule\n\nRe-exports [CreateTesseractJsModule](types/type-aliases/CreateTesseractJsModule.md)\n\n***\n\n### CreateTesseractJsWorker\n\nRe-exports [CreateTesseractJsWorker](types/type-aliases/CreateTesseractJsWorker.md)\n\n***\n\n### E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS](exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md)\n\n***\n\n### E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR](exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md)\n\n***\n\n### RecognizeOptions\n\nRe-exports [RecognizeOptions](types/interfaces/RecognizeOptions.md)\n\n***\n\n### RecognizeResult\n\nRe-exports [RecognizeResult](types/interfaces/RecognizeResult.md)\n\n***\n\n### TesseractJsModule\n\nRe-exports [TesseractJsModule](types/type-aliases/TesseractJsModule.md)\n\n***\n\n### TesseractJsOcrAdapter\n\nRe-exports [TesseractJsOcrAdapter](adapter/classes/TesseractJsOcrAdapter.md)\n\n***\n\n### TesseractJsOcrAdapterOptions\n\nRe-exports [TesseractJsOcrAdapterOptions](types/interfaces/TesseractJsOcrAdapterOptions.md)\n\n***\n\n### tesseractJsOcrOptionsSchema\n\nRe-exports [tesseractJsOcrOptionsSchema](validation/variables/tesseractJsOcrOptionsSchema.md)\n\n***\n\n### TesseractJsWorker\n\nRe-exports [TesseractJsWorker](types/type-aliases/TesseractJsWorker.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter","title":"@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter.md\ndescription: >-\n tesseract.js (WASM Tesseract, dual-environment) OCR specialist adapter\n battery.\n---\n\n# @nhtio/adk/batteries/specialists/ocr/tesseract\\_js/adapter\n\ntesseract.js (WASM Tesseract, dual-environment) OCR specialist adapter battery.\n\n## Remarks\n\nOCR battery backed by `tesseract.js` — Node and browsers, no native binary. Environment-neutral,\nmirroring the transformers.js embeddings battery's dual-environment posture.\n\n**Divergence from `src/batteries/media/engines/tesseract_js.ts`:** that `MediaEngine` creates a\nfresh worker **per convert call** and terminates it in a `finally` — correct for a stateless,\npossibly-concurrent conversion pipeline, but it pays tesseract's ~1-2s WASM boot on every single\ncall. This adapter is a construct-once specialist object (the same posture as\n[@nhtio/adk/batteries/embeddings/transformers\\_js!TransformersJsEmbeddingsAdapter](../../../../embeddings/transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter.md)): a\nconsumer builds it once and calls [TesseractJsOcrAdapter.recognize](classes/TesseractJsOcrAdapter.md#recognize) repeatedly, so it holds\n**one cached worker**, created single-flight on first use (or via preload), and reused\nacross calls. `dispose()` terminates it; `reset()` also terminates it (see its own TSDoc for why\nthat differs from the embeddings adapter's `reset()`). Consumers who need the per-call-worker,\nleak-free-by-construction posture should use the media engine instead.\n\n`tesseract.js` is an optional peer dependency, lazily imported on first actual use.\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------------------- | ------------------------------- |\n| [TesseractJsOcrAdapter](classes/TesseractJsOcrAdapter.md) | OCR adapter for `tesseract.js`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter/classes/TesseractJsOcrAdapter","title":"Class: TesseractJsOcrAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter/classes/TesseractJsOcrAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter/classes/TesseractJsOcrAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/adapter/classes/TesseractJsOcrAdapter.md\ndescription: OCR adapter for `tesseract.js`.\n---\n\n# Class: TesseractJsOcrAdapter\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L70)\n\nOCR adapter for `tesseract.js`.\n\n## Remarks\n\nReusable: construct once, call [recognize](#recognize) as many times as needed. The worker is\nresolved lazily on first use (or via [preload](#preload)) and cached with single-flight semantics so\nconcurrent calls share one load. See the module remarks for how this deliberately diverges from\nthe per-call-worker `MediaEngine` in `src/batteries/media/engines/tesseract_js.ts`.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew TesseractJsOcrAdapter(options: unknown): TesseractJsOcrAdapter;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L87)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | --------------------------------------- |\n| `options` | `unknown` | Constructor options. Validated eagerly. |\n\n#### Returns\n\n`TesseractJsOcrAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS](../../exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md) when invalid.\n\n## Methods\n\n### dispose()\n\n```ts\ndispose(): Promise;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L127)\n\nTerminates the cached worker and drops the cached handle. Alias of [reset](#reset) — both\nreclaim the same underlying resource for this adapter (see [reset](#reset)'s TSDoc).\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L92)\n\nInstance availability probe (honours an injected `isAvailable`).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L97)\n\nEagerly loads (and caches) the worker so the first `recognize` call is fast. Idempotent.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### recognize()\n\n```ts\nrecognize(input: SpecialistImageInput, opts?: RecognizeOptions): Promise;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L188)\n\nRecognizes text in an image.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | [`SpecialistImageInput`](../../../../_shared/type-aliases/SpecialistImageInput.md) | The image/document input (bytes, bytes+MIME, or a `Media`-like value). |\n| `opts?` | [`RecognizeOptions`](../../types/interfaces/RecognizeOptions.md) | Per-call options. `opts.languages`, when given, must equal the constructor's `languages` (order-insensitive) — tesseract.js v7 workers do not support re-initializing an already-created worker's languages via a public, stable API (there is no `worker.reinitialize` re-language call safe to make on a warm worker without risking cross-call state bleed), so a genuinely different subset throws [@nhtio/adk/batteries!E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR](../../exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md) explaining that per-call language switching requires a new adapter instance. |\n\n#### Returns\n\n`Promise`<[`RecognizeResult`](../../types/interfaces/RecognizeResult.md)>\n\nThe recognized text and, when tesseract reports a numeric confidence, the mean\nconfidence (`0..100`).\n\n#### Throws\n\n[@nhtio/adk/batteries!E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR](../../exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md) when the worker fails to\nload, the recognize call throws, or a per-call language override cannot be honored.\n\n***\n\n### reset()\n\n```ts\nreset(): Promise;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L114)\n\nTerminates the cached worker (if any) and drops the cached handle + in-flight load, so the\nnext call creates a fresh worker.\n\n#### Returns\n\n`Promise`<`void`>\n\n#### Remarks\n\nUnlike [@nhtio/adk/batteries/embeddings/transformers\\_js!TransformersJsEmbeddingsAdapter.reset](../../../../../embeddings/transformers_js/adapter/classes/TransformersJsEmbeddingsAdapter.md#reset),\nwhich only nulls the JS reference and leaves native resources for [dispose](#dispose) to reclaim,\nthis `reset()` also terminates the worker. A live tesseract.js worker is the SAME heavy WASM\nresource `dispose()` releases — no lighter \"just drop the reference\" tier exists for it (there\nis no separate pipeline-session handle to keep warm), so leaving it running after `reset()`\nwould just leak it under a different method name. Swallows a terminate error (teardown must\nnot throw). Idempotent.\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/adapter.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/adapter.ts#L79)\n\nWhether this battery is available. tesseract.js is environment-neutral (Node + browser), so\nthis is `true` whenever the runtime can import the peer.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions","title":"@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions.md\ndescription: >-\n Battery-scoped exception constructors for the tesseract.js OCR specialist\n adapter.\n---\n\n# @nhtio/adk/batteries/specialists/ocr/tesseract\\_js/exceptions\n\nBattery-scoped exception constructors for the tesseract.js OCR specialist adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the tesseract.js OCR adapter, minted via `createException`\nfrom `@nhtio/adk/factories`. Categories mirror the embeddings batteries one-to-one — only the\nengine-specific failure differs.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS](variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md) | Thrown when the resolved adapter options fail validation against `tesseractJsOcrOptionsSchema` — e.g. a missing/empty `languages` or an unknown option key. Fatal: config bugs fail loud, not at recognize time. |\n| [E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR](variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md) | Thrown when the tesseract.js worker fails to load (e.g. the `tesseract.js` peer is not installed), when `recognize()` throws, or when a per-call language override cannot be honored against a cached worker. Non-fatal. Printf arg: `[detail]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS","title":"Variable: E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against\n `tesseractJsOcrOptionsSchema` — e.g. a missing/empty `languages` or an unknown\n option key. Fatal: config bugs fail loud, not at recognize time.\n---\n\n# Variable: E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS\n\n```ts\nconst E_INVALID_TESSERACT_JS_OCR_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/exceptions.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/exceptions.ts#L19)\n\nThrown when the resolved adapter options fail validation against\n`tesseractJsOcrOptionsSchema` — e.g. a missing/empty `languages` or an unknown option key.\nFatal: config bugs fail loud, not at recognize time.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR","title":"Variable: E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/exceptions/variables/E_TESSERACT_JS_OCR_ENGINE_ERROR.md\ndescription: >-\n Thrown when the tesseract.js worker fails to load (e.g. the `tesseract.js`\n peer is not installed), when `recognize()` throws, or when a per-call language\n override cannot be honored against a cached worker. Non-fatal. Printf arg:\n `[detail]`.\n---\n\n# Variable: E\\_TESSERACT\\_JS\\_OCR\\_ENGINE\\_ERROR\n\n```ts\nconst E_TESSERACT_JS_OCR_ENGINE_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/exceptions.ts:32](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/exceptions.ts#L32)\n\nThrown when the tesseract.js worker fails to load (e.g. the `tesseract.js` peer is not\ninstalled), when `recognize()` throws, or when a per-call language override cannot be honored\nagainst a cached worker. Non-fatal. Printf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types","title":"@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/types","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types.md\ndescription: Option and result types for the tesseract.js OCR specialist adapter.\n---\n\n# @nhtio/adk/batteries/specialists/ocr/tesseract\\_js/types\n\nOption and result types for the tesseract.js OCR specialist adapter.\n\n## Remarks\n\nBuilds on the shared specialist input contracts\n([@nhtio/adk/batteries/specialists/\\_shared!SpecialistImageInput](../../../_shared/type-aliases/SpecialistImageInput.md)) and the shared lifecycle\nhooks ([BatteryLifecycleHooks](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)). `tesseract.js` worker/module shapes are **local aliases**,\nnever direct re-exports of the externalized peer.\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [RecognizeOptions](interfaces/RecognizeOptions.md) | Per-call override options for [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js!TesseractJsOcrAdapter.recognize](../adapter/classes/TesseractJsOcrAdapter.md#recognize). |\n| [RecognizeResult](interfaces/RecognizeResult.md) | The result of [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js!TesseractJsOcrAdapter.recognize](../adapter/classes/TesseractJsOcrAdapter.md#recognize). |\n| [TesseractJsOcrAdapterOptions](interfaces/TesseractJsOcrAdapterOptions.md) | Constructor options for the tesseract.js OCR adapter. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CreateTesseractJsModule](type-aliases/CreateTesseractJsModule.md) | Factory for lazily resolving the `tesseract.js` module. Defaults to a dynamic `import('tesseract.js')`; override to inject a test double or a bundler-friendly resolver. |\n| [CreateTesseractJsWorker](type-aliases/CreateTesseractJsWorker.md) | Factory for creating a `tesseract.js` worker. Defaults to `mod.createWorker(languages, undefined, { langPath, cachePath, ...workerOptions })`; override to inject a pre-built worker or a test double (the full worker-injection seam for tests). |\n| [TesseractJsModule](type-aliases/TesseractJsModule.md) | The `tesseract.js` module namespace this adapter drives. Local alias of the peer's own type. |\n| [TesseractJsWorker](type-aliases/TesseractJsWorker.md) | A live `tesseract.js` worker instance. Local alias of the peer's own type. |\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeOptions","title":"Interface: RecognizeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeOptions.md\ndescription: >-\n Per-call override options for {@link\n @nhtio/adk/batteries/specialists/ocr/tesseract_js!TesseractJsOcrAdapter.recognize}.\n---\n\n# Interface: RecognizeOptions\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/types.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L42)\n\nPer-call override options for [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js!TesseractJsOcrAdapter.recognize](../../adapter/classes/TesseractJsOcrAdapter.md#recognize).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `languages?` | readonly `string`\\[] | A subset of the adapter's constructor `languages` to recognize with for this call only. See the adapter's `recognize` TSDoc for exactly how (and whether) this is honored against a cached worker — tesseract.js v7 does not support re-initializing an existing worker's languages, so this may throw rather than silently switching languages. | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L49) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeResult","title":"Interface: RecognizeResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/RecognizeResult.md\ndescription: >-\n The result of {@link\n @nhtio/adk/batteries/specialists/ocr/tesseract_js!TesseractJsOcrAdapter.recognize}.\n---\n\n# Interface: RecognizeResult\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/types.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L31)\n\nThe result of [@nhtio/adk/batteries/specialists/ocr/tesseract\\_js!TesseractJsOcrAdapter.recognize](../../adapter/classes/TesseractJsOcrAdapter.md#recognize).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `confidence?` | `number` | Tesseract's mean confidence for the recognized page, `0..100`, when the engine reports it. `undefined` when the underlying result carries no numeric `confidence`. | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L38) |\n| `text` | `string` | The recognized text. | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L33) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions","title":"Interface: TesseractJsOcrAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/interfaces/TesseractJsOcrAdapterOptions.md\ndescription: Constructor options for the tesseract.js OCR adapter.\n---\n\n# Interface: TesseractJsOcrAdapterOptions\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/types.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L78)\n\nConstructor options for the tesseract.js OCR adapter.\n\n## Remarks\n\n`languages` is REQUIRED with no default — language packs download on first use, so a deployment\nmust never silently fetch packs for languages it didn't plan for (mirrors\n[@nhtio/adk/batteries/media/engines/tesseract\\_js!TesseractJsEngineOptions](../../../../../media/engines/tesseract_js/interfaces/TesseractJsEngineOptions.md)).\n\n## Extends\n\n* [`BatteryLifecycleHooks`](../../../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cachePath?` | `string` | Local cache directory for downloaded language data (forwarded to `createWorker`). | - | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L84) |\n| `createWorker?` | [`CreateTesseractJsWorker`](../type-aliases/CreateTesseractJsWorker.md) | Override worker creation entirely — the full worker-injection seam for tests. | - | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L96) |\n| `isAvailable?` | () => `boolean` | Override the availability probe. Default: `true` (tesseract.js is environment-neutral). | - | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L98) |\n| `langPath?` | `string` | Where language data is fetched from (forwarded to `createWorker`). | - | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L82) |\n| `languages` | readonly `string`\\[] | Languages to load, e.g. `['eng']`. REQUIRED — language packs download on first use. | - | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L80) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L95) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L105) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L107) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L103) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L86) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L88) |\n| `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.20260921.0/src/src/batteries/llm/chat_common/lifecycle.ts#L97) |\n| `tesseract?` | [`CreateTesseractJsModule`](../type-aliases/CreateTesseractJsModule.md) | Override the module resolution. Default: `import('tesseract.js')`. | - | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L94) |\n| `workerOptions?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> | Escape hatch forwarded into `createWorker`'s options object, spread in AFTER `langPath` / `cachePath` (so an explicit `workerOptions.langPath`/`workerOptions.cachePath` wins). Exists because some bundlers mis-resolve tesseract.js's default `workerPath`/`corePath` URLs — this lets a consumer supply the correct bundled asset URLs without the adapter needing bespoke options for every bundler quirk. | - | [src/batteries/specialists/ocr/tesseract\\_js/types.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L92) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsModule","title":"Type Alias: CreateTesseractJsModule","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsModule.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsModule","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsModule.md\ndescription: >-\n Factory for lazily resolving the `tesseract.js` module. Defaults to a dynamic\n `import('tesseract.js')`; override to inject a test double or a\n bundler-friendly resolver.\n---\n\n# Type Alias: CreateTesseractJsModule\n\n```ts\ntype CreateTesseractJsModule = () =>\n | TesseractJsModule\n | Promise;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/types.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L56)\n\nFactory for lazily resolving the `tesseract.js` module. Defaults to a dynamic\n`import('tesseract.js')`; override to inject a test double or a bundler-friendly resolver.\n\n## Returns\n\n| [`TesseractJsModule`](TesseractJsModule.md)\n| `Promise`<[`TesseractJsModule`](TesseractJsModule.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsWorker","title":"Type Alias: CreateTesseractJsWorker","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsWorker.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsWorker","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/CreateTesseractJsWorker.md\ndescription: >-\n Factory for creating a `tesseract.js` worker. Defaults to\n `mod.createWorker(languages, undefined, { langPath, cachePath,\n ...workerOptions })`; override to inject a pre-built worker or a test double\n (the full worker-injection seam for tests).\n---\n\n# Type Alias: CreateTesseractJsWorker\n\n```ts\ntype CreateTesseractJsWorker = (input: {\n cachePath?: string;\n langPath?: string;\n languages: readonly string[];\n workerOptions?: Record;\n}) => TesseractJsWorker | Promise;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/types.ts:63](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L63)\n\nFactory for creating a `tesseract.js` worker. Defaults to\n`mod.createWorker(languages, undefined, { langPath, cachePath, ...workerOptions })`; override to\ninject a pre-built worker or a test double (the full worker-injection seam for tests).\n\n## Parameters\n\n| Parameter | Type |\n| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input` | { `cachePath?`: `string`; `langPath?`: `string`; `languages`: readonly `string`\\[]; `workerOptions?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>; } |\n| `input.cachePath?` | `string` |\n| `input.langPath?` | `string` |\n| `input.languages` | readonly `string`\\[] |\n| `input.workerOptions?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> |\n\n## Returns\n\n| [`TesseractJsWorker`](TesseractJsWorker.md)\n| `Promise`<[`TesseractJsWorker`](TesseractJsWorker.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsModule","title":"Type Alias: TesseractJsModule","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsModule.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsModule","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsModule.md\ndescription: >-\n The `tesseract.js` module namespace this adapter drives. Local alias of the\n peer's own type.\n---\n\n# Type Alias: TesseractJsModule\n\n```ts\ntype TesseractJsModule = typeof TesseractNS;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/types.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L26)\n\nThe `tesseract.js` module namespace this adapter drives. Local alias of the peer's own type.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsWorker","title":"Type Alias: TesseractJsWorker","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsWorker.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsWorker","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/types/type-aliases/TesseractJsWorker.md\ndescription: A live `tesseract.js` worker instance. Local alias of the peer's own type.\n---\n\n# Type Alias: TesseractJsWorker\n\n```ts\ntype TesseractJsWorker = TesseractNS.Worker;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/types.ts:28](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/types.ts#L28)\n\nA live `tesseract.js` worker instance. Local alias of the peer's own type.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation","title":"@nhtio/adk/batteries/specialists/ocr/tesseract\\_js/validation","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation.md\ndescription: Runtime validation schema and wrapper for tesseract.js OCR adapter options.\n---\n\n# @nhtio/adk/batteries/specialists/ocr/tesseract\\_js/validation\n\nRuntime validation schema and wrapper for tesseract.js OCR adapter options.\n\n## Remarks\n\nValidates `TesseractJsOcrAdapterOptions` at construction time. Throws\n`E_INVALID_TESSERACT_JS_OCR_OPTIONS` on failure. `languages` is required and must be a non-empty\narray of strings — language packs download on first use, so a missing/empty value fails loud\nrather than silently picking a default; unknown top-level keys are rejected so typos fail loud.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |\n| [tesseractJsOcrOptionsSchema](variables/tesseractJsOcrOptionsSchema.md) | Validator schema for `TesseractJsOcrAdapterOptions`. Rejects unknown top-level keys. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------- |\n| [validateOptions](functions/validateOptions.md) | Validates an arbitrary input against `tesseractJsOcrOptionsSchema`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/functions/validateOptions","title":"Function: validateOptions()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/functions/validateOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/functions/validateOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/functions/validateOptions.md\n---\n\n# Function: validateOptions()\n\n```ts\nfunction validateOptions(input: unknown): TesseractJsOcrAdapterOptions;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/validation.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/validation.ts#L52)\n\nValidates an arbitrary input against `tesseractJsOcrOptionsSchema`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ----------------------------------- |\n| `input` | `unknown` | The raw options object to validate. |\n\n## Returns\n\n[`TesseractJsOcrAdapterOptions`](../../types/interfaces/TesseractJsOcrAdapterOptions.md)\n\nThe resolved options object with defaults filled in.\n\n## Throws\n\n[@nhtio/adk/batteries!E\\_INVALID\\_TESSERACT\\_JS\\_OCR\\_OPTIONS](../../exceptions/variables/E_INVALID_TESSERACT_JS_OCR_OPTIONS.md) when invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/variables/tesseractJsOcrOptionsSchema","title":"Variable: tesseractJsOcrOptionsSchema","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/variables/tesseractJsOcrOptionsSchema.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/variables/tesseractJsOcrOptionsSchema","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/specialists/ocr/tesseract_js/validation/variables/tesseractJsOcrOptionsSchema.md\ndescription: >-\n Validator schema for `TesseractJsOcrAdapterOptions`. Rejects unknown top-level\n keys.\n---\n\n# Variable: tesseractJsOcrOptionsSchema\n\n```ts\nconst tesseractJsOcrOptionsSchema: ObjectSchema;\n```\n\nDefined in: [src/batteries/specialists/ocr/tesseract\\_js/validation.ts:19](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/specialists/ocr/tesseract_js/validation.ts#L19)\n\nValidator schema for `TesseractJsOcrAdapterOptions`. Rejects unknown top-level keys.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/stt","title":"@nhtio/adk/batteries/specialists/stt","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/stt.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/stt","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/specialists/stt.md'\ndescription: >-\n Environment-neutral aggregate barrel for bundled STT (speech-to-text)\n specialist batteries.\n---\n\n# @nhtio/adk/batteries/specialists/stt\n\nEnvironment-neutral aggregate barrel for bundled STT (speech-to-text) specialist batteries.\n\n## Remarks\n\nAggregate barrel for the STT specialist batteries. Currently re-exports the transformers.js\nbattery — environment-neutral (Node + browser, ONNX Runtime auto-selected, no WebGPU requirement) —\nmirroring `@nhtio/adk/batteries/embeddings`'s aggregate barrel, which re-exports only its\nenvironment-neutral engines and leaves browser/WebGPU-only engines reachable exclusively through\ntheir own subpath. Should a browser-only STT engine be added later, it would stay off this barrel\nfor the same reason.\n\n## References\n\n### CreateTransformersJsSttPipeline\n\nRe-exports [CreateTransformersJsSttPipeline](../../type-aliases/CreateTransformersJsSttPipeline.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS](../../variables/E_INVALID_TRANSFORMERS_JS_STT_OPTIONS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR](../../variables/E_TRANSFORMERS_JS_STT_ENGINE_ERROR.md)\n\n***\n\n### SttSegment\n\nRe-exports [SttSegment](../../interfaces/SttSegment.md)\n\n***\n\n### TranscribeOptions\n\nRe-exports [TranscribeOptions](../../interfaces/TranscribeOptions.md)\n\n***\n\n### TranscribeResult\n\nRe-exports [TranscribeResult](../../interfaces/TranscribeResult.md)\n\n***\n\n### TransformersJsSttAdapter\n\nRe-exports [TransformersJsSttAdapter](../../classes/TransformersJsSttAdapter.md)\n\n***\n\n### TransformersJsSttAdapterOptions\n\nRe-exports [TransformersJsSttAdapterOptions](../../interfaces/TransformersJsSttAdapterOptions.md)\n\n***\n\n### transformersJsSttAdapterOptionsSchema\n\nRe-exports [transformersJsSttAdapterOptionsSchema](../../variables/transformersJsSttAdapterOptionsSchema.md)\n\n***\n\n### TransformersJsSttDataType\n\nRe-exports [TransformersJsSttDataType](../../type-aliases/TransformersJsSttDataType.md)\n\n***\n\n### TransformersJsSttDeviceType\n\nRe-exports [TransformersJsSttDeviceType](../../type-aliases/TransformersJsSttDeviceType.md)\n\n***\n\n### TransformersJsSttModelSource\n\nRe-exports [TransformersJsSttModelSource](../../type-aliases/TransformersJsSttModelSource.md)\n\n***\n\n### TransformersJsSttPipeline\n\nRe-exports [TransformersJsSttPipeline](../../type-aliases/TransformersJsSttPipeline.md)\n\n***\n\n### TransformersJsSttProgressCallback\n\nRe-exports [TransformersJsSttProgressCallback](../../type-aliases/TransformersJsSttProgressCallback.md)\n\n***\n\n### validateTransformersJsSttOptions\n\nRe-exports [validateTransformersJsSttOptions](../../functions/validateTransformersJsSttOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/specialists/stt/transformers_js","title":"@nhtio/adk/batteries/specialists/stt/transformers\\_js","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/stt/transformers_js.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/specialists/stt/transformers_js","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/specialists/stt/transformers_js.md'\ndescription: >-\n transformers.js STT adapter battery — dual-environment ONNX Whisper\n transcription.\n---\n\n# @nhtio/adk/batteries/specialists/stt/transformers\\_js\n\ntransformers.js STT adapter battery — dual-environment ONNX Whisper transcription.\n\n## Remarks\n\nEnvironment-neutral (Node + browser, ONNX Runtime auto-selected) — so, like the transformers.js\nEmbeddings battery, it is re-exported from the environment-neutral\n`@nhtio/adk/batteries/specialists/stt` barrel. Re-exports the adapter class, the validation schema +\n`validateOptions` wrapper, every option / pipeline type alias, and the battery-scoped exceptions.\n\n## References\n\n### BatteryLifecycleBattery\n\nRe-exports [BatteryLifecycleBattery](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleBattery.md)\n\n***\n\n### BatteryLifecycleCallback\n\nRe-exports [BatteryLifecycleCallback](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecycleCallback.md)\n\n***\n\n### BatteryLifecycleHooks\n\nRe-exports [BatteryLifecycleHooks](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleHooks.md)\n\n***\n\n### BatteryLifecyclePhase\n\nRe-exports [BatteryLifecyclePhase](../../../llm/transformers_js/helpers/type-aliases/BatteryLifecyclePhase.md)\n\n***\n\n### BatteryLifecycleReport\n\nRe-exports [BatteryLifecycleReport](../../../llm/transformers_js/helpers/interfaces/BatteryLifecycleReport.md)\n\n***\n\n### CreateTransformersJsSttPipeline\n\nRe-exports [CreateTransformersJsSttPipeline](../../../type-aliases/CreateTransformersJsSttPipeline.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_STT\\_OPTIONS](../../../variables/E_INVALID_TRANSFORMERS_JS_STT_OPTIONS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_STT\\_ENGINE\\_ERROR](../../../variables/E_TRANSFORMERS_JS_STT_ENGINE_ERROR.md)\n\n***\n\n### SttSegment\n\nRe-exports [SttSegment](../../../interfaces/SttSegment.md)\n\n***\n\n### TranscribeOptions\n\nRe-exports [TranscribeOptions](../../../interfaces/TranscribeOptions.md)\n\n***\n\n### TranscribeResult\n\nRe-exports [TranscribeResult](../../../interfaces/TranscribeResult.md)\n\n***\n\n### TransformersJsSttAdapter\n\nRe-exports [TransformersJsSttAdapter](../../../classes/TransformersJsSttAdapter.md)\n\n***\n\n### TransformersJsSttAdapterOptions\n\nRe-exports [TransformersJsSttAdapterOptions](../../../interfaces/TransformersJsSttAdapterOptions.md)\n\n***\n\n### transformersJsSttAdapterOptionsSchema\n\nRe-exports [transformersJsSttAdapterOptionsSchema](../../../variables/transformersJsSttAdapterOptionsSchema.md)\n\n***\n\n### TransformersJsSttDataType\n\nRe-exports [TransformersJsSttDataType](../../../type-aliases/TransformersJsSttDataType.md)\n\n***\n\n### TransformersJsSttDeviceType\n\nRe-exports [TransformersJsSttDeviceType](../../../type-aliases/TransformersJsSttDeviceType.md)\n\n***\n\n### TransformersJsSttModelSource\n\nRe-exports [TransformersJsSttModelSource](../../../type-aliases/TransformersJsSttModelSource.md)\n\n***\n\n### TransformersJsSttPipeline\n\nRe-exports [TransformersJsSttPipeline](../../../type-aliases/TransformersJsSttPipeline.md)\n\n***\n\n### TransformersJsSttProgressCallback\n\nRe-exports [TransformersJsSttProgressCallback](../../../type-aliases/TransformersJsSttProgressCallback.md)\n\n***\n\n### validateOptions\n\nRenames and re-exports [validateTransformersJsSttOptions](../../../functions/validateTransformersJsSttOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage","title":"@nhtio/adk/batteries/storage","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/storage.md'\ndescription: Environment-neutral aggregate barrel for bundled storage batteries.\n---\n\n# @nhtio/adk/batteries/storage\n\nEnvironment-neutral aggregate barrel for bundled storage batteries.\n\n## Remarks\n\nAggregate barrel for the storage batteries. Re-exports only **environment-neutral** storage\nhelpers — currently just the in-memory battery — so that consumers can import this barrel from\neither Node or the browser without dragging in environment-specific runtime requirements.\n\nEnvironment-specific batteries are reachable only through their own subpath:\n\n* `@nhtio/adk/batteries/storage/flydrive` — Node-only (uses `node:stream`).\n* `@nhtio/adk/batteries/storage/opfs` — browser-only (uses the OPFS API).\n\nDeep-import the subpath you need; don't expect either to be re-exported from this barrel.\n\n## References\n\n### InMemorySpoolReader\n\nRe-exports [InMemorySpoolReader](in_memory/classes/InMemorySpoolReader.md)\n\n***\n\n### InMemorySpoolStore\n\nRe-exports [InMemorySpoolStore](in_memory/classes/InMemorySpoolStore.md)\n\n***\n\n### SPOOL\\_READER\\_TAG\\_IN\\_MEMORY\n\nRe-exports [SPOOL\\_READER\\_TAG\\_IN\\_MEMORY](in_memory/variables/SPOOL_READER_TAG_IN_MEMORY.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive","title":"@nhtio/adk/batteries/storage/flydrive","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive.md'\ndescription: Flydrive-backed spooled artifact storage for Node and server runtimes.\n---\n\n# @nhtio/adk/batteries/storage/flydrive\n\nFlydrive-backed spooled artifact storage for Node and server runtimes.\n\n## Remarks\n\n**Requires Node 24+.** `flydrive` uses the `node:stream` `ReadableStream` web API which is\nonly available from Node 24. This battery does not work in the browser or earlier Node versions.\n\nOpt-in storage battery backed by [flydrive](https://flydrive.dev). Provides\n[FlydriveSpoolReader](classes/FlydriveSpoolReader.md) (a [@nhtio/adk!SpoolReader](../../../spooled_artifact/interfaces/SpoolReader.md) over a flydrive key) and\n[FlydriveSpoolStore](classes/FlydriveSpoolStore.md) (a `write(callId, bytes) → reader` persistence layer that wraps an\nexisting `Disk`).\n\nThe reader has two modes selected at construction time based on the size of the underlying\nobject:\n\n* **Eager mode** — when the object's `contentLength` is below `streamThresholdBytes` (default\n 10 MiB), the reader calls `disk.get(key)` once, splits the content on `\\n`, and caches\n lines + byte count. All subsequent `line() / byteLength() / lineCount()` calls resolve from\n memory.\n* **Streaming mode** — when `contentLength` meets or exceeds the threshold, the reader\n streams the file once via `disk.getStream(key)` to build a line-offset index (`number[]`\n of byte offsets per line), then serves each `line(i)` request by streaming the byte range\n `[offsets[i], offsets[i+1])`. Caps RAM at one index + one line buffer regardless of file\n size.\n\nSet `streamThresholdBytes: 0` to force streaming mode; set it to `Infinity` to force eager\nmode. The default of 10 MiB matches typical tool output sizes — tune it for your workload.\n\nThe store and reader are pure-flydrive: they don't know about S3, GCS, or filesystem\nspecifically — they delegate to whatever `Disk` you construct.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| [FlydriveSpoolReader](classes/FlydriveSpoolReader.md) | Reads a flydrive-backed file as a [@nhtio/adk!SpoolReader](../../../spooled_artifact/interfaces/SpoolReader.md). |\n| [FlydriveSpoolStore](classes/FlydriveSpoolStore.md) | \"Give bytes, get a reader\" persistence layer over a flydrive [Disk](https://flydrive.dev/docs/disk_api). |\n\n## Interfaces\n\n| Interface | Description |\n| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| [FlydriveSpoolReaderOptions](interfaces/FlydriveSpoolReaderOptions.md) | Constructor options for [FlydriveSpoolReader](classes/FlydriveSpoolReader.md). |\n| [FlydriveSpoolStoreOptions](interfaces/FlydriveSpoolStoreOptions.md) | Constructor options for [FlydriveSpoolStore](classes/FlydriveSpoolStore.md). |\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SPOOL\\_READER\\_TAG\\_FLYDRIVE](variables/SPOOL_READER_TAG_FLYDRIVE.md) | Resolver tag for the flydrive spool reader handle. The locator carries the flydrive `key`; the live `Disk` binding is re-injected by the consumer-registered resolver on decode (the key alone cannot re-open the object store). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolReader","title":"Class: FlydriveSpoolReader","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolReader.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolReader","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolReader.md\ndescription: 'Reads a flydrive-backed file as a {@link @nhtio/adk!SpoolReader}.'\n---\n\n# Class: FlydriveSpoolReader\n\nDefined in: [src/batteries/storage/flydrive/index.ts:105](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L105)\n\nReads a flydrive-backed file as a [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n## Remarks\n\nConstructor is **not** async — but the first method call awaits a private readiness promise\nthat fetches the object's metadata (and in eager mode, its contents). Subsequent calls reuse\nthe cached state. This keeps construction call sites synchronous while still doing real I/O\nlazily.\n\nImplementations of [@nhtio/adk!SpoolReader.line](../../../../spooled_artifact/interfaces/SpoolReader.md#line), [@nhtio/adk!SpoolReader.byteLength](../../../../spooled_artifact/interfaces/SpoolReader.md#bytelength), and\n[@nhtio/adk!SpoolReader.lineCount](../../../../spooled_artifact/interfaces/SpoolReader.md#linecount) all return promises. The `SpoolReader` contract supports both\nsync and async return; consumers of `SpooledArtifact` handle either.\n\n## Implements\n\n* [`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew FlydriveSpoolReader(\n disk: Disk,\n key: string,\n opts?: FlydriveSpoolReaderOptions): FlydriveSpoolReader;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L111)\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------------------------------------- |\n| `disk` | [`Disk`](https://flydrive.dev/docs/disk_api) |\n| `key` | `string` |\n| `opts` | [`FlydriveSpoolReaderOptions`](../interfaces/FlydriveSpoolReaderOptions.md) |\n\n#### Returns\n\n`FlydriveSpoolReader`\n\n## Methods\n\n### byteLength()\n\n```ts\nbyteLength(): Promise;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L131)\n\nReturns the total number of bytes in the underlying data.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe byte length of the underlying data.\n\n#### Remarks\n\nUsed for reporting and token-estimation purposes. Byte length is distinct from character\nlength for multi-byte encodings.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`byteLength`](../../../../spooled_artifact/interfaces/SpoolReader.md#bytelength)\n\n***\n\n### describe()\n\n```ts\ndescribe(): ReaderDescriptor;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L171)\n\nOptionally emit a serialisable [ReaderDescriptor](../../../../common/interfaces/ReaderDescriptor.md) so a [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md)\nbacked by this reader can round-trip through `encode()`/`decode()` as a **handle**.\n\n#### Returns\n\n[`ReaderDescriptor`](../../../../common/interfaces/ReaderDescriptor.md)\n\nA tagged, serialisable handle, or `undefined`/absent when the reader cannot describe itself.\n\n#### Remarks\n\nSynchronous by contract — the encoder's `[ENCODE_METHOD]()` is synchronous and cannot await. The\ndescriptor describes *where the bytes live* (a spool key, or an inlined string for in-memory\nreaders) — never the live binding (`Disk`, OPFS root), which the matching resolver re-injects on\ndecode. A reader that omits this method is treated as non-describable: line/text reads still work at\nruntime, the `SpooledArtifact` simply cannot be serialised, and encoding it throws\n[@nhtio/adk!E\\_READER\\_NOT\\_DESCRIBABLE](../../../../exceptions/variables/E_READER_NOT_DESCRIBABLE.md).\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`describe`](../../../../spooled_artifact/interfaces/SpoolReader.md#describe)\n\n***\n\n### line()\n\n```ts\nline(index: number): Promise;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L124)\n\nReturns the line at the given 0-based index, or `undefined` when out of range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------- |\n| `index` | `number` | 0-based line index. |\n\n#### Returns\n\n`Promise`<`string` | `undefined`>\n\nThe raw line string (without trailing newline), or `undefined`.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`line`](../../../../spooled_artifact/interfaces/SpoolReader.md#line)\n\n***\n\n### lineCount()\n\n```ts\nlineCount(): Promise;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:136](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L136)\n\nReturns the total number of lines in the underlying data.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe total line count.\n\n#### Remarks\n\nRequired so consumers know when to stop iterating; the line count must remain stable for the\nlifetime of the reader.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`lineCount`](../../../../spooled_artifact/interfaces/SpoolReader.md#linecount)\n\n***\n\n### readAll()\n\n```ts\nreadAll(): Promise;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L150)\n\nReturns the full underlying content as a single decoded string, byte-faithful to the source.\n\n#### Returns\n\n`Promise`<`string`>\n\n#### Remarks\n\nIn **eager mode** the content is already cached at construction-time load and this method is\neffectively a property access. In **streaming mode** there is no cache: the file is\nre-streamed and concatenated on every call. Use [@nhtio/adk!SpooledArtifact.asString](../../../../spooled_artifact/classes/SpooledArtifact.md#asstring) judiciously\non large streaming-mode artifacts.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`readAll`](../../../../spooled_artifact/interfaces/SpoolReader.md#readall)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolStore","title":"Class: FlydriveSpoolStore","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolStore.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolStore","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolStore.md\ndescription: '\"Give bytes, get a reader\" persistence layer over a flydrive {@link Disk}.'\n---\n\n# Class: FlydriveSpoolStore\n\nDefined in: [src/batteries/storage/flydrive/index.ts:330](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L330)\n\n\"Give bytes, get a reader\" persistence layer over a flydrive [Disk](https://flydrive.dev/docs/disk_api).\n\n## Remarks\n\n`write(callId, bytes)` calls `disk.put(key, bytes)` where `key = keyPrefix + callId`, then\nreturns a fresh [FlydriveSpoolReader](FlydriveSpoolReader.md) pointed at the same key. `read(callId)` returns\na reader without re-writing; `delete(callId)` calls `disk.delete(key)`.\n\nThe store is stateless — it owns no in-memory cache of writes. Multiple `FlydriveSpoolStore`\ninstances sharing the same disk + key prefix see the same data.\n\n## Example\n\n```ts\nimport { Disk } from \"flydrive\";\nimport { FSDriver } from \"flydrive/drivers/fs\";\nimport { FlydriveSpoolStore } from \"@nhtio/adk/batteries/storage/flydrive\";\n\nconst disk = new Disk(\n new FSDriver({ location: \"./tmp\", visibility: \"public\" }),\n);\nconst store = new FlydriveSpoolStore(disk);\n\nconst bytes = await tool.executor(ctx)(args);\nconst reader = await store.write(callId, bytes);\nconst Ctor = tool.artifactConstructor?.() ?? SpooledArtifact;\nconst artifact = new Ctor(reader);\n```\n\n## Implements\n\n* [`SpoolStore`](../../../../common/type-aliases/SpoolStore.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew FlydriveSpoolStore(disk: Disk, opts?: FlydriveSpoolStoreOptions): FlydriveSpoolStore;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L335)\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------------- |\n| `disk` | [`Disk`](https://flydrive.dev/docs/disk_api) |\n| `opts` | [`FlydriveSpoolStoreOptions`](../interfaces/FlydriveSpoolStoreOptions.md) |\n\n#### Returns\n\n`FlydriveSpoolStore`\n\n## Methods\n\n### delete()\n\n```ts\ndelete(callId: string): Promise;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:403](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L403)\n\nRemoves the entry under `callId`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------- |\n| `callId` | `string` | Identifier whose entry should be removed. |\n\n#### Returns\n\n`Promise`<`boolean`>\n\n`true` if the key existed and was removed; `false` if it didn't exist.\n\n#### Implementation of\n\n```ts\nSpoolStore.delete;\n```\n\n***\n\n### keyFor()\n\n```ts\nkeyFor(callId: string): string;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:417](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L417)\n\nReturns the full disk key for a given `callId` (i.e. `keyPrefix + callId`).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `callId` | `string` |\n\n#### Returns\n\n`string`\n\n#### Remarks\n\nUseful for tests or for callers that want to interact with the underlying disk directly.\n\n***\n\n### read()\n\n```ts\nread(callId: string, opts?: FlydriveSpoolReaderOptions): Promise;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:386](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L386)\n\nReturns a reader over the bytes previously written under `callId`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------- |\n| `callId` | `string` | Identifier supplied to a prior [FlydriveSpoolStore.write](#write) call. |\n| `opts?` | [`FlydriveSpoolReaderOptions`](../interfaces/FlydriveSpoolReaderOptions.md) | Per-call override for `streamThresholdBytes`. |\n\n#### Returns\n\n`Promise`<[`FlydriveSpoolReader`](FlydriveSpoolReader.md) | `undefined`>\n\nA [FlydriveSpoolReader](FlydriveSpoolReader.md), or `undefined` if the key is missing.\n\n#### Remarks\n\nReturns `undefined` if the underlying key does not exist. Existence is checked via\n`disk.exists(key)` before the reader is returned, so callers can rely on a defined return\nvalue pointing at a real object.\n\n#### Implementation of\n\n```ts\nSpoolStore.read;\n```\n\n***\n\n### write()\n\n```ts\nwrite(\n callId: string,\n bytes:\n | string\n | Uint8Array\n | ReadableStream>,\nopts?: FlydriveSpoolReaderOptions): Promise;\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:355](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L355)\n\nPersists `bytes` under `callId` and returns a reader bound to the stored key.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| `callId` | `string` | Identifier used to retrieve the bytes via [FlydriveSpoolStore.read](#read). |\n| `bytes` | | `string` | `Uint8Array`<`ArrayBufferLike`> | `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>> | The bytes to store, as a `string`, `Uint8Array`, or `ReadableStream`. |\n| `opts?` | [`FlydriveSpoolReaderOptions`](../interfaces/FlydriveSpoolReaderOptions.md) | Per-call override for `streamThresholdBytes`. |\n\n#### Returns\n\n`Promise`<[`FlydriveSpoolReader`](FlydriveSpoolReader.md)>\n\nA [FlydriveSpoolReader](FlydriveSpoolReader.md) over the stored bytes.\n\n#### Remarks\n\n`string`/`Uint8Array` input goes through `disk.put`; `ReadableStream` is forwarded\nto `disk.putStream` (via `Readable.fromWeb`) so the payload streams straight to the backing\ndriver — to disk for `FSDriver`, to the object store for S3/GCS — without being materialized\nin memory first.\n\n#### Implementation of\n\n```ts\nSpoolStore.write;\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolReaderOptions","title":"Interface: FlydriveSpoolReaderOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolReaderOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolReaderOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolReaderOptions.md\ndescription: 'Constructor options for [`FlydriveSpoolReader`](https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolReader).'\n---\n\n# Interface: FlydriveSpoolReaderOptions\n\nDefined in: [src/batteries/storage/flydrive/index.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L54)\n\nConstructor options for [FlydriveSpoolReader](../classes/FlydriveSpoolReader.md).\n\n## Properties\n\n| Property | Type | Default value | Description | Defined in |\n| ------------------------------------------------------------------ | -------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `streamThresholdBytes?` | `number` | `10 * 1024 * 1024` (10 MiB) | Byte-length threshold that switches between eager and streaming modes. **Remarks** - Below the threshold → eager (whole-file in memory). - At or above the threshold → streaming (line-offset index + per-line streaming reads). Set to `0` to force streaming mode; set to `Number.POSITIVE_INFINITY` to force eager mode. | [src/batteries/storage/flydrive/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L66) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolStoreOptions","title":"Interface: FlydriveSpoolStoreOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolStoreOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolStoreOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive/interfaces/FlydriveSpoolStoreOptions.md\ndescription: 'Constructor options for [`FlydriveSpoolStore`](https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive/classes/FlydriveSpoolStore).'\n---\n\n# Interface: FlydriveSpoolStoreOptions\n\nDefined in: [src/batteries/storage/flydrive/index.ts:286](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L286)\n\nConstructor options for [FlydriveSpoolStore](../classes/FlydriveSpoolStore.md).\n\n## Properties\n\n| Property | Type | Default value | Description | Defined in |\n| ------------------------------------------------------------------ | -------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `keyPrefix?` | `string` | `\"\"` | Optional key prefix prepended to every `callId`. Useful for namespacing tool-call artifacts inside a shared bucket (e.g. `\"tool-calls/\"`). | [src/batteries/storage/flydrive/index.ts:293](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L293) |\n| `streamThresholdBytes?` | `number` | `10 * 1024 * 1024` (10 MiB) | Default `streamThresholdBytes` for readers produced by `write()` and `read()`. Individual calls may override via their own `opts` argument. | [src/batteries/storage/flydrive/index.ts:301](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L301) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/variables/SPOOL_READER_TAG_FLYDRIVE","title":"Variable: SPOOL\\_READER\\_TAG\\_FLYDRIVE","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/variables/SPOOL_READER_TAG_FLYDRIVE.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/flydrive/variables/SPOOL_READER_TAG_FLYDRIVE","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/flydrive/variables/SPOOL_READER_TAG_FLYDRIVE.md\ndescription: >-\n Resolver tag for the flydrive spool reader handle. The locator carries the\n flydrive `key`; the live `Disk` binding is re-injected by the\n consumer-registered resolver on decode (the key alone cannot re-open the\n object store).\n---\n\n# Variable: SPOOL\\_READER\\_TAG\\_FLYDRIVE\n\n```ts\nconst SPOOL_READER_TAG_FLYDRIVE: \"spool:flydrive\" = \"spool:flydrive\";\n```\n\nDefined in: [src/batteries/storage/flydrive/index.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/flydrive/index.ts#L45)\n\nResolver tag for the flydrive spool reader handle. The locator carries the flydrive `key`; the live\n`Disk` binding is re-injected by the consumer-registered resolver on decode (the key alone cannot\nre-open the object store).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory","title":"@nhtio/adk/batteries/storage/in\\_memory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/storage/in_memory.md'\ndescription: >-\n In-memory spool readers and stores for tests, scripts, and non-durable\n prototypes.\n---\n\n# @nhtio/adk/batteries/storage/in\\_memory\n\nIn-memory spool readers and stores for tests, scripts, and non-durable prototypes.\n\n## Remarks\n\nOpt-in in-memory persistence battery. Provides [InMemorySpoolReader](classes/InMemorySpoolReader.md) (a sync\n[@nhtio/adk!SpoolReader](../../../spooled_artifact/interfaces/SpoolReader.md) over a string) plus [InMemorySpoolStore](classes/InMemorySpoolStore.md) (a `Map`\nwith a `write()` method that returns a fresh reader bound to the stored bytes).\n\nUse this when:\n\n* Writing unit or functional tests that need a real `SpoolReader` over known bytes.\n* Running a REPL or one-shot script where persistence beyond the process lifetime is not\n needed.\n* Prototyping an agent before deciding on a real disk/object-store-backed persistence layer.\n\nDo **not** use this for production agents that need durability across process restarts —\neverything lives in process memory and is lost on exit.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| [InMemorySpoolReader](classes/InMemorySpoolReader.md) | Sync in-memory [@nhtio/adk!SpoolReader](../../../spooled_artifact/interfaces/SpoolReader.md) over a byte-faithful `Uint8Array` body. |\n| [InMemorySpoolStore](classes/InMemorySpoolStore.md) | In-memory \"give bytes, get a reader\" persistence layer keyed by `callId`. |\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SPOOL\\_READER\\_TAG\\_IN\\_MEMORY](variables/SPOOL_READER_TAG_IN_MEMORY.md) | Resolver tag for the in-memory spool reader handle. The locator inlines the decoded content because an in-memory reader owns its bytes outright — there is no external store to point at. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolReader","title":"Class: InMemorySpoolReader","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolReader.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolReader","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolReader.md\ndescription: >-\n Sync in-memory {@link @nhtio/adk!SpoolReader} over a byte-faithful\n `Uint8Array` body.\n---\n\n# Class: InMemorySpoolReader\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:49](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L49)\n\nSync in-memory [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md) over a byte-faithful `Uint8Array` body.\n\n## Remarks\n\nStores the raw bytes and decodes them as UTF-8 once at construction, then splits the decoded\nstring on `\\n` and caches the resulting line array. All four `SpoolReader` methods resolve\nsynchronously from the cache — no I/O happens after construction. `byteLength()` reports the\ntrue stored byte count (not the decoded character count), so it stays correct for multi-byte\ncontent; `line()`/`readAll()` operate on the decoded text.\n\nThe reader accepts a `string` or a `Uint8Array`. A `string` is encoded as UTF-8 for the byte\ncount; a `Uint8Array` is held byte-faithfully (no lossy re-encode) and decoded for text reads.\n\nEmpty input yields a reader with `lineCount() === 0` and `byteLength() === 0`. A trailing\nnewline produces a final empty line: `\"a\\nb\\n\".split('\\n') === ['a', 'b', '']`. This matches\nthe JavaScript `String.prototype.split` contract and lets a `lineCount()` consumer\ndistinguish \"two lines, no trailing newline\" from \"two lines, trailing newline\".\n\n## Implements\n\n* [`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew InMemorySpoolReader(content: string | Uint8Array): InMemorySpoolReader;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L54)\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | --------------------------------------------- |\n| `content` | `string` | `Uint8Array`<`ArrayBufferLike`> |\n\n#### Returns\n\n`InMemorySpoolReader`\n\n## Methods\n\n### byteLength()\n\n```ts\nbyteLength(): number;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L69)\n\nReturns the total number of bytes in the underlying data.\n\n#### Returns\n\n`number`\n\nThe byte length of the underlying data.\n\n#### Remarks\n\nUsed for reporting and token-estimation purposes. Byte length is distinct from character\nlength for multi-byte encodings.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`byteLength`](../../../../spooled_artifact/interfaces/SpoolReader.md#bytelength)\n\n***\n\n### describe()\n\n```ts\ndescribe(): ReaderDescriptor;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:81](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L81)\n\nOptionally emit a serialisable [ReaderDescriptor](../../../../common/interfaces/ReaderDescriptor.md) so a [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md)\nbacked by this reader can round-trip through `encode()`/`decode()` as a **handle**.\n\n#### Returns\n\n[`ReaderDescriptor`](../../../../common/interfaces/ReaderDescriptor.md)\n\nA tagged, serialisable handle, or `undefined`/absent when the reader cannot describe itself.\n\n#### Remarks\n\nSynchronous by contract — the encoder's `[ENCODE_METHOD]()` is synchronous and cannot await. The\ndescriptor describes *where the bytes live* (a spool key, or an inlined string for in-memory\nreaders) — never the live binding (`Disk`, OPFS root), which the matching resolver re-injects on\ndecode. A reader that omits this method is treated as non-describable: line/text reads still work at\nruntime, the `SpooledArtifact` simply cannot be serialised, and encoding it throws\n[@nhtio/adk!E\\_READER\\_NOT\\_DESCRIBABLE](../../../../exceptions/variables/E_READER_NOT_DESCRIBABLE.md).\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`describe`](../../../../spooled_artifact/interfaces/SpoolReader.md#describe)\n\n***\n\n### line()\n\n```ts\nline(index: number): string | undefined;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L65)\n\nReturns the line at the given 0-based index, or `undefined` when out of range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------- |\n| `index` | `number` | 0-based line index. |\n\n#### Returns\n\n`string` | `undefined`\n\nThe raw line string (without trailing newline), or `undefined`.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`line`](../../../../spooled_artifact/interfaces/SpoolReader.md#line)\n\n***\n\n### lineCount()\n\n```ts\nlineCount(): number;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L73)\n\nReturns the total number of lines in the underlying data.\n\n#### Returns\n\n`number`\n\nThe total line count.\n\n#### Remarks\n\nRequired so consumers know when to stop iterating; the line count must remain stable for the\nlifetime of the reader.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`lineCount`](../../../../spooled_artifact/interfaces/SpoolReader.md#linecount)\n\n***\n\n### readAll()\n\n```ts\nreadAll(): string;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L77)\n\nReturns the full underlying content as a single decoded string, byte-faithful to the source.\n\n#### Returns\n\n`string`\n\nThe full underlying content as a single string.\n\n#### Remarks\n\nUnlike [SpoolReader.line](../../../../spooled_artifact/interfaces/SpoolReader.md#line), this method preserves trailing newlines and any non-`\\n`\nline terminators (e.g. `\\r\\n`) present in the original bytes. It is the primitive that\npowers `SpooledArtifact.asString()` — the round-trip-faithful alternative to assembling\nthe artifact body from per-line reads.\n\nImplementations should make this O(n) in the size of the underlying data and may cache the\nresult if the read source is durable. Streaming implementations may choose not to cache.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`readAll`](../../../../spooled_artifact/interfaces/SpoolReader.md#readall)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolStore","title":"Class: InMemorySpoolStore","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolStore.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolStore","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/in_memory/classes/InMemorySpoolStore.md\ndescription: 'In-memory \"give bytes, get a reader\" persistence layer keyed by `callId`.'\n---\n\n# Class: InMemorySpoolStore\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L145)\n\nIn-memory \"give bytes, get a reader\" persistence layer keyed by `callId`.\n\n## Remarks\n\nStores each value byte-faithfully as a `Uint8Array`. `string` inputs are encoded as UTF-8;\n`Uint8Array` inputs are held verbatim (no lossy text round-trip, so binary payloads survive\nintact); `ReadableStream` inputs are drained fully into a buffer — in-memory storage\ncannot stream to disk, so the stream form resolves asynchronously and is the documented\ntrade-off for this battery.\n\nEach `write()` and each `read()` returns a *fresh* [InMemorySpoolReader](InMemorySpoolReader.md) — the store\nowns the bytes, the reader is a view. Mutating the store after handing out a reader does not\ninvalidate the reader.\n\nImplements [@nhtio/adk/common!SpoolStore](../../../../common/type-aliases/SpoolStore.md) (i.e. `ByteStore`).\n\n## Example\n\n```ts\nconst store = new InMemorySpoolStore();\nconst bytes = await tool.executor(ctx)(args);\nconst reader = await store.write(callId, bytes);\nconst Ctor = tool.artifactConstructor?.() ?? SpooledArtifact;\nconst artifact = new Ctor(reader);\n```\n\n## Implements\n\n* [`SpoolStore`](../../../../common/type-aliases/SpoolStore.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew InMemorySpoolStore(): InMemorySpoolStore;\n```\n\n#### Returns\n\n`InMemorySpoolStore`\n\n## Accessors\n\n### size\n\n#### Get Signature\n\n```ts\nget size(): number;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L221)\n\nReturns the number of entries currently in the store.\n\n##### Returns\n\n`number`\n\n## Methods\n\n### clear()\n\n```ts\nclear(): void;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:214](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L214)\n\nRemoves every entry from the store.\n\n#### Returns\n\n`void`\n\n#### Remarks\n\nExisting readers handed out by prior `write()` / `read()` calls remain valid — they hold\ntheir own snapshot.\n\n***\n\n### delete()\n\n```ts\ndelete(callId: string): boolean;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L203)\n\nRemoves the entry under `callId`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------- |\n| `callId` | `string` | Identifier whose entry should be removed. |\n\n#### Returns\n\n`boolean`\n\n`true` if an entry existed and was removed; `false` otherwise.\n\n#### Implementation of\n\n```ts\nSpoolStore.delete;\n```\n\n***\n\n### read()\n\n```ts\nread(callId: string): InMemorySpoolReader | undefined;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:191](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L191)\n\nReturns a reader over the bytes previously written under `callId`, or `undefined` if the\nentry has not been written or has been deleted.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------------------------------------- |\n| `callId` | `string` | Identifier supplied to a prior [InMemorySpoolStore.write](#write) call. |\n\n#### Returns\n\n[`InMemorySpoolReader`](InMemorySpoolReader.md) | `undefined`\n\nA fresh [InMemorySpoolReader](InMemorySpoolReader.md) bound to the stored bytes, or `undefined`.\n\n#### Implementation of\n\n```ts\nSpoolStore.read;\n```\n\n***\n\n### write()\n\n#### Call Signature\n\n```ts\nwrite(callId: string, bytes: string): InMemorySpoolReader;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L162)\n\nPersists `bytes` under `callId` and returns a reader over them.\n\n##### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | --------------------------------------------------------------------------------- |\n| `callId` | `string` | Identifier used to retrieve the bytes via [InMemorySpoolStore.read](#read). |\n| `bytes` | `string` | The bytes to store, as a `string`, `Uint8Array`, or `ReadableStream`. |\n\n##### Returns\n\n[`InMemorySpoolReader`](InMemorySpoolReader.md)\n\nA fresh [InMemorySpoolReader](InMemorySpoolReader.md) bound to the stored bytes — a `Promise` for stream\ninput, synchronous otherwise.\n\n##### Remarks\n\n`string` input is encoded as UTF-8; `Uint8Array` is stored byte-faithfully;\n`ReadableStream` is drained fully (and `write` returns a `Promise`). Re-writing the\nsame `callId` replaces the prior entry; readers handed out before the rewrite continue to view\nthe old bytes (they hold their own snapshot via the `InMemorySpoolReader` constructor).\n\n##### Implementation of\n\n```ts\nSpoolStore.write;\n```\n\n#### Call Signature\n\n```ts\nwrite(callId: string, bytes: Uint8Array): InMemorySpoolReader;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:163](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L163)\n\nPersists `bytes` under `callId` and returns a reader over them.\n\n##### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------ | --------------------------------------------------------------------------------- |\n| `callId` | `string` | Identifier used to retrieve the bytes via [InMemorySpoolStore.read](#read). |\n| `bytes` | `Uint8Array` | The bytes to store, as a `string`, `Uint8Array`, or `ReadableStream`. |\n\n##### Returns\n\n[`InMemorySpoolReader`](InMemorySpoolReader.md)\n\nA fresh [InMemorySpoolReader](InMemorySpoolReader.md) bound to the stored bytes — a `Promise` for stream\ninput, synchronous otherwise.\n\n##### Remarks\n\n`string` input is encoded as UTF-8; `Uint8Array` is stored byte-faithfully;\n`ReadableStream` is drained fully (and `write` returns a `Promise`). Re-writing the\nsame `callId` replaces the prior entry; readers handed out before the rewrite continue to view\nthe old bytes (they hold their own snapshot via the `InMemorySpoolReader` constructor).\n\n##### Implementation of\n\n```ts\nSpoolStore.write;\n```\n\n#### Call Signature\n\n```ts\nwrite(callId: string, bytes: ReadableStream>): Promise;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:164](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L164)\n\nPersists `bytes` under `callId` and returns a reader over them.\n\n##### Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------- | --------------------------------------------------------------------------------- |\n| `callId` | `string` | Identifier used to retrieve the bytes via [InMemorySpoolStore.read](#read). |\n| `bytes` | `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>> | The bytes to store, as a `string`, `Uint8Array`, or `ReadableStream`. |\n\n##### Returns\n\n`Promise`<[`InMemorySpoolReader`](InMemorySpoolReader.md)>\n\nA fresh [InMemorySpoolReader](InMemorySpoolReader.md) bound to the stored bytes — a `Promise` for stream\ninput, synchronous otherwise.\n\n##### Remarks\n\n`string` input is encoded as UTF-8; `Uint8Array` is stored byte-faithfully;\n`ReadableStream` is drained fully (and `write` returns a `Promise`). Re-writing the\nsame `callId` replaces the prior entry; readers handed out before the rewrite continue to view\nthe old bytes (they hold their own snapshot via the `InMemorySpoolReader` constructor).\n\n##### Implementation of\n\n```ts\nSpoolStore.write;\n```\n\n#### Call Signature\n\n```ts\nwrite(callId: string, bytes:\n | string\n | Uint8Array\n | ReadableStream>):\n | InMemorySpoolReader\n| Promise;\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L165)\n\nPersists `bytes` under `callId` and returns a reader over them.\n\n##### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| `callId` | `string` | Identifier used to retrieve the bytes via [InMemorySpoolStore.read](#read). |\n| `bytes` | | `string` | `Uint8Array`<`ArrayBufferLike`> | `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>> | The bytes to store, as a `string`, `Uint8Array`, or `ReadableStream`. |\n\n##### Returns\n\n| [`InMemorySpoolReader`](InMemorySpoolReader.md)\n| `Promise`<[`InMemorySpoolReader`](InMemorySpoolReader.md)>\n\nA fresh [InMemorySpoolReader](InMemorySpoolReader.md) bound to the stored bytes — a `Promise` for stream\ninput, synchronous otherwise.\n\n##### Remarks\n\n`string` input is encoded as UTF-8; `Uint8Array` is stored byte-faithfully;\n`ReadableStream` is drained fully (and `write` returns a `Promise`). Re-writing the\nsame `callId` replaces the prior entry; readers handed out before the rewrite continue to view\nthe old bytes (they hold their own snapshot via the `InMemorySpoolReader` constructor).\n\n##### Implementation of\n\n```ts\nSpoolStore.write;\n```\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/variables/SPOOL_READER_TAG_IN_MEMORY","title":"Variable: SPOOL\\_READER\\_TAG\\_IN\\_MEMORY","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/variables/SPOOL_READER_TAG_IN_MEMORY.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/in_memory/variables/SPOOL_READER_TAG_IN_MEMORY","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/in_memory/variables/SPOOL_READER_TAG_IN_MEMORY.md\ndescription: >-\n Resolver tag for the in-memory spool reader handle. The locator inlines the\n decoded content because an in-memory reader owns its bytes outright — there is\n no external store to point at.\n---\n\n# Variable: SPOOL\\_READER\\_TAG\\_IN\\_MEMORY\n\n```ts\nconst SPOOL_READER_TAG_IN_MEMORY: \"spool:in-memory\" = \"spool:in-memory\";\n```\n\nDefined in: [src/batteries/storage/in\\_memory/index.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/in_memory/index.ts#L29)\n\nResolver tag for the in-memory spool reader handle. The locator inlines the decoded content because an\nin-memory reader owns its bytes outright — there is no external store to point at.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs","title":"@nhtio/adk/batteries/storage/opfs","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs.md'\ndescription: Browser-only Origin Private File System storage for spooled artifacts.\n---\n\n# @nhtio/adk/batteries/storage/opfs\n\nBrowser-only Origin Private File System storage for spooled artifacts.\n\n## Remarks\n\nOpt-in **browser-only** storage battery backed by the\n[Origin Private File System](https://developer.mozilla.org/docs/Web/API/File_System_API/Origin_private_file_system)\n(OPFS). Provides [OpfsSpoolReader](classes/OpfsSpoolReader.md) (a [@nhtio/adk!SpoolReader](../../../spooled_artifact/interfaces/SpoolReader.md) over a `OpfsFileHandle`)\nand [OpfsSpoolStore](classes/OpfsSpoolStore.md) (a `write(callId, bytes) → reader` persistence layer that wraps an\nOPFS directory).\n\nThe reader has two modes selected lazily on first method invocation based on the size of the\nunderlying file:\n\n* **Eager mode** — when `file.size` is below `streamThresholdBytes` (default 10 MiB), the\n reader calls `file.text()` once, splits the content on `\\n`, and caches lines + byte count.\n All subsequent calls resolve from memory.\n* **Streaming mode** — when `file.size` meets or exceeds the threshold, the reader streams the\n file once via `file.stream().getReader()` to build a line-offset index (`number[]` of byte\n offsets per line), then serves each `line(i)` request by slicing the underlying `Blob` —\n `Blob.slice(start, end).text()` decodes only the requested range, no head-of-file scan.\n Caps RAM at one index + one line buffer regardless of file size.\n\nThe store auto-selects its write API by execution scope:\n\n* In **worker scopes** (`self instanceof WorkerGlobalScope`), it acquires a\n `FileSystemSyncAccessHandle` and writes synchronously. Sync handles are the only API\n available in workers and the fastest path for the spool-write hot path.\n* On the **main thread**, it uses `OpfsFileHandle.createWritable()` and the async\n stream API. Sync access handles are not exposed on the main thread.\n\nThis module assumes a browser-equivalent runtime — `navigator.storage`,\n`OpfsFileHandle`, `TextEncoder`/`TextDecoder`, and `Blob` must all exist. It must not\nbe imported from Node code; do so and you will fail at resolve time when `navigator` is\nreferenced.\n\n## Example\n\n```ts\nimport { OpfsSpoolStore } from \"@nhtio/adk/batteries/storage/opfs\";\n\nconst store = new OpfsSpoolStore({ keyPrefix: \"agent-runs/\" });\nconst reader = await store.write(callId, bytes);\nconst Ctor = tool.artifactConstructor?.() ?? SpooledArtifact;\nconst artifact = new Ctor(reader);\n```\n\n## Classes\n\n| Class | Description |\n| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| [OpfsSpoolReader](classes/OpfsSpoolReader.md) | Reads an OPFS-backed file as a [@nhtio/adk!SpoolReader](../../../spooled_artifact/interfaces/SpoolReader.md). |\n| [OpfsSpoolStore](classes/OpfsSpoolStore.md) | \"Give bytes, get a reader\" persistence layer over an OPFS directory. |\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OpfsBlob](interfaces/OpfsBlob.md) | Minimal subset of the DOM `Blob` interface used by [OpfsSpoolReader](classes/OpfsSpoolReader.md) streaming-mode random-access reads. Real OPFS handles return a `File` here; we narrow to the methods we actually call. |\n| [OpfsDirectoryHandle](interfaces/OpfsDirectoryHandle.md) | Minimal subset of the [File System Access](https://developer.mozilla.org/docs/Web/API/File_System_API) `OpfsDirectoryHandle` interface that this module touches at runtime. Structurally compatible with the DOM-lib `OpfsDirectoryHandle` — at call sites you pass real OPFS handles directly. |\n| [OpfsFile](interfaces/OpfsFile.md) | Minimal subset of the DOM `File` interface used by [OpfsSpoolReader](classes/OpfsSpoolReader.md). |\n| [OpfsFileHandle](interfaces/OpfsFileHandle.md) | Minimal subset of the [File System Access](https://developer.mozilla.org/docs/Web/API/File_System_API) `OpfsFileHandle` interface that this module touches at runtime. Structurally compatible with the DOM-lib `OpfsFileHandle` — at call sites you pass real OPFS handles directly. |\n| [OpfsReadableStream](interfaces/OpfsReadableStream.md) | Minimal subset of the DOM `ReadableStream` interface used by streaming-mode index construction. |\n| [OpfsReadableStreamReader](interfaces/OpfsReadableStreamReader.md) | Minimal subset of the DOM `ReadableStreamDefaultReader` interface used by streaming-mode index construction. |\n| [OpfsSpoolReaderOptions](interfaces/OpfsSpoolReaderOptions.md) | Constructor options for [OpfsSpoolReader](classes/OpfsSpoolReader.md). |\n| [OpfsSpoolStoreOptions](interfaces/OpfsSpoolStoreOptions.md) | Constructor options for [OpfsSpoolStore](classes/OpfsSpoolStore.md). |\n| [OpfsWritableFileStream](interfaces/OpfsWritableFileStream.md) | Minimal subset of the DOM `FileSystemWritableFileStream` interface used by the OPFS battery's main-thread write path. |\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SPOOL\\_READER\\_TAG\\_OPFS](variables/SPOOL_READER_TAG_OPFS.md) | Resolver tag for the OPFS spool reader handle. The locator carries the OPFS file `name`; the live OPFS root directory is re-injected by the consumer-registered resolver on decode (the name alone cannot re-open the file). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolReader","title":"Class: OpfsSpoolReader","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolReader.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolReader","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolReader.md\ndescription: 'Reads an OPFS-backed file as a {@link @nhtio/adk!SpoolReader}.'\n---\n\n# Class: OpfsSpoolReader\n\nDefined in: [src/batteries/storage/opfs/index.ts:264](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L264)\n\nReads an OPFS-backed file as a [@nhtio/adk!SpoolReader](../../../../spooled_artifact/interfaces/SpoolReader.md).\n\n## Remarks\n\nConstructor is **not** async — but the first method call awaits a private readiness promise\nthat fetches the underlying `File` (and in eager mode, its contents). Subsequent calls reuse\nthe cached state. This keeps construction call sites synchronous while still doing real I/O\nlazily.\n\nAll four `SpoolReader` methods on this reader return promises. The `SpoolReader` contract\nsupports both sync and async return; consumers of `SpooledArtifact` handle either.\n\n## Implements\n\n* [`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OpfsSpoolReader(handle: OpfsFileHandle, opts?: OpfsSpoolReaderOptions): OpfsSpoolReader;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:270](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L270)\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `handle` | [`OpfsFileHandle`](../interfaces/OpfsFileHandle.md) |\n| `opts` | [`OpfsSpoolReaderOptions`](../interfaces/OpfsSpoolReaderOptions.md) |\n\n#### Returns\n\n`OpfsSpoolReader`\n\n## Methods\n\n### byteLength()\n\n```ts\nbyteLength(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:303](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L303)\n\nReturns the total number of bytes in the underlying data.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe byte length of the underlying data.\n\n#### Remarks\n\nUsed for reporting and token-estimation purposes. Byte length is distinct from character\nlength for multi-byte encodings.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`byteLength`](../../../../spooled_artifact/interfaces/SpoolReader.md#bytelength)\n\n***\n\n### describe()\n\n```ts\ndescribe():\n | ReaderDescriptor\n | undefined;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:328](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L328)\n\nOptionally emit a serialisable [ReaderDescriptor](../../../../common/interfaces/ReaderDescriptor.md) so a [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md)\nbacked by this reader can round-trip through `encode()`/`decode()` as a **handle**.\n\n#### Returns\n\n| [`ReaderDescriptor`](../../../../common/interfaces/ReaderDescriptor.md)\n| `undefined`\n\nA tagged, serialisable handle, or `undefined`/absent when the reader cannot describe itself.\n\n#### Remarks\n\nSynchronous by contract — the encoder's `[ENCODE_METHOD]()` is synchronous and cannot await. The\ndescriptor describes *where the bytes live* (a spool key, or an inlined string for in-memory\nreaders) — never the live binding (`Disk`, OPFS root), which the matching resolver re-injects on\ndecode. A reader that omits this method is treated as non-describable: line/text reads still work at\nruntime, the `SpooledArtifact` simply cannot be serialised, and encoding it throws\n[@nhtio/adk!E\\_READER\\_NOT\\_DESCRIBABLE](../../../../exceptions/variables/E_READER_NOT_DESCRIBABLE.md).\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`describe`](../../../../spooled_artifact/interfaces/SpoolReader.md#describe)\n\n***\n\n### line()\n\n```ts\nline(index: number): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:296](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L296)\n\nReturns the line at the given 0-based index, or `undefined` when out of range.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------- |\n| `index` | `number` | 0-based line index. |\n\n#### Returns\n\n`Promise`<`string` | `undefined`>\n\nThe raw line string (without trailing newline), or `undefined`.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`line`](../../../../spooled_artifact/interfaces/SpoolReader.md#line)\n\n***\n\n### lineCount()\n\n```ts\nlineCount(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:308](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L308)\n\nReturns the total number of lines in the underlying data.\n\n#### Returns\n\n`Promise`<`number`>\n\nThe total line count.\n\n#### Remarks\n\nRequired so consumers know when to stop iterating; the line count must remain stable for the\nlifetime of the reader.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`lineCount`](../../../../spooled_artifact/interfaces/SpoolReader.md#linecount)\n\n***\n\n### readAll()\n\n```ts\nreadAll(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:322](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L322)\n\nReturns the full underlying content as a single decoded string, byte-faithful to the source.\n\n#### Returns\n\n`Promise`<`string`>\n\n#### Remarks\n\nIn **eager mode** the content is already cached at first-call load and this method is\neffectively a property access. In **streaming mode** there is no cache: the file is re-read\n(as a single `File.text()` call) on every invocation. Use `SpooledArtifact.asString()`\njudiciously on large streaming-mode artifacts.\n\n#### Implementation of\n\n[`SpoolReader`](../../../../spooled_artifact/interfaces/SpoolReader.md).[`readAll`](../../../../spooled_artifact/interfaces/SpoolReader.md#readall)\n\n***\n\n### isOpfsSpoolReader()\n\n```ts\nstatic isOpfsSpoolReader(value: unknown): value is OpfsSpoolReader;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:292](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L292)\n\nReturns `true` if `value` is an OpfsSpoolReader instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is OpfsSpoolReader`\n\n`true` when `value` is an OpfsSpoolReader instance.\n\n#### Remarks\n\nUses [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) for cross-realm safety.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolStore","title":"Class: OpfsSpoolStore","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolStore.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolStore","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolStore.md\ndescription: '\"Give bytes, get a reader\" persistence layer over an OPFS directory.'\n---\n\n# Class: OpfsSpoolStore\n\nDefined in: [src/batteries/storage/opfs/index.ts:482](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L482)\n\n\"Give bytes, get a reader\" persistence layer over an OPFS directory.\n\n## Remarks\n\n`write(callId, bytes)` resolves the root directory (lazily, on first call), opens or creates\nthe file named `keyPrefix + callId`, then writes via the API matching the current scope:\na `FileSystemSyncAccessHandle` in worker scopes, `OpfsFileHandle.createWritable()` on\nthe main thread. A fresh [OpfsSpoolReader](OpfsSpoolReader.md) pointed at the same file is returned.\n\n`read(callId)` returns a reader without re-writing; `delete(callId)` removes the entry.\n\nThe store is otherwise stateless — it owns no in-memory cache of writes. Multiple\n`OpfsSpoolStore` instances sharing the same root directory and key prefix see the same data.\n\n## Example\n\n```ts\nimport { OpfsSpoolStore } from \"@nhtio/adk/batteries/storage/opfs\";\n\nconst store = new OpfsSpoolStore({ keyPrefix: \"agent-runs/\" });\n\nconst bytes = await tool.executor(ctx)(args);\nconst reader = await store.write(callId, bytes);\nconst Ctor = tool.artifactConstructor?.() ?? SpooledArtifact;\nconst artifact = new Ctor(reader);\n```\n\n## Implements\n\n* [`SpoolStore`](../../../../common/type-aliases/SpoolStore.md)\n\n## Constructors\n\n### Constructor\n\n```ts\nnew OpfsSpoolStore(opts?: OpfsSpoolStoreOptions): OpfsSpoolStore;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:488](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L488)\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------- |\n| `opts` | [`OpfsSpoolStoreOptions`](../interfaces/OpfsSpoolStoreOptions.md) |\n\n#### Returns\n\n`OpfsSpoolStore`\n\n## Methods\n\n### delete()\n\n```ts\ndelete(callId: string): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:593](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L593)\n\nRemoves the entry under `callId`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ----------------------------------------- |\n| `callId` | `string` | Identifier whose entry should be removed. |\n\n#### Returns\n\n`Promise`<`boolean`>\n\n`true` if the entry existed and was removed; `false` if it didn't exist.\n\n#### Implementation of\n\n```ts\nSpoolStore.delete;\n```\n\n***\n\n### has()\n\n```ts\nhas(callId: string): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:611](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L611)\n\nReturns `true` if a file is present under `callId`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | -------- | ------------------- |\n| `callId` | `string` | Identifier to test. |\n\n#### Returns\n\n`Promise`<`boolean`>\n\n`true` when the file exists, `false` otherwise.\n\n***\n\n### keyFor()\n\n```ts\nkeyFor(callId: string): string;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:630](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L630)\n\nReturns the full filename for a given `callId` (i.e. `keyPrefix + callId`).\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `callId` | `string` |\n\n#### Returns\n\n`string`\n\n#### Remarks\n\nUseful for tests or for callers that want to interact with the underlying OPFS directory\ndirectly.\n\n***\n\n### read()\n\n```ts\nread(callId: string, opts?: OpfsSpoolReaderOptions): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:571](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L571)\n\nReturns a reader over the bytes previously written under `callId`.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| `callId` | `string` | Identifier supplied to a prior [OpfsSpoolStore.write](#write) call. |\n| `opts?` | [`OpfsSpoolReaderOptions`](../interfaces/OpfsSpoolReaderOptions.md) | Per-call override for `streamThresholdBytes`. |\n\n#### Returns\n\n`Promise`<[`OpfsSpoolReader`](OpfsSpoolReader.md) | `undefined`>\n\nAn [OpfsSpoolReader](OpfsSpoolReader.md), or `undefined` if the key is missing.\n\n#### Remarks\n\nReturns `undefined` if the file does not exist.\n\n#### Implementation of\n\n```ts\nSpoolStore.read;\n```\n\n***\n\n### write()\n\n```ts\nwrite(\n callId: string,\n bytes:\n | string\n | Uint8Array\n | ReadableStream>,\nopts?: OpfsSpoolReaderOptions): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:533](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L533)\n\nPersists `bytes` under `callId` and returns a reader bound to the stored key.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| `callId` | `string` | Identifier used to retrieve the bytes via [OpfsSpoolStore.read](#read). |\n| `bytes` | | `string` | `Uint8Array`<`ArrayBufferLike`> | `ReadableStream`<`Uint8Array`<`ArrayBufferLike`>> | The bytes to store, as a `string`, `Uint8Array`, or `ReadableStream`. |\n| `opts?` | [`OpfsSpoolReaderOptions`](../interfaces/OpfsSpoolReaderOptions.md) | Per-call override for `streamThresholdBytes`. |\n\n#### Returns\n\n`Promise`<[`OpfsSpoolReader`](OpfsSpoolReader.md)>\n\nAn [OpfsSpoolReader](OpfsSpoolReader.md) over the stored bytes.\n\n#### Remarks\n\n`string` input is encoded as UTF-8; `Uint8Array` is stored byte-faithfully;\n`ReadableStream` is written incrementally — the stream is consumed chunk-by-chunk\nstraight to OPFS without first materializing the whole payload in memory, which is the point\nof accepting a stream for a durable store.\n\n#### Implementation of\n\n```ts\nSpoolStore.write;\n```\n\n***\n\n### isOpfsSpoolStore()\n\n```ts\nstatic isOpfsSpoolStore(value: unknown): value is OpfsSpoolStore;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:515](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L515)\n\nReturns `true` if `value` is an OpfsSpoolStore instance.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------ |\n| `value` | `unknown` | The value to test. |\n\n#### Returns\n\n`value is OpfsSpoolStore`\n\n`true` when `value` is an OpfsSpoolStore instance.\n\n#### Remarks\n\nUses [@nhtio/adk!isInstanceOf](../../../../guards/functions/isInstanceOf.md) for cross-realm safety.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsBlob","title":"Interface: OpfsBlob","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsBlob.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsBlob","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsBlob.md\ndescription: >-\n Minimal subset of the DOM `Blob` interface used by [`OpfsSpoolReader`](https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolReader)\n streaming-mode random-access reads. Real OPFS handles return a `File` here; we\n narrow to the methods we actually call.\n---\n\n# Interface: OpfsBlob\n\nDefined in: [src/batteries/storage/opfs/index.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L119)\n\nMinimal subset of the DOM `Blob` interface used by [OpfsSpoolReader](../classes/OpfsSpoolReader.md) streaming-mode\nrandom-access reads. Real OPFS handles return a `File` here; we narrow to the methods we\nactually call.\n\n## Extended by\n\n* [`OpfsFile`](OpfsFile.md)\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------- | ---------- | -------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `size` | `readonly` | `number` | Byte length of the blob. | [src/batteries/storage/opfs/index.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L121) |\n\n## Methods\n\n### slice()\n\n```ts\nslice(\n start?: number,\n end?: number,\n contentType?: string): OpfsBlob;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L123)\n\nReturn a sub-range of the blob as a new blob.\n\n#### Parameters\n\n| Parameter | Type |\n| -------------- | -------- |\n| `start?` | `number` |\n| `end?` | `number` |\n| `contentType?` | `string` |\n\n#### Returns\n\n`OpfsBlob`\n\n***\n\n### stream()\n\n```ts\nstream(): OpfsReadableStream;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L127)\n\nOpen a readable byte stream over the blob.\n\n#### Returns\n\n[`OpfsReadableStream`](OpfsReadableStream.md)\n\n***\n\n### text()\n\n```ts\ntext(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L125)\n\nRead the blob's contents as text.\n\n#### Returns\n\n`Promise`<`string`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsDirectoryHandle","title":"Interface: OpfsDirectoryHandle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsDirectoryHandle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsDirectoryHandle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsDirectoryHandle.md\ndescription: >-\n Minimal subset of the [File System\n Access](https://developer.mozilla.org/docs/Web/API/File_System_API)\n `OpfsDirectoryHandle` interface that this module touches at runtime.\n Structurally compatible with the DOM-lib `OpfsDirectoryHandle` — at call sites\n you pass real OPFS handles directly.\n---\n\n# Interface: OpfsDirectoryHandle\n\nDefined in: [src/batteries/storage/opfs/index.ts:90](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L90)\n\nMinimal subset of the\n[File System Access](https://developer.mozilla.org/docs/Web/API/File_System_API)\n`OpfsDirectoryHandle` interface that this module touches at runtime. Structurally\ncompatible with the DOM-lib `OpfsDirectoryHandle` — at call sites you pass real OPFS\nhandles directly.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------- | ---------- | ------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `readonly` | `\"directory\"` | Discriminant: always `'directory'`. | [src/batteries/storage/opfs/index.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L92) |\n| `name` | `readonly` | `string` | The directory's name. | [src/batteries/storage/opfs/index.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L94) |\n\n## Methods\n\n### getDirectoryHandle()\n\n```ts\ngetDirectoryHandle(name: string, options?: {\n create?: boolean;\n}): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L98)\n\nResolve a child directory handle, optionally creating it.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------- | --------------------------- |\n| `name` | `string` |\n| `options?` | { `create?`: `boolean`; } |\n| `options.create?` | `boolean` |\n\n#### Returns\n\n`Promise`<`OpfsDirectoryHandle`>\n\n***\n\n### getFileHandle()\n\n```ts\ngetFileHandle(name: string, options?: {\n create?: boolean;\n}): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L96)\n\nResolve a child file handle, optionally creating it.\n\n#### Parameters\n\n| Parameter | Type |\n| ----------------- | --------------------------- |\n| `name` | `string` |\n| `options?` | { `create?`: `boolean`; } |\n| `options.create?` | `boolean` |\n\n#### Returns\n\n`Promise`<[`OpfsFileHandle`](OpfsFileHandle.md)>\n\n***\n\n### removeEntry()\n\n```ts\nremoveEntry(name: string, options?: {\n recursive?: boolean;\n}): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:100](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L100)\n\nRemove a child entry, optionally recursively.\n\n#### Parameters\n\n| Parameter | Type |\n| -------------------- | ------------------------------ |\n| `name` | `string` |\n| `options?` | { `recursive?`: `boolean`; } |\n| `options.recursive?` | `boolean` |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFile","title":"Interface: OpfsFile","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFile.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFile","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFile.md\ndescription: 'Minimal subset of the DOM `File` interface used by [`OpfsSpoolReader`](https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolReader).'\n---\n\n# Interface: OpfsFile\n\nDefined in: [src/batteries/storage/opfs/index.ts:133](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L133)\n\nMinimal subset of the DOM `File` interface used by [OpfsSpoolReader](../classes/OpfsSpoolReader.md).\n\n## Extends\n\n* [`OpfsBlob`](OpfsBlob.md)\n\n## Properties\n\n| Property | Modifier | Type | Description | Inherited from | Defined in |\n| --------------------------------- | ---------- | -------- | ------------------------ | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `name` | `readonly` | `string` | The file's name. | - | [src/batteries/storage/opfs/index.ts:135](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L135) |\n| `size` | `readonly` | `number` | Byte length of the blob. | [`OpfsBlob`](OpfsBlob.md).[`size`](OpfsBlob.md#property-size) | [src/batteries/storage/opfs/index.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L121) |\n\n## Methods\n\n### slice()\n\n```ts\nslice(\n start?: number,\n end?: number,\n contentType?: string): OpfsBlob;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L123)\n\nReturn a sub-range of the blob as a new blob.\n\n#### Parameters\n\n| Parameter | Type |\n| -------------- | -------- |\n| `start?` | `number` |\n| `end?` | `number` |\n| `contentType?` | `string` |\n\n#### Returns\n\n[`OpfsBlob`](OpfsBlob.md)\n\n#### Inherited from\n\n[`OpfsBlob`](OpfsBlob.md).[`slice`](OpfsBlob.md#slice)\n\n***\n\n### stream()\n\n```ts\nstream(): OpfsReadableStream;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L127)\n\nOpen a readable byte stream over the blob.\n\n#### Returns\n\n[`OpfsReadableStream`](OpfsReadableStream.md)\n\n#### Inherited from\n\n[`OpfsBlob`](OpfsBlob.md).[`stream`](OpfsBlob.md#stream)\n\n***\n\n### text()\n\n```ts\ntext(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L125)\n\nRead the blob's contents as text.\n\n#### Returns\n\n`Promise`<`string`>\n\n#### Inherited from\n\n[`OpfsBlob`](OpfsBlob.md).[`text`](OpfsBlob.md#text)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFileHandle","title":"Interface: OpfsFileHandle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFileHandle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFileHandle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsFileHandle.md\ndescription: >-\n Minimal subset of the [File System\n Access](https://developer.mozilla.org/docs/Web/API/File_System_API)\n `OpfsFileHandle` interface that this module touches at runtime. Structurally\n compatible with the DOM-lib `OpfsFileHandle` — at call sites you pass real\n OPFS handles directly.\n---\n\n# Interface: OpfsFileHandle\n\nDefined in: [src/batteries/storage/opfs/index.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L72)\n\nMinimal subset of the\n[File System Access](https://developer.mozilla.org/docs/Web/API/File_System_API)\n`OpfsFileHandle` interface that this module touches at runtime. Structurally compatible\nwith the DOM-lib `OpfsFileHandle` — at call sites you pass real OPFS handles directly.\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| --------------------------------- | ---------- | -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `kind` | `readonly` | `\"file\"` | Discriminant: always `'file'`. | [src/batteries/storage/opfs/index.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L74) |\n| `name` | `readonly` | `string` | The entry's name. | [src/batteries/storage/opfs/index.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L76) |\n\n## Methods\n\n### createWritable()\n\n```ts\ncreateWritable(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L80)\n\nOpen a writable stream that replaces the file's contents.\n\n#### Returns\n\n`Promise`<[`OpfsWritableFileStream`](OpfsWritableFileStream.md)>\n\n***\n\n### getFile()\n\n```ts\ngetFile(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:78](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L78)\n\nResolve a readable [OpfsFile](OpfsFile.md) snapshot of the handle's contents.\n\n#### Returns\n\n`Promise`<[`OpfsFile`](OpfsFile.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStream","title":"Interface: OpfsReadableStream","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStream.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStream","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStream.md\ndescription: >-\n Minimal subset of the DOM `ReadableStream` interface used by\n streaming-mode index construction.\n---\n\n# Interface: OpfsReadableStream\n\nDefined in: [src/batteries/storage/opfs/index.ts:142](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L142)\n\nMinimal subset of the DOM `ReadableStream` interface used by streaming-mode\nindex construction.\n\n## Methods\n\n### getReader()\n\n```ts\ngetReader(): OpfsReadableStreamReader;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L144)\n\nAcquire a reader over the stream.\n\n#### Returns\n\n[`OpfsReadableStreamReader`](OpfsReadableStreamReader.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStreamReader","title":"Interface: OpfsReadableStreamReader","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStreamReader.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStreamReader","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsReadableStreamReader.md\ndescription: >-\n Minimal subset of the DOM `ReadableStreamDefaultReader` interface\n used by streaming-mode index construction.\n---\n\n# Interface: OpfsReadableStreamReader\n\nDefined in: [src/batteries/storage/opfs/index.ts:151](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L151)\n\nMinimal subset of the DOM `ReadableStreamDefaultReader` interface used by\nstreaming-mode index construction.\n\n## Methods\n\n### read()\n\n```ts\nread(): Promise<\n | {\n done: false;\n value: Uint8Array;\n}\n | {\n done: true;\n value: undefined;\n}>;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:153](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L153)\n\nRead the next chunk, or signal end-of-stream with `done: true`.\n\n#### Returns\n\n`Promise`<\n| {\n`done`: `false`;\n`value`: `Uint8Array`;\n}\n| {\n`done`: `true`;\n`value`: `undefined`;\n}>\n\n***\n\n### releaseLock()\n\n```ts\nreleaseLock(): void;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L155)\n\nRelease the reader's lock on the stream.\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolReaderOptions","title":"Interface: OpfsSpoolReaderOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolReaderOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolReaderOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolReaderOptions.md\ndescription: 'Constructor options for [`OpfsSpoolReader`](https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolReader).'\n---\n\n# Interface: OpfsSpoolReaderOptions\n\nDefined in: [src/batteries/storage/opfs/index.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L187)\n\nConstructor options for [OpfsSpoolReader](../classes/OpfsSpoolReader.md).\n\n## Properties\n\n| Property | Type | Default value | Description | Defined in |\n| ------------------------------------------------------------------ | -------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `name?` | `string` | `undefined` | The stable OPFS file name (key) this reader was opened from. **Remarks** Optional. When supplied, the reader can emit a serialisable @nhtio/adk!ReaderDescriptor via `describe()` so a [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) backed by it round-trips through `encode()`/`decode()`. [OpfsSpoolStore](../classes/OpfsSpoolStore.md) threads this in automatically; a reader constructed from a bare file handle with no `name` is not describable (the opaque handle has no serialisable locator) and the artifact cannot be encoded. | [src/batteries/storage/opfs/index.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L211) |\n| `streamThresholdBytes?` | `number` | `10 * 1024 * 1024` (10 MiB) | Byte-length threshold that switches between eager and streaming modes. **Remarks** - Below the threshold → eager (whole-file in memory). - At or above the threshold → streaming (line-offset index + per-line slice reads). Set to `0` to force streaming mode; set to `Number.POSITIVE_INFINITY` to force eager mode. | [src/batteries/storage/opfs/index.ts:199](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L199) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolStoreOptions","title":"Interface: OpfsSpoolStoreOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolStoreOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolStoreOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsSpoolStoreOptions.md\ndescription: 'Constructor options for [`OpfsSpoolStore`](https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/classes/OpfsSpoolStore).'\n---\n\n# Interface: OpfsSpoolStoreOptions\n\nDefined in: [src/batteries/storage/opfs/index.ts:421](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L421)\n\nConstructor options for [OpfsSpoolStore](../classes/OpfsSpoolStore.md).\n\n## Properties\n\n| Property | Type | Default value | Description | Defined in |\n| ------------------------------------------------------------------ | ------------------------------------------------------------------ | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `directory?` | () => `Promise`<[`OpfsDirectoryHandle`](OpfsDirectoryHandle.md)> | `undefined` | Optional thunk that resolves the [OpfsDirectoryHandle](OpfsDirectoryHandle.md) used as the store root. **Remarks** When omitted, the store resolves the root via `navigator.storage.getDirectory()` on its first filesystem call. Override for tests (to point at a per-suite subdirectory) or to scope the store to a nested directory inside OPFS. The thunk is invoked at most once per store; the returned handle is memoised. | [src/batteries/storage/opfs/index.ts:432](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L432) |\n| `keyPrefix?` | `string` | `\"\"` | Optional filename prefix prepended to every `callId`. **Remarks** Prefix is a **filename prefix**, not a subdirectory — `keyPrefix: 'agent-runs/'` produces a file literally named `agent-runs/` at the root, not a nested directory. (OPFS filenames may not contain `/`, so use a non-`/` separator like `-` if you want a flat namespace.) This mirrors the `keyPrefix` semantics in the flydrive and in-memory batteries. | [src/batteries/storage/opfs/index.ts:445](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L445) |\n| `streamThresholdBytes?` | `number` | `10 * 1024 * 1024` (10 MiB) | Default `streamThresholdBytes` for readers produced by `write()` and `read()`. Individual calls may override via their own `opts` argument. | [src/batteries/storage/opfs/index.ts:453](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L453) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsWritableFileStream","title":"Interface: OpfsWritableFileStream","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsWritableFileStream.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsWritableFileStream","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/interfaces/OpfsWritableFileStream.md\ndescription: >-\n Minimal subset of the DOM `FileSystemWritableFileStream` interface used by the\n OPFS battery's main-thread write path.\n---\n\n# Interface: OpfsWritableFileStream\n\nDefined in: [src/batteries/storage/opfs/index.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L107)\n\nMinimal subset of the DOM `FileSystemWritableFileStream` interface used by the OPFS battery's\nmain-thread write path.\n\n## Methods\n\n### close()\n\n```ts\nclose(): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:111](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L111)\n\nFlush and close the stream, committing the written contents.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### write()\n\n```ts\nwrite(data:\n | string\n | ArrayBuffer\n | Uint8Array\n| ArrayBufferView): Promise;\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:109](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L109)\n\nAppend/write a chunk to the stream.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------------------------------------------------- |\n| `data` | | `string` | `ArrayBuffer` | `Uint8Array`<`ArrayBufferLike`> | `ArrayBufferView`<`ArrayBufferLike`> |\n\n#### Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/variables/SPOOL_READER_TAG_OPFS","title":"Variable: SPOOL\\_READER\\_TAG\\_OPFS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/variables/SPOOL_READER_TAG_OPFS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/storage/opfs/variables/SPOOL_READER_TAG_OPFS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/storage/opfs/variables/SPOOL_READER_TAG_OPFS.md\ndescription: >-\n Resolver tag for the OPFS spool reader handle. The locator carries the OPFS\n file `name`; the live OPFS root directory is re-injected by the\n consumer-registered resolver on decode (the name alone cannot re-open the\n file).\n---\n\n# Variable: SPOOL\\_READER\\_TAG\\_OPFS\n\n```ts\nconst SPOOL_READER_TAG_OPFS: \"spool:opfs\" = \"spool:opfs\";\n```\n\nDefined in: [src/batteries/storage/opfs/index.ts:57](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/storage/opfs/index.ts#L57)\n\nResolver tag for the OPFS spool reader handle. The locator carries the OPFS file `name`; the live OPFS\nroot directory is re-injected by the consumer-registered resolver on decode (the name alone cannot\nre-open the file).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools","title":"@nhtio/adk/batteries/tools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools.md'\ndescription: Aggregate barrel for every pre-constructed bundled tool category.\n---\n\n# @nhtio/adk/batteries/tools\n\nAggregate barrel for every pre-constructed bundled tool category.\n\n## Remarks\n\nAggregate barrel of every bundled tool category. Re-exports each category's tools as named\nexports so consumers can\n`import { calculateTool, formatTableTool } from '@nhtio/adk/batteries/tools'`. Each category\nis also exposed as its own subpath (`@nhtio/adk/batteries/tools/`) for\nfiner-grained tree-shaking.\n\n## References\n\n### addStandingInstructionTool\n\nRe-exports [addStandingInstructionTool](standing_instructions/variables/addStandingInstructionTool.md)\n\n***\n\n### ArticleContentSource\n\nRe-exports [ArticleContentSource](web_retrieval/type-aliases/ArticleContentSource.md)\n\n***\n\n### ArticleToRetrievableOptions\n\nRe-exports [ArticleToRetrievableOptions](web_retrieval/interfaces/ArticleToRetrievableOptions.md)\n\n***\n\n### ArtifactRecommendations\n\nRe-exports [ArtifactRecommendations](web_retrieval/interfaces/ArtifactRecommendations.md)\n\n***\n\n### calculateTool\n\nRe-exports [calculateTool](math/variables/calculateTool.md)\n\n***\n\n### colorAdjustTool\n\nRe-exports [colorAdjustTool](color/variables/colorAdjustTool.md)\n\n***\n\n### colorContrastTool\n\nRe-exports [colorContrastTool](color/variables/colorContrastTool.md)\n\n***\n\n### colorSchemeTool\n\nRe-exports [colorSchemeTool](color/variables/colorSchemeTool.md)\n\n***\n\n### compareRecordsTool\n\nRe-exports [compareRecordsTool](comparison/variables/compareRecordsTool.md)\n\n***\n\n### compareValuesTool\n\nRe-exports [compareValuesTool](comparison/variables/compareValuesTool.md)\n\n***\n\n### convertTimeTool\n\nRe-exports [convertTimeTool](time/variables/convertTimeTool.md)\n\n***\n\n### convertUnitTool\n\nRe-exports [convertUnitTool](unit_conversion/variables/convertUnitTool.md)\n\n***\n\n### createScrapperArticleTool\n\nRe-exports [createScrapperArticleTool](scrapper/functions/createScrapperArticleTool.md)\n\n***\n\n### createScrapperArticleToolSync\n\nRe-exports [createScrapperArticleToolSync](scrapper/functions/createScrapperArticleToolSync.md)\n\n***\n\n### createScrapperLinksTool\n\nRe-exports [createScrapperLinksTool](scrapper/functions/createScrapperLinksTool.md)\n\n***\n\n### createScrapperLinksToolSync\n\nRe-exports [createScrapperLinksToolSync](scrapper/functions/createScrapperLinksToolSync.md)\n\n***\n\n### createSearxngSearchTool\n\nRe-exports [createSearxngSearchTool](searxng/functions/createSearxngSearchTool.md)\n\n***\n\n### createSearxngSearchToolSync\n\nRe-exports [createSearxngSearchToolSync](searxng/functions/createSearxngSearchToolSync.md)\n\n***\n\n### dateAddTool\n\nRe-exports [dateAddTool](datetime_math/variables/dateAddTool.md)\n\n***\n\n### dateBusinessDaysTool\n\nRe-exports [dateBusinessDaysTool](datetime_extended/variables/dateBusinessDaysTool.md)\n\n***\n\n### dateCalendarInfoTool\n\nRe-exports [dateCalendarInfoTool](datetime_extended/variables/dateCalendarInfoTool.md)\n\n***\n\n### dateDiffTool\n\nRe-exports [dateDiffTool](datetime_math/variables/dateDiffTool.md)\n\n***\n\n### dateNthWeekdayTool\n\nRe-exports [dateNthWeekdayTool](datetime_extended/variables/dateNthWeekdayTool.md)\n\n***\n\n### dateParseTool\n\nRe-exports [dateParseTool](datetime_extended/variables/dateParseTool.md)\n\n***\n\n### datePeriodTool\n\nRe-exports [datePeriodTool](datetime_extended/variables/datePeriodTool.md)\n\n***\n\n### deleteMemoryTool\n\nRe-exports [deleteMemoryTool](memory/variables/deleteMemoryTool.md)\n\n***\n\n### deleteRetrievableTool\n\nRe-exports [deleteRetrievableTool](retrievables/variables/deleteRetrievableTool.md)\n\n***\n\n### detectDelimiterTool\n\nRe-exports [detectDelimiterTool](parsing/variables/detectDelimiterTool.md)\n\n***\n\n### durationFormatTool\n\nRe-exports [durationFormatTool](datetime_math/variables/durationFormatTool.md)\n\n***\n\n### E\\_INVALID\\_SCRAPPER\\_CONFIG\n\nRe-exports [E\\_INVALID\\_SCRAPPER\\_CONFIG](../variables/E_INVALID_SCRAPPER_CONFIG.md)\n\n***\n\n### E\\_INVALID\\_SEARXNG\\_CONFIG\n\nRe-exports [E\\_INVALID\\_SEARXNG\\_CONFIG](../variables/E_INVALID_SEARXNG_CONFIG.md)\n\n***\n\n### encodeTextTool\n\nRe-exports [encodeTextTool](encoding/variables/encodeTextTool.md)\n\n***\n\n### evaluateKatexTool\n\nRe-exports [evaluateKatexTool](math/variables/evaluateKatexTool.md)\n\n***\n\n### formatListTool\n\nRe-exports [formatListTool](formatting/variables/formatListTool.md)\n\n***\n\n### formatNumberTool\n\nRe-exports [formatNumberTool](formatting/variables/formatNumberTool.md)\n\n***\n\n### formatTableTool\n\nRe-exports [formatTableTool](structured_data/variables/formatTableTool.md)\n\n***\n\n### geoBboxContainsTool\n\nRe-exports [geoBboxContainsTool](geo_basics/variables/geoBboxContainsTool.md)\n\n***\n\n### geoDistanceTool\n\nRe-exports [geoDistanceTool](geo_basics/variables/geoDistanceTool.md)\n\n***\n\n### geoWithinRadiusTool\n\nRe-exports [geoWithinRadiusTool](geo_basics/variables/geoWithinRadiusTool.md)\n\n***\n\n### getCurrentTimeTool\n\nRe-exports [getCurrentTimeTool](time/variables/getCurrentTimeTool.md)\n\n***\n\n### jsonFormatTool\n\nRe-exports [jsonFormatTool](structured_data/variables/jsonFormatTool.md)\n\n***\n\n### jsonTransformTool\n\nRe-exports [jsonTransformTool](data_structure/variables/jsonTransformTool.md)\n\n***\n\n### listMemoriesTool\n\nRe-exports [listMemoriesTool](memory/variables/listMemoriesTool.md)\n\n***\n\n### listRetrievablesTool\n\nRe-exports [listRetrievablesTool](retrievables/variables/listRetrievablesTool.md)\n\n***\n\n### listStandingInstructionsTool\n\nRe-exports [listStandingInstructionsTool](standing_instructions/variables/listStandingInstructionsTool.md)\n\n***\n\n### memoryTools\n\nRe-exports [memoryTools](memory/variables/memoryTools.md)\n\n***\n\n### parseCsvTool\n\nRe-exports [parseCsvTool](parsing/variables/parseCsvTool.md)\n\n***\n\n### parseKvTool\n\nRe-exports [parseKvTool](parsing/variables/parseKvTool.md)\n\n***\n\n### parseYamlTool\n\nRe-exports [parseYamlTool](parsing/variables/parseYamlTool.md)\n\n***\n\n### removeStandingInstructionTool\n\nRe-exports [removeStandingInstructionTool](standing_instructions/variables/removeStandingInstructionTool.md)\n\n***\n\n### Resolver\n\nRe-exports [Resolver](web_retrieval/type-aliases/Resolver.md)\n\n***\n\n### RetrievableCtor\n\nRe-exports [RetrievableCtor](web_retrieval/type-aliases/RetrievableCtor.md)\n\n***\n\n### RetrievableStoreCtx\n\nRe-exports [RetrievableStoreCtx](web_retrieval/interfaces/RetrievableStoreCtx.md)\n\n***\n\n### retrievableTools\n\nRe-exports [retrievableTools](retrievables/variables/retrievableTools.md)\n\n***\n\n### ScrapperArticle\n\nRe-exports [ScrapperArticle](scrapper/interfaces/ScrapperArticle.md)\n\n***\n\n### ScrapperArticleConfig\n\nRe-exports [ScrapperArticleConfig](scrapper/type-aliases/ScrapperArticleConfig.md)\n\n***\n\n### ScrapperArticleConfigSync\n\nRe-exports [ScrapperArticleConfigSync](scrapper/type-aliases/ScrapperArticleConfigSync.md)\n\n***\n\n### ScrapperArticleLike\n\nRe-exports [ScrapperArticleLike](web_retrieval/interfaces/ScrapperArticleLike.md)\n\n***\n\n### ScrapperArticleParams\n\nRe-exports [ScrapperArticleParams](scrapper/interfaces/ScrapperArticleParams.md)\n\n***\n\n### scrapperArticleToRetrievable\n\nRe-exports [scrapperArticleToRetrievable](web_retrieval/functions/scrapperArticleToRetrievable.md)\n\n***\n\n### ScrapperBaseConfig\n\nRe-exports [ScrapperBaseConfig](../interfaces/ScrapperBaseConfig.md)\n\n***\n\n### ScrapperCommonParams\n\nRe-exports [ScrapperCommonParams](scrapper/interfaces/ScrapperCommonParams.md)\n\n***\n\n### ScrapperInputMiddlewareFn\n\nRe-exports [ScrapperInputMiddlewareFn](../type-aliases/ScrapperInputMiddlewareFn.md)\n\n***\n\n### ScrapperLink\n\nRe-exports [ScrapperLink](scrapper/interfaces/ScrapperLink.md)\n\n***\n\n### ScrapperLinkLike\n\nRe-exports [ScrapperLinkLike](web_retrieval/interfaces/ScrapperLinkLike.md)\n\n***\n\n### ScrapperLinks\n\nRe-exports [ScrapperLinks](scrapper/interfaces/ScrapperLinks.md)\n\n***\n\n### ScrapperLinksConfig\n\nRe-exports [ScrapperLinksConfig](scrapper/type-aliases/ScrapperLinksConfig.md)\n\n***\n\n### ScrapperLinksConfigSync\n\nRe-exports [ScrapperLinksConfigSync](scrapper/type-aliases/ScrapperLinksConfigSync.md)\n\n***\n\n### ScrapperLinksLike\n\nRe-exports [ScrapperLinksLike](web_retrieval/interfaces/ScrapperLinksLike.md)\n\n***\n\n### ScrapperLinksParams\n\nRe-exports [ScrapperLinksParams](scrapper/interfaces/ScrapperLinksParams.md)\n\n***\n\n### scrapperLinksToRetrievables\n\nRe-exports [scrapperLinksToRetrievables](web_retrieval/functions/scrapperLinksToRetrievables.md)\n\n***\n\n### ScrapperOutputMiddlewareFn\n\nRe-exports [ScrapperOutputMiddlewareFn](../type-aliases/ScrapperOutputMiddlewareFn.md)\n\n***\n\n### ScrapperRequestContext\n\nRe-exports [ScrapperRequestContext](../interfaces/ScrapperRequestContext.md)\n\n***\n\n### ScrapperResponseContext\n\nRe-exports [ScrapperResponseContext](../interfaces/ScrapperResponseContext.md)\n\n***\n\n### SearxngHeaders\n\nRe-exports [SearxngHeaders](searxng/type-aliases/SearxngHeaders.md)\n\n***\n\n### SearxngHeadersResolver\n\nRe-exports [SearxngHeadersResolver](searxng/type-aliases/SearxngHeadersResolver.md)\n\n***\n\n### SearxngInputMiddlewareFn\n\nRe-exports [SearxngInputMiddlewareFn](searxng/type-aliases/SearxngInputMiddlewareFn.md)\n\n***\n\n### SearxngOutputMiddlewareFn\n\nRe-exports [SearxngOutputMiddlewareFn](searxng/type-aliases/SearxngOutputMiddlewareFn.md)\n\n***\n\n### SearxngPayloadLike\n\nRe-exports [SearxngPayloadLike](web_retrieval/interfaces/SearxngPayloadLike.md)\n\n***\n\n### SearxngRequestContext\n\nRe-exports [SearxngRequestContext](searxng/interfaces/SearxngRequestContext.md)\n\n***\n\n### SearxngResponseContext\n\nRe-exports [SearxngResponseContext](searxng/interfaces/SearxngResponseContext.md)\n\n***\n\n### SearxngResult\n\nRe-exports [SearxngResult](searxng/interfaces/SearxngResult.md)\n\n***\n\n### SearxngResultFormat\n\nRe-exports [SearxngResultFormat](searxng/type-aliases/SearxngResultFormat.md)\n\n***\n\n### SearxngResultLike\n\nRe-exports [SearxngResultLike](web_retrieval/interfaces/SearxngResultLike.md)\n\n***\n\n### searxngResultsToRetrievables\n\nRe-exports [searxngResultsToRetrievables](web_retrieval/functions/searxngResultsToRetrievables.md)\n\n***\n\n### SearxngToolConfig\n\nRe-exports [SearxngToolConfig](searxng/interfaces/SearxngToolConfig.md)\n\n***\n\n### setOperationsTool\n\nRe-exports [setOperationsTool](data_structure/variables/setOperationsTool.md)\n\n***\n\n### SpoolHook\n\nRe-exports [SpoolHook](web_retrieval/type-aliases/SpoolHook.md)\n\n***\n\n### standingInstructionTools\n\nRe-exports [standingInstructionTools](standing_instructions/variables/standingInstructionTools.md)\n\n***\n\n### statsCorrelateTool\n\nRe-exports [statsCorrelateTool](statistics/variables/statsCorrelateTool.md)\n\n***\n\n### statsDescribeTool\n\nRe-exports [statsDescribeTool](statistics/variables/statsDescribeTool.md)\n\n***\n\n### statsHistogramTool\n\nRe-exports [statsHistogramTool](statistics/variables/statsHistogramTool.md)\n\n***\n\n### statsTransformTool\n\nRe-exports [statsTransformTool](statistics/variables/statsTransformTool.md)\n\n***\n\n### storeMemoryTool\n\nRe-exports [storeMemoryTool](memory/variables/storeMemoryTool.md)\n\n***\n\n### storeRetrievables\n\nRe-exports [storeRetrievables](web_retrieval/functions/storeRetrievables.md)\n\n***\n\n### storeRetrievableTool\n\nRe-exports [storeRetrievableTool](retrievables/variables/storeRetrievableTool.md)\n\n***\n\n### stringExtractTool\n\nRe-exports [stringExtractTool](string_processing/variables/stringExtractTool.md)\n\n***\n\n### stringSimilarityTool\n\nRe-exports [stringSimilarityTool](text_comparison/variables/stringSimilarityTool.md)\n\n***\n\n### stringTransformTool\n\nRe-exports [stringTransformTool](string_processing/variables/stringTransformTool.md)\n\n***\n\n### textAnalyzeTool\n\nRe-exports [textAnalyzeTool](text_analysis/variables/textAnalyzeTool.md)\n\n***\n\n### textDiffTool\n\nRe-exports [textDiffTool](text_comparison/variables/textDiffTool.md)\n\n***\n\n### textEscapeTool\n\nRe-exports [textEscapeTool](encoding/variables/textEscapeTool.md)\n\n***\n\n### textLinesTool\n\nRe-exports [textLinesTool](text_analysis/variables/textLinesTool.md)\n\n***\n\n### ToRetrievableOptions\n\nRe-exports [ToRetrievableOptions](web_retrieval/interfaces/ToRetrievableOptions.md)\n\n***\n\n### unicodeNormalizeTool\n\nRe-exports [unicodeNormalizeTool](encoding/variables/unicodeNormalizeTool.md)\n\n***\n\n### updateMemoryTool\n\nRe-exports [updateMemoryTool](memory/variables/updateMemoryTool.md)\n\n***\n\n### updateRetrievableTool\n\nRe-exports [updateRetrievableTool](retrievables/variables/updateRetrievableTool.md)\n\n***\n\n### validateFormatTool\n\nRe-exports [validateFormatTool](structured_data/variables/validateFormatTool.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared","title":"@nhtio/adk/batteries/tools/\\_shared","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared.md'\ndescription: >-\n Cross-battery helpers shared by the configured HTTP tool batteries (SearXNG,\n Scrapper, …).\n---\n\n# @nhtio/adk/batteries/tools/\\_shared\n\nCross-battery helpers shared by the configured HTTP tool batteries (SearXNG, Scrapper, …).\n\n## Remarks\n\nThese are internal building blocks for the *factory-style* tool batteries — the ones that talk\nto a configured HTTP instance behind custom auth and expose input/output middleware pipelines.\nRather than each battery carry its own copy, the common machinery lives here:\n\n* [resolveArtifact](functions/resolveArtifact.md) / [resolveArtifactSync](functions/resolveArtifactSync.md) — turn an [ArtifactResolver](type-aliases/ArtifactResolver.md)\n (a constructor, a sync resolver, or an async / dynamic-import resolver) into the **sync**\n `() => SpooledArtifactConstructor` that `Tool.artifactConstructor` requires. Mirrors the vector\n battery's `resolveClientCtor`.\n* [resolveHeaders](functions/resolveHeaders.md) — collapse a static header object or a (sync/async) resolver into a\n plain header record for one request (refreshable-auth friendly).\n* [runInputPipeline](functions/runInputPipeline.md) / [runOutputPipeline](functions/runOutputPipeline.md) — the onion middleware runners (fresh\n runner per call, short-circuit + non-terminal detection), generic over the context type.\n\nThis module imports harness primitives only through their specific subpath barrels\n(`@nhtio/adk/spooled_artifact`, `@nhtio/adk/forge`, `@nhtio/adk/guards`) per the batteries\nbarrel-only rule.\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ArtifactResolver](type-aliases/ArtifactResolver.md) | The artifact configuration accepted by a factory: a constructor, a sync resolver, or an async / dynamic-import resolver (which may yield a module namespace whose `default` is the constructor). |\n| [MiddlewareFn](type-aliases/MiddlewareFn.md) | A generic onion middleware stage over a mutable context `C`. |\n| [SpooledArtifactCtor](type-aliases/SpooledArtifactCtor.md) | Convenience alias for the spooled-artifact constructor a tool wraps its output in. |\n| [SyncArtifactResolver](type-aliases/SyncArtifactResolver.md) | The sync subset of [ArtifactResolver](type-aliases/ArtifactResolver.md) — a constructor or a sync resolver (no Promise). |\n| [ToolGateFn](type-aliases/ToolGateFn.md) | Optional per-call gate run before a side-effecting tool executes. Throwing aborts the call and surfaces through the standard tool-error path (`E_TOOL_DOWNSTREAM_ERROR` with the denial as `cause`). The canonical implementation awaits `ctx.waitFor({ reason: 'tool_approval', payload: call })` — the ADK gates primitive — and throws on denial; WHO approves and HOW is the consumer's contract, this type is the seam. |\n| [ToolHeaders](type-aliases/ToolHeaders.md) | A static set of request headers (used for custom instance authentication). |\n| [ToolHeadersResolver](type-aliases/ToolHeadersResolver.md) | A resolver returning request headers, sync or async. Use this form when the auth token is refreshable — the resolver runs on every request, so a fresh token can be minted per call. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [isShortCircuit](functions/isShortCircuit.md) | `true` when `value` is the short-circuit sentinel produced by [makeShortCircuit](functions/makeShortCircuit.md). |\n| [makeShortCircuit](functions/makeShortCircuit.md) | Build a `shortCircuit(result)` function for an input-pipeline context. Calling it throws the internal sentinel, which [runInputPipeline](functions/runInputPipeline.md) catches and converts into the verbatim result (skipping the HTTP request entirely — e.g. a cache hit). |\n| [resolveArtifact](functions/resolveArtifact.md) | Resolve an [ArtifactResolver](type-aliases/ArtifactResolver.md) to the **sync** `() => SpooledArtifactCtor` that `Tool.artifactConstructor` requires (the wrap-site and the construction-time validator both invoke it synchronously, so an async resolver cannot be passed straight through). |\n| [resolveArtifactSync](functions/resolveArtifactSync.md) | Synchronous [resolveArtifact](functions/resolveArtifact.md): accepts only the [SyncArtifactResolver](type-aliases/SyncArtifactResolver.md) subset and throws (via `onInvalid`) on an async resolver — a runtime guard for JS callers who bypass the compile-time narrowing. |\n| [resolveHeaders](functions/resolveHeaders.md) | Resolve the configured headers (a static object or a sync/async resolver) for a single request. |\n| [runInputPipeline](functions/runInputPipeline.md) | Run an input pipeline over `ctx`. Returns the short-circuit string when a stage short-circuited, or `undefined` when the pipeline reached its terminal handler. A non-terminal pipeline (a stage that neither called `next()` nor short-circuited) throws — the caller converts it to an `Error:` string. |\n| [runOutputPipeline](functions/runOutputPipeline.md) | Run an output pipeline over `ctx`; rethrow any stage error to the caller's try/catch. A non-terminal pipeline (no `next()`) throws. |\n| [runToolGate](functions/runToolGate.md) | Await a configured [ToolGateFn](type-aliases/ToolGateFn.md) (no-op when absent). Factory batteries call this at the top of their handlers so the gate runs before any side effect. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/isShortCircuit","title":"Function: isShortCircuit()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/isShortCircuit.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/isShortCircuit","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/isShortCircuit.md\n---\n\n# Function: isShortCircuit()\n\n```ts\nfunction isShortCircuit(value: unknown): value is { result: string };\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:180](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L180)\n\n`true` when `value` is the short-circuit sentinel produced by [makeShortCircuit](makeShortCircuit.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | --------- |\n| `value` | `unknown` |\n\n## Returns\n\n`value is { result: string }`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/makeShortCircuit","title":"Function: makeShortCircuit()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/makeShortCircuit.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/makeShortCircuit","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/makeShortCircuit.md\n---\n\n# Function: makeShortCircuit()\n\n```ts\nfunction makeShortCircuit(): (result: string) => never;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:190](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L190)\n\nBuild a `shortCircuit(result)` function for an input-pipeline context. Calling it throws the\ninternal sentinel, which [runInputPipeline](runInputPipeline.md) catches and converts into the verbatim result\n(skipping the HTTP request entirely — e.g. a cache hit).\n\n## Returns\n\nA function that, when called with a result string, throws the short-circuit sentinel.\n\n(`result`: `string`) => `never`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifact","title":"Function: resolveArtifact()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifact.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifact","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifact.md\n---\n\n# Function: resolveArtifact()\n\n```ts\nfunction resolveArtifact(\n resolver: ArtifactResolver,\n onInvalid: (reason: string) => never,\n): Promise<() => SpooledArtifactCtor>;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:103](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L103)\n\nResolve an [ArtifactResolver](../type-aliases/ArtifactResolver.md) to the **sync** `() => SpooledArtifactCtor` that\n`Tool.artifactConstructor` requires (the wrap-site and the construction-time validator both\ninvoke it synchronously, so an async resolver cannot be passed straight through).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `resolver` | [`ArtifactResolver`](../type-aliases/ArtifactResolver.md) | The artifact configuration. When `undefined`, callers should fall back to their own default (this function rejects `undefined` so the default lives with the caller). |\n| `onInvalid` | (`reason`: `string`) => `never` | Throws a battery-scoped error; receives a human-readable reason. |\n\n## Returns\n\n`Promise`<() => [`SpooledArtifactCtor`](../type-aliases/SpooledArtifactCtor.md)>\n\nA sync `() => SpooledArtifactCtor` suitable for `Tool.artifactConstructor`.\n\n## Remarks\n\nA bare constructor is itself a function, so it is distinguished from a resolver via\n`SpooledArtifact.isSpooledArtifactConstructor` (the same duck-typed guard the core validator\nuses) rather than by arity. Async because a dynamic-import resolver must be awaited here.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifactSync","title":"Function: resolveArtifactSync()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifactSync.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifactSync","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/resolveArtifactSync.md\n---\n\n# Function: resolveArtifactSync()\n\n```ts\nfunction resolveArtifactSync(\n resolver: SyncArtifactResolver,\n onInvalid: (reason: string) => never,\n): () => SpooledArtifactCtor;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L139)\n\nSynchronous [resolveArtifact](resolveArtifact.md): accepts only the [SyncArtifactResolver](../type-aliases/SyncArtifactResolver.md) subset and\nthrows (via `onInvalid`) on an async resolver — a runtime guard for JS callers who bypass the\ncompile-time narrowing.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | ----------------------------------------------------------------- | ---------------------------------------------------------------- |\n| `resolver` | [`SyncArtifactResolver`](../type-aliases/SyncArtifactResolver.md) | A constructor or a sync resolver. |\n| `onInvalid` | (`reason`: `string`) => `never` | Throws a battery-scoped error; receives a human-readable reason. |\n\n## Returns\n\nA sync `() => SpooledArtifactCtor` suitable for `Tool.artifactConstructor`.\n\n() => [`SpooledArtifactCtor`](../type-aliases/SpooledArtifactCtor.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveHeaders","title":"Function: resolveHeaders()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveHeaders.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/resolveHeaders","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/resolveHeaders.md\n---\n\n# Function: resolveHeaders()\n\n```ts\nfunction resolveHeaders(\n headers: ToolHeadersResolver | ToolHeaders | undefined,\n): Promise;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L48)\n\nResolve the configured headers (a static object or a sync/async resolver) for a single request.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |\n| `headers` | | [`ToolHeadersResolver`](../type-aliases/ToolHeadersResolver.md) | [`ToolHeaders`](../type-aliases/ToolHeaders.md) | `undefined` | The static header record, the resolver, or `undefined`. |\n\n## Returns\n\n`Promise`<[`ToolHeaders`](../type-aliases/ToolHeaders.md)>\n\nA fresh, owned copy of the resolved headers (`{}` when none supplied).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runInputPipeline","title":"Function: runInputPipeline()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runInputPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runInputPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/runInputPipeline.md\n---\n\n# Function: runInputPipeline()\n\n```ts\nfunction runInputPipeline(\n mw: Middleware>,\n ctx: C,\n label: string,\n): Promise;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L211)\n\nRun an input pipeline over `ctx`. Returns the short-circuit string when a stage short-circuited,\nor `undefined` when the pipeline reached its terminal handler. A non-terminal pipeline (a stage\nthat neither called `next()` nor short-circuited) throws — the caller converts it to an\n`Error:` string.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `C` |\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |\n| `mw` | `Middleware`<[`MiddlewareFn`](../type-aliases/MiddlewareFn.md)<`C`>> | The `Middleware` instance holding the stages (a fresh `.runner()` is minted here). |\n| `ctx` | `C` | The mutable input context handed to each stage. |\n| `label` | `string` | Battery name, used in the non-terminal error message. |\n\n## Returns\n\n`Promise`<`string` | `undefined`>\n\nThe short-circuit result string, or `undefined` if the pipeline ran to completion.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runOutputPipeline","title":"Function: runOutputPipeline()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runOutputPipeline.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runOutputPipeline","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/runOutputPipeline.md\n---\n\n# Function: runOutputPipeline()\n\n```ts\nfunction runOutputPipeline(\n mw: Middleware>,\n ctx: C,\n label: string,\n): Promise;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:250](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L250)\n\nRun an output pipeline over `ctx`; rethrow any stage error to the caller's try/catch. A\nnon-terminal pipeline (no `next()`) throws.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `C` |\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |\n| `mw` | `Middleware`<[`MiddlewareFn`](../type-aliases/MiddlewareFn.md)<`C`>> | The `Middleware` instance holding the stages (a fresh `.runner()` is minted here). |\n| `ctx` | `C` | The mutable output context handed to each stage. |\n| `label` | `string` | Battery name, used in the non-terminal error message. |\n\n## Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runToolGate","title":"Function: runToolGate()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runToolGate.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/functions/runToolGate","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/functions/runToolGate.md\n---\n\n# Function: runToolGate()\n\n```ts\nfunction runToolGate(\n gate: ToolGateFn | undefined,\n ctx: unknown,\n tool: string,\n args: unknown,\n): Promise;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:296](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L296)\n\nAwait a configured [ToolGateFn](../type-aliases/ToolGateFn.md) (no-op when absent). Factory batteries call this at\nthe top of their handlers so the gate runs before any side effect.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------ | ------------------------------------------ |\n| `gate` | [`ToolGateFn`](../type-aliases/ToolGateFn.md) | `undefined` | The configured gate, if any. |\n| `ctx` | `unknown` | The dispatch context the handler received. |\n| `tool` | `string` | The tool name (post-override). |\n| `args` | `unknown` | The validated tool args. |\n\n## Returns\n\n`Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ArtifactResolver","title":"Type Alias: ArtifactResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ArtifactResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ArtifactResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ArtifactResolver.md\ndescription: >-\n The artifact configuration accepted by a factory: a constructor, a sync\n resolver, or an async / dynamic-import resolver (which may yield a module\n namespace whose `default` is the constructor).\n---\n\n# Type Alias: ArtifactResolver\n\n```ts\ntype ArtifactResolver =\n | SpooledArtifactCtor\n | (() =>\n | SpooledArtifactCtor\n | {\n default: SpooledArtifactCtor;\n })\n | (() => Promise<\n | SpooledArtifactCtor\n | {\n default: SpooledArtifactCtor;\n }\n >);\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:69](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L69)\n\nThe artifact configuration accepted by a factory: a constructor, a sync resolver, or an async /\ndynamic-import resolver (which may yield a module namespace whose `default` is the constructor).\n\n## Remarks\n\nMirrors the vector battery's `client` resolver and `Tool.artifactConstructor`'s indirection. The\nasync form lets a consumer `() => import('@nhtio/adk/spooled_artifact').then(m => m.SpooledMarkdownArtifact)`\nso the artifact class never enters their static module graph.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/MiddlewareFn","title":"Type Alias: MiddlewareFn\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/MiddlewareFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/MiddlewareFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/MiddlewareFn.md\ndescription: A generic onion middleware stage over a mutable context `C`.\n---\n\n# Type Alias: MiddlewareFn\\\n\n```ts\ntype MiddlewareFn = (ctx: C, next: NextFn) => void | Promise;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L198)\n\nA generic onion middleware stage over a mutable context `C`.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `C` |\n\n## Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `ctx` | `C` |\n| `next` | `NextFn` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SpooledArtifactCtor","title":"Type Alias: SpooledArtifactCtor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SpooledArtifactCtor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SpooledArtifactCtor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SpooledArtifactCtor.md\ndescription: >-\n Convenience alias for the spooled-artifact constructor a tool wraps its output\n in.\n---\n\n# Type Alias: SpooledArtifactCtor\n\n```ts\ntype SpooledArtifactCtor = SpooledArtifactConstructor;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L58)\n\nConvenience alias for the spooled-artifact constructor a tool wraps its output in.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SyncArtifactResolver","title":"Type Alias: SyncArtifactResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SyncArtifactResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SyncArtifactResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/SyncArtifactResolver.md\ndescription: >-\n The sync subset of [`ArtifactResolver`](https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ArtifactResolver) — a constructor or a sync resolver\n (no Promise).\n---\n\n# Type Alias: SyncArtifactResolver\n\n```ts\ntype SyncArtifactResolver =\n | SpooledArtifactCtor\n | (() =>\n | SpooledArtifactCtor\n | {\n default: SpooledArtifactCtor;\n });\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L75)\n\nThe sync subset of [ArtifactResolver](ArtifactResolver.md) — a constructor or a sync resolver (no Promise).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolGateFn","title":"Type Alias: ToolGateFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolGateFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolGateFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolGateFn.md\ndescription: >-\n Optional per-call gate run before a side-effecting tool executes. Throwing\n aborts the call and surfaces through the standard tool-error path\n (`E_TOOL_DOWNSTREAM_ERROR` with the denial as `cause`). The canonical\n implementation awaits\n---\n\n# Type Alias: ToolGateFn\n\n```ts\ntype ToolGateFn = (\n ctx: unknown,\n call: {\n args: unknown;\n tool: string;\n },\n) => void | Promise;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:282](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L282)\n\nOptional per-call gate run before a side-effecting tool executes. Throwing aborts the call\nand surfaces through the standard tool-error path (`E_TOOL_DOWNSTREAM_ERROR` with the denial\nas `cause`). The canonical implementation awaits `ctx.waitFor({ reason: 'tool_approval',\npayload: call })` — the ADK gates primitive — and throws on denial; WHO approves and HOW is\nthe consumer's contract, this type is the seam.\n\n## Parameters\n\n| Parameter | Type |\n| ----------- | ------------------------------------------ |\n| `ctx` | `unknown` |\n| `call` | { `args`: `unknown`; `tool`: `string`; } |\n| `call.args` | `unknown` |\n| `call.tool` | `string` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeaders","title":"Type Alias: ToolHeaders","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeaders.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeaders","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeaders.md\ndescription: A static set of request headers (used for custom instance authentication).\n---\n\n# Type Alias: ToolHeaders\n\n```ts\ntype ToolHeaders = Record;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:34](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L34)\n\nA static set of request headers (used for custom instance authentication).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeadersResolver","title":"Type Alias: ToolHeadersResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeadersResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeadersResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/_shared/type-aliases/ToolHeadersResolver.md\ndescription: >-\n A resolver returning request headers, sync or async. Use this form when the\n auth token is refreshable — the resolver runs on every request, so a fresh\n token can be minted per call.\n---\n\n# Type Alias: ToolHeadersResolver\n\n```ts\ntype ToolHeadersResolver = () => ToolHeaders | Promise;\n```\n\nDefined in: [src/batteries/tools/\\_shared/index.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/_shared/index.ts#L40)\n\nA resolver returning request headers, sync or async. Use this form when the auth token is\nrefreshable — the resolver runs on every request, so a fresh token can be minted per call.\n\n## Returns\n\n| [`ToolHeaders`](ToolHeaders.md)\n| `Promise`<[`ToolHeaders`](ToolHeaders.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/color","title":"@nhtio/adk/batteries/tools/color","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/color.md'\ndescription: Pre-constructed tools for color conversion and palette-oriented calculations.\n---\n\n# @nhtio/adk/batteries/tools/color\n\nPre-constructed tools for color conversion and palette-oriented calculations.\n\n## Remarks\n\nPre-constructed bundled tools for the `color` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------- | ------------------------------------------------------------------- |\n| [colorAdjustTool](variables/colorAdjustTool.md) | Lighten or darken a colour by a percentage of HSL lightness. |\n| [colorContrastTool](variables/colorContrastTool.md) | Compute the WCAG 2.1 contrast ratio between two colours. |\n| [colorSchemeTool](variables/colorSchemeTool.md) | Generate a colour palette from a base colour using a named harmony. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorAdjustTool","title":"Variable: colorAdjustTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorAdjustTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorAdjustTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/color/variables/colorAdjustTool.md\ndescription: Lighten or darken a colour by a percentage of HSL lightness.\n---\n\n# Variable: colorAdjustTool\n\n```ts\nconst colorAdjustTool: Tool;\n```\n\nDefined in: [src/batteries/tools/color/index.ts:634](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/color/index.ts#L634)\n\nLighten or darken a colour by a percentage of HSL lightness.\n\n## Remarks\n\n`amount` is clamped to `[1, 100]`; `steps` is clamped to `[1, 10]`. With `steps > 1` the tool\nemits a ramp of progressively-adjusted colours, useful for generating tint/shade scales.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorContrastTool","title":"Variable: colorContrastTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorContrastTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorContrastTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/color/variables/colorContrastTool.md\ndescription: Compute the WCAG 2.1 contrast ratio between two colours.\n---\n\n# Variable: colorContrastTool\n\n```ts\nconst colorContrastTool: Tool;\n```\n\nDefined in: [src/batteries/tools/color/index.ts:462](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/color/index.ts#L462)\n\nCompute the WCAG 2.1 contrast ratio between two colours.\n\n## Remarks\n\nAccepts hex (`#rgb`, `#rrggbb`), `rgb()`, `hsl()`, or one of the CSS / Material Design named\ncolours. Reports the ratio and pass/fail against WCAG AA and AAA at both normal and large text\nsizes. If the foreground/background combination fails AA Normal (4.5:1), the tool suggests\nlightened or darkened variants that would pass.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorSchemeTool","title":"Variable: colorSchemeTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorSchemeTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/color/variables/colorSchemeTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/color/variables/colorSchemeTool.md\ndescription: Generate a colour palette from a base colour using a named harmony.\n---\n\n# Variable: colorSchemeTool\n\n```ts\nconst colorSchemeTool: Tool;\n```\n\nDefined in: [src/batteries/tools/color/index.ts:556](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/color/index.ts#L556)\n\nGenerate a colour palette from a base colour using a named harmony.\n\n## Remarks\n\nSupported schemes: `complementary`, `analogous`, `triadic`, `split-complementary`,\n`monochromatic`. Each entry reports its hex, rgb, and hsl forms, plus the contrast ratio\nrelative to the base colour.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison","title":"@nhtio/adk/batteries/tools/comparison","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/comparison.md'\ndescription: 'Pre-constructed tools for comparing primitive values, arrays, and ranges.'\n---\n\n# @nhtio/adk/batteries/tools/comparison\n\nPre-constructed tools for comparing primitive values, arrays, and ranges.\n\n## Remarks\n\nPre-constructed bundled tools for the `comparison` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| [compareRecordsTool](variables/compareRecordsTool.md) | Compare two JSON objects and report keys only in A, keys only in B, keys with matching values, and keys with differing values. |\n| [compareValuesTool](variables/compareValuesTool.md) | Compare two values and return their relationship (`equal`, `greater_than`, `less_than`). |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison/variables/compareRecordsTool","title":"Variable: compareRecordsTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison/variables/compareRecordsTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison/variables/compareRecordsTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/comparison/variables/compareRecordsTool.md\ndescription: >-\n Compare two JSON objects and report keys only in A, keys only in B, keys with\n matching values, and keys with differing values.\n---\n\n# Variable: compareRecordsTool\n\n```ts\nconst compareRecordsTool: Tool;\n```\n\nDefined in: [src/batteries/tools/comparison/index.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/comparison/index.ts#L127)\n\nCompare two JSON objects and report keys only in A, keys only in B, keys with matching\nvalues, and keys with differing values.\n\n## Remarks\n\nAccepts JSON strings (not pre-parsed objects) so the schema can validate the input\nshape uniformly across providers. When `deep` is true (default), nested objects and arrays\nare compared structurally; when false, comparison reduces to JSON serialisation equality.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison/variables/compareValuesTool","title":"Variable: compareValuesTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison/variables/compareValuesTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/comparison/variables/compareValuesTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/comparison/variables/compareValuesTool.md\ndescription: >-\n Compare two values and return their relationship (`equal`, `greater_than`,\n `less_than`).\n---\n\n# Variable: compareValuesTool\n\n```ts\nconst compareValuesTool: Tool;\n```\n\nDefined in: [src/batteries/tools/comparison/index.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/comparison/index.ts#L43)\n\nCompare two values and return their relationship (`equal`, `greater_than`, `less_than`).\n\n## Remarks\n\nHandles numbers, strings (lexicographic), booleans, ISO date strings, and null/undefined.\nUse `type_hint` to force a specific interpretation; the default `auto` infers from the\nvalues themselves.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure","title":"@nhtio/adk/batteries/tools/data\\_structure","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/data_structure.md'\ndescription: >-\n Pre-constructed tools for querying, filtering, grouping, and reshaping\n structured values.\n---\n\n# @nhtio/adk/batteries/tools/data\\_structure\n\nPre-constructed tools for querying, filtering, grouping, and reshaping structured values.\n\n## Remarks\n\nPre-constructed bundled tools for the `data_structure` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------- | --------------------------------------------------------- |\n| [jsonTransformTool](variables/jsonTransformTool.md) | Apply a pipeline of operations to a JSON array or object. |\n| [setOperationsTool](variables/setOperationsTool.md) | Perform set operations on two JSON arrays. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure/variables/jsonTransformTool","title":"Variable: jsonTransformTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure/variables/jsonTransformTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure/variables/jsonTransformTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/data_structure/variables/jsonTransformTool.md\ndescription: Apply a pipeline of operations to a JSON array or object.\n---\n\n# Variable: jsonTransformTool\n\n```ts\nconst jsonTransformTool: Tool;\n```\n\nDefined in: [src/batteries/tools/data\\_structure/index.ts:317](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/data_structure/index.ts#L317)\n\nApply a pipeline of operations to a JSON array or object.\n\n## Remarks\n\nOperations are applied in order; each step transforms the output of the previous. Supported\noperations: `filter`, `sort`, `select_keys`, `pluck`, `slice`, `unique`, `unique_by`,\n`group_by`, `flatten`, `reverse`, `count`, `sum`, `avg`, `median`, `min`, `max`, `first`,\n`last`, `chunk`, `frequency_count`, `top_n`, `map_template`. Dot-notation paths are supported\nfor nested key access in every operation that takes a `key` field.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure/variables/setOperationsTool","title":"Variable: setOperationsTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure/variables/setOperationsTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/data_structure/variables/setOperationsTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/data_structure/variables/setOperationsTool.md\ndescription: Perform set operations on two JSON arrays.\n---\n\n# Variable: setOperationsTool\n\n```ts\nconst setOperationsTool: Tool;\n```\n\nDefined in: [src/batteries/tools/data\\_structure/index.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/data_structure/index.ts#L371)\n\nPerform set operations on two JSON arrays.\n\n## Remarks\n\nSupported operations: `intersection`, `union`, `difference`, `symmetric_difference`,\n`is_member`, `is_subset`, `is_superset`. For arrays of objects, an optional `compare_key`\nnarrows equality to a single property rather than deep structural comparison.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended","title":"@nhtio/adk/batteries/tools/datetime\\_extended","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_extended.md'\ndescription: >-\n Pre-constructed tools for parsing natural-language dates and business-calendar\n calculations.\n---\n\n# @nhtio/adk/batteries/tools/datetime\\_extended\n\nPre-constructed tools for parsing natural-language dates and business-calendar calculations.\n\n## Remarks\n\nPre-constructed bundled tools for the `datetime_extended` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| [dateBusinessDaysTool](variables/dateBusinessDaysTool.md) | Count business days between two dates, or compute the date N business days away. |\n| [dateCalendarInfoTool](variables/dateCalendarInfoTool.md) | Get calendar metadata for a date. |\n| [dateNthWeekdayTool](variables/dateNthWeekdayTool.md) | Find the Nth occurrence of a weekday in a given month. |\n| [dateParseTool](variables/dateParseTool.md) | Parse a date/time expression from natural language or common formats. |\n| [datePeriodTool](variables/datePeriodTool.md) | Get the start or end of a time period containing a given date. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateBusinessDaysTool","title":"Variable: dateBusinessDaysTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateBusinessDaysTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateBusinessDaysTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateBusinessDaysTool.md\ndescription: >-\n Count business days between two dates, or compute the date N business days\n away.\n---\n\n# Variable: dateBusinessDaysTool\n\n```ts\nconst dateBusinessDaysTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_extended/index.ts:410](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_extended/index.ts#L410)\n\nCount business days between two dates, or compute the date N business days away.\n\n## Remarks\n\nMonday–Friday only; no holiday calendar awareness. Provide either `to` (count between) or\n`add_days` (compute target date). Negative `add_days` walks backwards.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateCalendarInfoTool","title":"Variable: dateCalendarInfoTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateCalendarInfoTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateCalendarInfoTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateCalendarInfoTool.md\ndescription: Get calendar metadata for a date.\n---\n\n# Variable: dateCalendarInfoTool\n\n```ts\nconst dateCalendarInfoTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_extended/index.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_extended/index.ts#L160)\n\nGet calendar metadata for a date.\n\n## Remarks\n\nReports ISO week number, day of year, calendar quarter, fiscal quarter/year (configurable via\n`fiscal_year_start_month`), week of month, and whether the date is a weekend. Accepts ISO\ndates, natural-language (\"next Tuesday\"), and `now`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateNthWeekdayTool","title":"Variable: dateNthWeekdayTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateNthWeekdayTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateNthWeekdayTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateNthWeekdayTool.md\ndescription: Find the Nth occurrence of a weekday in a given month.\n---\n\n# Variable: dateNthWeekdayTool\n\n```ts\nconst dateNthWeekdayTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_extended/index.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_extended/index.ts#L47)\n\nFind the Nth occurrence of a weekday in a given month.\n\n## Remarks\n\nExamples: \"2nd Friday of March 2026\", \"last Monday of January 2025\". Accepts 1st–5th and\n`last`. Returns an error if the month does not contain that many occurrences of the weekday.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateParseTool","title":"Variable: dateParseTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateParseTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateParseTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_extended/variables/dateParseTool.md\ndescription: Parse a date/time expression from natural language or common formats.\n---\n\n# Variable: dateParseTool\n\n```ts\nconst dateParseTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_extended/index.ts:244](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_extended/index.ts#L244)\n\nParse a date/time expression from natural language or common formats.\n\n## Remarks\n\nExamples: `\"next Monday\"`, `\"March 5th\"`, `\"in 2 weeks\"`, `\"yesterday\"`. Uses chrono-node for\nrelative parsing. `reference_date` overrides the \"now\" anchor.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/datePeriodTool","title":"Variable: datePeriodTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/datePeriodTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_extended/variables/datePeriodTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_extended/variables/datePeriodTool.md\ndescription: Get the start or end of a time period containing a given date.\n---\n\n# Variable: datePeriodTool\n\n```ts\nconst datePeriodTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_extended/index.ts:301](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_extended/index.ts#L301)\n\nGet the start or end of a time period containing a given date.\n\n## Remarks\n\nPeriods: `day`, `week`, `isoweek` (Monday-start), `month`, `quarter`, `year`. Quarter and year\nhonour `fiscal_year_start_month` for fiscal calendars (default: 1 = calendar year).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math","title":"@nhtio/adk/batteries/tools/datetime\\_math","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_math.md'\ndescription: >-\n Pre-constructed tools for ISO datetime arithmetic, differences, and\n timezone-aware formatting.\n---\n\n# @nhtio/adk/batteries/tools/datetime\\_math\n\nPre-constructed tools for ISO datetime arithmetic, differences, and timezone-aware formatting.\n\n## Remarks\n\nPre-constructed bundled tools for the `datetime_math` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------- | ------------------------------------------------------------------ |\n| [dateAddTool](variables/dateAddTool.md) | Add or subtract a duration from a date/time. |\n| [dateDiffTool](variables/dateDiffTool.md) | Calculate the difference between two dates/times in a chosen unit. |\n| [durationFormatTool](variables/durationFormatTool.md) | Convert total seconds into a human-readable duration string. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateAddTool","title":"Variable: dateAddTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateAddTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateAddTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateAddTool.md\ndescription: Add or subtract a duration from a date/time.\n---\n\n# Variable: dateAddTool\n\n```ts\nconst dateAddTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_math/index.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_math/index.ts#L39)\n\nAdd or subtract a duration from a date/time.\n\n## Remarks\n\nAll duration components (years/months/weeks/days/hours/minutes/seconds) are optional and\ncombined into a single Duration. Output formatting includes a time component when the input\nitself has one or when any sub-day component is non-zero.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateDiffTool","title":"Variable: dateDiffTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateDiffTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateDiffTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_math/variables/dateDiffTool.md\ndescription: Calculate the difference between two dates/times in a chosen unit.\n---\n\n# Variable: dateDiffTool\n\n```ts\nconst dateDiffTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_math/index.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_math/index.ts#L116)\n\nCalculate the difference between two dates/times in a chosen unit.\n\n## Remarks\n\nResult is signed — positive when `to` is after `from`, negative otherwise — but rendered as\n`|value| after/before` for readability. Uses luxon's `diff().as(unit)` which respects\ncalendar arithmetic for months/years.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/durationFormatTool","title":"Variable: durationFormatTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/durationFormatTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/datetime_math/variables/durationFormatTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/datetime_math/variables/durationFormatTool.md\ndescription: Convert total seconds into a human-readable duration string.\n---\n\n# Variable: durationFormatTool\n\n```ts\nconst durationFormatTool: Tool;\n```\n\nDefined in: [src/batteries/tools/datetime\\_math/index.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/datetime_math/index.ts#L169)\n\nConvert total seconds into a human-readable duration string.\n\n## Remarks\n\nExamples: `3725` → `1 hour, 2 minutes and 5 seconds`. Negative inputs are prefixed with `-`.\nZero seconds returns the literal `0 seconds`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding","title":"@nhtio/adk/batteries/tools/encoding","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/encoding.md'\ndescription: Pre-constructed tools for common text encodings and decoding operations.\n---\n\n# @nhtio/adk/batteries/tools/encoding\n\nPre-constructed tools for common text encodings and decoding operations.\n\n## Remarks\n\nPre-constructed bundled tools for the `encoding` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------- | ------------------------------------------------------------------------------------------ |\n| [encodeTextTool](variables/encodeTextTool.md) | Encode or decode text using common schemes: base64, url (percent-encoding), html\\_entities. |\n| [textEscapeTool](variables/textEscapeTool.md) | Escape or unescape special characters for a target context. |\n| [unicodeNormalizeTool](variables/unicodeNormalizeTool.md) | Normalize Unicode text or extract code points. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/encodeTextTool","title":"Variable: encodeTextTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/encodeTextTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/encodeTextTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/encoding/variables/encodeTextTool.md\ndescription: >-\n Encode or decode text using common schemes: base64, url (percent-encoding),\n html_entities.\n---\n\n# Variable: encodeTextTool\n\n```ts\nconst encodeTextTool: Tool;\n```\n\nDefined in: [src/batteries/tools/encoding/index.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/encoding/index.ts#L47)\n\nEncode or decode text using common schemes: base64, url (percent-encoding), html\\_entities.\n\n## Remarks\n\n`base64` uses the portable `globalThis.btoa`/`atob` pair so the tool works in browsers, Node,\nand edge runtimes. Encoding/decoding errors are returned as `Error:` strings rather than\nthrown so the model can react in-line.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/textEscapeTool","title":"Variable: textEscapeTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/textEscapeTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/textEscapeTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/encoding/variables/textEscapeTool.md\ndescription: Escape or unescape special characters for a target context.\n---\n\n# Variable: textEscapeTool\n\n```ts\nconst textEscapeTool: Tool;\n```\n\nDefined in: [src/batteries/tools/encoding/index.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/encoding/index.ts#L125)\n\nEscape or unescape special characters for a target context.\n\n## Remarks\n\nSupports `json_string`, `regex`, `csv_field`, `sql_like`, and `markdown` targets. Returns\nan error string for unknown targets rather than throwing.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/unicodeNormalizeTool","title":"Variable: unicodeNormalizeTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/unicodeNormalizeTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/encoding/variables/unicodeNormalizeTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/encoding/variables/unicodeNormalizeTool.md\ndescription: Normalize Unicode text or extract code points.\n---\n\n# Variable: unicodeNormalizeTool\n\n```ts\nconst unicodeNormalizeTool: Tool;\n```\n\nDefined in: [src/batteries/tools/encoding/index.ts:197](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/encoding/index.ts#L197)\n\nNormalize Unicode text or extract code points.\n\n## Remarks\n\nOperations: NFC, NFD, NFKC, NFKD Unicode normalization forms (via `String.prototype.normalize`),\n`strip_accents` (NFD-decompose, remove combining diacritics, re-compose to NFC), or\n`code_points` (one `U+HHHH (char)` per line).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting","title":"@nhtio/adk/batteries/tools/formatting","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/formatting.md'\ndescription: >-\n Pre-constructed tools for locale-aware number, list, table, and text\n formatting.\n---\n\n# @nhtio/adk/batteries/tools/formatting\n\nPre-constructed tools for locale-aware number, list, table, and text formatting.\n\n## Remarks\n\nPre-constructed bundled tools for the `formatting` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------- | ------------------------------------------ |\n| [formatListTool](variables/formatListTool.md) | Format an array of items as a list. |\n| [formatNumberTool](variables/formatNumberTool.md) | Format a number using locale-aware styles. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting/variables/formatListTool","title":"Variable: formatListTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting/variables/formatListTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting/variables/formatListTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/formatting/variables/formatListTool.md\ndescription: Format an array of items as a list.\n---\n\n# Variable: formatListTool\n\n```ts\nconst formatListTool: Tool;\n```\n\nDefined in: [src/batteries/tools/formatting/index.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/formatting/index.ts#L125)\n\nFormat an array of items as a list.\n\n## Remarks\n\nSupported styles: `bullet` (`• item`), `numbered` (`1. item`), `inline_and`\n(`a, b, and c`), `inline_or` (`a, b, or c`), `newline` (one per line).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting/variables/formatNumberTool","title":"Variable: formatNumberTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting/variables/formatNumberTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/formatting/variables/formatNumberTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/formatting/variables/formatNumberTool.md\ndescription: Format a number using locale-aware styles.\n---\n\n# Variable: formatNumberTool\n\n```ts\nconst formatNumberTool: Tool;\n```\n\nDefined in: [src/batteries/tools/formatting/index.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/formatting/index.ts#L24)\n\nFormat a number using locale-aware styles.\n\n## Remarks\n\nSupported styles: `decimal`, `currency`, `percent`, `compact` (e.g. `1.2K`), `scientific`\n(e.g. `1.2e+3`), and `ordinal` (`1st`, `2nd`, `3rd`). Uses `Intl.NumberFormat` and\n`Intl.PluralRules` from the JS standard library. Returns an error string for non-finite values\nor invalid currency-without-currency-code.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics","title":"@nhtio/adk/batteries/tools/geo\\_basics","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/geo_basics.md'\ndescription: >-\n Pre-constructed tools for basic geographic distance and coordinate\n calculations.\n---\n\n# @nhtio/adk/batteries/tools/geo\\_basics\n\nPre-constructed tools for basic geographic distance and coordinate calculations.\n\n## Remarks\n\nPre-constructed bundled tools for the `geo_basics` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------- | --------------------------------------------------------------------- |\n| [geoBboxContainsTool](variables/geoBboxContainsTool.md) | Check whether a point falls inside an axis-aligned bounding box. |\n| [geoDistanceTool](variables/geoDistanceTool.md) | Great-circle (haversine) distance between two geographic coordinates. |\n| [geoWithinRadiusTool](variables/geoWithinRadiusTool.md) | Check whether a point lies within a radius of a centre coordinate. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoBboxContainsTool","title":"Variable: geoBboxContainsTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoBboxContainsTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoBboxContainsTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoBboxContainsTool.md\ndescription: Check whether a point falls inside an axis-aligned bounding box.\n---\n\n# Variable: geoBboxContainsTool\n\n```ts\nconst geoBboxContainsTool: Tool;\n```\n\nDefined in: [src/batteries/tools/geo\\_basics/index.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/geo_basics/index.ts#L146)\n\nCheck whether a point falls inside an axis-aligned bounding box.\n\n## Remarks\n\nThe bounding box is defined by its SW and NE corners. Boxes that wrap the antimeridian\n(i.e. SW longitude greater than NE longitude) are handled correctly.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoDistanceTool","title":"Variable: geoDistanceTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoDistanceTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoDistanceTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoDistanceTool.md\ndescription: Great-circle (haversine) distance between two geographic coordinates.\n---\n\n# Variable: geoDistanceTool\n\n```ts\nconst geoDistanceTool: Tool;\n```\n\nDefined in: [src/batteries/tools/geo\\_basics/index.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/geo_basics/index.ts#L43)\n\nGreat-circle (haversine) distance between two geographic coordinates.\n\n## Remarks\n\nUses the Earth's mean radius (6371.0088 km). Returns both kilometres and miles.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoWithinRadiusTool","title":"Variable: geoWithinRadiusTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoWithinRadiusTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoWithinRadiusTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/geo_basics/variables/geoWithinRadiusTool.md\ndescription: Check whether a point lies within a radius of a centre coordinate.\n---\n\n# Variable: geoWithinRadiusTool\n\n```ts\nconst geoWithinRadiusTool: Tool;\n```\n\nDefined in: [src/batteries/tools/geo\\_basics/index.ts:92](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/geo_basics/index.ts#L92)\n\nCheck whether a point lies within a radius of a centre coordinate.\n\n## Remarks\n\nUses the haversine distance internally; returns the radius unit chosen by the caller\n(km or miles) in the result string.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/math","title":"@nhtio/adk/batteries/tools/math","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/math.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/math","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/math.md'\ndescription: >-\n Pre-constructed tools for safe arithmetic, expression evaluation, and numeric\n operations.\n---\n\n# @nhtio/adk/batteries/tools/math\n\nPre-constructed tools for safe arithmetic, expression evaluation, and numeric operations.\n\n## Remarks\n\nPre-constructed bundled tools for the `math` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |\n| [calculateTool](variables/calculateTool.md) | Evaluates a mathjs-syntax expression and returns the numeric result alongside the KaTeX representation of the parsed expression. |\n| [evaluateKatexTool](variables/evaluateKatexTool.md) | Translates a LaTeX/KaTeX expression using evaluatex and returns the numeric result. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/math/variables/calculateTool","title":"Variable: calculateTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/math/variables/calculateTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/math/variables/calculateTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/math/variables/calculateTool.md\ndescription: >-\n Evaluates a mathjs-syntax expression and returns the numeric result alongside\n the KaTeX representation of the parsed expression.\n---\n\n# Variable: calculateTool\n\n```ts\nconst calculateTool: Tool;\n```\n\nDefined in: [src/batteries/tools/math/index.ts:546](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/math/index.ts#L546)\n\nEvaluates a mathjs-syntax expression and returns the numeric result alongside the KaTeX\nrepresentation of the parsed expression.\n\n## Remarks\n\nSupports arithmetic, trigonometric, logarithmic, exponential, factorial, matrix, and unit\noperations via `mathjs`. The mathjs instance is hardened: dangerous functions (`import`,\n`createUnit`, `simplify`, `derivative`, `compile`, `chain`, `reviver`, `replacer`) are\ndisabled to prevent interpreter-surface exposure.\n\nExpressions over 1000 characters are rejected with an error string (not thrown). Parse and\nevaluation errors are also returned as error strings — the tool surfaces math errors as\ncontent rather than exceptions, so the model can react to them in-line.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/math/variables/evaluateKatexTool","title":"Variable: evaluateKatexTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/math/variables/evaluateKatexTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/math/variables/evaluateKatexTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/math/variables/evaluateKatexTool.md\ndescription: >-\n Translates a LaTeX/KaTeX expression using evaluatex and returns the numeric\n result.\n---\n\n# Variable: evaluateKatexTool\n\n```ts\nconst evaluateKatexTool: Tool;\n```\n\nDefined in: [src/batteries/tools/math/index.ts:598](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/math/index.ts#L598)\n\nTranslates a LaTeX/KaTeX expression using evaluatex and returns the numeric result.\n\n## Remarks\n\nUses the evaluatex library to parse and evaluate LaTeX expressions. Handles common constructs\n(`\\frac{a}{b}`, `\\sqrt{...}`, `\\cdot`, `\\times`, Greek macros like `\\pi`, inverse trig,\n`\\left`/`\\right` delimiters, `\\text{...}`, subscripts, etc.) with a proper parser rather than\nbrittle regex.\n\nAlso evaluates three calculus constructs **numerically** (mathjs has no symbolic integration, and\nits symbolic `derivative` is blocklisted here for safety):\n\n* Definite integrals — `\\int_{a}^{b} f \\,dx` via composite Simpson quadrature.\n* Derivatives at a point — `\\frac{d}{dx} f \\big|_{x=a}` via central finite difference.\n* Limits — `\\lim_{x \\to a} f` (including `a = \\pm\\infty`) via a two-sided numeric approach.\n\nNumeric results are rounded with `math.format(..., { precision: 12 })` and labelled\n`Result (numeric):` to flag that they are approximations. Constructs that cannot be evaluated\nnumerically (indefinite integrals, derivatives without a point, infinite integration bounds,\nsingular integrands, divergent limits) return a specific, guiding error string.\n\nParse and evaluation errors are returned as error strings rather than thrown.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/memory","title":"@nhtio/adk/batteries/tools/memory","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/memory.md'\ndescription: Pre-constructed CRUD tools for model-visible ADK memory management.\n---\n\n# @nhtio/adk/batteries/tools/memory\n\nPre-constructed CRUD tools for model-visible ADK memory management.\n\n## Remarks\n\nPre-constructed CRUD tools that expose the ADK's [@nhtio/adk!Memory](../../../common/classes/Memory.md) surface to the model.\nEach tool delegates to the corresponding callback on the active [@nhtio/adk!DispatchContext](../../../types/interfaces/DispatchContext.md)\n(`fetchMemories`, `storeMemory`, `mutateMemory`, `deleteMemory`) — the persistence layer is\nwhatever the consumer wired into the runner.\n\nMemory entries carry agent-internal `confidence` / `importance` scores and are rendered\nthrough the LLM battery's recall-tier envelope. Letting the model author and curate its own\nmemories is the canonical use case for these tools; deployers who do not want the model to\nmutate memory should simply not register the relevant tools.\n\nOutput is JSON for every tool so consumers can parse the result without re-tokenising — the\nartifact constructor is set to [@nhtio/adk!SpooledJsonArtifact](../../../spooled_artifact/classes/SpooledJsonArtifact.md).\n\nTools:\n\n* [listMemoriesTool](variables/listMemoriesTool.md) — read-only list of every memory currently held by the context.\n* [storeMemoryTool](variables/storeMemoryTool.md) — create a new memory (auto-generates `id` / `createdAt` /\n `updatedAt` unless explicit values are supplied).\n* [updateMemoryTool](variables/updateMemoryTool.md) — replace an existing memory by `id`. Bumps `updatedAt`.\n* [deleteMemoryTool](variables/deleteMemoryTool.md) — remove a memory by `id`.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [deleteMemoryTool](variables/deleteMemoryTool.md) | Remove an existing [@nhtio/adk!Memory](../../../common/classes/Memory.md) by `id`. |\n| [listMemoriesTool](variables/listMemoriesTool.md) | List every memory currently held by the active execution context. |\n| [memoryTools](variables/memoryTools.md) | Convenience tuple of every memory CRUD tool. Spread into a [@nhtio/adk!ToolRegistry](../../../forge/classes/ToolRegistry.md) to register the entire category at once: `registry.register(...memoryTools)`. |\n| [storeMemoryTool](variables/storeMemoryTool.md) | Create a new [@nhtio/adk!Memory](../../../common/classes/Memory.md) record and persist it via the context's `storeMemory` callback. |\n| [updateMemoryTool](variables/updateMemoryTool.md) | Replace an existing [@nhtio/adk!Memory](../../../common/classes/Memory.md) by `id`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/deleteMemoryTool","title":"Variable: deleteMemoryTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/deleteMemoryTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/deleteMemoryTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/memory/variables/deleteMemoryTool.md\ndescription: 'Remove an existing {@link @nhtio/adk!Memory} by `id`.'\n---\n\n# Variable: deleteMemoryTool\n\n```ts\nconst deleteMemoryTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/memory/index.ts:195](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/memory/index.ts#L195)\n\nRemove an existing [@nhtio/adk!Memory](../../../../common/classes/Memory.md) by `id`.\n\n## Remarks\n\nDelegates to `ctx.deleteMemory(id)`. Returns `{ ok: true, id }` on success regardless of\nwhether a memory was actually present — `deleteMemory` is idempotent at the ADK level.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/listMemoriesTool","title":"Variable: listMemoriesTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/listMemoriesTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/listMemoriesTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/memory/variables/listMemoriesTool.md\ndescription: List every memory currently held by the active execution context.\n---\n\n# Variable: listMemoriesTool\n\n```ts\nconst listMemoriesTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/memory/index.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/memory/index.ts#L51)\n\nList every memory currently held by the active execution context.\n\n## Remarks\n\nDelegates to `ctx.fetchMemories()`. Returns a JSON-encoded array of memory records (id,\ncontent, confidence, importance, createdAt, updatedAt). The model can use the `id` values\nto drive subsequent `update_memory` / `delete_memory` calls.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/memoryTools","title":"Variable: memoryTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/memoryTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/memoryTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/memory/variables/memoryTools.md\ndescription: >-\n Convenience tuple of every memory CRUD tool. Spread into a {@link\n @nhtio/adk!ToolRegistry} to register the entire category at once:\n `registry.register(...memoryTools)`.\n---\n\n# Variable: memoryTools\n\n```ts\nconst memoryTools: readonly [\n Tool>,\n Tool>,\n Tool>,\n Tool>,\n];\n```\n\nDefined in: [src/batteries/tools/memory/index.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/memory/index.ts#L217)\n\nConvenience tuple of every memory CRUD tool. Spread into a [@nhtio/adk!ToolRegistry](../../../../forge/classes/ToolRegistry.md) to register\nthe entire category at once: `registry.register(...memoryTools)`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/storeMemoryTool","title":"Variable: storeMemoryTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/storeMemoryTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/storeMemoryTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/memory/variables/storeMemoryTool.md\ndescription: >-\n Create a new {@link @nhtio/adk!Memory} record and persist it via the context's\n `storeMemory` callback.\n---\n\n# Variable: storeMemoryTool\n\n```ts\nconst storeMemoryTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/memory/index.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/memory/index.ts#L76)\n\nCreate a new [@nhtio/adk!Memory](../../../../common/classes/Memory.md) record and persist it via the context's `storeMemory` callback.\n\n## Remarks\n\nWhen `id` is omitted, a UUID v6 is generated. When `createdAt` / `updatedAt` are omitted,\nthe current time is used. The model authors `content`, `confidence`, and `importance`\ndirectly. The resulting record is added to `ctx.turnMemories` and flushed to the consumer's\npersistence layer.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/updateMemoryTool","title":"Variable: updateMemoryTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/updateMemoryTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/memory/variables/updateMemoryTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/memory/variables/updateMemoryTool.md\ndescription: 'Replace an existing {@link @nhtio/adk!Memory} by `id`.'\n---\n\n# Variable: updateMemoryTool\n\n```ts\nconst updateMemoryTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/memory/index.ts:134](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/memory/index.ts#L134)\n\nReplace an existing [@nhtio/adk!Memory](../../../../common/classes/Memory.md) by `id`.\n\n## Remarks\n\nThe model supplies `id` plus any subset of `content` / `confidence` / `importance`; fields\nleft undefined retain their prior values. `updatedAt` is always bumped to the current time;\n`createdAt` is preserved. Returns an error when no memory with the supplied `id` is found.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing","title":"@nhtio/adk/batteries/tools/parsing","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/parsing.md'\ndescription: >-\n Pre-constructed tools for parsing CSV, TSV, JSON, YAML, and other structured\n text formats.\n---\n\n# @nhtio/adk/batteries/tools/parsing\n\nPre-constructed tools for parsing CSV, TSV, JSON, YAML, and other structured text formats.\n\n## Remarks\n\nPre-constructed bundled tools for the `parsing` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------- | ----------------------------------------------------------------- |\n| [detectDelimiterTool](variables/detectDelimiterTool.md) | Detect the most likely field delimiter in a CSV-like text sample. |\n| [parseCsvTool](variables/parseCsvTool.md) | Parse a CSV or TSV string into a JSON array. |\n| [parseKvTool](variables/parseKvTool.md) | Extract key-value pairs from text. |\n| [parseYamlTool](variables/parseYamlTool.md) | Parse a YAML string into JSON. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/detectDelimiterTool","title":"Variable: detectDelimiterTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/detectDelimiterTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/detectDelimiterTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/parsing/variables/detectDelimiterTool.md\ndescription: Detect the most likely field delimiter in a CSV-like text sample.\n---\n\n# Variable: detectDelimiterTool\n\n```ts\nconst detectDelimiterTool: Tool;\n```\n\nDefined in: [src/batteries/tools/parsing/index.ts:218](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/parsing/index.ts#L218)\n\nDetect the most likely field delimiter in a CSV-like text sample.\n\n## Remarks\n\nTries comma, tab, semicolon, pipe, and colon. Scores each by mean field count divided by\nvariance (so consistent row widths beat noisy splits). Looks at up to the first 20 lines of\nthe first 5000 characters.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseCsvTool","title":"Variable: parseCsvTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseCsvTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseCsvTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/parsing/variables/parseCsvTool.md\ndescription: Parse a CSV or TSV string into a JSON array.\n---\n\n# Variable: parseCsvTool\n\n```ts\nconst parseCsvTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/parsing/index.ts:26](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/parsing/index.ts#L26)\n\nParse a CSV or TSV string into a JSON array.\n\n## Remarks\n\nWith `has_header: true` (default), each row becomes an object keyed by column name. Without a\nheader, rows are returned as positional arrays. `delimiter` auto-detects when omitted; pass\n`\"\\t\"` for TSV. Rows are clipped to `limit` (default 1000, max 10000). Parse warnings are\nprepended to the output.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseKvTool","title":"Variable: parseKvTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseKvTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseKvTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/parsing/variables/parseKvTool.md\ndescription: Extract key-value pairs from text.\n---\n\n# Variable: parseKvTool\n\n```ts\nconst parseKvTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/parsing/index.ts:136](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/parsing/index.ts#L136)\n\nExtract key-value pairs from text.\n\n## Remarks\n\nHandles `.env` files, config files, and query strings. `kv_delimiter` chooses the\nkey→value separator (`=`, `:`, or `auto`); `pair_delimiter` selects how pairs are separated\n(`newline`, `comma`, `semicolon`, `ampersand`). Surrounding single or double quotes around\nvalues are stripped. Comment lines starting with `#` are skipped by default.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseYamlTool","title":"Variable: parseYamlTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseYamlTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/parsing/variables/parseYamlTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/parsing/variables/parseYamlTool.md\ndescription: Parse a YAML string into JSON.\n---\n\n# Variable: parseYamlTool\n\n```ts\nconst parseYamlTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/parsing/index.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/parsing/index.ts#L93)\n\nParse a YAML string into JSON.\n\n## Remarks\n\nReturns a pretty-printed JSON representation of the parsed YAML document. Invalid YAML\nreturns an error string.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables","title":"@nhtio/adk/batteries/tools/retrievables","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/retrievables.md'\ndescription: >-\n Pre-constructed CRUD tools for model-visible retrievable and RAG-record\n management.\n---\n\n# @nhtio/adk/batteries/tools/retrievables\n\nPre-constructed CRUD tools for model-visible retrievable and RAG-record management.\n\n## Remarks\n\nPre-constructed CRUD tools that expose the ADK's [@nhtio/adk!Retrievable](../../../common/classes/Retrievable.md) surface to the\nmodel. Each tool delegates to the corresponding callback on the active\n[@nhtio/adk!DispatchContext](../../../types/interfaces/DispatchContext.md) (`fetchRetrievables`, `storeRetrievable`, `mutateRetrievable`,\n`deleteRetrievable`) — the persistence layer is whatever the consumer wired into the\nrunner.\n\nRetrievables are RAG records and carry an explicit `trustTier` that drives the LLM\nbattery's rendering envelope. Exposing these CRUD tools to the model is a deliberate\ndeployer decision; the trust tier the model declares when creating or updating a record\nis honoured verbatim by the persistence layer. The deployer is responsible for choosing\nwhether to register all four tools, only the read-only `list_retrievables`, or any subset\nthereof — that registration choice is exactly the trust boundary documented in the\nRetrievable battery contract.\n\nOutput is JSON for every tool so consumers can parse the result without re-tokenising —\nthe artifact constructor is set to [@nhtio/adk!SpooledJsonArtifact](../../../spooled_artifact/classes/SpooledJsonArtifact.md).\n\nTools:\n\n* [listRetrievablesTool](variables/listRetrievablesTool.md) — read-only list of every retrievable currently held by\n the context.\n* [storeRetrievableTool](variables/storeRetrievableTool.md) — create a new retrievable record (auto-generates `id` /\n `createdAt` / `updatedAt` unless explicit values are supplied).\n* [updateRetrievableTool](variables/updateRetrievableTool.md) — replace an existing retrievable by `id`. Bumps\n `updatedAt`.\n* [deleteRetrievableTool](variables/deleteRetrievableTool.md) — remove a retrievable by `id`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [deleteRetrievableTool](variables/deleteRetrievableTool.md) | Remove an existing [@nhtio/adk!Retrievable](../../../common/classes/Retrievable.md) by `id`. |\n| [listRetrievablesTool](variables/listRetrievablesTool.md) | List every retrievable record currently held by the active execution context. |\n| [retrievableTools](variables/retrievableTools.md) | Convenience tuple of every retrievable CRUD tool. Spread into a [@nhtio/adk!ToolRegistry](../../../forge/classes/ToolRegistry.md) to register the entire category at once. |\n| [storeRetrievableTool](variables/storeRetrievableTool.md) | Create a new [@nhtio/adk!Retrievable](../../../common/classes/Retrievable.md) record and persist it via the context's `storeRetrievable` callback. |\n| [updateRetrievableTool](variables/updateRetrievableTool.md) | Replace an existing [@nhtio/adk!Retrievable](../../../common/classes/Retrievable.md) by `id`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/deleteRetrievableTool","title":"Variable: deleteRetrievableTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/deleteRetrievableTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/deleteRetrievableTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/retrievables/variables/deleteRetrievableTool.md\ndescription: 'Remove an existing {@link @nhtio/adk!Retrievable} by `id`.'\n---\n\n# Variable: deleteRetrievableTool\n\n```ts\nconst deleteRetrievableTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/retrievables/index.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/retrievables/index.ts#L247)\n\nRemove an existing [@nhtio/adk!Retrievable](../../../../common/classes/Retrievable.md) by `id`.\n\n## Remarks\n\nDelegates to `ctx.deleteRetrievable(id)`. Returns `{ ok: true, id }` on success regardless\nof whether a retrievable was actually present — `deleteRetrievable` is idempotent at the\nADK level.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/listRetrievablesTool","title":"Variable: listRetrievablesTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/listRetrievablesTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/listRetrievablesTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/retrievables/variables/listRetrievablesTool.md\ndescription: List every retrievable record currently held by the active execution context.\n---\n\n# Variable: listRetrievablesTool\n\n```ts\nconst listRetrievablesTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/retrievables/index.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/retrievables/index.ts#L61)\n\nList every retrievable record currently held by the active execution context.\n\n## Remarks\n\nDelegates to `ctx.fetchRetrievables()`. Returns a JSON-encoded array of retrievable records\n(id, content, trustTier, source, kind, score, createdAt, updatedAt).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/retrievableTools","title":"Variable: retrievableTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/retrievableTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/retrievableTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/retrievables/variables/retrievableTools.md\ndescription: >-\n Convenience tuple of every retrievable CRUD tool. Spread into a {@link\n @nhtio/adk!ToolRegistry} to register the entire category at once.\n---\n\n# Variable: retrievableTools\n\n```ts\nconst retrievableTools: readonly [\n Tool>,\n Tool>,\n Tool>,\n Tool>,\n];\n```\n\nDefined in: [src/batteries/tools/retrievables/index.ts:269](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/retrievables/index.ts#L269)\n\nConvenience tuple of every retrievable CRUD tool. Spread into a [@nhtio/adk!ToolRegistry](../../../../forge/classes/ToolRegistry.md) to\nregister the entire category at once.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/storeRetrievableTool","title":"Variable: storeRetrievableTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/storeRetrievableTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/storeRetrievableTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/retrievables/variables/storeRetrievableTool.md\ndescription: >-\n Create a new {@link @nhtio/adk!Retrievable} record and persist it via the\n context's `storeRetrievable` callback.\n---\n\n# Variable: storeRetrievableTool\n\n```ts\nconst storeRetrievableTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/retrievables/index.ts:88](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/retrievables/index.ts#L88)\n\nCreate a new [@nhtio/adk!Retrievable](../../../../common/classes/Retrievable.md) record and persist it via the context's `storeRetrievable`\ncallback.\n\n## Remarks\n\nWhen `id` is omitted, a UUID v6 is generated. When `createdAt` / `updatedAt` are omitted,\nthe current time is used. The model must declare `trustTier` explicitly — there is no\ndefault; the choice is consciously the model's, exposed by the deployer's decision to\nregister this tool.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/updateRetrievableTool","title":"Variable: updateRetrievableTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/updateRetrievableTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/retrievables/variables/updateRetrievableTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/retrievables/variables/updateRetrievableTool.md\ndescription: 'Replace an existing {@link @nhtio/adk!Retrievable} by `id`.'\n---\n\n# Variable: updateRetrievableTool\n\n```ts\nconst updateRetrievableTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/retrievables/index.ts:173](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/retrievables/index.ts#L173)\n\nReplace an existing [@nhtio/adk!Retrievable](../../../../common/classes/Retrievable.md) by `id`.\n\n## Remarks\n\nThe model supplies `id` plus any subset of `content` / `trustTier` / `source` / `kind` /\n`score`; omitted fields retain their prior values. `updatedAt` is always bumped;\n`createdAt` is preserved. Returns an error when no retrievable with the supplied `id` is\nfound.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper","title":"@nhtio/adk/batteries/tools/scrapper","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper.md'\ndescription: Factories for configured Scrapper web-extraction tools (article + links).\n---\n\n# @nhtio/adk/batteries/tools/scrapper\n\nFactories for configured Scrapper web-extraction tools (article + links).\n\n## Remarks\n\n[Scrapper](https://github.com/amerkurev/scrapper) is a self-hosted service that loads a page in a\nreal headless browser and extracts either the readable article (`/api/article`) or the page's\nlinks (`/api/links`). It gives an agent browser-grade reading power — JS-rendered pages a\nrenderless fetcher can't see — but as a **stateless** HTTP call: each request runs in a fresh\nincognito context, stores no session or credentials, and shares nothing with any other call.\n\nLike the SearXNG battery, this exports **factories** (not ready-made `Tool` constants), because a\nscrape tool needs per-deployment config (instance URL + custom auth headers). Two verbs, each with\nan async factory ([createScrapperArticleTool](functions/createScrapperArticleTool.md) / [createScrapperLinksTool](functions/createScrapperLinksTool.md), accepting a\ndynamic-import `artifact` resolver) and a sync variant ([createScrapperArticleToolSync](functions/createScrapperArticleToolSync.md) /\n[createScrapperLinksToolSync](functions/createScrapperLinksToolSync.md)). Because these are factories, they MUST NOT be bulk-registered\nvia `Object.values(batteries)` — call one, then register the returned tool.\n\n## See\n\nhttps://github.com/amerkurev/scrapper\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------ | ----------------------------------------------------------------------------------- |\n| [ScrapperArticle](interfaces/ScrapperArticle.md) | A normalised Scrapper article (loose/nullable upstream). |\n| [ScrapperArticleParams](interfaces/ScrapperArticleParams.md) | Model-facing params for `/api/article`. |\n| [ScrapperCommonParams](interfaces/ScrapperCommonParams.md) | Model-facing params common to both verbs (snake\\_case; mapped to kebab on the wire). |\n| [ScrapperLink](interfaces/ScrapperLink.md) | A single link from `/api/links` (verified live: `{ url, text }`). |\n| [ScrapperLinks](interfaces/ScrapperLinks.md) | A normalised Scrapper links payload. |\n| [ScrapperLinksParams](interfaces/ScrapperLinksParams.md) | Model-facing params for `/api/links`. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| [ScrapperArticleConfig](type-aliases/ScrapperArticleConfig.md) | Async-factory config for `/api/article` (full `artifact` resolver, incl. dynamic import). |\n| [ScrapperArticleConfigSync](type-aliases/ScrapperArticleConfigSync.md) | Sync-factory config for `/api/article` (`artifact` narrowed to the sync subset). |\n| [ScrapperLinksConfig](type-aliases/ScrapperLinksConfig.md) | Async-factory config for `/api/links`. |\n| [ScrapperLinksConfigSync](type-aliases/ScrapperLinksConfigSync.md) | Sync-factory config for `/api/links`. |\n\n## Functions\n\n| Function | Description |\n| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| [createScrapperArticleTool](functions/createScrapperArticleTool.md) | Create a configured Scrapper **article** [Tool](../../../forge/classes/Tool.md) (async — accepts a dynamic-import `artifact`). |\n| [createScrapperArticleToolSync](functions/createScrapperArticleToolSync.md) | Synchronous [createScrapperArticleTool](functions/createScrapperArticleTool.md) — `artifact` narrowed to the sync subset. |\n| [createScrapperLinksTool](functions/createScrapperLinksTool.md) | Create a configured Scrapper **links** [Tool](../../../forge/classes/Tool.md) (async — accepts a dynamic-import `artifact`). |\n| [createScrapperLinksToolSync](functions/createScrapperLinksToolSync.md) | Synchronous [createScrapperLinksTool](functions/createScrapperLinksTool.md) — `artifact` narrowed to the sync subset. |\n\n## References\n\n### E\\_INVALID\\_SCRAPPER\\_CONFIG\n\nRe-exports [E\\_INVALID\\_SCRAPPER\\_CONFIG](../../variables/E_INVALID_SCRAPPER_CONFIG.md)\n\n***\n\n### ScrapperBaseConfig\n\nRe-exports [ScrapperBaseConfig](../../interfaces/ScrapperBaseConfig.md)\n\n***\n\n### ScrapperInputMiddlewareFn\n\nRe-exports [ScrapperInputMiddlewareFn](../../type-aliases/ScrapperInputMiddlewareFn.md)\n\n***\n\n### ScrapperOutputMiddlewareFn\n\nRe-exports [ScrapperOutputMiddlewareFn](../../type-aliases/ScrapperOutputMiddlewareFn.md)\n\n***\n\n### ScrapperRequestContext\n\nRe-exports [ScrapperRequestContext](../../interfaces/ScrapperRequestContext.md)\n\n***\n\n### ScrapperResponseContext\n\nRe-exports [ScrapperResponseContext](../../interfaces/ScrapperResponseContext.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleTool","title":"Function: createScrapperArticleTool()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleTool.md\n---\n\n# Function: createScrapperArticleTool()\n\n```ts\nfunction createScrapperArticleTool(\n config: ScrapperArticleConfig,\n): Promise>;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:371](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L371)\n\nCreate a configured Scrapper **article** [Tool](../../../../forge/classes/Tool.md) (async — accepts a dynamic-import `artifact`).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `config` | [`ScrapperArticleConfig`](../type-aliases/ScrapperArticleConfig.md) | Instance URL, instance-auth headers, output policy, `artifact` resolver, per-parameter disposition (`fixed`/`defaults`/`fixedQuery`), and middleware pipelines. |\n\n## Returns\n\n`Promise`<[`Tool`](../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)>>\n\nA promise of a `Tool` ready to register in a `ToolRegistry`.\n\n## Remarks\n\nAsync because `artifact` may be an async / dynamic-import resolver, which must resolve to the sync\n`() => Ctor` `Tool.artifactConstructor` requires before the tool is built. For the common case,\nuse [createScrapperArticleToolSync](createScrapperArticleToolSync.md) and skip the `await`.\n\n##\n\n::: warning\nTwo distinct \"headers\": `config.headers` authenticates to the Scrapper *instance*; the\n`extra_http_headers` *parameter* is what the scraper's browser sends to the *target site* — do not\nconflate them. Also note `scroll_down` requires a positive `sleep`, and `resultUri`/`screenshotUri`\nare instance-relative and may come back `http://` even over HTTPS — do not assume they match\n`instanceUrl`.\n:::\n\n## Throws\n\n[E\\_INVALID\\_SCRAPPER\\_CONFIG](../../../variables/E_INVALID_SCRAPPER_CONFIG.md) when `instanceUrl` or `artifact` is invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleToolSync","title":"Function: createScrapperArticleToolSync()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleToolSync.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleToolSync","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperArticleToolSync.md\n---\n\n# Function: createScrapperArticleToolSync()\n\n```ts\nfunction createScrapperArticleToolSync(config: ScrapperArticleConfigSync): Tool;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:384](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L384)\n\nSynchronous [createScrapperArticleTool](createScrapperArticleTool.md) — `artifact` narrowed to the sync subset.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| `config` | [`ScrapperArticleConfigSync`](../type-aliases/ScrapperArticleConfigSync.md) | Same as [createScrapperArticleTool](createScrapperArticleTool.md), with a sync-only `artifact`. |\n\n## Returns\n\n[`Tool`](../../../../forge/classes/Tool.md)\n\nA `Tool` ready to register in a `ToolRegistry`.\n\n## Throws\n\n[E\\_INVALID\\_SCRAPPER\\_CONFIG](../../../variables/E_INVALID_SCRAPPER_CONFIG.md) when `instanceUrl` or `artifact` is invalid (incl. an async resolver).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksTool","title":"Function: createScrapperLinksTool()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksTool.md\n---\n\n# Function: createScrapperLinksTool()\n\n```ts\nfunction createScrapperLinksTool(\n config: ScrapperLinksConfig,\n): Promise>;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:402](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L402)\n\nCreate a configured Scrapper **links** [Tool](../../../../forge/classes/Tool.md) (async — accepts a dynamic-import `artifact`).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `config` | [`ScrapperLinksConfig`](../type-aliases/ScrapperLinksConfig.md) | Instance URL, instance-auth headers, output policy, `artifact` resolver, per-parameter disposition, and middleware pipelines. |\n\n## Returns\n\n`Promise`<[`Tool`](../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)>>\n\nA promise of a `Tool` ready to register in a `ToolRegistry`.\n\n## Remarks\n\nSee [createScrapperArticleTool](createScrapperArticleTool.md) for the two-headers caveat and the async rationale. Each\n`links` item is `{ url, text }`.\n\n## Throws\n\n[E\\_INVALID\\_SCRAPPER\\_CONFIG](../../../variables/E_INVALID_SCRAPPER_CONFIG.md) when `instanceUrl` or `artifact` is invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksToolSync","title":"Function: createScrapperLinksToolSync()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksToolSync.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksToolSync","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/functions/createScrapperLinksToolSync.md\n---\n\n# Function: createScrapperLinksToolSync()\n\n```ts\nfunction createScrapperLinksToolSync(config: ScrapperLinksConfigSync): Tool;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:415](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L415)\n\nSynchronous [createScrapperLinksTool](createScrapperLinksTool.md) — `artifact` narrowed to the sync subset.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| `config` | [`ScrapperLinksConfigSync`](../type-aliases/ScrapperLinksConfigSync.md) | Same as [createScrapperLinksTool](createScrapperLinksTool.md), with a sync-only `artifact`. |\n\n## Returns\n\n[`Tool`](../../../../forge/classes/Tool.md)\n\nA `Tool` ready to register in a `ToolRegistry`.\n\n## Throws\n\n[E\\_INVALID\\_SCRAPPER\\_CONFIG](../../../variables/E_INVALID_SCRAPPER_CONFIG.md) when `instanceUrl` or `artifact` is invalid (incl. an async resolver).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticle","title":"Interface: ScrapperArticle","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticle.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticle","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticle.md\ndescription: A normalised Scrapper article (loose/nullable upstream).\n---\n\n# Interface: ScrapperArticle\n\nDefined in: [src/batteries/tools/scrapper/index.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L203)\n\nA normalised Scrapper article (loose/nullable upstream).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | -------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `byline?` | `string` | Author / byline metadata. | [src/batteries/tools/scrapper/index.ts:209](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L209) |\n| `content?` | `string` | Processed article HTML; present when the caller requested it. | [src/batteries/tools/scrapper/index.ts:225](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L225) |\n| `date?` | `string` | Scrapper's own date field for the result. | [src/batteries/tools/scrapper/index.ts:221](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L221) |\n| `excerpt?` | `string` | Short excerpt or description of the article. | [src/batteries/tools/scrapper/index.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L211) |\n| `fullContent?` | `string` | Full page HTML; present only when `full_content` was set. | [src/batteries/tools/scrapper/index.ts:227](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L227) |\n| `lang?` | `string` | Detected content language. | [src/batteries/tools/scrapper/index.ts:215](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L215) |\n| `length?` | `number` | Character count of the extracted article text. | [src/batteries/tools/scrapper/index.ts:217](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L217) |\n| `publishedTime?` | `string` | Publication time, when the page exposed one. | [src/batteries/tools/scrapper/index.ts:219](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L219) |\n| `screenshotUri?` | `string` | Screenshot URI; present only when `screenshot` was set. | [src/batteries/tools/scrapper/index.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L229) |\n| `siteName?` | `string` | Name of the site the article came from. | [src/batteries/tools/scrapper/index.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L213) |\n| `textContent?` | `string` | Article text with HTML stripped. | [src/batteries/tools/scrapper/index.ts:223](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L223) |\n| `title?` | `string` | Article title. | [src/batteries/tools/scrapper/index.ts:207](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L207) |\n| `url?` | `string` | The page URL the article was extracted from. | [src/batteries/tools/scrapper/index.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L205) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticleParams","title":"Interface: ScrapperArticleParams","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticleParams.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticleParams","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticleParams.md\ndescription: Model-facing params for `/api/article`.\n---\n\n# Interface: ScrapperArticleParams\n\nDefined in: [src/batteries/tools/scrapper/index.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L74)\n\nModel-facing params for `/api/article`.\n\n## Extends\n\n* [`ScrapperCommonParams`](ScrapperCommonParams.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `cache?` | `boolean` | Return a cached result when available instead of re-scraping. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`cache`](ScrapperCommonParams.md#property-cache) | [src/batteries/tools/scrapper/index.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L50) |\n| `device?` | `string` | Emulated device, e.g. `Desktop Chrome`. Overrides individual viewport/UA settings. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`device`](ScrapperCommonParams.md#property-device) | [src/batteries/tools/scrapper/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L64) |\n| `extra_http_headers?` | `string` | Extra headers the SCRAPER's browser sends to the TARGET site, `K:v;K2:v2` (NOT instance auth). | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`extra_http_headers`](ScrapperCommonParams.md#property-extra_http_headers) | [src/batteries/tools/scrapper/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L68) |\n| `full_content?` | `boolean` | Populate `fullContent` with the page's full HTML. | - | [src/batteries/tools/scrapper/index.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L76) |\n| `incognito?` | `boolean` | Run in an incognito browser context (no persisted browsing data). Default true upstream. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`incognito`](ScrapperCommonParams.md#property-incognito) | [src/batteries/tools/scrapper/index.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L54) |\n| `proxy_server?` | `string` | Upstream proxy, e.g. `http://host:3128` or `socks5://host:1080`. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`proxy_server`](ScrapperCommonParams.md#property-proxy_server) | [src/batteries/tools/scrapper/index.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L70) |\n| `screenshot?` | `boolean` | Capture a screenshot; the result carries a `screenshotUri`. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`screenshot`](ScrapperCommonParams.md#property-screenshot) | [src/batteries/tools/scrapper/index.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L52) |\n| `scroll_down?` | `number` | Scroll down N pixels for lazy-loading pages. Requires a positive `sleep`. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`scroll_down`](ScrapperCommonParams.md#property-scroll_down) | [src/batteries/tools/scrapper/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L62) |\n| `sleep?` | `number` | Wait this many ms after load before parsing. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`sleep`](ScrapperCommonParams.md#property-sleep) | [src/batteries/tools/scrapper/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L60) |\n| `timeout?` | `number` | Browser navigation timeout in ms (`0` disables). Distinct from the tool's own fetch timeout. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`timeout`](ScrapperCommonParams.md#property-timeout) | [src/batteries/tools/scrapper/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L56) |\n| `user_agent?` | `string` | Explicit user-agent (prefer `device`). | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`user_agent`](ScrapperCommonParams.md#property-user_agent) | [src/batteries/tools/scrapper/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L66) |\n| `wait_until?` | `\"load\"` | `\"domcontentloaded\"` | `\"networkidle\"` | `\"commit\"` | When navigation is considered finished. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`wait_until`](ScrapperCommonParams.md#property-wait_until) | [src/batteries/tools/scrapper/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L58) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperCommonParams","title":"Interface: ScrapperCommonParams","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperCommonParams.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperCommonParams","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperCommonParams.md\ndescription: >-\n Model-facing params common to both verbs (snake_case; mapped to kebab on the\n wire).\n---\n\n# Interface: ScrapperCommonParams\n\nDefined in: [src/batteries/tools/scrapper/index.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L48)\n\nModel-facing params common to both verbs (snake\\_case; mapped to kebab on the wire).\n\n## Extended by\n\n* [`ScrapperArticleParams`](ScrapperArticleParams.md)\n* [`ScrapperLinksParams`](ScrapperLinksParams.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `cache?` | `boolean` | Return a cached result when available instead of re-scraping. | [src/batteries/tools/scrapper/index.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L50) |\n| `device?` | `string` | Emulated device, e.g. `Desktop Chrome`. Overrides individual viewport/UA settings. | [src/batteries/tools/scrapper/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L64) |\n| `extra_http_headers?` | `string` | Extra headers the SCRAPER's browser sends to the TARGET site, `K:v;K2:v2` (NOT instance auth). | [src/batteries/tools/scrapper/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L68) |\n| `incognito?` | `boolean` | Run in an incognito browser context (no persisted browsing data). Default true upstream. | [src/batteries/tools/scrapper/index.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L54) |\n| `proxy_server?` | `string` | Upstream proxy, e.g. `http://host:3128` or `socks5://host:1080`. | [src/batteries/tools/scrapper/index.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L70) |\n| `screenshot?` | `boolean` | Capture a screenshot; the result carries a `screenshotUri`. | [src/batteries/tools/scrapper/index.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L52) |\n| `scroll_down?` | `number` | Scroll down N pixels for lazy-loading pages. Requires a positive `sleep`. | [src/batteries/tools/scrapper/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L62) |\n| `sleep?` | `number` | Wait this many ms after load before parsing. | [src/batteries/tools/scrapper/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L60) |\n| `timeout?` | `number` | Browser navigation timeout in ms (`0` disables). Distinct from the tool's own fetch timeout. | [src/batteries/tools/scrapper/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L56) |\n| `user_agent?` | `string` | Explicit user-agent (prefer `device`). | [src/batteries/tools/scrapper/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L66) |\n| `wait_until?` | `\"load\"` | `\"domcontentloaded\"` | `\"networkidle\"` | `\"commit\"` | When navigation is considered finished. | [src/batteries/tools/scrapper/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L58) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLink","title":"Interface: ScrapperLink","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLink.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLink","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLink.md\ndescription: 'A single link from `/api/links` (verified live: `{ url, text }`).'\n---\n\n# Interface: ScrapperLink\n\nDefined in: [src/batteries/tools/scrapper/index.ts:233](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L233)\n\nA single link from `/api/links` (verified live: `{ url, text }`).\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------- | -------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `text?` | `string` | The link's anchor text. | [src/batteries/tools/scrapper/index.ts:237](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L237) |\n| `url?` | `string` | The link's target URL. | [src/batteries/tools/scrapper/index.ts:235](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L235) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinks","title":"Interface: ScrapperLinks","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinks.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinks","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinks.md\ndescription: A normalised Scrapper links payload.\n---\n\n# Interface: ScrapperLinks\n\nDefined in: [src/batteries/tools/scrapper/index.ts:241](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L241)\n\nA normalised Scrapper links payload.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | ----------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `date?` | `string` | Scrapper's own date field for the result. | [src/batteries/tools/scrapper/index.ts:249](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L249) |\n| `domain?` | `string` | The page's domain. | [src/batteries/tools/scrapper/index.ts:247](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L247) |\n| `links` | [`ScrapperLink`](ScrapperLink.md)\\[] | The collected links, each `{ url, text }`. | [src/batteries/tools/scrapper/index.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L251) |\n| `screenshotUri?` | `string` | Screenshot URI; present only when `screenshot` was set. | [src/batteries/tools/scrapper/index.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L253) |\n| `title?` | `string` | The page title. | [src/batteries/tools/scrapper/index.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L245) |\n| `url?` | `string` | The page URL the links were collected from. | [src/batteries/tools/scrapper/index.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L243) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinksParams","title":"Interface: ScrapperLinksParams","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinksParams.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinksParams","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperLinksParams.md\ndescription: Model-facing params for `/api/links`.\n---\n\n# Interface: ScrapperLinksParams\n\nDefined in: [src/batteries/tools/scrapper/index.ts:80](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L80)\n\nModel-facing params for `/api/links`.\n\n## Extends\n\n* [`ScrapperCommonParams`](ScrapperCommonParams.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| -------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `cache?` | `boolean` | Return a cached result when available instead of re-scraping. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`cache`](ScrapperCommonParams.md#property-cache) | [src/batteries/tools/scrapper/index.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L50) |\n| `device?` | `string` | Emulated device, e.g. `Desktop Chrome`. Overrides individual viewport/UA settings. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`device`](ScrapperCommonParams.md#property-device) | [src/batteries/tools/scrapper/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L64) |\n| `extra_http_headers?` | `string` | Extra headers the SCRAPER's browser sends to the TARGET site, `K:v;K2:v2` (NOT instance auth). | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`extra_http_headers`](ScrapperCommonParams.md#property-extra_http_headers) | [src/batteries/tools/scrapper/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L68) |\n| `incognito?` | `boolean` | Run in an incognito browser context (no persisted browsing data). Default true upstream. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`incognito`](ScrapperCommonParams.md#property-incognito) | [src/batteries/tools/scrapper/index.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L54) |\n| `proxy_server?` | `string` | Upstream proxy, e.g. `http://host:3128` or `socks5://host:1080`. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`proxy_server`](ScrapperCommonParams.md#property-proxy_server) | [src/batteries/tools/scrapper/index.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L70) |\n| `screenshot?` | `boolean` | Capture a screenshot; the result carries a `screenshotUri`. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`screenshot`](ScrapperCommonParams.md#property-screenshot) | [src/batteries/tools/scrapper/index.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L52) |\n| `scroll_down?` | `number` | Scroll down N pixels for lazy-loading pages. Requires a positive `sleep`. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`scroll_down`](ScrapperCommonParams.md#property-scroll_down) | [src/batteries/tools/scrapper/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L62) |\n| `sleep?` | `number` | Wait this many ms after load before parsing. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`sleep`](ScrapperCommonParams.md#property-sleep) | [src/batteries/tools/scrapper/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L60) |\n| `text_len_threshold?` | `number` | Median link-text length threshold for the link parser. | - | [src/batteries/tools/scrapper/index.ts:82](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L82) |\n| `timeout?` | `number` | Browser navigation timeout in ms (`0` disables). Distinct from the tool's own fetch timeout. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`timeout`](ScrapperCommonParams.md#property-timeout) | [src/batteries/tools/scrapper/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L56) |\n| `user_agent?` | `string` | Explicit user-agent (prefer `device`). | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`user_agent`](ScrapperCommonParams.md#property-user_agent) | [src/batteries/tools/scrapper/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L66) |\n| `wait_until?` | `\"load\"` | `\"domcontentloaded\"` | `\"networkidle\"` | `\"commit\"` | When navigation is considered finished. | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`wait_until`](ScrapperCommonParams.md#property-wait_until) | [src/batteries/tools/scrapper/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L58) |\n| `words_threshold?` | `number` | Median words-per-link threshold for the link parser. | - | [src/batteries/tools/scrapper/index.ts:84](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L84) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfig","title":"Type Alias: ScrapperArticleConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfig.md\ndescription: >-\n Async-factory config for `/api/article` (full `artifact` resolver, incl.\n dynamic import).\n---\n\n# Type Alias: ScrapperArticleConfig\n\n```ts\ntype ScrapperArticleConfig = ScrapperBaseConfig<\n ScrapperArticleParams,\n ScrapperArticle,\n ArtifactResolver\n>;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:323](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L323)\n\nAsync-factory config for `/api/article` (full `artifact` resolver, incl. dynamic import).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfigSync","title":"Type Alias: ScrapperArticleConfigSync","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfigSync.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfigSync","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperArticleConfigSync.md\ndescription: >-\n Sync-factory config for `/api/article` (`artifact` narrowed to the sync\n subset).\n---\n\n# Type Alias: ScrapperArticleConfigSync\n\n```ts\ntype ScrapperArticleConfigSync = ScrapperBaseConfig<\n ScrapperArticleParams,\n ScrapperArticle,\n SyncArtifactResolver\n>;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:329](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L329)\n\nSync-factory config for `/api/article` (`artifact` narrowed to the sync subset).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfig","title":"Type Alias: ScrapperLinksConfig","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfig.md\ndescription: Async-factory config for `/api/links`.\n---\n\n# Type Alias: ScrapperLinksConfig\n\n```ts\ntype ScrapperLinksConfig = ScrapperBaseConfig<\n ScrapperLinksParams,\n ScrapperLinks,\n ArtifactResolver\n>;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:335](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L335)\n\nAsync-factory config for `/api/links`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfigSync","title":"Type Alias: ScrapperLinksConfigSync","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfigSync.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfigSync","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/type-aliases/ScrapperLinksConfigSync.md\ndescription: Sync-factory config for `/api/links`.\n---\n\n# Type Alias: ScrapperLinksConfigSync\n\n```ts\ntype ScrapperLinksConfigSync = ScrapperBaseConfig<\n ScrapperLinksParams,\n ScrapperLinks,\n SyncArtifactResolver\n>;\n```\n\nDefined in: [src/batteries/tools/scrapper/index.ts:341](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/scrapper/index.ts#L341)\n\nSync-factory config for `/api/links`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng","title":"@nhtio/adk/batteries/tools/searxng","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng.md'\ndescription: Factory for a configured SearXNG metasearch tool.\n---\n\n# @nhtio/adk/batteries/tools/searxng\n\nFactory for a configured SearXNG metasearch tool.\n\n## Remarks\n\nUnlike the other bundled tool categories — every one of which exports a ready-made,\nstateless `Tool` constant — the SearXNG battery exports **factories**,\n[createSearxngSearchTool](functions/createSearxngSearchTool.md) (async) and [createSearxngSearchToolSync](functions/createSearxngSearchToolSync.md). A search tool\nhas to talk to a *specific* SearXNG instance, usually behind custom authentication, so it needs\nper-deployment configuration (a base URL and headers) that cannot be baked in at module load.\n\nBecause this module exports factories rather than `Tool` instances, they MUST NOT be\nbulk-registered via `Object.values(batteries)`. Call a factory first, then register the\nreturned tool: `new ToolRegistry([await createSearxngSearchTool({ instanceUrl })])`.\n\n## See\n\nhttps://docs.searxng.org/dev/search\\_api.html\n\n## Interfaces\n\n| Interface | Description |\n| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SearxngRequestContext](interfaces/SearxngRequestContext.md) | Mutable context handed to each input-pipeline stage **before** the HTTP request is sent. |\n| [SearxngResponseContext](interfaces/SearxngResponseContext.md) | Mutable context handed to each output-pipeline stage **after** the response JSON is parsed. |\n| [SearxngResult](interfaces/SearxngResult.md) | A single normalised SearXNG result. SearXNG result items are deliberately untyped upstream, so every field except a best-effort `title`/`url` is optional. |\n| [SearxngToolConfig](interfaces/SearxngToolConfig.md) | Configuration for [createSearxngSearchTool](functions/createSearxngSearchTool.md) (async) and [createSearxngSearchToolSync](functions/createSearxngSearchToolSync.md) (sync — `artifact` narrowed to the sync subset). |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SearxngHeaders](type-aliases/SearxngHeaders.md) | A static set of request headers (used for custom authentication). |\n| [SearxngHeadersResolver](type-aliases/SearxngHeadersResolver.md) | A resolver returning request headers, sync or async. Use this form when the auth token is refreshable — the resolver runs on every search, so a fresh token can be minted per call. |\n| [SearxngInputMiddlewareFn](type-aliases/SearxngInputMiddlewareFn.md) | An input-pipeline stage. Onion middleware over [SearxngRequestContext](interfaces/SearxngRequestContext.md). |\n| [SearxngOutputMiddlewareFn](type-aliases/SearxngOutputMiddlewareFn.md) | An output-pipeline stage. Onion middleware over [SearxngResponseContext](interfaces/SearxngResponseContext.md). |\n| [SearxngResultFormat](type-aliases/SearxngResultFormat.md) | The output shape the tool serialises. `either` lets the model pick per call. |\n\n## Functions\n\n| Function | Description |\n| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| [createSearxngSearchTool](functions/createSearxngSearchTool.md) | Create a configured SearXNG search [Tool](../../../forge/classes/Tool.md) (async — accepts a dynamic-import `artifact`). |\n| [createSearxngSearchToolSync](functions/createSearxngSearchToolSync.md) | Synchronous [createSearxngSearchTool](functions/createSearxngSearchTool.md) — the ergonomic common path. |\n\n## References\n\n### E\\_INVALID\\_SEARXNG\\_CONFIG\n\nRe-exports [E\\_INVALID\\_SEARXNG\\_CONFIG](../../variables/E_INVALID_SEARXNG_CONFIG.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchTool","title":"Function: createSearxngSearchTool()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchTool.md\n---\n\n# Function: createSearxngSearchTool()\n\n```ts\nfunction createSearxngSearchTool(\n config: SearxngToolConfig,\n): Promise>;\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:424](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L424)\n\nCreate a configured SearXNG search [Tool](../../../../forge/classes/Tool.md) (async — accepts a dynamic-import `artifact`).\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `config` | [`SearxngToolConfig`](../interfaces/SearxngToolConfig.md)<[`ArtifactResolver`](../../_shared/type-aliases/ArtifactResolver.md)> | The instance URL, optional custom headers, output-format policy, `artifact` resolver, and input/output middleware pipelines. See [SearxngToolConfig](../interfaces/SearxngToolConfig.md). |\n\n## Returns\n\n`Promise`<[`Tool`](../../../../forge/classes/Tool.md)<[`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)>>\n\nA promise of a `Tool` ready to register in a `ToolRegistry`.\n\n## Remarks\n\nAsync because `artifact` may be an async / dynamic-import resolver, which must be resolved to the\nsync `() => Ctor` that `Tool.artifactConstructor` requires before the tool is built (the\nwrap-site invokes it synchronously). For the common case where you reference the artifact class\ndirectly, use [createSearxngSearchToolSync](createSearxngSearchToolSync.md) and skip the `await`.\n\nThe handler always requests `format=json`. Note that SearXNG ships with JSON output\n**disabled** by default (it is abused by bots); an instance that has not enabled\n`search.formats: [json]` in its `settings.yml` answers with HTTP 403, which the tool returns\nas a graceful `Error:` string naming the setting.\n\n##\n\n::: warning\nDo not trust the `number_of_results` field for a result count — SearXNG frequently reports `0`\nin JSON output even when `results` is non-empty. This is a long-standing upstream quirk, not a\ntool defect (see [searxng#2987](https://github.com/searxng/searxng/issues/2987) and\n[searxng#2457](https://github.com/searxng/searxng/issues/2457)). The tool passes the\nfield through verbatim; use `results.length` as the authoritative count.\n:::\n\n## Throws\n\n[E\\_INVALID\\_SEARXNG\\_CONFIG](../../../variables/E_INVALID_SEARXNG_CONFIG.md) when `instanceUrl` or `artifact` is invalid.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchToolSync","title":"Function: createSearxngSearchToolSync()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchToolSync.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchToolSync","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchToolSync.md\n---\n\n# Function: createSearxngSearchToolSync()\n\n```ts\nfunction createSearxngSearchToolSync(\n config: SearxngToolConfig,\n): Tool;\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:448](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L448)\n\nSynchronous [createSearxngSearchTool](createSearxngSearchTool.md) — the ergonomic common path.\n\n## Parameters\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| `config` | [`SearxngToolConfig`](../interfaces/SearxngToolConfig.md)<[`SyncArtifactResolver`](../../_shared/type-aliases/SyncArtifactResolver.md)> | Same as [SearxngToolConfig](../interfaces/SearxngToolConfig.md), with `artifact` restricted to the sync subset. |\n\n## Returns\n\n[`Tool`](../../../../forge/classes/Tool.md)\n\nA `Tool` ready to register in a `ToolRegistry`.\n\n## Remarks\n\n`artifact` is narrowed to the sync subset (a constructor or a sync resolver). Passing an async\nresolver is a compile-time type error and a runtime [E\\_INVALID\\_SEARXNG\\_CONFIG](../../../variables/E_INVALID_SEARXNG_CONFIG.md); for\ndynamic-import resolvers use the async [createSearxngSearchTool](createSearxngSearchTool.md). See its docs for the\n`number_of_results` caveat and 403/JSON-disabled behaviour.\n\n## Throws\n\n[E\\_INVALID\\_SEARXNG\\_CONFIG](../../../variables/E_INVALID_SEARXNG_CONFIG.md) when `instanceUrl` or `artifact` is invalid (incl. an async resolver).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngRequestContext","title":"Interface: SearxngRequestContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngRequestContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngRequestContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngRequestContext.md\ndescription: >-\n Mutable context handed to each input-pipeline stage **before** the HTTP\n request is sent.\n---\n\n# Interface: SearxngRequestContext\n\nDefined in: [src/batteries/tools/searxng/index.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L85)\n\nMutable context handed to each input-pipeline stage **before** the HTTP request is sent.\n\n## Remarks\n\nStages mutate this in place (onion `(ctx, next)` style) to adjust the outgoing request —\ninject or rotate auth headers, force a language, rewrite the query — or call\n[SearxngRequestContext.shortCircuit](#shortcircuit) to skip the fetch entirely (e.g. a cache hit).\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `headers` | `public` | [`SearxngHeaders`](../type-aliases/SearxngHeaders.md) | Resolved request headers. Mutable — inject, redact, or rotate auth here. | [src/batteries/tools/searxng/index.ts:93](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L93) |\n| `instanceUrl` | `readonly` | `string` | The target instance base URL (read-only). | [src/batteries/tools/searxng/index.ts:95](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L95) |\n| `params` | `public` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Extra SearXNG query parameters (`categories`, `engines`, `language`, …). Mutable. | [src/batteries/tools/searxng/index.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L91) |\n| `query` | `public` | `string` | The search query. Mutable. | [src/batteries/tools/searxng/index.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L89) |\n| `stash` | `readonly` | `Map`<`string`, `unknown`> | Cross-stage scratch space; also carried onto the response context. | [src/batteries/tools/searxng/index.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L97) |\n| `toolName` | `readonly` | `string` | The tool's name (read-only). | [src/batteries/tools/searxng/index.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L87) |\n\n## Methods\n\n### shortCircuit()\n\n```ts\nshortCircuit(result: string): void;\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L99)\n\nSkip the fetch and return `result` verbatim as the tool's output.\n\n#### Parameters\n\n| Parameter | Type |\n| --------- | -------- |\n| `result` | `string` |\n\n#### Returns\n\n`void`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResponseContext","title":"Interface: SearxngResponseContext","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResponseContext.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResponseContext","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResponseContext.md\ndescription: >-\n Mutable context handed to each output-pipeline stage **after** the response\n JSON is parsed.\n---\n\n# Interface: SearxngResponseContext\n\nDefined in: [src/batteries/tools/searxng/index.ts:110](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L110)\n\nMutable context handed to each output-pipeline stage **after** the response JSON is parsed.\n\n## Remarks\n\nStages reshape, redact, enrich, or re-rank [SearxngResponseContext.results](#property-results), mutate the\nraw body, or set [SearxngResponseContext.output](#property-output) to override the serialised string\nverbatim (e.g. to render markdown that matches a markdown `artifact` resolver).\n\n## Properties\n\n| Property | Modifier | Type | Description | Defined in |\n| ----------------------------------------- | ---------- | --------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `format` | `public` | `\"raw\"` | `\"normalized\"` | The effective payload shape for this call. | [src/batteries/tools/searxng/index.ts:120](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L120) |\n| `output?` | `public` | `string` | When set, used verbatim as the tool's output (overrides serialisation). | [src/batteries/tools/searxng/index.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L122) |\n| `raw` | `public` | `unknown` | The parsed SearXNG JSON body. Mutable (used when `format` is `raw`). | [src/batteries/tools/searxng/index.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L116) |\n| `request` | `readonly` | [`SearxngRequestContext`](SearxngRequestContext.md) | The request context as it was sent (post-input-pipeline). | [src/batteries/tools/searxng/index.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L114) |\n| `results` | `public` | [`SearxngResult`](SearxngResult.md)\\[] | The normalised result list. Mutable — filter, redact, or re-rank. | [src/batteries/tools/searxng/index.ts:118](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L118) |\n| `stash` | `readonly` | `Map`<`string`, `unknown`> | Cross-stage scratch space; carried over from the request context. | [src/batteries/tools/searxng/index.ts:124](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L124) |\n| `toolName` | `readonly` | `string` | The tool's name (read-only). | [src/batteries/tools/searxng/index.ts:112](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L112) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResult","title":"Interface: SearxngResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngResult.md\ndescription: >-\n A single normalised SearXNG result. SearXNG result items are deliberately\n untyped upstream, so every field except a best-effort `title`/`url` is\n optional.\n---\n\n# Interface: SearxngResult\n\nDefined in: [src/batteries/tools/searxng/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L62)\n\nA single normalised SearXNG result. SearXNG result items are deliberately untyped upstream,\nso every field except a best-effort `title`/`url` is optional.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | `string` | Snippet / summary text for the result. | [src/batteries/tools/searxng/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L68) |\n| `engine?` | `string` | The SearXNG engine that produced this result (e.g. `google`, `duckduckgo`). | [src/batteries/tools/searxng/index.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L70) |\n| `publishedDate?` | `string` | Publication date, when the source engine exposed one (ISO-ish string, engine-dependent). | [src/batteries/tools/searxng/index.ts:74](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L74) |\n| `score?` | `number` | Relevance score as reported by SearXNG (higher is more relevant). | [src/batteries/tools/searxng/index.ts:72](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L72) |\n| `title?` | `string` | Result title, when the source engine provided one. | [src/batteries/tools/searxng/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L64) |\n| `url?` | `string` | Result URL, when the source engine provided one. | [src/batteries/tools/searxng/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L66) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngToolConfig","title":"Interface: SearxngToolConfig\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngToolConfig.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngToolConfig","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngToolConfig.md\ndescription: >-\n Configuration for [`createSearxngSearchTool`](https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/functions/createSearxngSearchTool) (async) and {@link\n createSearxngSearchToolSync} (sync — `artifact` narrowed to the sync subset).\n---\n\n# Interface: SearxngToolConfig\\\n\nDefined in: [src/batteries/tools/searxng/index.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L146)\n\nConfiguration for [createSearxngSearchTool](../functions/createSearxngSearchTool.md) (async) and\n[createSearxngSearchToolSync](../functions/createSearxngSearchToolSync.md) (sync — `artifact` narrowed to the sync subset).\n\n## Type Parameters\n\n| Type Parameter | Default type | Description |\n| -------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `A` | [`ArtifactResolver`](../../_shared/type-aliases/ArtifactResolver.md) | The [ArtifactResolver](../../_shared/type-aliases/ArtifactResolver.md) variant accepted: the full resolver (async factory) or the sync subset ([createSearxngSearchToolSync](../functions/createSearxngSearchToolSync.md)). |\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `artifact?` | `A` | Spool-artifact resolver for the tool's output. Default `() => SpooledJsonArtifact`. Accepts a constructor, a sync resolver, or — via [createSearxngSearchTool](../functions/createSearxngSearchTool.md) — an async / dynamic-import resolver. Pass `() => SpooledMarkdownArtifact` (paired with an output stage that renders markdown into `ctx.output`) or `() => SpooledArtifact` for plain text. | [src/batteries/tools/searxng/index.ts:168](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L168) |\n| `description?` | `string` | Tool description override. | [src/batteries/tools/searxng/index.ts:161](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L161) |\n| `gate?` | [`ToolGateFn`](../../_shared/type-aliases/ToolGateFn.md) | Optional per-call gate run before the HTTP request — the seam for human-approval/RBAC flows built on `ctx.waitFor` (the ADK gates primitive). Throwing aborts the call through the standard tool-error path. Search queries reach the network on the agent's behalf, which makes every call a candidate for gating. | [src/batteries/tools/searxng/index.ts:175](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L175) |\n| `headers?` | | [`SearxngHeadersResolver`](../type-aliases/SearxngHeadersResolver.md) | [`SearxngHeaders`](../type-aliases/SearxngHeaders.md) | Custom request headers — a static object or a (sync/async) resolver for refreshable auth. | [src/batteries/tools/searxng/index.ts:150](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L150) |\n| `inputPipeline?` | [`SearxngInputMiddlewareFn`](../type-aliases/SearxngInputMiddlewareFn.md)\\[] | Stages run before the HTTP request. See [SearxngRequestContext](SearxngRequestContext.md). | [src/batteries/tools/searxng/index.ts:177](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L177) |\n| `instanceUrl` | `string` | Base URL of the SearXNG instance, e.g. `https://searx.example.org`. Required. | [src/batteries/tools/searxng/index.ts:148](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L148) |\n| `name?` | `string` | Tool name. Default `searxng_search`. | [src/batteries/tools/searxng/index.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L159) |\n| `outputPipeline?` | [`SearxngOutputMiddlewareFn`](../type-aliases/SearxngOutputMiddlewareFn.md)\\[] | Stages run after the response is parsed. See [SearxngResponseContext](SearxngResponseContext.md). | [src/batteries/tools/searxng/index.ts:179](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L179) |\n| `resultFormat?` | [`SearxngResultFormat`](../type-aliases/SearxngResultFormat.md) | Output shape. `normalized`/`raw` pin the shape (the model cannot change it); `either` (default) exposes a `format` argument so the model chooses per call. | [src/batteries/tools/searxng/index.ts:157](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L157) |\n| `timeout?` | `number` | Request timeout in milliseconds. Default `10_000`. | [src/batteries/tools/searxng/index.ts:152](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L152) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeaders","title":"Type Alias: SearxngHeaders","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeaders.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeaders","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeaders.md\ndescription: A static set of request headers (used for custom authentication).\n---\n\n# Type Alias: SearxngHeaders\n\n```ts\ntype SearxngHeaders = Record;\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L47)\n\nA static set of request headers (used for custom authentication).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeadersResolver","title":"Type Alias: SearxngHeadersResolver","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeadersResolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeadersResolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngHeadersResolver.md\ndescription: >-\n A resolver returning request headers, sync or async. Use this form when the\n auth token is refreshable — the resolver runs on every search, so a fresh\n token can be minted per call.\n---\n\n# Type Alias: SearxngHeadersResolver\n\n```ts\ntype SearxngHeadersResolver = () => SearxngHeaders | Promise;\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L53)\n\nA resolver returning request headers, sync or async. Use this form when the auth token is\nrefreshable — the resolver runs on every search, so a fresh token can be minted per call.\n\n## Returns\n\n| [`SearxngHeaders`](SearxngHeaders.md)\n| `Promise`<[`SearxngHeaders`](SearxngHeaders.md)>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngInputMiddlewareFn","title":"Type Alias: SearxngInputMiddlewareFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngInputMiddlewareFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngInputMiddlewareFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngInputMiddlewareFn.md\ndescription: 'An input-pipeline stage. Onion middleware over [`SearxngRequestContext`](https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/interfaces/SearxngRequestContext).'\n---\n\n# Type Alias: SearxngInputMiddlewareFn\n\n```ts\ntype SearxngInputMiddlewareFn = (\n ctx: SearxngRequestContext,\n next: NextFn,\n) => void | Promise;\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:128](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L128)\n\nAn input-pipeline stage. Onion middleware over [SearxngRequestContext](../interfaces/SearxngRequestContext.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ----------------------------------------------------------------- |\n| `ctx` | [`SearxngRequestContext`](../interfaces/SearxngRequestContext.md) |\n| `next` | `NextFn` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngOutputMiddlewareFn","title":"Type Alias: SearxngOutputMiddlewareFn","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngOutputMiddlewareFn.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngOutputMiddlewareFn","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngOutputMiddlewareFn.md\ndescription: >-\n An output-pipeline stage. Onion middleware over {@link\n SearxngResponseContext}.\n---\n\n# Type Alias: SearxngOutputMiddlewareFn\n\n```ts\ntype SearxngOutputMiddlewareFn = (\n ctx: SearxngResponseContext,\n next: NextFn,\n) => void | Promise;\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:134](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L134)\n\nAn output-pipeline stage. Onion middleware over [SearxngResponseContext](../interfaces/SearxngResponseContext.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `ctx` | [`SearxngResponseContext`](../interfaces/SearxngResponseContext.md) |\n| `next` | `NextFn` |\n\n## Returns\n\n`void` | `Promise`<`void`>\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngResultFormat","title":"Type Alias: SearxngResultFormat","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngResultFormat.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngResultFormat","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/searxng/type-aliases/SearxngResultFormat.md\ndescription: The output shape the tool serialises. `either` lets the model pick per call.\n---\n\n# Type Alias: SearxngResultFormat\n\n```ts\ntype SearxngResultFormat = \"normalized\" | \"raw\" | \"either\";\n```\n\nDefined in: [src/batteries/tools/searxng/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/searxng/index.ts#L56)\n\nThe output shape the tool serialises. `either` lets the model pick per call.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions","title":"@nhtio/adk/batteries/tools/standing\\_instructions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/standing_instructions.md'\ndescription: Pre-constructed CRUD tools for model-visible standing instruction management.\n---\n\n# @nhtio/adk/batteries/tools/standing\\_instructions\n\nPre-constructed CRUD tools for model-visible standing instruction management.\n\n## Remarks\n\nPre-constructed CRUD tools that expose the ADK's standing-instruction surface to the\nmodel. Each tool delegates to the corresponding callback on the active\n[@nhtio/adk!DispatchContext](../../../types/interfaces/DispatchContext.md) (`standingInstructions` getter, `storeStandingInstruction`,\n`deleteStandingInstruction`) — the persistence layer is whatever the consumer wired into\nthe runner.\n\nStanding instructions are stored as a [Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) of [@nhtio/adk!Tokenizable](../../../common/classes/Tokenizable.md) values keyed by\nidentity, not by an `id` field — there is no separate \"update by id\" semantics. The tools\ntherefore expose only `list` / `add` / `remove`. To replace an existing instruction the\nmodel should `remove` the old value and `add` the new one (the ADK's persistence layer\nis free to interpret that pair as an update if appropriate).\n\nOutput is JSON for every tool so consumers can parse the result without re-tokenising —\nthe artifact constructor is set to [@nhtio/adk!SpooledJsonArtifact](../../../spooled_artifact/classes/SpooledJsonArtifact.md).\n\nTools:\n\n* [listStandingInstructionsTool](variables/listStandingInstructionsTool.md) — read-only list of every standing instruction\n currently held by the context (after refreshing from the persistence layer).\n* [addStandingInstructionTool](variables/addStandingInstructionTool.md) — add a new standing instruction.\n* [removeStandingInstructionTool](variables/removeStandingInstructionTool.md) — remove a standing instruction by its content\n (exact string match).\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [addStandingInstructionTool](variables/addStandingInstructionTool.md) | Add a new standing instruction to the active execution context. |\n| [listStandingInstructionsTool](variables/listStandingInstructionsTool.md) | List every standing instruction currently held by the active execution context. |\n| [removeStandingInstructionTool](variables/removeStandingInstructionTool.md) | Remove an existing standing instruction by its content string. |\n| [standingInstructionTools](variables/standingInstructionTools.md) | Convenience tuple of every standing-instruction tool. Spread into a [@nhtio/adk!ToolRegistry](../../../forge/classes/ToolRegistry.md) to register the entire category at once. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/addStandingInstructionTool","title":"Variable: addStandingInstructionTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/addStandingInstructionTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/addStandingInstructionTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/standing_instructions/variables/addStandingInstructionTool.md\ndescription: Add a new standing instruction to the active execution context.\n---\n\n# Variable: addStandingInstructionTool\n\n```ts\nconst addStandingInstructionTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/standing\\_instructions/index.ts:67](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/standing_instructions/index.ts#L67)\n\nAdd a new standing instruction to the active execution context.\n\n## Remarks\n\nDelegates to `ctx.storeStandingInstruction(content)`. Standing instructions are stored as\na `Set` — adding the same content twice is a no-op at the local level, though the\nconsumer's persistence callback may interpret it differently.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/listStandingInstructionsTool","title":"Variable: listStandingInstructionsTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/listStandingInstructionsTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/listStandingInstructionsTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/standing_instructions/variables/listStandingInstructionsTool.md\ndescription: >-\n List every standing instruction currently held by the active execution\n context.\n---\n\n# Variable: listStandingInstructionsTool\n\n```ts\nconst listStandingInstructionsTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/standing\\_instructions/index.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/standing_instructions/index.ts#L42)\n\nList every standing instruction currently held by the active execution context.\n\n## Remarks\n\nCalls `ctx.refreshStandingInstructions()` to ensure the local Set is in sync with the\npersistence layer, then serialises the resulting strings to a JSON array. The list is\nstringly-keyed; the same content string serves as the identifier for subsequent removes.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/removeStandingInstructionTool","title":"Variable: removeStandingInstructionTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/removeStandingInstructionTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/removeStandingInstructionTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/standing_instructions/variables/removeStandingInstructionTool.md\ndescription: Remove an existing standing instruction by its content string.\n---\n\n# Variable: removeStandingInstructionTool\n\n```ts\nconst removeStandingInstructionTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/standing\\_instructions/index.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/standing_instructions/index.ts#L96)\n\nRemove an existing standing instruction by its content string.\n\n## Remarks\n\nDelegates to `ctx.deleteStandingInstruction(content)`. Idempotent — succeeds even when\nno matching instruction is currently present.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/standingInstructionTools","title":"Variable: standingInstructionTools","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/standingInstructionTools.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/standing_instructions/variables/standingInstructionTools","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/standing_instructions/variables/standingInstructionTools.md\ndescription: >-\n Convenience tuple of every standing-instruction tool. Spread into a {@link\n @nhtio/adk!ToolRegistry} to register the entire category at once.\n---\n\n# Variable: standingInstructionTools\n\n```ts\nconst standingInstructionTools: readonly [\n Tool>,\n Tool>,\n Tool>,\n];\n```\n\nDefined in: [src/batteries/tools/standing\\_instructions/index.ts:122](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/standing_instructions/index.ts#L122)\n\nConvenience tuple of every standing-instruction tool. Spread into a [@nhtio/adk!ToolRegistry](../../../../forge/classes/ToolRegistry.md)\nto register the entire category at once.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics","title":"@nhtio/adk/batteries/tools/statistics","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/statistics.md'\ndescription: >-\n Pre-constructed tools for descriptive statistics, correlation, quantiles, and\n numeric summaries.\n---\n\n# @nhtio/adk/batteries/tools/statistics\n\nPre-constructed tools for descriptive statistics, correlation, quantiles, and numeric summaries.\n\n## Remarks\n\nPre-constructed bundled tools for the `statistics` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------- | ------------------------------------------------------------------------ |\n| [statsCorrelateTool](variables/statsCorrelateTool.md) | Compute the Pearson correlation coefficient between two numeric arrays. |\n| [statsDescribeTool](variables/statsDescribeTool.md) | Compute descriptive statistics for a JSON array of numbers. |\n| [statsHistogramTool](variables/statsHistogramTool.md) | Bin a numeric array into equal-width histogram buckets. |\n| [statsTransformTool](variables/statsTransformTool.md) | Transform a numeric array — normalise, smooth, rank, or detect outliers. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsCorrelateTool","title":"Variable: statsCorrelateTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsCorrelateTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsCorrelateTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/statistics/variables/statsCorrelateTool.md\ndescription: Compute the Pearson correlation coefficient between two numeric arrays.\n---\n\n# Variable: statsCorrelateTool\n\n```ts\nconst statsCorrelateTool: Tool;\n```\n\nDefined in: [src/batteries/tools/statistics/index.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/statistics/index.ts#L125)\n\nCompute the Pearson correlation coefficient between two numeric arrays.\n\n## Remarks\n\nReturns `r`, `r²` (as a percentage of explained variance), and a plain-English interpretation\nof strength and direction. Arrays must be the same length and contain at least two points.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsDescribeTool","title":"Variable: statsDescribeTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsDescribeTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsDescribeTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/statistics/variables/statsDescribeTool.md\ndescription: Compute descriptive statistics for a JSON array of numbers.\n---\n\n# Variable: statsDescribeTool\n\n```ts\nconst statsDescribeTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/statistics/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/statistics/index.ts#L68)\n\nCompute descriptive statistics for a JSON array of numbers.\n\n## Remarks\n\nReturns count, sum, min/max/range, mean, median, mode, variance, standard deviation,\nquartiles (Q1/Q2/Q3), IQR, and key percentiles (P10/P90/P95/P99) as a pretty-printed JSON\nobject. Non-numeric and non-finite entries are silently filtered.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsHistogramTool","title":"Variable: statsHistogramTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsHistogramTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsHistogramTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/statistics/variables/statsHistogramTool.md\ndescription: Bin a numeric array into equal-width histogram buckets.\n---\n\n# Variable: statsHistogramTool\n\n```ts\nconst statsHistogramTool: Tool;\n```\n\nDefined in: [src/batteries/tools/statistics/index.ts:340](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/statistics/index.ts#L340)\n\nBin a numeric array into equal-width histogram buckets.\n\n## Remarks\n\nOutput is a text histogram showing each bin's range, count, percentage of total, and a bar\nchart. The last bin is inclusive on both ends; preceding bins are half-open. `bins` is clamped\nto `[2, 100]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsTransformTool","title":"Variable: statsTransformTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsTransformTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/statistics/variables/statsTransformTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/statistics/variables/statsTransformTool.md\ndescription: 'Transform a numeric array — normalise, smooth, rank, or detect outliers.'\n---\n\n# Variable: statsTransformTool\n\n```ts\nconst statsTransformTool: Tool;\n```\n\nDefined in: [src/batteries/tools/statistics/index.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/statistics/index.ts#L189)\n\nTransform a numeric array — normalise, smooth, rank, or detect outliers.\n\n## Remarks\n\nSupported operations: `normalize_min_max`, `normalize_z_score`, `normalize_percent_of_sum`,\n`running_total`, `rolling_avg`, `pct_change`, `rank`, `outliers_iqr`, `outliers_zscore`. Most\noperations return a JSON array of transformed values; outlier operations return a\nhuman-readable report.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing","title":"@nhtio/adk/batteries/tools/string\\_processing","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/string_processing.md'\ndescription: >-\n Pre-constructed tools for casing, trimming, normalizing, and transforming\n strings.\n---\n\n# @nhtio/adk/batteries/tools/string\\_processing\n\nPre-constructed tools for casing, trimming, normalizing, and transforming strings.\n\n## Remarks\n\nPre-constructed bundled tools for the `string_processing` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ------------------------------------------------------- | ---------------------------------------------------------- |\n| [stringExtractTool](variables/stringExtractTool.md) | Extract all matches of a regular expression from a string. |\n| [stringTransformTool](variables/stringTransformTool.md) | Apply an ordered pipeline of string transformations. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing/variables/stringExtractTool","title":"Variable: stringExtractTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing/variables/stringExtractTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing/variables/stringExtractTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/string_processing/variables/stringExtractTool.md\ndescription: Extract all matches of a regular expression from a string.\n---\n\n# Variable: stringExtractTool\n\n```ts\nconst stringExtractTool: Tool;\n```\n\nDefined in: [src/batteries/tools/string\\_processing/index.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/string_processing/index.ts#L211)\n\nExtract all matches of a regular expression from a string.\n\n## Remarks\n\nThe `g` flag is always enabled. `group` selects which capture group to return per match (0 =\nfull match). Output is at most 500 matches; if truncated, the suffix `(truncated at 500)` is\nappended.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing/variables/stringTransformTool","title":"Variable: stringTransformTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing/variables/stringTransformTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/string_processing/variables/stringTransformTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/string_processing/variables/stringTransformTool.md\ndescription: Apply an ordered pipeline of string transformations.\n---\n\n# Variable: stringTransformTool\n\n```ts\nconst stringTransformTool: Tool;\n```\n\nDefined in: [src/batteries/tools/string\\_processing/index.ts:171](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/string_processing/index.ts#L171)\n\nApply an ordered pipeline of string transformations.\n\n## Remarks\n\nEach operation reads the previous step's output. Most operations return strings; `count_*`\nreturn numbers and `split` returns an array — once a non-string flows through, subsequent\noperations report an error rather than coercing. The result is always serialised to a string\n(arrays become JSON; numbers/booleans are stringified).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data","title":"@nhtio/adk/batteries/tools/structured\\_data","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/structured_data.md'\ndescription: >-\n Pre-constructed tools for transforming arrays and objects into tables and\n tabular text.\n---\n\n# @nhtio/adk/batteries/tools/structured\\_data\n\nPre-constructed tools for transforming arrays and objects into tables and tabular text.\n\n## Remarks\n\nPre-constructed bundled tools for the `structured_data` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------- | ------------------------------------------------------- |\n| [formatTableTool](variables/formatTableTool.md) | Convert a JSON array of objects into a formatted table. |\n| [jsonFormatTool](variables/jsonFormatTool.md) | Pretty-print or minify a JSON string. |\n| [validateFormatTool](variables/validateFormatTool.md) | Check whether a string matches a known format. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/formatTableTool","title":"Variable: formatTableTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/formatTableTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/formatTableTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/structured_data/variables/formatTableTool.md\ndescription: Convert a JSON array of objects into a formatted table.\n---\n\n# Variable: formatTableTool\n\n```ts\nconst formatTableTool: Tool;\n```\n\nDefined in: [src/batteries/tools/structured\\_data/index.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/structured_data/index.ts#L41)\n\nConvert a JSON array of objects into a formatted table.\n\n## Remarks\n\nSupports `markdown`, `csv`, and `tsv` output. Columns default to the keys of the first row;\nsupply `columns` to control which keys appear and in what order.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/jsonFormatTool","title":"Variable: jsonFormatTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/jsonFormatTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/jsonFormatTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/structured_data/variables/jsonFormatTool.md\ndescription: Pretty-print or minify a JSON string.\n---\n\n# Variable: jsonFormatTool\n\n```ts\nconst jsonFormatTool: Tool;\n```\n\nDefined in: [src/batteries/tools/structured\\_data/index.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/structured_data/index.ts#L126)\n\nPretty-print or minify a JSON string.\n\n## Remarks\n\nValidates the input as JSON, then re-serialises it with the requested indentation. `indent` is\nclamped to the range \\[0, 8]; `0` produces minified output.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/validateFormatTool","title":"Variable: validateFormatTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/validateFormatTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/structured_data/variables/validateFormatTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/structured_data/variables/validateFormatTool.md\ndescription: Check whether a string matches a known format.\n---\n\n# Variable: validateFormatTool\n\n```ts\nconst validateFormatTool: Tool;\n```\n\nDefined in: [src/batteries/tools/structured\\_data/index.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/structured_data/index.ts#L213)\n\nCheck whether a string matches a known format.\n\n## Remarks\n\nSupported formats: `email`, `uuid` (v1–v5), `ipv4`, `iso_date`, `iso_datetime`, `hex_color`,\n`phone_e164`, `semver`, `integer`, `decimal`, `alphanumeric`, `slug`, `hex`, `base64`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis","title":"@nhtio/adk/batteries/tools/text\\_analysis","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/text_analysis.md'\ndescription: >-\n Pre-constructed tools for extracting counts, token estimates, and character\n statistics from text.\n---\n\n# @nhtio/adk/batteries/tools/text\\_analysis\n\nPre-constructed tools for extracting counts, token estimates, and character statistics from text.\n\n## Remarks\n\nPre-constructed bundled tools for the `text_analysis` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------- | ------------------------------------------------------ |\n| [textAnalyzeTool](variables/textAnalyzeTool.md) | Analyze text and return statistics as a JSON document. |\n| [textLinesTool](variables/textLinesTool.md) | Operate on text treated as a list of lines. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis/variables/textAnalyzeTool","title":"Variable: textAnalyzeTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis/variables/textAnalyzeTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis/variables/textAnalyzeTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/text_analysis/variables/textAnalyzeTool.md\ndescription: Analyze text and return statistics as a JSON document.\n---\n\n# Variable: textAnalyzeTool\n\n```ts\nconst textAnalyzeTool: Tool>;\n```\n\nDefined in: [src/batteries/tools/text\\_analysis/index.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/text_analysis/index.ts#L25)\n\nAnalyze text and return statistics as a JSON document.\n\n## Remarks\n\nReports character counts (with and without spaces), word/sentence/paragraph/line counts,\nunique word count, average word length, a rough token estimate (4 chars/token), and a set\nof character-class booleans (`is_all_alpha`, `is_all_ascii`, etc.).\n\nOutput is JSON, so the artifact constructor is set to [@nhtio/adk!SpooledJsonArtifact](../../../../spooled_artifact/classes/SpooledJsonArtifact.md) — consumer\ncode can read the result back as a parsed record without re-parsing.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis/variables/textLinesTool","title":"Variable: textLinesTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis/variables/textLinesTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_analysis/variables/textLinesTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/text_analysis/variables/textLinesTool.md\ndescription: Operate on text treated as a list of lines.\n---\n\n# Variable: textLinesTool\n\n```ts\nconst textLinesTool: Tool;\n```\n\nDefined in: [src/batteries/tools/text\\_analysis/index.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/text_analysis/index.ts#L101)\n\nOperate on text treated as a list of lines.\n\n## Remarks\n\nOperations: `sort`, `sort_desc`, `reverse`, `deduplicate`, `filter_empty`, `trim_each`,\n`number` (prefix each line with `1.`, `2.`, …), `count`. Sort and deduplicate respect the\noptional `case_insensitive` flag.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison","title":"@nhtio/adk/batteries/tools/text\\_comparison","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/text_comparison.md'\ndescription: >-\n Pre-constructed tools for text diffs, similarity checks, and edit-distance\n comparisons.\n---\n\n# @nhtio/adk/batteries/tools/text\\_comparison\n\nPre-constructed tools for text diffs, similarity checks, and edit-distance comparisons.\n\n## Remarks\n\nPre-constructed bundled tools for the `text_comparison` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| --------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| [stringSimilarityTool](variables/stringSimilarityTool.md) | Report the Levenshtein edit distance and a similarity percentage between two strings. |\n| [textDiffTool](variables/textDiffTool.md) | Compare two texts and emit a unified-style diff plus an additions/removals summary. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison/variables/stringSimilarityTool","title":"Variable: stringSimilarityTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison/variables/stringSimilarityTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison/variables/stringSimilarityTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/text_comparison/variables/stringSimilarityTool.md\ndescription: >-\n Report the Levenshtein edit distance and a similarity percentage between two\n strings.\n---\n\n# Variable: stringSimilarityTool\n\n```ts\nconst stringSimilarityTool: Tool;\n```\n\nDefined in: [src/batteries/tools/text\\_comparison/index.ts:94](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/text_comparison/index.ts#L94)\n\nReport the Levenshtein edit distance and a similarity percentage between two strings.\n\n## Remarks\n\nUseful for fuzzy matching. The percentage is `(1 - distance / max(len_a, len_b)) * 100`, with\na human-readable label appended (`identical` / `very similar` / `similar` / `somewhat\nsimilar` / `different` / `very different`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison/variables/textDiffTool","title":"Variable: textDiffTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison/variables/textDiffTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/text_comparison/variables/textDiffTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/text_comparison/variables/textDiffTool.md\ndescription: >-\n Compare two texts and emit a unified-style diff plus an additions/removals\n summary.\n---\n\n# Variable: textDiffTool\n\n```ts\nconst textDiffTool: Tool;\n```\n\nDefined in: [src/batteries/tools/text\\_comparison/index.ts:24](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/text_comparison/index.ts#L24)\n\nCompare two texts and emit a unified-style diff plus an additions/removals summary.\n\n## Remarks\n\n`mode: 'lines'` (default) compares line-by-line; `mode: 'words'` compares word-by-word. The\noutput is clipped at 60 diff lines — the suffix `… (N more lines truncated)` is appended if\nthe diff is larger. Identical inputs short-circuit with `Texts are identical`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/time","title":"@nhtio/adk/batteries/tools/time","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/time.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/time","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/time.md'\ndescription: >-\n Pre-constructed tools for current time lookup and timezone-aware time\n formatting.\n---\n\n# @nhtio/adk/batteries/tools/time\n\nPre-constructed tools for current time lookup and timezone-aware time formatting.\n\n## Remarks\n\nPre-constructed bundled tools for the `time` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------- | ------------------------------------------------------ |\n| [convertTimeTool](variables/convertTimeTool.md) | Convert a wall-clock time between two IANA timezones. |\n| [getCurrentTimeTool](variables/getCurrentTimeTool.md) | Return the current time formatted in a given timezone. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/time/variables/convertTimeTool","title":"Variable: convertTimeTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/time/variables/convertTimeTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/time/variables/convertTimeTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/time/variables/convertTimeTool.md\ndescription: Convert a wall-clock time between two IANA timezones.\n---\n\n# Variable: convertTimeTool\n\n```ts\nconst convertTimeTool: Tool;\n```\n\nDefined in: [src/batteries/tools/time/index.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/time/index.ts#L51)\n\nConvert a wall-clock time between two IANA timezones.\n\n## Remarks\n\n`time` must be `HH:MM` in 24-hour format. `target_timezone` defaults to UTC. The conversion\nuses today's date in the source zone to pick the correct DST offset.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/time/variables/getCurrentTimeTool","title":"Variable: getCurrentTimeTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/time/variables/getCurrentTimeTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/time/variables/getCurrentTimeTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/time/variables/getCurrentTimeTool.md\ndescription: Return the current time formatted in a given timezone.\n---\n\n# Variable: getCurrentTimeTool\n\n```ts\nconst getCurrentTimeTool: Tool;\n```\n\nDefined in: [src/batteries/tools/time/index.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/time/index.ts#L23)\n\nReturn the current time formatted in a given timezone.\n\n## Remarks\n\n`timezone` defaults to `UTC` when omitted. The ADK has no notion of a \"user local\"\ntimezone, so callers should pass an IANA zone (`America/New_York`, `Europe/London`, ...) for\nnon-UTC formatting.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/unit_conversion","title":"@nhtio/adk/batteries/tools/unit\\_conversion","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/unit_conversion.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/unit_conversion","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/unit_conversion.md'\ndescription: Pre-constructed tools for converting values across common measurement units.\n---\n\n# @nhtio/adk/batteries/tools/unit\\_conversion\n\nPre-constructed tools for converting values across common measurement units.\n\n## Remarks\n\nPre-constructed bundled tools for the `unit_conversion` category. Import individually, the whole\ncategory, or import every tool via `@nhtio/adk/batteries`.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------- | -------------------------------------------------------------------- |\n| [convertUnitTool](variables/convertUnitTool.md) | Convert a numeric value between units of the same physical category. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/unit_conversion/variables/convertUnitTool","title":"Variable: convertUnitTool","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/unit_conversion/variables/convertUnitTool.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/unit_conversion/variables/convertUnitTool","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/unit_conversion/variables/convertUnitTool.md\ndescription: Convert a numeric value between units of the same physical category.\n---\n\n# Variable: convertUnitTool\n\n```ts\nconst convertUnitTool: Tool;\n```\n\nDefined in: [src/batteries/tools/unit\\_conversion/index.ts:139](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/unit_conversion/index.ts#L139)\n\nConvert a numeric value between units of the same physical category.\n\n## Remarks\n\nSupported categories: length, mass, volume, temperature, speed, area, data, time, energy,\npressure, angle. Uses static conversion tables — no external data required. Temperature is\nhandled specially via a Kelvin intermediate to preserve precision across `C`/`F`/`K`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval","title":"@nhtio/adk/batteries/tools/web\\_retrieval","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval.md'\ndescription: >-\n RAG glue: turn web-search and web-scrape results into `Retrievable` records\n for a turn.\n---\n\n# @nhtio/adk/batteries/tools/web\\_retrieval\n\nRAG glue: turn web-search and web-scrape results into `Retrievable` records for a turn.\n\n## Remarks\n\nThe seam from \"I searched / scraped something\" to \"it is in the turn as a `Retrievable`\",\nshared by the SearXNG and Scrapper batteries. It is deliberately **decoupled** from the ADK\ncore at runtime:\n\n* The converters are **pure** `(payload) => RawRetrievable[]` — they build plain data objects and\n never instantiate a core class, so the module's only core coupling is erased `import type`.\n* The recommended spool-artifact type travels as an **open resolver**\n ([@nhtio/adk/forge!ArtifactConstructorResolver](../../../forge/type-aliases/ArtifactConstructorResolver.md)), never a closed string enum — a consumer's\n future YAML/HTML `SpooledArtifact` subclass works with no change here. The converter hands the\n recommendation to the caller's `spool` hook; the caller owns the actual class import.\n* The one helper that must construct a `Retrievable` ([storeRetrievables](functions/storeRetrievables.md)) takes the\n constructor via a **resolver** (constructor / sync / async / dynamic-import), exactly like the\n vector battery's `createVectorStore` `client`.\n\nWeb content is `'third-party-public'` by default — a definitional constant for open-web data\n(NOT inferred from the URL, which CONTRIBUTING Design Decision #12 forbids); override via\n`trustTier` when you know better.\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ArticleToRetrievableOptions](interfaces/ArticleToRetrievableOptions.md) | Options for [scrapperArticleToRetrievable](functions/scrapperArticleToRetrievable.md). |\n| [ArtifactRecommendations](interfaces/ArtifactRecommendations.md) | The artifact-resolver recommendations a caller may supply so the glue names no concrete class itself. Each converter asks for the relevant key; if the caller omits it, content stays inline. |\n| [RetrievableStoreCtx](interfaces/RetrievableStoreCtx.md) | The minimal context surface [storeRetrievables](functions/storeRetrievables.md) needs. |\n| [ScrapperArticleLike](interfaces/ScrapperArticleLike.md) | Minimal structural shape of a Scrapper normalised article. |\n| [ScrapperLinkLike](interfaces/ScrapperLinkLike.md) | Minimal structural shape of a Scrapper normalised link. |\n| [ScrapperLinksLike](interfaces/ScrapperLinksLike.md) | Minimal structural shape of a Scrapper normalised links payload. |\n| [SearxngPayloadLike](interfaces/SearxngPayloadLike.md) | Minimal structural shape of a SearXNG normalised payload. |\n| [SearxngResultLike](interfaces/SearxngResultLike.md) | Minimal structural shape of a SearXNG normalised result the converter reads. |\n| [ToRetrievableOptions](interfaces/ToRetrievableOptions.md) | Options common to every converter. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [ArticleContentSource](type-aliases/ArticleContentSource.md) | Which article text field to use as the record content. |\n| [Resolver](type-aliases/Resolver.md) | A resolver of `T`: the value itself, or a (sync/async) thunk, optionally a module `{ default }`. |\n| [RetrievableCtor](type-aliases/RetrievableCtor.md) | A constructor that builds a [@nhtio/adk!Retrievable](../../../common/classes/Retrievable.md) from a [@nhtio/adk/common!RawRetrievable](../../../common/interfaces/RawRetrievable.md). |\n| [SpoolHook](type-aliases/SpoolHook.md) | A reader-backed-artifact hook. Called by a converter for content that may be large; the converter passes the artifact constructor it **recommends** for this content (an open [@nhtio/adk/forge!ArtifactConstructorResolver](../../../forge/type-aliases/ArtifactConstructorResolver.md)) so the caller can wrap with the right subclass — preserving its forged query tools — using the caller's own core import. Return a [@nhtio/adk!SpooledArtifact](../../../spooled_artifact/classes/SpooledArtifact.md) to store the content reader-backed, or `undefined` to keep it inline as a string. |\n\n## Functions\n\n| Function | Description |\n| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| [scrapperArticleToRetrievable](functions/scrapperArticleToRetrievable.md) | Convert a Scrapper normalised article into a single [@nhtio/adk/common!RawRetrievable](../../../common/interfaces/RawRetrievable.md). |\n| [scrapperLinksToRetrievables](functions/scrapperLinksToRetrievables.md) | Convert a Scrapper normalised links payload into one [@nhtio/adk/common!RawRetrievable](../../../common/interfaces/RawRetrievable.md) per link. |\n| [searxngResultsToRetrievables](functions/searxngResultsToRetrievables.md) | Convert a SearXNG normalised payload into one [@nhtio/adk/common!RawRetrievable](../../../common/interfaces/RawRetrievable.md) per result. |\n| [storeRetrievables](functions/storeRetrievables.md) | Construct [@nhtio/adk!Retrievable](../../../common/classes/Retrievable.md)s from `RawRetrievable`s and store each via `ctx`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperArticleToRetrievable","title":"Function: scrapperArticleToRetrievable()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperArticleToRetrievable.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperArticleToRetrievable","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperArticleToRetrievable.md\n---\n\n# Function: scrapperArticleToRetrievable()\n\n```ts\nfunction scrapperArticleToRetrievable(\n article: ScrapperArticleLike,\n opts?: ArticleToRetrievableOptions,\n recommend?: ArtifactRecommendations,\n): RawRetrievable;\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:220](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L220)\n\nConvert a Scrapper normalised article into a single [@nhtio/adk/common!RawRetrievable](../../../../common/interfaces/RawRetrievable.md).\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| `article` | [`ScrapperArticleLike`](../interfaces/ScrapperArticleLike.md) | The Scrapper normalised article. |\n| `opts` | [`ArticleToRetrievableOptions`](../interfaces/ArticleToRetrievableOptions.md) | Trust tier, kind, id prefix, content source, markdown flag, optional spool hook. |\n| `recommend` | [`ArtifactRecommendations`](../interfaces/ArtifactRecommendations.md) | Optional artifact-resolver recommendations. |\n\n## Returns\n\n[`RawRetrievable`](../../../../common/interfaces/RawRetrievable.md)\n\nA single `RawRetrievable`.\n\n## Remarks\n\nLong article text is exactly what a reader-backed [@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) is for: pass a\n`spool` hook and the converter offers it the recommended artifact resolver (markdown when\n`asMarkdown`, else text/HTML) so the model gets the right forged query tools. Without a hook,\ncontent stays inline.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperLinksToRetrievables","title":"Function: scrapperLinksToRetrievables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperLinksToRetrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperLinksToRetrievables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperLinksToRetrievables.md\n---\n\n# Function: scrapperLinksToRetrievables()\n\n```ts\nfunction scrapperLinksToRetrievables(\n payload: ScrapperLinksLike,\n opts?: ToRetrievableOptions,\n recommend?: ArtifactRecommendations,\n): RawRetrievable[];\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:278](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L278)\n\nConvert a Scrapper normalised links payload into one [@nhtio/adk/common!RawRetrievable](../../../../common/interfaces/RawRetrievable.md) per link.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| `payload` | [`ScrapperLinksLike`](../interfaces/ScrapperLinksLike.md) | The Scrapper normalised links payload (`{ links: [{ url, text }] }`). |\n| `opts` | [`ToRetrievableOptions`](../interfaces/ToRetrievableOptions.md) | Trust tier, kind, id prefix, optional spool hook, and inline preference. |\n| `recommend` | [`ArtifactRecommendations`](../interfaces/ArtifactRecommendations.md) | Optional artifact-resolver recommendations. |\n\n## Returns\n\n[`RawRetrievable`](../../../../common/interfaces/RawRetrievable.md)\\[]\n\nOne `RawRetrievable` per link.\n\n## Remarks\n\nEach link's `text` becomes the content and its `url` the `source`. Spooling is opt-in, exactly\nas for the other web converters; link records default to `inline: true` so short text remains\ninline even when a storage layer auto-spools it.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/searxngResultsToRetrievables","title":"Function: searxngResultsToRetrievables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/searxngResultsToRetrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/searxngResultsToRetrievables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/functions/searxngResultsToRetrievables.md\n---\n\n# Function: searxngResultsToRetrievables()\n\n```ts\nfunction searxngResultsToRetrievables(\n payload: SearxngPayloadLike,\n opts?: ToRetrievableOptions,\n recommend?: ArtifactRecommendations,\n): RawRetrievable[];\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L147)\n\nConvert a SearXNG normalised payload into one [@nhtio/adk/common!RawRetrievable](../../../../common/interfaces/RawRetrievable.md) per result.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ----------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| `payload` | [`SearxngPayloadLike`](../interfaces/SearxngPayloadLike.md) | The SearXNG normalised payload (`{ results: [{ url, title, content, score }] }`). |\n| `opts` | [`ToRetrievableOptions`](../interfaces/ToRetrievableOptions.md) | Trust tier, kind, id prefix, optional spool hook. |\n| `recommend` | [`ArtifactRecommendations`](../interfaces/ArtifactRecommendations.md) | Optional artifact-resolver recommendations (the glue names no class itself). |\n\n## Returns\n\n[`RawRetrievable`](../../../../common/interfaces/RawRetrievable.md)\\[]\n\nOne `RawRetrievable` per result.\n\n## Remarks\n\nSnippets are short, so `content` stays an inline string (the `spool` hook, if any, is still\noffered the `text` recommendation). `source` is the result URL; `score` is clamped to `[0,1]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/storeRetrievables","title":"Function: storeRetrievables()","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/storeRetrievables.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/functions/storeRetrievables","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/functions/storeRetrievables.md\n---\n\n# Function: storeRetrievables()\n\n```ts\nfunction storeRetrievables(\n ctx: RetrievableStoreCtx,\n raws: RawRetrievable[],\n deps: {\n retrievable: Resolver;\n },\n): Promise;\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L359)\n\nConstruct [@nhtio/adk!Retrievable](../../../../common/classes/Retrievable.md)s from `RawRetrievable`s and store each via `ctx`.\n\n## Parameters\n\n| Parameter | Type | Description |\n| ------------------ | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |\n| `ctx` | [`RetrievableStoreCtx`](../interfaces/RetrievableStoreCtx.md) | Anything with a `storeRetrievable` method (a `DispatchContext`, or a stub). |\n| `raws` | [`RawRetrievable`](../../../../common/interfaces/RawRetrievable.md)\\[] | The plain records from the converters. |\n| `deps` | { `retrievable`: [`Resolver`](../type-aliases/Resolver.md)<[`RetrievableCtor`](../type-aliases/RetrievableCtor.md)>; } | `{ retrievable }`: the `Retrievable` constructor or a resolver of it. |\n| `deps.retrievable` | [`Resolver`](../type-aliases/Resolver.md)<[`RetrievableCtor`](../type-aliases/RetrievableCtor.md)> | - |\n\n## Returns\n\n`Promise`<[`Retrievable`](../../../../common/classes/Retrievable.md)\\[]>\n\nThe constructed `Retrievable` instances, in input order.\n\n## Remarks\n\nThis is the only function here that touches a core class, and it does so through an injected\n**resolver** (`deps.retrievable`) so the glue itself never value-imports `Retrievable`. Each\nrecord's `RawRetrievable` validation (including the required `trustTier`) fires at construction.\nFor reader-backed content, the caller's `spool` hook will typically have used\n`ctx.storeRetrievableBytes` already; this helper just persists the records into the turn.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArticleToRetrievableOptions","title":"Interface: ArticleToRetrievableOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArticleToRetrievableOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArticleToRetrievableOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArticleToRetrievableOptions.md\ndescription: 'Options for [`scrapperArticleToRetrievable`](https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/functions/scrapperArticleToRetrievable).'\n---\n\n# Interface: ArticleToRetrievableOptions\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:196](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L196)\n\nOptions for [scrapperArticleToRetrievable](../functions/scrapperArticleToRetrievable.md).\n\n## Extends\n\n* [`ToRetrievableOptions`](ToRetrievableOptions.md)\n\n## Properties\n\n| Property | Type | Description | Inherited from | Defined in |\n| ---------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `asMarkdown?` | `boolean` | Whether the chosen content is markdown (recommend `markdown`) rather than plain text. Default false. Use when an output pipeline rendered the article to markdown. | - | [src/batteries/tools/web\\_retrieval/index.ts:203](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L203) |\n| `contentSource?` | [`ArticleContentSource`](../type-aliases/ArticleContentSource.md) | Which field to use as content (default `'textContent'`). `'content'` is HTML. | - | [src/batteries/tools/web\\_retrieval/index.ts:198](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L198) |\n| `idPrefix?` | `string` | Prefix for the stable, hashed record id (namespacing across sources). | [`ToRetrievableOptions`](ToRetrievableOptions.md).[`idPrefix`](ToRetrievableOptions.md#property-idprefix) | [src/batteries/tools/web\\_retrieval/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L62) |\n| `inline?` | `boolean` | Whether spooled content should be materialized inline instead of rendered as a handle. | [`ToRetrievableOptions`](ToRetrievableOptions.md).[`inline`](ToRetrievableOptions.md#property-inline) | [src/batteries/tools/web\\_retrieval/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L66) |\n| `kind?` | `string` | Semantic `kind` label, e.g. `'web-search-result'`, `'web-article'`, `'web-links'`. | [`ToRetrievableOptions`](ToRetrievableOptions.md).[`kind`](ToRetrievableOptions.md#property-kind) | [src/batteries/tools/web\\_retrieval/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L60) |\n| `spool?` | [`SpoolHook`](../type-aliases/SpoolHook.md) | Optional reader-backed-artifact hook for large content. See [SpoolHook](../type-aliases/SpoolHook.md). | [`ToRetrievableOptions`](ToRetrievableOptions.md).[`spool`](ToRetrievableOptions.md#property-spool) | [src/batteries/tools/web\\_retrieval/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L64) |\n| `trustTier?` | [`RetrievableTrustTier`](../../../../common/type-aliases/RetrievableTrustTier.md) | Trust tier for the produced records. Default `'third-party-public'` (web content is third-party by definition — this is a constant, not URL inference). | [`ToRetrievableOptions`](ToRetrievableOptions.md).[`trustTier`](ToRetrievableOptions.md#property-trusttier) | [src/batteries/tools/web\\_retrieval/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L58) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArtifactRecommendations","title":"Interface: ArtifactRecommendations","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArtifactRecommendations.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArtifactRecommendations","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ArtifactRecommendations.md\ndescription: >-\n The artifact-resolver recommendations a caller may supply so the glue names no\n concrete class itself. Each converter asks for the relevant key; if the caller\n omits it, content stays inline.\n---\n\n# Interface: ArtifactRecommendations\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L73)\n\nThe artifact-resolver recommendations a caller may supply so the glue names no concrete class\nitself. Each converter asks for the relevant key; if the caller omits it, content stays inline.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `json?` | [`ArtifactConstructorResolver`](../../../../forge/type-aliases/ArtifactConstructorResolver.md) | Recommended for JSON content (`SpooledJsonArtifact`). | [src/batteries/tools/web\\_retrieval/index.ts:79](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L79) |\n| `markdown?` | [`ArtifactConstructorResolver`](../../../../forge/type-aliases/ArtifactConstructorResolver.md) | Recommended for markdown content (`SpooledMarkdownArtifact`). | [src/batteries/tools/web\\_retrieval/index.ts:77](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L77) |\n| `text?` | [`ArtifactConstructorResolver`](../../../../forge/type-aliases/ArtifactConstructorResolver.md) | Recommended for plain-text / HTML content (base `SpooledArtifact`). | [src/batteries/tools/web\\_retrieval/index.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L75) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/RetrievableStoreCtx","title":"Interface: RetrievableStoreCtx","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/RetrievableStoreCtx.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/RetrievableStoreCtx","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/RetrievableStoreCtx.md\ndescription: 'The minimal context surface [`storeRetrievables`](https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/functions/storeRetrievables) needs.'\n---\n\n# Interface: RetrievableStoreCtx\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:310](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L310)\n\nThe minimal context surface [storeRetrievables](../functions/storeRetrievables.md) needs.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `storeRetrievable` | (`v`: [`Retrievable`](../../../../common/classes/Retrievable.md)) => | [`Retrievable`](../../../../common/classes/Retrievable.md) | `Promise`<[`Retrievable`](../../../../common/classes/Retrievable.md)> | Persist a single `Retrievable` and return the tracked (possibly auto-spooled) instance. | [src/batteries/tools/web\\_retrieval/index.ts:312](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L312) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperArticleLike","title":"Interface: ScrapperArticleLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperArticleLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperArticleLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperArticleLike.md\ndescription: Minimal structural shape of a Scrapper normalised article.\n---\n\n# Interface: ScrapperArticleLike\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L181)\n\nMinimal structural shape of a Scrapper normalised article.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------------------ | -------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | `string` | Processed article HTML (the `'content'` content source). | [src/batteries/tools/web\\_retrieval/index.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L189) |\n| `textContent?` | `string` | Article text with HTML stripped (the default content source). | [src/batteries/tools/web\\_retrieval/index.ts:187](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L187) |\n| `title?` | `string` | Article title. | [src/batteries/tools/web\\_retrieval/index.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L185) |\n| `url?` | `string` | The page URL (becomes the record's `source`). | [src/batteries/tools/web\\_retrieval/index.ts:183](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L183) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinkLike","title":"Interface: ScrapperLinkLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinkLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinkLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinkLike.md\ndescription: Minimal structural shape of a Scrapper normalised link.\n---\n\n# Interface: ScrapperLinkLike\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:251](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L251)\n\nMinimal structural shape of a Scrapper normalised link.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------- | -------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `text?` | `string` | The link's anchor text (becomes the record's content). | [src/batteries/tools/web\\_retrieval/index.ts:255](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L255) |\n| `url?` | `string` | The link's target URL (becomes the record's `source`). | [src/batteries/tools/web\\_retrieval/index.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L253) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinksLike","title":"Interface: ScrapperLinksLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinksLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinksLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ScrapperLinksLike.md\ndescription: Minimal structural shape of a Scrapper normalised links payload.\n---\n\n# Interface: ScrapperLinksLike\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L258)\n\nMinimal structural shape of a Scrapper normalised links payload.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | ------------------------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `links?` | [`ScrapperLinkLike`](ScrapperLinkLike.md)\\[] | The collected links. | [src/batteries/tools/web\\_retrieval/index.ts:262](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L262) |\n| `url?` | `string` | The page URL the links were collected from. | [src/batteries/tools/web\\_retrieval/index.ts:260](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L260) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngPayloadLike","title":"Interface: SearxngPayloadLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngPayloadLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngPayloadLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngPayloadLike.md\ndescription: Minimal structural shape of a SearXNG normalised payload.\n---\n\n# Interface: SearxngPayloadLike\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L130)\n\nMinimal structural shape of a SearXNG normalised payload.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | --------------------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `results?` | [`SearxngResultLike`](SearxngResultLike.md)\\[] | The result list. | [src/batteries/tools/web\\_retrieval/index.ts:132](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L132) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngResultLike","title":"Interface: SearxngResultLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngResultLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngResultLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/SearxngResultLike.md\ndescription: Minimal structural shape of a SearXNG normalised result the converter reads.\n---\n\n# Interface: SearxngResultLike\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:119](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L119)\n\nMinimal structural shape of a SearXNG normalised result the converter reads.\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ---------------------------------------- | -------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `content?` | `string` | Result snippet (joined into the inline content). | [src/batteries/tools/web\\_retrieval/index.ts:125](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L125) |\n| `score?` | `number` | Relevance score (clamped to `[0,1]` on the record). | [src/batteries/tools/web\\_retrieval/index.ts:127](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L127) |\n| `title?` | `string` | Result title (joined into the inline content). | [src/batteries/tools/web\\_retrieval/index.ts:123](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L123) |\n| `url?` | `string` | Result URL (becomes the record's `source`). | [src/batteries/tools/web\\_retrieval/index.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L121) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ToRetrievableOptions","title":"Interface: ToRetrievableOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ToRetrievableOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ToRetrievableOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/interfaces/ToRetrievableOptions.md\ndescription: Options common to every converter.\n---\n\n# Interface: ToRetrievableOptions\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:53](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L53)\n\nOptions common to every converter.\n\n## Extended by\n\n* [`ArticleToRetrievableOptions`](ArticleToRetrievableOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| -------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `idPrefix?` | `string` | Prefix for the stable, hashed record id (namespacing across sources). | [src/batteries/tools/web\\_retrieval/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L62) |\n| `inline?` | `boolean` | Whether spooled content should be materialized inline instead of rendered as a handle. | [src/batteries/tools/web\\_retrieval/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L66) |\n| `kind?` | `string` | Semantic `kind` label, e.g. `'web-search-result'`, `'web-article'`, `'web-links'`. | [src/batteries/tools/web\\_retrieval/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L60) |\n| `spool?` | [`SpoolHook`](../type-aliases/SpoolHook.md) | Optional reader-backed-artifact hook for large content. See [SpoolHook](../type-aliases/SpoolHook.md). | [src/batteries/tools/web\\_retrieval/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L64) |\n| `trustTier?` | [`RetrievableTrustTier`](../../../../common/type-aliases/RetrievableTrustTier.md) | Trust tier for the produced records. Default `'third-party-public'` (web content is third-party by definition — this is a constant, not URL inference). | [src/batteries/tools/web\\_retrieval/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L58) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/ArticleContentSource","title":"Type Alias: ArticleContentSource","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/ArticleContentSource.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/ArticleContentSource","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/ArticleContentSource.md\ndescription: Which article text field to use as the record content.\n---\n\n# Type Alias: ArticleContentSource\n\n```ts\ntype ArticleContentSource = \"textContent\" | \"content\";\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:193](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L193)\n\nWhich article text field to use as the record content.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/Resolver","title":"Type Alias: Resolver\\","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/Resolver.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/Resolver","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/Resolver.md\ndescription: >-\n A resolver of `T`: the value itself, or a (sync/async) thunk, optionally a\n module `{ default }`.\n---\n\n# Type Alias: Resolver\\\n\n```ts\ntype Resolver =\n | T\n | (() =>\n | T\n | {\n default: T;\n })\n | (() => Promise<\n | T\n | {\n default: T;\n }\n >);\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L36)\n\nA resolver of `T`: the value itself, or a (sync/async) thunk, optionally a module `{ default }`.\n\n## Type Parameters\n\n| Type Parameter |\n| -------------- |\n| `T` |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/RetrievableCtor","title":"Type Alias: RetrievableCtor","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/RetrievableCtor.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/RetrievableCtor","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/RetrievableCtor.md\ndescription: >-\n A constructor that builds a {@link @nhtio/adk!Retrievable} from a {@link\n @nhtio/adk/common!RawRetrievable}.\n---\n\n# Type Alias: RetrievableCtor\n\n```ts\ntype RetrievableCtor = (raw: RawRetrievable) => Retrievable;\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L33)\n\nA constructor that builds a [@nhtio/adk!Retrievable](../../../../common/classes/Retrievable.md) from a [@nhtio/adk/common!RawRetrievable](../../../../common/interfaces/RawRetrievable.md).\n\n## Parameters\n\n| Parameter | Type |\n| --------- | ------------------------------------------------------------------- |\n| `raw` | [`RawRetrievable`](../../../../common/interfaces/RawRetrievable.md) |\n\n## Returns\n\n[`Retrievable`](../../../../common/classes/Retrievable.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/SpoolHook","title":"Type Alias: SpoolHook","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/SpoolHook.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/SpoolHook","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tools/web_retrieval/type-aliases/SpoolHook.md\ndescription: >-\n A reader-backed-artifact hook. Called by a converter for content that may be\n large; the converter passes the artifact constructor it **recommends** for\n this content (an open {@link @nhtio/adk/forge!ArtifactConstructorResolver}) so\n the caller can wrap with the right subclass — preserving its forged query\n tools — using the caller's own core import. Return a {@link\n @nhtio/adk!SpooledArtifact} to store the content reader-backed, or `undefined`\n to keep it inline as a string.\n---\n\n# Type Alias: SpoolHook\n\n```ts\ntype SpoolHook = (\n id: string,\n text: string,\n recommended: ArtifactConstructorResolver,\n) => SpooledArtifact | undefined;\n```\n\nDefined in: [src/batteries/tools/web\\_retrieval/index.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tools/web_retrieval/index.ts#L46)\n\nA reader-backed-artifact hook. Called by a converter for content that may be large; the\nconverter passes the artifact constructor it **recommends** for this content (an open\n[@nhtio/adk/forge!ArtifactConstructorResolver](../../../../forge/type-aliases/ArtifactConstructorResolver.md)) so the caller can wrap with the right\nsubclass — preserving its forged query tools — using the caller's own core import. Return a\n[@nhtio/adk!SpooledArtifact](../../../../spooled_artifact/classes/SpooledArtifact.md) to store the content reader-backed, or `undefined` to keep it\ninline as a string.\n\n## Parameters\n\n| Parameter | Type |\n| ------------- | ---------------------------------------------------------------------------------------------- |\n| `id` | `string` |\n| `text` | `string` |\n| `recommended` | [`ArtifactConstructorResolver`](../../../../forge/type-aliases/ArtifactConstructorResolver.md) |\n\n## Returns\n\n| [`SpooledArtifact`](../../../../spooled_artifact/classes/SpooledArtifact.md)\n| `undefined`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts","title":"@nhtio/adk/batteries/tts","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tts.md'\ndescription: >-\n Environment-neutral aggregate barrel for bundled TTS (text-to-speech)\n batteries.\n---\n\n# @nhtio/adk/batteries/tts\n\nEnvironment-neutral aggregate barrel for bundled TTS (text-to-speech) batteries.\n\n## Remarks\n\nThe TTS domain is the inverse of the specialists domain: where specialists turn a modality INTO\ntext (STT/OCR/caption), a TTS engine turns text INTO audio. Each engine normalizes an existing\ntext-to-speech API behind one contract — `synthesize(text, opts?)` → a single\n[@nhtio/adk/batteries/tts/transformers\\_js!GeneratedMediaOutput](../interfaces/GeneratedMediaOutput.md) (`kind: 'audio'`,\n`mimeType: 'audio/wav'`, WAV bytes).\n\nThis barrel re-exports only the **environment-neutral** transformers.js engine (Node + browser,\nONNX Runtime auto-selected — no WebGPU requirement), so it imports cleanly from either Node or the\nbrowser. The **node-only** OS-native engine is reachable only through its own subpath:\n\n* `@nhtio/adk/batteries/tts/native` — node-only (shells out to macOS `say` / Linux `espeak-ng` /\n Windows PowerShell `System.Speech`; imports `node:*` builtins).\n\nDeep-import that subpath when you need it; don't expect it to be re-exported here — the same reason\nthe embeddings aggregate excludes its browser-only WebLLM engine.\n\nThe shared option base is intentionally model-LESS ([BaseTtsAdapterOptions](_shared/interfaces/BaseTtsAdapterOptions.md) carries only\n`voice`/`rate`) because the native engine has no model concept; each model-backed engine adds its\nown required `model`. See `@nhtio/adk/batteries/tts/_shared`.\n\n## References\n\n### BaseTtsAdapterOptions\n\nRe-exports [BaseTtsAdapterOptions](_shared/interfaces/BaseTtsAdapterOptions.md)\n\n***\n\n### CreateTransformersJsTtsPipeline\n\nRe-exports [CreateTransformersJsTtsPipeline](transformers_js/types/type-aliases/CreateTransformersJsTtsPipeline.md)\n\n***\n\n### E\\_INVALID\\_TRANSFORMERS\\_JS\\_TTS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_TRANSFORMERS\\_JS\\_TTS\\_OPTIONS](transformers_js/exceptions/variables/E_INVALID_TRANSFORMERS_JS_TTS_OPTIONS.md)\n\n***\n\n### E\\_TRANSFORMERS\\_JS\\_TTS\\_ENGINE\\_ERROR\n\nRe-exports [E\\_TRANSFORMERS\\_JS\\_TTS\\_ENGINE\\_ERROR](transformers_js/exceptions/variables/E_TRANSFORMERS_JS_TTS_ENGINE_ERROR.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### RawAudioLike\n\nRe-exports [RawAudioLike](_shared/interfaces/RawAudioLike.md)\n\n***\n\n### SynthesizeOptions\n\nRe-exports [SynthesizeOptions](_shared/interfaces/SynthesizeOptions.md)\n\n***\n\n### TransformersJsSynthesizeOptions\n\nRe-exports [TransformersJsSynthesizeOptions](transformers_js/types/interfaces/TransformersJsSynthesizeOptions.md)\n\n***\n\n### TransformersJsTtsAdapter\n\nRe-exports [TransformersJsTtsAdapter](transformers_js/adapter/classes/TransformersJsTtsAdapter.md)\n\n***\n\n### TransformersJsTtsAdapterOptions\n\nRe-exports [TransformersJsTtsAdapterOptions](transformers_js/types/interfaces/TransformersJsTtsAdapterOptions.md)\n\n***\n\n### TransformersJsTtsDataType\n\nRe-exports [TransformersJsTtsDataType](transformers_js/types/type-aliases/TransformersJsTtsDataType.md)\n\n***\n\n### TransformersJsTtsDeviceType\n\nRe-exports [TransformersJsTtsDeviceType](transformers_js/types/type-aliases/TransformersJsTtsDeviceType.md)\n\n***\n\n### TransformersJsTtsModelSource\n\nRe-exports [TransformersJsTtsModelSource](transformers_js/types/type-aliases/TransformersJsTtsModelSource.md)\n\n***\n\n### transformersJsTtsOptionsSchema\n\nRe-exports [transformersJsTtsOptionsSchema](transformers_js/validation/variables/transformersJsTtsOptionsSchema.md)\n\n***\n\n### TransformersJsTtsPipeline\n\nRe-exports [TransformersJsTtsPipeline](transformers_js/types/type-aliases/TransformersJsTtsPipeline.md)\n\n***\n\n### TransformersJsTtsProgressCallback\n\nRe-exports [TransformersJsTtsProgressCallback](transformers_js/types/type-aliases/TransformersJsTtsProgressCallback.md)\n\n***\n\n### TransformersJsTtsSpeakerEmbeddings\n\nRe-exports [TransformersJsTtsSpeakerEmbeddings](transformers_js/types/type-aliases/TransformersJsTtsSpeakerEmbeddings.md)\n\n***\n\n### TtsSynthesisResult\n\nRe-exports [TtsSynthesisResult](_shared/type-aliases/TtsSynthesisResult.md)\n\n***\n\n### validateTransformersJsTtsOptions\n\nRenames and re-exports [validateOptions](transformers_js/validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared","title":"@nhtio/adk/batteries/tts/\\_shared","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tts/_shared.md'\ndescription: >-\n Structural contracts shared across every TTS (text-to-speech) engine — the\n model-backed transformers.js engine and the OS-native CLI engine both build on\n these.\n---\n\n# @nhtio/adk/batteries/tts/\\_shared\n\nStructural contracts shared across every TTS (text-to-speech) engine — the model-backed\ntransformers.js engine and the OS-native CLI engine both build on these.\n\n## Remarks\n\nThis module owns the **shared** TTS option base ([BaseTtsAdapterOptions](interfaces/BaseTtsAdapterOptions.md)) and the shared\nper-call shape ([SynthesizeOptions](interfaces/SynthesizeOptions.md)), plus the audio-result contract\n([RawAudioLike](interfaces/RawAudioLike.md)). It lives in `_shared` — NOT inside any one engine — deliberately: the\nnative engine is model-less while the transformers.js engine requires a model, so neither engine\n\"owns\" the common base. A future non-transformers engine can extend this base without importing a\ntransformer-named subpath.\n\n`model` is intentionally **absent** from [BaseTtsAdapterOptions](interfaces/BaseTtsAdapterOptions.md): the OS-native engine\nsynthesizes through `say`/`espeak-ng`/PowerShell and has no model concept, so each model-backed\nengine adds its own required `model` field rather than the base forcing one. Do not \"fix\" this by\nhoisting `model` into the base — it is a deliberate divergence from the embeddings/generation\ndomains (whose bases require `model`).\n\n## Interfaces\n\n| Interface | Description |\n| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [BaseTtsAdapterOptions](interfaces/BaseTtsAdapterOptions.md) | Options shared by **every** TTS engine, regardless of backend. |\n| [RawAudioLike](interfaces/RawAudioLike.md) | The minimal structural slice of transformers.js's `RawAudio` the TTS engine consumes: a single `toBlob()` that encodes the synthesized samples to a WAV `Blob`. |\n| [SynthesizeOptions](interfaces/SynthesizeOptions.md) | Per-call options accepted by every engine's `synthesize`. Engine-specific per-call option interfaces extend this with their own knobs. |\n\n## Type Aliases\n\n| Type Alias | Description |\n| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [TtsSynthesisResult](type-aliases/TtsSynthesisResult.md) | The synthesized-audio result every TTS engine resolves to — an alias of the shared [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md) descriptor, always `kind: 'audio'` in practice. |\n\n## References\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/BaseTtsAdapterOptions","title":"Interface: BaseTtsAdapterOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/BaseTtsAdapterOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/BaseTtsAdapterOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/_shared/interfaces/BaseTtsAdapterOptions.md\ndescription: 'Options shared by **every** TTS engine, regardless of backend.'\n---\n\n# Interface: BaseTtsAdapterOptions\n\nDefined in: [src/batteries/tts/\\_shared/index.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L51)\n\nOptions shared by **every** TTS engine, regardless of backend.\n\n## Remarks\n\nEngine-specific option interfaces extend this with their own transport/engine fields (and, for\nmodel-backed engines, a required `model`). Both fields are normalized per-engine:\n\n* `voice` → `say -v ` / `espeak-ng -v ` / PowerShell `SelectVoice()` /\n transformers.js `speaker_embeddings` when it is a string.\n* `rate` is a **multiplier** where `1` is engine-normal, mapped per engine: `round(175 * rate)`\n words-per-minute for `say`/`espeak-ng` (clamped to a validated band), the documented `-10..10`\n `SpeechSynthesizer.Rate` for PowerShell, and `speed` for transformers.js.\n\n## Extended by\n\n* [`TransformersJsTtsAdapterOptions`](../../transformers_js/types/interfaces/TransformersJsTtsAdapterOptions.md)\n* [`NativeTtsAdapterOptions`](../../native/types/interfaces/NativeTtsAdapterOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| `rate?` | `number` | Default speaking-rate multiplier (`1` = engine-normal), applied when a `synthesize` call omits its own `rate`. Per-engine mapping (see the module remarks). Unset → engine-normal rate. | [src/batteries/tts/\\_shared/index.ts:61](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L61) |\n| `voice?` | `string` | Default voice, applied when a `synthesize` call omits its own `voice`. Per-engine semantics (see the module remarks). Unset → the engine/model default voice. | [src/batteries/tts/\\_shared/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L56) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/RawAudioLike","title":"Interface: RawAudioLike","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/RawAudioLike.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/RawAudioLike","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/_shared/interfaces/RawAudioLike.md\ndescription: >-\n The minimal structural slice of transformers.js's `RawAudio` the TTS engine\n consumes: a single `toBlob()` that encodes the synthesized samples to a WAV\n `Blob`.\n---\n\n# Interface: RawAudioLike\n\nDefined in: [src/batteries/tts/\\_shared/index.ts:89](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L89)\n\nThe minimal structural slice of transformers.js's `RawAudio` the TTS engine consumes: a single\n`toBlob()` that encodes the synthesized samples to a WAV `Blob`.\n\n## Remarks\n\ntransformers.js `RawAudio.toBlob()` calls its internal `encodeWAV()` — a pure\n`ArrayBuffer`/`DataView`/`Blob` path with `type: 'audio/wav'` — so it works in Node (Node ≥18 has\na global `Blob`) as well as the browser; it is NOT the browser-only path that `RawImage.toBlob()`\nguards. `toBlob()` is the ONLY method the engine needs (it never reads raw `audio`/`sampling_rate`),\nso this contract carries `toBlob` alone — the fake pipeline in unit tests implements exactly this.\n\n## Methods\n\n### toBlob()\n\n```ts\ntoBlob(): Blob;\n```\n\nDefined in: [src/batteries/tts/\\_shared/index.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L91)\n\nEncode the synthesized audio to a WAV `Blob` (`type: 'audio/wav'`).\n\n#### Returns\n\n`Blob`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/SynthesizeOptions","title":"Interface: SynthesizeOptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/SynthesizeOptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/interfaces/SynthesizeOptions","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/_shared/interfaces/SynthesizeOptions.md\ndescription: >-\n Per-call options accepted by every engine's `synthesize`. Engine-specific\n per-call option interfaces extend this with their own knobs.\n---\n\n# Interface: SynthesizeOptions\n\nDefined in: [src/batteries/tts/\\_shared/index.ts:71](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L71)\n\nPer-call options accepted by every engine's `synthesize`. Engine-specific per-call option\ninterfaces extend this with their own knobs.\n\n## Remarks\n\nBoth fields override the constructor-level default of the same name for this one call.\n\n## Extended by\n\n* [`TransformersJsSynthesizeOptions`](../../transformers_js/types/interfaces/TransformersJsSynthesizeOptions.md)\n* [`NativeSynthesizeOptions`](../../native/types/interfaces/NativeSynthesizeOptions.md)\n\n## Properties\n\n| Property | Type | Description | Defined in |\n| ------------------------------------ | -------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| `rate?` | `number` | Speaking-rate multiplier for this call; overrides the constructor `rate`. | [src/batteries/tts/\\_shared/index.ts:75](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L75) |\n| `voice?` | `string` | Voice for this call; overrides the constructor `voice`. | [src/batteries/tts/\\_shared/index.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L73) |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/type-aliases/TtsSynthesisResult","title":"Type Alias: TtsSynthesisResult","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/type-aliases/TtsSynthesisResult.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/_shared/type-aliases/TtsSynthesisResult","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/_shared/type-aliases/TtsSynthesisResult.md\ndescription: >-\n The synthesized-audio result every TTS engine resolves to — an alias of the\n shared [`GeneratedMediaOutput`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/GeneratedMediaOutput) descriptor, always `kind: 'audio'` in\n practice.\n---\n\n# Type Alias: TtsSynthesisResult\n\n```ts\ntype TtsSynthesisResult = GeneratedMediaOutput;\n```\n\nDefined in: [src/batteries/tts/\\_shared/index.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/_shared/index.ts#L36)\n\nThe synthesized-audio result every TTS engine resolves to — an alias of the shared\n[GeneratedMediaOutput](../../../interfaces/GeneratedMediaOutput.md) descriptor, always `kind: 'audio'` in practice.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native","title":"@nhtio/adk/batteries/tts/native","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tts/native.md'\ndescription: >-\n OS-native TTS (text-to-speech) battery — shells out to the OS's own speech\n binary.\n---\n\n# @nhtio/adk/batteries/tts/native\n\nOS-native TTS (text-to-speech) battery — shells out to the OS's own speech binary.\n\n## Remarks\n\n**Node-only.** This subpath barrel imports node builtins (`node:child_process`, `node:fs/promises`,\n`node:os`, `node:crypto`, `node:path`) — lazily, inside adapter methods — and will NOT load in a\nbrowser or Web Worker bundle. Deliberately, unlike the environment-neutral\n`@nhtio/adk/batteries/tts/transformers_js` barrel (which stays browser-loadable), this engine is\nmodel-less and shells out to the platform's own speech binary (`say` / `espeak-ng` / PowerShell\n`System.Speech`), reading back the WAV it writes. Import this subpath only from node-only entry\npoints (a server process, a build script, a node-targeted worker) — never from code that might\nalso run in a browser.\n\nRe-exports the adapter class, the validation schema + bare `validateOptions` wrapper, the pure\ninvocation builders (`buildNativeTtsInvocation` + `psSingleQuotedLiteral`), every option/seam type\nalias, and the four battery-scoped exceptions.\n\n## References\n\n### BaseTtsAdapterOptions\n\nRe-exports [BaseTtsAdapterOptions](../_shared/interfaces/BaseTtsAdapterOptions.md)\n\n***\n\n### buildNativeTtsInvocation\n\nRe-exports [buildNativeTtsInvocation](helpers/functions/buildNativeTtsInvocation.md)\n\n***\n\n### E\\_INVALID\\_NATIVE\\_TTS\\_OPTIONS\n\nRe-exports [E\\_INVALID\\_NATIVE\\_TTS\\_OPTIONS](exceptions/variables/E_INVALID_NATIVE_TTS_OPTIONS.md)\n\n***\n\n### E\\_NATIVE\\_TTS\\_ENGINE\\_ERROR\n\nRe-exports [E\\_NATIVE\\_TTS\\_ENGINE\\_ERROR](exceptions/variables/E_NATIVE_TTS_ENGINE_ERROR.md)\n\n***\n\n### E\\_NATIVE\\_TTS\\_TIMEOUT\n\nRe-exports [E\\_NATIVE\\_TTS\\_TIMEOUT](exceptions/variables/E_NATIVE_TTS_TIMEOUT.md)\n\n***\n\n### E\\_NATIVE\\_TTS\\_UNSUPPORTED\\_PLATFORM\n\nRe-exports [E\\_NATIVE\\_TTS\\_UNSUPPORTED\\_PLATFORM](exceptions/variables/E_NATIVE_TTS_UNSUPPORTED_PLATFORM.md)\n\n***\n\n### GeneratedMediaOutput\n\nRe-exports [GeneratedMediaOutput](../../interfaces/GeneratedMediaOutput.md)\n\n***\n\n### NativeSynthesizeOptions\n\nRe-exports [NativeSynthesizeOptions](types/interfaces/NativeSynthesizeOptions.md)\n\n***\n\n### NativeTtsAdapter\n\nRe-exports [NativeTtsAdapter](adapter/classes/NativeTtsAdapter.md)\n\n***\n\n### NativeTtsAdapterOptions\n\nRe-exports [NativeTtsAdapterOptions](types/interfaces/NativeTtsAdapterOptions.md)\n\n***\n\n### nativeTtsOptionsSchema\n\nRe-exports [nativeTtsOptionsSchema](validation/variables/nativeTtsOptionsSchema.md)\n\n***\n\n### NativeTtsPlatform\n\nRe-exports [NativeTtsPlatform](types/type-aliases/NativeTtsPlatform.md)\n\n***\n\n### psSingleQuotedLiteral\n\nRe-exports [psSingleQuotedLiteral](helpers/functions/psSingleQuotedLiteral.md)\n\n***\n\n### SynthesizeOptions\n\nRe-exports [SynthesizeOptions](../_shared/interfaces/SynthesizeOptions.md)\n\n***\n\n### TtsBinaryExecutor\n\nRe-exports [TtsBinaryExecutor](types/interfaces/TtsBinaryExecutor.md)\n\n***\n\n### TtsBinaryExecutorResult\n\nRe-exports [TtsBinaryExecutorResult](types/interfaces/TtsBinaryExecutorResult.md)\n\n***\n\n### TtsFsLike\n\nRe-exports [TtsFsLike](types/interfaces/TtsFsLike.md)\n\n***\n\n### TtsSynthesisResult\n\nRe-exports [TtsSynthesisResult](../_shared/type-aliases/TtsSynthesisResult.md)\n\n***\n\n### validateOptions\n\nRe-exports [validateOptions](validation/functions/validateOptions.md)\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/adapter","title":"@nhtio/adk/batteries/tts/native/adapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/adapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/adapter","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/adapter.md'\ndescription: >-\n OS-native TTS (text-to-speech) adapter battery — shells out to the platform's\n own speech binary.\n---\n\n# @nhtio/adk/batteries/tts/native/adapter\n\nOS-native TTS (text-to-speech) adapter battery — shells out to the platform's own speech binary.\n\n## Remarks\n\n**Node-only.** This adapter synthesizes by shelling out to the operating system's own speech\nbinary — macOS `say`, Linux `espeak-ng`, or Windows PowerShell `System.Speech` — and reading back\nthe WAV file it writes. It is model-less: it extends the shared BaseTtsAdapterOptions\n(`voice`/`rate`) but adds NO `model` field. Every `node:*` import is a LAZY dynamic import inside a\nmethod, so constructing and validating the adapter never touches node builtins and unit tests stay\nhermetic (zero `child_process`, zero `fs`, zero real files).\n\nThe shell-out and filesystem access are fully injectable: [NativeTtsAdapterOptions.executor](../types/interfaces/NativeTtsAdapterOptions.md#property-executor)\n(default: a lazy `node:child_process` `execFile` wrapper with an `AbortController` enforcing the\ntimeout), [NativeTtsAdapterOptions.fs](../types/interfaces/NativeTtsAdapterOptions.md#property-fs) (default: `node:fs/promises`), plus\n[NativeTtsAdapterOptions.tmpdir](../types/interfaces/NativeTtsAdapterOptions.md#property-tmpdir) / [NativeTtsAdapterOptions.randomName](../types/interfaces/NativeTtsAdapterOptions.md#property-randomname) seams for the\nscratch output path. The flow mirrors the media domain's `soffice` engine — build args, exec,\nread the output file, finally clean up — but this engine controls its own output path directly\n(it does NOT depend on the media domain's `ScratchWorkspace`).\n\nResult classification is from the executor's FLAGS, never inferred from exit code or stderr (a\ntimeout, a signal kill, and a non-zero CLI exit are indistinguishable from those signals alone):\n`result.timedOut` → `E_NATIVE_TTS_TIMEOUT` (504); else `result.failed` →\n`E_NATIVE_TTS_ENGINE_ERROR` (502). The read-back WAV is hard-validated against the RIFF/WAVE\nmagic — a payload missing that magic throws `E_NATIVE_TTS_ENGINE_ERROR`.\n\n## Classes\n\n| Class | Description |\n| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [NativeTtsAdapter](classes/NativeTtsAdapter.md) | TTS adapter that shells out to the OS's own speech binary. Reusable: construct once, call [NativeTtsAdapter.synthesize](classes/NativeTtsAdapter.md#synthesize) as many times as needed. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/adapter/classes/NativeTtsAdapter","title":"Class: NativeTtsAdapter","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/adapter/classes/NativeTtsAdapter.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/adapter/classes/NativeTtsAdapter","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/adapter/classes/NativeTtsAdapter.md\ndescription: >-\n TTS adapter that shells out to the OS's own speech binary. Reusable: construct\n once, call [`NativeTtsAdapter.synthesize`](https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/adapter/classes/NativeTtsAdapter#synthesize) as many times as needed.\n---\n\n# Class: NativeTtsAdapter\n\nDefined in: [src/batteries/tts/native/adapter.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/adapter.ts#L65)\n\nTTS adapter that shells out to the OS's own speech binary. Reusable: construct once, call\n[NativeTtsAdapter.synthesize](#synthesize) as many times as needed.\n\n## Remarks\n\nA zero-config `new NativeTtsAdapter()` is valid — it auto-detects the platform from\n`process.platform` at `synthesize` time and resolves the default executor / fs / scratch-path\nseams lazily.\n\n## Constructors\n\n### Constructor\n\n```ts\nnew NativeTtsAdapter(options?: unknown): NativeTtsAdapter;\n```\n\nDefined in: [src/batteries/tts/native/adapter.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/adapter.ts#L86)\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `options` | `unknown` | Constructor options. **All optional**; validated eagerly against [@nhtio/adk/batteries/tts/native!nativeTtsOptionsSchema](../../validation/variables/nativeTtsOptionsSchema.md). Pass `undefined` for zero-config. |\n\n#### Returns\n\n`NativeTtsAdapter`\n\n#### Throws\n\n[@nhtio/adk/batteries/tts/native!E\\_INVALID\\_NATIVE\\_TTS\\_OPTIONS](../../exceptions/variables/E_INVALID_NATIVE_TTS_OPTIONS.md) when invalid.\n\n## Methods\n\n### isAvailable()\n\n```ts\nisAvailable(): boolean;\n```\n\nDefined in: [src/batteries/tts/native/adapter.ts:91](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/adapter.ts#L91)\n\nInstance availability probe (honours an injected `isAvailable`).\n\n#### Returns\n\n`boolean`\n\n***\n\n### preload()\n\n```ts\npreload(): Promise;\n```\n\nDefined in: [src/batteries/tts/native/adapter.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/adapter.ts#L96)\n\nNo-op. The native engine has nothing to preload — the binary is invoked fresh per call.\n\n#### Returns\n\n`Promise`<`void`>\n\n***\n\n### reset()\n\n```ts\nreset(): void;\n```\n\nDefined in: [src/batteries/tts/native/adapter.ts:101](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/adapter.ts#L101)\n\nNo-op. The native engine holds no state between calls to reset.\n\n#### Returns\n\n`void`\n\n***\n\n### synthesize()\n\n```ts\nsynthesize(text: string, opts?: NativeSynthesizeOptions): Promise;\n```\n\nDefined in: [src/batteries/tts/native/adapter.ts:204](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/adapter.ts#L204)\n\nSynthesizes text into a WAV audio clip.\n\n#### Parameters\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |\n| `text` | `string` | The text to speak. Passed verbatim as the final positional arg / PowerShell literal. |\n| `opts?` | [`NativeSynthesizeOptions`](../../types/interfaces/NativeSynthesizeOptions.md) | Per-call options; each field overrides the constructor default of the same name. |\n\n#### Returns\n\n`Promise`<[`GeneratedMediaOutput`](../../../../interfaces/GeneratedMediaOutput.md)>\n\nA [GeneratedMediaOutput](../../../../interfaces/GeneratedMediaOutput.md) descriptor with `kind: 'audio'`, `mimeType: 'audio/wav'`,\nthe WAV bytes, and `filename: 'speech.wav'`.\n\n#### Remarks\n\nResolves the platform (constructor `platform` or `process.platform`), the effective\nvoice/rate/pitch (per-call overrides ctor), the words-per-minute (for `say`/`espeak-ng`) and\nthe `-10..10` PowerShell rate (for win32), then shells out via the executor, reads the scratch\nWAV back, hard-validates the RIFF/WAVE magic, and unlinks the scratch file in a `finally`.\n\n#### Throws\n\n[@nhtio/adk/batteries/tts/native!E\\_NATIVE\\_TTS\\_UNSUPPORTED\\_PLATFORM](../../exceptions/variables/E_NATIVE_TTS_UNSUPPORTED_PLATFORM.md) when the\nresolved platform is not `darwin`/`linux`/`win32`.\n\n#### Throws\n\n[@nhtio/adk/batteries/tts/native!E\\_NATIVE\\_TTS\\_TIMEOUT](../../exceptions/variables/E_NATIVE_TTS_TIMEOUT.md) when the binary is aborted\nfor exceeding `timeoutMs` (default 60\\_000 ms).\n\n#### Throws\n\n[@nhtio/adk/batteries/tts/native!E\\_NATIVE\\_TTS\\_ENGINE\\_ERROR](../../exceptions/variables/E_NATIVE_TTS_ENGINE_ERROR.md) when the binary fails,\nproduces no output, or yields bytes that are not a RIFF/WAVE file.\n\n***\n\n### isAvailable()\n\n```ts\nstatic isAvailable(): boolean;\n```\n\nDefined in: [src/batteries/tts/native/adapter.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/adapter.ts#L73)\n\nWhether this battery is available. `true` whenever a Node `process` is present on a supported\n[NativeTtsPlatform](../../types/type-aliases/NativeTtsPlatform.md) — the engine itself is the platform's own binary, so there is no peer\ndependency to probe.\n\n#### Returns\n\n`boolean`\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions","title":"@nhtio/adk/batteries/tts/native/exceptions","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/exceptions.md'\ndescription: Battery-scoped exception constructors for the OS-native TTS adapter.\n---\n\n# @nhtio/adk/batteries/tts/native/exceptions\n\nBattery-scoped exception constructors for the OS-native TTS adapter.\n\n## Remarks\n\nBattery-scoped exception classes for the model-less, shell-out OS-native text-to-speech adapter\n(macOS `say` / Linux `espeak-ng` / Windows PowerShell `System.Speech`), minted via `createException`\nfrom `@nhtio/adk/factories`. Two categories are fatal config/contract bugs (invalid options,\nunsupported platform — both 529); two are non-fatal runtime failures (engine error 502, timeout 504) so a caller may retry with a different voice/rate or fall back to another TTS engine.\n\n## Variables\n\n| Variable | Description |\n| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [E\\_INVALID\\_NATIVE\\_TTS\\_OPTIONS](variables/E_INVALID_NATIVE_TTS_OPTIONS.md) | Thrown when the resolved adapter options fail validation against [@nhtio/adk/batteries/tts/native!nativeTtsOptionsSchema](../validation/variables/nativeTtsOptionsSchema.md) — e.g. an unknown option key, a non-numeric `rate`, or a `platform` outside the supported set. Fatal: config bugs fail loud, not at `synthesize` time. Printf arg: `[detail]`. |\n| [E\\_NATIVE\\_TTS\\_ENGINE\\_ERROR](variables/E_NATIVE_TTS_ENGINE_ERROR.md) | Thrown when the OS-native binary invocation fails (non-zero exit / spawn error / empty or missing output file / a result that is not a RIFF/WAVE file). Non-fatal: the engine itself may be transiently unavailable, or a particular voice/rate combination may be rejected by the binary; retry or fall back to another TTS engine. Printf arg: `[detail]` (stderr on failure, otherwise a structural message such as `expected a RIFF/WAVE file`). |\n| [E\\_NATIVE\\_TTS\\_TIMEOUT](variables/E_NATIVE_TTS_TIMEOUT.md) | Thrown when the binary invocation is aborted for exceeding [@nhtio/adk/batteries/tts/native!NativeTtsAdapterOptions.timeoutMs](../types/interfaces/NativeTtsAdapterOptions.md#property-timeoutms). Non-fatal: a slow engine on a long text may simply need more time; the caller may raise `timeoutMs` and retry. Printf arg: `[timeoutMs]`. |\n| [E\\_NATIVE\\_TTS\\_UNSUPPORTED\\_PLATFORM](variables/E_NATIVE_TTS_UNSUPPORTED_PLATFORM.md) | Thrown when the resolved `platform` is not one of [@nhtio/adk/batteries/tts/native!NativeTtsPlatform](../types/type-aliases/NativeTtsPlatform.md) (`darwin`/`linux`/`win32`). Fatal: there is no engine binary to shell out to on any other platform, so synthesis cannot proceed. Printf arg: `[platform]`. |\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_INVALID_NATIVE_TTS_OPTIONS","title":"Variable: E\\_INVALID\\_NATIVE\\_TTS\\_OPTIONS","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_INVALID_NATIVE_TTS_OPTIONS.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_INVALID_NATIVE_TTS_OPTIONS","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_INVALID_NATIVE_TTS_OPTIONS.md\ndescription: >-\n Thrown when the resolved adapter options fail validation against {@link\n @nhtio/adk/batteries/tts/native!nativeTtsOptionsSchema} — e.g. an unknown\n option key, a non-numeric `rate`, or a `platform` outside the supported set.\n Fatal: config bugs fail loud, not at `synthesize` time. Printf arg:\n `[detail]`.\n---\n\n# Variable: E\\_INVALID\\_NATIVE\\_TTS\\_OPTIONS\n\n```ts\nconst E_INVALID_NATIVE_TTS_OPTIONS: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/tts/native/exceptions.ts:22](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/exceptions.ts#L22)\n\nThrown when the resolved adapter options fail validation against\n[@nhtio/adk/batteries/tts/native!nativeTtsOptionsSchema](../../validation/variables/nativeTtsOptionsSchema.md) — e.g. an unknown option key, a\nnon-numeric `rate`, or a `platform` outside the supported set. Fatal: config bugs fail loud, not\nat `synthesize` time. Printf arg: `[detail]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_ENGINE_ERROR","title":"Variable: E\\_NATIVE\\_TTS\\_ENGINE\\_ERROR","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_ENGINE_ERROR.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_ENGINE_ERROR","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_ENGINE_ERROR.md\ndescription: >-\n Thrown when the OS-native binary invocation fails (non-zero exit / spawn error\n / empty or missing output file / a result that is not a RIFF/WAVE file).\n Non-fatal: the engine itself may be transiently unavailable, or a particular\n voice/rate combination may be rejected by the binary; retry or fall back to\n another TTS engine. Printf arg: `[detail]` (stderr on failure, otherwise a\n structural message such as `expected a RIFF/WAVE file`).\n---\n\n# Variable: E\\_NATIVE\\_TTS\\_ENGINE\\_ERROR\n\n```ts\nconst E_NATIVE_TTS_ENGINE_ERROR: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/tts/native/exceptions.ts:51](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/exceptions.ts#L51)\n\nThrown when the OS-native binary invocation fails (non-zero exit / spawn error / empty or missing\noutput file / a result that is not a RIFF/WAVE file). Non-fatal: the engine itself may be\ntransiently unavailable, or a particular voice/rate combination may be rejected by the binary;\nretry or fall back to another TTS engine. Printf arg: `[detail]` (stderr on failure, otherwise a\nstructural message such as `expected a RIFF/WAVE file`).\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_TIMEOUT","title":"Variable: E\\_NATIVE\\_TTS\\_TIMEOUT","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_TIMEOUT.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_TIMEOUT","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_TIMEOUT.md\ndescription: >-\n Thrown when the binary invocation is aborted for exceeding {@link\n @nhtio/adk/batteries/tts/native!NativeTtsAdapterOptions.timeoutMs}. Non-fatal:\n a slow engine on a long text may simply need more time; the caller may raise\n `timeoutMs` and retry. Printf arg: `[timeoutMs]`.\n---\n\n# Variable: E\\_NATIVE\\_TTS\\_TIMEOUT\n\n```ts\nconst E_NATIVE_TTS_TIMEOUT: CreatedException<[number]>;\n```\n\nDefined in: [src/batteries/tts/native/exceptions.ts:65](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/exceptions.ts#L65)\n\nThrown when the binary invocation is aborted for exceeding\n[@nhtio/adk/batteries/tts/native!NativeTtsAdapterOptions.timeoutMs](../../types/interfaces/NativeTtsAdapterOptions.md#property-timeoutms). Non-fatal: a slow\nengine on a long text may simply need more time; the caller may raise `timeoutMs` and retry.\nPrintf arg: `[timeoutMs]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_UNSUPPORTED_PLATFORM","title":"Variable: E\\_NATIVE\\_TTS\\_UNSUPPORTED\\_PLATFORM","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_UNSUPPORTED_PLATFORM.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_UNSUPPORTED_PLATFORM","content":"---\nurl: >-\n https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/exceptions/variables/E_NATIVE_TTS_UNSUPPORTED_PLATFORM.md\ndescription: >-\n Thrown when the resolved `platform` is not one of {@link\n @nhtio/adk/batteries/tts/native!NativeTtsPlatform} (`darwin`/`linux`/`win32`).\n Fatal: there is no engine binary to shell out to on any other platform, so\n synthesis cannot proceed. Printf arg: `[platform]`.\n---\n\n# Variable: E\\_NATIVE\\_TTS\\_UNSUPPORTED\\_PLATFORM\n\n```ts\nconst E_NATIVE_TTS_UNSUPPORTED_PLATFORM: CreatedException<[string]>;\n```\n\nDefined in: [src/batteries/tts/native/exceptions.ts:36](https://github.com/NHTIO/ADK/blob/v1.20260921.0/src/src/batteries/tts/native/exceptions.ts#L36)\n\nThrown when the resolved `platform` is not one of [@nhtio/adk/batteries/tts/native!NativeTtsPlatform](../../types/type-aliases/NativeTtsPlatform.md) (`darwin`/`linux`/`win32`). Fatal: there is no\nengine binary to shell out to on any other platform, so synthesis cannot proceed. Printf arg:\n`[platform]`.\n"},{"id":"doc:.vitepress/dist/api/@nhtio/adk/batteries/tts/native/helpers","title":"@nhtio/adk/batteries/tts/native/helpers","kind":"doc","path":"docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/helpers.md","uri":"adk://docs/.vitepress/dist/api/@nhtio/adk/batteries/tts/native/helpers","content":"---\nurl: 'https://adk.nht.io/api/@nhtio/adk/batteries/tts/native/helpers.md'\ndescription: >-\n Pure invocation builders for the OS-native TTS adapter — the platform-specific\n argument arrays the adapter shells out with. This module is the hermetic,\n unit-tested core: NO node builtins, NO I/O.\n---\n\n# @nhtio/adk/batteries/tts/native/helpers\n\nPure invocation builders for the OS-native TTS adapter — the platform-specific argument arrays the\nadapter shells out with. This module is the hermetic, unit-tested core: NO node builtins, NO I/O.\n\n## Remarks\n\n`buildNativeTtsInvocation` is the pure function that turns a resolved platform + text + output\npath + optional voice/rate/pitch into the `{ cmd, args }` pair the executor runs, per platform:\n\n* **darwin**: `say -o --data-format=LEI16@22050 [...extraArgs] [-v ] [-r ] `.\n `--data-format=LEI16@22050` makes `say` emit real 16-bit little-endian PCM WAV at 22050 Hz rather\n than its default AIFF, so the adapter can assert the RIFF/WAVE magic on every byte payload.\n* **linux**: `espeak-ng -w [...extraArgs] [-v ] [-s ] [-p ] `.\n* **win32**: `powershell.exe -NoProfile -NonInteractive -Command