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:
76
extensions/deepgram/audio.live.test.ts
Normal file
76
extensions/deepgram/audio.live.test.ts
Normal file
@@ -0,0 +1,76 @@
|
||||
// Deepgram tests cover audio plugin behavior.
|
||||
import {
|
||||
runRealtimeSttLiveTest,
|
||||
synthesizeElevenLabsLiveSpeech,
|
||||
} from "openclaw/plugin-sdk/provider-test-contracts";
|
||||
import { isLiveTestEnabled } from "openclaw/plugin-sdk/test-env";
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { transcribeDeepgramAudio } from "./audio.js";
|
||||
import { buildDeepgramRealtimeTranscriptionProvider } from "./realtime-transcription-provider.js";
|
||||
|
||||
const DEEPGRAM_KEY = process.env.DEEPGRAM_API_KEY ?? "";
|
||||
const ELEVENLABS_KEY = process.env.ELEVENLABS_API_KEY ?? "";
|
||||
const DEEPGRAM_MODEL = process.env.DEEPGRAM_MODEL?.trim() || "nova-3";
|
||||
const DEEPGRAM_BASE_URL = process.env.DEEPGRAM_BASE_URL?.trim();
|
||||
const SAMPLE_URL =
|
||||
process.env.DEEPGRAM_SAMPLE_URL?.trim() ||
|
||||
"https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav";
|
||||
const LIVE = isLiveTestEnabled(["DEEPGRAM_LIVE_TEST"]);
|
||||
|
||||
const describeLive = LIVE && DEEPGRAM_KEY ? describe : describe.skip;
|
||||
|
||||
async function fetchSampleBuffer(url: string, timeoutMs: number): Promise<Buffer> {
|
||||
const controller = new AbortController();
|
||||
const timer = setTimeout(() => controller.abort(), Math.max(1, timeoutMs));
|
||||
try {
|
||||
const res = await fetch(url, { signal: controller.signal });
|
||||
if (!res.ok) {
|
||||
throw new Error(`Sample download failed (HTTP ${res.status})`);
|
||||
}
|
||||
const data = await res.arrayBuffer();
|
||||
return Buffer.from(data);
|
||||
} finally {
|
||||
clearTimeout(timer);
|
||||
}
|
||||
}
|
||||
|
||||
describeLive("deepgram live", () => {
|
||||
it("transcribes sample audio", async () => {
|
||||
const buffer = await fetchSampleBuffer(SAMPLE_URL, 15000);
|
||||
const result = await transcribeDeepgramAudio({
|
||||
buffer,
|
||||
fileName: "sample.wav",
|
||||
mime: "audio/wav",
|
||||
apiKey: DEEPGRAM_KEY,
|
||||
model: DEEPGRAM_MODEL,
|
||||
baseUrl: DEEPGRAM_BASE_URL,
|
||||
timeoutMs: 20000,
|
||||
});
|
||||
expect(result.text.trim().length).toBeGreaterThan(0);
|
||||
}, 30000);
|
||||
|
||||
it("streams realtime STT through the registered transcription provider", async () => {
|
||||
if (!ELEVENLABS_KEY) {
|
||||
throw new Error("ELEVENLABS_API_KEY required to synthesize live realtime STT input");
|
||||
}
|
||||
const provider = buildDeepgramRealtimeTranscriptionProvider();
|
||||
const phrase = "Testing OpenClaw Deepgram realtime transcription integration OK.";
|
||||
const speech = await synthesizeElevenLabsLiveSpeech({
|
||||
text: phrase,
|
||||
apiKey: ELEVENLABS_KEY,
|
||||
outputFormat: "ulaw_8000",
|
||||
timeoutMs: 30_000,
|
||||
});
|
||||
expect(speech.byteLength).toBeGreaterThan(0);
|
||||
|
||||
await runRealtimeSttLiveTest({
|
||||
provider,
|
||||
providerConfig: {
|
||||
apiKey: DEEPGRAM_KEY,
|
||||
language: "en-US",
|
||||
endpointingMs: 500,
|
||||
},
|
||||
audio: Buffer.concat([Buffer.alloc(4000, 0xff), speech, Buffer.alloc(8000, 0xff)]),
|
||||
});
|
||||
}, 90_000);
|
||||
});
|
||||
147
extensions/deepgram/audio.test.ts
Normal file
147
extensions/deepgram/audio.test.ts
Normal file
@@ -0,0 +1,147 @@
|
||||
// Deepgram tests cover audio plugin behavior.
|
||||
import {
|
||||
createAuthCaptureJsonFetch,
|
||||
createRequestCaptureJsonFetch,
|
||||
installPinnedHostnameTestHooks,
|
||||
} from "openclaw/plugin-sdk/test-env";
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
import { transcribeDeepgramAudio } from "./audio.js";
|
||||
|
||||
installPinnedHostnameTestHooks();
|
||||
|
||||
describe("transcribeDeepgramAudio", () => {
|
||||
it("respects lowercase authorization header overrides", async () => {
|
||||
const { fetchFn, getAuthHeader } = createAuthCaptureJsonFetch({
|
||||
results: { channels: [{ alternatives: [{ transcript: "ok" }] }] },
|
||||
});
|
||||
|
||||
const result = await transcribeDeepgramAudio({
|
||||
buffer: Buffer.from("audio"),
|
||||
fileName: "note.mp3",
|
||||
apiKey: "test-key",
|
||||
timeoutMs: 1000,
|
||||
headers: { authorization: "Token override" },
|
||||
fetchFn,
|
||||
});
|
||||
|
||||
expect(getAuthHeader()).toBe("Token override");
|
||||
expect(result.text).toBe("ok");
|
||||
});
|
||||
|
||||
it("builds the expected request payload", async () => {
|
||||
const { fetchFn, getRequest } = createRequestCaptureJsonFetch({
|
||||
results: { channels: [{ alternatives: [{ transcript: "hello" }] }] },
|
||||
});
|
||||
|
||||
const result = await transcribeDeepgramAudio({
|
||||
buffer: Buffer.from("audio-bytes"),
|
||||
fileName: "voice.wav",
|
||||
apiKey: "test-key",
|
||||
timeoutMs: 1234,
|
||||
baseUrl: "https://api.example.com/v1/",
|
||||
model: " ",
|
||||
language: " en ",
|
||||
mime: "audio/wav",
|
||||
headers: { "X-Custom": "1" },
|
||||
query: {
|
||||
punctuate: false,
|
||||
smart_format: true,
|
||||
},
|
||||
fetchFn,
|
||||
});
|
||||
const { url: seenUrl, init: seenInit } = getRequest();
|
||||
|
||||
expect(result.model).toBe("nova-3");
|
||||
expect(result.text).toBe("hello");
|
||||
expect(seenUrl).toBe(
|
||||
"https://api.example.com/v1/listen?model=nova-3&language=en&punctuate=false&smart_format=true",
|
||||
);
|
||||
if (!seenInit) {
|
||||
throw new Error("Expected Deepgram fetch request init");
|
||||
}
|
||||
expect(seenInit.method).toBe("POST");
|
||||
expect(seenInit.signal).toBeInstanceOf(AbortSignal);
|
||||
|
||||
const headers = new Headers(seenInit.headers);
|
||||
expect(headers.get("authorization")).toBe("Token test-key");
|
||||
expect(headers.get("x-custom")).toBe("1");
|
||||
expect(headers.get("content-type")).toBe("audio/wav");
|
||||
expect(seenInit.body).toBeInstanceOf(Uint8Array);
|
||||
});
|
||||
|
||||
it("throws when the provider response omits transcript", async () => {
|
||||
const { fetchFn } = createRequestCaptureJsonFetch({
|
||||
results: { channels: [{ alternatives: [{}] }] },
|
||||
});
|
||||
|
||||
await expect(
|
||||
transcribeDeepgramAudio({
|
||||
buffer: Buffer.from("audio-bytes"),
|
||||
fileName: "voice.wav",
|
||||
apiKey: "test-key",
|
||||
timeoutMs: 1234,
|
||||
fetchFn,
|
||||
}),
|
||||
).rejects.toThrow("Audio transcription response missing transcript");
|
||||
});
|
||||
|
||||
it("wraps malformed successful transcription JSON with a stable provider error", async () => {
|
||||
const fetchFn = vi.fn<typeof fetch>().mockResolvedValueOnce(new Response("{ nope"));
|
||||
|
||||
await expect(
|
||||
transcribeDeepgramAudio({
|
||||
buffer: Buffer.from("audio-bytes"),
|
||||
fileName: "voice.wav",
|
||||
apiKey: "test-key",
|
||||
timeoutMs: 1234,
|
||||
fetchFn,
|
||||
}),
|
||||
).rejects.toThrow("Audio transcription failed: malformed JSON response");
|
||||
});
|
||||
|
||||
it("rejects non-object successful transcription JSON with a stable provider error", async () => {
|
||||
const fetchFn = vi.fn<typeof fetch>().mockResolvedValueOnce(new Response(JSON.stringify([])));
|
||||
|
||||
await expect(
|
||||
transcribeDeepgramAudio({
|
||||
buffer: Buffer.from("audio-bytes"),
|
||||
fileName: "voice.wav",
|
||||
apiKey: "test-key",
|
||||
timeoutMs: 1234,
|
||||
fetchFn,
|
||||
}),
|
||||
).rejects.toThrow("Audio transcription failed: malformed JSON response");
|
||||
});
|
||||
|
||||
it("rejects wrong nested transcript shapes with a stable provider error", async () => {
|
||||
const { fetchFn } = createRequestCaptureJsonFetch({
|
||||
results: { channels: { alternatives: [{ transcript: "hello" }] } },
|
||||
});
|
||||
|
||||
await expect(
|
||||
transcribeDeepgramAudio({
|
||||
buffer: Buffer.from("audio-bytes"),
|
||||
fileName: "voice.wav",
|
||||
apiKey: "test-key",
|
||||
timeoutMs: 1234,
|
||||
fetchFn,
|
||||
}),
|
||||
).rejects.toThrow("Audio transcription failed: malformed JSON response");
|
||||
});
|
||||
|
||||
it("rejects non-string transcript values with a stable provider error", async () => {
|
||||
const { fetchFn } = createRequestCaptureJsonFetch({
|
||||
results: { channels: [{ alternatives: [{ transcript: 123 }] }] },
|
||||
});
|
||||
|
||||
await expect(
|
||||
transcribeDeepgramAudio({
|
||||
buffer: Buffer.from("audio-bytes"),
|
||||
fileName: "voice.wav",
|
||||
apiKey: "test-key",
|
||||
timeoutMs: 1234,
|
||||
fetchFn,
|
||||
}),
|
||||
).rejects.toThrow("Audio transcription failed: malformed JSON response");
|
||||
});
|
||||
});
|
||||
105
extensions/deepgram/audio.ts
Normal file
105
extensions/deepgram/audio.ts
Normal file
@@ -0,0 +1,105 @@
|
||||
// Deepgram plugin module implements audio behavior.
|
||||
import type {
|
||||
AudioTranscriptionRequest,
|
||||
AudioTranscriptionResult,
|
||||
} from "openclaw/plugin-sdk/media-understanding";
|
||||
import {
|
||||
assertOkOrThrowHttpError,
|
||||
postTranscriptionRequest,
|
||||
readProviderJsonObjectResponse,
|
||||
resolveProviderHttpRequestConfig,
|
||||
requireTranscriptionText,
|
||||
} from "openclaw/plugin-sdk/provider-http";
|
||||
import { asOptionalRecord as asRecord } from "openclaw/plugin-sdk/string-coerce-runtime";
|
||||
|
||||
export const DEFAULT_DEEPGRAM_AUDIO_BASE_URL = "https://api.deepgram.com/v1";
|
||||
export const DEFAULT_DEEPGRAM_AUDIO_MODEL = "nova-3";
|
||||
|
||||
function resolveModel(model?: string): string {
|
||||
const trimmed = model?.trim();
|
||||
return trimmed || DEFAULT_DEEPGRAM_AUDIO_MODEL;
|
||||
}
|
||||
|
||||
function readDeepgramTranscript(payload: Record<string, unknown>): string | undefined {
|
||||
const results = asRecord(payload.results);
|
||||
if (!results) {
|
||||
return undefined;
|
||||
}
|
||||
if (!Array.isArray(results.channels)) {
|
||||
throw new Error("Audio transcription failed: malformed JSON response");
|
||||
}
|
||||
const channel = asRecord(results.channels[0]);
|
||||
if (!channel) {
|
||||
return undefined;
|
||||
}
|
||||
if (!Array.isArray(channel.alternatives)) {
|
||||
throw new Error("Audio transcription failed: malformed JSON response");
|
||||
}
|
||||
const alternative = asRecord(channel.alternatives[0]);
|
||||
if (!alternative) {
|
||||
return undefined;
|
||||
}
|
||||
if (alternative.transcript !== undefined && typeof alternative.transcript !== "string") {
|
||||
throw new Error("Audio transcription failed: malformed JSON response");
|
||||
}
|
||||
return alternative.transcript;
|
||||
}
|
||||
|
||||
export async function transcribeDeepgramAudio(
|
||||
params: AudioTranscriptionRequest,
|
||||
): Promise<AudioTranscriptionResult> {
|
||||
const fetchFn = params.fetchFn ?? fetch;
|
||||
const model = resolveModel(params.model);
|
||||
const { baseUrl, allowPrivateNetwork, headers, dispatcherPolicy } =
|
||||
resolveProviderHttpRequestConfig({
|
||||
baseUrl: params.baseUrl,
|
||||
defaultBaseUrl: DEFAULT_DEEPGRAM_AUDIO_BASE_URL,
|
||||
headers: params.headers,
|
||||
request: params.request,
|
||||
defaultHeaders: {
|
||||
authorization: `Token ${params.apiKey}`,
|
||||
"content-type": params.mime ?? "application/octet-stream",
|
||||
},
|
||||
provider: "deepgram",
|
||||
capability: "audio",
|
||||
transport: "media-understanding",
|
||||
});
|
||||
|
||||
const url = new URL(`${baseUrl}/listen`);
|
||||
url.searchParams.set("model", model);
|
||||
if (params.language?.trim()) {
|
||||
url.searchParams.set("language", params.language.trim());
|
||||
}
|
||||
if (params.query) {
|
||||
for (const [key, value] of Object.entries(params.query)) {
|
||||
if (value === undefined) {
|
||||
continue;
|
||||
}
|
||||
url.searchParams.set(key, String(value));
|
||||
}
|
||||
}
|
||||
|
||||
const body = new Uint8Array(params.buffer);
|
||||
const { response: res, release } = await postTranscriptionRequest({
|
||||
url: url.toString(),
|
||||
headers,
|
||||
body,
|
||||
timeoutMs: params.timeoutMs,
|
||||
fetchFn,
|
||||
allowPrivateNetwork,
|
||||
dispatcherPolicy,
|
||||
});
|
||||
|
||||
try {
|
||||
await assertOkOrThrowHttpError(res, "Audio transcription failed");
|
||||
|
||||
const payload = await readProviderJsonObjectResponse(res, "Audio transcription failed");
|
||||
const transcript = requireTranscriptionText(
|
||||
readDeepgramTranscript(payload),
|
||||
"Audio transcription response missing transcript",
|
||||
);
|
||||
return { text: transcript, model };
|
||||
} finally {
|
||||
await release();
|
||||
}
|
||||
}
|
||||
14
extensions/deepgram/index.ts
Normal file
14
extensions/deepgram/index.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
// Deepgram plugin entrypoint registers its OpenClaw integration.
|
||||
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
|
||||
import { deepgramMediaUnderstandingProvider } from "./media-understanding-provider.js";
|
||||
import { buildDeepgramRealtimeTranscriptionProvider } from "./realtime-transcription-provider.js";
|
||||
|
||||
export default definePluginEntry({
|
||||
id: "deepgram",
|
||||
name: "Deepgram Media Understanding",
|
||||
description: "Bundled Deepgram audio transcription provider",
|
||||
register(api) {
|
||||
api.registerMediaUnderstandingProvider(deepgramMediaUnderstandingProvider);
|
||||
api.registerRealtimeTranscriptionProvider(buildDeepgramRealtimeTranscriptionProvider());
|
||||
},
|
||||
});
|
||||
11
extensions/deepgram/media-understanding-provider.ts
Normal file
11
extensions/deepgram/media-understanding-provider.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
// Deepgram provider module implements model/runtime integration.
|
||||
import type { MediaUnderstandingProvider } from "openclaw/plugin-sdk/media-understanding";
|
||||
import { transcribeDeepgramAudio } from "./audio.js";
|
||||
|
||||
export const deepgramMediaUnderstandingProvider: MediaUnderstandingProvider = {
|
||||
id: "deepgram",
|
||||
capabilities: ["audio"],
|
||||
defaultModels: { audio: "nova-3" },
|
||||
autoPriority: { audio: 30 },
|
||||
transcribeAudio: transcribeDeepgramAudio,
|
||||
};
|
||||
36
extensions/deepgram/openclaw.plugin.json
Normal file
36
extensions/deepgram/openclaw.plugin.json
Normal file
@@ -0,0 +1,36 @@
|
||||
{
|
||||
"id": "deepgram",
|
||||
"icon": "https://cdn.simpleicons.org/deepgram",
|
||||
"activation": {
|
||||
"onStartup": false
|
||||
},
|
||||
"enabledByDefault": true,
|
||||
"setup": {
|
||||
"providers": [
|
||||
{
|
||||
"id": "deepgram",
|
||||
"envVars": ["DEEPGRAM_API_KEY"]
|
||||
}
|
||||
]
|
||||
},
|
||||
"contracts": {
|
||||
"mediaUnderstandingProviders": ["deepgram"],
|
||||
"realtimeTranscriptionProviders": ["deepgram"]
|
||||
},
|
||||
"mediaUnderstandingProviderMetadata": {
|
||||
"deepgram": {
|
||||
"capabilities": ["audio"],
|
||||
"defaultModels": {
|
||||
"audio": "nova-3"
|
||||
},
|
||||
"autoPriority": {
|
||||
"audio": 30
|
||||
}
|
||||
}
|
||||
},
|
||||
"configSchema": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
}
|
||||
}
|
||||
15
extensions/deepgram/package.json
Normal file
15
extensions/deepgram/package.json
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "@openclaw/deepgram-provider",
|
||||
"version": "2026.6.11",
|
||||
"private": true,
|
||||
"description": "OpenClaw Deepgram media-understanding provider",
|
||||
"type": "module",
|
||||
"devDependencies": {
|
||||
"@openclaw/plugin-sdk": "workspace:*"
|
||||
},
|
||||
"openclaw": {
|
||||
"extensions": [
|
||||
"./index.ts"
|
||||
]
|
||||
}
|
||||
}
|
||||
70
extensions/deepgram/realtime-transcription-provider.test.ts
Normal file
70
extensions/deepgram/realtime-transcription-provider.test.ts
Normal file
@@ -0,0 +1,70 @@
|
||||
// Deepgram tests cover realtime transcription provider plugin behavior.
|
||||
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-contracts";
|
||||
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||
import {
|
||||
testing,
|
||||
buildDeepgramRealtimeTranscriptionProvider,
|
||||
} from "./realtime-transcription-provider.js";
|
||||
|
||||
describe("buildDeepgramRealtimeTranscriptionProvider", () => {
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
it("normalizes nested provider config", () => {
|
||||
const provider = buildDeepgramRealtimeTranscriptionProvider();
|
||||
const resolved = provider.resolveConfig?.({
|
||||
cfg: {} as OpenClawConfig,
|
||||
rawConfig: {
|
||||
providers: {
|
||||
deepgram: {
|
||||
apiKey: "dg-key",
|
||||
model: "nova-3",
|
||||
encoding: "g711_ulaw",
|
||||
sample_rate: "8000",
|
||||
interim_results: "true",
|
||||
endpointing: "500",
|
||||
language: "en-US",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(resolved).toEqual({
|
||||
apiKey: "dg-key",
|
||||
baseUrl: undefined,
|
||||
model: "nova-3",
|
||||
language: "en-US",
|
||||
sampleRate: 8000,
|
||||
encoding: "mulaw",
|
||||
interimResults: true,
|
||||
endpointingMs: 500,
|
||||
});
|
||||
});
|
||||
|
||||
it("builds a Deepgram listen websocket URL", () => {
|
||||
const url = testing.toDeepgramRealtimeWsUrl({
|
||||
apiKey: "dg-key",
|
||||
baseUrl: "https://api.deepgram.com/v1",
|
||||
model: "nova-3",
|
||||
providerConfig: {},
|
||||
sampleRate: 8000,
|
||||
encoding: "mulaw",
|
||||
interimResults: true,
|
||||
endpointingMs: 800,
|
||||
});
|
||||
|
||||
expect(url).toContain("wss://api.deepgram.com/v1/listen?");
|
||||
expect(url).toContain("model=nova-3");
|
||||
expect(url).toContain("encoding=mulaw");
|
||||
expect(url).toContain("sample_rate=8000");
|
||||
});
|
||||
|
||||
it("requires an API key when creating sessions", () => {
|
||||
vi.stubEnv("DEEPGRAM_API_KEY", "");
|
||||
const provider = buildDeepgramRealtimeTranscriptionProvider();
|
||||
expect(() => provider.createSession({ providerConfig: {} })).toThrow(
|
||||
"Deepgram API key missing",
|
||||
);
|
||||
});
|
||||
});
|
||||
255
extensions/deepgram/realtime-transcription-provider.ts
Normal file
255
extensions/deepgram/realtime-transcription-provider.ts
Normal file
@@ -0,0 +1,255 @@
|
||||
// Deepgram provider module implements model/runtime integration.
|
||||
import {
|
||||
createRealtimeTranscriptionWebSocketSession,
|
||||
type RealtimeTranscriptionProviderConfig,
|
||||
type RealtimeTranscriptionProviderPlugin,
|
||||
type RealtimeTranscriptionSession,
|
||||
type RealtimeTranscriptionSessionCreateRequest,
|
||||
} from "openclaw/plugin-sdk/realtime-transcription";
|
||||
import { normalizeResolvedSecretInputString } from "openclaw/plugin-sdk/secret-input";
|
||||
import {
|
||||
asOptionalRecord as readRecord,
|
||||
normalizeOptionalString,
|
||||
parseBooleanValue as readBoolean,
|
||||
parseFiniteNumber as readFiniteNumber,
|
||||
} from "openclaw/plugin-sdk/string-coerce-runtime";
|
||||
import { DEFAULT_DEEPGRAM_AUDIO_BASE_URL, DEFAULT_DEEPGRAM_AUDIO_MODEL } from "./audio.js";
|
||||
|
||||
type DeepgramRealtimeTranscriptionEncoding = "linear16" | "mulaw" | "alaw";
|
||||
|
||||
type DeepgramRealtimeTranscriptionProviderConfig = {
|
||||
apiKey?: string;
|
||||
baseUrl?: string;
|
||||
model?: string;
|
||||
language?: string;
|
||||
sampleRate?: number;
|
||||
encoding?: DeepgramRealtimeTranscriptionEncoding;
|
||||
interimResults?: boolean;
|
||||
endpointingMs?: number;
|
||||
};
|
||||
|
||||
type DeepgramRealtimeTranscriptionSessionConfig = RealtimeTranscriptionSessionCreateRequest & {
|
||||
apiKey: string;
|
||||
baseUrl: string;
|
||||
model: string;
|
||||
sampleRate: number;
|
||||
encoding: DeepgramRealtimeTranscriptionEncoding;
|
||||
interimResults: boolean;
|
||||
endpointingMs: number;
|
||||
language?: string;
|
||||
};
|
||||
|
||||
type DeepgramRealtimeTranscriptionEvent = {
|
||||
type?: string;
|
||||
channel?: {
|
||||
alternatives?: Array<{
|
||||
transcript?: string;
|
||||
}>;
|
||||
};
|
||||
is_final?: boolean;
|
||||
speech_final?: boolean;
|
||||
error?: unknown;
|
||||
message?: string;
|
||||
};
|
||||
|
||||
const DEEPGRAM_REALTIME_DEFAULT_SAMPLE_RATE = 8000;
|
||||
const DEEPGRAM_REALTIME_DEFAULT_ENCODING: DeepgramRealtimeTranscriptionEncoding = "mulaw";
|
||||
const DEEPGRAM_REALTIME_DEFAULT_ENDPOINTING_MS = 800;
|
||||
const DEEPGRAM_REALTIME_CONNECT_TIMEOUT_MS = 10_000;
|
||||
const DEEPGRAM_REALTIME_CLOSE_TIMEOUT_MS = 5_000;
|
||||
const DEEPGRAM_REALTIME_MAX_RECONNECT_ATTEMPTS = 5;
|
||||
const DEEPGRAM_REALTIME_RECONNECT_DELAY_MS = 1000;
|
||||
const DEEPGRAM_REALTIME_MAX_QUEUED_BYTES = 2 * 1024 * 1024;
|
||||
|
||||
function readNestedDeepgramConfig(rawConfig: RealtimeTranscriptionProviderConfig) {
|
||||
const raw = readRecord(rawConfig);
|
||||
const providers = readRecord(raw?.providers);
|
||||
return readRecord(providers?.deepgram ?? raw?.deepgram ?? raw) ?? {};
|
||||
}
|
||||
|
||||
function normalizeDeepgramEncoding(
|
||||
value: unknown,
|
||||
): DeepgramRealtimeTranscriptionEncoding | undefined {
|
||||
const normalized = normalizeOptionalString(value)?.toLowerCase();
|
||||
if (!normalized) {
|
||||
return undefined;
|
||||
}
|
||||
if (normalized === "pcm" || normalized === "pcm_s16le" || normalized === "linear16") {
|
||||
return "linear16";
|
||||
}
|
||||
if (normalized === "ulaw" || normalized === "g711_ulaw" || normalized === "g711-mulaw") {
|
||||
return "mulaw";
|
||||
}
|
||||
if (normalized === "g711_alaw" || normalized === "g711-alaw") {
|
||||
return "alaw";
|
||||
}
|
||||
if (normalized === "mulaw" || normalized === "alaw") {
|
||||
return normalized;
|
||||
}
|
||||
throw new Error(`Invalid Deepgram realtime transcription encoding: ${normalized}`);
|
||||
}
|
||||
|
||||
function normalizeDeepgramRealtimeBaseUrl(value?: string): string {
|
||||
return (
|
||||
normalizeOptionalString(value ?? process.env.DEEPGRAM_BASE_URL) ??
|
||||
DEFAULT_DEEPGRAM_AUDIO_BASE_URL
|
||||
);
|
||||
}
|
||||
|
||||
function toDeepgramRealtimeWsUrl(config: DeepgramRealtimeTranscriptionSessionConfig): string {
|
||||
const url = new URL(normalizeDeepgramRealtimeBaseUrl(config.baseUrl));
|
||||
url.protocol = url.protocol === "http:" ? "ws:" : "wss:";
|
||||
url.pathname = `${url.pathname.replace(/\/+$/, "")}/listen`;
|
||||
url.searchParams.set("model", config.model);
|
||||
url.searchParams.set("encoding", config.encoding);
|
||||
url.searchParams.set("sample_rate", String(config.sampleRate));
|
||||
url.searchParams.set("channels", "1");
|
||||
url.searchParams.set("interim_results", String(config.interimResults));
|
||||
url.searchParams.set("endpointing", String(config.endpointingMs));
|
||||
if (config.language) {
|
||||
url.searchParams.set("language", config.language);
|
||||
}
|
||||
return url.toString();
|
||||
}
|
||||
|
||||
function normalizeProviderConfig(
|
||||
config: RealtimeTranscriptionProviderConfig,
|
||||
): DeepgramRealtimeTranscriptionProviderConfig {
|
||||
const raw = readNestedDeepgramConfig(config);
|
||||
return {
|
||||
apiKey: normalizeResolvedSecretInputString({
|
||||
value: raw.apiKey,
|
||||
path: "plugins.entries.voice-call.config.streaming.providers.deepgram.apiKey",
|
||||
}),
|
||||
baseUrl: normalizeOptionalString(raw.baseUrl),
|
||||
model: normalizeOptionalString(raw.model ?? raw.sttModel),
|
||||
language: normalizeOptionalString(raw.language),
|
||||
sampleRate: readFiniteNumber(raw.sampleRate ?? raw.sample_rate),
|
||||
encoding: normalizeDeepgramEncoding(raw.encoding),
|
||||
interimResults: readBoolean(raw.interimResults ?? raw.interim_results),
|
||||
endpointingMs: readFiniteNumber(raw.endpointingMs ?? raw.endpointing ?? raw.silenceDurationMs),
|
||||
};
|
||||
}
|
||||
|
||||
function readErrorDetail(value: unknown): string {
|
||||
if (typeof value === "string") {
|
||||
return value;
|
||||
}
|
||||
const record = readRecord(value);
|
||||
const message = normalizeOptionalString(record?.message);
|
||||
const code = normalizeOptionalString(record?.code);
|
||||
return message ?? code ?? "Deepgram realtime transcription error";
|
||||
}
|
||||
|
||||
function readTranscriptText(event: DeepgramRealtimeTranscriptionEvent): string | undefined {
|
||||
return normalizeOptionalString(event.channel?.alternatives?.[0]?.transcript);
|
||||
}
|
||||
|
||||
function createDeepgramRealtimeTranscriptionSession(
|
||||
config: DeepgramRealtimeTranscriptionSessionConfig,
|
||||
): RealtimeTranscriptionSession {
|
||||
let lastTranscript: string | undefined;
|
||||
let speechStarted = false;
|
||||
|
||||
const emitTranscript = (text: string) => {
|
||||
if (text === lastTranscript) {
|
||||
return;
|
||||
}
|
||||
lastTranscript = text;
|
||||
config.onTranscript?.(text);
|
||||
};
|
||||
|
||||
const handleEvent = (event: DeepgramRealtimeTranscriptionEvent) => {
|
||||
switch (event.type) {
|
||||
case "Results": {
|
||||
const text = readTranscriptText(event);
|
||||
if (!text) {
|
||||
return;
|
||||
}
|
||||
if (!speechStarted) {
|
||||
speechStarted = true;
|
||||
config.onSpeechStart?.();
|
||||
}
|
||||
if (event.is_final || event.speech_final) {
|
||||
emitTranscript(text);
|
||||
if (event.speech_final) {
|
||||
speechStarted = false;
|
||||
}
|
||||
return;
|
||||
}
|
||||
config.onPartial?.(text);
|
||||
return;
|
||||
}
|
||||
case "SpeechStarted":
|
||||
speechStarted = true;
|
||||
config.onSpeechStart?.();
|
||||
return;
|
||||
case "Error":
|
||||
case "error":
|
||||
config.onError?.(new Error(readErrorDetail(event.error ?? event.message)));
|
||||
|
||||
default:
|
||||
}
|
||||
};
|
||||
|
||||
return createRealtimeTranscriptionWebSocketSession<DeepgramRealtimeTranscriptionEvent>({
|
||||
providerId: "deepgram",
|
||||
callbacks: config,
|
||||
url: () => toDeepgramRealtimeWsUrl(config),
|
||||
headers: { Authorization: `Token ${config.apiKey}` },
|
||||
readyOnOpen: true,
|
||||
connectTimeoutMs: DEEPGRAM_REALTIME_CONNECT_TIMEOUT_MS,
|
||||
closeTimeoutMs: DEEPGRAM_REALTIME_CLOSE_TIMEOUT_MS,
|
||||
maxReconnectAttempts: DEEPGRAM_REALTIME_MAX_RECONNECT_ATTEMPTS,
|
||||
reconnectDelayMs: DEEPGRAM_REALTIME_RECONNECT_DELAY_MS,
|
||||
maxQueuedBytes: DEEPGRAM_REALTIME_MAX_QUEUED_BYTES,
|
||||
connectTimeoutMessage: "Deepgram realtime transcription connection timeout",
|
||||
connectClosedBeforeReadyMessage:
|
||||
"Deepgram realtime transcription connection closed before ready",
|
||||
reconnectLimitMessage: "Deepgram realtime transcription reconnect limit reached",
|
||||
sendAudio: (audio, transport) => {
|
||||
transport.sendBinary(audio);
|
||||
},
|
||||
onClose: (transport) => {
|
||||
transport.sendJson({ type: "Finalize" });
|
||||
},
|
||||
onMessage: handleEvent,
|
||||
});
|
||||
}
|
||||
|
||||
export function buildDeepgramRealtimeTranscriptionProvider(): RealtimeTranscriptionProviderPlugin {
|
||||
return {
|
||||
id: "deepgram",
|
||||
label: "Deepgram Realtime Transcription",
|
||||
aliases: ["deepgram-realtime", "nova-3-streaming"],
|
||||
defaultModel: DEFAULT_DEEPGRAM_AUDIO_MODEL,
|
||||
autoSelectOrder: 35,
|
||||
resolveConfig: ({ rawConfig }) => normalizeProviderConfig(rawConfig),
|
||||
isConfigured: ({ providerConfig }) =>
|
||||
Boolean(normalizeProviderConfig(providerConfig).apiKey || process.env.DEEPGRAM_API_KEY),
|
||||
createSession: (req) => {
|
||||
const config = normalizeProviderConfig(req.providerConfig);
|
||||
const apiKey = config.apiKey || process.env.DEEPGRAM_API_KEY;
|
||||
if (!apiKey) {
|
||||
throw new Error("Deepgram API key missing");
|
||||
}
|
||||
return createDeepgramRealtimeTranscriptionSession({
|
||||
...req,
|
||||
apiKey,
|
||||
baseUrl: normalizeDeepgramRealtimeBaseUrl(config.baseUrl),
|
||||
model: config.model ?? DEFAULT_DEEPGRAM_AUDIO_MODEL,
|
||||
sampleRate: config.sampleRate ?? DEEPGRAM_REALTIME_DEFAULT_SAMPLE_RATE,
|
||||
encoding: config.encoding ?? DEEPGRAM_REALTIME_DEFAULT_ENCODING,
|
||||
interimResults: config.interimResults ?? true,
|
||||
endpointingMs: config.endpointingMs ?? DEEPGRAM_REALTIME_DEFAULT_ENDPOINTING_MS,
|
||||
language: config.language,
|
||||
});
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export const testing = {
|
||||
normalizeProviderConfig,
|
||||
toDeepgramRealtimeWsUrl,
|
||||
};
|
||||
export { testing as __testing };
|
||||
3
extensions/deepgram/test-api.ts
Normal file
3
extensions/deepgram/test-api.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
// Deepgram API module exposes the plugin public contract.
|
||||
export { deepgramMediaUnderstandingProvider } from "./media-understanding-provider.js";
|
||||
export { buildDeepgramRealtimeTranscriptionProvider } from "./realtime-transcription-provider.js";
|
||||
16
extensions/deepgram/tsconfig.json
Normal file
16
extensions/deepgram/tsconfig.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"extends": "../tsconfig.package-boundary.base.json",
|
||||
"compilerOptions": {
|
||||
"rootDir": "."
|
||||
},
|
||||
"include": ["./*.ts", "./src/**/*.ts"],
|
||||
"exclude": [
|
||||
"./**/*.test.ts",
|
||||
"./dist/**",
|
||||
"./node_modules/**",
|
||||
"./src/test-support/**",
|
||||
"./src/**/*test-helpers.ts",
|
||||
"./src/**/*test-harness.ts",
|
||||
"./src/**/*test-support.ts"
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user