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

danny-avila · 2024-04-30T01:54:48Z

Summary

Model Specs

Introduces "modelSpecs" for a configurable UI experience, simplifying model selection with specific presets and tools.

Preview

Tools in Conversation Settings (Parameters) and Presets

Chats now save the tools used throughout the conversation and can also be configured from parameters, as well as saved to Presets

Other Changes

Replaced some hardcoded values with enums, to improve maintainability, mainly with localStorage keys in this update.
Removed many unused files from the codebase, mainly from the client workspace, which increase bundle size or contribute to typescript compilation errors
Removed redundant code, applied DRY in areas touched, resulting in speed/handling optimizations in certain areas
Consolidated conversation state updating logic on the frontend, to improve maintainability
custom name and instructions now possible for gptPlugins endpoint

Custom Config (librechat.yaml) v1.0.8

Added additional fields to interface config to toggle access to specific features:
- endpointsMenu, modelSelect, parameters, sidePanel, presets
Now ensures the following fields always have defaults set:
- cache, imageOutputType, fileStrategy, registration
Added filteredTools to disable specific plugins/tools without any changes to the codebase
- Affects both gptPlugins and assistants endpoints
Invalid YAML format is now logged for easier debugging
iconURL can now be to set to one of the main endpoints to use existing project icons

Closes #1617
Closes #2174

Change Type

New feature (non-breaking change which adds functionality)

Checklist

My code adheres to this project's style guidelines
I have performed a self-review of my own code
I have commented in any complex areas of my code
I have made pertinent documentation changes
My changes do not introduce new warnings
I have written tests demonstrating that my changes are effective or that my feature works
Local unit tests pass with my changes
Any changes dependent on mine have been merged and published in downstream modules.
New documents have been locally validated with mkdocs

…presets/messages

… undefined spec, add localStorage keys enum, additional type fields for spec

…` and no specs on initial load

…ts shared conversation state with other endpoints

…ehavior (localStorage)

…atGptLabel

… button if preset UI visibility disabled

…bleTools on Plugin installations

…tings

…fferent response methods

* 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

danny-avila added 30 commits April 27, 2024 18:32

WIP: first pass ModelSpecs

9515560

refactor(onSelectEndpoint): use getConvoSwitchLogic

a9b4c41

feat: introduce iconURL, greeting, frontend fields for conversations/…

d3c4155

…presets/messages

feat: conversation.iconURL & greeting in Landing

578a0ba

feat: conversation.iconURL & greeting in New Chat button

1a17665

feat: message.iconURL

36ccf4c

refactor: ConversationIcon -> ConvoIconURL

f4f19f4

WIP: add spec as a conversation field

58152cc

refactor: useAppStartup, set spec on initial load for new chat, allow…

d280efc

… undefined spec, add localStorage keys enum, additional type fields for spec

feat: handle showIconInMenu, showIconInHeader, undefined `iconURL…

840bbab

…` and no specs on initial load

chore: handle undefined or empty modelSpecs

0271667

WIP: first pass, modelSpec schema for custom config

f3904cb

refactor: move default filtered tools definition to ToolService

4a51326

feat: pass modelSpecs from backend via startupConfig

79a8c1c

refactor: modelSpecs config, return and define list

6f834d3

fix: react error and include iconURL in responseMessage

45df533

refactor: add iconURL to responseMessage only

002da92

refactor: getIconEndpoint

7096b18

refactor: pass TSpecsConfig

c375dd1

fix(assistants): differentiate compactAssistantSchema, correctly rese…

5cf8ba2

…ts shared conversation state with other endpoints

refactor: assistant id prefix localStorage key

4c457c9

refactor: add more LocalStorageKeys and replace hardcoded values

48ddd2c

feat: prioritize spec on new chat behavior: last selected modelSpec b…

b537da0

…ehavior (localStorage)

feat: first pass, interface config

6582e85

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

499c818

feat: enforce modelSpecs if configured

559c6d4

feat: show config file yaml errors

e9c1f30

chore: delete unused legacy Plugins component

748736e

refactor: set tools to localStorage from recoil store

ee81bfc

chore: add stable recoil setter to useEffect deps

6e97bb7

danny-avila added 16 commits April 30, 2024 11:32

docs: update modelSpecs info

d56fb3f

chore: remove unused files

5efa422

chore: remove unused files

056f73e

chore: move useSetIndexOptions

2c01472

chore: remove unused file

f8e71a2

chore: move useConversation(s)

939428f

chore: move useDefaultConvo

e1d6346

chore: move useNavigateToConvo

bd62598

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

e55927c

chore: import order

5ea4fee

update docs

c6d8a8e

refactor(OpenAI/Plugins): allow modelLabel as an initial value for ch…

f1d2755

…atGptLabel

chore: remove unused EndpointOptionsPopover and hide 'Save as Preset'…

445aa41

… button if preset UI visibility disabled

feat(loadDefaultInterface): issue warnings based on values

84f1b70

feat: changelog for custom config file

1c389f3

docs: add additional changelog note

69d2007

danny-avila marked this pull request as ready for review April 30, 2024 18:49

danny-avila added 9 commits April 30, 2024 15:54

fix: prevent unavailable tool selection from preset and update availa…

207d08e

…bleTools on Plugin installations

feat: add filteredTools option in custom config

23d7547

chore: changelog

7d225f4

fix(MessageIcon): always overwrite conversation.iconURL in messageSet…

a632f23

…tings

fix(ModelSpecsMenu): icon edge cases

2d7c517

fix(NewChat): dynamic icon

501f356

fix(PluginsClient): always include endpoint in responseMessage

523f4ac

fix: always include endpoint and iconURL in responseMessage across di…

e46f4c1

…fferent response methods

feat: interchangeable keys for modelSpec enforcing

a9860c8

danny-avila merged commit 0e50c07 into main May 1, 2024
3 checks passed

danny-avila deleted the model-select branch May 1, 2024 02:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

danny-avila commented Apr 30, 2024 •

edited

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

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

Conversation

danny-avila commented Apr 30, 2024 • edited

Summary

Model Specs

Preview

Tools in Conversation Settings (Parameters) and Presets

Other Changes

Custom Config (librechat.yaml) v1.0.8

Change Type

Checklist

danny-avila commented Apr 30, 2024 •

edited