@fonoster/autopilot 0.5.4 → 0.7.0

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,7 @@
+import { AutopilotConfig } from "./types";
+declare class Autopilot {
+    private config;
+    constructor(config: AutopilotConfig);
+    start(): void;
+}
+export { Autopilot };

package/dist/Autopilot.js

@@ -0,0 +1,58 @@
+"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 logger = (0, logger_1.getLogger)({ service: "autopilot", filePath: __filename });
+class Autopilot {
+    constructor(config) {
+        this.config = config;
+        this.config = config;
+    }
+    start() {
+        const { voice, assistantConfig, firstMessage } = this.config;
+        const assistant = (0, assistants_1.makeAssistant)(assistantConfig);
+        const actor = (0, xstate_1.createActor)(machine_1.machine, {
+            input: {
+                firstMessage,
+                voice,
+                assistant
+            }
+        });
+        actor.start();
+        actor.subscribe((state) => {
+            logger.verbose("actor's new state is", { state: state.value });
+        });
+        voice
+            .sgather({
+            source: common_1.StreamGatherSource.SPEECH
+        })
+            .then((stream) => {
+            stream.onPayload((payload) => {
+                actor.send({ type: "HUMAN_PROMPT", speech: payload.speech });
+            });
+        });
+    }
+}
+exports.Autopilot = Autopilot;

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/examples.d.ts

@@ -0,0 +1,10 @@
+export declare const RESTAURANT_PHONE_ASSISTANT: {
+    name: string;
+    firstMessage: string;
+    template: string;
+};
+export declare const OLIVIA_AI_PHONE_ASSISTANT: {
+    name: string;
+    firstMessage: string;
+    template: string;
+};

package/dist/assistants/examples.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OLIVIA_AI_PHONE_ASSISTANT = exports.RESTAURANT_PHONE_ASSISTANT = 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.
+ */
+exports.RESTAURANT_PHONE_ASSISTANT = {
+    name: "Restaurant Phone Assistant",
+    firstMessage: "Hello, I'm Martha the AI assistant from Restaurant La Casa. How can I help you today?",
+    template: `
+  ## La casa AI Phone Assistant (Martha)
+
+  ### Mission Statement
+
+  To assist users in navigating our restaurant's offerings. This includes providing information on the menu, 
+  handling reservations, and updating on special events.
+
+  ### Interaction Modes
+
+  - **Age Restriction:** None; suitable for all ages.
+  - **Meal Options:** Brunch, Lunch, Dinner.
+  - **Special Notes:** Users should specify any dietary restrictions or preferences.
+
+  ### Available Links
+
+  Since you are a AI Phone assistant, you can't browse the web. However, you can send links to the user's phone via SMS.
+  Here are some useful links for Restaurant La Casa:
+
+  - [Menu Information](https://www.lacasarestaurant.com/menu)
+  - [Make a Reservation](https://www.lacasarestaurant.com/reservations)
+  - [Special Events Details](https://www.lacasarestaurant.com/events)
+
+  ### Hours of Operation
+
+  - **Brunch:** 9:00 AM - 12:00 PM
+  - **Lunch:** 12:00 PM - 3:00 PM
+  - **Dinner:** 5:00 PM - 10:00 PM
+
+  ### Special Instructions
+
+  Provide accurate and timely responses to user inquiries. Stay on brand and maintain a friendly and professional tone.
+  Only provide information that is relevant to the user's request. If the user asks for something that is not within the scope of the system,
+  politely inform them that you are unable to assist with that request.
+
+  In case of any medical emergency instruct the user to call 911 immediately.
+
+  Make sure all response are readable by a TTS engine. For example, when reading the hours of operation, say "Brunch is served from 9:00 AM to 12:00 PM.".
+  Similarly, when providing links, say "I have sent you a link to the menu."
+`
+};
+exports.OLIVIA_AI_PHONE_ASSISTANT = {
+    name: "Olivia AI Phone Assistant",
+    firstMessage: "Hello, I'm Olivia your friendly AI. What would you like to chat about today?",
+    template: `
+    ## Olivia the friendly AI
+
+    ### Mission Statement
+
+    Olivia is designed to help users by researching topics, bringing news updates, and telling engaging stories. Our goal is to provide accurate information and captivating narratives in a timely manner.
+
+    ### Available Links
+
+    As an AI, Olivia can browse the web and retrieve information in real-time. Here are some resources that Olivia may use to enhance the user experience:
+
+    - [Latest News](https://www.news.com)
+    - [Popular Topics](https://www.populartopics.com)
+    - [Story Archive](https://www.storyarchive.com)
+
+    ### Special Instructions
+
+    Provide accurate and up-to-date information on requested topics. Maintain a friendly, engaging, and creative tone. Ensure that all responses are clear and easy to understand. If a topic or request is beyond Olivia's capabilities, politely inform the user and suggest alternative sources if possible.
+
+    In case of urgent or critical news, inform users to consult trusted news sources immediately.
+
+    Make sure all responses are concise and engaging. For instance, when delivering news updates, say "Here’s the latest update on the topic." When telling stories, ensure the narrative is compelling and well-structured.
+
+    When telling story, begin with conversation starters like "Sure, I have a great story for you!" or "Let me tell you a fascinating tale!".
+
+    When you finish a story, or news summary, end with a conversation prompt like "What do you think?" or "Would you like to hear more?".
+`
+};

package/dist/assistants/index.d.ts

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

package/dist/{file-retention → 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.makeAssistant = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
  *
- * This file is part of nodejs-voiceapp
+ * This file is part of Fonoster
  *
  * Licensed under the MIT License (the "License");
  * you may not use this file except in compliance with
@@ -32,4 +33,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-__exportStar(require("./cron"), exports);
+var assistants_1 = require("./assistants");
+Object.defineProperty(exports, "makeAssistant", { enumerable: true, get: function () { return assistants_1.makeAssistant; } });
+__exportStar(require("./types"), exports);

package/dist/assistants/types.d.ts

@@ -0,0 +1,13 @@
+declare enum Model {
+    GPT_3 = "gpt-3",
+    GPT_4 = "gpt-4",
+    GPT_4O_MINI = "gpt-4o-mini"
+}
+type AssistantConfig = {
+    apiKey: string;
+    model: Model;
+    temperature: number;
+    maxTokens: number;
+    systemTemplate: string;
+};
+export { 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/demo.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/demo.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * 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 logger_1 = require("@fonoster/logger");
+const voice_1 = __importDefault(require("@fonoster/voice"));
+const examples_1 = require("./assistants/examples");
+const types_1 = require("./assistants/types");
+const Autopilot_1 = require("./Autopilot");
+const envs_1 = require("./envs");
+const logger = (0, logger_1.getLogger)({ service: "autopilot", filePath: __filename });
+// Only skip identity for local development
+new voice_1.default({ skipIdentity: true }).listen((req, voice) => __awaiter(void 0, void 0, void 0, function* () {
+    const { ingressNumber, sessionRef, appRef } = req;
+    logger.verbose("voice request", { ingressNumber, sessionRef, appRef });
+    const { firstMessage, template: systemTemplate } = examples_1.OLIVIA_AI_PHONE_ASSISTANT;
+    const autopilot = new Autopilot_1.Autopilot({
+        voice,
+        firstMessage,
+        assistantConfig: {
+            apiKey: envs_1.OPENAI_API_KEY,
+            model: types_1.Model.GPT_4O_MINI,
+            temperature: 0.9,
+            maxTokens: 100,
+            systemTemplate
+        }
+    });
+    autopilot.start();
+}));

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,108 @@
+export declare const machine: import("xstate").StateMachine<{
+    firstMessage: string;
+    voice: import("@fonoster/voice").VoiceResponse;
+    assistant: import("../assistants/assistants").Assistant;
+}, {
+    type: "VOICE_DETECTED";
+} | {
+    type: "HUMAN_PROMPT";
+    speech: string;
+}, {}, never, import("xstate").Values<{
+    sendGreeting: {
+        type: "sendGreeting";
+        params: unknown;
+    };
+    interruptAISpeaking: {
+        type: "interruptAISpeaking";
+        params: unknown;
+    };
+    processHumanRequest: {
+        type: "processHumanRequest";
+        params: unknown;
+    };
+    hangup: {
+        type: "hangup";
+        params: unknown;
+    };
+}>, never, never, "hangup" | "active" | "welcome" | "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;
+        }, {
+            type: "VOICE_DETECTED";
+        } | {
+            type: "HUMAN_PROMPT";
+            speech: string;
+        }, Record<string, import("xstate").AnyActorRef | undefined>, import("xstate").StateValue, string, unknown, any, any>, {
+            type: "VOICE_DETECTED";
+        } | {
+            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>;
+    };
+    readonly id: "fnAI";
+    readonly initial: "welcome";
+    readonly states: {
+        readonly welcome: {
+            readonly always: {
+                readonly target: "active";
+            };
+            readonly entry: {
+                readonly type: "sendGreeting";
+            };
+            readonly description: "The initial state where the AI greets the Human.";
+        };
+        readonly active: {
+            readonly on: {
+                readonly HUMAN_PROMPT: {
+                    readonly target: "active";
+                    readonly actions: {
+                        readonly type: "processHumanRequest";
+                    };
+                    readonly description: "This must be triggered when speech to text ends.";
+                };
+            };
+            readonly description: "The state where the AI is actively engaged in conversation.";
+        };
+        readonly humanSpeaking: {
+            readonly always: {
+                readonly target: "active";
+            };
+            readonly entry: {
+                readonly type: "interruptAISpeaking";
+            };
+            readonly description: "The state where the AI detects Human speech while it is speaking.";
+        };
+        readonly hangup: {
+            readonly type: "final";
+            readonly description: "The final state where the AI terminates the conversation due to inactivity.";
+            readonly entry: {
+                readonly type: "hangup";
+            };
+        };
+    };
+}>;