mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-16 16:30:15 +01:00
* WIP: app.locals refactoring
WIP: appConfig
fix: update memory configuration retrieval to use getAppConfig based on user role
fix: update comment for AppConfig interface to clarify purpose
🏷️ refactor: Update tests to use getAppConfig for endpoint configurations
ci: Update AppService tests to initialize app config instead of app.locals
ci: Integrate getAppConfig into remaining tests
refactor: Update multer storage destination to use promise-based getAppConfig and improve error handling in tests
refactor: Rename initializeAppConfig to setAppConfig and update related tests
ci: Mock getAppConfig in various tests to provide default configurations
refactor: Update convertMCPToolsToPlugins to use mcpManager for server configuration and adjust related tests
chore: rename `Config/getAppConfig` -> `Config/app`
fix: streamline OpenAI image tools configuration by removing direct appConfig dependency and using function parameters
chore: correct parameter documentation for imageOutputType in ToolService.js
refactor: remove `getCustomConfig` dependency in config route
refactor: update domain validation to use appConfig for allowed domains
refactor: use appConfig registration property
chore: remove app parameter from AppService invocation
refactor: update AppConfig interface to correct registration and turnstile configurations
refactor: remove getCustomConfig dependency and use getAppConfig in PluginController, multer, and MCP services
refactor: replace getCustomConfig with getAppConfig in STTService, TTSService, and related files
refactor: replace getCustomConfig with getAppConfig in Conversation and Message models, update tempChatRetention functions to use AppConfig type
refactor: update getAppConfig calls in Conversation and Message models to include user role for temporary chat expiration
ci: update related tests
refactor: update getAppConfig call in getCustomConfigSpeech to include user role
fix: update appConfig usage to access allowedDomains from actions instead of registration
refactor: enhance AppConfig to include fileStrategies and update related file strategy logic
refactor: update imports to use normalizeEndpointName from @librechat/api and remove redundant definitions
chore: remove deprecated unused RunManager
refactor: get balance config primarily from appConfig
refactor: remove customConfig dependency for appConfig and streamline loadConfigModels logic
refactor: remove getCustomConfig usage and use app config in file citations
refactor: consolidate endpoint loading logic into loadEndpoints function
refactor: update appConfig access to use endpoints structure across various services
refactor: implement custom endpoints configuration and streamline endpoint loading logic
refactor: update getAppConfig call to include user role parameter
refactor: streamline endpoint configuration and enhance appConfig usage across services
refactor: replace getMCPAuthMap with getUserMCPAuthMap and remove unused getCustomConfig file
refactor: add type annotation for loadedEndpoints in loadEndpoints function
refactor: move /services/Files/images/parse to TS API
chore: add missing FILE_CITATIONS permission to IRole interface
refactor: restructure toolkits to TS API
refactor: separate manifest logic into its own module
refactor: consolidate tool loading logic into a new tools module for startup logic
refactor: move interface config logic to TS API
refactor: migrate checkEmailConfig to TypeScript and update imports
refactor: add FunctionTool interface and availableTools to AppConfig
refactor: decouple caching and DB operations from AppService, make part of consolidated `getAppConfig`
WIP: fix tests
* fix: rebase conflicts
* refactor: remove app.locals references
* refactor: replace getBalanceConfig with getAppConfig in various strategies and middleware
* refactor: replace appConfig?.balance with getBalanceConfig in various controllers and clients
* test: add balance configuration to titleConvo method in AgentClient tests
* chore: remove unused `openai-chat-tokens` package
* chore: remove unused imports in initializeMCPs.js
* refactor: update balance configuration to use getAppConfig instead of getBalanceConfig
* refactor: integrate configMiddleware for centralized configuration handling
* refactor: optimize email domain validation by removing unnecessary async calls
* refactor: simplify multer storage configuration by removing async calls
* refactor: reorder imports for better readability in user.js
* refactor: replace getAppConfig calls with req.config for improved performance
* chore: replace getAppConfig calls with req.config in tests for centralized configuration handling
* chore: remove unused override config
* refactor: add configMiddleware to endpoint route and replace getAppConfig with req.config
* chore: remove customConfig parameter from TTSService constructor
* refactor: pass appConfig from request to processFileCitations for improved configuration handling
* refactor: remove configMiddleware from endpoint route and retrieve appConfig directly in getEndpointsConfig if not in `req.config`
* test: add mockAppConfig to processFileCitations tests for improved configuration handling
* fix: pass req.config to hasCustomUserVars and call without await after synchronous refactor
* fix: type safety in useExportConversation
* refactor: retrieve appConfig using getAppConfig in PluginController and remove configMiddleware from plugins route, to avoid always retrieving when plugins are cached
* chore: change `MongoUser` typedef to `IUser`
* fix: Add `user` and `config` fields to ServerRequest and update JSDoc type annotations from Express.Request to ServerRequest
* fix: remove unused setAppConfig mock from Server configuration tests
202 lines
5.6 KiB
JavaScript
202 lines
5.6 KiB
JavaScript
const OpenAI = require('openai');
|
|
const { ProxyAgent } = require('undici');
|
|
const { constructAzureURL, isUserProvided, resolveHeaders } = require('@librechat/api');
|
|
const { ErrorTypes, EModelEndpoint, mapModelToAzureConfig } = require('librechat-data-provider');
|
|
const {
|
|
checkUserKeyExpiry,
|
|
getUserKeyValues,
|
|
getUserKeyExpiry,
|
|
} = require('~/server/services/UserService');
|
|
const OAIClient = 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 appConfig = req.config;
|
|
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 = appConfig.endpoints?.[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: {
|
|
...headers,
|
|
'api-key': apiKey,
|
|
'OpenAI-Beta': `assistants=${version}`,
|
|
},
|
|
user: req.user,
|
|
});
|
|
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) {
|
|
const proxyAgent = new ProxyAgent(PROXY);
|
|
opts.fetchOptions = {
|
|
dispatcher: proxyAgent,
|
|
};
|
|
}
|
|
|
|
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 OAIClient(apiKey, clientOptions);
|
|
return {
|
|
client,
|
|
openai,
|
|
openAIApiKey: apiKey,
|
|
};
|
|
}
|
|
|
|
return {
|
|
openai,
|
|
openAIApiKey: apiKey,
|
|
};
|
|
};
|
|
|
|
module.exports = initializeClient;
|