All files / api/src/utils model-validator.ts

64.61% Statements 168/260
75% Branches 30/40
80% Functions 8/10
64.61% Lines 168/260

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405                          1x             1x     1x         1x 20x 20x 20x 20x                 1x 99x 99x 99x   99x   99x 2x 2x 2x 2x 2x   97x 97x 97x 97x 97x                 34x 34x 34x 34x 34x 23x 23x     34x           11x 11x         25x 25x 25x 25x 25x 34x 25x 25x         1x 57x 57x 57x 57x 57x   57x 57x 57x 57x   57x     57x 57x   57x   35x 35x 35x 35x 35x     22x   22x 22x 22x 22x   22x   21x               21x   21x                 21x 21x 21x 21x 21x     21x             21x 21x 21x 14x 14x 21x     21x 1x 1x 1x 1x 1x 22x   1x           1x             1x   22x 22x 57x 57x 57x 57x 57x         3x 3x 3x 3x 3x 3x   3x 3x 3x       3x     3x 3x 3x               1x 8x 8x 8x 8x 8x 8x         1x 39x 39x 39x 39x 39x 39x 39x   39x 39x 39x 39x 39x 39x   39x 1x 1x     38x 38x 38x 38x   39x     39x 39x   39x 35x 35x     3x     3x 3x 3x 3x 3x 3x     39x 1x 1x 1x 1x 1x     2x   2x 2x 2x 2x 2x 2x         1x                                                                                                                                           1x                                  
/**
 * Model capability validation utility.
 *
 * This service validates whether specific parameters are supported by AI models
 * and handles parameter remapping for legacy models.
 */
 
import type {
  ModelCapability,
  ParameterRange,
  ParameterValidationResult,
  ProviderModelCapabilities,
} from '@shared/types/ai-providers/model-capabilities';
import { ModelParameter } from '@shared/types/ai-providers/model-capabilities';
import type { FunctionName } from '@shared/types/api/request';
import type { AIProvider } from '@shared/types/constants';
 
/**
 * Registry of provider model capabilities.
 */
const providerCapabilitiesRegistry = new Map<
  string,
  ProviderModelCapabilities
>();
 
/**
 * Register model capabilities for a provider.
 */
export function registerProviderCapabilities(
  capabilities: ProviderModelCapabilities,
): void {
  providerCapabilitiesRegistry.set(capabilities.provider, capabilities);
}
 
/**
 * Parse model identifier to extract provider and model name.
 * Supports formats like:
 * - "gpt-4" (simple model name)
 * - "openai/gpt-4" (OpenRouter format)
 * - "anthropic/claude-3-opus" (OpenRouter format)
 */
export function parseModelIdentifier(
  modelId: string,
  defaultProvider?: AIProvider,
): { provider: string | undefined; modelName: string } {
  // Check if model ID contains provider prefix (OpenRouter format)
  const parts = modelId.split('/');
 
  if (parts.length === 2) {
    return {
      provider: parts[0],
      modelName: parts[1],
    };
  }
 
  return {
    provider: defaultProvider,
    modelName: modelId,
  };
}
 
/**
 * Check if a model pattern matches a model name.
 * Supports:
 * - Exact match: "gpt-4"
 * - Wildcard: "gpt-4*" matches "gpt-4-turbo", "gpt-4o", etc.
 * - RegExp: custom regex patterns
 */
function matchesModelPattern(
  modelName: string,
  pattern: string | RegExp,
): boolean {
  if (pattern instanceof RegExp) {
    return pattern.test(modelName);
  }
 
  // Convert wildcard pattern to regex
  if (pattern.includes('*')) {
    const regexPattern = pattern.replace(/\*/g, '.*');
    return new RegExp(`^${regexPattern}$`).test(modelName);
  }
 
  // Exact match
  return modelName === pattern;
}
 
/**
 * Find model capability configuration for a specific model.
 */
function findModelCapability(
  providerCapabilities: ProviderModelCapabilities,
  modelName: string,
): ModelCapability | undefined {
  return providerCapabilities.models.find((modelCap) =>
    matchesModelPattern(modelName, modelCap.modelPattern),
  );
}
 
/**
 * Validate if a parameter is supported by a model for a specific endpoint.
 */
export function validateParameter(
  provider: AIProvider | string,
  modelId: string,
  parameter: ModelParameter,
  functionName?: FunctionName,
): ParameterValidationResult {
  // Parse model identifier (handles OpenRouter format)
  const { provider: parsedProvider, modelName } = parseModelIdentifier(
    modelId,
    provider as AIProvider,
  );
 
  const effectiveProvider = parsedProvider || provider;
 
  // Get provider capabilities
  const providerCapabilities =
    providerCapabilitiesRegistry.get(effectiveProvider);
 
  if (!providerCapabilities) {
    // No capabilities registered - assume supported
    return {
      isSupported: true,
      parameterName: parameter,
    };
  }
 
  // Find model-specific capability
  const modelCapability = findModelCapability(providerCapabilities, modelName);
 
  let isSupported = true;
  let parameterName = parameter;
  let reason: string | undefined;
  let warning: string | undefined;
 
  if (modelCapability) {
    // Check if we have endpoint-specific configuration
    if (!functionName) {
      // No function name provided - assume all parameters supported
      return {
        isSupported: true,
        parameterName: parameter,
      };
    }
 
    const endpointConfig = modelCapability.endpointConfigs[functionName];
 
    if (!endpointConfig) {
      // No config for this endpoint - assume all parameters supported
      return {
        isSupported: true,
        parameterName: parameter,
      };
    }
 
    // Check endpoint-specific supported/unsupported parameters
    const {
      supportedParameters,
      unsupportedParameters,
      legacyParameterMapping,
    } = endpointConfig;
 
    // Check if parameter is explicitly supported
    if (supportedParameters) {
      isSupported = supportedParameters.includes(parameter);
      if (!isSupported) {
        reason = `Parameter '${parameter}' is not in the supported parameters list for endpoint '${functionName}' on model '${modelName}'`;
      }
    }
    // Check if parameter is explicitly unsupported
    else if (unsupportedParameters) {
      isSupported = !unsupportedParameters.includes(parameter);
      if (!isSupported) {
        reason = `Parameter '${parameter}' is not supported by endpoint '${functionName}' on model '${modelName}'`;
      }
    }
 
    // Check for parameter remapping (legacy models)
    if (isSupported && legacyParameterMapping) {
      const mappedParameter = legacyParameterMapping[parameter as string];
      if (mappedParameter !== undefined) {
        parameterName = mappedParameter;
      }
    }
  } else {
    // No model-specific config, check provider defaults
    if (providerCapabilities.defaultSupportedParameters) {
      isSupported =
        providerCapabilities.defaultSupportedParameters.includes(parameter);
      if (!isSupported) {
        reason = `Parameter '${parameter}' is not in the default supported parameters for provider '${effectiveProvider}'`;
      }
    } else if (providerCapabilities.defaultUnsupportedParameters) {
      isSupported =
        !providerCapabilities.defaultUnsupportedParameters.includes(parameter);
      if (!isSupported) {
        reason = `Parameter '${parameter}' is not supported by provider '${effectiveProvider}'`;
      }
    }
  }
 
  return {
    isSupported,
    parameterName: isSupported ? parameterName : undefined,
    reason,
    warning,
  };
}
 
/**
 * Get the parameter range for a specific parameter on a model/endpoint.
 */
function getParameterRange(
  providerCapabilities: ProviderModelCapabilities,
  modelCapability: ModelCapability | undefined,
  parameter: ModelParameter,
  functionName?: FunctionName,
): ParameterRange | undefined {
  // Check endpoint-specific ranges first
  if (modelCapability && functionName) {
    const endpointConfig = modelCapability.endpointConfigs[functionName];
    if (endpointConfig?.parameterRanges) {
      const range = endpointConfig.parameterRanges[parameter];
      if (range) return range;
    }
  }
 
  // Fall back to provider default ranges
  if (providerCapabilities.defaultParameterRanges) {
    return providerCapabilities.defaultParameterRanges[parameter];
  }
 
  return undefined;
}
 
/**
 * Transform a normalized value (0-1) to the model's expected range.
 */
export function transformParameterValue(
  normalizedValue: number,
  range: ParameterRange,
): number {
  const { min, max } = range;
  return min + normalizedValue * (max - min);
}
 
/**
 * Validate and optionally transform a parameter value based on model capabilities.
 */
export function validateAndTransformParameter(
  provider: AIProvider | string,
  modelId: string,
  parameter: ModelParameter,
  value: number,
  functionName?: FunctionName,
  shouldTransform = true,
): ParameterValidationResult {
  // First validate if parameter is supported
  const validation = validateParameter(
    provider,
    modelId,
    parameter,
    functionName,
  );
 
  if (!validation.isSupported) {
    return validation;
  }
 
  // Parse model identifier
  const { provider: parsedProvider, modelName } = parseModelIdentifier(
    modelId,
    provider as AIProvider,
  );
 
  const effectiveProvider = parsedProvider || provider;
 
  // Get provider capabilities
  const providerCapabilities =
    providerCapabilitiesRegistry.get(effectiveProvider);
 
  if (!providerCapabilities) {
    return validation;
  }
 
  // Find model-specific capability
  const modelCapability = findModelCapability(providerCapabilities, modelName);
 
  // Get parameter range
  const parameterRange = getParameterRange(
    providerCapabilities,
    modelCapability,
    parameter,
    functionName,
  );
 
  // If no range defined or transformation disabled, return as-is
  if (!parameterRange || !shouldTransform) {
    return {
      ...validation,
      parameterRange,
    };
  }
 
  // Transform the value
  const transformedValue = transformParameterValue(value, parameterRange);
 
  return {
    ...validation,
    transformedValue,
    parameterRange,
  };
}
 
/**
 * Get all supported parameters for a model and optional endpoint.
 */
export function getSupportedParameters(
  provider: AIProvider | string,
  modelId: string,
  functionName?: FunctionName,
): ModelParameter[] {
  const { provider: parsedProvider, modelName } = parseModelIdentifier(
    modelId,
    provider as AIProvider,
  );
 
  const effectiveProvider = parsedProvider || provider;
 
  const providerCapabilities =
    providerCapabilitiesRegistry.get(effectiveProvider);
 
  if (!providerCapabilities) {
    // Return all parameters if no capabilities registered
    return Object.values(ModelParameter);
  }
 
  const modelCapability = findModelCapability(providerCapabilities, modelName);
 
  if (modelCapability) {
    // Check if we have function name and endpoint config
    if (!functionName) {
      // No function name - return all parameters
      return Object.values(ModelParameter);
    }
 
    const endpointConfig = modelCapability.endpointConfigs[functionName];
 
    if (!endpointConfig) {
      // No config for this endpoint - return all parameters
      return Object.values(ModelParameter);
    }
 
    // Use endpoint-specific supported parameters
    if (endpointConfig.supportedParameters) {
      return endpointConfig.supportedParameters;
    }
 
    // Use endpoint-specific unsupported parameters
    if (endpointConfig.unsupportedParameters) {
      return Object.values(ModelParameter).filter(
        (param) => !endpointConfig.unsupportedParameters!.includes(param),
      );
    }
 
    // No restrictions for this endpoint
    return Object.values(ModelParameter);
  }
 
  // Use provider defaults
  if (providerCapabilities.defaultSupportedParameters) {
    return providerCapabilities.defaultSupportedParameters;
  }
 
  if (providerCapabilities.defaultUnsupportedParameters) {
    return Object.values(ModelParameter).filter(
      (param) =>
        !providerCapabilities.defaultUnsupportedParameters!.includes(param),
    );
  }
 
  return Object.values(ModelParameter);
}
 
/**
 * Validate multiple parameters at once.
 */
export function validateParameters(
  provider: AIProvider | string,
  modelId: string,
  parameters: ModelParameter[],
  functionName?: FunctionName,
): Map<ModelParameter, ParameterValidationResult> {
  const results = new Map<ModelParameter, ParameterValidationResult>();
 
  for (const parameter of parameters) {
    results.set(
      parameter,
      validateParameter(provider, modelId, parameter, functionName),
    );
  }
 
  return results;
}