Model Listing

Import from @anvia/core/model-listing or @anvia/core.

Model Listing Types

type ListedModel = {
  id: string;
  name?: string;
  description?: string;
  type?: string;
  createdAt?: number;
  ownedBy?: string;
  contextLength?: number;
};

type ModelList = {
  data: ListedModel[];
};

interface ModelListingClient {
  listModels(): Promise<ModelList>;
}

type ModelId<KnownModel extends string> = KnownModel | (string & {});

Purpose: normalized model-listing contracts shared by provider clients.

Return behavior: provider clients fetch live provider model data and normalize known fields. Unknown fields remain omitted.

ModelId is used by provider packages for model-name autocomplete. Known provider model unions stay suggested by TypeScript, while custom model IDs remain accepted as strings.

ModelListingError

class ModelListingError extends Error {
  readonly provider?: string;
  readonly statusCode?: number;
  readonly cause?: unknown;
}

Purpose: standard error wrapper for provider model-listing failures.

Return behavior: thrown by provider listModels() implementations when SDK or provider requests fail.