Vendor OpenClaw source as Adolf fork baseline
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
This commit is contained in:
270
extensions/llama-cpp/src/embedding-provider.ts
Normal file
270
extensions/llama-cpp/src/embedding-provider.ts
Normal file
@@ -0,0 +1,270 @@
|
||||
import { createRequire } from "node:module";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { pathToFileURL } from "node:url";
|
||||
import type {
|
||||
EmbeddingInput,
|
||||
EmbeddingProvider,
|
||||
EmbeddingProviderAdapter,
|
||||
EmbeddingProviderCreateOptions,
|
||||
EmbeddingProviderCreateResult,
|
||||
} from "openclaw/plugin-sdk/embedding-providers";
|
||||
import {
|
||||
createLocalEmbeddingProvider,
|
||||
type EmbeddingInput as MemoryEmbeddingInput,
|
||||
type MemoryEmbeddingProvider,
|
||||
type MemoryEmbeddingProviderCreateOptions,
|
||||
type MemoryEmbeddingProviderCreateResult,
|
||||
} from "openclaw/plugin-sdk/memory-core-host-engine-embeddings";
|
||||
|
||||
type LlamaCppLocalOptions = {
|
||||
modelPath?: string;
|
||||
modelCacheDir?: string;
|
||||
contextSize?: number | "auto";
|
||||
};
|
||||
|
||||
export type LlamaCppEmbeddingProviderRuntimeOptions = {
|
||||
nodeLlamaCppImportUrl?: string;
|
||||
};
|
||||
|
||||
export const LLAMA_CPP_EMBEDDING_PROVIDER_ID = "local";
|
||||
export const DEFAULT_LLAMA_CPP_EMBEDDING_MODEL =
|
||||
"hf:ggml-org/embeddinggemma-300m-qat-q8_0-GGUF/embeddinggemma-300m-qat-Q8_0.gguf";
|
||||
const DEFAULT_LLAMA_CPP_EMBEDDING_MODEL_CACHE_FILE_NAME =
|
||||
"hf_ggml-org_embeddinggemma-300m-qat-Q8_0.gguf";
|
||||
|
||||
type LlamaCppModelIdentity = {
|
||||
model: string;
|
||||
cacheKeyData: Record<string, unknown>;
|
||||
aliases: Array<{
|
||||
model: string;
|
||||
cacheKeyData: Record<string, unknown>;
|
||||
}>;
|
||||
};
|
||||
|
||||
function normalizeOptionalString(value: unknown): string | undefined {
|
||||
return typeof value === "string" && value.trim() ? value.trim() : undefined;
|
||||
}
|
||||
|
||||
function readLocalOptions(options: { local?: unknown }): LlamaCppLocalOptions {
|
||||
const local = options.local as LlamaCppLocalOptions | undefined;
|
||||
return local ?? {};
|
||||
}
|
||||
|
||||
function createLlamaCppCacheKeyData(
|
||||
model: string,
|
||||
outputDimensionality?: number,
|
||||
): Record<string, unknown> {
|
||||
return {
|
||||
provider: LLAMA_CPP_EMBEDDING_PROVIDER_ID,
|
||||
model,
|
||||
...(typeof outputDimensionality === "number" ? { outputDimensionality } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
function resolveLlamaCppModelIdentity(
|
||||
local: LlamaCppLocalOptions,
|
||||
modelPath: string,
|
||||
outputDimensionality?: number,
|
||||
): LlamaCppModelIdentity {
|
||||
const modelCacheDir =
|
||||
normalizeOptionalString(local.modelCacheDir) ??
|
||||
path.join(os.homedir(), ".node-llama-cpp", "models");
|
||||
const resolvedDefaultModelPath = path.resolve(
|
||||
modelCacheDir,
|
||||
DEFAULT_LLAMA_CPP_EMBEDDING_MODEL_CACHE_FILE_NAME,
|
||||
);
|
||||
const isModelUri = /^(?:hf:|https?:\/\/)/i.test(modelPath);
|
||||
const resolvedModelPath = isModelUri ? undefined : path.resolve(modelCacheDir, modelPath);
|
||||
// node-llama-cpp resolves the default HF URI to this exact cache target and
|
||||
// accepts its URI-derived filename relative to any configured cache directory.
|
||||
// Preserve that exact historical key; arbitrary filenames and paths stay distinct.
|
||||
if (
|
||||
modelPath !== DEFAULT_LLAMA_CPP_EMBEDDING_MODEL &&
|
||||
resolvedModelPath !== resolvedDefaultModelPath
|
||||
) {
|
||||
return {
|
||||
model: modelPath,
|
||||
cacheKeyData: createLlamaCppCacheKeyData(modelPath, outputDimensionality),
|
||||
aliases: [],
|
||||
};
|
||||
}
|
||||
const aliasModels = new Set([
|
||||
resolvedDefaultModelPath,
|
||||
DEFAULT_LLAMA_CPP_EMBEDDING_MODEL_CACHE_FILE_NAME,
|
||||
]);
|
||||
if (modelPath !== DEFAULT_LLAMA_CPP_EMBEDDING_MODEL) {
|
||||
aliasModels.add(modelPath);
|
||||
}
|
||||
return {
|
||||
model: DEFAULT_LLAMA_CPP_EMBEDDING_MODEL,
|
||||
cacheKeyData: createLlamaCppCacheKeyData(
|
||||
DEFAULT_LLAMA_CPP_EMBEDDING_MODEL,
|
||||
outputDimensionality,
|
||||
),
|
||||
aliases: Array.from(aliasModels, (aliasModel) => ({
|
||||
model: aliasModel,
|
||||
cacheKeyData: createLlamaCppCacheKeyData(aliasModel, outputDimensionality),
|
||||
})),
|
||||
};
|
||||
}
|
||||
|
||||
function textFromEmbeddingInput(input: EmbeddingInput): string {
|
||||
return typeof input === "string" ? input : input.text;
|
||||
}
|
||||
|
||||
function toMemoryEmbeddingInput(input: EmbeddingInput): MemoryEmbeddingInput {
|
||||
return typeof input === "string" ? { text: input } : input;
|
||||
}
|
||||
|
||||
function isNodeLlamaCppMissing(err: unknown): boolean {
|
||||
if (!(err instanceof Error)) {
|
||||
return false;
|
||||
}
|
||||
const code = (err as Error & { code?: unknown }).code;
|
||||
return code === "ERR_MODULE_NOT_FOUND" && err.message.includes("node-llama-cpp");
|
||||
}
|
||||
|
||||
function formatErrorMessage(err: unknown): string {
|
||||
if (err instanceof Error) {
|
||||
return err.message;
|
||||
}
|
||||
return String(err);
|
||||
}
|
||||
|
||||
export function formatLlamaCppSetupError(err: unknown): string {
|
||||
const detail = formatErrorMessage(err);
|
||||
const missing = isNodeLlamaCppMissing(err);
|
||||
return [
|
||||
"Local llama.cpp embeddings unavailable.",
|
||||
missing
|
||||
? "Reason: node-llama-cpp is missing or failed to install."
|
||||
: detail
|
||||
? `Reason: ${detail}`
|
||||
: undefined,
|
||||
missing && detail ? `Detail: ${detail}` : null,
|
||||
"To enable local GGUF embeddings:",
|
||||
"1) Install the official provider plugin: openclaw plugins install @openclaw/llama-cpp-provider",
|
||||
"2) Use Node 24 for native installs/updates.",
|
||||
"3) If you use pnpm from source: pnpm approve-builds, then pnpm rebuild node-llama-cpp.",
|
||||
'Or set agents.defaults.memorySearch.provider to a remote embedding provider such as "openai", "ollama", "lmstudio", or "voyage".',
|
||||
]
|
||||
.filter(Boolean)
|
||||
.join("\n");
|
||||
}
|
||||
|
||||
const requireFromPlugin = createRequire(import.meta.url);
|
||||
|
||||
export function resolveNodeLlamaCppImportUrl(): string {
|
||||
return pathToFileURL(requireFromPlugin.resolve("node-llama-cpp")).href;
|
||||
}
|
||||
|
||||
function adaptMemoryEmbeddingProvider(provider: MemoryEmbeddingProvider): EmbeddingProvider {
|
||||
return {
|
||||
id: LLAMA_CPP_EMBEDDING_PROVIDER_ID,
|
||||
model: provider.model,
|
||||
maxInputTokens: provider.maxInputTokens,
|
||||
embed: async (input, callOptions) =>
|
||||
await provider.embedQuery(textFromEmbeddingInput(input), {
|
||||
signal: callOptions?.signal,
|
||||
}),
|
||||
embedBatch: async (inputs, callOptions) => {
|
||||
if (provider.embedBatchInputs) {
|
||||
return await provider.embedBatchInputs(inputs.map(toMemoryEmbeddingInput), {
|
||||
signal: callOptions?.signal,
|
||||
});
|
||||
}
|
||||
return await provider.embedBatch(inputs.map(textFromEmbeddingInput), {
|
||||
signal: callOptions?.signal,
|
||||
});
|
||||
},
|
||||
close: provider.close,
|
||||
};
|
||||
}
|
||||
|
||||
export async function createLlamaCppMemoryEmbeddingProvider(
|
||||
options: MemoryEmbeddingProviderCreateOptions,
|
||||
runtimeOptions: LlamaCppEmbeddingProviderRuntimeOptions = {},
|
||||
): Promise<MemoryEmbeddingProviderCreateResult> {
|
||||
const createOptions = buildMemoryCreateOptions(options, options.outputDimensionality);
|
||||
const local = readLocalOptions(createOptions);
|
||||
const provider = await createLocalEmbeddingProvider(createOptions, {
|
||||
nodeLlamaCppImportUrl: runtimeOptions.nodeLlamaCppImportUrl ?? resolveNodeLlamaCppImportUrl(),
|
||||
});
|
||||
const identity = resolveLlamaCppModelIdentity(
|
||||
local,
|
||||
provider.model,
|
||||
createOptions.outputDimensionality,
|
||||
);
|
||||
const identifiedProvider =
|
||||
identity.model === provider.model ? provider : { ...provider, model: identity.model };
|
||||
return {
|
||||
provider: identifiedProvider,
|
||||
runtime: createLlamaCppEmbeddingProviderRuntime(identity),
|
||||
};
|
||||
}
|
||||
|
||||
async function createLlamaCppEmbeddingProviderResult(
|
||||
options: EmbeddingProviderCreateOptions,
|
||||
runtimeOptions: LlamaCppEmbeddingProviderRuntimeOptions = {},
|
||||
): Promise<EmbeddingProviderCreateResult> {
|
||||
const result = await createLlamaCppMemoryEmbeddingProvider(
|
||||
buildMemoryCreateOptions(options, options.dimensions),
|
||||
runtimeOptions,
|
||||
);
|
||||
return {
|
||||
provider: result.provider ? adaptMemoryEmbeddingProvider(result.provider) : null,
|
||||
runtime: result.runtime,
|
||||
};
|
||||
}
|
||||
|
||||
function buildMemoryCreateOptions(
|
||||
options: MemoryEmbeddingProviderCreateOptions | EmbeddingProviderCreateOptions,
|
||||
outputDimensionality: number | undefined,
|
||||
): MemoryEmbeddingProviderCreateOptions {
|
||||
const local = readLocalOptions(options);
|
||||
const modelPath = normalizeOptionalString(local.modelPath) || DEFAULT_LLAMA_CPP_EMBEDDING_MODEL;
|
||||
return {
|
||||
config: options.config,
|
||||
agentDir: options.agentDir,
|
||||
provider: LLAMA_CPP_EMBEDDING_PROVIDER_ID,
|
||||
fallback: "none",
|
||||
remote: options.remote,
|
||||
model: modelPath,
|
||||
inputType: options.inputType,
|
||||
queryInputType: options.queryInputType,
|
||||
documentInputType: options.documentInputType,
|
||||
local: {
|
||||
...local,
|
||||
modelPath,
|
||||
},
|
||||
outputDimensionality,
|
||||
};
|
||||
}
|
||||
|
||||
function createLlamaCppEmbeddingProviderRuntime(identity: LlamaCppModelIdentity) {
|
||||
return {
|
||||
id: LLAMA_CPP_EMBEDDING_PROVIDER_ID,
|
||||
inlineQueryTimeoutMs: 5 * 60_000,
|
||||
inlineBatchTimeoutMs: 10 * 60_000,
|
||||
cacheKeyData: identity.cacheKeyData,
|
||||
...(identity.aliases.length > 0 ? { indexIdentityAliases: identity.aliases } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
export const llamaCppEmbeddingProviderAdapter: EmbeddingProviderAdapter = {
|
||||
id: LLAMA_CPP_EMBEDDING_PROVIDER_ID,
|
||||
defaultModel: DEFAULT_LLAMA_CPP_EMBEDDING_MODEL,
|
||||
transport: "local",
|
||||
formatSetupError: formatLlamaCppSetupError,
|
||||
resolveIndexIdentity: (options) => {
|
||||
const createOptions = buildMemoryCreateOptions(options, options.dimensions);
|
||||
const local = readLocalOptions(createOptions);
|
||||
return resolveLlamaCppModelIdentity(
|
||||
local,
|
||||
normalizeOptionalString(local.modelPath) ?? DEFAULT_LLAMA_CPP_EMBEDDING_MODEL,
|
||||
createOptions.outputDimensionality,
|
||||
);
|
||||
},
|
||||
create: async (options) => await createLlamaCppEmbeddingProviderResult(options),
|
||||
};
|
||||
Reference in New Issue
Block a user