@copilotkit/voice 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Atai Barkai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# @copilotkit/voice
+
+Audio transcription providers for CopilotKit.
+
+## Setup
+
+```bash
+pnpm add @copilotkit/voice openai
+```
+
+```typescript
+import { CopilotRuntime, createCopilotEndpoint } from "@copilotkitnext/runtime";
+import { TranscriptionServiceOpenAI } from "@copilotkit/voice";
+import OpenAI from "openai";
+
+const runtime = new CopilotRuntime({
+  agents: { default: yourAgent },
+  transcriptionService: new TranscriptionServiceOpenAI({
+    openai: new OpenAI({ apiKey: process.env.OPENAI_API_KEY }),
+  }),
+});
+```
+
+Once configured, the chat UI shows a microphone button. Users can record audio, which gets transcribed and inserted into the input field as text.
+
+## TranscriptionServiceOpenAI
+
+Uses [OpenAI Whisper](https://platform.openai.com/docs/guides/speech-to-text) for transcription.
+
+```typescript
+new TranscriptionServiceOpenAI({
+  openai: new OpenAI({ apiKey: "..." }),  // required
+  model: "whisper-1",                      // default
+  language: "en",                          // optional, ISO-639-1 code
+  prompt: "Technical discussion context",  // optional, helps with domain terms
+  temperature: 0,                          // optional, 0 = deterministic
+});
+```
+
+## Custom providers
+
+Extend `TranscriptionService` from runtime:
+
+```typescript
+import { TranscriptionService, TranscribeFileOptions } from "@copilotkitnext/runtime";
+
+class MyTranscriptionService extends TranscriptionService {
+  async transcribeFile(options: TranscribeFileOptions): Promise<string> {
+    // options.audioFile, options.mimeType, options.size
+    return "transcribed text";
+  }
+}
+```

package/dist/index.d.mts

@@ -0,0 +1,38 @@
+import { TranscriptionService, TranscribeFileOptions } from '@copilotkitnext/runtime';
+import OpenAI from 'openai';
+
+/**
+ * Configuration options for the OpenAI transcription service.
+ */
+interface TranscriptionServiceOpenAIConfig {
+    /** OpenAI client instance. */
+    openai: OpenAI;
+    /** Whisper model to use. Defaults to "whisper-1". */
+    model?: string;
+    /**
+     * Language of the audio in ISO-639-1 format (e.g., "en", "de", "fr").
+     * Providing the language improves accuracy and latency.
+     */
+    language?: string;
+    /**
+     * Optional text to guide the model's style or continue a previous segment.
+     * Should match the audio language.
+     */
+    prompt?: string;
+    /**
+     * Sampling temperature between 0 and 1.
+     * Lower values are more deterministic, higher values more creative.
+     */
+    temperature?: number;
+}
+declare class TranscriptionServiceOpenAI extends TranscriptionService {
+    private openai;
+    private model;
+    private language?;
+    private prompt?;
+    private temperature?;
+    constructor(config: TranscriptionServiceOpenAIConfig);
+    transcribeFile(options: TranscribeFileOptions): Promise<string>;
+}
+
+export { TranscriptionServiceOpenAI, type TranscriptionServiceOpenAIConfig };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { TranscriptionService, TranscribeFileOptions } from '@copilotkitnext/runtime';
+import OpenAI from 'openai';
+
+/**
+ * Configuration options for the OpenAI transcription service.
+ */
+interface TranscriptionServiceOpenAIConfig {
+    /** OpenAI client instance. */
+    openai: OpenAI;
+    /** Whisper model to use. Defaults to "whisper-1". */
+    model?: string;
+    /**
+     * Language of the audio in ISO-639-1 format (e.g., "en", "de", "fr").
+     * Providing the language improves accuracy and latency.
+     */
+    language?: string;
+    /**
+     * Optional text to guide the model's style or continue a previous segment.
+     * Should match the audio language.
+     */
+    prompt?: string;
+    /**
+     * Sampling temperature between 0 and 1.
+     * Lower values are more deterministic, higher values more creative.
+     */
+    temperature?: number;
+}
+declare class TranscriptionServiceOpenAI extends TranscriptionService {
+    private openai;
+    private model;
+    private language?;
+    private prompt?;
+    private temperature?;
+    constructor(config: TranscriptionServiceOpenAIConfig);
+    transcribeFile(options: TranscribeFileOptions): Promise<string>;
+}
+
+export { TranscriptionServiceOpenAI, type TranscriptionServiceOpenAIConfig };

package/dist/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  TranscriptionServiceOpenAI: () => TranscriptionServiceOpenAI
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/transcription/transcription-service-openai.ts
+var import_runtime = require("@copilotkitnext/runtime");
+var import_openai = __toESM(require("openai"));
+var TranscriptionServiceOpenAI = class extends import_runtime.TranscriptionService {
+  openai;
+  model;
+  language;
+  prompt;
+  temperature;
+  constructor(config) {
+    super();
+    this.openai = config.openai ?? new import_openai.default();
+    this.model = config.model ?? "whisper-1";
+    this.language = config.language;
+    this.prompt = config.prompt;
+    this.temperature = config.temperature;
+  }
+  async transcribeFile(options) {
+    const response = await this.openai.audio.transcriptions.create({
+      file: options.audioFile,
+      model: this.model,
+      ...this.language && { language: this.language },
+      ...this.prompt && { prompt: this.prompt },
+      ...this.temperature !== void 0 && { temperature: this.temperature }
+    });
+    return response.text;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TranscriptionServiceOpenAI
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/transcription/transcription-service-openai.ts"],"sourcesContent":["// Transcription services\nexport * from \"./transcription/transcription-service-openai\";\n","import {\n  TranscribeFileOptions,\n  TranscriptionService,\n} from \"@copilotkitnext/runtime\";\nimport OpenAI from \"openai\";\n\n/**\n * Configuration options for the OpenAI transcription service.\n */\nexport interface TranscriptionServiceOpenAIConfig {\n  /** OpenAI client instance. */\n  openai: OpenAI;\n  /** Whisper model to use. Defaults to \"whisper-1\". */\n  model?: string;\n  /**\n   * Language of the audio in ISO-639-1 format (e.g., \"en\", \"de\", \"fr\").\n   * Providing the language improves accuracy and latency.\n   */\n  language?: string;\n  /**\n   * Optional text to guide the model's style or continue a previous segment.\n   * Should match the audio language.\n   */\n  prompt?: string;\n  /**\n   * Sampling temperature between 0 and 1.\n   * Lower values are more deterministic, higher values more creative.\n   */\n  temperature?: number;\n}\n\nexport class TranscriptionServiceOpenAI extends TranscriptionService {\n  private openai: OpenAI;\n  private model: string;\n  private language?: string;\n  private prompt?: string;\n  private temperature?: number;\n\n  constructor(config: TranscriptionServiceOpenAIConfig) {\n    super();\n    this.openai = config.openai ?? new OpenAI();\n    this.model = config.model ?? \"whisper-1\";\n    this.language = config.language;\n    this.prompt = config.prompt;\n    this.temperature = config.temperature;\n  }\n\n  async transcribeFile(options: TranscribeFileOptions): Promise<string> {\n    const response = await this.openai.audio.transcriptions.create({\n      file: options.audioFile,\n      model: this.model,\n      ...(this.language && { language: this.language }),\n      ...(this.prompt && { prompt: this.prompt }),\n      ...(this.temperature !== undefined && { temperature: this.temperature }),\n    });\n    return response.text;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,qBAGO;AACP,oBAAmB;AA2BZ,IAAM,6BAAN,cAAyC,oCAAqB;AAAA,EAC3D;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAER,YAAY,QAA0C;AACpD,UAAM;AACN,SAAK,SAAS,OAAO,UAAU,IAAI,cAAAA,QAAO;AAC1C,SAAK,QAAQ,OAAO,SAAS;AAC7B,SAAK,WAAW,OAAO;AACvB,SAAK,SAAS,OAAO;AACrB,SAAK,cAAc,OAAO;AAAA,EAC5B;AAAA,EAEA,MAAM,eAAe,SAAiD;AACpE,UAAM,WAAW,MAAM,KAAK,OAAO,MAAM,eAAe,OAAO;AAAA,MAC7D,MAAM,QAAQ;AAAA,MACd,OAAO,KAAK;AAAA,MACZ,GAAI,KAAK,YAAY,EAAE,UAAU,KAAK,SAAS;AAAA,MAC/C,GAAI,KAAK,UAAU,EAAE,QAAQ,KAAK,OAAO;AAAA,MACzC,GAAI,KAAK,gBAAgB,UAAa,EAAE,aAAa,KAAK,YAAY;AAAA,IACxE,CAAC;AACD,WAAO,SAAS;AAAA,EAClB;AACF;","names":["OpenAI"]}

package/dist/index.mjs

@@ -0,0 +1,34 @@
+// src/transcription/transcription-service-openai.ts
+import {
+  TranscriptionService
+} from "@copilotkitnext/runtime";
+import OpenAI from "openai";
+var TranscriptionServiceOpenAI = class extends TranscriptionService {
+  openai;
+  model;
+  language;
+  prompt;
+  temperature;
+  constructor(config) {
+    super();
+    this.openai = config.openai ?? new OpenAI();
+    this.model = config.model ?? "whisper-1";
+    this.language = config.language;
+    this.prompt = config.prompt;
+    this.temperature = config.temperature;
+  }
+  async transcribeFile(options) {
+    const response = await this.openai.audio.transcriptions.create({
+      file: options.audioFile,
+      model: this.model,
+      ...this.language && { language: this.language },
+      ...this.prompt && { prompt: this.prompt },
+      ...this.temperature !== void 0 && { temperature: this.temperature }
+    });
+    return response.text;
+  }
+};
+export {
+  TranscriptionServiceOpenAI
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/transcription/transcription-service-openai.ts"],"sourcesContent":["import {\n  TranscribeFileOptions,\n  TranscriptionService,\n} from \"@copilotkitnext/runtime\";\nimport OpenAI from \"openai\";\n\n/**\n * Configuration options for the OpenAI transcription service.\n */\nexport interface TranscriptionServiceOpenAIConfig {\n  /** OpenAI client instance. */\n  openai: OpenAI;\n  /** Whisper model to use. Defaults to \"whisper-1\". */\n  model?: string;\n  /**\n   * Language of the audio in ISO-639-1 format (e.g., \"en\", \"de\", \"fr\").\n   * Providing the language improves accuracy and latency.\n   */\n  language?: string;\n  /**\n   * Optional text to guide the model's style or continue a previous segment.\n   * Should match the audio language.\n   */\n  prompt?: string;\n  /**\n   * Sampling temperature between 0 and 1.\n   * Lower values are more deterministic, higher values more creative.\n   */\n  temperature?: number;\n}\n\nexport class TranscriptionServiceOpenAI extends TranscriptionService {\n  private openai: OpenAI;\n  private model: string;\n  private language?: string;\n  private prompt?: string;\n  private temperature?: number;\n\n  constructor(config: TranscriptionServiceOpenAIConfig) {\n    super();\n    this.openai = config.openai ?? new OpenAI();\n    this.model = config.model ?? \"whisper-1\";\n    this.language = config.language;\n    this.prompt = config.prompt;\n    this.temperature = config.temperature;\n  }\n\n  async transcribeFile(options: TranscribeFileOptions): Promise<string> {\n    const response = await this.openai.audio.transcriptions.create({\n      file: options.audioFile,\n      model: this.model,\n      ...(this.language && { language: this.language }),\n      ...(this.prompt && { prompt: this.prompt }),\n      ...(this.temperature !== undefined && { temperature: this.temperature }),\n    });\n    return response.text;\n  }\n}\n"],"mappings":";AAAA;AAAA,EAEE;AAAA,OACK;AACP,OAAO,YAAY;AA2BZ,IAAM,6BAAN,cAAyC,qBAAqB;AAAA,EAC3D;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAER,YAAY,QAA0C;AACpD,UAAM;AACN,SAAK,SAAS,OAAO,UAAU,IAAI,OAAO;AAC1C,SAAK,QAAQ,OAAO,SAAS;AAC7B,SAAK,WAAW,OAAO;AACvB,SAAK,SAAS,OAAO;AACrB,SAAK,cAAc,OAAO;AAAA,EAC5B;AAAA,EAEA,MAAM,eAAe,SAAiD;AACpE,UAAM,WAAW,MAAM,KAAK,OAAO,MAAM,eAAe,OAAO;AAAA,MAC7D,MAAM,QAAQ;AAAA,MACd,OAAO,KAAK;AAAA,MACZ,GAAI,KAAK,YAAY,EAAE,UAAU,KAAK,SAAS;AAAA,MAC/C,GAAI,KAAK,UAAU,EAAE,QAAQ,KAAK,OAAO;AAAA,MACzC,GAAI,KAAK,gBAAgB,UAAa,EAAE,aAAa,KAAK,YAAY;AAAA,IACxE,CAAC;AACD,WAAO,SAAS;AAAA,EAClB;AACF;","names":[]}

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import { config as baseConfig } from "@copilotkitnext/eslint-config/base";
+
+export default [...baseConfig];

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@copilotkit/voice",
+  "version": "0.0.1",
+  "description": "Voice services for CopilotKit (transcription, text-to-speech, etc.)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.3",
+    "eslint": "^9.30.0",
+    "tsup": "^8.5.0",
+    "typescript": "5.8.2",
+    "vitest": "^3.0.5",
+    "@copilotkitnext/eslint-config": "1.51.2",
+    "@copilotkitnext/typescript-config": "1.51.2"
+  },
+  "dependencies": {
+    "openai": "^5.9.0",
+    "@copilotkitnext/runtime": "1.51.2"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint . --max-warnings 0",
+    "check-types": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+// Transcription services
+export * from "./transcription/transcription-service-openai";

package/src/transcription/transcription-service-openai.ts

@@ -0,0 +1,58 @@
+import {
+  TranscribeFileOptions,
+  TranscriptionService,
+} from "@copilotkitnext/runtime";
+import OpenAI from "openai";
+
+/**
+ * Configuration options for the OpenAI transcription service.
+ */
+export interface TranscriptionServiceOpenAIConfig {
+  /** OpenAI client instance. */
+  openai: OpenAI;
+  /** Whisper model to use. Defaults to "whisper-1". */
+  model?: string;
+  /**
+   * Language of the audio in ISO-639-1 format (e.g., "en", "de", "fr").
+   * Providing the language improves accuracy and latency.
+   */
+  language?: string;
+  /**
+   * Optional text to guide the model's style or continue a previous segment.
+   * Should match the audio language.
+   */
+  prompt?: string;
+  /**
+   * Sampling temperature between 0 and 1.
+   * Lower values are more deterministic, higher values more creative.
+   */
+  temperature?: number;
+}
+
+export class TranscriptionServiceOpenAI extends TranscriptionService {
+  private openai: OpenAI;
+  private model: string;
+  private language?: string;
+  private prompt?: string;
+  private temperature?: number;
+
+  constructor(config: TranscriptionServiceOpenAIConfig) {
+    super();
+    this.openai = config.openai ?? new OpenAI();
+    this.model = config.model ?? "whisper-1";
+    this.language = config.language;
+    this.prompt = config.prompt;
+    this.temperature = config.temperature;
+  }
+
+  async transcribeFile(options: TranscribeFileOptions): Promise<string> {
+    const response = await this.openai.audio.transcriptions.create({
+      file: options.audioFile,
+      model: this.model,
+      ...(this.language && { language: this.language }),
+      ...(this.prompt && { prompt: this.prompt }),
+      ...(this.temperature !== undefined && { temperature: this.temperature }),
+    });
+    return response.text;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "@copilotkitnext/typescript-config/base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist", "node_modules"]
+}

package/tsup.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'tsup';
+
+const isWatch = process.argv.includes("--watch");
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  format: ['cjs', 'esm'],
+  dts: isWatch ? false : true,
+  sourcemap: true,
+  clean: !isWatch,
+  target: 'es2022',
+  outDir: 'dist',
+});