mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-16 16:30:15 +01:00
* wip: first pass for azure endpoint schema * refactor: azure config to return groupMap and modelConfigMap * wip: naming and schema changes * refactor(errorsToString): move to data-provider * feat: rename to azureGroups, add additional tests, tests all expected outcomes, return errors * feat(AppService): load Azure groups * refactor(azure): use imported types, write `mapModelToAzureConfig` * refactor: move `extractEnvVariable` to data-provider * refactor(validateAzureGroups): throw on duplicate groups or models; feat(mapModelToAzureConfig): throw if env vars not present, add tests * refactor(AppService): ensure each model is properly configured on startup * refactor: deprecate azureOpenAI environment variables in favor of librechat.yaml config * feat: use helper functions to handle and order enabled/default endpoints; initialize azureOpenAI from config file * refactor: redefine types as well as load azureOpenAI models from config file * chore(ci): fix test description naming * feat(azureOpenAI): use validated model grouping for request authentication * chore: bump data-provider following rebase * chore: bump config file version noting significant changes * feat: add title options and switch azure configs for titling and vision requests * feat: enable azure plugins from config file * fix(ci): pass tests * chore(.env.example): mark `PLUGINS_USE_AZURE` as deprecated * fix(fetchModels): early return if apiKey not passed * chore: fix azure config typing * refactor(mapModelToAzureConfig): return baseURL and headers as well as azureOptions * feat(createLLM): use `azureOpenAIBasePath` * feat(parsers): resolveHeaders * refactor(extractBaseURL): handle invalid input * feat(OpenAIClient): handle headers and baseURL for azureConfig * fix(ci): pass `OpenAIClient` tests * chore: extract env var for azureOpenAI group config, baseURL * docs: azureOpenAI config setup docs * feat: safe check of potential conflicting env vars that map to unique placeholders * fix: reset apiKey when model switches from originally requested model (vision or title) * chore: linting * docs: CONFIG_PATH notes in custom_config.md
110 lines
3.6 KiB
JavaScript
110 lines
3.6 KiB
JavaScript
const {
|
|
EModelEndpoint,
|
|
CacheKeys,
|
|
extractEnvVariable,
|
|
envVarRegex,
|
|
} = require('librechat-data-provider');
|
|
const { getUserKey, checkUserKeyExpiry } = require('~/server/services/UserService');
|
|
const getCustomConfig = require('~/server/services/Config/getCustomConfig');
|
|
const { fetchModels } = require('~/server/services/ModelService');
|
|
const getLogStores = require('~/cache/getLogStores');
|
|
const { isUserProvided } = require('~/server/utils');
|
|
const { OpenAIClient } = require('~/app');
|
|
|
|
const { PROXY } = process.env;
|
|
|
|
const initializeClient = async ({ req, res, endpointOption }) => {
|
|
const { key: expiresAt, endpoint } = req.body;
|
|
const customConfig = await getCustomConfig();
|
|
if (!customConfig) {
|
|
throw new Error(`Config not found for the ${endpoint} custom endpoint.`);
|
|
}
|
|
|
|
const { endpoints = {} } = customConfig;
|
|
const customEndpoints = endpoints[EModelEndpoint.custom] ?? [];
|
|
const endpointConfig = customEndpoints.find((endpointConfig) => endpointConfig.name === endpoint);
|
|
|
|
const CUSTOM_API_KEY = extractEnvVariable(endpointConfig.apiKey);
|
|
const CUSTOM_BASE_URL = extractEnvVariable(endpointConfig.baseURL);
|
|
|
|
let resolvedHeaders = {};
|
|
if (endpointConfig.headers && typeof endpointConfig.headers === 'object') {
|
|
Object.keys(endpointConfig.headers).forEach((key) => {
|
|
resolvedHeaders[key] = extractEnvVariable(endpointConfig.headers[key]);
|
|
});
|
|
}
|
|
|
|
if (CUSTOM_API_KEY.match(envVarRegex)) {
|
|
throw new Error(`Missing API Key for ${endpoint}.`);
|
|
}
|
|
|
|
if (CUSTOM_BASE_URL.match(envVarRegex)) {
|
|
throw new Error(`Missing Base URL for ${endpoint}.`);
|
|
}
|
|
|
|
const cache = getLogStores(CacheKeys.TOKEN_CONFIG);
|
|
let endpointTokenConfig = await cache.get(endpoint);
|
|
if (endpointConfig && endpointConfig.models.fetch && !endpointTokenConfig) {
|
|
await fetchModels({ apiKey: CUSTOM_API_KEY, baseURL: CUSTOM_BASE_URL, name: endpoint });
|
|
endpointTokenConfig = await cache.get(endpoint);
|
|
}
|
|
|
|
const customOptions = {
|
|
headers: resolvedHeaders,
|
|
addParams: endpointConfig.addParams,
|
|
dropParams: endpointConfig.dropParams,
|
|
titleConvo: endpointConfig.titleConvo,
|
|
titleModel: endpointConfig.titleModel,
|
|
forcePrompt: endpointConfig.forcePrompt,
|
|
summaryModel: endpointConfig.summaryModel,
|
|
modelDisplayLabel: endpointConfig.modelDisplayLabel,
|
|
titleMethod: endpointConfig.titleMethod ?? 'completion',
|
|
contextStrategy: endpointConfig.summarize ? 'summarize' : null,
|
|
endpointTokenConfig,
|
|
};
|
|
|
|
const useUserKey = isUserProvided(CUSTOM_API_KEY);
|
|
const useUserURL = isUserProvided(CUSTOM_BASE_URL);
|
|
|
|
let userValues = null;
|
|
if (expiresAt && (useUserKey || useUserURL)) {
|
|
checkUserKeyExpiry(
|
|
expiresAt,
|
|
`Your API values for ${endpoint} have expired. Please configure them again.`,
|
|
);
|
|
userValues = await getUserKey({ userId: req.user.id, name: endpoint });
|
|
try {
|
|
userValues = JSON.parse(userValues);
|
|
} catch (e) {
|
|
throw new Error(`Invalid JSON provided for ${endpoint} user values.`);
|
|
}
|
|
}
|
|
|
|
let apiKey = useUserKey ? userValues.apiKey : CUSTOM_API_KEY;
|
|
let baseURL = useUserURL ? userValues.baseURL : CUSTOM_BASE_URL;
|
|
|
|
if (!apiKey) {
|
|
throw new Error(`${endpoint} API key not provided.`);
|
|
}
|
|
|
|
if (!baseURL) {
|
|
throw new Error(`${endpoint} Base URL not provided.`);
|
|
}
|
|
|
|
const clientOptions = {
|
|
reverseProxyUrl: baseURL ?? null,
|
|
proxy: PROXY ?? null,
|
|
req,
|
|
res,
|
|
...customOptions,
|
|
...endpointOption,
|
|
};
|
|
|
|
const client = new OpenAIClient(apiKey, clientOptions);
|
|
return {
|
|
client,
|
|
openAIApiKey: apiKey,
|
|
};
|
|
};
|
|
|
|
module.exports = initializeClient;
|