chore: update to include the events hook + chat history

Author: psanders

README.md

@@ -48,10 +48,65 @@ To run the events server, you can use the following command:
 npm run start:eventsServer
 ```
 
+If your `eventsHook` is set you will receive events from Fonoster including the chat history which will look like this:
+
+```json
+{
+  eventType: 'conversation.ended',
+  chatHistory: [
+    {
+      ai: "Hello, I'm the Awesome Autopilot, how can I help you today?"
+    },
+    { human: 'trying to find out what the meaning of life' },
+    { ai: "Before we dive into that, what's your name?" },
+    { human: 'My name is John Doe' },
+    {
+      ai: 'Hello John Doe. Life is a journey of love, laughter, and learning. Anything else I can help you with?'
+    },
+    { human: 'No that is all' },
+    { ai: 'Thank you for your time. Have a great day!' }
+  ]
+}
+```
+
 This will start the events server on port `3000`. You will also need to run Ngrok to expose the events server to the internet. You can do this by running the following command:
 
 ```bash
 ngrok http 3000
 ```
 
 This will expose the events server to the internet and you can use the URL returned by Ngrok to test the events server.
+
+
+
+## Run the test cases
+
+Firt, make sure to set the `apiKey` for the language model and the evals provider in the `appConfig.yaml` file.
+
+Then, you use the following command to run the test cases:
+
+```bash
+fonoster utils:autopilotTestsCases -f appConfig.yaml
+```
+
+Your output should be similar to the following:
+
+```
+Scenario: test-case-1
+Overall Passed: ✔
+┌──────┬────────────────────────────┬────────────────────────────┬────────────────────────────┬────────────┬────────┐
+│ Step │ Human Input                │ Expected                   │ AI Response                │ Tool Calls │ Passed │
+├──────┼────────────────────────────┼────────────────────────────┼────────────────────────────┼────────────┼────────┤
+│ 1    │ I want to learn about the  │ Ok, but first, what's your │ Before we dive into that,  │            │ ✔      │
+│      │ meaning of life.           │ name?                      │ what's your name?          │            │        │
+├──────┼────────────────────────────┼────────────────────────────┼────────────────────────────┼────────────┼────────┤
+│ 2    │ My name is John Doe.       │ Great to meet you John     │ Hello John Doe. Life is a  │            │ ✔      │
+│      │                            │ Doe. Life is a journey of  │ journey of love, laughter, │            │        │
+│      │                            │ love, laughter, and        │ and learning. Is there     │            │        │
+│      │                            │ learning. Anything else I  │ anything else I can help   │            │        │
+│      │                            │ can help you with?         │ you with?                  │            │        │
+├──────┼────────────────────────────┼────────────────────────────┼────────────────────────────┼────────────┼────────┤
+│ 3    │ No, that's all.            │ Thank you for your time.   │ Thank you so much, bye!    │ hangup()   │ ✔      │
+│      │                            │ Have a great day!          │                            │            │        │
+└──────┴────────────────────────────┴────────────────────────────┴────────────────────────────┴────────────┴────────┘
+```

appConfig.yaml

@@ -18,14 +18,17 @@ intelligence:
         ## Role
         You are an awesome assistant that can talk about anything. You always ask for the user's name before proceeding with the conversation.
 
+        ## Instructions
+
+        Keep your answers short and concise as this is a phone call.
+
         ## Example Interaction
-        Assistant: Hello, I'm the Awesome Autopilot, how can I help you today?
         User: I want to learn about the meaning of life.
 
         Assistant: Ok, but first, what's your name?
         User: My name is John Doe. 
 
-        Assistant: Hello John Doe. Life is a journey of love, laughter, and learning. (And use the `saveUserInfo` tool to save the user's name)
+        Assistant: Hello John Doe. Life is a journey of love, laughter, and learning.
         User: That's a great answer! Thank you!
 
         Assistant: You're welcome! Is there anything else I can help you with?
@@ -47,26 +50,20 @@ intelligence:
         timeout: 30
     languageModel:
       provider: "groq"
-      model: "llama-3.1-70b-versatile"
+      model: "llama-3.3-70b-versatile"
       maxTokens: 240
       temperature: 0.4
       apiKey: "REDACTED"
-      tools: 
-        - name: "saveUserInfo"
-          description: "Tool to save the user's name."
-          parameters:
-            type: "object"
-            properties:
-              name:
-                type: "string"
-            required:
-              - name
-          operation:
-            method: "post"
-            url: "https://82e4-47-132-130-31.ngrok-free.app/events"
-            waitForResponse: false
-            headers:
-              x-api-key: "REDACTED"
+    eventsHook:
+      # TODO: Replace with your own URL
+      url: "https://ac86-47-132-130-31.ngrok-free.app/events"
+      headers:
+        Content-Type: "application/json"
+        Authorization: "Basic REDACTED"
+      events: ["all"]
+
+## TEST CASES
+
     testCases:
       evalsLanguageModel:
         # Note: Only OpenAI is supported for evals
@@ -91,10 +88,6 @@ intelligence:
                 text:
                   type: "similar"
                   response: "Great to meet you John Doe. Life is a journey of love, laughter, and learning. Anything else I can help you with?"
-                tools:
-                  - tool: "saveUserInfo"
-                    parameters:
-                      name: "John Doe"
             - userInput: "No, that's all."
               expected:
                 text:

src/eventsServer.ts

@@ -1,6 +1,6 @@
 import express from "express";
 const app = express();
-const port = 4000;
+const port = 3000;
 
 app.use(express.json());
 
@@ -13,15 +13,6 @@ app.post("/events", (req, res) => {
   });
 });
 
-app.get("/test", (req, res) => {
-  console.log("Headers:", req.headers);
-  console.log("Body:", req.body);
-
-  res.json({
-    result: "we booked an appointment for your for Friday next week"
-  });
-});
-
 app.listen(port, () => {
   console.log(`The events server is listening on port ${port}`);
 });