feat: Add support for builtin models in the application
- Introduced `is_builtin` property in the model configuration to identify builtin models. - Updated frontend components to display a tag for builtin models in the ModelSelector and ModelSettings. - Enhanced the ModelEditorDialog to prevent editing and deletion of builtin models. - Implemented logic in the backend to hide sensitive information for builtin models and restrict their modification. - Added informative UI elements to clarify the nature of builtin models in the settings and editor views.
This commit is contained in:
@@ -28,7 +28,7 @@ func (r *modelRepository) Create(ctx context.Context, m *types.Model) error {
|
||||
func (r *modelRepository) GetByID(ctx context.Context, tenantID uint, id string) (*types.Model, error) {
|
||||
var m types.Model
|
||||
if err := r.db.WithContext(ctx).Where("id = ?", id).Where(
|
||||
"tenant_id = ? or tenant_id = 0", tenantID,
|
||||
"tenant_id = ? OR is_builtin = true", tenantID,
|
||||
).First(&m).Error; err != nil {
|
||||
if errors.Is(err, gorm.ErrRecordNotFound) {
|
||||
return nil, nil
|
||||
@@ -44,7 +44,7 @@ func (r *modelRepository) List(
|
||||
) ([]*types.Model, error) {
|
||||
var models []*types.Model
|
||||
query := r.db.WithContext(ctx).Where(
|
||||
"tenant_id = ? or tenant_id = 0", tenantID,
|
||||
"tenant_id = ? OR is_builtin = true", tenantID,
|
||||
)
|
||||
|
||||
if modelType != "" {
|
||||
|
||||
@@ -178,6 +178,20 @@ func (s *modelService) UpdateModel(ctx context.Context, model *types.Model) erro
|
||||
logger.Info(ctx, "Start updating model")
|
||||
logger.Infof(ctx, "Updating model ID: %s, name: %s", model.ID, model.Name)
|
||||
|
||||
// Check if the model is builtin - builtin models cannot be updated
|
||||
tenantID := ctx.Value(types.TenantIDContextKey).(uint)
|
||||
existingModel, err := s.repo.GetByID(ctx, tenantID, model.ID)
|
||||
if err != nil {
|
||||
logger.ErrorWithFields(ctx, err, map[string]interface{}{
|
||||
"model_id": model.ID,
|
||||
})
|
||||
return err
|
||||
}
|
||||
if existingModel != nil && existingModel.IsBuiltin {
|
||||
logger.Warnf(ctx, "Attempted to update builtin model: %s", model.ID)
|
||||
return errors.New("builtin models cannot be updated")
|
||||
}
|
||||
|
||||
// If this model is set as default, unset other default models of the same type
|
||||
if model.IsDefault {
|
||||
logger.Infof(ctx, "Model is set as default, clearing other default models of type: %s", model.Type)
|
||||
@@ -192,7 +206,7 @@ func (s *modelService) UpdateModel(ctx context.Context, model *types.Model) erro
|
||||
}
|
||||
|
||||
// Update model in repository
|
||||
err := s.repo.Update(ctx, model)
|
||||
err = s.repo.Update(ctx, model)
|
||||
if err != nil {
|
||||
logger.ErrorWithFields(ctx, err, map[string]interface{}{
|
||||
"model_id": model.ID,
|
||||
@@ -213,8 +227,21 @@ func (s *modelService) DeleteModel(ctx context.Context, id string) error {
|
||||
tenantID := ctx.Value(types.TenantIDContextKey).(uint)
|
||||
logger.Infof(ctx, "Tenant ID: %d", tenantID)
|
||||
|
||||
// Check if the model is builtin - builtin models cannot be deleted
|
||||
existingModel, err := s.repo.GetByID(ctx, tenantID, id)
|
||||
if err != nil {
|
||||
logger.ErrorWithFields(ctx, err, map[string]interface{}{
|
||||
"model_id": id,
|
||||
})
|
||||
return err
|
||||
}
|
||||
if existingModel != nil && existingModel.IsBuiltin {
|
||||
logger.Warnf(ctx, "Attempted to delete builtin model: %s", id)
|
||||
return errors.New("builtin models cannot be deleted")
|
||||
}
|
||||
|
||||
// Delete model from repository
|
||||
err := s.repo.Delete(ctx, tenantID, id)
|
||||
err = s.repo.Delete(ctx, tenantID, id)
|
||||
if err != nil {
|
||||
logger.ErrorWithFields(ctx, err, map[string]interface{}{
|
||||
"model_id": id,
|
||||
|
||||
@@ -1155,28 +1155,36 @@ func (h *InitializationHandler) buildConfigResponse(ctx context.Context, models
|
||||
|
||||
// 按类型分组模型
|
||||
for _, model := range models {
|
||||
// Hide sensitive information for builtin models
|
||||
baseURL := model.Parameters.BaseURL
|
||||
apiKey := model.Parameters.APIKey
|
||||
if model.IsBuiltin {
|
||||
baseURL = ""
|
||||
apiKey = ""
|
||||
}
|
||||
|
||||
switch model.Type {
|
||||
case types.ModelTypeKnowledgeQA:
|
||||
config["llm"] = map[string]interface{}{
|
||||
"source": string(model.Source),
|
||||
"modelName": model.Name,
|
||||
"baseUrl": model.Parameters.BaseURL,
|
||||
"apiKey": model.Parameters.APIKey,
|
||||
"baseUrl": baseURL,
|
||||
"apiKey": apiKey,
|
||||
}
|
||||
case types.ModelTypeEmbedding:
|
||||
config["embedding"] = map[string]interface{}{
|
||||
"source": string(model.Source),
|
||||
"modelName": model.Name,
|
||||
"baseUrl": model.Parameters.BaseURL,
|
||||
"apiKey": model.Parameters.APIKey,
|
||||
"baseUrl": baseURL,
|
||||
"apiKey": apiKey,
|
||||
"dimension": model.Parameters.EmbeddingParameters.Dimension,
|
||||
}
|
||||
case types.ModelTypeRerank:
|
||||
config["rerank"] = map[string]interface{}{
|
||||
"enabled": true,
|
||||
"modelName": model.Name,
|
||||
"baseUrl": model.Parameters.BaseURL,
|
||||
"apiKey": model.Parameters.APIKey,
|
||||
"baseUrl": baseURL,
|
||||
"apiKey": apiKey,
|
||||
}
|
||||
case types.ModelTypeVLLM:
|
||||
if config["multimodal"] == nil {
|
||||
@@ -1187,8 +1195,8 @@ func (h *InitializationHandler) buildConfigResponse(ctx context.Context, models
|
||||
multimodal := config["multimodal"].(map[string]interface{})
|
||||
multimodal["vlm"] = map[string]interface{}{
|
||||
"modelName": model.Name,
|
||||
"baseUrl": model.Parameters.BaseURL,
|
||||
"apiKey": model.Parameters.APIKey,
|
||||
"baseUrl": baseURL,
|
||||
"apiKey": apiKey,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -27,6 +27,37 @@ func NewModelHandler(service interfaces.ModelService) *ModelHandler {
|
||||
return &ModelHandler{service: service}
|
||||
}
|
||||
|
||||
// hideSensitiveInfo hides sensitive information (APIKey, BaseURL) for builtin models
|
||||
// Returns a copy of the model with sensitive fields cleared if it's a builtin model
|
||||
func hideSensitiveInfo(model *types.Model) *types.Model {
|
||||
if !model.IsBuiltin {
|
||||
return model
|
||||
}
|
||||
|
||||
// Create a copy with sensitive information hidden
|
||||
return &types.Model{
|
||||
ID: model.ID,
|
||||
TenantID: model.TenantID,
|
||||
Name: model.Name,
|
||||
Type: model.Type,
|
||||
Source: model.Source,
|
||||
Description: model.Description,
|
||||
Parameters: types.ModelParameters{
|
||||
// Hide APIKey and BaseURL for builtin models
|
||||
BaseURL: "",
|
||||
APIKey: "",
|
||||
// Keep other parameters like embedding dimensions
|
||||
EmbeddingParameters: model.Parameters.EmbeddingParameters,
|
||||
ParameterSize: model.Parameters.ParameterSize,
|
||||
},
|
||||
IsDefault: model.IsDefault,
|
||||
IsBuiltin: model.IsBuiltin,
|
||||
Status: model.Status,
|
||||
CreatedAt: model.CreatedAt,
|
||||
UpdatedAt: model.UpdatedAt,
|
||||
}
|
||||
}
|
||||
|
||||
// CreateModelRequest defines the structure for model creation requests
|
||||
// Contains all fields required to create a new model in the system
|
||||
type CreateModelRequest struct {
|
||||
@@ -82,9 +113,13 @@ func (h *ModelHandler) CreateModel(c *gin.Context) {
|
||||
}
|
||||
|
||||
logger.Infof(ctx, "Model created successfully, ID: %s, Name: %s", model.ID, model.Name)
|
||||
|
||||
// Hide sensitive information for builtin models (though newly created models are unlikely to be builtin)
|
||||
responseModel := hideSensitiveInfo(model)
|
||||
|
||||
c.JSON(http.StatusCreated, gin.H{
|
||||
"success": true,
|
||||
"data": model,
|
||||
"data": responseModel,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -119,9 +154,16 @@ func (h *ModelHandler) GetModel(c *gin.Context) {
|
||||
}
|
||||
|
||||
logger.Infof(ctx, "Retrieved model successfully, ID: %s, Name: %s", model.ID, model.Name)
|
||||
|
||||
// Hide sensitive information for builtin models
|
||||
responseModel := hideSensitiveInfo(model)
|
||||
if model.IsBuiltin {
|
||||
logger.Infof(ctx, "Builtin model detected, hiding sensitive information for model: %s", model.ID)
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"success": true,
|
||||
"data": model,
|
||||
"data": responseModel,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -150,9 +192,19 @@ func (h *ModelHandler) ListModels(c *gin.Context) {
|
||||
}
|
||||
|
||||
logger.Infof(ctx, "Retrieved model list successfully, Tenant ID: %d, Total: %d models", tenantID, len(models))
|
||||
|
||||
// Hide sensitive information for builtin models in the list
|
||||
responseModels := make([]*types.Model, len(models))
|
||||
for i, model := range models {
|
||||
responseModels[i] = hideSensitiveInfo(model)
|
||||
if model.IsBuiltin {
|
||||
logger.Infof(ctx, "Builtin model detected in list, hiding sensitive information for model: %s", model.ID)
|
||||
}
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"success": true,
|
||||
"data": models,
|
||||
"data": responseModels,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -224,9 +276,13 @@ func (h *ModelHandler) UpdateModel(c *gin.Context) {
|
||||
}
|
||||
|
||||
logger.Infof(ctx, "Model updated successfully, ID: %s", id)
|
||||
|
||||
// Hide sensitive information for builtin models (though builtin models cannot be updated)
|
||||
responseModel := hideSensitiveInfo(model)
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"success": true,
|
||||
"data": model,
|
||||
"data": responseModel,
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -66,6 +66,8 @@ type Model struct {
|
||||
Parameters ModelParameters `yaml:"parameters" json:"parameters" gorm:"type:json"`
|
||||
// Whether the model is the default model
|
||||
IsDefault bool `yaml:"is_default" json:"is_default"`
|
||||
// Whether the model is a builtin model (visible to all tenants)
|
||||
IsBuiltin bool `yaml:"is_builtin" json:"is_builtin" gorm:"default:false"`
|
||||
// Model status, default: active, possible: downloading, download_failed
|
||||
Status ModelStatus `yaml:"status" json:"status"`
|
||||
// Creation time of the model
|
||||
|
||||
Reference in New Issue
Block a user