Directories
¶
| Path | Synopsis |
|---|---|
|
Package ai wires the Genkit runtime and the SpeechKit model catalog into a single LLM/embedding/reranker surface used by Assist and the Voice Agent pipeline-fallback path.
|
Package ai wires the Genkit runtime and the SpeechKit model catalog into a single LLM/embedding/reranker surface used by Assist and the Voice Agent pipeline-fallback path. |
|
Package assist implements the Assist Mode pipeline: STT transcript → Codeword check → LLM → TTS → Result with both text and audio.
|
Package assist implements the Assist Mode pipeline: STT transcript → Codeword check → LLM → TTS → Result with both text and audio. |
|
skills/voice_companion
Package voice_companion provides ToolExecutor-compatible skill plugins for SpeechKit's Voice-Companion pattern.
|
Package voice_companion provides ToolExecutor-compatible skill plugins for SpeechKit's Voice-Companion pattern. |
|
Package audio is the platform-neutral audio I/O kernel.
|
Package audio is the platform-neutral audio I/O kernel. |
|
Package auditlog provides the dedicated audit-event stream for SpeechKit.
|
Package auditlog provides the dedicated audit-event stream for SpeechKit. |
|
Package auditlogtest provides test-only helpers for resetting the audit log package state between test cases.
|
Package auditlogtest provides test-only helpers for resetting the audit log package state between test cases. |
|
Package auth provides the authentication abstraction for SpeechKit.
|
Package auth provides the authentication abstraction for SpeechKit. |
|
Package config defines SpeechKit's TOML configuration schema and the load/merge/validate helpers around it.
|
Package config defines SpeechKit's TOML configuration schema and the load/merge/validate helpers around it. |
|
Package desktop hosts the Device-Target runtime helpers (mode dispatcher, control-plane, update checker, settings persistence) that the Windows Wails reference UI under cmd/speechkit/ wires together.
|
Package desktop hosts the Device-Target runtime helpers (mode dispatcher, control-plane, update checker, settings persistence) that the Windows Wails reference UI under cmd/speechkit/ wires together. |
|
Package dictation implements pause-based segmentation for Dictation Mode: it consumes VAD speech-probability frames and emits one transcription request per natural pause.
|
Package dictation implements pause-based segmentation for Dictation Mode: it consumes VAD speech-probability frames and emits one transcription request per natural pause. |
|
Package downloads manages model downloads for SpeechKit — HTTP file downloads and Ollama model pulls with progress tracking.
|
Package downloads manages model downloads for SpeechKit — HTTP file downloads and Ollama model pulls with progress tracking. |
|
Package features provides runtime feature detection for UI gating.
|
Package features provides runtime feature detection for UI gating. |
|
Package hotkey is the Windows adapter for the global hotkey bus.
|
Package hotkey is the Windows adapter for the global hotkey bus. |
|
Package kombify is the build-tag seam between OSS and kombify builds.
|
Package kombify is the build-tag seam between OSS and kombify builds. |
|
Package localllm manages the lifecycle of the local llama.cpp HTTP server SpeechKit ships alongside the desktop bundle for offline LLM inference.
|
Package localllm manages the lifecycle of the local llama.cpp HTTP server SpeechKit ships alongside the desktop bundle for offline LLM inference. |
|
Package models defines the SpeechKit model catalog: provider IDs, model identifiers, modality (STT, TTS, Realtime Voice, Assist, Utility, Embedding, Reranker), execution mode (local/cloud/direct), and the readiness metadata that setup UIs and the readiness endpoint consume.
|
Package models defines the SpeechKit model catalog: provider IDs, model identifiers, modality (STT, TTS, Realtime Voice, Assist, Utility, Embedding, Reranker), execution mode (local/cloud/direct), and the readiness metadata that setup UIs and the readiness endpoint consume. |
|
Package netsec provides centralized network security primitives used by every HTTP-based provider in SpeechKit (STT, TTS, LLM, downloads).
|
Package netsec provides centralized network security primitives used by every HTTP-based provider in SpeechKit (STT, TTS, LLM, downloads). |
|
Package output is the Windows text-output adapter.
|
Package output is the Windows text-output adapter. |
|
Package router implements the STT routing layer.
|
Package router implements the STT routing layer. |
|
Package runtimepath resolves exe-relative paths so SpeechKit's portable-mode bundle finds its bundled assets, models, and per-user data dirs without depending on the OS-level installer having registered a fixed location.
|
Package runtimepath resolves exe-relative paths so SpeechKit's portable-mode bundle finds its bundled assets, models, and per-user data dirs without depending on the OS-level installer having registered a fixed location. |
|
Package scaffold renders embedded starter templates into a target directory so callers can bootstrap a SpeechKit integration without hand-copying boilerplate.
|
Package scaffold renders embedded starter templates into a target directory so callers can bootstrap a SpeechKit integration without hand-copying boilerplate. |
|
Package secrets is the cross-platform credential store with the canonical User > Install > Env > None resolution hierarchy.
|
Package secrets is the cross-platform credential store with the canonical User > Install > Env > None resolution hierarchy. |
|
Package server is the umbrella for the Linux Server-Target HTTP + WebSocket adapter.
|
Package server is the umbrella for the Linux Server-Target HTTP + WebSocket adapter. |
|
assist
Package assist implements the POST /v1/assist/process handler.
|
Package assist implements the POST /v1/assist/process handler. |
|
audio
Package audio normalizes inbound audio payloads to the Framework kernel's canonical PCM format (16 kHz, signed 16-bit little-endian, mono) before they enter the STT router.
|
Package audio normalizes inbound audio payloads to the Framework kernel's canonical PCM format (16 kHz, signed 16-bit little-endian, mono) before they enter the STT router. |
|
cli
Package cli holds the small amount of CLI-level glue for the Linux SpeechKit Server entry point.
|
Package cli holds the small amount of CLI-level glue for the Linux SpeechKit Server entry point. |
|
core
Package core is the SpeechKit server bootstrap layer.
|
Package core is the SpeechKit server bootstrap layer. |
|
dictation
Package dictation implements the POST /v1/dictation/transcribe handler.
|
Package dictation implements the POST /v1/dictation/transcribe handler. |
|
httpx
Package httpx contains tiny cross-handler helpers for JSON error envelopes and status mapping.
|
Package httpx contains tiny cross-handler helpers for JSON error envelopes and status mapping. |
|
middleware
Package middleware provides HTTP middleware primitives for the SpeechKit server adapter.
|
Package middleware provides HTTP middleware primitives for the SpeechKit server adapter. |
|
persona
Package persona provides the Voice Agent persona / role / sequence catalog for the Server-Target.
|
Package persona provides the Voice Agent persona / role / sequence catalog for the Server-Target. |
|
voiceagent
Package voiceagent implements the Voice Agent WebSocket surface on the Server-Target.
|
Package voiceagent implements the Voice Agent WebSocket surface on the Server-Target. |
|
wakewordtraining
Package wakewordtraining mounts the v0.37.5 REST endpoints that accept wake-word activation training-data uploads from device clients.
|
Package wakewordtraining mounts the v0.37.5 REST endpoints that accept wake-word activation training-data uploads from device clients. |
|
Package serverclient is the client-side transport adapter that lets a device-target (cmd/speechkit) or a local-target binary delegate one or more modes (Dictation, Assist, Voice Agent) to a remote SpeechKit Server-Target instead of running the Framework kernel in-process.
|
Package serverclient is the client-side transport adapter that lets a device-target (cmd/speechkit) or a local-target binary delegate one or more modes (Dictation, Assist, Voice Agent) to a remote SpeechKit Server-Target instead of running the Framework kernel in-process. |
|
Package shortcuts implements pattern-matched intent shortcuts used by Assist Mode.
|
Package shortcuts implements pattern-matched intent shortcuts used by Assist Mode. |
|
Package store is the durable backend for transcriptions, quick notes, voice-agent session summaries, persona catalog (M5b), and wake-word activation audio.
|
Package store is the durable backend for transcriptions, quick notes, voice-agent session summaries, persona catalog (M5b), and wake-word activation audio. |
|
Package stt defines the SpeechKit speech-to-text provider interface and houses the concrete provider implementations: whisper.cpp (local built-in), HuggingFace, OpenAI, Groq, Google, an OpenAI-compatible adapter (covers Ollama and other compatible servers), and the self-hosted VPS adapter.
|
Package stt defines the SpeechKit speech-to-text provider interface and houses the concrete provider implementations: whisper.cpp (local built-in), HuggingFace, OpenAI, Groq, Google, an OpenAI-compatible adapter (covers Ollama and other compatible servers), and the self-hosted VPS adapter. |
|
Package testutil holds test helpers shared across SpeechKit's kernel packages — temp-dir builders, fake clocks, identity injectors.
|
Package testutil holds test helpers shared across SpeechKit's kernel packages — temp-dir builders, fake clocks, identity injectors. |
|
Package textactions is the post-transcription text-processing pipeline (case normalisation, dictionary substitution, locale- aware capitalisation).
|
Package textactions is the post-transcription text-processing pipeline (case normalisation, dictionary substitution, locale- aware capitalisation). |
|
Package tray is the Windows system-tray adapter for the Wails reference UI.
|
Package tray is the Windows system-tray adapter for the Wails reference UI. |
|
Package tts implements the SpeechKit text-to-speech surface: a small provider interface plus concrete adapters for OpenAI, Google, and Hugging Face.
|
Package tts implements the SpeechKit text-to-speech surface: a small provider interface plus concrete adapters for OpenAI, Google, and Hugging Face. |
|
Package vad is the voice-activity-detection layer.
|
Package vad is the voice-activity-detection layer. |
|
Package voiceagent is the Voice Agent kernel — realtime audio-to-audio session manager backed by Gemini Live, with Persona/Role/Sequence resolution from internal/voicebehavior.
|
Package voiceagent is the Voice Agent kernel — realtime audio-to-audio session manager backed by Gemini Live, with Persona/Role/Sequence resolution from internal/voicebehavior. |
|
cascaded
Package cascaded implements a turn-based STT -> LLM -> TTS voice agent provider.
|
Package cascaded implements a turn-based STT -> LLM -> TTS voice agent provider. |
|
Package voiceagentprofile re-exports the voicebehavior Profile DTO with JSON tags suitable for HTTP envelope serialisation.
|
Package voiceagentprofile re-exports the voicebehavior Profile DTO with JSON tags suitable for HTTP envelope serialisation. |
|
Package voicebehavior contains the shared Voice Agent behavior catalog used by both the local desktop runtime and the Linux server target.
|
Package voicebehavior contains the shared Voice Agent behavior catalog used by both the local desktop runtime and the Linux server target. |
|
Package voiceeval contains deterministic dialogue checks for Voice Agent workflow tests.
|
Package voiceeval contains deterministic dialogue checks for Voice Agent workflow tests. |
|
Package wakeword implements an always-on, on-device keyword spotter that any of the three SpeechKit modes (Dictation, Assist, Voice Agent) can opt into.
|
Package wakeword implements an always-on, on-device keyword spotter that any of the three SpeechKit modes (Dictation, Assist, Voice Agent) can opt into. |
|
Package winapi provides shared Windows DLL proc references used by multiple packages.
|
Package winapi provides shared Windows DLL proc references used by multiple packages. |
Click to show internal directories.
Click to hide internal directories.