Skip to content
1 min read · 91 words

Type Alias: CreateWebLLMEmbeddingsEngine ​

ts
type CreateWebLLMEmbeddingsEngine = (input: {
  chatOptions?: ChatOptions | ChatOptions[];
  engineConfig?: MLCEngineConfig;
  model: string;
  onInitProgress?: (report: InitProgressReport) => void;
}) => Promise<WebLLMEmbeddingsEngine>;

Defined in: src/batteries/embeddings/webllm/types.ts:37

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.

Parameters ​

ParameterType
input{ chatOptions?: ChatOptions | ChatOptions[]; engineConfig?: MLCEngineConfig; model: string; onInitProgress?: (report: InitProgressReport) => void; }
input.chatOptions?ChatOptions | ChatOptions[]
input.engineConfig?MLCEngineConfig
input.modelstring
input.onInitProgress?(report: InitProgressReport) => void

Returns ​

Promise<WebLLMEmbeddingsEngine>