Skip to content
3 min read · 537 words

@nhtio/adk/batteries/llm/webllm_chat_completions ​

WebLLM Chat Completions adapter battery with swappable translation helpers and wire types.

Remarks ​

Opinionated WebLLM Chat Completions LLM battery. Ships a WebLLMChatCompletionsAdapter that targets WebLLM's in-process OpenAI-style Chat Completions API and translates the ADK's primitives into that wire shape.

Re-exports the adapter class, every translation helper (each under its unprefixed name AND a default*-prefixed alias so consumers can compose partial overrides against the bundled defaults), every option / wire-shape type alias, the validation schema + validateOptions wrapper, and the six battery-scoped exception classes.

See the project README for the design-decisions block governing this battery (trust-framed envelopes, per-tool trust, swappable translation helpers, per-dispatch override channel via stash, trust-tier-distinct envelopes, multi-identity rendering, opaque-reasoning round-trips, etc.).

Type Aliases ​

Type AliasDescription
CreateWebLLMChatCompletionsEngineFactory that loads a model and resolves a ready-to-use WebLLMEngine.
WebLLMChatCompletionsEngineAlias of WebLLMEngine.

References ​

AssembledToolCall ​

Re-exports AssembledToolCall


BatteryLifecycleBattery ​

Re-exports BatteryLifecycleBattery


BatteryLifecycleCallback ​

Re-exports BatteryLifecycleCallback


BatteryLifecycleHooks ​

Re-exports BatteryLifecycleHooks


BatteryLifecyclePhase ​

Re-exports BatteryLifecyclePhase


BatteryLifecycleReport ​

Re-exports BatteryLifecycleReport


buildChatCompletionsHistory ​

Re-exports buildChatCompletionsHistory


ChatCompletionsBucketLabel ​

Re-exports ChatCompletionsBucketLabel


ChatCompletionsBucketOrder ​

Re-exports ChatCompletionsBucketOrder


ChatCompletionsChunk ​

Re-exports ChatCompletionsChunk


ChatCompletionsHelpers ​

Re-exports ChatCompletionsHelpers


ChatCompletionsMessage ​

Re-exports ChatCompletionsMessage


ChatCompletionsResponse ​

Re-exports ChatCompletionsResponse


ChatCompletionsTool ​

Re-exports ChatCompletionsTool


ChatCompletionsToolCallDelta ​

Re-exports ChatCompletionsToolCallDelta


ChatCompletionsToolCallDeltaAccumulator ​

Re-exports ChatCompletionsToolCallDeltaAccumulator


createChatCompletionsToolCallDeltaAccumulator ​

Re-exports createChatCompletionsToolCallDeltaAccumulator


deCollideToolCallIds ​

Re-exports deCollideToolCallIds


defaultBuildChatCompletionsHistory ​

Re-exports defaultBuildChatCompletionsHistory


defaultCreateChatCompletionsToolCallDeltaAccumulator ​

Re-exports defaultCreateChatCompletionsToolCallDeltaAccumulator


defaultDescriptionToChatCompletionsJsonSchema ​

Re-exports defaultDescriptionToChatCompletionsJsonSchema


defaultFilterThoughts ​

Re-exports defaultFilterThoughts


defaultRenderChatCompletionsSystemPrompt ​

Re-exports defaultRenderChatCompletionsSystemPrompt


defaultRenderChatCompletionsToolCallResult ​

Re-exports defaultRenderChatCompletionsToolCallResult


defaultRenderFirstPartyRetrievables ​

Re-exports defaultRenderFirstPartyRetrievables


defaultRenderMemories ​

Re-exports defaultRenderMemories


defaultRenderRetrievables ​

Re-exports defaultRenderRetrievables


defaultRenderRetrievableSafetyDirective ​

Re-exports defaultRenderRetrievableSafetyDirective


defaultRenderStandingInstructions ​

Re-exports defaultRenderStandingInstructions


defaultRenderThirdPartyPrivateRetrievables ​

Re-exports defaultRenderThirdPartyPrivateRetrievables


defaultRenderThirdPartyPublicRetrievables ​

Re-exports defaultRenderThirdPartyPublicRetrievables


defaultRenderThought ​

Re-exports defaultRenderThought


defaultRenderTimelineMessage ​

Re-exports defaultRenderTimelineMessage


defaultRenderTrustedContent ​

Re-exports defaultRenderTrustedContent


defaultRenderUntrustedContent ​

Re-exports defaultRenderUntrustedContent


defaultToolsToChatCompletionsTools ​

Re-exports defaultToolsToChatCompletionsTools


DescriptionLike ​

Re-exports DescriptionLike


descriptionToChatCompletionsJsonSchema ​

Re-exports descriptionToChatCompletionsJsonSchema


E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS ​

Re-exports E_INVALID_WEBLLM_CHAT_COMPLETIONS_OPTIONS


E_UNSUPPORTED_MEDIA_MODALITY ​

Re-exports E_UNSUPPORTED_MEDIA_MODALITY


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


extractReasoningFields ​

Re-exports extractReasoningFields


filterThoughts ​

Re-exports filterThoughts


JsonSchema ​

Re-exports JsonSchema


MemoryAttrs ​

Re-exports MemoryAttrs


ReasoningExtract ​

Re-exports ReasoningExtract


ReasoningField ​

Re-exports ReasoningField


ReasoningFieldPrecedence ​

Re-exports ReasoningFieldPrecedence


renderChatCompletionsSystemPrompt ​

Re-exports renderChatCompletionsSystemPrompt


renderChatCompletionsToolCallResult ​

Re-exports renderChatCompletionsToolCallResult


renderFirstPartyRetrievables ​

Re-exports renderFirstPartyRetrievables


renderMemories ​

Re-exports renderMemories


renderRetrievables ​

Re-exports renderRetrievables


renderRetrievableSafetyDirective ​

Re-exports renderRetrievableSafetyDirective


renderStandingInstructions ​

Re-exports renderStandingInstructions


renderThirdPartyPrivateRetrievables ​

Re-exports renderThirdPartyPrivateRetrievables


renderThirdPartyPublicRetrievables ​

Re-exports renderThirdPartyPublicRetrievables


renderThought ​

Re-exports renderThought


renderTimelineMessage ​

Re-exports renderTimelineMessage


renderTrustedContent ​

Re-exports renderTrustedContent


renderUntrustedContent ​

Re-exports renderUntrustedContent


RetrievableAttrs ​

Re-exports RetrievableAttrs


StandingInstructionAttrs ​

Re-exports StandingInstructionAttrs


ThoughtAttrs ​

Re-exports ThoughtAttrs


ToolCallIdFilterFn ​

Re-exports ToolCallIdFilterFn


toolsToChatCompletionsTools ​

Re-exports toolsToChatCompletionsTools


TrustedContentAttrs ​

Re-exports TrustedContentAttrs


UntrustedContentAttrs ​

Re-exports UntrustedContentAttrs


validateOptions ​

Re-exports validateOptions


WebLLMChatCompletionsAdapter ​

Re-exports WebLLMChatCompletionsAdapter


WebLLMChatCompletionsAdapterOptions ​

Re-exports WebLLMChatCompletionsAdapterOptions


webLLMChatCompletionsOptionsSchema ​

Re-exports webLLMChatCompletionsOptionsSchema


WebLLMChatCompletionsRequestBody ​

Re-exports WebLLMChatCompletionsRequestBody


WebLLMEngine ​

Re-exports WebLLMEngine


WebLLMInitProgressReport ​

Re-exports WebLLMInitProgressReport