speechkit

May 26, 2026

Changes in this version

type AssistRequest

+ SessionKey string

type AssistResult

+ Audio *AudioData

+ Format string

+ type AudioData []byte

+ func NewAudioData(data []byte) *AudioData

+ func (a *AudioData) Bytes() []byte

+ func (a *AudioData) Len() int

type Event

+ Metadata *Metadata

+ Mode string

+ SessionID string

+ func (e Event) Clone() Event

type EventType

+ const EventCompanionSessionEnded

+ const EventCompanionSessionStarted

+ const EventSkillExecuted

+ const EventTTSFinished

+ const EventTTSStarted

+ const EventVoiceAgentTurnFinalized

+ const EventWakeFired

+ type Metadata map[string]string

+ func NewMetadata(values map[string]string) *Metadata

+ func (m *Metadata) Clone() *Metadata

+ func (m *Metadata) Get(key string) string

+ func (m *Metadata) Map() map[string]string

May 25, 2026

Changes in this version

type IntelligenceKind

+ const IntelligenceVoiceOutput

type Mode

+ const ModeTTS

May 21, 2026

Changes in this version

type DictationSegmenter

+ func (s *DictationSegmenter) IdleSince() time.Time

+ type IdleObserver interface

+ IdleSince func() time.Time

type RecordingController

+ func (c *RecordingController) SetIdleWatchInterval(d time.Duration)

type RecordingStartOptions

+ IdleTimeout time.Duration

+ OnIdleTimeoutCallback func()

May 11, 2026

Changes in this version

type ServerConnectionSetting

+ ActiveTargetID string

+ AuthMode string

+ Targets []ServerConnectionTarget

+ type ServerConnectionTarget struct

+ AuthMode string

+ BearerTokenEnv string

+ BearerTokenSet bool

+ FallbackToLocal bool

+ ID string

+ Label string

+ RequestTimeoutSec int

+ URL string

May 2, 2026

Changes in this version

type VoiceAgentSetting

+ AgentProfileID string

+ AgentSequenceID string

Apr 30, 2026

Changes in this version

+ const DefaultLocalBuiltInLLMModel

Apr 27, 2026

Changes in this version

type ModeSetting

+ ModeSource string

type ModeSettings

+ ServerConnection ServerConnectionSetting

+ type ServerConnectionSetting struct

+ BearerTokenEnv string

+ BearerTokenSet bool

+ Enabled bool

+ FallbackToLocal bool

+ RequestTimeoutSec int

+ URL string

Apr 23, 2026

Changes in this version

+ const AudioBitsPerSample

+ const AudioBytesPerSample

+ const AudioChannels

+ const AudioSampleRate

+ const ReadinessSchemaVersion

+ func PCMDurationSecs(pcm []byte) float64

+ func PCMToWAV(pcm []byte) []byte

+ func ValidateDefaultCatalog() error

+ func ValidateModeSettingsForPolicy(profiles []ProviderProfile, settings ModeSettings, policy RuntimePolicy) error

+ func ValidateProfileForMode(profile ProviderProfile, mode Mode) error

+ func ValidateRuntimePolicy(profiles []ProviderProfile, policy RuntimePolicy) error

+ type AssistRequest struct

+ Context string

+ EditableTarget bool

+ Locale string

+ ProviderProfileID string

+ Selection string

+ Text string

+ type AssistResult struct

+ Action string

+ Kind string

+ Locale string

+ ShortcutID string

+ SpeakText string

+ Surface AssistSurfaceDecision

+ Text string

+ type AssistService interface

+ Process func(context.Context, AssistRequest) (AssistResult, error)

+ type AssistSetting struct

+ TTSEnabled bool

+ UtilityRegistry string

+ type AssistSurfaceDecision string

+ const AssistSurfaceActionAck

+ const AssistSurfaceInsert

+ const AssistSurfacePanel

+ const AssistSurfaceReplace

+ const AssistSurfaceSilent

+ type AudioSegment struct

+ Duration time.Duration

+ Final bool

+ PCM []byte

+ Paragraph bool

+ type Capability string

+ const CapabilityAudioInput

+ const CapabilityDictionaryNativeHints

+ const CapabilityDictionaryPrompt

+ const CapabilityLLM

+ const CapabilityPipelineFallback

+ const CapabilityRealtimeAudio

+ const CapabilitySTT

+ const CapabilitySessionSummary

+ const CapabilityTTS

+ const CapabilityToolCalling

+ const CapabilityTranscription

+ func RequiredCapabilities(mode Mode, nativeRealtime bool) []Capability

type CommandType

+ const CommandStartMode

+ const CommandStopMode

+ type DictationRun struct

+ AudioDurationMs int64

+ CompletedAt time.Time

+ DictionaryTerms []string

+ ID string

+ ProcessingTimeMs int64

+ ProviderProfile string

+ StartedAt time.Time

+ Transcript Transcript

+ type DictationService interface

+ Start func(context.Context) error

+ Stop func(context.Context) (DictationRun, error)

+ type DictationSetting struct

+ DictionaryEnabled bool

+ type ExecutionMode string

+ const ExecutionModeGoogle

+ const ExecutionModeGroq

+ const ExecutionModeHFRouted

+ const ExecutionModeLocal

+ const ExecutionModeOllama

+ const ExecutionModeOpenAI

+ const ExecutionModeOpenRouter

+ const ExecutionModeSelfHostedHTTP

+ type IntelligenceKind string

+ const IntelligenceBrainstorming

+ const IntelligenceUser

+ const IntelligenceUtility

+ type Mode string

+ const ModeAssist

+ const ModeDictation

+ const ModeNone

+ const ModeVoiceAgent

+ func NormalizeMode(mode Mode) Mode

+ type ModeBehavior string

+ const ModeBehaviorClean

+ const ModeBehaviorIntelligence

+ type ModeContract struct

+ Allowed []Capability

+ Forbidden []Capability

+ Input string

+ Intelligence IntelligenceKind

+ Mode Mode

+ Output string

+ func DefaultModeContracts() []ModeContract

+ type ModeSetting struct

+ Enabled bool

+ FallbackProfileID string

+ Hotkey string

+ HotkeyBehavior string

+ PrimaryProfileID string

+ type ModeSettings struct

+ Assist AssistSetting

+ Dictation DictationSetting

+ VoiceAgent VoiceAgentSetting

+ type ModelVariant struct

+ Description string

+ ID string

+ ModelID string

+ Name string

+ Recommended bool

+ type ProviderKind string

+ const ProviderKindCloudProvider

+ const ProviderKindDirectProvider

+ const ProviderKindLocalBuiltIn

+ const ProviderKindLocalProvider

+ func ProviderKindsForMode(mode Mode) []ProviderKind

+ type ProviderProfile struct

+ AdapterKind string

+ AllowInference bool

+ Capabilities []Capability

+ Default bool

+ Description string

+ ExecutionMode ExecutionMode

+ Experimental bool

+ ID string

+ License string

+ Mode Mode

+ ModelID string

+ Name string

+ ProviderKind ProviderKind

+ Recommended bool

+ Source string

+ Variants []ModelVariant

+ func DefaultProviderProfiles() []ProviderProfile

+ func FilterProviderProfiles(profiles []ProviderProfile, policy RuntimePolicy) []ProviderProfile

+ func ProfilesForMode(mode Mode) []ProviderProfile

+ func (p ProviderProfile) HasCapability(capability Capability) bool

+ type Readiness struct

+ Actions []ReadinessAction

+ Active bool

+ Artifacts []ReadinessArtifact

+ CapabilityReady bool

+ Configured bool

+ CredentialsReady bool

+ Default bool

+ ExecutionMode ExecutionMode

+ Missing []string

+ Mode Mode

+ ModelID string

+ ProfileID string

+ ProviderKind ProviderKind

+ Ready bool

+ Requirements []ReadinessRequirement

+ RuntimeReady bool

+ SchemaVersion string

+ Source string

+ type ReadinessAction struct

+ ID string

+ Kind string

+ Label string

+ Target string

+ type ReadinessArtifact struct

+ Available bool

+ ID string

+ Kind string

+ Name string

+ Recommended bool

+ RuntimeProblem string

+ RuntimeReady bool

+ Selected bool

+ SizeBytes int64

+ SizeLabel string

+ type ReadinessRequirement struct

+ Category string

+ ID string

+ Label string

+ Missing string

+ Ready bool

+ Required bool

+ type RuntimePolicy struct

+ AllowFallbacks bool

+ AllowedProfiles []string

+ EnabledModes []Mode

+ FixedProfiles map[Mode]string

+ ModeBehaviors map[Mode]ModeBehavior

+ type VoiceActivityDetector interface

+ ProcessFrame func([]int16) (float32, error)

+ Reset func()

+ type VoiceAgentService interface

+ CurrentSession func(context.Context) (VoiceAgentSession, error)

+ SendText func(context.Context, string) error

+ Start func(context.Context) error

+ Stop func(context.Context) (VoiceAgentSession, error)

+ type VoiceAgentSession struct

+ EndedAt time.Time

+ ID string

+ Locale string

+ ProviderProfileID string

+ RuntimeKind string

+ StartedAt time.Time

+ Summary VoiceAgentSessionSummary

+ Turns []VoiceAgentTurn

+ type VoiceAgentSessionSummary struct

+ Decisions []string

+ Ideas []string

+ NextSteps []string

+ OpenQuestions []string

+ RawText string

+ Summary string

+ Title string

+ type VoiceAgentSetting struct

+ CloseBehavior string

+ PipelineFallback bool

+ SessionSummary bool

+ type VoiceAgentTurn struct

+ CreatedAt time.Time

+ Role string

+ Text string

Mar 30, 2026

Changes in this version

+ const DefaultDictationMinSegment

+ const DefaultDictationOverlap

+ const DefaultDictationPadding

+ const DefaultMinPCMBytes

+ const DefaultProcessingMessage

+ var ErrCommandHandlerUnavailable = errors.New("speechkit: no command handler configured")

+ var ErrMissingRunner = errors.New("speechkit: transcription worker requires a runner")

+ var ErrMissingTranscriber = errors.New("speechkit: transcription runner requires a transcriber")

+ var ErrWorkerClosed = errors.New("speechkit: transcription worker is closed")

+ var ErrWorkerQueueFull = errors.New("speechkit: transcription worker queue is full")

+ func FallbackDictationSegments(fullPCM []byte) []dictation.Segment

+ type AudioRecorder interface

+ SetPCMHandler func(func([]byte))

+ Start func() error

+ Stop func() ([]byte, error)

+ type Command struct

+ Metadata map[string]string

+ NoteID int64

+ Target string

+ Text string

+ Type CommandType

+ func (c Command) Clone() Command

+ type CommandBus interface

+ Dispatch func(context.Context, Command) error

+ type CommandType string

+ const CommandArmQuickNoteRecording

+ const CommandCloseQuickCapture

+ const CommandCopyLastTranscription

+ const CommandInsertLastTranscription

+ const CommandOpenQuickCapture

+ const CommandOpenQuickNote

+ const CommandSetActiveMode

+ const CommandShowDashboard

+ const CommandStartDictation

+ const CommandStopDictation

+ const CommandSummarizeSelection

+ type CommitObserver interface

+ OnCommit func(completion Completion)

+ type Completion struct

+ QuickNoteCommitted bool

+ QuickNoteCreated bool

+ QuickNoteID int64

+ Transcript Transcript

+ TranscriptionPersisted bool

+ type DictationSegmenter struct

+ func NewDictationSegmenter(detector vad.Detector, pauseThreshold time.Duration) *DictationSegmenter

+ func (s *DictationSegmenter) CollectStopSegments(fullPCM []byte) ([]dictation.Segment, error)

+ func (s *DictationSegmenter) FeedPCM(pcm []byte) error

+ type Engine interface

+ Commands func() CommandBus

+ Events func() <-chan Event

+ Start func(context.Context) error

+ State func() Snapshot

+ Stop func(context.Context) error

+ type Event struct

+ Err error

+ Message string

+ Provider string

+ QuickNote bool

+ Shortcut string

+ Text string

+ Time time.Time

+ Type EventType

+ type EventType string

+ const EventErrorRaised

+ const EventProcessingStarted

+ const EventQuickNoteModeArmed

+ const EventQuickNoteUpdated

+ const EventRecordingStarted

+ const EventShortcutMatched

+ const EventStateChanged

+ const EventTranscriptCommitted

+ const EventTranscriptionReady

+ const EventWarningRaised

+ type Hooks struct

+ HandleCommand func(context.Context, Command) error

+ Start func(context.Context) error

+ Stop func(context.Context) error

+ type JobSubmitter interface

+ Submit func(TranscriptionJob) error

+ type Persistence interface

+ type QuickNoteStore interface

+ GetQuickNoteText func(ctx context.Context, id int64) (string, error)

+ SaveQuickNote func(ctx context.Context, text, language, provider string, ...) (int64, error)

+ UpdateQuickNote func(ctx context.Context, id int64, text string) error

+ UpdateQuickNoteCapture func(ctx context.Context, id int64, text, provider string, ...) error

+ type RecordingController struct

+ func NewRecordingController(recorder AudioRecorder, submitter JobSubmitter, observer RecordingObserver, ...) *RecordingController

+ func (c *RecordingController) IsRecording() bool

+ func (c *RecordingController) Start(opts RecordingStartOptions) error

+ func (c *RecordingController) Stop(opts RecordingStopOptions) error

+ type RecordingObserver interface

+ OnLog func(message, kind string)

+ OnState func(status, text string)

+ type RecordingStartOptions struct

+ Label string

+ Language string

+ QuickNote bool

+ QuickNoteID int64

+ Target any

+ type RecordingStopOptions struct

+ Label string

+ type Runtime struct

+ func NewRuntime(initial Snapshot, hooks Hooks) *Runtime

+ func (r *Runtime) Close()

+ func (r *Runtime) Commands() CommandBus

+ func (r *Runtime) Events() <-chan Event

+ func (r *Runtime) Publish(event Event) bool

+ func (r *Runtime) SetState(snapshot Snapshot)

+ func (r *Runtime) Start(ctx context.Context) error

+ func (r *Runtime) State() Snapshot

+ func (r *Runtime) Stop(ctx context.Context) error

+ func (r *Runtime) UpdateState(update func(*Snapshot)) Snapshot

+ type SegmentCollector interface

+ CollectStopSegments func(fullPCM []byte) ([]dictation.Segment, error)

+ FeedPCM func([]byte) error

+ type SegmentCollectorFactory func() SegmentCollector

+ type Snapshot struct

+ ActiveMode string

+ ActiveProfiles map[string]string

+ Hotkey string

+ LastTranscriptionText string

+ Level float64

+ Providers []string

+ QuickCaptureMode bool

+ QuickNoteMode bool

+ Status string

+ Text string

+ Transcriptions int

+ func (s Snapshot) Clone() Snapshot

+ type Submission struct

+ DurationSecs float64

+ Language string

+ PCM []byte

+ Prefix string

+ QuickNote bool

+ QuickNoteID int64

+ WAV []byte

+ type Transcriber interface

+ Transcribe func(ctx context.Context, audio []byte, durationSecs float64, language string) (Transcript, error)

+ type Transcript struct

+ Confidence float64

+ Duration time.Duration

+ Language string

+ Model string

+ Provider string

+ Text string

+ type TranscriptInterceptor interface

+ Intercept func(ctx context.Context, transcript Transcript, target any) (bool, error)

+ type TranscriptOutput interface

+ Deliver func(ctx context.Context, transcript Transcript, target any) error

+ type TranscriptionJob struct

+ Target any

+ func (j TranscriptionJob) Clone() TranscriptionJob

+ type TranscriptionObserver interface

+ OnLog func(message, kind string)

+ OnState func(status, text string)

+ OnTranscriptCommitted func(transcript Transcript, quickNote bool)

+ type TranscriptionRunner struct

+ func NewTranscriptionRunner(transcriber Transcriber, store Persistence) *TranscriptionRunner

+ func (r *TranscriptionRunner) Commit(ctx context.Context, submission Submission, transcript Transcript) (Completion, error)

+ func (r *TranscriptionRunner) WithObserver(observer CommitObserver) *TranscriptionRunner

+ type TranscriptionStore interface

+ SaveTranscription func(ctx context.Context, text, language, provider, model string, ...) error

+ type TranscriptionWorker struct

+ func NewTranscriptionWorker(cfg TranscriptionWorkerConfig) (*TranscriptionWorker, error)

+ func (w *TranscriptionWorker) Close()

+ func (w *TranscriptionWorker) Start(ctx context.Context)

+ func (w *TranscriptionWorker) Submit(job TranscriptionJob) error

+ func (w *TranscriptionWorker) Wait()

+ type TranscriptionWorkerConfig struct

+ Interceptor TranscriptInterceptor

+ Observer TranscriptionObserver

+ Output TranscriptOutput

+ QueueSize int

+ Runner *TranscriptionRunner

+ Timeout time.Duration