mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-16 08:20:14 +01:00
* refactor: move endpoint initialization methods to typescript * refactor: move agent init to packages/api - Introduced `initialize.ts` for agent initialization, including file processing and tool loading. - Updated `resources.ts` to allow optional appConfig parameter. - Enhanced endpoint configuration handling in various initialization files to support model parameters. - Added new artifacts and prompts for React component generation. - Refactored existing code to improve type safety and maintainability. * refactor: streamline endpoint initialization and enhance type safety - Updated initialization functions across various endpoints to use a consistent request structure, replacing `unknown` types with `ServerResponse`. - Simplified request handling by directly extracting keys from the request body. - Improved type safety by ensuring user IDs are safely accessed with optional chaining. - Removed unnecessary parameters and streamlined model options handling for better clarity and maintainability. * refactor: moved ModelService and extractBaseURL to packages/api - Added comprehensive tests for the models fetching functionality, covering scenarios for OpenAI, Anthropic, Google, and Ollama models. - Updated existing endpoint index to include the new models module. - Enhanced utility functions for URL extraction and model data processing. - Improved type safety and error handling across the models fetching logic. * refactor: consolidate utility functions and remove unused files - Merged `deriveBaseURL` and `extractBaseURL` into the `@librechat/api` module for better organization. - Removed redundant utility files and their associated tests to streamline the codebase. - Updated imports across various client files to utilize the new consolidated functions. - Enhanced overall maintainability by reducing the number of utility modules. * refactor: replace ModelService references with direct imports from @librechat/api and remove ModelService file * refactor: move encrypt/decrypt methods and key db methods to data-schemas, use `getProviderConfig` from `@librechat/api` * chore: remove unused 'res' from options in AgentClient * refactor: file model imports and methods - Updated imports in various controllers and services to use the unified file model from '~/models' instead of '~/models/File'. - Consolidated file-related methods into a new file methods module in the data-schemas package. - Added comprehensive tests for file methods including creation, retrieval, updating, and deletion. - Enhanced the initializeAgent function to accept dependency injection for file-related methods. - Improved error handling and logging in file methods. * refactor: streamline database method references in agent initialization * refactor: enhance file method tests and update type references to IMongoFile * refactor: consolidate database method imports in agent client and initialization * chore: remove redundant import of initializeAgent from @librechat/api * refactor: move checkUserKeyExpiry utility to @librechat/api and update references across endpoints * refactor: move updateUserPlugins logic to user.ts and simplify UserController * refactor: update imports for user key management and remove UserService * refactor: remove unused Anthropics and Bedrock endpoint files and clean up imports * refactor: consolidate and update encryption imports across various files to use @librechat/data-schemas * chore: update file model mock to use unified import from '~/models' * chore: import order * refactor: remove migrated to TS agent.js file and its associated logic from the endpoints * chore: add reusable function to extract imports from source code in unused-packages workflow * chore: enhance unused-packages workflow to include @librechat/api dependencies and improve dependency extraction * chore: improve dependency extraction in unused-packages workflow with enhanced error handling and debugging output * chore: add detailed debugging output to unused-packages workflow for better visibility into unused dependencies and exclusion lists * chore: refine subpath handling in unused-packages workflow to correctly process scoped and non-scoped package imports * chore: clean up unused debug output in unused-packages workflow and reorganize type imports in initialize.ts
193 lines
5.3 KiB
JavaScript
193 lines
5.3 KiB
JavaScript
const OpenAI = require('openai');
|
|
const { ProxyAgent } = require('undici');
|
|
const {
|
|
isUserProvided,
|
|
resolveHeaders,
|
|
constructAzureURL,
|
|
checkUserKeyExpiry,
|
|
} = require('@librechat/api');
|
|
const { ErrorTypes, EModelEndpoint, mapModelToAzureConfig } = require('librechat-data-provider');
|
|
const { getUserKeyValues, getUserKeyExpiry } = require('~/models');
|
|
|
|
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 };
|
|
}
|
|
|
|
return {
|
|
openai,
|
|
openAIApiKey: apiKey,
|
|
};
|
|
};
|
|
|
|
module.exports = initializeClient;
|