@nhtio/adk/batteries
Opt-in aggregate barrel for bundled ADK batteries across LLMs, tools, and storage.
Remarks
Opt-in bundled tools that ship with the ADK. This barrel is not re-exported from the root entry — consumers must explicitly import { ... } from '@nhtio/adk/batteries' to use these tools, and consumers who do not import this barrel pay nothing in their bundle.
The barrel is a plain re-export of every category. Finer-grained subpaths exist for tree-shaking:
@nhtio/adk/batteries/tools— every tool, identical to this barrel@nhtio/adk/batteries/tools/<category>— just one category (e.g.math,color,datetime_math)
Each export is a pre-constructed @nhtio/adk!Tool instance ready to be registered with a ToolRegistry. The ADK has no opinion on storage — the consumer's executor middleware is responsible for persisting tool output and assembling the ToolCall.results field using each tool's artifactConstructor.
Need every bundled tool? import * as batteries from '@nhtio/adk/batteries' then Object.values(batteries). Need just one category? Deep-import the subpath and pay only for that bundle.
Classes
| Class | Description |
|---|---|
| GuestEndpoint | Guest-side correlation engine over a PortLike. Owns per-call AbortControllers (aborted on an inbound abort/stream:cancel envelope) and exposes settleCall/pushDelta/endStream/ errorStream for serve.ts to report outcomes back across the wire. |
| HostEndpoint | Host-side correlation engine over a PortLike. 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). |
| TransformersJsSttAdapter | STT adapter for transformers.js's automatic-speech-recognition (Whisper-family) pipeline. |
Interfaces
| Interface | Description | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | BrowserErrorEvent | 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. | | BrowserMessageEvent | Minimal subset of the DOM MessageEvent interface this module touches. | | BrowserWorker | Minimal subset of the DOM Worker interface this module touches. Structurally compatible with the real DOM Worker — callers (and WorkerResolver implementations) pass/construct real Worker instances directly. | | BrowserWorkerOptions | Minimal subset of the DOM WorkerOptions dictionary this module forwards verbatim to new Worker(url, options) — used ONLY for the string | URLspawn form (a caller-supplied WorkerResolver constructs its ownWorker 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 callsimportScripts(), illegal in a module worker. Pass { type: 'module' } explicitly when the guest script is an ES module. | | ChatCompletionsRetryConfig | Retry/backoff configuration for a Chat-family battery's HTTP requests. | | ChatCompletionsTool | Wire shape of a single function tool advertised to the model — identical for OpenAI Chat Completions and Ollama. | | CrashInfo | Information about a crashed isolated guest, reported via IsolationTransport.onCrash. | | CrashPolicy | A sliding-window crash-escalation decider, as returned by createCrashPolicy. | | CrashPolicyOptions | Options accepted by createCrashPolicy. | | DescriptionLike | 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. | | EncoderModule | 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 <T extends Encodable>-constrained signature is narrowed away via defaultEncoderLoader's adapter rather than reflected here. | | EventDescriptor | An event descriptor produced by event. Phantom-typed like MethodDescriptor. | | GeneratedMediaOutput | One piece of media a model GENERATED as turn output — the descriptor a MediaOutputExtractorFn returns for the adapter to persist + attach to the assistant @nhtio/adk!Message. | | GuestEndpointHooks | Hooks GuestEndpoint invokes for the guest server (serve.ts) to react to. | | HostEndpointHooks | Hooks HostEndpoint invokes on protocol-level events; host.ts wires these to the observability layer + guest-event fan-out. All optional. | | IsolatedFunctionHandle | The live handle returned by isolateFunction. | | IsolatedService | The host-side handle createIsolatedService returns. | | IsolatedServiceOptions | Options accepted by createIsolatedService. | | IsolatedServiceSpec | A fully-resolved isolated-service spec, as returned by defineIsolatedService. 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). | | IsolatedServiceSpecInput | Input shape accepted by defineIsolatedService. | | IsolateFunctionOptions | Options accepted by isolateFunction. | | IsolationCallContext | 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. | | IsolationObservabilityHooks | The opt-in observability option block mixed into createIsolatedService/serveIsolated options. Every reported phase fires 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. | | IsolationReport | 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 for which extra fields a given phase populates). | | IsolationTransport | The environment-specific spawn/lifecycle duck a host-side transport implements — WP2 (Web Worker) and WP3 (node child_process) each provide one; createIsolatedService (host.ts) drives only this interface, never a concrete Worker/ChildProcess type. | | JsonSchema | The subset of JSON Schema that Chat-family tool/function parameters accept, as emitted by ChatHelpersCommon.descriptionToChatCompletionsJsonSchema. The index signature allows extra keywords to pass through to the wire. | | MemoryAttrs | Attribute bag rendered onto a memory block. | | MethodDescriptor | A method descriptor produced by method. 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. | | MethodOptions | Runtime options accepted by method. | | PortLike | 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 — WP1 exercises it only against linked in-memory fake ports; WP2/WP3 wire it to the real transports. | | PromptAssembledObservation | 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: 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. | | RawGenerationObservation | 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. | | RetrievableAttrs | Attribute bag rendered onto a retrievable block. | | ScrapperBaseConfig | Configuration common to every Scrapper factory. A is the accepted artifact resolver type. | | ScrapperRequestContext | Mutable context handed to each input-pipeline stage before the HTTP request is sent. Identical for both verbs. | | ScrapperResponseContext | Mutable context handed to each output-pipeline stage after the response JSON is parsed. | | ServeIsolatedOptions | Options accepted by serveIsolated/serveIsolatedOverPort. | | SpawnIsolatedOptions | Options accepted by spawnIsolated/createWorkerTransport, layered on top of IsolatedServiceOptions. | | StandingInstructionAttrs | Attribute bag rendered onto a standing-instruction block. | | StreamDescriptor | A stream descriptor produced by stream. Phantom-typed like MethodDescriptor. | | StreamHandle | 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. | | StreamOptions | Runtime options accepted by stream. | | SttSegment | A single recognized speech segment with its time bounds and text. | | ThoughtAttrs | Attribute bag rendered onto a thought block. | | TranscribeOptions | Per-call options for TransformersJsSttAdapter.transcribe. | | TranscribeResult | The result of a transcribe call. | | TransformersJsSttAdapterOptions | Constructor options for the transformers.js STT adapter. | | TrustedContentAttrs | Attribute bag rendered onto the trust envelope that wraps trusted (first-party) content. | | UntrustedContentAttrs | Attribute bag rendered onto the trust envelope that wraps untrusted (third-party) content. | | WebLLMChatCompletionsAdapterOptions | 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. | | WireError | 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. |
Type Aliases
| Type Alias | Description | | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | ----- | ----- | --- | | ChatCompletionsBucketLabel | Name of a system-prompt content bucket whose render order is configurable. | | ChatCompletionsBucketOrder | Ordered list of ChatCompletionsBucketLabels controlling the sequence in which content buckets are assembled into the prompt. | | CodecMode | 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. | | CrashVerdict | The escalation CrashPolicy.record decided for a single crash event. | | CreateTransformersJsSttPipeline | 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. | | EventMap | The shape of an events map passed to defineIsolatedService: unsolicited-notification descriptors keyed by channel name. | | GuestToHostEnvelope | Guest → host envelopes. | | HostToGuestEnvelope | Host → guest envelopes. | | IsolatedEmitter | Emit an event declared on a spec — the guest-side capability handed alongside the implementation. | | IsolatedEventListener | A typed event-channel listener for the host-side IsolatedService.on(channel, fn). | | IsolatedFacade | The host-side callable facade a IsolatedServiceSpec maps to — .api on the IsolatedService returned by createIsolatedService. Every declared method becomes an async function returning Promise<R> 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<D> immediately. | | IsolatedImplementation | 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 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<D> or any AsyncIterable<D> (e.g. an async generator), and always receive a trailing StreamHandle. Declared events are NOT part of this object — see serveIsolated's factory emit parameter. | | IsolatedImplementationFactory | The implementation factory serveIsolated/serveIsolatedOverPort calls once, up front, to obtain the guest-side method/stream implementations plus the emit capability for declared events. | | IsolatedServiceState | Lifecycle state of an IsolatedService. | | IsolationReportCallback | An isolation report consumer. | | IsolationReportPhase | The coarse phase groups an isolation report can belong to. | | MethodMap | The shape of a methods map passed to defineIsolatedService: request/response descriptors keyed by method name. | | PromptAssembledObserverFn | Observe the fully-assembled request a battery is about to dispatch. Injectable + defaulted to absent on every LLM battery, mirroring RawGenerationObserverFn. 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 for the no-redaction contract. | | RawGenerationObserverFn | 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). | | ScrapperInputMiddlewareFn | An input-pipeline stage. Onion middleware over ScrapperRequestContext. | | ScrapperOutputMiddlewareFn | An output-pipeline stage over a verb's ScrapperResponseContext. | | StreamMap | The shape of a streams map passed to defineIsolatedService: fire-and-forward streaming descriptors keyed by stream name. | | TransformersJsSttDataType | Quantization/precision dtype: 'auto' | 'fp32' | 'fp16' | 'q8' | 'q4' | …. | | TransformersJsSttDeviceType | Inference device: 'auto' | 'webgpu' | 'wasm' | 'cpu' | 'gpu' | …. | | TransformersJsSttModelSource | 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. | | TransformersJsSttPipeline | The transformers.js automatic-speech-recognition pipeline this battery drives. | | TransformersJsSttProgressCallback | Model-load progress callback. | | WebLLMChatCompletionsRequestBody | 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. | | WebLLMEngine | The in-browser MLC engine instance the adapter drives. | | WebLLMInitProgressReport | Progress report emitted while a WebLLM model loads/initializes. | | WireEnvelope | Either direction's envelope — used by generic wire-tracing hooks. | | WireValue | 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 WP2's browser transport unwraps into a postMessage transfer list; node transports ignore it. | | WorkerResolver | Bring-your-own Worker spawner — the first-class seam for handing spawnIsolated/createWorkerTransport 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's remarks for why this makes a resolver the SINGLE source of Worker creation for a given transport. |
Variables
| Variable | Description |
|---|---|
| DEFAULT_CRASH_POLICY_MAX_CRASHES | How many crashes inside the window are tolerated (with 'respawn') before 'giveUp'. |
| DEFAULT_CRASH_POLICY_WINDOW_MS | How long a run of crashes must fall within to count toward the same escalation window. |
| defaultDescriptionToChatCompletionsJsonSchema | Default JSON-Schema renderer; alias of descriptionToChatCompletionsJsonSchema. |
| defaultFilterThoughts | Default thought filter; alias of filterThoughts. |
| defaultRenderChatCompletionsSystemPrompt | Default system-prompt renderer; alias of renderChatCompletionsSystemPrompt. |
| defaultRenderFirstPartyRetrievables | Default first-party retrievables renderer; alias of renderFirstPartyRetrievables. |
| defaultRenderMemories | Default memories renderer; alias of renderMemories. |
| defaultRenderRetrievables | Default retrievables orchestrator; alias of renderRetrievables. |
| defaultRenderRetrievableSafetyDirective | Default safety-directive renderer; alias of renderRetrievableSafetyDirective. |
| defaultRenderStandingInstructions | Default standing-instructions renderer; alias of renderStandingInstructions. |
| defaultRenderThirdPartyPrivateRetrievables | Default third-party-private retrievables renderer; alias of renderThirdPartyPrivateRetrievables. |
| defaultRenderThirdPartyPublicRetrievables | Default third-party-public retrievables renderer; alias of renderThirdPartyPublicRetrievables. |
| defaultRenderThought | Default thought renderer; alias of renderThought. |
| defaultRenderTrustedContent | Default trusted-content renderer; alias of renderTrustedContent. |
| defaultRenderUntrustedContent | Default untrusted-content renderer; alias of renderUntrustedContent. |
| defaultToolsToChatCompletionsTools | Default tool-translation helper; alias of toolsToChatCompletionsTools. |
| E_INVALID_ISOLATION_OPTIONS | 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. |
| E_INVALID_SCRAPPER_CONFIG | Thrown when a Scrapper factory receives invalid configuration. |
| E_INVALID_SEARXNG_CONFIG | Thrown when createSearxngSearchTool receives invalid configuration. |
| E_INVALID_TRANSFORMERS_JS_STT_OPTIONS | 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. |
| E_ISOLATE_FUNCTION_ARG_UNSUPPORTED | 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. |
| E_ISOLATE_FUNCTION_REQUIRES_SOURCE_REHYDRATION | Thrown when isolateFunction is called without the literal { allowSourceRehydration: true } acknowledgement. Fatal: this is a configuration/call-site error, caught before anything is spawned. |
| E_ISOLATE_FUNCTION_UNSERIALIZABLE | Thrown when the function passed to isolateFunction 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. |
| E_ISOLATED_CRASHED | 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. |
| E_ISOLATED_TERMINATED | 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. |
| E_ISOLATION_ENCODER_REQUIRED | 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. |
| E_ISOLATION_READY_TIMEOUT | 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. |
| E_ISOLATION_UNENCODABLE | 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. |
| E_ISOLATION_UNSUPPORTED_ENV | 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. |
| E_TRANSFORMERS_JS_STT_ENGINE_ERROR | 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]. |
| transformersJsSttAdapterOptionsSchema | Validator schema for TransformersJsSttAdapterOptions. Rejects unknown top-level keys. |
Functions
| Function | Description |
|---|---|
| createCrashPolicy | 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. |
| createIsolatedService | Build an IsolatedService over transport for spec. Connection + the first ready handshake begin immediately (fire-and-forget internally); calls made before ready queue inside the underlying HostEndpoint and flush in order once it arrives. |
| createWorkerTransport | Build an IsolationTransport that spawns/re-spawns a real browser Worker per SpawnIsolatedOptions.worker. |
| defineIsolatedService | 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. |
| descriptionToChatCompletionsJsonSchema | Implements ChatHelpersCommon.descriptionToChatCompletionsJsonSchema. |
| emitIsolationReport | Build an IsolationReport (stamping at) and dispatch it to the firehose (IsolationObservabilityHooks.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 so it is never computed when unhooked. Each callback is invoked through safeInvoke, so a throwing consumer never disrupts the battery. |
| event | 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. |
| filterThoughts | Implements ChatHelpersCommon.filterThoughts. |
| floorTrustTier | 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. |
| hasIsolationHook | Returns true when at least one hook relevant to phase is registered — the guard emitIsolationReport uses to skip assembling a report entirely (zero overhead when unhooked). |
| isEncoderAvailable | Whether the encoder peer is currently available. Used to populate ready.encoderAvailable. |
| isolateFunction | 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. |
| method | Declare a request/response method on an isolated service's spec — the host gets a (...args) => Promise<R> facade method; the guest implementation returns (or resolves to) R directly (or throws/rejects, crossing back as a rejected promise on the host). |
| neutraliseDeveloperRulesTag | Neutralise the no-nonce <system_instructions …> / </system_instructions> developer-rules tier if it appears inside model- or user-supplied BODY content. |
| nextCorrelationId | 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). |
| registerEncodableClasses | 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. |
| renderChatCompletionsSystemPrompt | Implements ChatHelpersCommon.renderChatCompletionsSystemPrompt. |
| renderFirstPartyRetrievables | Implements ChatHelpersCommon.renderFirstPartyRetrievables. |
| renderMemories | Implements ChatHelpersCommon.renderMemories. |
| renderRetrievables | Implements ChatHelpersCommon.renderRetrievables. |
| renderRetrievableSafetyDirective | Implements ChatHelpersCommon.renderRetrievableSafetyDirective. |
| renderStandingInstructions | Implements ChatHelpersCommon.renderStandingInstructions. |
| renderThirdPartyPrivateRetrievables | Implements ChatHelpersCommon.renderThirdPartyPrivateRetrievables. |
| renderThirdPartyPublicRetrievables | Implements ChatHelpersCommon.renderThirdPartyPublicRetrievables. |
| renderThought | Implements ChatHelpersCommon.renderThought. |
| renderTrustedContent | Implements ChatHelpersCommon.renderTrustedContent. |
| renderUntrustedContent | Implements ChatHelpersCommon.renderUntrustedContent. |
| resolveIsolatedServiceSpec | Resolve an isolated-service spec input into its final IsolatedServiceSpec 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. |
| sanitizeFilenameForDescription | 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. |
| sanitizeMimeType | Validate a media mimeType for safe interpolation into a data:<mime>;base64,… URI, a Blob({type}), or a synthetic-description line. |
| serveIsolated | 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 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. |
| serveIsolatedOverPort | Serve spec over an already-constructed PortLike — the environment-neutral primitive. Builds the implementation via factory, wires a GuestEndpoint to it, and announces readiness (ready envelope) once the encoder-availability probe resolves. |
| spawnIsolated | Sugar for createIsolatedService(spec, createWorkerTransport(spec, options), options) — spawn a real Worker-backed IsolatedService in one call. |
| stream | Declare a fire-and-forward streaming method on an isolated service's spec — the host gets a (...args) => ReadableStream<D> 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<D> or AsyncIterable<D>. |
| stripEnvelopeSpecialTokens | Strip the non-semantic envelope/turn-boundary special tokens (see ENVELOPE_SPECIAL_TOKEN_RE) from decoded model text before it reaches the parser layer. |
| toolsToChatCompletionsTools | Implements ChatHelpersCommon.toolsToChatCompletionsTools. |
| transfer | Mark value for transfer (rather than clone) across a postMessage-based transport — WP2's browser transport unwraps this into the message's transfer list. The codec passes marked values through as raw with transferables preserved on the WireValue envelope's transfer field. Node transports (WP3) 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. |
| validateTransformersJsSttOptions | Validates an arbitrary input against transformersJsSttAdapterOptionsSchema. |
| wireErrorToError | Reconstruct an Error from a WireError baseline (name/message/stack only — the nhtio-rich path is decoded separately by the caller when an encoder is available; see host.ts). |
References
addStandingInstructionTool
Re-exports addStandingInstructionTool
applyEmbeddingPrefix
Re-exports applyEmbeddingPrefix
argText
Re-exports argText
ArticleContentSource
Re-exports ArticleContentSource
ArticleToRetrievableOptions
Re-exports ArticleToRetrievableOptions
ArtifactRecommendations
Re-exports ArtifactRecommendations
assembleCompactedTurns
Re-exports assembleCompactedTurns
AssembleCompactedTurnsOptions
Re-exports AssembleCompactedTurnsOptions
AssembleCompactedTurnsResult
Re-exports AssembleCompactedTurnsResult
AssembledToolCall
Re-exports AssembledToolCall
BaseEmbeddingsAdapterOptions
Re-exports BaseEmbeddingsAdapterOptions
BaseGenerationAdapterOptions
Re-exports BaseGenerationAdapterOptions
BaseVectorStore
Re-exports BaseVectorStore
BaseVectorStoreOptions
Re-exports BaseVectorStoreOptions
baseVectorStoreOptionsSchema
Re-exports baseVectorStoreOptionsSchema
BatteryLifecycleBattery
Re-exports BatteryLifecycleBattery
BatteryLifecycleCallback
Re-exports BatteryLifecycleCallback
BatteryLifecycleHooks
Re-exports BatteryLifecycleHooks
BatteryLifecyclePhase
Re-exports BatteryLifecyclePhase
BatteryLifecycleReport
Re-exports BatteryLifecycleReport
BucketTrace
Re-exports BucketTrace
buildChatCompletionsHistory
Re-exports buildChatCompletionsHistory
calculateTool
Re-exports calculateTool
CallableVectorStore
Re-exports CallableVectorStore
ChatCompletionsChunk
Re-exports ChatCompletionsChunk
ChatCompletionsHelpers
Re-exports ChatCompletionsHelpers
ChatCompletionsMessage
Re-exports ChatCompletionsMessage
ChatCompletionsResponse
Re-exports ChatCompletionsResponse
ChatCompletionsToolCallDelta
Re-exports ChatCompletionsToolCallDelta
ChatCompletionsToolCallDeltaAccumulator
Re-exports ChatCompletionsToolCallDeltaAccumulator
clamp01
Re-exports clamp01
CollectionBuilder
Re-exports CollectionBuilder
CollectionFieldSpec
Re-exports CollectionFieldSpec
CollectionSpec
Re-exports CollectionSpec
colorAdjustTool
Re-exports colorAdjustTool
colorContrastTool
Re-exports colorContrastTool
colorSchemeTool
Re-exports colorSchemeTool
COMPACTION_SYSTEM_PROMPT
Re-exports COMPACTION_SYSTEM_PROMPT
CompactionCostEvent
Re-exports CompactionCostEvent
compareRecordsTool
Re-exports compareRecordsTool
compareValuesTool
Re-exports compareValuesTool
ContentLike
Re-exports ContentLike
contentTokens
Re-exports contentTokens
convertTimeTool
Re-exports convertTimeTool
convertUnitTool
Re-exports convertUnitTool
createChatCompletionsToolCallDeltaAccumulator
Re-exports createChatCompletionsToolCallDeltaAccumulator
createScrapperArticleTool
Re-exports createScrapperArticleTool
createScrapperArticleToolSync
Re-exports createScrapperArticleToolSync
createScrapperLinksTool
Re-exports createScrapperLinksTool
createScrapperLinksToolSync
Re-exports createScrapperLinksToolSync
createSearxngSearchTool
Re-exports createSearxngSearchTool
createSearxngSearchToolSync
Re-exports createSearxngSearchToolSync
CreateTesseractJsModule
Re-exports CreateTesseractJsModule
CreateTesseractJsWorker
Re-exports CreateTesseractJsWorker
CreateTransformersJsCaptionPipeline
Re-exports CreateTransformersJsCaptionPipeline
CreateTransformersJsEmbeddingsPipeline
Re-exports CreateTransformersJsEmbeddingsPipeline
CreateTransformersJsGenerationModel
Re-exports CreateTransformersJsGenerationModel
CreateTransformersJsGenerationProcessor
Re-exports CreateTransformersJsGenerationProcessor
createVectorRetrievableCallbacks
Re-exports createVectorRetrievableCallbacks
createVectorStore
Re-exports createVectorStore
CreateVectorStoreConfig
Re-exports CreateVectorStoreConfig
dateAddTool
Re-exports dateAddTool
dateBusinessDaysTool
Re-exports dateBusinessDaysTool
dateCalendarInfoTool
Re-exports dateCalendarInfoTool
dateDiffTool
Re-exports dateDiffTool
dateNthWeekdayTool
Re-exports dateNthWeekdayTool
dateParseTool
Re-exports dateParseTool
datePeriodTool
Re-exports datePeriodTool
DecodeAudioFn
Re-exports DecodeAudioFn
DEFAULT_ENCODING
Re-exports DEFAULT_ENCODING
DEFAULT_KEEP_VERBATIM
Re-exports DEFAULT_KEEP_VERBATIM
DEFAULT_RESERVE_FRACTION
Re-exports DEFAULT_RESERVE_FRACTION
DEFAULT_SUMMARISE_AT_TOKENS
Re-exports DEFAULT_SUMMARISE_AT_TOKENS
DEFAULT_SUMMARY_MESSAGE_ID
Re-exports DEFAULT_SUMMARY_MESSAGE_ID
DEFAULT_THIS_TURN_RESULT_KEEP
Re-exports DEFAULT_THIS_TURN_RESULT_KEEP
defaultBuildChatCompletionsHistory
Re-exports defaultBuildChatCompletionsHistory
defaultCreateChatCompletionsToolCallDeltaAccumulator
Re-exports defaultCreateChatCompletionsToolCallDeltaAccumulator
defaultDecodeAudio
Re-exports defaultDecodeAudio
defaultRenderChatCompletionsToolCallResult
Re-exports defaultRenderChatCompletionsToolCallResult
defaultRenderTimelineMessage
Re-exports defaultRenderTimelineMessage
deleteMemoryTool
Re-exports deleteMemoryTool
DeletePlan
Re-exports DeletePlan
deleteRetrievableTool
Re-exports deleteRetrievableTool
DescribeOptions
Re-exports DescribeOptions
DescribeResult
Re-exports DescribeResult
detectDelimiterTool
Re-exports detectDelimiterTool
dimensionsMatch
Re-exports dimensionsMatch
DistanceMetric
Re-exports DistanceMetric
durationFormatTool
Re-exports durationFormatTool
E_CONTEXT_RESOLVER_MISSING
Re-exports E_CONTEXT_RESOLVER_MISSING
E_GEMINI_GENERATION_HTTP_ERROR
Re-exports E_GEMINI_GENERATION_HTTP_ERROR
E_GEMINI_GENERATION_MALFORMED_RESPONSE
Re-exports E_GEMINI_GENERATION_MALFORMED_RESPONSE
E_GEMINI_GENERATION_REQUEST_TIMEOUT
Re-exports E_GEMINI_GENERATION_REQUEST_TIMEOUT
E_INVALID_GEMINI_GENERATION_OPTIONS
Re-exports E_INVALID_GEMINI_GENERATION_OPTIONS
E_INVALID_LITERT_LM_OPTIONS
Re-exports E_INVALID_LITERT_LM_OPTIONS
E_INVALID_OLLAMA_OPTIONS
Re-exports E_INVALID_OLLAMA_OPTIONS
E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS
Re-exports E_INVALID_OPENAI_CHAT_COMPLETIONS_OPTIONS
E_INVALID_OPENAI_EMBEDDINGS_OPTIONS
Re-exports E_INVALID_OPENAI_EMBEDDINGS_OPTIONS
E_INVALID_OPENAI_GENERATION_OPTIONS
Re-exports E_INVALID_OPENAI_GENERATION_OPTIONS
E_INVALID_TESSERACT_JS_OCR_OPTIONS
Re-exports E_INVALID_TESSERACT_JS_OCR_OPTIONS
E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS
Re-exports E_INVALID_TRANSFORMERS_JS_CAPTION_OPTIONS
E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS
Re-exports E_INVALID_TRANSFORMERS_JS_EMBEDDINGS_OPTIONS
E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS
Re-exports E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS
E_INVALID_TRANSFORMERS_JS_OPTIONS
Re-exports E_INVALID_TRANSFORMERS_JS_OPTIONS
E_INVALID_VECTOR_RECORD
Re-exports E_INVALID_VECTOR_RECORD
E_INVALID_VECTOR_STORE_CONFIG
Re-exports E_INVALID_VECTOR_STORE_CONFIG
E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS
Re-exports E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS
E_LITERT_LM_CONTEXT_OVERFLOW
Re-exports E_LITERT_LM_CONTEXT_OVERFLOW
E_LITERT_LM_INVALID_TOOL_CALL_ARGS
Re-exports E_LITERT_LM_INVALID_TOOL_CALL_ARGS
E_LITERT_LM_STREAM_ERROR
Re-exports E_LITERT_LM_STREAM_ERROR
E_OLLAMA_CONTEXT_OVERFLOW
Re-exports E_OLLAMA_CONTEXT_OVERFLOW
E_OLLAMA_HTTP_ERROR
Re-exports E_OLLAMA_HTTP_ERROR
E_OLLAMA_INVALID_TOOL_CALL_ARGS
Re-exports E_OLLAMA_INVALID_TOOL_CALL_ARGS
E_OLLAMA_REQUEST_TIMEOUT
Re-exports E_OLLAMA_REQUEST_TIMEOUT
E_OLLAMA_STREAM_ERROR
Re-exports E_OLLAMA_STREAM_ERROR
E_OLLAMA_STREAM_STALLED
Re-exports E_OLLAMA_STREAM_STALLED
E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY
Re-exports E_OLLAMA_UNSUPPORTED_MEDIA_MODALITY
E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW
Re-exports E_OPENAI_CHAT_COMPLETIONS_CONTEXT_OVERFLOW
E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR
Re-exports E_OPENAI_CHAT_COMPLETIONS_HTTP_ERROR
E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS
Re-exports E_OPENAI_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS
E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT
Re-exports E_OPENAI_CHAT_COMPLETIONS_REQUEST_TIMEOUT
E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR
Re-exports E_OPENAI_CHAT_COMPLETIONS_STREAM_ERROR
E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED
Re-exports E_OPENAI_CHAT_COMPLETIONS_STREAM_STALLED
E_OPENAI_EMBEDDINGS_HTTP_ERROR
Re-exports E_OPENAI_EMBEDDINGS_HTTP_ERROR
E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE
Re-exports E_OPENAI_EMBEDDINGS_MALFORMED_RESPONSE
E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT
Re-exports E_OPENAI_EMBEDDINGS_REQUEST_TIMEOUT
E_OPENAI_GENERATION_HTTP_ERROR
Re-exports E_OPENAI_GENERATION_HTTP_ERROR
E_OPENAI_GENERATION_MALFORMED_RESPONSE
Re-exports E_OPENAI_GENERATION_MALFORMED_RESPONSE
E_OPENAI_GENERATION_REQUEST_TIMEOUT
Re-exports E_OPENAI_GENERATION_REQUEST_TIMEOUT
E_TESSERACT_JS_OCR_ENGINE_ERROR
Re-exports E_TESSERACT_JS_OCR_ENGINE_ERROR
E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR
Re-exports E_TRANSFORMERS_JS_CAPTION_ENGINE_ERROR
E_TRANSFORMERS_JS_CONTEXT_OVERFLOW
Re-exports E_TRANSFORMERS_JS_CONTEXT_OVERFLOW
E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR
Re-exports E_TRANSFORMERS_JS_EMBEDDINGS_ENGINE_ERROR
E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR
Re-exports E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR
E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION
Re-exports E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION
E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS
Re-exports E_TRANSFORMERS_JS_INVALID_TOOL_CALL_ARGS
E_TRANSFORMERS_JS_STREAM_ERROR
Re-exports E_TRANSFORMERS_JS_STREAM_ERROR
E_TRANSFORMERS_JS_TOOL_PARSE_FAILED
Re-exports E_TRANSFORMERS_JS_TOOL_PARSE_FAILED
E_VECTOR_STORE_COLLECTION_FAILED
Re-exports E_VECTOR_STORE_COLLECTION_FAILED
E_VECTOR_STORE_CONNECTION_FAILED
Re-exports E_VECTOR_STORE_CONNECTION_FAILED
E_VECTOR_STORE_CONSISTENCY_TIMEOUT
Re-exports E_VECTOR_STORE_CONSISTENCY_TIMEOUT
E_VECTOR_STORE_DELETE_FAILED
Re-exports E_VECTOR_STORE_DELETE_FAILED
E_VECTOR_STORE_DIMENSION_MISMATCH
Re-exports E_VECTOR_STORE_DIMENSION_MISMATCH
E_VECTOR_STORE_DRIVER_UNAVAILABLE
Re-exports E_VECTOR_STORE_DRIVER_UNAVAILABLE
E_VECTOR_STORE_ENCODER_REQUIRED
Re-exports E_VECTOR_STORE_ENCODER_REQUIRED
E_VECTOR_STORE_MIGRATION_FAILED
Re-exports E_VECTOR_STORE_MIGRATION_FAILED
E_VECTOR_STORE_PROJECTION_REQUIRED
Re-exports E_VECTOR_STORE_PROJECTION_REQUIRED
E_VECTOR_STORE_QUERY_CONFLICT
Re-exports E_VECTOR_STORE_QUERY_CONFLICT
E_VECTOR_STORE_RAW_BINDING_MISMATCH
Re-exports E_VECTOR_STORE_RAW_BINDING_MISMATCH
E_VECTOR_STORE_SEARCH_FAILED
Re-exports E_VECTOR_STORE_SEARCH_FAILED
E_VECTOR_STORE_TRANSACTIONS_UNSUPPORTED
Re-exports E_VECTOR_STORE_TRANSACTIONS_UNSUPPORTED
E_VECTOR_STORE_UNSUPPORTED_FILTER_OPERATOR
Re-exports E_VECTOR_STORE_UNSUPPORTED_FILTER_OPERATOR
E_VECTOR_STORE_UNSUPPORTED_OPERATION
Re-exports E_VECTOR_STORE_UNSUPPORTED_OPERATION
E_VECTOR_STORE_UPSERT_FAILED
Re-exports E_VECTOR_STORE_UPSERT_FAILED
E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW
Re-exports E_WEBLLM_CHAT_COMPLETIONS_CONTEXT_OVERFLOW
E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS
Re-exports E_WEBLLM_CHAT_COMPLETIONS_INVALID_TOOL_CALL_ARGS
E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR
Re-exports E_WEBLLM_CHAT_COMPLETIONS_STREAM_ERROR
EDIT_IMAGE_FIELD_NAME
Re-exports EDIT_IMAGE_FIELD_NAME
EditOptions
Re-exports EditOptions
EmbeddingKind
Re-exports EmbeddingKind
EmbeddingsLike
Re-exports EmbeddingsLike
EmbeddingsRetryConfig
Re-exports EmbeddingsRetryConfig
EmbedOptions
Re-exports EmbedOptions
EncodeKind
Re-exports EncodeKind
EncodeRawImageFn
Re-exports EncodeRawImageFn
encoderFromEmbeddings
Re-exports encoderFromEmbeddings
encodeTextTool
Re-exports encodeTextTool
EnsureCollectionOptions
Re-exports EnsureCollectionOptions
Estimable
Re-exports Estimable
EstimateTokensFn
Re-exports EstimateTokensFn
EstimatorOptions
Re-exports EstimatorOptions
evaluateFilter
Re-exports evaluateFilter
evaluateKatexTool
Re-exports evaluateKatexTool
extractReasoningFields
Re-exports extractReasoningFields
FieldChain
Re-exports FieldChain
FilterBuilder
Re-exports FilterBuilder
FilterCallback
Re-exports FilterCallback
FilterCondition
Re-exports FilterCondition
FilterGroup
Re-exports FilterGroup
FilterOperator
Re-exports FilterOperator
formatListTool
Re-exports formatListTool
formatNumberTool
Re-exports formatNumberTool
formatTableTool
Re-exports formatTableTool
GeminiContent
Re-exports GeminiContent
GeminiEditOptions
Re-exports GeminiEditOptions
GeminiGenerateContentRequestBody
Re-exports GeminiGenerateContentRequestBody
GeminiGenerateContentResponse
Re-exports GeminiGenerateContentResponse
GeminiGenerateOptions
Re-exports GeminiGenerateOptions
GeminiGenerationAdapter
Re-exports GeminiGenerationAdapter
GeminiGenerationAdapterOptions
Re-exports GeminiGenerationAdapterOptions
GeminiGenerationConfig
Re-exports GeminiGenerationConfig
geminiGenerationOptionsSchema
Re-exports geminiGenerationOptionsSchema
GeminiRequestPart
Re-exports GeminiRequestPart
GeminiResponseModality
Re-exports GeminiResponseModality
GeminiResponsePart
Re-exports GeminiResponsePart
GenerateOptions
Re-exports GenerateOptions
GenerationBytesInput
Re-exports GenerationBytesInput
GenerationImageInput
Re-exports GenerationImageInput
GenerationMediaLike
Re-exports GenerationMediaLike
GenerationRetryConfig
Re-exports GenerationRetryConfig
geoBboxContainsTool
Re-exports geoBboxContainsTool
geoDistanceTool
Re-exports geoDistanceTool
geoWithinRadiusTool
Re-exports geoWithinRadiusTool
getCurrentTimeTool
Re-exports getCurrentTimeTool
groupHistoryIntoTurns
Re-exports groupHistoryIntoTurns
HistoryTurn
Re-exports HistoryTurn
implementsVectorStoreConstructor
Re-exports implementsVectorStoreConstructor
InMemoryVectorStore
Re-exports InMemoryVectorStore
InMemoryVectorStoreOptions
Re-exports InMemoryVectorStoreOptions
IsEphemeralMessageFn
Re-exports IsEphemeralMessageFn
isFilterCondition
Re-exports isFilterCondition
isFilterGroup
Re-exports isFilterGroup
isFiniteVector
Re-exports isFiniteVector
isPcmInput
Re-exports isPcmInput
isRawExpr
Re-exports isRawExpr
isRawFilter
Re-exports isRawFilter
IsSummaryMessageFn
Re-exports IsSummaryMessageFn
jsonFormatTool
Re-exports jsonFormatTool
jsonTransformTool
Re-exports jsonTransformTool
listMemoriesTool
Re-exports listMemoriesTool
listRetrievablesTool
Re-exports listRetrievablesTool
listStandingInstructionsTool
Re-exports listStandingInstructionsTool
LiteRtLmAdapter
Re-exports LiteRtLmAdapter
LiteRtLmAdapterOptions
Re-exports LiteRtLmAdapterOptions
LiteRtLmConversation
Re-exports LiteRtLmConversation
LiteRtLmEngine
Re-exports LiteRtLmEngine
liteRtLmOptionsSchema
Re-exports liteRtLmOptionsSchema
mapMetric
Re-exports mapMetric
memoryTools
Re-exports memoryTools
MigrationLedger
Re-exports MigrationLedger
MillisTimestamp
Re-exports MillisTimestamp
normalizeScore
Re-exports normalizeScore
OllamaAdapter
Re-exports OllamaAdapter
OllamaAdapterOptions
Re-exports OllamaAdapterOptions
OllamaChatRequestBody
Re-exports OllamaChatRequestBody
OllamaChatResponse
Re-exports OllamaChatResponse
OllamaChatStreamChunk
Re-exports OllamaChatStreamChunk
OllamaFormat
Re-exports OllamaFormat
OllamaHelpers
Re-exports OllamaHelpers
OllamaMessage
Re-exports OllamaMessage
ollamaOptionsSchema
Re-exports ollamaOptionsSchema
OllamaRuntimeOptions
Re-exports OllamaRuntimeOptions
OllamaThink
Re-exports OllamaThink
OllamaTool
Re-exports OllamaTool
OllamaToolCall
Re-exports OllamaToolCall
OnCostFn
Re-exports OnCostFn
OpenAIChatCompletionsAdapter
Re-exports OpenAIChatCompletionsAdapter
OpenAIChatCompletionsAdapterOptions
Re-exports OpenAIChatCompletionsAdapterOptions
openAIChatCompletionsOptionsSchema
Re-exports openAIChatCompletionsOptionsSchema
OpenAIChatCompletionsRequestBody
Re-exports OpenAIChatCompletionsRequestBody
OpenAIEditOptions
Re-exports OpenAIEditOptions
OpenAIEmbeddingsAdapter
Re-exports OpenAIEmbeddingsAdapter
OpenAIEmbeddingsAdapterOptions
Re-exports OpenAIEmbeddingsAdapterOptions
openAIEmbeddingsOptionsSchema
Re-exports openAIEmbeddingsOptionsSchema
OpenAIEmbeddingsRequestBody
Re-exports OpenAIEmbeddingsRequestBody
OpenAIEmbeddingsResponseBody
Re-exports OpenAIEmbeddingsResponseBody
OpenAIGenerateOptions
Re-exports OpenAIGenerateOptions
OpenAIGenerationAdapter
Re-exports OpenAIGenerationAdapter
OpenAIGenerationAdapterOptions
Re-exports OpenAIGenerationAdapterOptions
openAIGenerationOptionsSchema
Re-exports openAIGenerationOptionsSchema
OpenAIImagesGenerationRequestBody
Re-exports OpenAIImagesGenerationRequestBody
OpenAIImagesResponse
Re-exports OpenAIImagesResponse
OramaVectorStore
Re-exports OramaVectorStore
OramaVectorStoreOptions
Re-exports OramaVectorStoreOptions
parseCsvTool
Re-exports parseCsvTool
parseKvTool
Re-exports parseKvTool
parseYamlTool
Re-exports parseYamlTool
PlanSink
Re-exports PlanSink
Projection
Re-exports Projection
raw
Re-exports raw
RawExpr
Re-exports RawExpr
RawFilter
Re-exports RawFilter
ReasoningExtract
Re-exports ReasoningExtract
ReasoningField
Re-exports ReasoningField
ReasoningFieldPrecedence
Re-exports ReasoningFieldPrecedence
ReasoningParserFn
Re-exports ReasoningParserFn
ReasoningParserName
Re-exports ReasoningParserName
RecognizeOptions
Re-exports RecognizeOptions
RecognizeResult
Re-exports RecognizeResult
RELEVANCE_FLOOR_CURVE
Re-exports RELEVANCE_FLOOR_CURVE
RELEVANCE_FLOOR_MAX
Re-exports RELEVANCE_FLOOR_MAX
RELEVANCE_FLOOR_MIN
Re-exports RELEVANCE_FLOOR_MIN
RelevanceMessage
Re-exports RelevanceMessage
RelevanceToolCall
Re-exports RelevanceToolCall
relevanceToQuery
Re-exports relevanceToQuery
removeStandingInstructionTool
Re-exports removeStandingInstructionTool
renderChatCompletionsToolCallResult
Re-exports renderChatCompletionsToolCallResult
renderTimelineMessage
Re-exports renderTimelineMessage
RenderToolsFn
Re-exports RenderToolsFn
resolveBudget
Re-exports resolveBudget
resolveClientCtor
Re-exports resolveClientCtor
Resolver
Re-exports Resolver
RetrievableCtor
Re-exports RetrievableCtor
RetrievableStoreCtx
Re-exports RetrievableStoreCtx
retrievableTools
Re-exports retrievableTools
sanitizeMetadata
Re-exports sanitizeMetadata
scaledRelevanceFloor
Re-exports scaledRelevanceFloor
SchemaExecutor
Re-exports SchemaExecutor
ScoreKind
Re-exports ScoreKind
ScrapperArticle
Re-exports ScrapperArticle
ScrapperArticleConfig
Re-exports ScrapperArticleConfig
ScrapperArticleConfigSync
Re-exports ScrapperArticleConfigSync
ScrapperArticleLike
Re-exports ScrapperArticleLike
ScrapperArticleParams
Re-exports ScrapperArticleParams
scrapperArticleToRetrievable
Re-exports scrapperArticleToRetrievable
ScrapperCommonParams
Re-exports ScrapperCommonParams
ScrapperLink
Re-exports ScrapperLink
ScrapperLinkLike
Re-exports ScrapperLinkLike
ScrapperLinks
Re-exports ScrapperLinks
ScrapperLinksConfig
Re-exports ScrapperLinksConfig
ScrapperLinksConfigSync
Re-exports ScrapperLinksConfigSync
ScrapperLinksLike
Re-exports ScrapperLinksLike
ScrapperLinksParams
Re-exports ScrapperLinksParams
scrapperLinksToRetrievables
Re-exports scrapperLinksToRetrievables
SearchPlan
Re-exports SearchPlan
SearxngHeaders
Re-exports SearxngHeaders
SearxngHeadersResolver
Re-exports SearxngHeadersResolver
SearxngInputMiddlewareFn
Re-exports SearxngInputMiddlewareFn
SearxngOutputMiddlewareFn
Re-exports SearxngOutputMiddlewareFn
SearxngPayloadLike
Re-exports SearxngPayloadLike
SearxngRequestContext
Re-exports SearxngRequestContext
SearxngResponseContext
Re-exports SearxngResponseContext
SearxngResult
Re-exports SearxngResult
SearxngResultFormat
Re-exports SearxngResultFormat
SearxngResultLike
Re-exports SearxngResultLike
searxngResultsToRetrievables
Re-exports searxngResultsToRetrievables
SearxngToolConfig
Re-exports SearxngToolConfig
SelectArg
Re-exports SelectArg
selectNaiveTurns
Re-exports selectNaiveTurns
SelectNaiveTurnsOptions
Re-exports SelectNaiveTurnsOptions
selectRelevantTurns
Re-exports selectRelevantTurns
SelectRelevantTurnsOptions
Re-exports SelectRelevantTurnsOptions
setOperationsTool
Re-exports setOperationsTool
ShedRankFn
Re-exports ShedRankFn
SpecialistAudioInput
Re-exports SpecialistAudioInput
SpecialistBytesInput
Re-exports SpecialistBytesInput
SpecialistImageInput
Re-exports SpecialistImageInput
SpecialistMediaLike
Re-exports SpecialistMediaLike
SpecialistPcmInput
Re-exports SpecialistPcmInput
SpoolHook
Re-exports SpoolHook
standingInstructionTools
Re-exports standingInstructionTools
statsCorrelateTool
Re-exports statsCorrelateTool
statsDescribeTool
Re-exports statsDescribeTool
statsHistogramTool
Re-exports statsHistogramTool
statsTransformTool
Re-exports statsTransformTool
storeMemoryTool
Re-exports storeMemoryTool
storeRetrievables
Re-exports storeRetrievables
storeRetrievableTool
Re-exports storeRetrievableTool
stringExtractTool
Re-exports stringExtractTool
stringSimilarityTool
Re-exports stringSimilarityTool
stringTransformTool
Re-exports stringTransformTool
stripPriorTurnThoughts
Re-exports stripPriorTurnThoughts
subtractToFit
Re-exports subtractToFit
SubtractToFitOptions
Re-exports SubtractToFitOptions
summariseTurns
Re-exports summariseTurns
SummariseTurnsOptions
Re-exports SummariseTurnsOptions
SummarizeFn
Re-exports SummarizeFn
TesseractJsModule
Re-exports TesseractJsModule
TesseractJsOcrAdapter
Re-exports TesseractJsOcrAdapter
TesseractJsOcrAdapterOptions
Re-exports TesseractJsOcrAdapterOptions
tesseractJsOcrOptionsSchema
Re-exports tesseractJsOcrOptionsSchema
TesseractJsWorker
Re-exports TesseractJsWorker
textAnalyzeTool
Re-exports textAnalyzeTool
textDiffTool
Re-exports textDiffTool
textEscapeTool
Re-exports textEscapeTool
textLinesTool
Re-exports textLinesTool
ThriftTrace
Re-exports ThriftTrace
toBytes
Re-exports toBytes
toGenerationBytes
Renames and re-exports toBytes
ToolCallParserFn
Re-exports ToolCallParserFn
ToolCallParserName
Re-exports ToolCallParserName
ToRetrievableOptions
Re-exports ToRetrievableOptions
TransformersJsAdapter
Re-exports TransformersJsAdapter
TransformersJsAdapterOptions
Re-exports TransformersJsAdapterOptions
TransformersJsCaptionAdapter
Re-exports TransformersJsCaptionAdapter
TransformersJsCaptionAdapterOptions
Re-exports TransformersJsCaptionAdapterOptions
TransformersJsCaptionDataType
Re-exports TransformersJsCaptionDataType
TransformersJsCaptionDeviceType
Re-exports TransformersJsCaptionDeviceType
TransformersJsCaptionModelSource
Re-exports TransformersJsCaptionModelSource
transformersJsCaptionOptionsSchema
Re-exports transformersJsCaptionOptionsSchema
TransformersJsCaptionPipeline
Re-exports TransformersJsCaptionPipeline
TransformersJsCaptionProgressCallback
Re-exports TransformersJsCaptionProgressCallback
TransformersJsEmbeddingsAdapter
Re-exports TransformersJsEmbeddingsAdapter
TransformersJsEmbeddingsAdapterOptions
Re-exports TransformersJsEmbeddingsAdapterOptions
TransformersJsEmbeddingsDataType
Re-exports TransformersJsEmbeddingsDataType
TransformersJsEmbeddingsDeviceType
Re-exports TransformersJsEmbeddingsDeviceType
transformersJsEmbeddingsOptionsSchema
Re-exports transformersJsEmbeddingsOptionsSchema
TransformersJsEmbeddingsPipeline
Re-exports TransformersJsEmbeddingsPipeline
TransformersJsEmbeddingsProgressCallback
Re-exports TransformersJsEmbeddingsProgressCallback
TransformersJsGenerateOptions
Re-exports TransformersJsGenerateOptions
TransformersJsGenerationAdapter
Re-exports TransformersJsGenerationAdapter
TransformersJsGenerationAdapterOptions
Re-exports TransformersJsGenerationAdapterOptions
TransformersJsGenerationDataType
Re-exports TransformersJsGenerationDataType
TransformersJsGenerationDeviceType
Re-exports TransformersJsGenerationDeviceType
TransformersJsGenerationModel
Re-exports TransformersJsGenerationModel
TransformersJsGenerationModelSource
Re-exports TransformersJsGenerationModelSource
transformersJsGenerationOptionsSchema
Re-exports transformersJsGenerationOptionsSchema
TransformersJsGenerationProcessor
Re-exports TransformersJsGenerationProcessor
TransformersJsGenerationProgressCallback
Re-exports TransformersJsGenerationProgressCallback
TransformersJsMessage
Re-exports TransformersJsMessage
transformersJsOptionsSchema
Re-exports transformersJsOptionsSchema
TransformersJsPipeline
Re-exports TransformersJsPipeline
TransformersJsPooling
Re-exports TransformersJsPooling
TransformersJsRawImageLike
Re-exports TransformersJsRawImageLike
unicodeNormalizeTool
Re-exports unicodeNormalizeTool
updateMemoryTool
Re-exports updateMemoryTool
updateRetrievableTool
Re-exports updateRetrievableTool
UpsertPlan
Re-exports UpsertPlan
validateCreateConfig
Re-exports validateCreateConfig
validateFormatTool
Re-exports validateFormatTool
validateGeminiGenerationOptions
Renames and re-exports validateOptions
validateLiteRtLmOptions
Renames and re-exports validateOptions
validateOllamaOptions
Renames and re-exports validateOptions
validateOpenAIEmbeddingsOptions
Renames and re-exports validateOptions
validateOpenAIGenerationOptions
Renames and re-exports validateOptions
validateOptions
Re-exports validateOptions
validateRecords
Re-exports validateRecords
validateTesseractJsOcrOptions
Renames and re-exports validateOptions
validateTransformersJsCaptionOptions
Renames and re-exports validateOptions
validateTransformersJsEmbeddingsOptions
Renames and re-exports validateOptions
validateTransformersJsGenerationOptions
Renames and re-exports validateOptions
validateTransformersJsOptions
Renames and re-exports validateOptions
validateWebLLMChatCompletionsOptions
Renames and re-exports validateOptions
VectorConsistency
Re-exports VectorConsistency
VectorConsistencyCapability
Re-exports VectorConsistencyCapability
VectorEncoderFn
Re-exports VectorEncoderFn
VectorFilter
Re-exports VectorFilter
vectorFilterSchema
Re-exports vectorFilterSchema
VectorInput
Re-exports VectorInput
VectorMatch
Re-exports VectorMatch
VectorMetadata
Re-exports VectorMetadata
VectorMetadataValue
Re-exports VectorMetadataValue
VectorMigrateOptions
Re-exports VectorMigrateOptions
VectorMigration
Re-exports VectorMigration
VectorMigrationContext
Re-exports VectorMigrationContext
VectorMigrator
Re-exports VectorMigrator
VectorQueryBuilder
Re-exports VectorQueryBuilder
VectorRecord
Re-exports VectorRecord
vectorRecordSchema
Re-exports vectorRecordSchema
VectorRetrievableCallbacks
Re-exports VectorRetrievableCallbacks
VectorRetrievableGlueOptions
Re-exports VectorRetrievableGlueOptions
VectorSchemaBuilder
Re-exports VectorSchemaBuilder
VectorStore
Re-exports VectorStore
VectorStoreCapabilities
Re-exports VectorStoreCapabilities
VectorStoreClient
Re-exports VectorStoreClient
VectorStoreConstructor
Re-exports VectorStoreConstructor
VectorStoreConstructorLike
Re-exports VectorStoreConstructorLike
vectorStoreConstructorSchema
Re-exports vectorStoreConstructorSchema
VectorTx
Re-exports VectorTx
WebLLMChatCompletionsAdapter
Re-exports WebLLMChatCompletionsAdapter
webLLMChatCompletionsOptionsSchema
Re-exports webLLMChatCompletionsOptionsSchema
WorkingImage
Re-exports WorkingImage
WorkingMemory
Re-exports WorkingMemory
WorkingMessage
Re-exports WorkingMessage
WorkingRetrievable
Re-exports WorkingRetrievable
WorkingSet
Re-exports WorkingSet
WorkingThought
Re-exports WorkingThought
WorkingTool
Re-exports WorkingTool
WorkingToolCall
Re-exports WorkingToolCall
WorkingToolRegistry
Re-exports WorkingToolRegistry