🐳 feat: RAG for Default Docker Compose Files + Docs Update (#2246)

* refactor(deploy-compose.yml): use long-syntax to avoid implicit folder creation of librechat.yaml

* refactor(docker-compose.override.yml.example): use long-syntax to avoid implicit folder creation of librechat.yaml

* chore: add simple health check for RAG_API_URL

* chore: improve axios error handling, adding `logAxiosError`

* chore: more informative message detailing RAG_API_URL path

* feat: add rag_api and vectordb to default compose file

* chore(rag.yml): update standalone rag compose file to use RAG_PORT

* chore: documentation updates

* docs: Update rag_api.md with images

* Update rag_api.md

* Update rag_api.md, assistants clarification

* add RAG API note to breaking changes

api/server/services/AppService.js

@@ -156,6 +156,17 @@ const AppService = async (app) => {
     };
   }
 
+  try {
+    const response = await fetch(`${process.env.RAG_API_URL}/health`);
+    if (response?.ok && response?.status === 200) {
+      logger.info(`RAG API is running and reachable at ${process.env.RAG_API_URL}.`);
+    }
+  } catch (error) {
+    logger.warn(
+      `RAG API is either not running or not reachable at ${process.env.RAG_API_URL}, you may experience errors with file uploads.`,
+    );
+  }
+
   app.locals = {
     socialLogins,
     availableTools,

api/server/services/ModelService.js

@@ -1,11 +1,8 @@
 const axios = require('axios');
 const { HttpsProxyAgent } = require('https-proxy-agent');
 const { EModelEndpoint, defaultModels, CacheKeys } = require('librechat-data-provider');
-const { extractBaseURL, inputSchema, processModelData } = require('~/utils');
+const { extractBaseURL, inputSchema, processModelData, logAxiosError } = require('~/utils');
 const getLogStores = require('~/cache/getLogStores');
-const { logger } = require('~/config');
-
-// const { getAzureCredentials, genAzureChatCompletion } = require('~/utils/');
 
 const { openAIApiKey, userProvidedOpenAI } = require('./Config/EndpointService').config;
 
@@ -77,29 +74,7 @@ const fetchModels = async ({
     models = input.data.map((item) => item.id);
   } catch (error) {
     const logMessage = `Failed to fetch models from ${azure ? 'Azure ' : ''}${name} API`;
-    if (error.response) {
-      logger.error(
-        `${logMessage} The request was made and the server responded with a status code that falls out of the range of 2xx: ${
-          error.message ? error.message : ''
-        }`,
-        {
-          headers: error.response.headers,
-          status: error.response.status,
-          data: error.response.data,
-        },
-      );
-    } else if (error.request) {
-      logger.error(
-        `${logMessage} The request was made but no response was received: ${
-          error.message ? error.message : ''
-        }`,
-        {
-          request: error.request,
-        },
-      );
-    } else {
-      logger.error(`${logMessage} Something happened in setting up the request`, error);
-    }
+    logAxiosError({ message: logMessage, error });
   }
 
   return models;

api/server/services/Runs/methods.js

@@ -1,6 +1,6 @@
 const axios = require('axios');
 const { EModelEndpoint } = require('librechat-data-provider');
-const { logger } = require('~/config');
+const { logAxiosError } = require('~/utils');
 
 /**
  * @typedef {Object} RetrieveOptions
@@ -54,33 +54,8 @@ async function retrieveRun({ thread_id, run_id, timeout, openai }) {
     const response = await axios.get(url, axiosConfig);
     return response.data;
   } catch (error) {
-    const logMessage = '[retrieveRun] Failed to retrieve run data:';
-    const timedOutMessage = 'Cannot read properties of undefined (reading \'status\')';
-    if (error?.response && error?.response?.status) {
-      logger.error(
-        `${logMessage} The request was made and the server responded with a status code that falls out of the range of 2xx: ${
-          error.message ? error.message : ''
-        }`,
-        {
-          headers: error.response.headers,
-          status: error.response.status,
-          data: error.response.data,
-        },
-      );
-    } else if (error.request) {
-      logger.error(
-        `${logMessage} The request was made but no response was received: ${
-          error.message ? error.message : ''
-        }`,
-        {
-          request: error.request,
-        },
-      );
-    } else if (error?.message && !error?.message?.includes(timedOutMessage)) {
-      logger.error(`${logMessage} Something happened in setting up the request`, {
-        message: error.message,
-      });
-    }
+    const message = '[retrieveRun] Failed to retrieve run data:';
+    logAxiosError({ message, error });
     throw error;
   }
 }

api/utils/index.js

@@ -1,13 +1,15 @@
 const loadYaml = require('./loadYaml');
 const tokenHelpers = require('./tokens');
 const azureUtils = require('./azureUtils');
+const logAxiosError = require('./logAxiosError');
 const extractBaseURL = require('./extractBaseURL');
 const findMessageContent = require('./findMessageContent');
 
 module.exports = {
-  ...azureUtils,
+  loadYaml,
   ...tokenHelpers,
+  ...azureUtils,
+  logAxiosError,
   extractBaseURL,
   findMessageContent,
-  loadYaml,
 };

api/utils/logAxiosError.js

@@ -0,0 +1,45 @@
+const { logger } = require('~/config');
+
+/**
+ * Logs Axios errors based on the error object and a custom message.
+ *
+ * @param {Object} options - The options object.
+ * @param {string} options.message - The custom message to be logged.
+ * @param {Error} options.error - The Axios error object.
+ */
+const logAxiosError = ({ message, error }) => {
+  const timedOutMessage = 'Cannot read properties of undefined (reading \'status\')';
+  if (error.response) {
+    logger.error(
+      `${message} The request was made and the server responded with a status code that falls out of the range of 2xx: ${
+        error.message ? error.message : ''
+      }. Error response data:\n`,
+      {
+        headers: error.response?.headers,
+        status: error.response?.status,
+        data: error.response?.data,
+      },
+    );
+  } else if (error.request) {
+    logger.error(
+      `${message} The request was made but no response was received: ${
+        error.message ? error.message : ''
+      }. Error Request:\n`,
+      {
+        request: error.request,
+      },
+    );
+  } else if (error?.message?.includes(timedOutMessage)) {
+    logger.error(
+      `${message}\nThe request either timed out or was unsuccessful. Error message:\n`,
+      error,
+    );
+  } else {
+    logger.error(
+      `${message}\nSomething happened in setting up the request. Error message:\n`,
+      error,
+    );
+  }
+};
+
+module.exports = logAxiosError;