🅰️ feat: Azure OpenAI Assistants API Support (#1992)

* chore: rename dir from `assistant` to plural

* feat: `assistants` field for azure config, spread options in AppService

* refactor: rename constructAzureURL param for azure as `azureOptions`

* chore: bump openai and bun

* chore(loadDefaultModels): change naming of assistant -> assistants

* feat: load azure settings with currect baseURL for assistants' initializeClient

* refactor: add `assistants` flags to groups and model configs, add mapGroupToAzureConfig

* feat(loadConfigEndpoints): initialize assistants endpoint if azure flag `assistants` is enabled

* feat(AppService): determine assistant models on startup, throw Error if none

* refactor(useDeleteAssistantMutation): send model along with assistant id for delete mutations

* feat: support listing and deleting assistants with azure

* feat: add model query to assistant avatar upload

* feat: add azure support for retrieveRun method

* refactor: update OpenAIClient initialization

* chore: update README

* fix(ci): tests passing

* refactor(uploadOpenAIFile): improve logging and use more efficient REST API method

* refactor(useFileHandling): add model to metadata to target Azure region compatible with current model

* chore(files): add azure naming pattern for valid file id recognition

* fix(assistants): initialize openai with first available assistant model if none provided

* refactor(uploadOpenAIFile): add content type for azure, initialize formdata before azure options

* refactor(sleep): move sleep function out of Runs and into `~/server/utils`

* fix(azureOpenAI/assistants): make sure to only overwrite models with assistant models if `assistants` flag is enabled

* refactor(uploadOpenAIFile): revert to old method

* chore(uploadOpenAIFile): use enum for file purpose

* docs: azureOpenAI update guide with more info, examples

* feat: enable/disable assistant capabilities and specify retrieval models

* refactor: optional chain conditional statement in loadConfigModels.js

* docs: add assistants examples

* chore: update librechat.example.yaml

* docs(azure): update note of file upload behavior in Azure OpenAI Assistants

* chore: update docs and add descriptive message about assistant errors

* fix: prevent message submission with invalid assistant or if files loading

* style: update Landing icon & text when assistant is not selected

* chore: bump librechat-data-provider to 0.4.8

* fix(assistants/azure): assign req.body.model for proper azure init to abort runs
This commit is contained in:
Danny Avila 2024-03-14 17:21:42 -04:00 committed by GitHub
parent 1b243c6f8c
commit 5cd5c3bef8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
60 changed files with 1044 additions and 300 deletions

View file

@ -1,5 +1,5 @@
import type { TAzureGroups } from '../src/config';
import { validateAzureGroups, mapModelToAzureConfig } from '../src/azure';
import { validateAzureGroups, mapModelToAzureConfig, mapGroupToAzureConfig } from '../src/azure';
describe('validateAzureGroups', () => {
it('should validate a correct configuration', () => {
@ -785,3 +785,57 @@ describe('validateAzureGroups with modelGroupMap and groupMap', () => {
});
});
});
describe('mapGroupToAzureConfig', () => {
// Test setup for a basic config with 2 groups
const groupMap = {
group1: {
apiKey: 'key-for-group1',
instanceName: 'instance-group1',
models: {
model1: { deploymentName: 'deployment1', version: '1.0' },
},
},
group2: {
apiKey: 'key-for-group2',
instanceName: 'instance-group2',
serverless: true,
baseURL: 'https://group2.example.com',
models: {
model2: true, // demonstrating a boolean style model configuration
},
},
};
it('should successfully map non-serverless group configuration', () => {
const groupName = 'group1';
const result = mapGroupToAzureConfig({ groupName, groupMap });
expect(result).toEqual({
azureOptions: expect.objectContaining({
azureOpenAIApiKey: 'key-for-group1',
azureOpenAIApiInstanceName: 'instance-group1',
azureOpenAIApiDeploymentName: expect.any(String),
azureOpenAIApiVersion: expect.any(String),
}),
});
});
it('should successfully map serverless group configuration', () => {
const groupName = 'group2';
const result = mapGroupToAzureConfig({ groupName, groupMap });
expect(result).toEqual({
azureOptions: expect.objectContaining({
azureOpenAIApiKey: 'key-for-group2',
}),
baseURL: 'https://group2.example.com',
serverless: true,
});
});
it('should throw error for nonexistent group name', () => {
const groupName = 'nonexistent-group';
expect(() => {
mapGroupToAzureConfig({ groupName, groupMap });
}).toThrow(`Group named "${groupName}" not found in configuration.`);
});
});