@fonoster/autopilot 0.5.5 → 0.7.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Fonoster Inc
+Copyright (c) 2024 Fonoster Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+<a href="https://gitpod.io/#https://github.com/fonoster/fonoster"> <img src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod" alt="Contribute with Gitpod" />
+
+This module is part of the [Fonoster](https://fonoster.com) project. By itself, it does not do much. It is intended to be used as a dependency for other modules. For more information about the project, please visit [https://github.com/fonoster/fonoster](https://github.com/fonoster/fonoster)(../apiserver/README.md)

package/dist/Autopilot.d.ts

@@ -0,0 +1,15 @@
+import { AutopilotConfig } from "./types";
+declare class Autopilot {
+    private config;
+    private assistant;
+    private actor;
+    private voice;
+    constructor(config: AutopilotConfig);
+    start(): void;
+    private createActor;
+    private subscribeToActorState;
+    private setupVoiceStream;
+    private handleVoicePayload;
+    private setupSpeechGathering;
+}
+export { Autopilot };

package/dist/Autopilot.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Autopilot = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const common_1 = require("@fonoster/common");
+const logger_1 = require("@fonoster/logger");
+const xstate_1 = require("xstate");
+const assistants_1 = require("./assistants");
+const machine_1 = require("./machine/machine");
+const vad_1 = require("./vad");
+const logger = (0, logger_1.getLogger)({ service: "autopilot", filePath: __filename });
+class Autopilot {
+    constructor(config) {
+        this.config = config;
+        this.assistant = (0, assistants_1.makeAssistant)(config.assistantConfig);
+        this.actor = this.createActor();
+        this.voice = config.voice;
+    }
+    start() {
+        this.actor.start();
+        this.setupSpeechGathering();
+        this.setupVoiceStream();
+        this.subscribeToActorState();
+    }
+    createActor() {
+        const { voice } = this.config;
+        const { firstMessage } = this.config.assistantConfig;
+        return (0, xstate_1.createActor)(machine_1.machine, {
+            input: { firstMessage, voice, assistant: this.assistant }
+        });
+    }
+    subscribeToActorState() {
+        this.actor.subscribe((state) => {
+            logger.verbose("actor's new state is", { state: state.value });
+        });
+    }
+    async setupVoiceStream() {
+        const stream = await this.config.voice.stream({
+            direction: common_1.StreamDirection.OUT
+        });
+        const vad = await (0, vad_1.makeVad)();
+        stream.onPayload(this.handleVoicePayload(vad));
+    }
+    handleVoicePayload(vad) {
+        return async (payload) => {
+            try {
+                // TODO: Investigate why we need to cast this to Float32Array
+                const data = payload.data;
+                await vad(data, (event) => {
+                    if (event === "SPEECH_START" || event === "SPEECH_END") {
+                        this.actor.send({ type: event });
+                    }
+                });
+            }
+            catch (err) {
+                logger.error("an error occurred while processing vad", err);
+            }
+        };
+    }
+    async setupSpeechGathering() {
+        const stream = await this.voice.sgather({
+            source: common_1.StreamGatherSource.SPEECH
+        });
+        stream.onPayload((payload) => {
+            this.actor.send({ type: "HUMAN_PROMPT", speech: payload.speech });
+        });
+    }
+}
+exports.Autopilot = Autopilot;

package/dist/assistants/AssistantSchema.d.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import { Model } from "./types";
+declare const AssistantSchema: z.ZodObject<{
+    name: z.ZodString;
+    firstMessage: z.ZodString;
+    systemTemplate: z.ZodString;
+    model: z.ZodNativeEnum<typeof Model>;
+    temperature: z.ZodNumber;
+    maxTokens: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    systemTemplate: string;
+    model: Model;
+    temperature: number;
+    maxTokens: number;
+    name: string;
+    firstMessage: string;
+}, {
+    systemTemplate: string;
+    model: Model;
+    temperature: number;
+    maxTokens: number;
+    name: string;
+    firstMessage: string;
+}>;
+export { AssistantSchema };

package/dist/assistants/AssistantSchema.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssistantSchema = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const zod_1 = require("zod");
+const types_1 = require("./types");
+const AssistantSchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    firstMessage: zod_1.z.string(),
+    systemTemplate: zod_1.z.string(),
+    model: zod_1.z.nativeEnum(types_1.Model),
+    temperature: zod_1.z.number(),
+    maxTokens: zod_1.z.number()
+});
+exports.AssistantSchema = AssistantSchema;

package/dist/assistants/assistants.d.ts

@@ -0,0 +1,4 @@
+import { AssistantConfig } from "./types";
+type Assistant = ReturnType<typeof makeAssistant>;
+declare function makeAssistant(config: AssistantConfig): import("@langchain/core/runnables").Runnable<any, string, import("@langchain/core/runnables").RunnableConfig>;
+export { makeAssistant, Assistant };

package/dist/assistants/assistants.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeAssistant = makeAssistant;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const output_parsers_1 = require("@langchain/core/output_parsers");
+const prompts_1 = require("@langchain/core/prompts");
+const openai_1 = require("@langchain/openai");
+function makeAssistant(config) {
+    const model = new openai_1.ChatOpenAI({
+        model: config.model,
+        apiKey: config.apiKey,
+        maxTokens: config.maxTokens,
+        temperature: config.temperature
+    });
+    const { systemTemplate } = config;
+    const parser = new output_parsers_1.StringOutputParser();
+    const promptTemplate = prompts_1.ChatPromptTemplate.fromMessages([
+        ["system", systemTemplate],
+        ["user", "{text}"]
+    ]);
+    return promptTemplate.pipe(model).pipe(parser);
+}

package/dist/assistants/index.d.ts

@@ -0,0 +1,4 @@
+export { makeAssistant } from "./assistants";
+export { loadAndValidateAssistant } from "./loadAndValidateAssistant";
+export * from "./AssistantSchema";
+export * from "./types";

package/dist/{cerebro → assistants}/index.js

@@ -14,11 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadAndValidateAssistant = exports.makeAssistant = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/rox
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
  *
- * This file is part of Rox AI
+ * This file is part of Fonoster
  *
  * Licensed under the MIT License (the "License");
  * you may not use this file except in compliance with
@@ -32,5 +33,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-__exportStar(require("./cerebro"), exports);
-__exportStar(require("./effects"), exports);
+var assistants_1 = require("./assistants");
+Object.defineProperty(exports, "makeAssistant", { enumerable: true, get: function () { return assistants_1.makeAssistant; } });
+var loadAndValidateAssistant_1 = require("./loadAndValidateAssistant");
+Object.defineProperty(exports, "loadAndValidateAssistant", { enumerable: true, get: function () { return loadAndValidateAssistant_1.loadAndValidateAssistant; } });
+__exportStar(require("./AssistantSchema"), exports);
+__exportStar(require("./types"), exports);

package/dist/assistants/loadAndValidateAssistant.d.ts

@@ -0,0 +1,3 @@
+import { AssistantFromJson } from "./types";
+declare function loadAndValidateAssistant(path: string): AssistantFromJson;
+export { loadAndValidateAssistant };

package/dist/assistants/loadAndValidateAssistant.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadAndValidateAssistant = loadAndValidateAssistant;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const fs_1 = __importDefault(require("fs"));
+const logger_1 = require("@fonoster/logger");
+const AssistantSchema_1 = require("./AssistantSchema");
+const logger = (0, logger_1.getLogger)({ service: "autopilot", filePath: __filename });
+function loadAndValidateAssistant(path) {
+    if (!fs_1.default.existsSync(path)) {
+        logger.error("assistant file not found", { path });
+        process.exit(1);
+    }
+    try {
+        const fileContent = fs_1.default.readFileSync(path, "utf8");
+        const assistant = JSON.parse(fileContent);
+        return AssistantSchema_1.AssistantSchema.parse(assistant);
+    }
+    catch (e) {
+        logger.error("error parsing or validating assistant file", {
+            path,
+            error: e.message
+        });
+        process.exit(1);
+    }
+}

package/dist/assistants/types.d.ts

@@ -0,0 +1,17 @@
+declare enum Model {
+    GPT_3 = "gpt-3",
+    GPT_4 = "gpt-4",
+    GPT_4O_MINI = "gpt-4o-mini"
+}
+type AssistantFromJson = {
+    name: string;
+    firstMessage: string;
+    systemTemplate: string;
+    model: Model;
+    temperature: number;
+    maxTokens: number;
+};
+type AssistantConfig = AssistantFromJson & {
+    apiKey: string;
+};
+export { AssistantFromJson, AssistantConfig, Model };

package/dist/{events → assistants}/types.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLIENT_EVENTS = void 0;
+exports.Model = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/rox
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
  *
- * This file is part of Rox AI
+ * This file is part of Fonoster
  *
  * Licensed under the MIT License (the "License");
  * you may not use this file except in compliance with
@@ -19,11 +19,9 @@ exports.CLIENT_EVENTS = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var CLIENT_EVENTS;
-(function (CLIENT_EVENTS) {
-    CLIENT_EVENTS["RECOGNIZING"] = "RECOGNIZING";
-    CLIENT_EVENTS["ANSWERED"] = "ANSWERED";
-    CLIENT_EVENTS["RECOGNIZING_FINISHED"] = "RECOGNIZING_FINISHED";
-    CLIENT_EVENTS["INTENT"] = "INTENT";
-    CLIENT_EVENTS["HANGUP"] = "HANGUP";
-})(CLIENT_EVENTS || (exports.CLIENT_EVENTS = CLIENT_EVENTS = {}));
+var Model;
+(function (Model) {
+    Model["GPT_3"] = "gpt-3";
+    Model["GPT_4"] = "gpt-4";
+    Model["GPT_4O_MINI"] = "gpt-4o-mini";
+})(Model || (exports.Model = Model = {}));

package/dist/envs.d.ts

@@ -1,4 +1 @@
-export declare const APISERVER_AUTOPILOT_PORT: number;
-export declare const APISERVER_AUTOPILOT_DEFAULT_LANGUAGE_CODE: string;
-export declare const APISERVER_AUTOPILOT_MEDIA_BUSY_MESSAGE: string;
-export declare const APISERVER_AUTOPILOT_MEDIA_NOANSWER_MESSAGE: string;
+export declare const OPENAI_API_KEY: string | undefined;

package/dist/envs.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.APISERVER_AUTOPILOT_MEDIA_NOANSWER_MESSAGE = exports.APISERVER_AUTOPILOT_MEDIA_BUSY_MESSAGE = exports.APISERVER_AUTOPILOT_DEFAULT_LANGUAGE_CODE = exports.APISERVER_AUTOPILOT_PORT = void 0;
+exports.OPENAI_API_KEY = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
  *
  * This file is part of Fonoster
@@ -19,9 +22,9 @@ exports.APISERVER_AUTOPILOT_MEDIA_NOANSWER_MESSAGE = exports.APISERVER_AUTOPILOT
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-exports.APISERVER_AUTOPILOT_PORT = process.env.APISERVER_AUTOPILOT_PORT
-    ? parseInt(process.env.APISERVER_AUTOPILOT_PORT)
-    : 6445;
-exports.APISERVER_AUTOPILOT_DEFAULT_LANGUAGE_CODE = process.env.APISERVER_AUTOPILOT_DEFAULT_LANGUAGE_CODE || "en-US";
-exports.APISERVER_AUTOPILOT_MEDIA_BUSY_MESSAGE = process.env.APISERVER_AUTOPILOT_MEDIA_BUSY_MESSAGE;
-exports.APISERVER_AUTOPILOT_MEDIA_NOANSWER_MESSAGE = process.env.APISERVER_AUTOPILOT_MEDIA_NOANSWER_MESSAGE;
+const path_1 = require("path");
+const dotenv_1 = __importDefault(require("dotenv"));
+if (process.env.NODE_ENV === "dev") {
+    dotenv_1.default.config({ path: (0, path_1.join)(process.cwd(), ".env") });
+}
+exports.OPENAI_API_KEY = process.env.OPENAI_API_KEY;

package/dist/index.d.ts

@@ -1 +1 @@
-export {};
+export { machine } from "./machine";

package/dist/index.js

@@ -1,10 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.machine = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
  *
  * This file is part of Fonoster
@@ -21,10 +19,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const envs_1 = require("./envs");
-const pilot_1 = __importDefault(require("./pilot"));
-(0, pilot_1.default)({
-    defaultLanguageCode: envs_1.APISERVER_AUTOPILOT_DEFAULT_LANGUAGE_CODE,
-    port: envs_1.APISERVER_AUTOPILOT_PORT,
-    eventsServerEnabled: false
-});
+var machine_1 = require("./machine");
+Object.defineProperty(exports, "machine", { enumerable: true, get: function () { return machine_1.machine; } });

package/dist/machine/index.d.ts

@@ -0,0 +1 @@
+export { machine } from "./machine";

package/dist/machine/index.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.machine = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var machine_1 = require("./machine");
+Object.defineProperty(exports, "machine", { enumerable: true, get: function () { return machine_1.machine; } });

package/dist/machine/machine.d.ts

@@ -0,0 +1,163 @@
+declare const machine: import("xstate").StateMachine<{
+    firstMessage: string;
+    voice: import("@fonoster/voice").VoiceResponse;
+    assistant: import("../assistants/assistants").Assistant;
+    playbackRef: string;
+    speechBuffer: string;
+    speechResponseStartTime: number;
+    speechResponseTime: number;
+}, {
+    type: "SPEECH_START";
+} | {
+    type: "SPEECH_END";
+} | {
+    type: "SESSION_END";
+} | {
+    type: "HUMAN_PROMPT";
+    speech: string;
+}, {}, never, import("xstate").Values<{
+    sendGreeting: {
+        type: "sendGreeting";
+        params: unknown;
+    };
+    interruptMachineSpeaking: {
+        type: "interruptMachineSpeaking";
+        params: unknown;
+    };
+    appendSpeech: {
+        type: "appendSpeech";
+        params: unknown;
+    };
+    processHumanRequest: {
+        type: "processHumanRequest";
+        params: unknown;
+    };
+    hangup: {
+        type: "hangup";
+        params: unknown;
+    };
+}>, {
+    type: "hasSpeechBuffer";
+    params: unknown;
+}, never, "hangup" | "welcome" | "machineListening" | "humanSpeaking", string, {
+    firstMessage: string;
+    voice: import("@fonoster/voice").VoiceResponse;
+    assistant: import("../assistants/assistants").Assistant;
+}, import("xstate").NonReducibleUnknown, import("xstate").EventObject, import("xstate").MetaObject, {
+    readonly context: ({ input }: {
+        spawn: {
+            <TSrc extends never>(logic: TSrc, ...[options]: never): import("xstate").ActorRefFromLogic<never>;
+            <TLogic extends import("xstate").AnyActorLogic>(src: TLogic, options?: {
+                id?: never;
+                systemId?: string;
+                input?: import("xstate").InputFrom<TLogic> | undefined;
+                syncSnapshot?: boolean;
+            } | undefined): import("xstate").ActorRefFromLogic<TLogic>;
+        };
+        input: {
+            firstMessage: string;
+            voice: import("@fonoster/voice").VoiceResponse;
+            assistant: import("../assistants/assistants").Assistant;
+        };
+        self: import("xstate").ActorRef<import("xstate").MachineSnapshot<{
+            firstMessage: string;
+            voice: import("@fonoster/voice").VoiceResponse;
+            assistant: import("../assistants/assistants").Assistant;
+            playbackRef: string;
+            speechBuffer: string;
+            speechResponseStartTime: number;
+            speechResponseTime: number;
+        }, {
+            type: "SPEECH_START";
+        } | {
+            type: "SPEECH_END";
+        } | {
+            type: "SESSION_END";
+        } | {
+            type: "HUMAN_PROMPT";
+            speech: string;
+        }, Record<string, import("xstate").AnyActorRef | undefined>, import("xstate").StateValue, string, unknown, any, any>, {
+            type: "SPEECH_START";
+        } | {
+            type: "SPEECH_END";
+        } | {
+            type: "SESSION_END";
+        } | {
+            type: "HUMAN_PROMPT";
+            speech: string;
+        }, import("xstate").AnyEventObject>;
+    }) => {
+        firstMessage: string;
+        voice: import("@fonoster/voice").VoiceResponse;
+        assistant: import("@langchain/core/runnables").Runnable<any, string, import("@langchain/core/runnables").RunnableConfig>;
+        playbackRef: string;
+        speechBuffer: string;
+        speechResponseStartTime: number;
+        speechResponseTime: number;
+    };
+    readonly id: "fnAI";
+    readonly initial: "welcome";
+    readonly states: {
+        readonly welcome: {
+            readonly entry: {
+                readonly type: "sendGreeting";
+            };
+            readonly always: {
+                readonly target: "machineListening";
+            };
+            readonly description: "The initial state where the AI greets the Human.";
+        };
+        readonly machineListening: {
+            readonly on: {
+                readonly SPEECH_START: {
+                    readonly target: "humanSpeaking";
+                    readonly description: "This must be triggered by a VAD or similar system.";
+                };
+                readonly HUMAN_PROMPT: {
+                    readonly actions: {
+                        readonly type: "appendSpeech";
+                    };
+                    readonly description: "Appends the speech to the buffer.";
+                };
+            };
+            readonly description: "The state where the AI is actively listening in conversation.";
+        };
+        readonly humanSpeaking: {
+            readonly entry: {
+                readonly type: "interruptMachineSpeaking";
+            };
+            readonly on: {
+                readonly HUMAN_PROMPT: {
+                    readonly actions: {
+                        readonly type: "appendSpeech";
+                    };
+                    readonly description: "Appends the speech to the buffer.";
+                };
+                readonly SPEECH_END: {
+                    readonly target: "machineListening";
+                    readonly actions: {
+                        readonly type: "processHumanRequest";
+                    };
+                    readonly guard: {
+                        readonly type: "hasSpeechBuffer";
+                    };
+                    readonly description: "This must be triggered by a VAD or similar system.";
+                };
+            };
+            readonly description: "The state where the AI detects Human speech while it is speaking.";
+        };
+        readonly hangup: {
+            readonly type: "final";
+            readonly entry: {
+                readonly type: "hangup";
+            };
+            readonly on: {
+                readonly SESSION_END: {
+                    readonly target: "hangup";
+                };
+            };
+            readonly description: "The final state where the AI terminates the conversation due to inactivity.";
+        };
+    };
+}>;
+export { machine };