Skip to content
1 min read · 177 words

@nhtio/adk/batteries/embeddings/webllm/types

Option and engine types for the WebLLM Embeddings adapter.

Remarks

Builds on the shared embeddings option base owned by the OpenAI Embeddings battery (@nhtio/adk/batteries/embeddings/openai/types!BaseEmbeddingsAdapterOptions). The two batteries differ only in their engine: this one Omits nothing from the base (the base carries no HTTP fields) and adds the WebGPU/MLC engine knobs — exactly how the WebLLM Chat Completions battery extends the OpenAI Chat Completions option type.

Interfaces

InterfaceDescription
WebLLMEmbeddingsAdapterOptionsConstructor options for @nhtio/adk/batteries/embeddings/webllm/adapter!WebLLMEmbeddingsAdapter.

Type Aliases

Type AliasDescription
CreateWebLLMEmbeddingsEngineFactory 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.
WebLLMEmbeddingsEngineThe WebLLM engine handle this battery drives. Alias of MLCEngineInterface.
WebLLMEmbeddingsInitProgressReportProgress report emitted while the engine loads weights. Alias of InitProgressReport.

References

BaseEmbeddingsAdapterOptions

Re-exports BaseEmbeddingsAdapterOptions


EmbeddingKind

Re-exports EmbeddingKind


EmbedOptions

Re-exports EmbedOptions