LibreChat/packages/data-provider/src/models.ts
Peter Nancarrow e9a85d5c65
🗂️ feat: Add Optional Group Field to ModelSpecs Configuration (#9996)
* feat: Add group field to modelSpecs for flexible grouping

* resolve lint issues

* fix test

* docs: enhance modelSpecs group field documentation for clarity

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2025-10-11 07:55:06 -04:00

52 lines
1.6 KiB
TypeScript

import { z } from 'zod';
import type { TPreset } from './schemas';
import {
EModelEndpoint,
tPresetSchema,
eModelEndpointSchema,
AuthType,
authTypeSchema,
} from './schemas';
export type TModelSpec = {
name: string;
label: string;
preset: TPreset;
order?: number;
default?: boolean;
description?: string;
/**
* Optional group name for organizing specs in the UI selector.
* - If it matches an endpoint name (e.g., "openAI", "groq"), the spec appears nested under that endpoint
* - If it's a custom name (doesn't match any endpoint), it creates a separate collapsible group
* - If omitted, the spec appears as a standalone item at the top level
*/
group?: string;
showIconInMenu?: boolean;
showIconInHeader?: boolean;
iconURL?: string | EModelEndpoint; // Allow using project-included icons
authType?: AuthType;
};
export const tModelSpecSchema = z.object({
name: z.string(),
label: z.string(),
preset: tPresetSchema,
order: z.number().optional(),
default: z.boolean().optional(),
description: z.string().optional(),
group: z.string().optional(),
showIconInMenu: z.boolean().optional(),
showIconInHeader: z.boolean().optional(),
iconURL: z.union([z.string(), eModelEndpointSchema]).optional(),
authType: authTypeSchema.optional(),
});
export const specsConfigSchema = z.object({
enforce: z.boolean().default(false),
prioritize: z.boolean().default(true),
list: z.array(tModelSpecSchema).min(1),
addedEndpoints: z.array(z.union([z.string(), eModelEndpointSchema])).optional(),
});
export type TSpecsConfig = z.infer<typeof specsConfigSchema>;