@actos-voice/core

Core types, interfaces, and controller logic for ActosVoice - A modern voice AI library.

Installation

npm install @actos-voice/core

Overview

This package provides the foundational building blocks for ActosVoice:

• Core Types - TypeScript interfaces for ASR, LLM, and Tool providers
• Controller - Central orchestration logic for voice interactions
• Tool System - JSON Schema-based tool calling interface

Usage

Most users should use @actos-voice/react instead of this package directly. This package is primarily for:

• Building custom framework integrations (Vue, Svelte, Angular, etc.)
• Creating custom ASR or LLM providers
• Advanced use cases requiring direct controller access

Core Types

ASRProvider

interface ASRProvider {
  start(): Promise<void>;
  stop(): void;
  onTranscript(callback: (text: string) => void): void;
  onError(callback: (error: Error) => void): void;
}

LLMProvider

interface LLMProvider {
  load(config?: LLMConfig): Promise<void>;
  chat(messages: ChatMessage[], tools?: Tool[]): Promise<string>;
  onProgress(callback: (progress: number) => void): void;
}

Tool

interface Tool {
  name: string;
  description: string;
  parameters: JSONSchema;
  execute: (args: Record<string, unknown>) => Promise<ToolResult>;
}

Example: Custom Integration

import { VoiceController } from '@actos-voice/core';
import { WebSpeechASR } from '@actos-voice/asr-webspeech';
import { WebLLM } from '@actos-voice/llm-webllm';

const controller = new VoiceController({
  asrProvider: new WebSpeechASR(),
  llmProvider: new WebLLM(),
  tools: [
    {
      name: 'greet',
      description: 'Greet the user',
      parameters: { type: 'object', properties: {} },
      execute: async () => {
        console.log('Hello!');
        return { success: true };
      }
    }
  ]
});

await controller.initialize();
await controller.startListening();

Documentation

📚 Full Documentation

Related Packages

• @actos-voice/react - React hooks and components
• @actos-voice/asr-webspeech - WebSpeech ASR provider
• @actos-voice/llm-webllm - WebLLM provider

License

MIT © patrick-mns

Links

• GitHub Repository
• Report Issues