runbios-sdk 0.2.14-dev.244 → 0.2.14-dev.246

package/README.md

@@ -251,6 +251,34 @@ const compat = await client.models.getAdapterCompatibility({
 });
 ```
 
+#### Models this credential can invoke
+
+`client.models.list()` reads the unified `GET /v1/models` roster with the SDK's
+platform API key: serverless pool models and workspace deployments appear only
+when that key's scopes permit them. `client.models.retrieve(id)` uses the same
+scope and workspace boundary. The trainable `models.search()` / `models.get()`
+registry above is separate; a registry result does not guarantee that this
+credential can invoke it.
+
+When a dedicated inference key is configured separately, use
+`client.inference.listModels()` and `client.inference.retrieveModel(id)`: they
+use the exact inference key and base URL selected for chat completions. Model
+ids containing `author/name` are encoded safely. A partially readable list
+includes `usf_unreachable_sources`; an unavailable source is not proof there
+are no models in it. Neither SDK retries a failed inference request for you.
+
+```typescript
+const available = await client.inference.listModels();
+for (const model of available.data) console.log(model.id);
+if (available.usf_unreachable_sources?.length) {
+  console.log('Some model sources were unreachable; retry discovery before concluding they are empty.');
+}
+if (available.data.length) {
+  const detail = await client.inference.retrieveModel(available.data[0].id);
+  console.log(detail.id);
+}
+```
+
 ### Datasets
 
 ```typescript

package/dist/index.d.ts

@@ -36,7 +36,7 @@ import { Loop } from './resources/loop.js';
  * SDK version. Sent as part of the User-Agent header.
  * Must match package.json "version" -- enforced by a contract test.
  */
-export declare const VERSION = "0.2.14-dev.244";
+export declare const VERSION = "0.2.14-dev.246";
 export declare class RunBiOS {
     /** Search models, fetch configs, check adapter compatibility. */
     readonly models: Models;
@@ -75,7 +75,7 @@ export { Training } from './resources/training.js';
 export { Wallet } from './resources/wallet.js';
 export { GPU, type GPURecommendation } from './resources/gpu.js';
 export { Inference, validateChatRequest, parseSSE, buildInferenceRequest, contextSizingBasis, type ContextSizingBasis, CONTEXT_DEFAULT_CEILING, CONTEXT_EDITABLE_FLOOR, type ChatMessage, type FunctionTool, type ChatCompletionParams, type ChatCompletionResponse, type ChatCompletionChunk, type ServerlessUsageWindow, type ServerlessTimeseriesMetric, type ServerlessWorkspaceLimits, type ServerlessUsageEnvelope, type ServerlessUsageOverviewResponse, type ServerlessUsageRowsResponse, type ServerlessUsageTimeseriesResponse, type ServerlessUsageDailyResponse, type ServerlessSavingsTotals, type ServerlessSavingsPeriod, type ServerlessUsageSavingsResponse, } from './resources/inference.js';
-export type { BiOSConfig, PaginatedResponse, ApiErrorBody, AvailableGpuAlternative, CapacityMinimumRequirement, InferenceBookingAccepted, Model, ModelSearchParams, ModelSearchResponse, ModelDetailResponse, ModelConfig, Dataset, DatasetListParams, DatasetListResponse, DatasetUploadParams, DatasetPreview, DatasetPreviewParams, DatasetImportHFParams, DatasetRegisterHFParams, DatasetHubSearchParams, DatasetHubPreviewParams, DatasetValidation, DatasetFormatVariant, DatasetFormatSpec, DatasetFormatSpecs, DatasetStorageUsage, TrainingMethod, RLHFAlgorithm, AdapterType, TrainingJobStatus, TrainingStatusFilter, TrainingCreateParams, TrainingListParams, TrainingListResponse, TrainingJob, TrainingMetrics, TrainingResourceMetrics, TrainingDeviceMetrics, MetricPoint, MetricGraphConfig, TrainingCheckpoint, TrainingLogs, TrainingLogEntry, TrainingStopResponse, TrainingResumeResponse, CanonicalTrainingRequest, TrainingPreflightDataset, TrainingPreflightWarning, TrainingPreflightResponse, TrainingCapabilityChoice, TrainingConfigFieldCapability, TrainingCapabilities, GPUChoice, WalletBalance, Transaction, TransactionListResponse, TransactionListParams, GPUInfo, GPUPricingResponse, GPUOptionsParams, TrainingRecommendParams, TrainingAdvisorVerdict, TrainingAdvisorRecommendation, TrainingAdvisorUserShape, TrainingAdvisorJustification, TrainingAdvisorBasis, GPUOption, GPUOptionSuggestion, GPUOptionsResponse, InferenceStatus, InferenceCreateParams, InferenceUpdateParams, InferenceDeployment, InferenceDeploymentSummary, InferenceCreateResponse, InferenceListResponse, InferenceUpdateResponse, InferenceLifecycleResponse, InferenceDeleteResponse, InferenceGPUOptionMarket, InferenceGPUOption, InferenceGPUAlternative, InferenceGPUOptionsParams, InferenceGPUOptionsResponse, InferenceCanonicalRequest, InferencePreflightWarning, InferencePreflightResponse, AdapterCompatibility, AdapterCompatibilityResponse, AdapterCompatibilityParams, SupportedArchitecture, ArchitectureScope, SupportedArchitecturesResponse, ApiKey, ApiKeyScope, ApiKeyIntrospection, Organization, OrgMember, OrgInvite, Workspace, Integration, IntegrationCreateParams, StorageUsage, StorageObject, PromptTokensDetails, ChatCompletionUsage, TrainingCadence, TrainingCombinator, ServingKind, TrainingRulePausedReason, LoopTrainingMethod, TrainType, GradersScope, TrainingTrigger, TrainingRecipe, TrainingRunState, TrainingVerdict, TrainingDecision, NotifyState, EvaluationStatus, EvaluationItemStatus, EvaluationWinner, EvaluationWarningCode, ConsentVia, TrainingToolCall, TrainingMessage, TrainingRuleServing, TrainingGPURung, TrainingRule, TrainingRuleConsent, TrainingRulePreflightRefusal, TrainingRuleKeyRef, TrainingRuleKeyCheck, TrainingRulePreflight, TrainingRuleBuildSpec, TrainingRuleTriggerInput, TrainingRuleTrainingInput, TrainingRuleDeployInput, TrainingRuleMoneyInput, TrainingRuleEvaluationInput, TrainingRulePromotionInput, TrainingRuleAcceptTerms, TrainingRulePreflightRequest, TrainingRuleCreateRequest, TrainingRuleUpdateRequest, TrainingRuleConsentRequest, TrainingRuleListParams, TrainingRunPromoteRequest, TrainingRunRejectRequest, TrainingRunRollbackRequest, TrainingRunCancelRequest, TrainingRunListParams, TrainingRun, TrainingRunSummary, TrainingRunEvent, TrainingRunLinks, TrainingRunActions, EvaluationRef, EvaluationDecoding, EvaluationJudgeDimension, EvaluationDimensionScore, EvaluationGraderScore, EvaluationWarning, EvaluationMargin, JudgeAgreementDimension, JudgeAgreement, Evaluation, EvaluationItemSide, EvaluationItem, EvaluationItemListParams, JudgeAgreementParams, AgentSettings, AgentSettingsRequest, BenchmarkStatus, BenchmarkSourceKind, BenchmarkRunStatus, BenchmarkScoring, BenchmarkDimensionScore, Benchmark, BenchmarkItem, BenchmarkRun, BenchmarkHistoryPoint, BenchmarkSource, BenchmarkCreateParams, BenchmarkListParams, BenchmarkItemListParams, BenchmarkHistoryParams, BenchmarkRetireParams, TrainingRuleBenchmarkRequest, InferenceAlias, InferenceAliasRequest, TrainingRuleListResponse, TrainingRuleResponse, TrainingRuleMutationResponse, TrainingRuleDeleteResponse, TrainingRunListResponse, TrainingRunResponse, TrainingRunActionResponse, EvaluationItemsResponse, AgentSettingsResponse, InferenceAliasListResponse, InferenceAliasResponse, InferenceAliasDeleteResponse, BenchmarkListResponse, BenchmarkItemsResponse, BenchmarkHistoryResponse, TrainingRuleRunRefusalCode, TrainingRuleMonthlyLimitRefusal, LoopDatasetDeleteRefusalCode, PipelineStatus, PipelineRecipeExploration, PipelineActiveRun, PipelineVersion, Pipeline, PipelineListResponse, PipelineResponse, } from './types.js';
+export type { BiOSConfig, PaginatedResponse, ApiErrorBody, AvailableGpuAlternative, CapacityMinimumRequirement, InferenceBookingAccepted, Model, ModelSearchParams, ModelSearchResponse, ModelDetailResponse, InferenceModel, InferenceModelListResponse, ModelConfig, Dataset, DatasetListParams, DatasetListResponse, DatasetUploadParams, DatasetPreview, DatasetPreviewParams, DatasetImportHFParams, DatasetRegisterHFParams, DatasetHubSearchParams, DatasetHubPreviewParams, DatasetValidation, DatasetFormatVariant, DatasetFormatSpec, DatasetFormatSpecs, DatasetStorageUsage, TrainingMethod, RLHFAlgorithm, AdapterType, TrainingJobStatus, TrainingStatusFilter, TrainingCreateParams, TrainingListParams, TrainingListResponse, TrainingJob, TrainingMetrics, TrainingResourceMetrics, TrainingDeviceMetrics, MetricPoint, MetricGraphConfig, TrainingCheckpoint, TrainingLogs, TrainingLogEntry, TrainingStopResponse, TrainingResumeResponse, CanonicalTrainingRequest, TrainingPreflightDataset, TrainingPreflightWarning, TrainingPreflightResponse, TrainingCapabilityChoice, TrainingConfigFieldCapability, TrainingCapabilities, GPUChoice, WalletBalance, Transaction, TransactionListResponse, TransactionListParams, GPUInfo, GPUPricingResponse, GPUOptionsParams, TrainingRecommendParams, TrainingAdvisorVerdict, TrainingAdvisorRecommendation, TrainingAdvisorUserShape, TrainingAdvisorJustification, TrainingAdvisorBasis, GPUOption, GPUOptionSuggestion, GPUOptionsResponse, InferenceStatus, InferenceCreateParams, InferenceUpdateParams, InferenceDeployment, InferenceDeploymentSummary, InferenceCreateResponse, InferenceListResponse, InferenceUpdateResponse, InferenceLifecycleResponse, InferenceDeleteResponse, InferenceGPUOptionMarket, InferenceGPUOption, InferenceGPUAlternative, InferenceGPUOptionsParams, InferenceGPUOptionsResponse, InferenceCanonicalRequest, InferencePreflightWarning, InferencePreflightResponse, AdapterCompatibility, AdapterCompatibilityResponse, AdapterCompatibilityParams, SupportedArchitecture, ArchitectureScope, SupportedArchitecturesResponse, ApiKey, ApiKeyScope, ApiKeyIntrospection, Organization, OrgMember, OrgInvite, Workspace, Integration, IntegrationCreateParams, StorageUsage, StorageObject, PromptTokensDetails, ChatCompletionUsage, TrainingCadence, TrainingCombinator, ServingKind, TrainingRulePausedReason, LoopTrainingMethod, TrainType, GradersScope, TrainingTrigger, TrainingRecipe, TrainingRunState, TrainingVerdict, TrainingDecision, NotifyState, EvaluationStatus, EvaluationItemStatus, EvaluationWinner, EvaluationWarningCode, ConsentVia, TrainingToolCall, TrainingMessage, TrainingRuleServing, TrainingGPURung, TrainingRule, TrainingRuleConsent, TrainingRulePreflightRefusal, TrainingRuleKeyRef, TrainingRuleKeyCheck, TrainingRulePreflight, TrainingRuleBuildSpec, TrainingRuleTriggerInput, TrainingRuleTrainingInput, TrainingRuleDeployInput, TrainingRuleMoneyInput, TrainingRuleEvaluationInput, TrainingRulePromotionInput, TrainingRuleAcceptTerms, TrainingRulePreflightRequest, TrainingRuleCreateRequest, TrainingRuleUpdateRequest, TrainingRuleConsentRequest, TrainingRuleListParams, TrainingRunPromoteRequest, TrainingRunRejectRequest, TrainingRunRollbackRequest, TrainingRunCancelRequest, TrainingRunListParams, TrainingRun, TrainingRunSummary, TrainingRunEvent, TrainingRunLinks, TrainingRunActions, EvaluationRef, EvaluationDecoding, EvaluationJudgeDimension, EvaluationDimensionScore, EvaluationGraderScore, EvaluationWarning, EvaluationMargin, JudgeAgreementDimension, JudgeAgreement, Evaluation, EvaluationItemSide, EvaluationItem, EvaluationItemListParams, JudgeAgreementParams, AgentSettings, AgentSettingsRequest, BenchmarkStatus, BenchmarkSourceKind, BenchmarkRunStatus, BenchmarkScoring, BenchmarkDimensionScore, Benchmark, BenchmarkItem, BenchmarkRun, BenchmarkHistoryPoint, BenchmarkSource, BenchmarkCreateParams, BenchmarkListParams, BenchmarkItemListParams, BenchmarkHistoryParams, BenchmarkRetireParams, TrainingRuleBenchmarkRequest, InferenceAlias, InferenceAliasRequest, TrainingRuleListResponse, TrainingRuleResponse, TrainingRuleMutationResponse, TrainingRuleDeleteResponse, TrainingRunListResponse, TrainingRunResponse, TrainingRunActionResponse, EvaluationItemsResponse, AgentSettingsResponse, InferenceAliasListResponse, InferenceAliasResponse, InferenceAliasDeleteResponse, BenchmarkListResponse, BenchmarkItemsResponse, BenchmarkHistoryResponse, TrainingRuleRunRefusalCode, TrainingRuleMonthlyLimitRefusal, LoopDatasetDeleteRefusalCode, PipelineStatus, PipelineRecipeExploration, PipelineActiveRun, PipelineVersion, Pipeline, PipelineListResponse, PipelineResponse, } from './types.js';
 /** The closed set of run states a training run never leaves. */
 export { TERMINAL_RUN_STATES } from './types.js';
 /** The most versions a pipeline may be set to make. */

package/dist/index.js

@@ -36,7 +36,7 @@ import { Loop } from './resources/loop.js';
  * SDK version. Sent as part of the User-Agent header.
  * Must match package.json "version" -- enforced by a contract test.
  */
-export const VERSION = '0.2.14-dev.244';
+export const VERSION = '0.2.14-dev.246';
 export class RunBiOS {
     /** Search models, fetch configs, check adapter compatibility. */
     models;

package/dist/resources/inference.d.ts

@@ -1,5 +1,5 @@
 import type { HttpClient } from '../client.js';
-import type { InferenceDeployment, InferenceDeploymentSummary, InferenceBookingAccepted, InferenceCreateParams, InferenceCreateResponse, InferenceDeleteResponse, InferenceGPUOptionsParams, InferenceGPUOptionsResponse, InferenceLifecycleResponse, InferenceListParams, InferenceListResponse, InferenceNotificationListResponse, InferencePreflightResponse, InferenceUpdateResponse, InferenceUpdateParams, InferenceAlias, InferenceAliasRequest, InferenceAliasDeleteResponse } from '../types.js';
+import type { InferenceDeployment, InferenceDeploymentSummary, InferenceModel, InferenceModelListResponse, InferenceBookingAccepted, InferenceCreateParams, InferenceCreateResponse, InferenceDeleteResponse, InferenceGPUOptionsParams, InferenceGPUOptionsResponse, InferenceLifecycleResponse, InferenceListParams, InferenceListResponse, InferenceNotificationListResponse, InferencePreflightResponse, InferenceUpdateResponse, InferenceUpdateParams, InferenceAlias, InferenceAliasRequest, InferenceAliasDeleteResponse } from '../types.js';
 /**
  * Serving context-length policy, owned and enforced by the server. Mirrored
  * here for documentation only -- never to pre-empt a server verdict.
@@ -330,6 +330,9 @@ export declare class Inference {
     getGPUOptions(params: InferenceGPUOptionsParams): Promise<InferenceGPUOptionsResponse>;
     private prepare;
     private abortContext;
+    private modelRead;
+    listModels(inferenceKey?: string): Promise<InferenceModelListResponse>;
+    retrieveModel(modelId: string, inferenceKey?: string): Promise<InferenceModel>;
     chatCompletions(params: ChatCompletionParams): Promise<ChatCompletionResponse>;
     streamChatCompletions(params: ChatCompletionParams): AsyncGenerator<ChatCompletionChunk>;
 }

package/dist/resources/inference.js

@@ -1,5 +1,5 @@
 import { ApiError, GpuRejectionError, gpuRejectionCodeForReason, envApiKey, envBaseUrl, envInferenceKey } from '../client.js';
-import { readNativeMaxContext } from './models.js';
+import { asInferenceModel, asInferenceModelList, readNativeMaxContext } from './models.js';
 import { normalizeGPUPlacement } from './gpu-priorities.js';
 const FUNCTION_NAME = /^[A-Za-z0-9_-]{1,64}$/;
 const ROLES = new Set(['system', 'developer', 'user', 'assistant', 'tool', 'function']);
@@ -830,6 +830,46 @@ export class Inference {
             remove: () => signal?.removeEventListener('abort', relay),
         };
     }
+    async modelRead(path, inferenceKey) {
+        const key = inferenceKey || this.key;
+        if (!key)
+            throw new Error('an inferenceKey is required');
+        const abort = this.abortContext();
+        try {
+            const response = await fetch(`${this.baseUrl}${path}`, {
+                method: 'GET',
+                headers: { Authorization: `Bearer ${key}`, Accept: 'application/json', 'X-Request-ID': crypto.randomUUID() },
+                signal: abort.controller.signal,
+            });
+            if (!response.ok)
+                throw await apiError(response);
+            try {
+                return await response.json();
+            }
+            catch {
+                throw new ApiError(response.status, { error: { code: 'INVALID_MODEL_RESPONSE', message: 'Inference model discovery returned invalid JSON.' } });
+            }
+        }
+        catch (error) {
+            if (abort.controller.signal.aborted && !(error instanceof ApiError)) {
+                throw new ApiError(0, { error: String(abort.controller.signal.reason || 'Inference model discovery aborted') });
+            }
+            throw error;
+        }
+        finally {
+            clearTimeout(abort.timeoutId);
+            abort.remove();
+        }
+    }
+    async listModels(inferenceKey) {
+        return asInferenceModelList(await this.modelRead('/v1/models', inferenceKey));
+    }
+    async retrieveModel(modelId, inferenceKey) {
+        const id = typeof modelId === 'string' ? modelId.trim() : '';
+        if (!id)
+            throw new Error('RunBiOS: modelId is required to retrieve an inference model');
+        return asInferenceModel(await this.modelRead(`/v1/models/${encodeURIComponent(id)}`, inferenceKey));
+    }
     async chatCompletions(params) {
         const prepared = this.prepare(params, false);
         const abort = this.abortContext(prepared.signal);

package/dist/resources/models.d.ts

@@ -1,5 +1,5 @@
 import type { HttpClient } from '../client.js';
-import type { ModelDetailResponse, ModelSearchParams, ModelSearchResponse, ModelConfig, AdapterCompatibilityParams, AdapterCompatibilityResponse, ArchitectureScope, SupportedArchitecturesResponse } from '../types.js';
+import type { InferenceModel, InferenceModelListResponse, ModelDetailResponse, ModelSearchParams, ModelSearchResponse, ModelConfig, AdapterCompatibilityParams, AdapterCompatibilityResponse, ArchitectureScope, SupportedArchitecturesResponse } from '../types.js';
 /**
  * Access the Run BiOS model catalog -- search models, fetch
  * training-relevant configuration, and check adapter compatibility.
@@ -8,6 +8,8 @@ export declare class Models {
     private readonly _http;
     /** @internal */
     constructor(_http: HttpClient);
+    list(): Promise<InferenceModelListResponse>;
+    retrieve(modelId: string): Promise<InferenceModel>;
     /**
      * Search the Run BiOS model catalog -- the platform's own hosted, verified
      * models. Every result is mirrored in Run BiOS storage and can be trained and
@@ -98,6 +100,8 @@ export declare class Models {
         scope?: ArchitectureScope;
     }): Promise<SupportedArchitecturesResponse>;
 }
+export declare function asInferenceModelList(value: unknown): InferenceModelListResponse;
+export declare function asInferenceModel(value: unknown): InferenceModel;
 /** Registry detail path for an `author/name` catalog id, else undefined. @internal */
 export declare function modelDetailPath(modelId: string): string | undefined;
 /**

package/dist/resources/models.js

@@ -1,3 +1,4 @@
+import { ApiError } from '../client.js';
 /**
  * Access the Run BiOS model catalog -- search models, fetch
  * training-relevant configuration, and check adapter compatibility.
@@ -8,6 +9,15 @@ export class Models {
     constructor(_http) {
         this._http = _http;
     }
+    async list() {
+        return asInferenceModelList(await this._http.fetchGet('/v1/models'));
+    }
+    async retrieve(modelId) {
+        const id = typeof modelId === 'string' ? modelId.trim() : '';
+        if (!id)
+            throw new Error('RunBiOS: modelId is required to retrieve an inference model');
+        return asInferenceModel(await this._http.fetchGet(`/v1/models/${encodeURIComponent(id)}`));
+    }
     /**
      * Search the Run BiOS model catalog -- the platform's own hosted, verified
      * models. Every result is mirrored in Run BiOS storage and can be trained and
@@ -135,6 +145,22 @@ export class Models {
         return this._http.fetchGet(`/api/public/serving-architectures?${q}`);
     }
 }
+export function asInferenceModelList(value) {
+    const response = value && typeof value === 'object' ? value : null;
+    const data = response?.data;
+    if (response?.object !== 'list' || !Array.isArray(data) ||
+        !data.every(row => row && typeof row.id === 'string' && row.id.trim())) {
+        throw new ApiError(0, { error: { code: 'INVALID_MODELS_RESPONSE', message: 'Inference model discovery returned an invalid list; retry instead of treating it as empty.' } });
+    }
+    return value;
+}
+export function asInferenceModel(value) {
+    const model = value && typeof value === 'object' ? value : null;
+    if (model?.object !== 'model' || typeof model?.id !== 'string' || !model.id.trim()) {
+        throw new ApiError(0, { error: { code: 'INVALID_MODEL_RESPONSE', message: 'Inference model retrieval returned an invalid model; retry or list available models.' } });
+    }
+    return value;
+}
 /** Registry detail path for an `author/name` catalog id, else undefined. @internal */
 export function modelDetailPath(modelId) {
     const repo = (modelId || '').trim().replace(/^\/+|\/+$/g, '');

package/dist/types.d.ts

@@ -215,6 +215,22 @@ export interface ModelDetailResponse {
      */
     primary_revision?: string;
 }
+export interface InferenceModel {
+    id: string;
+    object: string;
+    owned_by?: string;
+    created?: number;
+    [field: string]: unknown;
+}
+export interface InferenceModelListResponse {
+    object: string;
+    data: InferenceModel[];
+    usf_unreachable_sources?: Array<{
+        source: string;
+        reason: string;
+    }>;
+    [field: string]: unknown;
+}
 export interface ModelSearchParams {
     /**
      * Search text. Becomes the registry's `q` filter -- the ONLY search

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "runbios-sdk",
-  "version": "0.2.14-dev.244",
+  "version": "0.2.14-dev.246",
   "description": "Official TypeScript SDK for the Run BiOS training and deployment platform API",
   "type": "module",
   "main": "./dist/index.js",