embeddingPlugin · Docs

← All plugins

import { embeddingPlugin } from '@routecraft/ai'

Provides the embedding service that embedding() reads its provider credentials from. Required when any capability uses embedding(). Releases native ONNX resources when the application stops (used by the huggingface provider).

import { embeddingPlugin } from '@routecraft/ai'
import type { CraftConfig } from '@routecraft/routecraft'

export const craftConfig: CraftConfig = {
  plugins: [
    embeddingPlugin({
      providers: {
        openai: { apiKey: process.env.OPENAI_API_KEY! },
      },
    }),
  ],
}

Options:

Option	Type	Required	Description
`providers`	`EmbeddingPluginProviders`	Yes	Provider credentials (at least one required)
`defaultOptions`	`Partial<EmbeddingOptions>`	No	Default options applied to all `embedding()` calls

Providers:

Provider	Options	Description
`huggingface`	`{}`	Local ONNX inference, no API key required
`ollama`	`{ baseURL?: string }`	Local Ollama instance
`openai`	`{ apiKey: string, baseURL?: string }`	OpenAI embeddings API
`mock`	`{}`	Deterministic test vectors, for use in tests

See embedding adapter for usage.