aimyapi 0.1.2 → 0.1.4

package/README.md

@@ -152,26 +152,218 @@ The module created by the `createWithAPI` function:
 
 #### Methods
 
-- `generateCode(queryText: string, userChatHistory: ChatCompletionRequestMessage[]): Promise<string>`: A function that generates code for the given query text and user chat history.
-- `runCode(task: string): Promise<void>`: A function that runs the generated code.
-- `processRequest(userQuery: string, context?: object): Promise<string>`: A function that processes a user request.
+- `generateCode(queryText: string, userChatHistory: ChatCompletionRequestMessage[]): Promise<string>`: A function that generates code to be run in the sandbox for the given query text and user chat history.
+- `runCode(task: string): Promise<void>`: A function that runs the generated code in the sandbox.
+- `processRequest(userQuery: string, context?: object): Promise<string>`: A single function that generates and runs code assuming no chat history.
 
 ## Examples
 
 Download or clone the repo. From the root folder run the following.
 
+
+### Example 1 - sales database
 A simple api example where the LLM allows you to ask questions and compute things about a dataset
 ```
 npm run example1
 ```
 
+```
+import AIMyAPI from "../lib";
+import { API } from "./sales_api_impl";
+import * as APIExports from "./sales_api";
+import path from "path";
+
+// Simpler example using no support for chat history; 
+
+(async () => {
+    const api = new API();
+
+    const aimyapi = await AIMyAPI.createWithAPI({
+        apiObject: api,
+        apiGlobalName: "api", // Should match whatever you declared as your global in your api.
+        apiExports: APIExports,
+        apiDefFilePath: path.join(__dirname, "./sales_api.ts"),
+        apiDocsPath: path.join(__dirname, "./sales_api.md"),
+        debug: false,
+    })
+    
+    console.log("Print 'hello' three times.")
+    await aimyapi.processRequest("Print 'hello' three times.");
+
+    console.log("What was our best month in 2020")
+    await aimyapi.processRequest("What was our best month in 2020");
+
+    console.log("Which business unit had the highest sales in 2020?")
+    await aimyapi.processRequest("Which business unit had the highest sales in 2020?");
+
+    console.log("Compute the total sales for each month in 2020 then email the top 3 to test@email.com")
+    await aimyapi.processRequest("Compute the total sales for each month in 2020 then email the top 3 to test@email.com");
+})();
+```
+
+Output:
+```
+Print 'hello' three times.
+Generate Task: 4.086s
+hello
+hello
+hello
+Run Code: 379.328ms
+What was our best month in 2020
+Generate Task: 11.345s
+Our best month in 2020 was month 8 with 4400 sales.
+Run Code: 119.145ms
+Which business unit had the highest sales in 2020?
+Generate Task: 11.477s
+The business unit with the highest sales in 2020 was Hardware
+Run Code: 124.522ms
+Compute the total sales for each month in 2020 then email the top 3 to test@email.com
+Generate Task: 15.648s
+Sending email to "test@email.com" with subject "Top 3 Sales Months in 2020" and body
+"Top 3 sales months in 2020:
+Month 8: $4400
+Month 7: $4300
+Month 6: $4000"
+Run Code: 1.200s
+```
+
+### Example 2 - Food ordering bot
+
 A more complex food ordering example which incorporates chat history
 
 ```
 npm run example2
 ```
 
-Interactive ordering example (same api as example2)
+Code:
+```
+import AIMyAPI from "../lib";
+import { OrderingAPI } from "./ordering_api_impl";
+import * as APIExports from "./ordering_api";
+import path from "path";
+
+// More complex fast food ordering example that uses chat history.
+// Fast food ordering example.
+(async () => {
+    const api = new OrderingAPI();
+
+    const aimyapi = await AIMyAPI.createWithAPI({
+        apiObject: api,
+        apiGlobalName: "orderingApi",       // Should match whatever you declared as your global in your ordering api.
+        apiExports: APIExports,
+        apiDefFilePath: path.join(__dirname, "./ordering_api.ts"),
+        apiDocsPath: path.join(__dirname, "./ordering_api.md"),
+        debug: false,
+    })
+
+    async function runQuery(query:string) {
+        console.log(`Query: ${query}`)
+
+        // generate the code for this query
+        const code = await aimyapi.generateCode(query, api._getHistory());
+
+        api._addMessageToHistory({
+            content: query,
+            role: "user",
+            name: "user",
+        });
+
+        api._addMessageToHistory({
+            content: '```\n' + code + '\n```',
+            role: "assistant",
+            name: "assistant",
+        });
+
+        // run the code in the sandbox
+        await aimyapi.runCode(code);
+    }
+   
+    await runQuery("How's the burger here?");
+    await runQuery("I'd like a plain hamburger and a large fries, a pizza with anchovies and a cola. I'd also like a cheese burger with bacon and avocado.");
+    await runQuery("I changed my mind, instead of anchovies, can I get a large gluten free pizza with pineapple instead.");
+    await runQuery("email me the total at myemail@test.com and complete the order");
+
+})();
+```
+
+Output:
+```
+Query: How's the burger here?
+Our Hamburger is delicious! It comes with cheese, lettuce, tomato, and onion by default, but you can customize it with any of our toppings.
+Query: I'd like a plain hamburger (no cheese) and a large fries, a pizza with anchovies and a cola. I'd also like a cheese burger with bacon and avocado.
+        added #0 Hamburger...           $8.99
+                lettuce
+                tomato
+                onion
+
+Ok, I added a plain hamburger. What else would you like?
+        added #1 Fries...               $2.99
+                Large...        $1.99
+
+Ok, I added large fries. What else would you like?
+        added #2 Pizza...               $10.99
+                anchovies
+
+Ok, I added a pizza with anchovies. What else would you like?
+        added #3 Fountain Drink...              $1.99
+                Large...        $0.99
+
+Ok, I added a cola. What else would you like?
+        added #4 Hamburger...           $8.99
+                cheese
+                lettuce
+                tomato
+                onion
+                cheese
+                bacon
+                avocado
+
+Ok, I added a cheese burger with bacon and avocado. Is there anything else I can help you with?
+Query: I changed my mind, instead of anchovies, can I get a large gluten free pizza with pineapple instead.
+Removed item 2
+        added #5 Pizza...               $10.99
+                pineapple
+                Gluten Free Crust...    $2.99
+
+Ok, I added a large gluten free pizza with pineapple. Is there anything else I can help you with?
+Query: email me the total at myemail@test.com and complete the order
+Sending email to "myemail@test.com" with subject "Order Total" and body
+"Your order total is $39.92."
+----
+
+Displaying order:
+        #0 Hamburger...         $8.99
+                lettuce
+                tomato
+                onion
+
+        #1 Fries...             $2.99
+                Large...        $1.99
+
+        #3 Fountain Drink...            $1.99
+                Large...        $0.99
+
+        #4 Hamburger...         $8.99
+                cheese
+                lettuce
+                tomato
+                onion
+                cheese
+                bacon
+                avocado
+
+        #5 Pizza...             $10.99
+                pineapple
+                Gluten Free Crust...    $2.99
+
+--      Total:          $39.92
+Order completed!
+Your order has been completed. Thank you for choosing our restaurant!
+```
+
+# Example 3 - interactive food ordering
+
+Interactive ordering example (same api as example2). You can type your own orders on the command line.
 
 ```
 npm run example3

package/dist/{lib/index.d.ts → index.d.ts}

@@ -19,7 +19,7 @@ export interface CreateWithAPIExports {
 export interface AIMyAPIExports {
     createWithAPI: (options: AIMyAPIOptions) => Promise<CreateWithAPIExports>;
     createBasePrompt: (apiFilePath: string, documentationPath: string) => string;
-    generateTask: (queryText: string, userChatHistory: any[], createTaskPrompt: string, apiPath: string) => Promise<string>;
+    generateCode: (queryText: string, userChatHistory: ChatCompletionRequestMessage[], createTaskPrompt: string, apiPath: string, debug: boolean) => Promise<string>;
     createSandbox: (QuickJS: QuickJSWASMModule, globals: any) => Promise<any>;
 }
 declare const aimyapi: AIMyAPIExports;

package/dist/{lib/index.js → index.js}

@@ -29,12 +29,24 @@ function createBasePrompt(apiFilePath, documentationPath) {
     return createTaskPrompt;
 }
 exports.createBasePrompt = createBasePrompt;
-// userChatHistory is not currently used but could be in the future.
+// FIXME: add an options parameter and allow specifying the token limit
 const generateCode = async function (queryText, userChatHistory, createTaskPrompt, apiPath, debug = false) {
     if (!queryText)
         return;
     let generatedCode = '';
     const prompt = createTaskPrompt.replace("{{QUERY_TEXT}}", queryText);
+    const messages = [
+        {
+            role: "system",
+            content: prompt,
+        },
+        ...userChatHistory,
+        {
+            role: "user",
+            content: `${queryText}`,
+            name: "user"
+        }
+    ];
     // TODO: I should switch this back to gpt3.5 turbo since it's cheaper
     try {
         // const task = await openai.createCompletion(
@@ -47,20 +59,9 @@ const generateCode = async function (queryText, userChatHistory, createTaskPromp
         // );
         const results = await openai.createChatCompletion({
             model: "gpt-3.5-turbo",
-            messages: [
-                {
-                    role: "system",
-                    content: prompt,
-                },
-                ...userChatHistory,
-                {
-                    role: "user",
-                    content: `${queryText}`,
-                    name: "user"
-                }
-            ],
+            messages: messages,
             temperature: 0.1,
-            max_tokens: 800,
+            max_tokens: 700,
         });
         if (debug)
             console.log(results.data.usage);
@@ -73,11 +74,12 @@ const generateCode = async function (queryText, userChatHistory, createTaskPromp
         if (codeStart === -1 || codeEnd === -1 || codeStart === codeEnd)
             return '';
         generatedCode = response.substring(codeStart + 3, codeEnd).replace('typescript', '');
-        generatedCode = `// Query=${queryText}\n` + generatedCode.replace("./api.ts", apiPath);
+        generatedCode = generatedCode.replace("./api.ts", apiPath);
         return generatedCode;
     }
     catch (err) {
         console.error(err);
+        console.log("Prompt", messages);
         return '';
     }
 };
@@ -173,7 +175,7 @@ const aimyapi = {
     createWithAPI,
     // functions for customized usage
     createBasePrompt,
-    generateTask: exports.generateCode,
+    generateCode: exports.generateCode,
     createSandbox: sandbox_1.default,
 };
 exports.default = aimyapi;

package/dist/{lib/sandbox.js → sandbox.js}

@@ -121,7 +121,7 @@ async function createSandbox(QuickJS, requireLookup = {}, globals = {}, debug =
             try {
                 const compiled = tsCompile(task);
                 if (!compiled || compiled.length === 0) {
-                    console.log("Could not compile");
+                    console.error("Could not compile", task);
                     return false;
                 }
                 // View compiled typescript code for debugging

package/example/example1.ts

@@ -1,10 +1,8 @@
-
 import AIMyAPI from "../lib";
 import { API } from "./sales_api_impl";
 import * as APIExports from "./sales_api";
 import path from "path";
 
-
 // Simpler example using no support for chat history; 
 
 (async () => {

package/example/example2.ts

@@ -1,24 +1,22 @@
-
 import AIMyAPI from "../lib";
 import { OrderingAPI } from "./ordering_api_impl";
 import * as APIExports from "./ordering_api";
 import path from "path";
 
-
-
 // More complex fast food ordering example that uses chat history.
 // Fast food ordering example.
 (async () => {
     const api = new OrderingAPI();
 
-    const aimyapi = await AIMyAPI.createWithAPI({
+    const options = {
         apiObject: api,
         apiGlobalName: "orderingApi",       // Should match whatever you declared as your global in your ordering api.
         apiExports: APIExports,
         apiDefFilePath: path.join(__dirname, "./ordering_api.ts"),
         apiDocsPath: path.join(__dirname, "./ordering_api.md"),
         debug: false,
-    })
+    };
+    const aimyapi = await AIMyAPI.createWithAPI(options)
 
     async function runQuery(query:string) {
         console.log(`Query: ${query}`)
@@ -33,7 +31,7 @@ import path from "path";
         });
 
         api._addMessageToHistory({
-            content: '```\n' + code + '\n```',
+            content: '```\n' + code.replace(options.apiDefFilePath, "./api.ts") + '\n```',
             role: "assistant",
             name: "assistant",
         });
@@ -43,7 +41,7 @@ import path from "path";
     }
    
     await runQuery("How's the burger here?");
-    await runQuery("I'd like a plain hamburger and a large fries, a pizza with anchovies and a cola. I'd also like a cheese burger with bacon and avocado.");
+    await runQuery("I'd like a plain hamburger (no cheese) and a large fries, a pizza with anchovies and a cola. I'd also like a cheese burger with bacon and avocado.");
     await runQuery("I changed my mind, instead of anchovies, can I get a large gluten free pizza with pineapple instead.");
     await runQuery("email me the total at myemail@test.com and complete the order");
 

package/example/ordering_api.md

@@ -20,14 +20,20 @@ import * as ApiDefs from './api.ts'
 })();
 ```
 
-user: Add a hamburger to my order
+user: Add a hamburger with no cheese to my order
 
 assistant:
 ```
 import * as ApiDefs from './api.ts'
 (async() {
     try {
-        orderingApi.addItemToOrder("Hamburger", [], []);
+        const itemName = "Hamburger";
+		const item = ApiDefs.Menu.find((item) => item.name === itemName);
+		if (!item) {
+			throw new Error(`Item with name "${itemName}" not found`);
+		}
+
+        orderingApi.addItemToOrder(itemName, undefined, item.toppings.filter( topping => topping.name != "cheese") );
         orderingApi.respondToUser("Ok, I added a Hamburger. What else would you like?");
     } catch(e) {
         console.error(e);
@@ -35,6 +41,8 @@ import * as ApiDefs from './api.ts'
 })();
 ```
 
+assistant: Added Hamburger with id 1
+
 user: I'd like a large pizza with mushrooms
 
 assistant:
@@ -42,7 +50,6 @@ assistant:
 import * as ApiDefs from './api.ts'
 (async() {
     try {
-        ApiDefs.Menu
         orderingApi.addItemToOrder("Pizza", ["Large"], ["mushrooms"]);
         orderingApi.respondToUser("Ok, I added a Large Pizza with mushrooms");
     } catch(err) {
@@ -51,23 +58,28 @@ import * as ApiDefs from './api.ts'
 })();
 ```
 
-user: I'd like a cheese burger
+user: Add a hamburger with bacon
 
-assistant: 
+assistant:
 ```
 import * as ApiDefs from './api.ts'
 (async() {
     try {
-        orderingApi.addItemToOrder("Hamburger", [], ["cheese"]);
-        orderingApi.respondToUser("Ok, I added a Hamburger. What else would you like?");
+        const itemName = "Hamburger";
+		const item = ApiDefs.Menu.find((item) => item.name === itemName);
+		if (!item) {
+			throw new Error(`Item with name "${itemName}" not found`);
+		}
+
+        orderingApi.addItemToOrder(itemName, undefined, [...item.toppings, "bacon"]);
+        orderingApi.respondToUser("Ok, I added a Hamburger with no cheese or onions. What else would you like?");
     } catch(e) {
-        orderingApi.respondToUser("Apologies, something went wrong with that request.");
         console.error(e);
     }
 })();
 ```
 
-assistant: Added Hamburger with id 1
+assistant: Added Hamburger with id 2
 
 user: Add jalapenos to that
 
@@ -76,10 +88,10 @@ assistant:
 import * as ApiDefs from './api.ts'
 (async() {
     try {
-        const existingItem = orderingApi.getItemInOrder("1");
+        const existingItem = orderingApi.getItemInOrder("2");
 
         if(existingItem) {
-            orderingApi.modifyItemInOrder("1", existingItem.customizations.map(item => item.name), [...existingItem.toppings, "jalapenos"]);
+            orderingApi.modifyItemInOrder("2", existingItem.customizations.map(item => item.name), [...existingItem.toppings, "jalapenos"]);
             orderingApi.respondToUser("Ok, I added jalapenos to your Hamburger");
         } else {
             orderingApi.respondToUser("Hmm, I can't find that item.");

package/example/ordering_api.ts

@@ -66,20 +66,15 @@ export const Menu: MenuItemBase[] = [
     {
         "name": "Hamburger",
         "price": 8.99,
-        "description": "A classic american hamburger with your choice of toppings. Cheese, lettuce, tomato, and onion are included by default. Other toppings available on request.",
+        "description": "A classic american hamburger with your choice of toppings. Cheese, lettuce, tomato, and onion toppings are included by default. Other toppings available on request.",
         "category": "Burgers",
         "tags": [
             "hamburger",
             "burger"
         ],
         "customizations": [],
-        "allowedCustomizations": [
-            {
-                "name": "Special sauce",
-                "priceAdjustment": 1.99
-            }
-        ],
-        "toppings": [],
+        "allowedCustomizations": [],
+        "toppings": [ "cheese", "lettuce", "tomato", "onion"],
         "allowedToppings": [
             "cheese",
             "lettuce",
@@ -116,7 +111,7 @@ export const Menu: MenuItemBase[] = [
     {
         "name": "Fountain Drink",
         "price": 1.99,
-        "description": "A classic fountain drink. Choose from Cola, Diet Cola, Dr. Dazzle, or Mountain Rush.",
+        "description": "A classic fountain drink. Choose from the following sodas Cola, Diet Cola, Dr. Dazzle, or Mountain Rush. Large size available on request.",
         "category": "Drinks",
         "tags": [
             "drink",
@@ -157,9 +152,9 @@ export interface OrderingAPIInterface {
     // Gets the customization with the specified name for the specified item.
     // If the item does not have a customization with the specified name, returns undefined.
 
-    addItemToOrder(itemName:string, customizationNames: string[], toppings: string[]): void;
+    addItemToOrder(itemName:string, customizationNames: string[] | undefined, toppings: string[] | undefined): void;
     // Adds the specified item to the order.
-    // when adding an item, you should always create a new object that matches the existing menu item structure. Only include the toppings that the user has specified unless they come by default with the item.
+    // leave customizationNames and toppings undefined if you want to use the default values for the item.
 
     removeItemFromOrder(itemOrderId: string): void;
     // Removes the item with the specified id from the order.
@@ -179,8 +174,9 @@ export interface OrderingAPIInterface {
     delay(milliseconds: number): Promise<void>;
     // waits for the specified number of milliseconds before resolving the promise.
 
-    displayItem(item: MenuItemBase): void;
+    displayItem(item: MenuItemBase, justAdded:boolean): void;
     // Displays the specified item to the user.
+    // If justAdded is true, the item will be displayed as a new item in the order.
 
     displayOrder(): void;
     // Displays the current order to the user.

package/example/ordering_api_impl.ts

@@ -26,10 +26,7 @@ export class OrderingAPI implements OrderingAPIInterface {
 
 	respondToUser(text: string): void {
 		console.log(text);
-		this._history.push({
-			role: "assistant",
-			content: "Response output: " + text,
-		});
+
 	}
 
 	delay(milliseconds: number): Promise<void> {
@@ -61,33 +58,38 @@ export class OrderingAPI implements OrderingAPIInterface {
 
 	addItemToOrder(
 		itemName: string,
-		customizationNames: string[],
-		toppings: string[]
+		customizationNames: string[] | undefined,
+		toppings: string[] | undefined
 	) {
 		const item = Menu.find((item) => item.name === itemName);
 		if (!item) {
 			throw new Error(`Item with name "${itemName}" not found`);
 		}
 
-		const customizations = customizationNames
+		const customizations = customizationNames ? customizationNames
 			.map((customizationName) => {
 				return this.getCustomizationByName(itemName, customizationName);
 			})
 			.filter(
 				(customization) => customization !== undefined
-			) as Customization[];
+			) as Customization[] : [...item.customizations];
 
 		const newItem = {
 			...item,
 			customizations,
-			toppings: toppings,
+			toppings: toppings ? toppings : [...item.toppings],
 			orderId: "" + this._lastOrderIdNumber++,
 		};
 
 		this._order.push(newItem);
 
-		this.respondToUser(`Added ${itemName} with id ${newItem.orderId}`);
-		this.displayItem(newItem);
+		//this.respondToUser(`Added ${itemName} with id ${newItem.orderId}`);
+
+		this._history.push({
+			role: "user",
+			content: `I see you have added added ${itemName} with id ${newItem.orderId}`,
+		});
+		this.displayItem(newItem, true);
 	}
 
     getItemInOrder(itemOrderId: string): MenuItemBase {
@@ -102,6 +104,10 @@ export class OrderingAPI implements OrderingAPIInterface {
 	removeItemFromOrder(itemOrderId: string) {
 		this._order = this._order.filter((item) => item.orderId !== itemOrderId);
 
+		this._history.push({
+			role: "user",
+			content: `I see you have removed item ${itemOrderId}`,
+		});
 		this.respondToUser(`Removed item ${itemOrderId}`);
 	}
 
@@ -132,6 +138,10 @@ export class OrderingAPI implements OrderingAPIInterface {
 			throw new Error(`Item with id #"${itemOrderId}" not found in order`);
 		}
 
+		this._history.push({
+			role: "user",
+			content: `I see you have modified item ${itemOrderId}`,
+		});
 		this.respondToUser(`Modified item ${itemOrderId}`);
 	}
 
@@ -160,20 +170,19 @@ export class OrderingAPI implements OrderingAPIInterface {
         this._isCompleted = true;
 	}
 
-	displayItem(item: MenuItemBase) {
-		this.respondToUser(
-			`\t#${item.orderId || ""} ${item.name}...\t\t$${item.price.toFixed(2)}`
-		);
+	displayItem(item: MenuItemBase, justAdded: boolean = false) {
+		let output = "";
+
+		output += `\t${justAdded ? "added " : ""}#${item.orderId || ""} ${item.name}...\t\t$${item.price.toFixed(2)}\n`;
 		item.toppings.forEach((topping) => {
-			this.respondToUser(`\t\t${topping}`);
+			output += `\t\t${topping}\n`;
 		});
 		item.customizations.forEach((customization) => {
-			this.respondToUser(
-				`\t\t${customization.name}...\t$${customization.priceAdjustment.toFixed(
-					2
-				)}`
-			);
+			output += `\t\t${customization.name}...\t$${customization.priceAdjustment.toFixed(2)}\n`;
 		});
+
+
+		this.respondToUser(output)
 	}
 
 	displayOrder() {