Skip to content

CustomModelResponse

Response object containing full details about a registered custom model including health status.

Example Usage

typescript
import { CustomModelResponse } from "@meetkai/mka1/models/components";

let value: CustomModelResponse = {
  id: "cm_abc123",
  name: "my-local-llama",
  baseUrl: "http://localhost:8080/v1",
  capabilities: {
    chat: true,
    completion: true,
    embedding: false,
    image: false,
    transcription: false,
    speech: false,
  },
  contextWindow: 4096,
  temperature: 0.7,
  isAvailable: true,
  lastHealthCheck: new Date("2024-01-15T10:30:00Z"),
  createdAt: new Date("2024-01-01T00:00:00Z"),
  updatedAt: new Date("2024-01-15T10:30:00Z"),
};

Fields

FieldTypeRequiredDescription
idstring✔️Unique identifier for this custom model
namestring✔️Name of the custom model
baseUrlstring✔️Base URL of the custom model API endpoint
capabilitiescomponents.Capabilities✔️Object describing the capabilities of this custom model
maxTokensnumberDefault maximum tokens for generation
contextWindownumberContext window size (total tokens)
temperaturenumberDefault temperature setting (0-2)
topPnumberDefault nucleus sampling parameter (0-1)
frequencyPenaltynumberDefault frequency penalty (-2 to 2)
presencePenaltynumberDefault presence penalty (-2 to 2)
rpmnumberRate limit in requests per minute
isAvailableboolean✔️Whether the model is currently available and passing health checks
lastHealthCheckDate✔️Timestamp of the most recent health check
healthCheckErrorstringError message from the last health check, if the check failed
createdAtDate✔️Timestamp when this custom model was registered
updatedAtDate✔️Timestamp when this custom model configuration was last updated