bios-sdk 0.1.1-rc.20 → 0.1.1-rc.26

package/README.md

@@ -109,6 +109,10 @@ for await (const chunk of client.inference.streamChatCompletions({
 
 ### Models
 
+The catalog lists only models hosted on BiOS (the platform's own verified
+registry, mirrored in BiOS storage) — every result can be trained and
+deployed; it is never a live Hugging Face search.
+
 ```typescript
 // Search models
 const results = await client.models.search({ query: 'llama', limit: 10 });

package/dist/resources/models.d.ts

@@ -9,10 +9,10 @@ export declare class Models {
     /** @internal */
     constructor(_http: HttpClient);
     /**
-     * Search the model catalog for fine-tunable models.
-     *
-     * Results are filtered to exclude quantized derivatives (GGUF, GPTQ, AWQ)
-     * and adapters by default -- pass `kind: "adapter"` to find LoRA adapters.
+     * Search the BiOS model catalog -- the platform's own hosted, verified
+     * models. Every result is mirrored in BiOS storage and can be trained and
+     * deployed; this is never a live Hugging Face search. A model that is not
+     * listed here is not hosted on BiOS yet.
      *
      * @example
      * ```ts

package/dist/resources/models.js

@@ -9,10 +9,10 @@ export class Models {
         this._http = _http;
     }
     /**
-     * Search the model catalog for fine-tunable models.
-     *
-     * Results are filtered to exclude quantized derivatives (GGUF, GPTQ, AWQ)
-     * and adapters by default -- pass `kind: "adapter"` to find LoRA adapters.
+     * Search the BiOS model catalog -- the platform's own hosted, verified
+     * models. Every result is mirrored in BiOS storage and can be trained and
+     * deployed; this is never a live Hugging Face search. A model that is not
+     * listed here is not hosted on BiOS yet.
      *
      * @example
      * ```ts

package/dist/types.d.ts

@@ -99,7 +99,12 @@ export interface AvailableGpuAlternative {
     tier?: string;
     recommended?: boolean;
 }
-/** A model returned from the catalog model search. */
+/**
+ * A model from the BiOS model catalog. The catalog is served from the
+ * platform's own registry: every listed model is hosted in BiOS storage,
+ * verified end-to-end, and can be trained and deployed. It is never a live
+ * Hugging Face search result — a model that is not listed is not hosted.
+ */
 export interface Model {
     /** Full model id (e.g. "meta-llama/Llama-3.1-8B"). */
     id: string;
@@ -111,30 +116,58 @@ export interface Model {
     totalParams: number;
     /** Active parameter count in billions (differs from total for MoE models). */
     activeParams: number;
-    /** Architecture type: "dense" or "moe". */
-    architecture: 'dense' | 'moe';
-    /** Model type: "llm" or "vlm". */
-    modelType: 'llm' | 'vlm';
-    /** Raw model_type from config.json. */
+    /** Alias of totalParams returned by the search route. */
+    params?: number;
+    /** Model family kind: "dense" or "moe". */
+    kind?: 'dense' | 'moe';
+    /** Whether this is a Mixture-of-Experts model. */
+    isMoE?: boolean;
+    /** Serving surface: "llm" (text) or "vlm" (vision-language). */
+    surfaceType?: 'llm' | 'vlm';
+    /**
+     * Raw model_type from the hosted model's config.json. Legacy field name —
+     * resolved from the BiOS registry copy, never from Hugging Face.
+     */
     hfModelType: string | null;
+    /**
+     * Architecture class (e.g. "LlamaForCausalLM") from the hosted model's
+     * config.json. Legacy field name, same registry provenance as hfModelType.
+     */
+    hfArchitecture?: string | null;
+    /** Precision of the hosted weights (e.g. "bf16"), when known. */
+    precision?: string;
     /** Download count from the catalog. */
     downloads: number;
     /** Like count from the catalog. */
     likes: number;
-    /** Whether this is a private model. */
-    isPrivate: boolean;
-    /** Whether this is an adapter/LoRA model. */
-    isAdapter: boolean;
-}
-/** Parameters for searching models. */
+    /** Always false for catalog models — hosted weights are never gated. */
+    gated?: boolean;
+    /** Short description from the registry. */
+    summary?: string;
+    /** Always true: every catalog model is verified for serving. */
+    servingSupported?: boolean;
+    /** Always true: every catalog model is verified for training. */
+    trainSupported?: boolean;
+    /** Registry visibility: "public" or "private" (partner-hosted models). */
+    visibility?: string;
+    /** @deprecated Legacy alias for kind. Not populated by the current API. */
+    architecture?: 'dense' | 'moe';
+    /** @deprecated Legacy alias for surfaceType. Not populated by the current API. */
+    modelType?: 'llm' | 'vlm';
+    /** @deprecated Not populated by the current API — hosted models are visible to every workspace. */
+    isPrivate?: boolean;
+    /** @deprecated Not populated by the current API — the catalog carries verified full base models only. */
+    isAdapter?: boolean;
+}
+/** Parameters for searching the BiOS model catalog (platform-hosted models only). */
 export interface ModelSearchParams {
     /** Search query string. */
     query?: string;
-    /** Filter by model type: "all", "llm", or "vlm". */
+    /** Filter by model surface: "all", "llm", or "vlm". */
     type?: 'all' | 'llm' | 'vlm';
     /** Pagination offset. Defaults to 0. */
     offset?: number;
-    /** Number of results to return. Max 50, defaults to 20. */
+    /** Number of results to return. Server defaults to 24 and clamps to 60. */
     limit?: number;
     /** Minimum parameter count in billions. */
     minParams?: number;
@@ -142,13 +175,25 @@ export interface ModelSearchParams {
     maxParams?: number;
     /** Sort order: "downloads", "likes", or "trending". */
     sort?: 'downloads' | 'likes' | 'trending';
-    /** Filter by author/organization. */
+    /**
+     * @deprecated Ignored by the registry-backed catalog. Include the author in
+     * `query` instead — model ids are "author/name" and match as text.
+     */
     author?: string;
-    /** Visibility filter: "all", "public", or "private". */
+    /**
+     * @deprecated Ignored by the registry-backed catalog — hosted models are
+     * visible to every workspace (partner models are labeled via `visibility`).
+     */
     visibility?: 'all' | 'public' | 'private';
-    /** Model kind: "full" (base models only) or "adapter". */
+    /**
+     * @deprecated Ignored by the registry-backed catalog — it carries verified
+     * full base models only, so no adapter/quantized filtering is needed.
+     */
     kind?: 'full' | 'adapter';
-    /** Integration ID for accessing private models. */
+    /**
+     * @deprecated Ignored by the registry-backed catalog — hosted models never
+     * require a Hugging Face integration (legacy from the live-HF era).
+     */
     integrationId?: string;
 }
 /** Response from a model search. */
@@ -158,9 +203,13 @@ export interface ModelSearchResponse {
     offset: number;
     limit: number;
     hasMore: boolean;
-    hfUsername: string;
+    /**
+     * @deprecated Legacy field from the live-Hugging-Face era. The registry-
+     * backed catalog no longer returns it — hosted models need no HF account.
+     */
+    hfUsername?: string;
 }
-/** Model configuration from the model's config.json. */
+/** Model configuration resolved from the registry's hosted copy of the model. */
 export interface ModelConfig {
     /** Full model id. */
     modelId: string;
@@ -407,7 +456,12 @@ export interface GPUChoice {
 export interface TrainingCreateParams {
     /** Stable retry key. Reuse it after a timeout; a new value creates a new job. Auto-generated when omitted. */
     idempotencyKey?: string;
-    /** Model id to fine-tune. */
+    /**
+     * Model id to fine-tune. Must be hosted on BiOS — pick from the platform's
+     * own catalog (client.models.search); arbitrary Hugging Face ids are
+     * rejected. Training FROM a fine-tuned model (adapter stacking) is not
+     * supported; every job starts from a catalog base model.
+     */
     model: string;
     /** Optional model branch, tag, or commit; the API canonicalizes it to an exact commit. */
     modelRevision?: string;
@@ -970,12 +1024,26 @@ export interface InferenceServingConfig {
 }
 export interface InferenceCreateParams {
     name: string;
+    /**
+     * Deployment source: a verified training checkpoint, or 'hf_model' — the
+     * legacy wire name for a base model from the BiOS catalog (the platform's
+     * own hosted registry, never a live Hugging Face reference).
+     */
     sourceType: 'checkpoint' | 'hf_model';
     sourceJobId?: string;
     sourceCheckpointId?: string;
+    /**
+     * Catalog model id (e.g. "meta-llama/Llama-3.1-8B-Instruct"), required with
+     * sourceType 'hf_model'. Legacy field name: the model must be hosted on
+     * BiOS (see client.models.search) — arbitrary Hugging Face ids are rejected.
+     */
     hfModelId?: string;
     /** Exact 40-hex commit returned by deployment preflight. */
     hfModelRevision?: string;
+    /**
+     * @deprecated Legacy field kept for wire compatibility. Catalog models are
+     * pre-mirrored and never gated, so no integration is needed to deploy them.
+     */
     hfIntegrationId?: string;
     baseModelId?: string;
     /** Exact base-model commit returned by deployment preflight. */
@@ -1017,9 +1085,11 @@ export interface InferenceDeployment {
     /** Compatibility alias for status_reason. */
     error_code?: string | null;
     desired_state: 'running' | 'stopped';
+    /** 'hf_model' is the legacy wire name for a BiOS-catalog base model. */
     source_type: 'checkpoint' | 'hf_model';
     source_job_id?: string;
     source_checkpoint_id?: string;
+    /** Catalog model id. Legacy field name — hosted on BiOS, not live Hugging Face. */
     hf_model_id?: string;
     hf_model_revision?: string | null;
     base_model_id?: string;
@@ -1262,7 +1332,10 @@ export interface InferenceGPUOptionsParams {
     revision?: string;
     /** Size from an existing deployment's pinned facts instead of a model id. */
     inferenceId?: string;
-    /** Integration for gated models when using `model`. */
+    /**
+     * @deprecated Legacy field kept for wire compatibility — catalog models are
+     * pre-mirrored and never gated, so no integration is needed with `model`.
+     */
     hfIntegrationId?: string;
     /** DEPRECATED client-fact path; required only when `model`/`inferenceId` are absent. */
     paramsB?: number;
@@ -1296,11 +1369,14 @@ export interface InferencePreflightWarning {
 }
 export interface InferenceCanonicalRequest {
     name: string;
+    /** 'hf_model' is the legacy wire name for a BiOS-catalog base model. */
     source_type: 'checkpoint' | 'hf_model';
     source_job_id?: string;
     source_checkpoint_id?: string;
+    /** Catalog model id. Legacy field name — hosted on BiOS, not live Hugging Face. */
     hf_model_id?: string;
     hf_model_revision?: string;
+    /** Legacy field — catalog models never need an integration. */
     hf_integration_id?: string;
     base_model_id: string;
     base_model_revision: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bios-sdk",
-  "version": "0.1.1-rc.20",
+  "version": "0.1.1-rc.26",
   "description": "Official TypeScript SDK for the BIOS training and deployment platform API",
   "type": "module",
   "main": "./dist/index.js",