@saltcorn/large-language-model 0.9.12 → 1.0.1

package/constants.js

@@ -7,9 +7,7 @@ const OPENAI_MODELS = [
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
-  "gpt-5.1",
-  "gpt-5.1-mini",
-  "gpt-5.1-nano",
+  "gpt-5.1",  
   "gpt-5.2",
   "gpt-5.2-pro",
   "o3",

package/generate.js

@@ -38,7 +38,7 @@ const getEmbedding = async (config, opts) => {
           apiKey: config.api_key,
           embed_model: opts?.embed_model || config.embed_model || config.model,
         },
-        opts
+        opts,
       );
     case "OpenAI":
       return await getEmbeddingOpenAICompatible(
@@ -47,7 +47,7 @@ const getEmbedding = async (config, opts) => {
           bearer: opts?.api_key || config.api_key,
           embed_model: opts?.model || config.embed_model,
         },
-        opts
+        opts,
       );
     case "OpenAI-compatible API":
       return await getEmbeddingOpenAICompatible(
@@ -61,7 +61,7 @@ const getEmbedding = async (config, opts) => {
             config.embed_model ||
             config.model,
         },
-        opts
+        opts,
       );
     case "Local Ollama":
       if (config.embed_endpoint) {
@@ -74,14 +74,14 @@ const getEmbedding = async (config, opts) => {
               config.embed_model ||
               config.model,
           },
-          opts
+          opts,
         );
       } else {
         if (!ollamaMod) throw new Error("Not implemented for this backend");
 
         const { Ollama } = ollamaMod;
         const ollama = new Ollama(
-          config.ollama_host ? { host: config.ollama_host } : undefined
+          config.ollama_host ? { host: config.ollama_host } : undefined,
         );
         const olres = await ollama.embeddings({
           model: opts?.model || config.embed_model || config.model,
@@ -112,7 +112,7 @@ const getImageGeneration = async (config, opts) => {
           model: opts?.model || config.model,
           responses_api: config.responses_api,
         },
-        opts
+        opts,
       );
     default:
       throw new Error("Image generation not implemented for this backend");
@@ -121,7 +121,7 @@ const getImageGeneration = async (config, opts) => {
 
 const getAudioTranscription = async (
   { backend, apiKey, api_key, provider, ai_sdk_provider },
-  opts
+  opts,
 ) => {
   switch (opts.backend || backend) {
     case "ElevenLabs":
@@ -134,7 +134,7 @@ const getAudioTranscription = async (
         languageCode: opts.languageCode || "eng", // Language of the audio file. If set to null, the model will detect the language automatically.
         numSpeakers: opts.numSpeakers || null, // Language of the audio file. If set to null, the model will detect the language automatically.
         diarize: !!opts.diarize, // Whether to annotate who is speaking
-        diarizationThreshold: opts.diarizationThreshold || null
+        diarizationThreshold: opts.diarizationThreshold || null,
       });
       return transcription;
     case "OpenAI":
@@ -144,10 +144,10 @@ const getAudioTranscription = async (
       const fp = opts.file.location
         ? opts.file.location
         : typeof opts.file === "string"
-        ? await (
-            await File.findOne(opts.file)
-          ).location
-        : null;
+          ? await (
+              await File.findOne(opts.file)
+            ).location
+          : null;
       const model = opts?.model || "whisper-1";
       const diarize = model === "gpt-4o-transcribe-diarize";
       const transcript1 = await client.audio.transcriptions.create({
@@ -171,8 +171,8 @@ const getAudioTranscription = async (
         (Buffer.isBuffer(opts.file)
           ? opts.file
           : typeof opts.file === "string"
-          ? await (await File.findOne(opts.file)).get_contents()
-          : await opts.file.get_contents());
+            ? await (await File.findOne(opts.file)).get_contents()
+            : await opts.file.get_contents());
       const extra = {};
       if (opts.prompt)
         extra.providerOptions = {
@@ -193,6 +193,156 @@ const getAudioTranscription = async (
   }
 };
 
+const last = (xs) => xs[xs.length - 1];
+
+const toolResponse = async (
+  { backend, apiKey, api_key, provider, ai_sdk_provider, responses_api },
+  opts,
+) => {
+  let chat = opts.chat;
+  let result = opts.prompt;
+  //console.log("chat", JSON.stringify(chat, null, 2));
+  switch (opts.backend || backend) {
+    case "OpenAI":
+      {
+        let tool_call_chat, tool_call;
+        if (!((opts.tool_call_id && opts.tool_name) || opts.tool_call)) {
+          if (opts.tool_call) tool_call_chat = opts.tool_call;
+          else
+            tool_call_chat = last(
+              chat.filter((c) => c.tool_calls || c.type === "function_call"),
+            );
+
+          tool_call = tool_call_chat.tool_calls
+            ? tool_call_chat.tool_calls[0] //original api
+            : tool_call_chat; //responses api
+        }
+        const content =
+          result && typeof result !== "string"
+            ? JSON.stringify(result)
+            : result || "Action run";
+        const new_chat_item = responses_api
+          ? {
+              type: "function_call_output",
+              call_id:
+                opts.tool_call?.tool_call_id ||
+                opts.tool_call_id ||
+                tool_call.call_id,
+              output: content,
+            }
+          : {
+              role: "tool",
+              tool_call_id:
+                opts.tool_call?.tool_call_id ||
+                opts.tool_call_id ||
+                tool_call.toolCallId ||
+                tool_call.id,
+              content,
+            };
+
+        chat.push(new_chat_item);
+      }
+      break;
+    case "AI SDK":
+      {
+        let tool_call, tc;
+        if (!((opts.tool_call_id && opts.tool_name) || opts.tool_call)) {
+          if (opts.tool_call) tool_call = opts.tool_call;
+          else
+            tool_call = last(
+              chat.filter(
+                (c) =>
+                  c.role === "assistant" &&
+                  Array.isArray(c.content) &&
+                  c.content.some((cc) => cc.type === "tool-call"),
+              ),
+            );
+
+          tc = tool_call.content[0];
+        }
+
+        chat.push({
+          role: "tool",
+          content: [
+            {
+              type: "tool-result",
+              toolCallId:
+                opts.tool_call?.tool_call_id ||
+                opts.tool_call_id ||
+                tc.toolCallId,
+              toolName:
+                opts.tool_call?.tool_name || opts.tool_name || tc.toolName,
+              output:
+                !result || typeof result === "string"
+                  ? {
+                      type: "text",
+                      value: result || "Action run",
+                    }
+                  : {
+                      type: "json",
+                      value: JSON.parse(JSON.stringify(result)),
+                    },
+            },
+          ],
+        });
+      }
+      break;
+    default:
+  }
+};
+
+const addImageMesssage = async (
+  { backend, apiKey, api_key, provider, ai_sdk_provider, responses_api },
+  opts,
+) => {
+  let chat = opts.chat;
+  let result = opts.prompt;
+  //console.log("chat", JSON.stringify(chat, null, 2));
+  let imageurl = opts.prompt;
+  switch (opts.backend || backend) {
+    case "OpenAI":
+      {
+        const new_chat_item = responses_api
+          ? {
+              role: "user",
+              content: [
+                {
+                  type: "input_image",
+                  image_url: imageurl,
+                },
+              ],
+            }
+          : {
+              role: "user",
+              content: [
+                {
+                  type: "image_url",
+                  image_url: {
+                    url: imageurl,
+                  },
+                },
+              ],
+            };
+
+        chat.push(new_chat_item);
+      }
+      break;
+    case "AI SDK":
+      chat.push({
+        role: "user",
+        content: [
+          {
+            type: "image",
+            image: imageurl,
+          },
+        ],
+      });
+
+      break;
+    default:
+  }
+};
+
 const getCompletion = async (config, opts) => {
   switch (config.backend) {
     case "AI SDK":
@@ -202,7 +352,7 @@ const getCompletion = async (config, opts) => {
           apiKey: config.api_key,
           model: opts?.model || config.model,
         },
-        opts
+        opts,
       );
     case "OpenAI":
       return await getCompletionOpenAICompatible(
@@ -214,7 +364,7 @@ const getCompletion = async (config, opts) => {
           model: opts?.model || config.model,
           responses_api: config.responses_api,
         },
-        opts
+        opts,
       );
     case "OpenAI-compatible API":
       return await getCompletionOpenAICompatible(
@@ -228,7 +378,7 @@ const getCompletion = async (config, opts) => {
           apiKey: opts?.api_key || config.api_key,
           model: opts?.model || config.model,
         },
-        opts
+        opts,
       );
     case "Local Ollama":
       return await getCompletionOpenAICompatible(
@@ -238,14 +388,14 @@ const getCompletion = async (config, opts) => {
             : "http://localhost:11434/v1/chat/completions",
           model: opts?.model || config.model,
         },
-        opts
+        opts,
       );
     case "Local llama.cpp":
       //TODO only check if unsafe plugins not allowed
       const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
       if (!isRoot)
         throw new Error(
-          "llama.cpp inference is not permitted on subdomain tenants"
+          "llama.cpp inference is not permitted on subdomain tenants",
         );
       let hyperStr = "";
       if (opts.temperature) hyperStr += ` --temp ${opts.temperature}`;
@@ -255,7 +405,7 @@ const getCompletion = async (config, opts) => {
 
       const { stdout, stderr } = await exec(
         `./main -m ${config.model_path} -p "${opts.prompt}" ${nstr}${hyperStr}`,
-        { cwd: config.llama_dir }
+        { cwd: config.llama_dir },
       );
       return stdout;
     case "Google Vertex AI":
@@ -286,12 +436,13 @@ const getCompletionAISDK = async (
     systemPrompt,
     prompt,
     debugResult,
+    appendToChat,
     debugCollector,
     chat = [],
     api_key,
     endpoint,
     ...rest
-  }
+  },
 ) => {
   const use_model_name = rest.model || model;
   let model_obj = getAiSdkModel({
@@ -313,7 +464,7 @@ const getCompletionAISDK = async (
       ...(Array.isArray(chat.content) ? { content: chat.content.map(f) } : {}),
     };
   };
-  const newChat = chat.map(modifyChat);
+  const newChat = appendToChat ? chat : chat.map(modifyChat);
 
   const body = {
     ...rest,
@@ -327,6 +478,9 @@ const getCompletionAISDK = async (
       ...(prompt ? [{ role: "user", content: prompt }] : []),
     ],
   };
+  if (appendToChat && chat && prompt) {
+    chat.push({ role: "user", content: prompt });
+  }
   if (rest.temperature || temperature) {
     const str_or_num = rest.temperature || temperature;
     body.temperature = +str_or_num;
@@ -342,6 +496,9 @@ const getCompletionAISDK = async (
         "gpt-5",
         "gpt-5-nano",
         "gpt-5-mini",
+        "gpt-5.1",
+        "gpt-5.1-codex",
+        "gpt-5.2",
       ].includes(use_model_name)
     )
       body.temperature = 0.7;
@@ -350,9 +507,9 @@ const getCompletionAISDK = async (
     const prevTools = [...body.tools];
     body.tools = {};
     prevTools.forEach((t) => {
-      body.tools[t.function.name] = tool({
-        description: t.function.description,
-        inputSchema: jsonSchema(t.function.parameters),
+      body.tools[t.name || t.function.name] = tool({
+        description: t.description || t.function.description,
+        inputSchema: jsonSchema(t.parameters || t.function.parameters),
       });
     });
   }
@@ -367,11 +524,21 @@ const getCompletionAISDK = async (
   let results;
   if (rest.streamCallback) {
     delete body.streamCallback;
-    results = await streamText(body);
-    for await (const textPart of results.textStream) {
+    const results1 = await streamText(body);
+    for await (const textPart of results1.textStream) {
       rest.streamCallback(textPart);
     }
+    results = {
+      response: await results1.response,
+      text: await results1.text,
+      steps: await results1.steps,
+    };
   } else results = await generateText(body);
+
+  if (appendToChat && chat) {
+    chat.push(...results.response.messages);
+  }
+
   if (debugResult)
     console.log("AI SDK response", JSON.stringify(results, null, 2));
   else getState().log(6, `AI SDK response ${JSON.stringify(results)}`);
@@ -387,6 +554,14 @@ const getCompletionAISDK = async (
       content: await results.text,
       messages: (await results.response).messages,
       ai_sdk: true,
+      hasToolCalls: allToolCalls.length,
+      getToolCalls() {
+        return allToolCalls.map((tc) => ({
+          tool_name: tc.toolName,
+          input: tc.input,
+          tool_call_id: tc.toolCallId,
+        }));
+      },
     };
   } else return results.text;
 };
@@ -399,10 +574,11 @@ const getCompletionOpenAICompatible = async (
     debugResult,
     debugCollector,
     chat = [],
+    appendToChat,
     api_key,
     endpoint,
     ...rest
-  }
+  },
 ) => {
   const headers = {
     "Content-Type": "application/json",
@@ -440,63 +616,67 @@ const getCompletionOpenAICompatible = async (
     delete body.streamCallback;
   }
   if (responses_api) {
+    delete body.tool_choice;
     for (const tool of body.tools || []) {
-      if (tool.type !== "function") continue;
+      if (tool.type !== "function" || !tool.function) continue;
       tool.name = tool.function.name;
       tool.description = tool.function.description;
       tool.parameters = tool.function.parameters;
       if (tool.function.required) tool.required = tool.function.required;
       delete tool.function;
     }
-    const newChat = [];
-    (chat || []).forEach((c) => {
-      if (c.tool_calls) {
-        c.tool_calls.forEach((tc) => {
-          newChat.push({
-            id: tc.id,
-            type: "function_call",
-            call_id: tc.call_id,
-            name: tc.name,
-            arguments: tc.arguments,
+    let newChat;
+    if (!appendToChat) {
+      newChat = [];
+      (chat || []).forEach((c) => {
+        if (c.tool_calls) {
+          c.tool_calls.forEach((tc) => {
+            newChat.push({
+              id: tc.id,
+              type: "function_call",
+              call_id: tc.call_id,
+              name: tc.name,
+              arguments: tc.arguments,
+            });
           });
-        });
-      } else if (c.content?.image_calls) {
-        c.content.image_calls.forEach((ic) => {
+        } else if (c.content?.image_calls) {
+          c.content.image_calls.forEach((ic) => {
+            newChat.push({
+              ...ic,
+              result: undefined,
+              filename: undefined,
+            });
+          });
+        } else if (c.content?.mcp_calls) {
+          c.content.mcp_calls.forEach((ic) => {
+            newChat.push({
+              ...ic,
+            });
+          });
+        } else if (c.role === "tool") {
           newChat.push({
-            ...ic,
-            result: undefined,
-            filename: undefined,
+            type: "function_call_output",
+            call_id: c.call_id,
+            output: c.content,
           });
-        });
-      } else if (c.content?.mcp_calls) {
-        c.content.mcp_calls.forEach((ic) => {
+        } else {
+          const fcontent = (c) => {
+            if (c.type === "image_url")
+              return {
+                type: "input_image",
+                image_url: c.image_url.url,
+              };
+            else return c;
+          };
           newChat.push({
-            ...ic,
+            ...c,
+            content: Array.isArray(c.content)
+              ? c.content.map(fcontent)
+              : c.content,
           });
-        });
-      } else if (c.role === "tool") {
-        newChat.push({
-          type: "function_call_output",
-          call_id: c.call_id,
-          output: c.content,
-        });
-      } else {
-        const fcontent = (c) => {
-          if (c.type === "image_url")
-            return {
-              type: "input_image",
-              image_url: c.image_url.url,
-            };
-          else return c;
-        };
-        newChat.push({
-          ...c,
-          content: Array.isArray(c.content)
-            ? c.content.map(fcontent)
-            : c.content,
-        });
-      }
-    });
+        }
+      });
+    } else newChat = chat;
     body.input = [
       {
         role: "system",
@@ -517,6 +697,9 @@ const getCompletionOpenAICompatible = async (
       ...(prompt ? [{ role: "user", content: prompt }] : []),
     ];
   }
+  if (appendToChat && chat && prompt) {
+    chat.push({ role: "user", content: prompt });
+  }
   if (debugResult)
     console.log(
       "OpenAI request",
@@ -524,14 +707,14 @@ const getCompletionOpenAICompatible = async (
       "to",
       chatCompleteEndpoint,
       "headers",
-      JSON.stringify(headers)
+      JSON.stringify(headers),
     );
   else
     getState().log(
       6,
       `OpenAI request ${JSON.stringify(
-        body
-      )} to ${chatCompleteEndpoint} headers ${JSON.stringify(headers)}`
+        body,
+      )} to ${chatCompleteEndpoint} headers ${JSON.stringify(headers)}`,
     );
   if (debugCollector) debugCollector.request = body;
   const reqTimeStart = Date.now();
@@ -623,7 +806,7 @@ const getCompletionOpenAICompatible = async (
       : streamParts.join("");
   }
   const results = await rawResponse.json();
-  //console.log("results", results);
+
   if (debugResult)
     console.log("OpenAI response", JSON.stringify(results, null, 2));
   else getState().log(6, `OpenAI response ${JSON.stringify(results)}`);
@@ -633,36 +816,49 @@ const getCompletionOpenAICompatible = async (
   }
 
   if (results.error) throw new Error(`OpenAI error: ${results.error.message}`);
+  if (appendToChat && chat) {
+    if (responses_api) chat.push(...results.output);
+    else chat.push(results.choices[0].message);
+  }
   if (responses_api) {
     const textOutput = results.output
       .filter((o) => o.type === "message")
       .map((o) => o.content.map((c) => c.text).join(""))
       .join("");
+    const tool_calls = emptyToUndefined(
+      results.output
+        .filter((o) => o.type === "function_call")
+        .map((o) => ({
+          function: { name: o.name, arguments: o.arguments },
+          ...o,
+        })),
+    );
     return results.output.some(
       (o) =>
         o.type === "function_call" ||
         o.type === "image_generation_call" ||
         o.type === "mcp_list_tools" ||
-        o.type === "mcp_call"
+        o.type === "mcp_call",
     )
       ? {
-          tool_calls: emptyToUndefined(
-            results.output
-              .filter((o) => o.type === "function_call")
-              .map((o) => ({
-                function: { name: o.name, arguments: o.arguments },
-                ...o,
-              }))
-          ),
+          tool_calls,
           image_calls: emptyToUndefined(
-            results.output.filter((o) => o.type === "image_generation_call")
+            results.output.filter((o) => o.type === "image_generation_call"),
           ),
           mcp_calls: emptyToUndefined(
             results.output.filter(
-              (o) => o.type === "mcp_call" || o.type === "mcp_list_tools"
-            )
+              (o) => o.type === "mcp_call" || o.type === "mcp_list_tools",
+            ),
           ),
           content: textOutput || null,
+          hasToolCalls: tool_calls?.length,
+          getToolCalls() {
+            return tool_calls.map((tc) => ({
+              tool_name: tc.function.name,
+              input: JSON.parse(tc.function.arguments),
+              tool_call_id: tc.call_id,
+            }));
+          },
         }
       : textOutput || null;
   } else
@@ -670,6 +866,14 @@ const getCompletionOpenAICompatible = async (
       ? {
           tool_calls: results?.choices?.[0]?.message?.tool_calls,
           content: results?.choices?.[0]?.message?.content || null,
+          hasToolCalls: results?.choices?.[0]?.message?.tool_calls.length,
+          getToolCalls() {
+            return results?.choices?.[0]?.message?.tool_calls.map((tc) => ({
+              tool_name: tc.function.name,
+              input: JSON.parse(tc.function.arguments),
+              tool_call_id: tc.id,
+            }));
+          },
         }
       : results?.choices?.[0]?.message?.content || null;
 };
@@ -688,7 +892,7 @@ const getImageGenOpenAICompatible = async (
     n,
     output_format,
     response_format,
-  }
+  },
 ) => {
   const { imageEndpoint, bearer, apiKey, image_model } = config;
   const headers = {
@@ -725,7 +929,7 @@ const getImageGenOpenAICompatible = async (
 
 const getEmbeddingOpenAICompatible = async (
   config,
-  { prompt, model, debugResult }
+  { prompt, model, debugResult },
 ) => {
   const { embeddingsEndpoint, bearer, apiKey, embed_model } = config;
   const headers = {
@@ -762,7 +966,7 @@ const getEmbeddingAISDK = async (config, { prompt, model, debugResult }) => {
     case "OpenAI":
       const openai = createOpenAI({ apiKey: apiKey });
       model_obj = openai.textEmbeddingModel(
-        model_name || "text-embedding-3-small"
+        model_name || "text-embedding-3-small",
       );
       //providerOptions.openai = {};
       break;
@@ -815,7 +1019,7 @@ const initOAuth2Client = async (config) => {
   const oauth2Client = new google.auth.OAuth2(
     client_id,
     client_secret,
-    redirect_uri
+    redirect_uri,
   );
   oauth2Client.setCredentials(pluginCfg.tokens);
   return oauth2Client;
@@ -883,7 +1087,7 @@ const getCompletionGoogleVertex = async (config, opts, oauth2Client) => {
     chatParams.tools = [
       {
         functionDeclarations: opts.tools.map((t) =>
-          prepFuncArgsForChat(t.function)
+          prepFuncArgsForChat(t.function),
         ),
       },
     ];
@@ -925,7 +1129,7 @@ const getEmbeddingGoogleVertex = async (config, opts, oauth2Client) => {
       helpers.toValue({
         content: p,
         task_type: config.task_type || "RETRIEVAL_QUERY",
-      })
+      }),
     );
   } else {
     instances = [
@@ -957,4 +1161,6 @@ module.exports = {
   getEmbedding,
   getImageGeneration,
   getAudioTranscription,
+  toolResponse,
+  addImageMesssage,
 };

package/index.js

@@ -11,6 +11,8 @@ const {
   getEmbedding,
   getImageGeneration,
   getAudioTranscription,
+  toolResponse,
+  addImageMesssage,
 } = require("./generate");
 const { OPENAI_MODELS } = require("./constants.js");
 const { eval_expression } = require("@saltcorn/data/models/expression");
@@ -381,7 +383,10 @@ const functions = (config) => {
       },
       isAsync: true,
       description: "Generate text with GPT",
-      arguments: [{ name: "prompt", type: "String" }],
+      arguments: [
+        { name: "prompt", type: "String", required: true },
+        { name: "options", type: "JSON", tstype: "any" },
+      ],
     },
     llm_image_generate: {
       run: async (prompt, opts) => {
@@ -390,7 +395,10 @@ const functions = (config) => {
       },
       isAsync: true,
       description: "Generate image",
-      arguments: [{ name: "prompt", type: "String" }],
+      arguments: [
+        { name: "prompt", type: "String", required: true },
+        { name: "options", type: "JSON", tstype: "any" },
+      ],
     },
     llm_embedding: {
       run: async (prompt, opts) => {
@@ -399,7 +407,10 @@ const functions = (config) => {
       },
       isAsync: true,
       description: "Get vector embedding",
-      arguments: [{ name: "prompt", type: "String" }],
+      arguments: [
+        { name: "prompt", type: "String", required: true },
+        { name: "options", type: "JSON", tstype: "any" },
+      ],
     },
     llm_transcribe: {
       run: async (opts) => {
@@ -408,7 +419,33 @@ const functions = (config) => {
       },
       isAsync: true,
       description: "Get vector embedding",
-      arguments: [{ name: "prompt", type: "String" }],
+      arguments: [
+        { name: "options", type: "JSON", tstype: "any", required: true },
+      ],
+    },
+    llm_add_message: {
+      run: async (what, prompt, opts) => {
+        switch (what) {
+          case "tool_response":
+            return await toolResponse(config, { prompt, ...opts });
+          case "image":
+            return await addImageMesssage(config, { prompt, ...opts });
+          default:
+            break;
+        }
+      },
+      isAsync: true,
+      description: "Insert a tool response or an image in a chat",
+      arguments: [
+        {
+          name: "what",
+          type: "String",
+          tstype: '"tool_response"|"image"',
+          required: true,
+        },
+        { name: "prompt", type: "String", required: true },
+        { name: "options", type: "JSON", tstype: "any" },
+      ],
     },
   };
 };
@@ -432,7 +469,7 @@ const routes = (config) => {
         const oauth2Client = new google.auth.OAuth2(
           client_id,
           client_secret,
-          redirect_uri
+          redirect_uri,
         );
         const authUrl = oauth2Client.generateAuthUrl({
           access_type: "offline",
@@ -459,7 +496,7 @@ const routes = (config) => {
         const oauth2Client = new google.auth.OAuth2(
           client_id,
           client_secret,
-          redirect_uri
+          redirect_uri,
         );
         let plugin = await Plugin.findOne({ name: "large-language-model" });
         if (!plugin) {
@@ -475,8 +512,8 @@ const routes = (config) => {
             req.flash(
               "warning",
               req.__(
-                "No refresh token received. Please revoke the plugin's access and try again."
-              )
+                "No refresh token received. Please revoke the plugin's access and try again.",
+              ),
             );
           } else {
             const newConfig = { ...(plugin.configuration || {}), tokens };
@@ -488,7 +525,7 @@ const routes = (config) => {
             });
             req.flash(
               "success",
-              req.__("Authentication successful! You can now use Vertex AI.")
+              req.__("Authentication successful! You can now use Vertex AI."),
             );
           }
         } catch (error) {
@@ -615,13 +652,13 @@ module.exports = {
             prompt_formula,
             row,
             user,
-            "llm_generate prompt formula"
+            "llm_generate prompt formula",
           );
         else prompt = row[prompt_field];
         const opts = {};
         if (override_config) {
           const altcfg = config.altconfigs.find(
-            (c) => c.name === override_config
+            (c) => c.name === override_config,
           );
           opts.endpoint = altcfg.endpoint;
           opts.model = altcfg.model;
@@ -679,7 +716,8 @@ module.exports = {
             {
               name: "answer_field",
               label: "Response variable",
-              sublabel: "Set the generated response object to this context variable. The subfield <code>text</code> holds the string transcription",
+              sublabel:
+                "Set the generated response object to this context variable. The subfield <code>text</code> holds the string transcription",
               type: "String",
               required: true,
             },
@@ -766,7 +804,7 @@ module.exports = {
         else
           await table.updateRow(
             { [answer_field]: ans.text },
-            row[table.pk_name]
+            row[table.pk_name],
           );
       },
     },
@@ -879,7 +917,7 @@ module.exports = {
             prompt_formula,
             row,
             user,
-            "llm_generate prompt formula"
+            "llm_generate prompt formula",
           );
         else prompt = row[prompt_field];
 
@@ -906,7 +944,7 @@ module.exports = {
             "image/png",
             imgContents,
             user?.id,
-            min_role || 1
+            min_role || 1,
           );
           upd[answer_field] = file.path_to_serve;
         }
@@ -998,7 +1036,7 @@ module.exports = {
               sublabel:
                 "Use this context variable to store the chat history for subsequent prompts",
               type: "String",
-            }
+            },
           );
         } else if (table) {
           const jsonFields = table.fields
@@ -1022,7 +1060,7 @@ module.exports = {
               type: "String",
               required: true,
               attributes: { options: jsonFields },
-            }
+            },
           );
         }
 
@@ -1051,7 +1089,7 @@ module.exports = {
             input_type: "section_header",
             label: "JSON fields to generate",
           },
-          fieldsField
+          fieldsField,
         );
         return cfgFields;
       },
@@ -1077,7 +1115,7 @@ module.exports = {
         if (model) opts.model = model;
         if (override_config) {
           const altcfg = config.altconfigs.find(
-            (c) => c.name === override_config
+            (c) => c.name === override_config,
           );
           opts.endpoint = altcfg.endpoint;
           opts.model = altcfg.model;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/large-language-model",
-  "version": "0.9.12",
+  "version": "1.0.1",
   "description": "Large language models and functionality for Saltcorn",
   "main": "index.js",
   "dependencies": {
@@ -16,17 +16,24 @@
     "openai": "6.16.0",
     "@elevenlabs/elevenlabs-js": "2.31.0"
   },
+  "devDependencies": {
+    "jest": "^29.7.0"
+  },
+  "scripts": {
+    "test": "jest tests --runInBand"
+  },
   "author": "Tom Nielsen",
   "license": "MIT",
   "repository": "github:saltcorn/large-language-model",
   "eslintConfig": {
     "extends": "eslint:recommended",
     "parserOptions": {
-      "ecmaVersion": 2020
+      "ecmaVersion": 2024
     },
     "env": {
       "node": true,
-      "es6": true
+      "es6": true,
+      "jest/globals": true
     },
     "rules": {
       "no-unused-vars": "off",

package/tests/configs.js

@@ -0,0 +1,34 @@
+module.exports = [
+  {
+    name: "OpenAI completions",
+    model: "gpt-5.1",
+    api_key: process.env.OPENAI_API_KEY,
+    backend: "OpenAI",
+    embed_model: "text-embedding-3-small",
+    image_model: "gpt-image-1",
+    temperature: 0.7,
+    responses_api: false,
+    ai_sdk_provider: "OpenAI",
+  },
+  {
+    name: "OpenAI responses",
+    model: "gpt-5.1",
+    api_key: process.env.OPENAI_API_KEY,
+    backend: "OpenAI",
+    embed_model: "text-embedding-3-small",
+    image_model: "gpt-image-1",
+    temperature: 0.7,
+    responses_api: true,
+    ai_sdk_provider: "OpenAI",
+  },
+  {
+    name: "AI SDK OpenAI",
+    model: "gpt-5.1",
+    api_key: process.env.OPENAI_API_KEY,
+    backend: "AI SDK",
+    embed_model: "text-embedding-3-small",
+    image_model: "gpt-image-1",
+    temperature: 0.7,
+    ai_sdk_provider: "OpenAI",
+  },
+];

package/tests/llm.test.js

@@ -0,0 +1,209 @@
+const { getState } = require("@saltcorn/data/db/state");
+const View = require("@saltcorn/data/models/view");
+const Table = require("@saltcorn/data/models/table");
+const Plugin = require("@saltcorn/data/models/plugin");
+
+const { mockReqRes } = require("@saltcorn/data/tests/mocks");
+const { afterAll, beforeAll, describe, it, expect } = require("@jest/globals");
+
+afterAll(require("@saltcorn/data/db").close);
+beforeAll(async () => {
+  await require("@saltcorn/data/db/reset_schema")();
+  await require("@saltcorn/data/db/fixtures")();
+
+  getState().registerPlugin("base", require("@saltcorn/data/base-plugin"));
+});
+
+// run with:
+//  saltcorn dev:plugin-test -d ~/large-language-model/
+
+jest.setTimeout(30000);
+
+for (const nameconfig of require("./configs")) {
+  const { name, ...config } = nameconfig;
+  describe("llm_generate function with " + name, () => {
+    beforeAll(async () => {
+      getState().registerPlugin(
+        "@saltcorn/large-language-model",
+        require(".."),
+        config,
+      );
+    });
+
+    it("generates text", async () => {
+      const answer = await getState().functions.llm_generate.run(
+        "What is the Capital of France?",
+      );
+      //console.log({ answer });
+
+      expect(typeof answer).toBe("string");
+      expect(answer).toContain("Paris");
+    });
+    it("generates text with system prompt", async () => {
+      const answer = await getState().functions.llm_generate.run(
+        "What is the name of the last week day in a normal work week?",
+        {
+          systemPrompt: "Answer in German, even when questions are in English",
+        },
+      );
+      //console.log({ answer });
+
+      expect(typeof answer).toBe("string");
+      expect(answer).toContain("Freitag");
+    });
+    it("generates text with chat history", async () => {
+      const chat = [
+        {
+          role: "user",
+          content: "What is the capital of France?",
+        },
+        {
+          role: "assistant",
+          content: "Paris.",
+        },
+      ];
+      const answer = await getState().functions.llm_generate.run(
+        "What is the name of the river running through this city?",
+        {
+          chat,
+        },
+      );
+      //console.log({ answer });
+
+      expect(typeof answer).toBe("string");
+      expect(answer).toContain("Seine");
+      expect(chat.length).toBe(2);
+    });
+    it("generates text with chat history and no prompt", async () => {
+      const answer = await getState().functions.llm_generate.run("", {
+        chat: [
+          {
+            role: "user",
+            content: "What is the capital of France?",
+          },
+          {
+            role: "assistant",
+            content: "Paris.",
+          },
+          {
+            role: "user",
+            content: "What is the name of the river running through this city?",
+          },
+        ],
+      });
+      //console.log({ answer });
+
+      expect(typeof answer).toBe("string");
+      expect(answer).toContain("Seine");
+    });
+    it("uses tools", async () => {
+      const answer = await getState().functions.llm_generate.run(
+        "Generate a list of EU capitals in a structured format using the provided tool",
+        cities_tool,
+      );
+      expect(typeof answer).toBe("object");
+      const cities = answer.ai_sdk
+        ? answer.tool_calls[0].input?.cities
+        : JSON.parse(answer.tool_calls[0].function.arguments).cities;
+      expect(cities.length).toBe(27);
+    });
+    it("appends to chat history", async () => {
+      const chat = [];
+      const answer1 = await getState().functions.llm_generate.run(
+        "What is the Capital of France?",
+        {
+          chat,
+          appendToChat: true,
+        },
+      );
+      const answer2 = await getState().functions.llm_generate.run(
+        "What is the name of the river running through this city?",
+        {
+          chat,
+          appendToChat: true,
+        },
+      );
+      //console.log({ answer });
+
+      expect(typeof answer2).toBe("string");
+      expect(answer2).toContain("Seine");
+      expect(chat.length).toBe(4);
+    });
+    it("tool use sequence", async () => {
+      const chat = [];
+      const answer = await getState().functions.llm_generate.run(
+        "Generate a list of EU capitals in a structured format using the provided tool",
+        {
+          chat,
+          appendToChat: true,
+          ...cities_tool,
+          //streamCallback() {}
+        },
+      );
+      expect(typeof answer).toBe("object");
+
+      const tc = answer.getToolCalls()[0];
+
+      const cities = tc.input.cities;
+      expect(cities.length).toBe(27);
+
+      await getState().functions.llm_add_message.run(
+        "tool_response",
+        "List received",
+        {
+          chat,
+          tool_call: tc,
+        },
+      );
+
+      const answer1 = await getState().functions.llm_generate.run(
+        "Make the same list in a structured format using the provided tool but for the original 12 member countries of the EU",
+        { chat, appendToChat: true, ...cities_tool },
+      );
+
+      const cities1 = answer1.getToolCalls()[0].input?.cities;
+
+      expect(cities1.length).toBe(12);
+    });
+  });
+}
+
+const cities_tool = {
+  tools: [
+    {
+      type: "function",
+      function: {
+        name: "cities",
+        description: "Provide a list of cities by country and city name",
+        parameters: {
+          type: "object",
+          properties: {
+            cities: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  country_name: {
+                    type: "string",
+                    description: "Country name",
+                  },
+                  city_name: {
+                    type: "string",
+                    description: "City name",
+                  },
+                },
+                required: ["country_name", "city_name"],
+              },
+            },
+          },
+        },
+      },
+    },
+  ],
+  tool_choice: {
+    type: "function",
+    function: {
+      name: "cities",
+    },
+  },
+};