mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-21 21:50:49 +02:00

* 🧠 feat: User Memories for Conversational Context
chore: mcp typing, use `t`
WIP: first pass, Memories UI
- Added MemoryViewer component for displaying, editing, and deleting user memories.
- Integrated data provider hooks for fetching, updating, and deleting memories.
- Implemented pagination and loading states for better user experience.
- Created unit tests for MemoryViewer to ensure functionality and interaction with data provider.
- Updated translation files to include new UI strings related to memories.
chore: move mcp-related files to own directory
chore: rename librechat-mcp to librechat-api
WIP: first pass, memory processing and data schemas
chore: linting in fileSearch.js query description
chore: rename librechat-api to @librechat/api across the project
WIP: first pass, functional memory agent
feat: add MemoryEditDialog and MemoryViewer components for managing user memories
- Introduced MemoryEditDialog for editing memory entries with validation and toast notifications.
- Updated MemoryViewer to support editing and deleting memories, including pagination and loading states.
- Enhanced data provider to handle memory updates with optional original key for better management.
- Added new localization strings for memory-related UI elements.
feat: add memory permissions management
- Implemented memory permissions in the backend, allowing roles to have specific permissions for using, creating, updating, and reading memories.
- Added new API endpoints for updating memory permissions associated with roles.
- Created a new AdminSettings component for managing memory permissions in the frontend.
- Integrated memory permissions into the existing roles and permissions schemas.
- Updated the interface to include memory settings and permissions.
- Enhanced the MemoryViewer component to conditionally render admin settings based on user roles.
- Added localization support for memory permissions in the translation files.
feat: move AdminSettings component to a new position in MemoryViewer for better visibility
refactor: clean up commented code in MemoryViewer component
feat: enhance MemoryViewer with search functionality and improve MemoryEditDialog integration
- Added a search input to filter memories in the MemoryViewer component.
- Refactored MemoryEditDialog to accept children for better customization.
- Updated MemoryViewer to utilize the new EditMemoryButton and DeleteMemoryButton components for editing and deleting memories.
- Improved localization support by adding new strings for memory filtering and deletion confirmation.
refactor: optimize memory filtering in MemoryViewer using match-sorter
- Replaced manual filtering logic with match-sorter for improved search functionality.
- Enhanced performance and readability of the filteredMemories computation.
feat: enhance MemoryEditDialog with triggerRef and improve updateMemory mutation handling
feat: implement access control for MemoryEditDialog and MemoryViewer components
refactor: remove commented out code and create runMemory method
refactor: rename role based files
feat: implement access control for memory usage in AgentClient
refactor: simplify checkVisionRequest method in AgentClient by removing commented-out code
refactor: make `agents` dir in api package
refactor: migrate Azure utilities to TypeScript and consolidate imports
refactor: move sanitizeFilename function to a new file and update imports, add related tests
refactor: update LLM configuration types and consolidate Azure options in the API package
chore: linting
chore: import order
refactor: replace getLLMConfig with getOpenAIConfig and remove unused LLM configuration file
chore: update winston-daily-rotate-file to version 5.0.0 and add object-hash dependency in package-lock.json
refactor: move primeResources and optionalChainWithEmptyCheck functions to resources.ts and update imports
refactor: move createRun function to a new run.ts file and update related imports
fix: ensure safeAttachments is correctly typed as an array of TFile
chore: add node-fetch dependency and refactor fetch-related functions into packages/api/utils, removing the old generators file
refactor: enhance TEndpointOption type by using Pick to streamline endpoint fields and add new properties for model parameters and client options
feat: implement initializeOpenAIOptions function and update OpenAI types for enhanced configuration handling
fix: update types due to new TEndpointOption typing
fix: ensure safe access to group parameters in initializeOpenAIOptions function
fix: remove redundant API key validation comment in initializeOpenAIOptions function
refactor: rename initializeOpenAIOptions to initializeOpenAI for consistency and update related documentation
refactor: decouple req.body fields and tool loading from initializeAgentOptions
chore: linting
refactor: adjust column widths in MemoryViewer for improved layout
refactor: simplify agent initialization by creating loadAgent function and removing unused code
feat: add memory configuration loading and validation functions
WIP: first pass, memory processing with config
feat: implement memory callback and artifact handling
feat: implement memory artifacts display and processing updates
feat: add memory configuration options and schema validation for validKeys
fix: update MemoryEditDialog and MemoryViewer to handle memory state and display improvements
refactor: remove padding from BookmarkTable and MemoryViewer headers for consistent styling
WIP: initial tokenLimit config and move Tokenizer to @librechat/api
refactor: update mongoMeili plugin methods to use callback for better error handling
feat: enhance memory management with token tracking and usage metrics
- Added token counting for memory entries to enforce limits and provide usage statistics.
- Updated memory retrieval and update routes to include total token usage and limit.
- Enhanced MemoryEditDialog and MemoryViewer components to display memory usage and token information.
- Refactored memory processing functions to handle token limits and provide feedback on memory capacity.
feat: implement memory artifact handling in attachment handler
- Enhanced useAttachmentHandler to process memory artifacts when receiving updates.
- Introduced handleMemoryArtifact utility to manage memory updates and deletions.
- Updated query client to reflect changes in memory state based on incoming data.
refactor: restructure web search key extraction logic
- Moved the logic for extracting API keys from the webSearchAuth configuration into a dedicated function, getWebSearchKeys.
- Updated webSearchKeys to utilize the new function for improved clarity and maintainability.
- Prevents build time errors
feat: add personalization settings and memory preferences management
- Introduced a new Personalization tab in settings to manage user memory preferences.
- Implemented API endpoints and client-side logic for updating memory preferences.
- Enhanced user interface components to reflect personalization options and memory usage.
- Updated permissions to allow users to opt out of memory features.
- Added localization support for new settings and messages related to personalization.
style: personalization switch class
feat: add PersonalizationIcon and align Side Panel UI
feat: implement memory creation functionality
- Added a new API endpoint for creating memory entries, including validation for key and value.
- Introduced MemoryCreateDialog component for user interface to facilitate memory creation.
- Integrated token limit checks to prevent exceeding user memory capacity.
- Updated MemoryViewer to include a button for opening the memory creation dialog.
- Enhanced localization support for new messages related to memory creation.
feat: enhance message processing with configurable window size
- Updated AgentClient to use a configurable message window size for processing messages.
- Introduced messageWindowSize option in memory configuration schema with a default value of 5.
- Improved logic for selecting messages to process based on the configured window size.
chore: update librechat-data-provider version to 0.7.87 in package.json and package-lock.json
chore: remove OpenAPIPlugin and its associated tests
chore: remove MIGRATION_README.md as migration tasks are completed
ci: fix backend tests
chore: remove unused translation keys from localization file
chore: remove problematic test file and unused var in AgentClient
chore: remove unused import and import directly for JSDoc
* feat: add api package build stage in Dockerfile for improved modularity
* docs: reorder build steps in contributing guide for clarity
200 lines
5.5 KiB
JavaScript
200 lines
5.5 KiB
JavaScript
const OpenAI = require('openai');
|
|
const { HttpsProxyAgent } = require('https-proxy-agent');
|
|
const { constructAzureURL, isUserProvided } = require('@librechat/api');
|
|
const {
|
|
ErrorTypes,
|
|
EModelEndpoint,
|
|
resolveHeaders,
|
|
mapModelToAzureConfig,
|
|
} = require('librechat-data-provider');
|
|
const {
|
|
getUserKeyValues,
|
|
getUserKeyExpiry,
|
|
checkUserKeyExpiry,
|
|
} = require('~/server/services/UserService');
|
|
const OpenAIClient = require('~/app/clients/OpenAIClient');
|
|
|
|
class Files {
|
|
constructor(client) {
|
|
this._client = client;
|
|
}
|
|
/**
|
|
* Create an assistant file by attaching a
|
|
* [File](https://platform.openai.com/docs/api-reference/files) to an
|
|
* [assistant](https://platform.openai.com/docs/api-reference/assistants).
|
|
*/
|
|
create(assistantId, body, options) {
|
|
return this._client.post(`/assistants/${assistantId}/files`, {
|
|
body,
|
|
...options,
|
|
headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Retrieves an AssistantFile.
|
|
*/
|
|
retrieve(assistantId, fileId, options) {
|
|
return this._client.get(`/assistants/${assistantId}/files/${fileId}`, {
|
|
...options,
|
|
headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Delete an assistant file.
|
|
*/
|
|
del(assistantId, fileId, options) {
|
|
return this._client.delete(`/assistants/${assistantId}/files/${fileId}`, {
|
|
...options,
|
|
headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
|
|
});
|
|
}
|
|
}
|
|
|
|
const initializeClient = async ({ req, res, version, endpointOption, initAppClient = false }) => {
|
|
const { PROXY, OPENAI_ORGANIZATION, AZURE_ASSISTANTS_API_KEY, AZURE_ASSISTANTS_BASE_URL } =
|
|
process.env;
|
|
|
|
const userProvidesKey = isUserProvided(AZURE_ASSISTANTS_API_KEY);
|
|
const userProvidesURL = isUserProvided(AZURE_ASSISTANTS_BASE_URL);
|
|
|
|
let userValues = null;
|
|
if (userProvidesKey || userProvidesURL) {
|
|
const expiresAt = await getUserKeyExpiry({
|
|
userId: req.user.id,
|
|
name: EModelEndpoint.azureAssistants,
|
|
});
|
|
checkUserKeyExpiry(expiresAt, EModelEndpoint.azureAssistants);
|
|
userValues = await getUserKeyValues({
|
|
userId: req.user.id,
|
|
name: EModelEndpoint.azureAssistants,
|
|
});
|
|
}
|
|
|
|
let apiKey = userProvidesKey ? userValues.apiKey : AZURE_ASSISTANTS_API_KEY;
|
|
let baseURL = userProvidesURL ? userValues.baseURL : AZURE_ASSISTANTS_BASE_URL;
|
|
|
|
const opts = {};
|
|
|
|
const clientOptions = {
|
|
reverseProxyUrl: baseURL ?? null,
|
|
proxy: PROXY ?? null,
|
|
req,
|
|
res,
|
|
...endpointOption,
|
|
};
|
|
|
|
/** @type {TAzureConfig | undefined} */
|
|
const azureConfig = req.app.locals[EModelEndpoint.azureOpenAI];
|
|
|
|
/** @type {AzureOptions | undefined} */
|
|
let azureOptions;
|
|
|
|
if (azureConfig && azureConfig.assistants) {
|
|
const { modelGroupMap, groupMap, assistantModels } = azureConfig;
|
|
const modelName = req.body.model ?? req.query.model ?? assistantModels[0];
|
|
const {
|
|
azureOptions: currentOptions,
|
|
baseURL: azureBaseURL,
|
|
headers = {},
|
|
serverless,
|
|
} = mapModelToAzureConfig({
|
|
modelName,
|
|
modelGroupMap,
|
|
groupMap,
|
|
});
|
|
|
|
azureOptions = currentOptions;
|
|
|
|
baseURL = constructAzureURL({
|
|
baseURL: azureBaseURL ?? 'https://${INSTANCE_NAME}.openai.azure.com/openai',
|
|
azureOptions,
|
|
});
|
|
|
|
apiKey = azureOptions.azureOpenAIApiKey;
|
|
opts.defaultQuery = { 'api-version': azureOptions.azureOpenAIApiVersion };
|
|
opts.defaultHeaders = resolveHeaders({
|
|
...headers,
|
|
'api-key': apiKey,
|
|
'OpenAI-Beta': `assistants=${version}`,
|
|
});
|
|
opts.model = azureOptions.azureOpenAIApiDeploymentName;
|
|
|
|
if (initAppClient) {
|
|
clientOptions.titleConvo = azureConfig.titleConvo;
|
|
clientOptions.titleModel = azureConfig.titleModel;
|
|
clientOptions.titleMethod = azureConfig.titleMethod ?? 'completion';
|
|
|
|
const groupName = modelGroupMap[modelName].group;
|
|
clientOptions.addParams = azureConfig.groupMap[groupName].addParams;
|
|
clientOptions.dropParams = azureConfig.groupMap[groupName].dropParams;
|
|
clientOptions.forcePrompt = azureConfig.groupMap[groupName].forcePrompt;
|
|
|
|
clientOptions.reverseProxyUrl = baseURL ?? clientOptions.reverseProxyUrl;
|
|
clientOptions.headers = opts.defaultHeaders;
|
|
clientOptions.azure = !serverless && azureOptions;
|
|
if (serverless === true) {
|
|
clientOptions.defaultQuery = azureOptions.azureOpenAIApiVersion
|
|
? { 'api-version': azureOptions.azureOpenAIApiVersion }
|
|
: undefined;
|
|
clientOptions.headers['api-key'] = apiKey;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (userProvidesKey & !apiKey) {
|
|
throw new Error(
|
|
JSON.stringify({
|
|
type: ErrorTypes.NO_USER_KEY,
|
|
}),
|
|
);
|
|
}
|
|
|
|
if (!apiKey) {
|
|
throw new Error('Assistants API key not provided. Please provide it again.');
|
|
}
|
|
|
|
if (baseURL) {
|
|
opts.baseURL = baseURL;
|
|
}
|
|
|
|
if (PROXY) {
|
|
opts.httpAgent = new HttpsProxyAgent(PROXY);
|
|
}
|
|
|
|
if (OPENAI_ORGANIZATION) {
|
|
opts.organization = OPENAI_ORGANIZATION;
|
|
}
|
|
|
|
/** @type {OpenAIClient} */
|
|
const openai = new OpenAI({
|
|
apiKey,
|
|
...opts,
|
|
});
|
|
|
|
openai.beta.assistants.files = new Files(openai);
|
|
|
|
openai.req = req;
|
|
openai.res = res;
|
|
|
|
if (azureOptions) {
|
|
openai.locals = { ...(openai.locals ?? {}), azureOptions };
|
|
}
|
|
|
|
if (endpointOption && initAppClient) {
|
|
const client = new OpenAIClient(apiKey, clientOptions);
|
|
return {
|
|
client,
|
|
openai,
|
|
openAIApiKey: apiKey,
|
|
};
|
|
}
|
|
|
|
return {
|
|
openai,
|
|
openAIApiKey: apiKey,
|
|
};
|
|
};
|
|
|
|
module.exports = initializeClient;
|