Files
Acbox Liu b88ca96064 refactor: provider & models (#277)
* refactor: move client_type to provider, replace model fields with config JSONB

- Move `client_type` from `models` to `llm_providers` table
- Add `icon` field to `llm_providers`
- Replace `dimensions`, `input_modalities`, `supports_reasoning` on `models`
  with a single `config` JSONB column containing `dimensions`,
  `compatibilities` (vision, tool-call, image-output, reasoning),
  and `context_window`
- Auto-imported models default to vision + tool-call + reasoning
- Update all backend consumers (agent, flow resolver, handlers, memory)
- Regenerate sqlc, swagger, and TypeScript SDK
- Update frontend forms, display, and i18n for new schema

* ui: show provider icon avatar in sidebar and detail header, remove icon input

* feat: add built-in provider registry with YAML definitions and enable toggle

- Add `enable` column to llm_providers (default true, backward-compatible)
- Create internal/registry package to load YAML provider/model definitions
  on startup and upsert into database (new providers disabled by default)
- Add conf/providers/ with OpenAI, Anthropic, Google YAML definitions
- Add RegistryConfig to TOML config (providers_dir, default conf/providers)
- Model listing APIs and conversation flow now filter by enabled providers
- Frontend: enable switch in provider form, green status dot in sidebar,
  enabled providers sorted to top

* fix: make 0041 migration idempotent for fresh databases

Guard data migration steps with column-existence checks so the
migration succeeds on databases created from the updated init schema.
2026-03-22 17:24:45 +08:00

480 lines
14 KiB
Go

package models
import (
"context"
"encoding/json"
"errors"
"fmt"
"log/slog"
"strings"
"github.com/google/uuid"
"github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/pgtype"
"github.com/memohai/memoh/internal/channel"
"github.com/memohai/memoh/internal/db"
"github.com/memohai/memoh/internal/db/sqlc"
)
var (
ErrModelIDAlreadyExists = errors.New("model_id already exists")
ErrModelIDAmbiguous = errors.New("model_id is ambiguous across providers")
)
// Service provides CRUD operations for models.
type Service struct {
queries *sqlc.Queries
logger *slog.Logger
}
// NewService creates a new models service.
func NewService(log *slog.Logger, queries *sqlc.Queries) *Service {
return &Service{
queries: queries,
logger: log.With(slog.String("service", "models")),
}
}
// Create adds a new model to the database.
func (s *Service) Create(ctx context.Context, req AddRequest) (AddResponse, error) {
model := Model(req)
if err := model.Validate(); err != nil {
return AddResponse{}, fmt.Errorf("validation failed: %w", err)
}
llmProviderID, err := db.ParseUUID(model.LlmProviderID)
if err != nil {
return AddResponse{}, fmt.Errorf("invalid llm provider ID: %w", err)
}
configJSON, err := json.Marshal(model.Config)
if err != nil {
return AddResponse{}, fmt.Errorf("marshal config: %w", err)
}
params := sqlc.CreateModelParams{
ModelID: model.ModelID,
LlmProviderID: llmProviderID,
Type: string(model.Type),
Config: configJSON,
}
if model.Name != "" {
params.Name = pgtype.Text{String: model.Name, Valid: true}
}
created, err := s.queries.CreateModel(ctx, params)
if err != nil {
if db.IsUniqueViolation(err) {
return AddResponse{}, ErrModelIDAlreadyExists
}
return AddResponse{}, fmt.Errorf("failed to create model: %w", err)
}
var idStr string
if created.ID.Valid {
id, err := uuid.FromBytes(created.ID.Bytes[:])
if err != nil {
return AddResponse{}, fmt.Errorf("failed to convert UUID: %w", err)
}
idStr = id.String()
}
return AddResponse{
ID: idStr,
ModelID: created.ModelID,
}, nil
}
// GetByID retrieves a model by its internal UUID.
func (s *Service) GetByID(ctx context.Context, id string) (GetResponse, error) {
uuid, err := db.ParseUUID(id)
if err != nil {
return GetResponse{}, fmt.Errorf("invalid ID: %w", err)
}
dbModel, err := s.queries.GetModelByID(ctx, uuid)
if err != nil {
return GetResponse{}, fmt.Errorf("failed to get model: %w", err)
}
return s.convertToGetResponse(dbModel), nil
}
// GetByModelID retrieves a model by its model_id field.
func (s *Service) GetByModelID(ctx context.Context, modelID string) (GetResponse, error) {
if modelID == "" {
return GetResponse{}, errors.New("model_id is required")
}
dbModel, err := s.findUniqueByModelID(ctx, modelID)
if err != nil {
return GetResponse{}, fmt.Errorf("failed to get model: %w", err)
}
return s.convertToGetResponse(dbModel), nil
}
// List returns all models.
func (s *Service) List(ctx context.Context) ([]GetResponse, error) {
dbModels, err := s.queries.ListModels(ctx)
if err != nil {
return nil, fmt.Errorf("failed to list models: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// ListByType returns models filtered by type (chat or embedding).
func (s *Service) ListByType(ctx context.Context, modelType ModelType) ([]GetResponse, error) {
if modelType != ModelTypeChat && modelType != ModelTypeEmbedding {
return nil, fmt.Errorf("invalid model type: %s", modelType)
}
dbModels, err := s.queries.ListModelsByType(ctx, string(modelType))
if err != nil {
return nil, fmt.Errorf("failed to list models by type: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// ListByProviderClientType returns models whose provider has the given client_type.
func (s *Service) ListByProviderClientType(ctx context.Context, clientType ClientType) ([]GetResponse, error) {
if !IsValidClientType(clientType) {
return nil, fmt.Errorf("invalid client type: %s", clientType)
}
dbModels, err := s.queries.ListModelsByProviderClientType(ctx, string(clientType))
if err != nil {
return nil, fmt.Errorf("failed to list models by provider client type: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// ListEnabled returns all models from enabled providers.
func (s *Service) ListEnabled(ctx context.Context) ([]GetResponse, error) {
dbModels, err := s.queries.ListEnabledModels(ctx)
if err != nil {
return nil, fmt.Errorf("failed to list enabled models: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// ListEnabledByType returns models from enabled providers filtered by type.
func (s *Service) ListEnabledByType(ctx context.Context, modelType ModelType) ([]GetResponse, error) {
if modelType != ModelTypeChat && modelType != ModelTypeEmbedding {
return nil, fmt.Errorf("invalid model type: %s", modelType)
}
dbModels, err := s.queries.ListEnabledModelsByType(ctx, string(modelType))
if err != nil {
return nil, fmt.Errorf("failed to list enabled models by type: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// ListEnabledByProviderClientType returns models from enabled providers with
// the given client_type.
func (s *Service) ListEnabledByProviderClientType(ctx context.Context, clientType ClientType) ([]GetResponse, error) {
if !IsValidClientType(clientType) {
return nil, fmt.Errorf("invalid client type: %s", clientType)
}
dbModels, err := s.queries.ListEnabledModelsByProviderClientType(ctx, string(clientType))
if err != nil {
return nil, fmt.Errorf("failed to list enabled models by provider client type: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// ListByProviderID returns models filtered by provider ID.
func (s *Service) ListByProviderID(ctx context.Context, providerID string) ([]GetResponse, error) {
if strings.TrimSpace(providerID) == "" {
return nil, errors.New("provider id is required")
}
uuid, err := db.ParseUUID(providerID)
if err != nil {
return nil, fmt.Errorf("invalid provider id: %w", err)
}
dbModels, err := s.queries.ListModelsByProviderID(ctx, uuid)
if err != nil {
return nil, fmt.Errorf("failed to list models by provider: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// ListByProviderIDAndType returns models filtered by provider ID and type.
func (s *Service) ListByProviderIDAndType(ctx context.Context, providerID string, modelType ModelType) ([]GetResponse, error) {
if modelType != ModelTypeChat && modelType != ModelTypeEmbedding {
return nil, fmt.Errorf("invalid model type: %s", modelType)
}
if strings.TrimSpace(providerID) == "" {
return nil, errors.New("provider id is required")
}
uuid, err := db.ParseUUID(providerID)
if err != nil {
return nil, fmt.Errorf("invalid provider id: %w", err)
}
dbModels, err := s.queries.ListModelsByProviderIDAndType(ctx, sqlc.ListModelsByProviderIDAndTypeParams{
LlmProviderID: uuid,
Type: string(modelType),
})
if err != nil {
return nil, fmt.Errorf("failed to list models by provider and type: %w", err)
}
return s.convertToGetResponseList(dbModels), nil
}
// UpdateByID updates a model by its internal UUID.
func (s *Service) UpdateByID(ctx context.Context, id string, req UpdateRequest) (GetResponse, error) {
uuid, err := db.ParseUUID(id)
if err != nil {
return GetResponse{}, fmt.Errorf("invalid ID: %w", err)
}
model := Model(req)
if err := model.Validate(); err != nil {
return GetResponse{}, fmt.Errorf("validation failed: %w", err)
}
llmProviderID, err := db.ParseUUID(model.LlmProviderID)
if err != nil {
return GetResponse{}, fmt.Errorf("invalid llm provider ID: %w", err)
}
configJSON, err := json.Marshal(model.Config)
if err != nil {
return GetResponse{}, fmt.Errorf("marshal config: %w", err)
}
params := sqlc.UpdateModelParams{
ID: uuid,
ModelID: model.ModelID,
LlmProviderID: llmProviderID,
Type: string(model.Type),
Config: configJSON,
}
if model.Name != "" {
params.Name = pgtype.Text{String: model.Name, Valid: true}
}
updated, err := s.queries.UpdateModel(ctx, params)
if err != nil {
if db.IsUniqueViolation(err) {
return GetResponse{}, ErrModelIDAlreadyExists
}
return GetResponse{}, fmt.Errorf("failed to update model: %w", err)
}
return s.convertToGetResponse(updated), nil
}
// UpdateByModelID updates a model by its model_id field.
func (s *Service) UpdateByModelID(ctx context.Context, modelID string, req UpdateRequest) (GetResponse, error) {
if modelID == "" {
return GetResponse{}, errors.New("model_id is required")
}
current, err := s.findUniqueByModelID(ctx, modelID)
if err != nil {
return GetResponse{}, fmt.Errorf("failed to update model: %w", err)
}
model := Model(req)
if err := model.Validate(); err != nil {
return GetResponse{}, fmt.Errorf("validation failed: %w", err)
}
llmProviderID, err := db.ParseUUID(model.LlmProviderID)
if err != nil {
return GetResponse{}, fmt.Errorf("invalid llm provider ID: %w", err)
}
configJSON, err := json.Marshal(model.Config)
if err != nil {
return GetResponse{}, fmt.Errorf("marshal config: %w", err)
}
params := sqlc.UpdateModelParams{
ID: current.ID,
ModelID: model.ModelID,
LlmProviderID: llmProviderID,
Type: string(model.Type),
Config: configJSON,
}
if model.Name != "" {
params.Name = pgtype.Text{String: model.Name, Valid: true}
}
updated, err := s.queries.UpdateModel(ctx, params)
if err != nil {
if db.IsUniqueViolation(err) {
return GetResponse{}, ErrModelIDAlreadyExists
}
return GetResponse{}, fmt.Errorf("failed to update model: %w", err)
}
return s.convertToGetResponse(updated), nil
}
// DeleteByID deletes a model by its internal UUID.
func (s *Service) DeleteByID(ctx context.Context, id string) error {
uuid, err := db.ParseUUID(id)
if err != nil {
return fmt.Errorf("invalid ID: %w", err)
}
if err := s.queries.DeleteModel(ctx, uuid); err != nil {
return fmt.Errorf("failed to delete model: %w", err)
}
return nil
}
// DeleteByModelID deletes a model by its model_id field.
func (s *Service) DeleteByModelID(ctx context.Context, modelID string) error {
if modelID == "" {
return errors.New("model_id is required")
}
current, err := s.findUniqueByModelID(ctx, modelID)
if err != nil {
return fmt.Errorf("failed to delete model: %w", err)
}
if err := s.queries.DeleteModel(ctx, current.ID); err != nil {
return fmt.Errorf("failed to delete model: %w", err)
}
return nil
}
// Count returns the total number of models.
func (s *Service) Count(ctx context.Context) (int64, error) {
count, err := s.queries.CountModels(ctx)
if err != nil {
return 0, fmt.Errorf("failed to count models: %w", err)
}
return count, nil
}
// CountByType returns the number of models of a specific type.
func (s *Service) CountByType(ctx context.Context, modelType ModelType) (int64, error) {
if modelType != ModelTypeChat && modelType != ModelTypeEmbedding {
return 0, fmt.Errorf("invalid model type: %s", modelType)
}
count, err := s.queries.CountModelsByType(ctx, string(modelType))
if err != nil {
return 0, fmt.Errorf("failed to count models by type: %w", err)
}
return count, nil
}
func (s *Service) convertToGetResponse(dbModel sqlc.Model) GetResponse {
resp := GetResponse{
ID: dbModel.ID.String(),
ModelID: dbModel.ModelID,
Model: Model{
ModelID: dbModel.ModelID,
Type: ModelType(dbModel.Type),
},
}
if dbModel.LlmProviderID.Valid {
resp.LlmProviderID = dbModel.LlmProviderID.String()
}
if dbModel.Name.Valid {
resp.Name = dbModel.Name.String
}
if len(dbModel.Config) > 0 {
if err := json.Unmarshal(dbModel.Config, &resp.Config); err != nil {
s.logger.Warn("failed to unmarshal model config", slog.String("model_id", dbModel.ModelID), slog.Any("error", err))
}
}
return resp
}
func (s *Service) convertToGetResponseList(dbModels []sqlc.Model) []GetResponse {
responses := make([]GetResponse, 0, len(dbModels))
for _, dbModel := range dbModels {
responses = append(responses, s.convertToGetResponse(dbModel))
}
return responses
}
func (s *Service) findUniqueByModelID(ctx context.Context, modelID string) (sqlc.Model, error) {
rows, err := s.queries.ListModelsByModelID(ctx, modelID)
if err != nil {
return sqlc.Model{}, err
}
if len(rows) == 0 {
return sqlc.Model{}, pgx.ErrNoRows
}
if len(rows) > 1 {
return sqlc.Model{}, ErrModelIDAmbiguous
}
return rows[0], nil
}
// IsValidClientType returns true if the given client type is supported.
func IsValidClientType(clientType ClientType) bool {
switch clientType {
case ClientTypeOpenAIResponses,
ClientTypeOpenAICompletions,
ClientTypeAnthropicMessages,
ClientTypeGoogleGenerativeAI:
return true
default:
return false
}
}
// SelectMemoryModel selects a chat model for memory operations.
func SelectMemoryModel(ctx context.Context, modelsService *Service, queries *sqlc.Queries) (GetResponse, sqlc.LlmProvider, error) {
if modelsService == nil {
return GetResponse{}, sqlc.LlmProvider{}, errors.New("models service not configured")
}
if queries == nil {
return GetResponse{}, sqlc.LlmProvider{}, errors.New("queries not configured")
}
candidates, err := modelsService.ListByType(ctx, ModelTypeChat)
if err != nil || len(candidates) == 0 {
return GetResponse{}, sqlc.LlmProvider{}, errors.New("no chat models available for memory operations")
}
selected := candidates[0]
provider, err := FetchProviderByID(ctx, queries, selected.LlmProviderID)
if err != nil {
return GetResponse{}, sqlc.LlmProvider{}, err
}
return selected, provider, nil
}
// SelectMemoryModelForBot delegates to SelectMemoryModel.
func SelectMemoryModelForBot(ctx context.Context, modelsService *Service, queries *sqlc.Queries, _ string) (GetResponse, sqlc.LlmProvider, error) {
return SelectMemoryModel(ctx, modelsService, queries)
}
// FetchProviderByID fetches a provider by ID.
func FetchProviderByID(ctx context.Context, queries *sqlc.Queries, providerID string) (sqlc.LlmProvider, error) {
if strings.TrimSpace(providerID) == "" {
return sqlc.LlmProvider{}, errors.New("provider id missing")
}
parsed, err := db.ParseUUID(providerID)
if err != nil {
return sqlc.LlmProvider{}, err
}
provider, err := queries.GetLlmProviderByID(ctx, parsed)
if err != nil {
return sqlc.LlmProvider{}, err
}
if strings.TrimSpace(provider.ApiKey) != "" {
channel.SetIMErrorSecrets("llm-provider:"+providerID, provider.ApiKey)
}
return provider, nil
}