const { CacheKeys, SystemRoles, EModelEndpoint, defaultOrderQuery, defaultAssistantsVersion, } = require('librechat-data-provider'); const { initializeClient: initAzureClient, } = require('~/server/services/Endpoints/azureAssistants'); const { initializeClient } = require('~/server/services/Endpoints/assistants'); const { getLogStores } = require('~/cache'); /** * @param {Express.Request} req * @param {string} [endpoint] * @returns {Promise} */ const getCurrentVersion = async (req, endpoint) => { const index = req.baseUrl.lastIndexOf('/v'); let version = index !== -1 ? req.baseUrl.substring(index + 1, index + 3) : null; if (!version && req.body.version) { version = `v${req.body.version}`; } if (!version && endpoint) { const cache = getLogStores(CacheKeys.CONFIG_STORE); const cachedEndpointsConfig = await cache.get(CacheKeys.ENDPOINT_CONFIG); version = `v${ cachedEndpointsConfig?.[endpoint]?.version ?? defaultAssistantsVersion[endpoint] }`; } if (!version?.startsWith('v') && version.length !== 2) { throw new Error(`[${req.baseUrl}] Invalid version: ${version}`); } return version; }; /** * Asynchronously lists assistants based on provided query parameters. * * Initializes the client with the current request and response objects and lists assistants * according to the query parameters. This function abstracts the logic for non-Azure paths. * * @deprecated * @async * @param {object} params - The parameters object. * @param {object} params.req - The request object, used for initializing the client. * @param {object} params.res - The response object, used for initializing the client. * @param {string} params.version - The API version to use. * @param {object} params.query - The query parameters to list assistants (e.g., limit, order). * @returns {Promise} A promise that resolves to the response from the `openai.beta.assistants.list` method call. */ const _listAssistants = async ({ req, res, version, query }) => { const { openai } = await getOpenAIClient({ req, res, version }); return openai.beta.assistants.list(query); }; /** * Fetches all assistants based on provided query params, until `has_more` is `false`. * * @async * @param {object} params - The parameters object. * @param {object} params.req - The request object, used for initializing the client. * @param {object} params.res - The response object, used for initializing the client. * @param {string} params.version - The API version to use. * @param {Omit} params.query - The query parameters to list assistants (e.g., limit, order). * @returns {Promise>} A promise that resolves to the response from the `openai.beta.assistants.list` method call. */ const listAllAssistants = async ({ req, res, version, query }) => { /** @type {{ openai: OpenAIClient }} */ const { openai } = await getOpenAIClient({ req, res, version }); const allAssistants = []; let first_id; let last_id; let afterToken = query.after; let hasMore = true; while (hasMore) { const response = await openai.beta.assistants.list({ ...query, after: afterToken, }); const { body } = response; allAssistants.push(...body.data); hasMore = body.has_more; if (!first_id) { first_id = body.first_id; } if (hasMore) { afterToken = body.last_id; } else { last_id = body.last_id; } } return { data: allAssistants, body: { data: allAssistants, has_more: false, first_id, last_id, }, }; }; /** * Asynchronously lists assistants for Azure configured groups. * * Iterates through Azure configured assistant groups, initializes the client with the current request and response objects, * lists assistants based on the provided query parameters, and merges their data alongside the model information into a single array. * * @async * @param {object} params - The parameters object. * @param {object} params.req - The request object, used for initializing the client and manipulating the request body. * @param {object} params.res - The response object, used for initializing the client. * @param {string} params.version - The API version to use. * @param {TAzureConfig} params.azureConfig - The Azure configuration object containing assistantGroups and groupMap. * @param {object} params.query - The query parameters to list assistants (e.g., limit, order). * @returns {Promise} A promise that resolves to an array of assistant data merged with their respective model information. */ const listAssistantsForAzure = async ({ req, res, version, azureConfig = {}, query }) => { /** @type {Array<[string, TAzureModelConfig]>} */ const groupModelTuples = []; const promises = []; /** @type {Array} */ const groups = []; const { groupMap, assistantGroups } = azureConfig; for (const groupName of assistantGroups) { const group = groupMap[groupName]; groups.push(group); const currentModelTuples = Object.entries(group?.models); groupModelTuples.push(currentModelTuples); /* The specified model is only necessary to fetch assistants for the shared instance */ req.body.model = currentModelTuples[0][0]; promises.push(listAllAssistants({ req, res, version, query })); } const resolvedQueries = await Promise.all(promises); const data = resolvedQueries.flatMap((res, i) => res.data.map((assistant) => { const deploymentName = assistant.model; const currentGroup = groups[i]; const currentModelTuples = groupModelTuples[i]; const firstModel = currentModelTuples[0][0]; if (currentGroup.deploymentName === deploymentName) { return { ...assistant, model: firstModel }; } for (const [model, modelConfig] of currentModelTuples) { if (modelConfig.deploymentName === deploymentName) { return { ...assistant, model }; } } return { ...assistant, model: firstModel }; }), ); return { first_id: data[0]?.id, last_id: data[data.length - 1]?.id, object: 'list', has_more: false, data, }; }; async function getOpenAIClient({ req, res, endpointOption, initAppClient, overrideEndpoint }) { let endpoint = overrideEndpoint ?? req.body.endpoint ?? req.query.endpoint; const version = await getCurrentVersion(req, endpoint); if (!endpoint) { throw new Error(`[${req.baseUrl}] Endpoint is required`); } let result; if (endpoint === EModelEndpoint.assistants) { result = await initializeClient({ req, res, version, endpointOption, initAppClient }); } else if (endpoint === EModelEndpoint.azureAssistants) { result = await initAzureClient({ req, res, version, endpointOption, initAppClient }); } return result; } /** * Returns a list of assistants. * @param {object} params * @param {object} params.req - Express Request * @param {AssistantListParams} [params.req.query] - The assistant list parameters for pagination and sorting. * @param {object} params.res - Express Response * @param {string} [params.overrideEndpoint] - The endpoint to override the request endpoint. * @returns {Promise} 200 - success response - application/json */ const fetchAssistants = async ({ req, res, overrideEndpoint }) => { const { limit = 100, order = 'desc', after, before, endpoint, } = req.query ?? { endpoint: overrideEndpoint, ...defaultOrderQuery, }; const version = await getCurrentVersion(req, endpoint); const query = { limit, order, after, before }; /** @type {AssistantListResponse} */ let body; if (endpoint === EModelEndpoint.assistants) { ({ body } = await listAllAssistants({ req, res, version, query })); } else if (endpoint === EModelEndpoint.azureAssistants) { const azureConfig = req.app.locals[EModelEndpoint.azureOpenAI]; body = await listAssistantsForAzure({ req, res, version, azureConfig, query }); } if (req.user.role === SystemRoles.ADMIN) { return body; } else if (!req.app.locals[endpoint]) { return body; } body.data = filterAssistants({ userId: req.user.id, assistants: body.data, assistantsConfig: req.app.locals[endpoint], }); return body; }; /** * Filter assistants based on configuration. * * @param {object} params - The parameters object. * @param {string} params.userId - The user ID to filter private assistants. * @param {Assistant[]} params.assistants - The list of assistants to filter. * @param {Partial} params.assistantsConfig - The assistant configuration. * @returns {Assistant[]} - The filtered list of assistants. */ function filterAssistants({ assistants, userId, assistantsConfig }) { const { supportedIds, excludedIds, privateAssistants } = assistantsConfig; if (privateAssistants) { return assistants.filter((assistant) => userId === assistant.metadata?.author); } else if (supportedIds?.length) { return assistants.filter((assistant) => supportedIds.includes(assistant.id)); } else if (excludedIds?.length) { return assistants.filter((assistant) => !excludedIds.includes(assistant.id)); } return assistants; } module.exports = { getOpenAIClient, fetchAssistants, getCurrentVersion, };