🎉 feat: Code Interpreter API and Agents Release (#4860)

* feat: Code Interpreter API & File Search Agent Uploads

chore: add back code files

wip: first pass, abstract key dialog

refactor: influence checkbox on key changes

refactor: update localization keys for 'execute code' to 'run code'

wip: run code button

refactor: add throwError parameter to loadAuthValues and getUserPluginAuthValue functions

feat: first pass, API tool calling

fix: handle missing toolId in callTool function and return 404 for non-existent tools

feat: show code outputs

fix: improve error handling in callTool function and log errors

fix: handle potential null value for filepath in attachment destructuring

fix: normalize language before rendering and prevent null return

fix: add loading indicator in RunCode component while executing code

feat: add support for conditional code execution in Markdown components

feat: attachments

refactor: remove bash

fix: pass abort signal to graph/run

refactor: debounce and rate limit tool call

refactor: increase debounce delay for execute function

feat: set code output attachments

feat: image attachments

refactor: apply message context

refactor: pass `partIndex`

feat: toolCall schema/model/methods

feat: block indexing

feat: get tool calls

chore: imports

chore: typing

chore: condense type imports

feat: get tool calls

fix: block indexing

chore: typing

refactor: update tool calls mapping to support multiple results

fix: add unique key to nav link for rendering

wip: first pass, tool call results

refactor: update query cache from successful tool call mutation

style: improve result switcher styling

chore: note on using \`.toObject()\`

feat: add agent_id field to conversation schema

chore: typing

refactor: rename agentMap to agentsMap for consistency

feat: Agent Name as chat input placeholder

chore: bump agents

📦 chore: update @langchain dependencies to latest versions to match agents package

📦 chore: update @librechat/agents dependency to version 1.8.0

fix: Aborting agent stream removes sender; fix(bedrock): completion removes preset name label

refactor: remove direct file parameter to use req.file, add `processAgentFileUpload` for image uploads

feat: upload menu

feat: prime message_file resources

feat: implement conversation access validation in chat route

refactor: remove file parameter from processFileUpload and use req.file instead

feat: add savedMessageIds set to track saved message IDs in BaseClient, to prevent unnecessary double-write to db

feat: prevent duplicate message saves by checking savedMessageIds in AgentController

refactor: skip legacy RAG API handling for agents

feat: add files field to convoSchema

refactor: update request type annotations from Express.Request to ServerRequest in file processing functions

feat: track conversation files

fix: resendFiles, addPreviousAttachments handling

feat: add ID validation for session_id and file_id in download route

feat: entity_id for code file uploads/downloads

fix: code file edge cases

feat: delete related tool calls

feat: add stream rate handling for LLM configuration

feat: enhance system content with attached file information

fix: improve error logging in resource priming function

* WIP: PoC, sequential agents

WIP: PoC Sequential Agents, first pass content data + bump agents package

fix: package-lock

WIP: PoC, o1 support, refactor bufferString

feat: convertJsonSchemaToZod

fix: form issues and schema defining erroneous model

fix: max length issue on agent form instructions, limit conversation messages to sequential agents

feat: add abort signal support to createRun function and AgentClient

feat: PoC, hide prior sequential agent steps

fix: update parameter naming from config to metadata in event handlers for clarity, add model to usage data

refactor: use only last contentData, track model for usage data

chore: bump agents package

fix: content parts issue

refactor: filter contentParts to include tool calls and relevant indices

feat: show function calls

refactor: filter context messages to exclude tool calls when no tools are available to the agent

fix: ensure tool call content is not undefined in formatMessages

feat: add agent_id field to conversationPreset schema

feat: hide sequential agents

feat: increase upload toast duration to 10 seconds

* refactor: tool context handling & update Code API Key Dialog

feat: toolContextMap

chore: skipSpecs -> useSpecs

ci: fix handleTools tests

feat: API Key Dialog

* feat: Agent Permissions Admin Controls

feat: replace label with button for prompt permission toggle

feat: update agent permissions

feat: enable experimental agents and streamline capability configuration

feat: implement access control for agents and enhance endpoint menu items

feat: add welcome message for agent selection in localization

feat: add agents permission to access control and update version to 0.7.57

* fix: update types in useAssistantListMap and useMentions hooks for better null handling

* feat: mention agents

* fix: agent tool resource race conditions when deleting agent tool resource files

* feat: add error handling for code execution with user feedback

* refactor: rename AdminControls to AdminSettings for clarity

* style: add gap to button in AdminSettings for improved layout

* refactor: separate agent query hooks and check access to enable fetching

* fix: remove unused provider from agent initialization options, creates issue with custom endpoints

* refactor: remove redundant/deprecated modelOptions from AgentClient processes

* chore: update @librechat/agents to version 1.8.5 in package.json and package-lock.json

* fix: minor styling issues + agent panel uniformity

* fix: agent edge cases when set endpoint is no longer defined

* refactor: remove unused cleanup function call from AppService

* fix: update link in ApiKeyDialog to point to pricing page

* fix: improve type handling and layout calculations in SidePanel component

* fix: add missing localization string for agent selection in SidePanel

* chore: form styling and localizations for upload filesearch/code interpreter

* fix: model selection placeholder logic in AgentConfig component

* style: agent capabilities

* fix: add localization for provider selection and improve dropdown styling in ModelPanel

* refactor: use gpt-4o-mini > gpt-3.5-turbo

* fix: agents configuration for loadDefaultInterface and update related tests

* feat: DALLE Agents support

Author: danny-avila

.env.example

@@ -177,10 +177,10 @@ OPENAI_API_KEY=user_provided
 DEBUG_OPENAI=false
 
 # TITLE_CONVO=false
-# OPENAI_TITLE_MODEL=gpt-3.5-turbo
+# OPENAI_TITLE_MODEL=gpt-4o-mini
 
 # OPENAI_SUMMARIZE=true
-# OPENAI_SUMMARY_MODEL=gpt-3.5-turbo
+# OPENAI_SUMMARY_MODEL=gpt-4o-mini
 
 # OPENAI_FORCE_PROMPT=true
 

api/app/clients/OpenAIClient.js

@@ -688,7 +688,7 @@ class OpenAIClient extends BaseClient {
   }
 
   initializeLLM({
-    model = 'gpt-3.5-turbo',
+    model = 'gpt-4o-mini',
     modelName,
     temperature = 0.2,
     presence_penalty = 0,
@@ -793,7 +793,7 @@ class OpenAIClient extends BaseClient {
 
     const { OPENAI_TITLE_MODEL } = process.env ?? {};
 
-    let model = this.options.titleModel ?? OPENAI_TITLE_MODEL ?? 'gpt-3.5-turbo';
+    let model = this.options.titleModel ?? OPENAI_TITLE_MODEL ?? 'gpt-4o-mini';
     if (model === Constants.CURRENT_MODEL) {
       model = this.modelOptions.model;
     }
@@ -982,7 +982,7 @@ ${convo}
     let prompt;
 
     // TODO: remove the gpt fallback and make it specific to endpoint
-    const { OPENAI_SUMMARY_MODEL = 'gpt-3.5-turbo' } = process.env ?? {};
+    const { OPENAI_SUMMARY_MODEL = 'gpt-4o-mini' } = process.env ?? {};
     let model = this.options.summaryModel ?? OPENAI_SUMMARY_MODEL;
     if (model === Constants.CURRENT_MODEL) {
       model = this.modelOptions.model;

api/app/clients/llm/createLLM.js

@@ -17,7 +17,7 @@ const { isEnabled } = require('~/server/utils');
  *
  * @example
  * const llm = createLLM({
- *   modelOptions: { modelName: 'gpt-3.5-turbo', temperature: 0.2 },
+ *   modelOptions: { modelName: 'gpt-4o-mini', temperature: 0.2 },
  *   configOptions: { basePath: 'https://example.api/path' },
  *   callbacks: { onMessage: handleMessage },
  *   openAIApiKey: 'your-api-key'

api/app/clients/memory/summaryBuffer.demo.js

@@ -3,7 +3,7 @@ const { ChatOpenAI } = require('@langchain/openai');
 const { getBufferString, ConversationSummaryBufferMemory } = require('langchain/memory');
 
 const chatPromptMemory = new ConversationSummaryBufferMemory({
-  llm: new ChatOpenAI({ modelName: 'gpt-3.5-turbo', temperature: 0 }),
+  llm: new ChatOpenAI({ modelName: 'gpt-4o-mini', temperature: 0 }),
   maxTokenLimit: 10,
   returnMessages: true,
 });

api/app/clients/specs/BaseClient.test.js

@@ -61,7 +61,7 @@ describe('BaseClient', () => {
   const options = {
     // debug: true,
     modelOptions: {
-      model: 'gpt-3.5-turbo',
+      model: 'gpt-4o-mini',
       temperature: 0,
     },
   };

api/app/clients/specs/OpenAIClient.test.js

@@ -221,7 +221,7 @@ describe('OpenAIClient', () => {
 
     it('should set isChatCompletion based on useOpenRouter, reverseProxyUrl, or model', () => {
       client.setOptions({ reverseProxyUrl: null });
-      // true by default since default model will be gpt-3.5-turbo
+      // true by default since default model will be gpt-4o-mini
       expect(client.isChatCompletion).toBe(true);
       client.isChatCompletion = undefined;
 
@@ -230,7 +230,7 @@ describe('OpenAIClient', () => {
       expect(client.isChatCompletion).toBe(false);
       client.isChatCompletion = undefined;
 
-      client.setOptions({ modelOptions: { model: 'gpt-3.5-turbo' }, reverseProxyUrl: null });
+      client.setOptions({ modelOptions: { model: 'gpt-4o-mini' }, reverseProxyUrl: null });
       expect(client.isChatCompletion).toBe(true);
     });
 

api/app/clients/tools/structured/DALLE3.js

@@ -19,6 +19,8 @@ class DALLE3 extends Tool {
 
     this.userId = fields.userId;
     this.fileStrategy = fields.fileStrategy;
+    /** @type {boolean} */
+    this.isAgent = fields.isAgent;
     if (fields.processFileURL) {
       /** @type {processFileURL} Necessary for output to contain all image metadata. */
       this.processFileURL = fields.processFileURL.bind(this);
@@ -108,6 +110,19 @@ class DALLE3 extends Tool {
     return `![generated image](${imageUrl})`;
   }
 
+  returnValue(value) {
+    if (this.isAgent === true && typeof value === 'string') {
+      return [value, {}];
+    } else if (this.isAgent === true && typeof value === 'object') {
+      return [
+        'DALL-E displayed an image. All generated images are already plainly visible, so don\'t repeat the descriptions in detail. Do not list download links as they are available in the UI already. The user may download the images by clicking on them, but do not mention anything about downloading to the user.',
+        value,
+      ];
+    }
+
+    return value;
+  }
+
   async _call(data) {
     const { prompt, quality = 'standard', size = '1024x1024', style = 'vivid' } = data;
     if (!prompt) {
@@ -126,18 +141,23 @@ class DALLE3 extends Tool {
       });
     } catch (error) {
       logger.error('[DALL-E-3] Problem generating the image:', error);
-      return `Something went wrong when trying to generate the image. The DALL-E API may be unavailable:
-Error Message: ${error.message}`;
+      return this
+        .returnValue(`Something went wrong when trying to generate the image. The DALL-E API may be unavailable:
+Error Message: ${error.message}`);
     }
 
     if (!resp) {
-      return 'Something went wrong when trying to generate the image. The DALL-E API may be unavailable';
+      return this.returnValue(
+        'Something went wrong when trying to generate the image. The DALL-E API may be unavailable',
+      );
     }
 
     const theImageUrl = resp.data[0].url;
 
     if (!theImageUrl) {
-      return 'No image URL returned from OpenAI API. There may be a problem with the API or your configuration.';
+      return this.returnValue(
+        'No image URL returned from OpenAI API. There may be a problem with the API or your configuration.',
+      );
     }
 
     const imageBasename = getImageBasename(theImageUrl);
@@ -157,11 +177,11 @@ Error Message: ${error.message}`;
 
     try {
       const result = await this.processFileURL({
-        fileStrategy: this.fileStrategy,
-        userId: this.userId,
         URL: theImageUrl,
-        fileName: imageName,
         basePath: 'images',
+        userId: this.userId,
+        fileName: imageName,
+        fileStrategy: this.fileStrategy,
         context: FileContext.image_generation,
       });
 
@@ -175,7 +195,7 @@ Error Message: ${error.message}`;
       this.result = `Failed to save the image locally. ${error.message}`;
     }
 
-    return this.result;
+    return this.returnValue(this.result);
   }
 }
 

api/app/clients/tools/util/handleTools.js

@@ -146,11 +146,12 @@ const loadToolWithAuth = (userId, authFields, ToolConstructor, options = {}) =>
 const loadTools = async ({
   user,
   model,
-  functions = true,
-  returnMap = false,
+  isAgent,
+  useSpecs,
   tools = [],
   options = {},
-  useSpecs,
+  functions = true,
+  returnMap = false,
 }) => {
   const toolConstructors = {
     calculator: Calculator,
@@ -183,6 +184,7 @@ const loadTools = async ({
   }
 
   const imageGenOptions = {
+    isAgent,
     req: options.req,
     fileStrategy: options.fileStrategy,
     processFileURL: options.processFileURL,

api/server/controllers/agents/callbacks.js

@@ -1,4 +1,4 @@
-const { Tools, StepTypes } = require('librechat-data-provider');
+const { Tools, StepTypes, imageGenTools } = require('librechat-data-provider');
 const {
   EnvVar,
   GraphEvents,
@@ -191,16 +191,41 @@ function createToolEndCallback({ req, res, artifactPromises }) {
       return;
     }
 
+    if (imageGenTools.has(output.name) && output.artifact) {
+      artifactPromises.push(
+        (async () => {
+          const fileMetadata = Object.assign(output.artifact, {
+            messageId: metadata.run_id,
+            toolCallId: output.tool_call_id,
+            conversationId: metadata.thread_id,
+          });
+          if (!res.headersSent) {
+            return fileMetadata;
+          }
+
+          if (!fileMetadata) {
+            return null;
+          }
+
+          res.write(`event: attachment\ndata: ${JSON.stringify(fileMetadata)}\n\n`);
+          return fileMetadata;
+        })().catch((error) => {
+          logger.error('Error processing code output:', error);
+          return null;
+        }),
+      );
+      return;
+    }
+
     if (output.name !== Tools.execute_code) {
       return;
     }
 
-    const { tool_call_id, artifact } = output;
-    if (!artifact.files) {
+    if (!output.artifact.files) {
       return;
     }
 
-    for (const file of artifact.files) {
+    for (const file of output.artifact.files) {
       const { id, name } = file;
       artifactPromises.push(
         (async () => {
@@ -213,10 +238,10 @@ function createToolEndCallback({ req, res, artifactPromises }) {
             id,
             name,
             apiKey: result[EnvVar.CODE_API_KEY],
-            toolCallId: tool_call_id,
             messageId: metadata.run_id,
-            session_id: artifact.session_id,
+            toolCallId: output.tool_call_id,
             conversationId: metadata.thread_id,
+            session_id: output.artifact.session_id,
           });
           if (!res.headersSent) {
             return fileMetadata;

api/server/services/AppService.js

@@ -9,7 +9,6 @@ const handleRateLimits = require('./Config/handleRateLimits');
 const { loadDefaultInterface } = require('./start/interface');
 const { azureConfigSetup } = require('./start/azureOpenAI');
 const { initializeRoles } = require('~/models/Role');
-const { cleanup } = require('./cleanup');
 const paths = require('~/config/paths');
 
 /**
@@ -19,7 +18,6 @@ const paths = require('~/config/paths');
  * @param {Express.Application} app - The Express application object.
  */
 const AppService = async (app) => {
-  cleanup();
   await initializeRoles();
   /** @type {TCustomConfig}*/
   const config = (await loadCustomConfig()) ?? {};