aimyapi 0.1.10 → 0.1.13

package/README.md

@@ -1,8 +1,8 @@
 # AI My API
 
-Build AI assistants that use your API's and respond to natural language queries by writing small programs that are executed in a [QuickJS](https://github.com/justjake/quickjs-emscripten) sandbox.
-AIMyAPI writes the glue between your various API functions unlocking new functionality without having to write any code. With the right building blocks, AIMyAPI can even invent new functionality you didn't originally plan for - 
-for example, being able to sort or filter your data in new ways, email or text yourself results, or combine the results of different operations and API's.
+Build AI assistants that use your API's and respond to natural language queries by writing small programs that are executed in a [QuickJS](https://github.com/justjake/quickjs-emscripten) sandbox. Similar to chatGPT Code Interpreter but running on your servers and calling your own API.
+
+AIMyAPI writes the glue between your various API functions unlocking new functionality without having to write any code. With the right building blocks, AIMyAPI can even invent new functionality you didn't originally plan for - for example, being able to sort or filter your data in new ways, email or text yourself results, or combine the results of different operations and API's.
 
 Uses the OpenAI API and requires an API key. 
 
@@ -45,7 +45,7 @@ declare global {
 
 ```
 
-Implement it:
+Implement it (`sales_api_impl.ts`):
 ```
 export class API implements APIInterface {
 
@@ -53,6 +53,18 @@ export class API implements APIInterface {
     ...
 ```
 
+Document it (`sales_api.md`):
+
+```
+Examples of how you should respond:
+
+user: How are you today?
+
+assistant:
+
+api.print("I'm great, thanks for asking!");
+```
+
 Instantiate your api and AIMyAPI. AIMyAPI will wrap your API so that it can be called from within the QuickJS sandbox.
 
 ```

package/dist/index.d.ts

@@ -4,8 +4,9 @@ export declare function createBasePrompt(apiFilePath: string, documentationPath:
 export interface GenerateCodeResult {
     code: string;
     loggableCode: string;
+    rawResponse?: string;
 }
-export declare const generateCode: (queryText: string, userChatHistory: ChatCompletionRequestMessage[], createTaskPrompt: string, apiPath: string, debug?: boolean) => Promise<GenerateCodeResult>;
+export declare const generateCode: (queryText: string, userChatHistory: ChatCompletionRequestMessage[], createTaskPrompt: string, apiPath: string, debug?: boolean, model?: string) => Promise<GenerateCodeResult>;
 export interface AIMyAPIOptions {
     apiObject: object;
     apiExports: object;
@@ -15,6 +16,7 @@ export interface AIMyAPIOptions {
     apiGlobalName?: string;
     apiDocsPath?: string;
     debug?: boolean;
+    model?: string;
 }
 export interface AIMyAPIInstance {
     options: AIMyAPIOptions;

package/dist/index.js

@@ -30,9 +30,9 @@ function createBasePrompt(apiFilePath, documentationPath) {
 }
 exports.createBasePrompt = createBasePrompt;
 // FIXME: add an options parameter and allow specifying the token limit
-const generateCode = async function (queryText, userChatHistory, createTaskPrompt, apiPath, debug = false) {
+const generateCode = async function (queryText, userChatHistory, createTaskPrompt, apiPath, debug = false, model = "gpt-4o") {
     if (!queryText)
-        return;
+        return { code: '', loggableCode: '' };
     let generatedCode = '';
     const prompt = createTaskPrompt.replace("{{QUERY_TEXT}}", queryText);
     const messages = [
@@ -43,13 +43,13 @@ const generateCode = async function (queryText, userChatHistory, createTaskPromp
         ...userChatHistory,
         {
             role: "user",
-            content: `${queryText}`,
+            content: `${queryText}.\nRespond only with code enclosed in \`\`\`.`,
             name: "user"
         }
     ];
     try {
         const results = await openai.createChatCompletion({
-            model: "gpt-3.5-turbo",
+            model,
             messages: messages,
             temperature: 0.1,
             max_tokens: 700,
@@ -64,16 +64,15 @@ const generateCode = async function (queryText, userChatHistory, createTaskPromp
         const codeEnd = response.lastIndexOf('```');
         // error, no code detected inside the response
         if (codeStart === -1 || codeEnd === -1 || codeStart === codeEnd) {
-            return { code: '', loggableCode: '' };
+            return { code: '', loggableCode: '', rawResponse: response };
         }
         generatedCode = response.substring(codeStart + 3, codeEnd).replace('typescript', '');
-        const codeHeader = `// Query: ${queryText}\nimport * as ApiDefs from '${apiPath}'\n(async() {\n\ttry {`;
+        const codeHeader = `import * as ApiDefs from '${apiPath}'\n(async() {\n\ttry {`;
         const codeFooter = `\n\t} catch(err) {\n\t\tconsole.error(err);\n\t}\n})();`;
         return { code: codeHeader + generatedCode + codeFooter, loggableCode: generatedCode };
     }
     catch (err) {
         console.error(err);
-        console.log("Prompt", messages);
         return { code: '', loggableCode: '' };
     }
 };
@@ -87,19 +86,20 @@ async function createWithAPI(options) {
         apiGlobals: {},
         apiWhitelist: Object.getOwnPropertyNames(Object.getPrototypeOf(options.apiObject)).filter((f) => f !== "constructor" && !f.startsWith("_")),
         debug: false,
+        model: "gpt-4o",
         ...options
     };
     if (!options.apiObject || !options.apiDefFilePath) {
         throw new Error("apiObject and apiFilePath are required");
     }
-    const { apiObject, apiWhitelist, apiGlobalName, apiExports, apiDefFilePath, apiDocsPath, debug } = options;
+    const { apiObject, apiWhitelist, apiGlobalName, apiExports, apiDefFilePath, apiDocsPath, debug, model } = options;
     const createTaskPrompt = createBasePrompt(apiDefFilePath, apiDocsPath);
     return {
         options,
         generateCode: async function (queryText, userChatHistory, currentContext = undefined) {
             if (!queryText)
                 return { code: '', loggableCode: '' };
-            return await (0, exports.generateCode)(queryText, userChatHistory, createTaskPrompt.replace("{{CONTEXT}}", currentContext ? "```" + JSON.stringify(currentContext, null, 2) + "```" : ""), apiDefFilePath, debug);
+            return await (0, exports.generateCode)(queryText, userChatHistory, createTaskPrompt.replace("{{CONTEXT}}", currentContext ? "```" + JSON.stringify(currentContext, null, 2) + "```" : ""), apiDefFilePath, debug, model);
         },
         runCode: async function (generatedCode) {
             if (!QuickJS) {

package/lib/index.ts

@@ -34,12 +34,13 @@ export function createBasePrompt(apiFilePath:string, documentationPath: string):
 export interface GenerateCodeResult {
     code: string;
     loggableCode: string;
+    rawResponse?: string;
 }
 
 // FIXME: add an options parameter and allow specifying the token limit
-export const generateCode = async function(queryText:string, userChatHistory:ChatCompletionRequestMessage[], createTaskPrompt:string, apiPath:string, debug:boolean = false): Promise<GenerateCodeResult> {
+export const generateCode = async function(queryText:string, userChatHistory:ChatCompletionRequestMessage[], createTaskPrompt:string, apiPath:string, debug:boolean = false, model="gpt-4o"): Promise<GenerateCodeResult> {
     if(!queryText)
-        return;
+        return { code: '', loggableCode: '' };
 
     let generatedCode = '';
     const prompt = createTaskPrompt.replace("{{QUERY_TEXT}}", queryText);
@@ -51,13 +52,13 @@ export const generateCode = async function(queryText:string, userChatHistory:Cha
         ...userChatHistory,
         {
             role: "user",
-            content: `${queryText}`,
+            content: `${queryText}.\nRespond only with code enclosed in \`\`\`.`,
             name: "user"
         }
     ];
     try {
         const results = await openai.createChatCompletion({
-            model: "gpt-3.5-turbo",
+            model,
             messages: messages,
             temperature: 0.1,
             max_tokens: 700,
@@ -78,17 +79,16 @@ export const generateCode = async function(queryText:string, userChatHistory:Cha
 
         // error, no code detected inside the response
         if(codeStart === -1 || codeEnd === -1 || codeStart === codeEnd) {
-            return { code: '', loggableCode: '' };
+            return { code: '', loggableCode: '', rawResponse: response };
         }
 
         generatedCode = response.substring(codeStart + 3, codeEnd).replace('typescript', '');
        
-        const codeHeader = `// Query: ${queryText}\nimport * as ApiDefs from '${apiPath}'\n(async() {\n\ttry {`;
+        const codeHeader = `import * as ApiDefs from '${apiPath}'\n(async() {\n\ttry {`;
         const codeFooter = `\n\t} catch(err) {\n\t\tconsole.error(err);\n\t}\n})();`;
         return { code: codeHeader + generatedCode + codeFooter, loggableCode: generatedCode };
     } catch(err) {
         console.error(err);
-        console.log("Prompt", messages);
         return { code: '', loggableCode: '' };
     } 
 };
@@ -104,6 +104,7 @@ export interface AIMyAPIOptions {
     apiGlobalName?: string;    
     apiDocsPath?: string;
     debug?: boolean;
+    model?: string;
 };
 
 export interface AIMyAPIInstance {
@@ -122,7 +123,8 @@ async function createWithAPI(options:AIMyAPIOptions): Promise<AIMyAPIInstance> {
         apiGlobalName: "api",
         apiGlobals: {},
         apiWhitelist: Object.getOwnPropertyNames(Object.getPrototypeOf(options.apiObject)).filter((f) => f !== "constructor" && !f.startsWith("_")),
-        debug: false,
+        debug: false, 
+        model: "gpt-4o",
         ...options
     } as AIMyAPIOptions;
 
@@ -130,7 +132,7 @@ async function createWithAPI(options:AIMyAPIOptions): Promise<AIMyAPIInstance> {
         throw new Error("apiObject and apiFilePath are required");
     }
 
-    const {apiObject, apiWhitelist, apiGlobalName, apiExports, apiDefFilePath, apiDocsPath, debug} = options;
+    const {apiObject, apiWhitelist, apiGlobalName, apiExports, apiDefFilePath, apiDocsPath, debug, model} = options;
 
     const createTaskPrompt = createBasePrompt( apiDefFilePath, apiDocsPath);
 
@@ -140,7 +142,7 @@ async function createWithAPI(options:AIMyAPIOptions): Promise<AIMyAPIInstance> {
             if(!queryText)
                 return { code: '', loggableCode: '' };
 
-            return await generateCode(queryText, userChatHistory, createTaskPrompt.replace("{{CONTEXT}}", currentContext ? "```" + JSON.stringify(currentContext, null, 2) + "```" : ""), apiDefFilePath, debug);
+            return await generateCode(queryText, userChatHistory, createTaskPrompt.replace("{{CONTEXT}}", currentContext ? "```" + JSON.stringify(currentContext, null, 2) + "```" : ""), apiDefFilePath, debug, model);
         },
         runCode: async function(generatedCode:string) {
             if(!QuickJS) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aimyapi",
-  "version": "0.1.10",
+  "version": "0.1.13",
   "description": "AI My API! Use LLMs to create small programs that safely* run and make calls against your API. Similar to ChatGPT's Code Interpreter.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",