Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ module.exports = {
'unicorn/no-array-for-each': 'error',
'unicorn/prefer-string-replace-all': 'error',
'@typescript-eslint/prefer-for-of': 'error',
"no-sharp-comments": "off",
"markdown/no-sharp-comments": "off",
'no-sharp-comments': 'off',
'markdown/no-sharp-comments': 'off',
// todo: enable
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-non-null-assertion': 'off',
Expand Down Expand Up @@ -104,7 +104,7 @@ module.exports = {
],
parserOptions: {
project: ['tsconfig.json'],
tsconfigRootDir: './'
tsconfigRootDir: './',
},
rules: {
'@typescript-eslint/no-unnecessary-type-assertion': 'error',
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/generate_embeddings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ jobs:
supabase-url: 'https://gnoyckdqaktttbfurtcv.supabase.co'
supabase-service-role-key: ${{ secrets.SUPABASE_SERVICE_ROLE_KEY }}
openai-key: ${{ secrets.OPENAI_API_KEY }}
docs-root-path: './pages'
docs-root-path: './pages'
3 changes: 2 additions & 1 deletion components/changelog/content/config_v1.0.0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ see: [librechat.yaml](/docs/configuration/librechat_yaml)
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.
Expand All @@ -25,4 +26,4 @@ Features:
- **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.
- Ensures strict object structure without additional properties.
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.01.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- Added [`fileStrategy`](/docs/configuration/librechat_yaml/object_structure/config#filestrategy) to custom config
- Added [`fileStrategy`](/docs/configuration/librechat_yaml/object_structure/config#filestrategy) to custom config
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.02.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Added `userIdQuery` to custom endpoint [models](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#useridquery) settings
- Added [Registration Configuration](/docs/configuration/librechat_yaml/object_structure/config#registration) settings
- Added [`headers`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#headers) to custom endpoint settings
- Added [`headers`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#headers) to custom endpoint settings
4 changes: 2 additions & 2 deletions components/changelog/content/config_v1.03.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- Added [OpenAI Assistants configuration](/docs/configuration/librechat_yaml/object_structure/assistants_endpoint) settings
- Added the following fields to custom endpoint settings:
- [`addParams`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#addparams), [`dropParams`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#dropparams)
- [`addParams`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#addparams), [`dropParams`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#dropparams)
- Added [Rate Limit Configuration](/docs/configuration/librechat_yaml/object_structure/config#ratelimits) settings
- Added [File Configuration](/docs/configuration/librechat_yaml/object_structure/file_config) settings
- Added [File Configuration](/docs/configuration/librechat_yaml/object_structure/file_config) settings
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.04.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- Added initial [Azure OpenAI configuration](/docs/configuration/librechat_yaml/object_structure/azure_openai) settings
- Added initial [Azure OpenAI configuration](/docs/configuration/librechat_yaml/object_structure/azure_openai) settings
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.05.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- Added [Azure OpenAI Assistants configuration](/docs/configuration/librechat_yaml/object_structure/assistants_endpoint) settings
- Added initial [interface settings](/docs/configuration/librechat_yaml/object_structure/interface) (privacy policy & terms of service)
- Added the following fields to the [Azure Group Config](/docs/configuration/librechat_yaml/object_structure/azure_openai#group-object-structure):
- `serverless`, `addParams`, `dropParams`, `forcePrompt`
- `serverless`, `addParams`, `dropParams`, `forcePrompt`
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.06.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
- Added [`imageOutputType`](/docs/configuration/librechat_yaml/object_structure/config#imageoutputtype) field to specify the output type for image generation.
- Added [`secureImageLinks`](/docs/configuration/librechat_yaml/object_structure/config#secureimagelinks) to optionally lock down access to generated images.
- Added [`secureImageLinks`](/docs/configuration/librechat_yaml/object_structure/config#secureimagelinks) to optionally lock down access to generated images.
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.07.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
- Removed `stop` from OpenAI/custom endpoint default parameters
- Added `current_model` option for [`titleModel`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#titlemodel) and [`summaryModel`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#summarymodel) endpoint settings in order to use the active conversation's model for those methods.
- Added `current_model` option for [`titleModel`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#titlemodel) and [`summaryModel`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#summarymodel) endpoint settings in order to use the active conversation's model for those methods.
10 changes: 5 additions & 5 deletions components/changelog/content/config_v1.08.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
- Added additional fields to [interface config](/docs/configuration/librechat_yaml/object_structure/interface) to toggle access to specific features:
- `endpointsMenu`, `modelSelect`, `parameters`, `sidePanel`, `presets`
- `endpointsMenu`, `modelSelect`, `parameters`, `sidePanel`, `presets`
- Now ensures the following fields always have defaults set:
- `cache`, `imageOutputType`, `fileStrategy`, `registration`
- `cache`, `imageOutputType`, `fileStrategy`, `registration`
- Added [`modelSpecs`](/docs/configuration/librechat_yaml/object_structure/model_specs) for a configurable UI experience, simplifying model selection with specific presets and tools.
- Added [`filteredTools`](/docs/configuration/librechat_yaml/object_structure/config#filteredtools) to disable specific plugins/tools without any changes to the codebase
- Affects both `gptPlugins` and `assistants` endpoints
- Affects both `gptPlugins` and `assistants` endpoints
- [`iconURL`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#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
- "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "gptPlugins"
- Invalid YAML format is now logged for easier debugging
1 change: 0 additions & 1 deletion components/changelog/content/config_v1.09.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
- Added `conversationsImport` to [rateLimits](/docs/configuration/librechat_yaml/object_structure/config#ratelimits) along with the [new feature](https://github.com/danny-avila/LibreChat/pull/2355) for importing conversations from LibreChat, ChatGPT, and Chatbot UI.

4 changes: 2 additions & 2 deletions components/changelog/content/config_v1.1.1.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Added new `azureAssistants` endpoint to [librechat_yaml config](/docs/configuration/librechat_yaml/object_structure/assistants_endpoint)
- Uses the same structure as the `assistants` endpoint, but is separated to accomodate latest OpenAI Assistant v2 changes to the API.
- More info: [Azure OpenAI Configuration](/docs/configuration/azure#using-assistants-with-azure)
- Uses the same structure as the `assistants` endpoint, but is separated to accomodate latest OpenAI Assistant v2 changes to the API.
- More info: [Azure OpenAI Configuration](/docs/configuration/azure#using-assistants-with-azure)
1 change: 0 additions & 1 deletion components/changelog/content/config_v1.1.2.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
- Added `stt` and `tts` to [librechat_yaml config](/docs/configuration/stt_tts)

3 changes: 1 addition & 2 deletions components/changelog/content/config_v1.1.3.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
- Added `privateAssistants` to [Assistants Object Structure](/docs/configuration/librechat_yaml/object_structure/assistants_endpoint#privateassistants)
- Added [`directEndpoint`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#directendpoint) and [`titleMessageRole`](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#titlemessagerole) to Custom Endpoint Settings
- Added example for [Databricks](/docs/configuration/librechat_yaml/ai_endpoints/databricks), which requires use of both these new values

- Added example for [Databricks](/docs/configuration/librechat_yaml/ai_endpoints/databricks), which requires use of both these new values
1 change: 0 additions & 1 deletion components/changelog/content/config_v1.1.4.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
- Added [new rate limiters](/docs/configuration/librechat_yaml/object_structure/config#ratelimits) for speech-to-text (stt) and text-to-speech (tts) services

14 changes: 8 additions & 6 deletions components/changelog/content/config_v1.1.5.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
- Added [`streamRate`](/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings#streamrate) to the shared endpoint settings.
- This setting allows you to control the rate at which data is streamed from the endpoint.
- You can set a global value for all endpoints or customize it for each individual endpoint.
- The `all` setting can override all individual endpoint values, making them unnecessary if used.

- This setting allows you to control the rate at which data is streamed from the endpoint.
- You can set a global value for all endpoints or customize it for each individual endpoint.
- The `all` setting can override all individual endpoint values, making them unnecessary if used.

- Added [`speech`](/docs/configuration/stt_tts#speech-introduction) object

- Moved `TTS` and `STT` under the new `speech` object
- This change allows you to configure speech settings in a more organized way.

- This change allows you to configure speech settings in a more organized way.

- Added [`speechTab`](/docs/configuration/stt_tts#speech-tab-optional) under the new `speech` object
- This setting allows you to configure the default speech tab settings for LibreChat users
- Remeber that users can still override them
- This setting allows you to configure the default speech tab settings for LibreChat users
- Remeber that users can still override them
4 changes: 2 additions & 2 deletions components/changelog/content/config_v1.1.6.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Added [`prompts`](/docs/configuration/librechat_yaml/object_structure/interface#prompts) and [`bookmarks`](/docs/configuration/librechat_yaml/object_structure/interface#bookmarks) to the interface settings.
- This allows you to disable or enable the prompts and bookmarks tabs in the interface.
- Applies only to users with "USER" roles, "ADMIN" roles will always see these features enabled.
- This allows you to disable or enable the prompts and bookmarks tabs in the interface.
- Applies only to users with "USER" roles, "ADMIN" roles will always see these features enabled.
6 changes: 3 additions & 3 deletions components/changelog/content/config_v1.1.7.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- Added [`multiConvo`](/docs/configuration/librechat_yaml/object_structure/interface#multiConvo) to the interface settings.
- This allows you to disable or enable all "multi convo", AKA multiple response streaming, related features
- All interface settings now apply to both "USER" and "ADMIN" roles.
- This allows you to disable or enable all "multi convo", AKA multiple response streaming, related features
- All interface settings now apply to both "USER" and "ADMIN" roles.
- Added [`bedrock`](/docs/configuration/librechat_yaml/object_structure/aws_bedrock) to the endpoints settings.
- This allows you to configure additional options for the AWS Bedrock endpoint, notably the `titleModel`, `streamRate`, and `availableRegions`.
- This allows you to configure additional options for the AWS Bedrock endpoint, notably the `titleModel`, `streamRate`, and `availableRegions`.
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.2.0.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
- Added initial MCP Support (Tools) for Agents and Assistants
- Requires editing `librechat.yaml` with new `mcpServers` object config
- Requires editing `librechat.yaml` with new `mcpServers` object config
2 changes: 1 addition & 1 deletion components/changelog/content/config_v1.2.2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
- Adds "File Context (OCR)" as a new file upload category for agents
- This setting also affects the "Upload as Text" feature in chat (uploading as a message attachment)
- Added `titleModel` to [Shared Endpoint Settings](), making this configurable for all endpoints
- Note, this doesn't included `assistants` nor `all` configurations
- Note, this doesn't included `assistants` nor `all` configurations
15 changes: 12 additions & 3 deletions components/changelog/content/config_v1.2.4.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,29 @@
- Allows administrators to specify a list of endpoint providers (e.g., `openAI`, `anthropic`, `google`) that are permitted for use with the Agents feature.
- If defined, only agents configured with these providers can be initialized.
- This provides better control over which providers can be used with the Agents feature, enhancing security and compliance.

---

- Implemented `addedEndpoints` in [Model Specs](/docs/configuration/librechat_yaml/object_structure/model_specs)
- **`modelSpecs.addedEndpoints`**: Enables specific endpoints (e.g., `openAI`, `google`) to be selectable in the UI even when `modelSpecs` are defined and prioritized. This allows users to choose standard models alongside specialized specs. Requires `interface.modelSelect` to be `true`. See [Model Specs Docs](/docs/configuration/librechat_yaml/object_structure/model_specs#addedendpoints) for more details.
- If `modelSpecs.addedEndpoints` is provided, `interface.modelSelect` will default to `true` if not explicitly set, ensuring the model selection dropdown is visible.
- **`modelSpecs.addedEndpoints`**: Enables specific endpoints (e.g., `openAI`, `google`) to be selectable in the UI even when `modelSpecs` are defined and prioritized. This allows users to choose standard models alongside specialized specs. Requires `interface.modelSelect` to be `true`. See [Model Specs Docs](/docs/configuration/librechat_yaml/object_structure/model_specs#addedendpoints) for more details.
- If `modelSpecs.addedEndpoints` is provided, `interface.modelSelect` will default to `true` if not explicitly set, ensuring the model selection dropdown is visible.

---

- Added `timeout` to [MCP Servers](/docs/configuration/librechat_yaml/object_structure/mcp_servers)
- Controls how long to wait for a response from MCP server tool requests (in milliseconds)
- Provides better control over MCP server request behavior
- Allows adjusting timeouts based on expected response times for different MCP servers

---

- Added `initTimeout` to [MCP Servers](/docs/configuration/librechat_yaml/object_structure/mcp_servers)
- Controls how long to wait for MCP server initialization (in milliseconds)
- Allows configuration of initialization timeouts for servers that may take longer to start up
- Helps fine-tune performance for specific environments and use cases

---

- Implemented [Balance Configuration](/docs/configuration/librechat_yaml/object_structure/balance)
- Set `enabled` to `true` to check user balances; replaces `CHECK_BALANCE` environment variable
- Set `startBalance` to desired starting balance; replaces `START_BALANCE` environment variable
Expand All @@ -27,9 +35,10 @@
- Improved balance synchronization to ensure user settings match global configuration
- Provides administrators with more control over token usage and user balance management
- For more details, see the [Token Usage Guide](/docs/configuration/token_usage)

---

- Deprecated `interface.endpointsMenu` in [Interface](/docs/configuration/librechat_yaml/object_structure/interface#endpointsmenu)
- This setting will be removed in a future version
- Use `interface.modelSelect` instead for controlling endpoint/model selection visibility
- If you would like to limit the available endpoints while using model specs, configure the [`modelSpecs.addedEndpoints`](/docs/configuration/librechat_yaml/object_structure/model_specs#addedendpoints) setting.

4 changes: 3 additions & 1 deletion components/changelog/content/config_v1.2.6.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
- Added `webSearch` configuration to control web search functionality

- Configures search providers (Serper, SearXNG), scrapers (Firecrawl, Serper), and rerankers (Jina, Cohere)
- Allows customization of API keys and endpoints for each service
- Enables safe search mode by default
- See [Web Search Configuration](/docs/configuration/librechat_yaml/object_structure/web_search) for details

- Added `webSearch` toggle to [Interface Configuration](/docs/configuration/librechat_yaml/object_structure/interface)

- When set to `false`, disables the web search button in the chat interface
- Defaults to `true` (web search button is visible)

- Added `web_search` capability to [Agents Configuration](/docs/configuration/librechat_yaml/object_structure/agents)
- Enables web search functionality for agents
- Defaults to enabled in the default capabilities list
- Can be disabled by removing from the capabilities array
- Can be disabled by removing from the capabilities array
3 changes: 2 additions & 1 deletion components/changelog/content/config_v1.2.7.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
- Added `memory` configuration to control memory functionality for conversations

- Configure memory persistence and personalization settings
- Set token limits and message window sizes for memory context
- Configure agents for memory processing with provider-specific settings
Expand All @@ -9,4 +10,4 @@
- Enables conversation memory and personalization features
- Configurable token limits and context window management
- Integration with agent-based memory processing
- Defaults to personalization enabled with a 5-message window size
- Defaults to personalization enabled with a 5-message window size
Loading