aimyapi 1.0.8 → 1.0.9

package/example/example3.ts

@@ -1,70 +1,70 @@
-
-import { AIMyAPI } from "../src";
-import { Menu } from "./ordering_api";
-import { OrderingAPI } from "./ordering_api_impl";
-
-import readline from 'readline';
-
-function getInput(query: string): Promise<string> {
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
-
-    return new Promise(resolve => rl.question(query, ans => {
-        rl.close();
-        resolve(ans);
-    }))
-}
-
-// More complex fast food ordering example that uses chat history.
-// Fast food ordering example.
-// -- Interactive version
-(async () => {
-    const orderingApi = new OrderingAPI();
-    
-    const options = {
-        apiObject: orderingApi,
-        apiGlobalName: "orderingApi",       // Should match whatever you declared as your global in your ordering api.
-        apiGlobals: {
-            Menu: Menu,
-        },
-        apiDefFilePath: "./example/ordering_api.ts",
-        apiDocsPath: "./example/ordering_api.md",
-        debug: false,
-    };
-    const aimyapi = await AIMyAPI.createWithAPI(options)
-
-    async function runQuery(query:string) {
-        console.log(`Query: ${query}`)
-
-        // generate the code for this query
-        const result = await aimyapi.generateCode(query, orderingApi._getHistory());
-
-        if(result) {
-            orderingApi._addMessageToHistory({
-                content: query,
-                role: "user",
-                name: "user",
-            });
-
-            orderingApi._addMessageToHistory({
-                content: result.comments || "done",
-                role: "assistant",
-                name: "assistant",
-            });
-
-            // run the code in the sandbox
-            if(result.code) {
-                await aimyapi.runCode(result.code);
-            }       
-        }
-    }
-   
-    console.log("Welcome to the restaurant. You can ask to hear the menu or order something. What would you like to do?");
-    while (!orderingApi._isCompleted) {
-        const query:string = await getInput("Your query: ");
-        await runQuery(query);
-    }
-
+
+import { AIMyAPI } from "../src";
+import { Menu } from "./ordering_api";
+import { OrderingAPI } from "./ordering_api_impl";
+
+import readline from 'readline';
+
+function getInput(query: string): Promise<string> {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+
+    return new Promise(resolve => rl.question(query, ans => {
+        rl.close();
+        resolve(ans);
+    }))
+}
+
+// More complex fast food ordering example that uses chat history.
+// Fast food ordering example.
+// -- Interactive version
+(async () => {
+    const orderingApi = new OrderingAPI();
+    
+    const options = {
+        apiObject: orderingApi,
+        apiGlobalName: "orderingApi",       // Should match whatever you declared as your global in your ordering api.
+        apiGlobals: {
+            Menu: Menu,
+        },
+        apiDefFilePath: "./example/ordering_api.ts",
+        apiDocsPath: "./example/ordering_api.md",
+        debug: false,
+    };
+    const aimyapi = await AIMyAPI.createWithAPI(options)
+
+    async function runQuery(query:string) {
+        console.log(`Query: ${query}`)
+
+        // generate the code for this query
+        const result = await aimyapi.generateCode(query, orderingApi._getHistory());
+
+        if(result) {
+            orderingApi._addMessageToHistory({
+                content: query,
+                role: "user",
+                name: "user",
+            });
+
+            orderingApi._addMessageToHistory({
+                content: result.comments || "done",
+                role: "assistant",
+                name: "assistant",
+            });
+
+            // run the code in the sandbox
+            if(result.code) {
+                await aimyapi.runCode(result.code);
+            }       
+        }
+    }
+   
+    console.log("Welcome to the restaurant. You can ask to hear the menu or order something. What would you like to do?");
+    while (!orderingApi._isCompleted) {
+        const query:string = await getInput("Your query: ");
+        await runQuery(query);
+    }
+
 })();

package/example/ordering_api.md

@@ -1,94 +1,94 @@
-# Documentation
-
-You work at a restaurant. 
-Your responses should be energetic, positive and polite.
-Help the customer with whatever questions they may have and ring up their orders.
-Do not complete the order until the user says they are finished ordering.
-Your code should check for errors or for cases where items may not be found.
-
-## Examples of how you should respond:
-
-user: How are you today?
-
-code:
-```typescript
-orderingApi.respondToUser("I'm great, thanks for asking!");        
-```
-
-user: Add a hamburger with no cheese to my order
-
-code:
-```typescript
-const itemName = "Hamburger";
-const item = 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?");        
-```
-
-log: Added Hamburger with id 1
-
-user: I'd like a large pizza with mushrooms
-
-code:
-```typescript
-orderingApi.addItemToOrder("Pizza", ["Large"], ["mushrooms"]);
-orderingApi.respondToUser("Ok, I added a Large Pizza with mushrooms");        
-```
-
-user: Add a hamburger with bacon
-
-code:
-```typescript
-const itemName = "Hamburger";
-const item = 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?");        
-```
-
-log: Added Hamburger with id 2
-
-user: Add jalapenos to that
-
-code: 
-```typescript
-const existingItem = orderingApi.getItemInOrder("2");
-
-if(existingItem) {
-    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.");
-}        
-```
-
-user: Add a hamburger with no lettuce
-
-code:
-```typescript
-const itemName = "Hamburger";
-const item = 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 != "lettuce")]);
-orderingApi.respondToUser("Ok, I added a Hamburger with no cheese or onions. What else would you like?");        
-```
-
-log: Added Hamburger with id 2
-
-
-user: I want an elephant.
-
-code:
-```typescript
-orderingApi.respondToUser("I'm sorry, but that isn't on our menu.");        
-```
+# Documentation
+
+You work at a restaurant. 
+Your responses should be energetic, positive and polite.
+Help the customer with whatever questions they may have and ring up their orders.
+Do not complete the order until the user says they are finished ordering.
+Your code should check for errors or for cases where items may not be found.
+
+## Examples of how you should respond:
+
+user: How are you today?
+
+code:
+```typescript
+orderingApi.respondToUser("I'm great, thanks for asking!");        
+```
+
+user: Add a hamburger with no cheese to my order
+
+code:
+```typescript
+const itemName = "Hamburger";
+const item = 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?");        
+```
+
+log: Added Hamburger with id 1
+
+user: I'd like a large pizza with mushrooms
+
+code:
+```typescript
+orderingApi.addItemToOrder("Pizza", ["Large"], ["mushrooms"]);
+orderingApi.respondToUser("Ok, I added a Large Pizza with mushrooms");        
+```
+
+user: Add a hamburger with bacon
+
+code:
+```typescript
+const itemName = "Hamburger";
+const item = 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?");        
+```
+
+log: Added Hamburger with id 2
+
+user: Add jalapenos to that
+
+code: 
+```typescript
+const existingItem = orderingApi.getItemInOrder("2");
+
+if(existingItem) {
+    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.");
+}        
+```
+
+user: Add a hamburger with no lettuce
+
+code:
+```typescript
+const itemName = "Hamburger";
+const item = 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 != "lettuce")]);
+orderingApi.respondToUser("Ok, I added a Hamburger with no cheese or onions. What else would you like?");        
+```
+
+log: Added Hamburger with id 2
+
+
+user: I want an elephant.
+
+code:
+```typescript
+orderingApi.respondToUser("I'm sorry, but that isn't on our menu.");        
+```