🤖 feat: Model Specs & Save Tools per Convo/Preset (#2578)

* WIP: first pass ModelSpecs

* refactor(onSelectEndpoint): use `getConvoSwitchLogic`

* feat: introduce iconURL, greeting, frontend fields for conversations/presets/messages

* feat: conversation.iconURL & greeting in Landing

* feat: conversation.iconURL & greeting in New Chat button

* feat: message.iconURL

* refactor: ConversationIcon -> ConvoIconURL

* WIP: add spec as a conversation field

* refactor: useAppStartup, set spec on initial load for new chat, allow undefined spec, add localStorage keys enum, additional type fields for spec

* feat: handle `showIconInMenu`, `showIconInHeader`, undefined `iconURL` and no specs on initial load

* chore: handle undefined or empty modelSpecs

* WIP: first pass, modelSpec schema for custom config

* refactor: move default filtered tools definition to ToolService

* feat: pass modelSpecs from backend via startupConfig

* refactor: modelSpecs config, return and define list

* fix: react error and include iconURL in responseMessage

* refactor: add iconURL to responseMessage only

* refactor: getIconEndpoint

* refactor: pass TSpecsConfig

* fix(assistants): differentiate compactAssistantSchema, correctly resets shared conversation state with other endpoints

* refactor: assistant id prefix localStorage key

* refactor: add more LocalStorageKeys and replace hardcoded values

* feat: prioritize spec on new chat behavior: last selected modelSpec behavior (localStorage)

* feat: first pass, interface config

* chore: WIP, todo: add warnings based on config.modelSpecs settings.

* feat: enforce modelSpecs if configured

* feat: show config file yaml errors

* chore: delete unused legacy Plugins component

* refactor: set tools to localStorage from recoil store

* chore: add stable recoil setter to useEffect deps

* refactor: save tools to conversation documents

* style(MultiSelectPop): dynamic height, remove unused import

* refactor(react-query): use localstorage keys and pass config to useAvailablePluginsQuery

* feat(utils): add mapPlugins

* refactor(Convo): use conversation.tools if defined, lastSelectedTools if not

* refactor: remove unused legacy code using `useSetOptions`, remove conditional flag `isMultiChat` for using legacy settings

* refactor(PluginStoreDialog): add exhaustive-deps which are stable react state setters

* fix(HeaderOptions): pass `popover` as true

* refactor(useSetStorage): use project enums

* refactor: use LocalStorageKeys enum

* fix: prevent setConversation from setting falsy values in lastSelectedTools

* refactor: use map for availableTools state and available Plugins query

* refactor(updateLastSelectedModel): organize logic better and add note on purpose

* fix(setAgentOption): prevent reseting last model to secondary model for gptPlugins

* refactor(buildDefaultConvo): use enum

* refactor: remove `useSetStorage` and consolidate areas where conversation state is saved to localStorage

* fix: conversations retain tools on refresh

* fix(gptPlugins): prevent nullish tools from being saved

* chore: delete useServerStream

* refactor: move initial plugins logic to useAppStartup

* refactor(MultiSelectDropDown): add more pass-in className props

* feat: use tools in presets

* chore: delete unused usePresetOptions

* refactor: new agentOptions default handling

* chore: note

* feat: add label and custom instructions to agents

* chore: remove 'disabled with tools' message

* style: move plugins to 2nd column in parameters

* fix: TPreset type for agentOptions

* fix: interface controls

* refactor: add interfaceConfig, use Separator within Switcher

* refactor: hide Assistants panel if interface.parameters are disabled

* fix(Header): only modelSpecs if list is greater than 0

* refactor: separate MessageIcon logic from useMessageHelpers for better react rule-following

* fix(AppService): don't use reserved keyword 'interface'

* feat: set existing Icon for custom endpoints through iconURL

* fix(ci): tests passing for App Service

* docs: refactor custom_config.md for readability and better organization, also include missing values

* docs: interface section and re-organize docs

* docs: update modelSpecs info

* chore: remove unused files

* chore: remove unused files

* chore: move useSetIndexOptions

* chore: remove unused file

* chore: move useConversation(s)

* chore: move useDefaultConvo

* chore: move useNavigateToConvo

* refactor: use plugin install hook so it can be used elsewhere

* chore: import order

* update docs

* refactor(OpenAI/Plugins): allow modelLabel as an initial value for chatGptLabel

* chore: remove unused EndpointOptionsPopover and hide 'Save as Preset' button if preset UI visibility disabled

* feat(loadDefaultInterface): issue warnings based on values

* feat: changelog for custom config file

* docs: add additional changelog note

* fix: prevent unavailable tool selection from preset and update availableTools on Plugin installations

* feat: add `filteredTools` option in custom config

* chore: changelog

* fix(MessageIcon): always overwrite conversation.iconURL in messageSettings

* fix(ModelSpecsMenu): icon edge cases

* fix(NewChat): dynamic icon

* fix(PluginsClient): always include endpoint in responseMessage

* fix: always include endpoint and iconURL in responseMessage across different response methods

* feat: interchangeable keys for modelSpec enforcing

client/src/hooks/useNewConvo.ts

@@ -1,35 +1,45 @@
 import { useCallback, useRef } from 'react';
-import { EModelEndpoint, FileSources, defaultOrderQuery } from 'librechat-data-provider';
-import { useGetEndpointsQuery, useGetModelsQuery } from 'librechat-data-provider/react-query';
 import {
-  useSetRecoilState,
-  useResetRecoilState,
-  useRecoilCallback,
+  useGetModelsQuery,
+  useGetStartupConfig,
+  useGetEndpointsQuery,
+} from 'librechat-data-provider/react-query';
+import {
+  FileSources,
+  EModelEndpoint,
+  LocalStorageKeys,
+  defaultOrderQuery,
+} from 'librechat-data-provider';
+import {
   useRecoilState,
   useRecoilValue,
+  useSetRecoilState,
+  useRecoilCallback,
+  useResetRecoilState,
 } from 'recoil';
 import type {
-  TConversation,
-  TSubmission,
   TPreset,
+  TSubmission,
   TModelsConfig,
+  TConversation,
   TEndpointsConfig,
 } from 'librechat-data-provider';
 import {
+  getEndpointField,
   buildDefaultConvo,
   getDefaultEndpoint,
-  getEndpointField,
+  getDefaultModelSpec,
+  getModelSpecIconURL,
   updateLastSelectedModel,
 } from '~/utils';
 import { useDeleteFilesMutation, useListAssistantsQuery } from '~/data-provider';
 import useOriginNavigate from './useOriginNavigate';
-import useSetStorage from './useSetStorage';
 import { mainTextareaId } from '~/common';
 import store from '~/store';
 
 const useNewConvo = (index = 0) => {
-  const setStorage = useSetStorage();
   const navigate = useOriginNavigate();
+  const { data: startupConfig } = useGetStartupConfig();
   const defaultPreset = useRecoilValue(store.defaultPreset);
   const { setConversation } = store.useCreateConversationAtom(index);
   const [files, setFiles] = useRecoilState(store.filesByIndex(index));
@@ -94,7 +104,8 @@ const useNewConvo = (index = 0) => {
 
           if (!conversation.assistant_id && isAssistantEndpoint) {
             conversation.assistant_id =
-              localStorage.getItem(`assistant_id__${index}`) ?? assistants[0]?.id;
+              localStorage.getItem(`${LocalStorageKeys.ASST_ID_PREFIX}${index}`) ??
+              assistants[0]?.id;
           }
 
           if (
@@ -102,9 +113,7 @@ const useNewConvo = (index = 0) => {
             isAssistantEndpoint &&
             conversation.conversationId === 'new'
           ) {
-            const assistant = assistants.find(
-              (assistant) => assistant.id === conversation.assistant_id,
-            );
+            const assistant = assistants.find((asst) => asst.id === conversation.assistant_id);
             conversation.model = assistant?.model;
             updateLastSelectedModel({
               endpoint: EModelEndpoint.assistants,
@@ -125,7 +134,6 @@ const useNewConvo = (index = 0) => {
           });
         }
 
-        setStorage(conversation);
         setConversation(conversation);
         setSubmission({} as TSubmission);
         if (!keepLatestMessage) {
@@ -133,7 +141,7 @@ const useNewConvo = (index = 0) => {
         }
 
         if (conversation.conversationId === 'new' && !modelsData) {
-          const appTitle = localStorage.getItem('appTitle');
+          const appTitle = localStorage.getItem(LocalStorageKeys.APP_TITLE);
           if (appTitle) {
             document.title = appTitle;
           }
@@ -154,7 +162,7 @@ const useNewConvo = (index = 0) => {
   const newConversation = useCallback(
     ({
       template = {},
-      preset,
+      preset: _preset,
       modelsData,
       buildDefault = true,
       keepLatestMessage = false,
@@ -174,6 +182,16 @@ const useNewConvo = (index = 0) => {
         updatedAt: '',
       };
 
+      let preset = _preset;
+      const defaultModelSpec = getDefaultModelSpec(startupConfig?.modelSpecs?.list);
+      if (!preset && startupConfig && startupConfig.modelSpecs?.prioritize && defaultModelSpec) {
+        preset = {
+          ...defaultModelSpec.preset,
+          iconURL: getModelSpecIconURL(defaultModelSpec),
+          spec: defaultModelSpec.name,
+        } as TConversation;
+      }
+
       if (conversation.conversationId === 'new' && !modelsData) {
         const filesToDelete = Array.from(files.values())
           .filter((file) => file.filepath && file.source && !file.embedded && file.temp_file_id)
@@ -185,7 +203,7 @@ const useNewConvo = (index = 0) => {
           }));
 
         setFiles(new Map());
-        localStorage.setItem('filesToDelete', JSON.stringify({}));
+        localStorage.setItem(LocalStorageKeys.FILES_TO_DELETE, JSON.stringify({}));
 
         if (filesToDelete.length > 0) {
           mutateAsync({ files: filesToDelete });
@@ -194,7 +212,7 @@ const useNewConvo = (index = 0) => {
 
       switchToConversation(conversation, preset, modelsData, buildDefault, keepLatestMessage);
     },
-    [switchToConversation, files, mutateAsync, setFiles],
+    [switchToConversation, files, mutateAsync, setFiles, startupConfig],
   );
 
   return {