LibreChat/docs/install/configuration/config_changelog.md
Danny Avila 0e50c07e3f
🤖 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
2024-04-30 22:11:48 -04:00

4.5 KiB

title description weight
🖥️ Config Changelog Changelog for the custom configuration file -10

🖥️ Config Changelog

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 modelSpecs for a configurable UI experience, simplifying model selection with specific presets and tools.
  • Added filteredTools to disable specific plugins/tools without any changes to the codebase
    • Affects both gptPlugins and assistants endpoints
  • iconURL can now be to set to one of the main endpoints to use existing project icons
    • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "gptPlugins"
  • Invalid YAML format is now logged for easier debugging

v1.0.7

  • Removed stop from OpenAI/custom endpoint default parameters
  • Added current_model option for titleModel and summaryModel endpoint settings in order to use the active conversation's model for those methods.

v1.0.6

v1.0.5

v1.0.4

v1.0.3

v1.0.2

v1.0.1

v1.0.0

This initial release introduces a robust configuration schema using Zod for validation, designed to manage API endpoints and associated settings in a structured and type-safe manner.

Features:

  1. Endpoint Configuration Schema (endpointSchema):

    • Name Validation: Ensures that the endpoint name is not one of the default EModelEndpoint values.
    • API Key: Requires a string value for API key identification.
    • Base URL: Requires a string value for the base URL of the endpoint.
    • Models Configuration:
      • Default Models: Requires an array of strings with at least one model specified.
      • Fetch Option: Optional boolean to enable model fetching.
    • Additional Optional Settings:
      • Title Convo: Optional boolean to toggle conversation titles.
      • Title Method: Optional choice between 'completion' and 'functions' methods.
      • Title Model: Optional string for model specification in titles.
      • Summarize: Optional boolean for enabling summary features.
      • Summary Model: Optional string specifying the model used for summaries.
      • Force Prompt: Optional boolean to force prompt inclusion.
      • Model Display Label: Optional string for labeling the model in UI displays.
  2. Main Configuration Schema (configSchema):

    • Version: String to specify the config schema version.
    • Cache: Boolean to toggle caching mechanisms.
    • Endpoints:
      • Custom Endpoints: Array of partially applied endpointSchema to allow custom endpoint configurations.
    • Ensures strict object structure without additional properties.