🤖 feat: OpenAI Assistants v2 (initial support) (#2781)
* 🤖 Assistants V2 Support: Part 1
- Separated Azure Assistants to its own endpoint
- File Search / Vector Store integration is incomplete, but can toggle and use storage from playground
- Code Interpreter resource files can be added but not deleted
- GPT-4o is supported
- Many improvements to the Assistants Endpoint overall
data-provider v2 changes
copy existing route as v1
chore: rename new endpoint to reduce comparison operations and add new azure filesource
api: add azureAssistants part 1
force use of version for assistants/assistantsAzure
chore: switch name back to azureAssistants
refactor type version: string | number
Ensure assistants endpoints have version set
fix: isArchived type issue in ConversationListParams
refactor: update assistants mutations/queries with endpoint/version definitions, update Assistants Map structure
chore: FilePreview component ExtendedFile type assertion
feat: isAssistantsEndpoint helper
chore: remove unused useGenerations
chore(buildTree): type issue
chore(Advanced): type issue (unused component, maybe in future)
first pass for multi-assistant endpoint rewrite
fix(listAssistants): pass params correctly
feat: list separate assistants by endpoint
fix(useTextarea): access assistantMap correctly
fix: assistant endpoint switching, resetting ID
fix: broken during rewrite, selecting assistant mention
fix: set/invalidate assistants endpoint query data correctly
feat: Fix issue with assistant ID not being reset correctly
getOpenAIClient helper function
feat: add toast for assistant deletion
fix: assistants delete right after create issue for azure
fix: assistant patching
refactor: actions to use getOpenAIClient
refactor: consolidate logic into helpers file
fix: issue where conversation data was not initially available
v1 chat support
refactor(spendTokens): only early return if completionTokens isNaN
fix(OpenAIClient): ensure spendTokens has all necessary params
refactor: route/controller logic
fix(assistants/initializeClient): use defaultHeaders field
fix: sanitize default operation id
chore: bump openai package
first pass v2 action service
feat: retroactive domain parsing for actions added via v1
feat: delete db records of actions/assistants on openai assistant deletion
chore: remove vision tools from v2 assistants
feat: v2 upload and delete assistant vision images
WIP first pass, thread attachments
fix: show assistant vision files (save local/firebase copy)
v2 image continue
fix: annotations
fix: refine annotations
show analyze as error if is no longer submitting before progress reaches 1 and show file_search as retrieval tool
fix: abort run, undefined endpoint issue
refactor: consolidate capabilities logic and anticipate versioning
frontend version 2 changes
fix: query selection and filter
add endpoint to unknown filepath
add file ids to resource, deleting in progress
enable/disable file search
remove version log
* 🤖 Assistants V2 Support: Part 2
🎹 fix: Autocompletion Chrome Bug on Action API Key Input
chore: remove `useOriginNavigate`
chore: set correct OpenAI Storage Source
fix: azure file deletions, instantiate clients by source for deletion
update code interpret files info
feat: deleteResourceFileId
chore: increase poll interval as azure easily rate limits
fix: openai file deletions, TODO: evaluate rejected deletion settled promises to determine which to delete from db records
file source icons
update table file filters
chore: file search info and versioning
fix: retrieval update with necessary tool_resources if specified
fix(useMentions): add optional chaining in case listMap value is undefined
fix: force assistant avatar roundedness
fix: azure assistants, check correct flag
chore: bump data-provider
* fix: merge conflict
* ci: fix backend tests due to new updates
* chore: update .env.example
* meilisearch improvements
* localization updates
* chore: update comparisons
* feat: add additional metadata: endpoint, author ID
* chore: azureAssistants ENDPOINTS exclusion warning
2024-05-19 12:56:55 -04:00
|
|
|
// const OpenAI = require('openai');
|
|
|
|
|
const { HttpsProxyAgent } = require('https-proxy-agent');
|
|
|
|
|
const { ErrorTypes } = require('librechat-data-provider');
|
|
|
|
|
const { getUserKey, getUserKeyExpiry, getUserKeyValues } = require('~/server/services/UserService');
|
2024-10-19 14:24:07 +02:00
|
|
|
const initializeClient = require('./initialize');
|
🤖 feat: OpenAI Assistants v2 (initial support) (#2781)
* 🤖 Assistants V2 Support: Part 1
- Separated Azure Assistants to its own endpoint
- File Search / Vector Store integration is incomplete, but can toggle and use storage from playground
- Code Interpreter resource files can be added but not deleted
- GPT-4o is supported
- Many improvements to the Assistants Endpoint overall
data-provider v2 changes
copy existing route as v1
chore: rename new endpoint to reduce comparison operations and add new azure filesource
api: add azureAssistants part 1
force use of version for assistants/assistantsAzure
chore: switch name back to azureAssistants
refactor type version: string | number
Ensure assistants endpoints have version set
fix: isArchived type issue in ConversationListParams
refactor: update assistants mutations/queries with endpoint/version definitions, update Assistants Map structure
chore: FilePreview component ExtendedFile type assertion
feat: isAssistantsEndpoint helper
chore: remove unused useGenerations
chore(buildTree): type issue
chore(Advanced): type issue (unused component, maybe in future)
first pass for multi-assistant endpoint rewrite
fix(listAssistants): pass params correctly
feat: list separate assistants by endpoint
fix(useTextarea): access assistantMap correctly
fix: assistant endpoint switching, resetting ID
fix: broken during rewrite, selecting assistant mention
fix: set/invalidate assistants endpoint query data correctly
feat: Fix issue with assistant ID not being reset correctly
getOpenAIClient helper function
feat: add toast for assistant deletion
fix: assistants delete right after create issue for azure
fix: assistant patching
refactor: actions to use getOpenAIClient
refactor: consolidate logic into helpers file
fix: issue where conversation data was not initially available
v1 chat support
refactor(spendTokens): only early return if completionTokens isNaN
fix(OpenAIClient): ensure spendTokens has all necessary params
refactor: route/controller logic
fix(assistants/initializeClient): use defaultHeaders field
fix: sanitize default operation id
chore: bump openai package
first pass v2 action service
feat: retroactive domain parsing for actions added via v1
feat: delete db records of actions/assistants on openai assistant deletion
chore: remove vision tools from v2 assistants
feat: v2 upload and delete assistant vision images
WIP first pass, thread attachments
fix: show assistant vision files (save local/firebase copy)
v2 image continue
fix: annotations
fix: refine annotations
show analyze as error if is no longer submitting before progress reaches 1 and show file_search as retrieval tool
fix: abort run, undefined endpoint issue
refactor: consolidate capabilities logic and anticipate versioning
frontend version 2 changes
fix: query selection and filter
add endpoint to unknown filepath
add file ids to resource, deleting in progress
enable/disable file search
remove version log
* 🤖 Assistants V2 Support: Part 2
🎹 fix: Autocompletion Chrome Bug on Action API Key Input
chore: remove `useOriginNavigate`
chore: set correct OpenAI Storage Source
fix: azure file deletions, instantiate clients by source for deletion
update code interpret files info
feat: deleteResourceFileId
chore: increase poll interval as azure easily rate limits
fix: openai file deletions, TODO: evaluate rejected deletion settled promises to determine which to delete from db records
file source icons
update table file filters
chore: file search info and versioning
fix: retrieval update with necessary tool_resources if specified
fix(useMentions): add optional chaining in case listMap value is undefined
fix: force assistant avatar roundedness
fix: azure assistants, check correct flag
chore: bump data-provider
* fix: merge conflict
* ci: fix backend tests due to new updates
* chore: update .env.example
* meilisearch improvements
* localization updates
* chore: update comparisons
* feat: add additional metadata: endpoint, author ID
* chore: azureAssistants ENDPOINTS exclusion warning
2024-05-19 12:56:55 -04:00
|
|
|
// const { OpenAIClient } = require('~/app');
|
|
|
|
|
|
|
|
|
|
jest.mock('~/server/services/UserService', () => ({
|
|
|
|
|
getUserKey: jest.fn(),
|
|
|
|
|
getUserKeyExpiry: jest.fn(),
|
|
|
|
|
getUserKeyValues: jest.fn(),
|
|
|
|
|
checkUserKeyExpiry: jest.requireActual('~/server/services/UserService').checkUserKeyExpiry,
|
|
|
|
|
}));
|
|
|
|
|
|
|
|
|
|
const today = new Date();
|
|
|
|
|
const tenDaysFromToday = new Date(today.setDate(today.getDate() + 10));
|
|
|
|
|
const isoString = tenDaysFromToday.toISOString();
|
|
|
|
|
|
|
|
|
|
describe('initializeClient', () => {
|
|
|
|
|
// Set up environment variables
|
|
|
|
|
const originalEnvironment = process.env;
|
|
|
|
|
const app = {
|
|
|
|
|
locals: {},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
|
jest.resetModules(); // Clears the cache
|
|
|
|
|
process.env = { ...originalEnvironment }; // Make a copy
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterAll(() => {
|
|
|
|
|
process.env = originalEnvironment; // Restore original env vars
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
test('initializes OpenAI client with default API key and URL', async () => {
|
|
|
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'default-api-key';
|
|
|
|
|
process.env.AZURE_ASSISTANTS_BASE_URL = 'https://default.api.url';
|
|
|
|
|
|
|
|
|
|
// Assuming 'isUserProvided' to return false for this test case
|
|
|
|
|
jest.mock('~/server/utils', () => ({
|
|
|
|
|
isUserProvided: jest.fn().mockReturnValueOnce(false),
|
|
|
|
|
}));
|
|
|
|
|
|
|
|
|
|
const req = { user: { id: 'user123' }, app };
|
|
|
|
|
const res = {};
|
|
|
|
|
|
|
|
|
|
const { openai, openAIApiKey } = await initializeClient({ req, res });
|
|
|
|
|
expect(openai.apiKey).toBe('default-api-key');
|
|
|
|
|
expect(openAIApiKey).toBe('default-api-key');
|
|
|
|
|
expect(openai.baseURL).toBe('https://default.api.url');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
test('initializes OpenAI client with user-provided API key and URL', async () => {
|
|
|
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'user_provided';
|
|
|
|
|
process.env.AZURE_ASSISTANTS_BASE_URL = 'user_provided';
|
|
|
|
|
|
|
|
|
|
getUserKeyValues.mockResolvedValue({ apiKey: 'user-api-key', baseURL: 'https://user.api.url' });
|
|
|
|
|
getUserKeyExpiry.mockResolvedValue(isoString);
|
|
|
|
|
|
|
|
|
|
const req = { user: { id: 'user123' }, app };
|
|
|
|
|
const res = {};
|
|
|
|
|
|
|
|
|
|
const { openai, openAIApiKey } = await initializeClient({ req, res });
|
|
|
|
|
expect(openAIApiKey).toBe('user-api-key');
|
|
|
|
|
expect(openai.apiKey).toBe('user-api-key');
|
|
|
|
|
expect(openai.baseURL).toBe('https://user.api.url');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
test('throws error for invalid JSON in user-provided values', async () => {
|
|
|
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'user_provided';
|
|
|
|
|
getUserKey.mockResolvedValue('invalid-json');
|
|
|
|
|
getUserKeyExpiry.mockResolvedValue(isoString);
|
|
|
|
|
getUserKeyValues.mockImplementation(() => {
|
|
|
|
|
let userValues = getUserKey();
|
|
|
|
|
try {
|
|
|
|
|
userValues = JSON.parse(userValues);
|
|
|
|
|
} catch (e) {
|
|
|
|
|
throw new Error(
|
|
|
|
|
JSON.stringify({
|
|
|
|
|
type: ErrorTypes.INVALID_USER_KEY,
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
return userValues;
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const req = { user: { id: 'user123' } };
|
|
|
|
|
const res = {};
|
|
|
|
|
|
|
|
|
|
await expect(initializeClient({ req, res })).rejects.toThrow(/invalid_user_key/);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
test('throws error if API key is not provided', async () => {
|
|
|
|
|
delete process.env.AZURE_ASSISTANTS_API_KEY; // Simulate missing API key
|
|
|
|
|
|
|
|
|
|
const req = { user: { id: 'user123' }, app };
|
|
|
|
|
const res = {};
|
|
|
|
|
|
|
|
|
|
await expect(initializeClient({ req, res })).rejects.toThrow(/Assistants API key not/);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
test('initializes OpenAI client with proxy configuration', async () => {
|
|
|
|
|
process.env.AZURE_ASSISTANTS_API_KEY = 'test-key';
|
|
|
|
|
process.env.PROXY = 'http://proxy.server';
|
|
|
|
|
|
|
|
|
|
const req = { user: { id: 'user123' }, app };
|
|
|
|
|
const res = {};
|
|
|
|
|
|
|
|
|
|
const { openai } = await initializeClient({ req, res });
|
|
|
|
|
expect(openai.httpAgent).toBeInstanceOf(HttpsProxyAgent);
|
|
|
|
|
});
|
|
|
|
|
});
|