@dbx-tools/dbx-model-catalog 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,24 @@
-# Temporary Holding Version
+# @dbx-tools/dbx-model-catalog
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Node client connects to the Python-owned model catalog contract. It starts a
+local Pynect worker by default or connects to a remote Chanx WebSocket server
+when a URL is provided.
+
+```ts
+import { connectModelCatalog } from "@dbx-tools/dbx-model-catalog";
+
+await using local = await connectModelCatalog();
+const matches = await local.client.list({ query: "gpt", limit: 10 });
+
+await using remote = await connectModelCatalog("wss://catalog.example.com");
+const catalog = await remote.client.catalog();
+```
+
+Pass `{ python: "/path/to/python" }` to select the Python executable used for
+the local worker. The npm artifact includes the Python service source; Pynect
+uses uv to provision its isolated environment on the first local connection.
+Generated catalog types are re-exported from this package. The package does not
+contain a separate JavaScript schema implementation.
+
+For direct public ingestion without the service client, fetch:
+<https://reggie-db.github.io/dbx-model-catalog/catalog.json>.

package/dist/_generated/channels.d.ts

@@ -0,0 +1,17 @@
+import type { GetCatalogRequest, GetCatalogResponse, GetSearchIndexRequest, GetSearchIndexResponse, ListModelsRequest, ListModelsResponse, StreamModelsRequest, StreamModelsResponse } from './schemas.js';
+export type ModelsToServer = GetCatalogRequest | GetSearchIndexRequest | ListModelsRequest | StreamModelsRequest;
+export type ModelsToClient = GetCatalogResponse | GetSearchIndexResponse | ListModelsResponse | StreamModelsResponse;
+export type ModelsReplies = {
+    get_catalog: GetCatalogResponse;
+    get_search_index: GetSearchIndexResponse;
+    list_models: ListModelsResponse;
+    stream_models: StreamModelsResponse;
+};
+export declare const models: import("@chanx-js/client").ChannelDescriptor<ModelsToServer, ModelsToClient, "/ws/models", Record<never, never>, ModelsReplies> & {
+    streamActions: readonly ["stream_models"];
+};
+export declare const channels: {
+    readonly models: import("@chanx-js/client").ChannelDescriptor<ModelsToServer, ModelsToClient, "/ws/models", Record<never, never>, ModelsReplies> & {
+        streamActions: readonly ["stream_models"];
+    };
+};

package/dist/_generated/index.d.ts

@@ -0,0 +1,3 @@
+export * from './schemas.js';
+export * from './channels.js';
+export { createPynectClient, type PynectClientOptions } from 'pynect';

package/dist/_generated/schemas.d.ts

@@ -0,0 +1,329 @@
+/** Model availability on one Databricks cloud provider. */
+export interface Availability {
+    status: Status1;
+    serving_modes: Array<ServingMode>;
+    details?: string | null;
+}
+/** Normalized Databricks price in one currency. */
+export interface AveragePrice {
+    unit: Unit;
+    rates: Record<string, number>;
+}
+/** Task-suite benchmark result. */
+export interface Benchmark {
+    name: string;
+    rank: number;
+    score: number;
+    task_count: number;
+    published_at?: string | null;
+    variant?: Variant2 | null;
+    sources: Array<SourceLink>;
+}
+/** Supported reasoning-token budget range. */
+export interface Budget {
+    min?: number | null;
+    max?: number | null;
+}
+/** Capabilities used to select the model for a workload. */
+export interface Capabilities {
+    attachments?: boolean | null;
+    tools?: boolean | null;
+    structured_output?: boolean | null;
+    temperature?: boolean | null;
+    interleaved_reasoning?: boolean | null;
+    web_search: boolean;
+    reasoning?: Reasoning | Reasoning1 | null;
+}
+export interface CatalogFilters {
+    query?: string | null;
+    status?: Array<Status>;
+    type?: Array<Type>;
+    publisher?: Array<string>;
+    task?: Array<string>;
+    capability?: Array<"attachments" | "reasoning" | "structured-output" | "tools" | "web-search">;
+    limit?: number | null;
+}
+/** Published statistics for one Databricks model. */
+export interface CatalogModel {
+    name: string;
+    description: string;
+    aliases: Array<string>;
+    type: Type;
+    family?: string | null;
+    publisher?: string | null;
+    license?: string | null;
+    open_weights?: boolean | null;
+    status: Status;
+    release_date?: string | null;
+    last_updated?: string | null;
+    knowledge_cutoff?: string | null;
+    retirement?: Retirement | null;
+    modalities: Modalities;
+    capabilities: Capabilities;
+    limits?: Limits | null;
+    tasks: Array<string>;
+    use_cases: Array<string>;
+    availability: Record<string, Availability>;
+    price: Record<string, Record<string, Price>>;
+    average_price: Record<string, AveragePrice>;
+    sources: Record<string, Array<SourceLink>>;
+    notices: Array<Notice>;
+    rankings: Array<Rankings | Rankings1>;
+    benchmarks: Array<Benchmark>;
+}
+export interface CatalogModelRecord {
+    name: string;
+    description: string;
+    aliases: Array<string>;
+    type: Type;
+    family?: string | null;
+    publisher?: string | null;
+    license?: string | null;
+    open_weights?: boolean | null;
+    status: Status;
+    release_date?: string | null;
+    last_updated?: string | null;
+    knowledge_cutoff?: string | null;
+    retirement?: Retirement | null;
+    modalities: Modalities;
+    capabilities: Capabilities;
+    limits?: Limits | null;
+    tasks: Array<string>;
+    use_cases: Array<string>;
+    availability: Record<string, Availability>;
+    price: Record<string, Record<string, Price>>;
+    average_price: Record<string, AveragePrice>;
+    sources: Record<string, Array<SourceLink>>;
+    notices: Array<Notice>;
+    rankings: Array<Rankings | Rankings1>;
+    benchmarks: Array<Benchmark>;
+    id: string;
+}
+export interface CatalogSearchIndexDocument {
+    id: string;
+    exact_identities: Array<string>;
+    identities: Array<string>;
+    keywords: string;
+    description: string;
+    tokens: Array<string>;
+    family?: string | null;
+    version: Array<number>;
+    quality_score: number;
+    scores: CatalogSearchQualityScores;
+}
+export interface CatalogSearchIndexPayload {
+    schema_version: number;
+    catalog_schema_version: number;
+    updated_at: string;
+    weights: CatalogSearchWeights;
+    documents: Array<CatalogSearchIndexDocument>;
+}
+export interface CatalogSearchQualityScores {
+    leaderboard: number;
+    benchmark: number;
+    version: number;
+    freshness: number;
+    lifecycle: number;
+}
+export interface CatalogSearchWeights {
+    relevance: number;
+    leaderboard: number;
+    benchmark: number;
+    version: number;
+    freshness: number;
+    lifecycle: number;
+}
+/** Default reasoning effort when no level is specified. */
+export type DefaultEffort = "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max" | "default";
+/** Normalized reasoning effort level. */
+export type EffortEnum = "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max" | "default";
+export interface GetCatalogRequest {
+    action: "get_catalog";
+    payload: CatalogFilters;
+}
+export interface GetCatalogResponse {
+    action: "catalog";
+    payload: ModelCatalog;
+}
+export interface GetSearchIndexRequest {
+    action: "get_search_index";
+    payload: CatalogFilters;
+}
+export interface GetSearchIndexResponse {
+    action: "search_index";
+    payload: CatalogSearchIndexPayload;
+}
+/** Known model input and output modalities. */
+export type Input = "text" | "image" | "audio" | "video" | "application/pdf" | "embedding" | "reranking" | "decision";
+/** Known Databricks documentation notice kinds. */
+export type Kind = "note" | "important" | "warning" | "tip" | "caution" | "info";
+/** Documented token limits. */
+export interface Limits {
+    context?: number | null;
+    input?: number | null;
+    output?: number | null;
+}
+export interface ListModelsRequest {
+    action: "list_models";
+    payload: CatalogFilters;
+}
+export interface ListModelsResponse {
+    action: "models";
+    payload: Array<CatalogModelRecord>;
+}
+/** Model input and output modalities. */
+export interface Modalities {
+    input: Array<Input | string>;
+    output: Array<Output | string>;
+}
+/** Published Databricks model catalog with identity, capabilities, availability, pricing, lifecycle, rankings, and benchmarks. */
+export interface ModelCatalog {
+    schema_version: 15;
+    updated_at: string;
+    models: Record<string, CatalogModel>;
+}
+/** Important Databricks documentation notice. */
+export interface Notice {
+    kind: Kind | string;
+    title?: string | null;
+    text: string;
+    sources: Array<SourceLink>;
+}
+/** Known model input and output modalities. */
+export type Output = "text" | "image" | "audio" | "video" | "application/pdf" | "embedding" | "reranking" | "decision";
+/** Normalized Databricks price in one currency. */
+export interface Price {
+    unit: Unit;
+    rates: Record<string, number>;
+}
+/** An RFC 9457 problem details object, the payload of an error frame. See https://python.chanx.dev/en/latest/protocol.html#protocol-errors */
+export interface ProblemDetails {
+    /** A URI reference that identifies the problem type. */
+    type: string;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    /** The HTTP status code generated by the origin server for this occurrence of the problem. */
+    status?: number;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+    /** The validation failures, when type is validation-failed. */
+    errors?: Array<ValidationFailure>;
+}
+/** Competitive ranking based on human preference ratings. */
+export interface Rankings {
+    domain: string;
+    category: string;
+    rank: number;
+    published_at?: string | null;
+    variant?: Variant | null;
+    sources: Array<SourceLink>;
+    metric: "rating";
+    rating: number;
+    lower: number;
+    upper: number;
+    variance: number;
+    votes: number;
+}
+/** Competitive ranking based on a scored evaluation. */
+export interface Rankings1 {
+    domain: string;
+    category: string;
+    rank: number;
+    published_at?: string | null;
+    variant?: Variant1 | null;
+    sources: Array<SourceLink>;
+    metric: "score";
+    score: number;
+    lower: number;
+    upper: number;
+    observations: number;
+    sessions: number | null;
+}
+/** Reasoning support and controls when known. */
+export interface Reasoning {
+    supported: false;
+}
+/** Reasoning support and controls when known. */
+export interface Reasoning1 {
+    supported: true;
+    effort?: Array<EffortEnum> | null;
+    default_effort?: DefaultEffort | null;
+    toggle?: boolean | null;
+    budget?: Budget | null;
+    description?: string | null;
+}
+/** Reasoning effort used by the evaluated variant. */
+export type ReasoningEffort = "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max" | "default";
+/** Reasoning execution mode used by the evaluated variant. */
+export type ReasoningMode = "auto" | "thinking";
+/** Databricks retirement and replacement information. */
+export interface Retirement {
+    schedules: Array<Schedule>;
+    replacement?: string | null;
+    replacement_name?: string | null;
+}
+/** Retirement dates for one serving offering. */
+export interface Schedule {
+    offering: string;
+    dates: Array<string>;
+}
+/** Databricks serving mode available for the model. */
+export type ServingMode = "pay_per_token" | "priority_pay_per_token" | "provisioned_throughput" | "batch";
+/** Openable attribution for published catalog data. */
+export interface SourceLink {
+    label: string;
+    url: string;
+}
+/** Current normalized lifecycle state. */
+export type Status = "active" | "preview" | "alpha" | "beta" | "legacy" | "deprecated" | "retired";
+/** Lifecycle state for this cloud-provider deployment. */
+export type Status1 = "active" | "preview" | "alpha" | "beta" | "legacy" | "deprecated" | "retired";
+export interface StreamModelsRequest {
+    action: "stream_models";
+    payload: CatalogFilters;
+}
+export interface StreamModelsResponse {
+    action: "model";
+    payload: CatalogModelRecord;
+}
+/** Normalized model type. */
+export type Type = "chat" | "image" | "video" | "embedding" | "reranking" | "decision" | "transcription" | "speech" | "realtime" | "extraction" | "audio";
+/** Quantity to which the rates apply. */
+export type Unit = "per_million_tokens" | "per_hour" | "per_hour_per_50_model_units";
+/** One validation failure, shaped like RFC 9457's validation example. */
+export interface ValidationFailure {
+    /** The JSON Schema keyword that failed, or custom. */
+    keyword: string;
+    /** A JSON Pointer to the failing value in the frame; for required, the object lacking the member. */
+    pointer: string;
+    /** A human-readable message. */
+    detail: string;
+    /** For required only: the missing member. */
+    property?: string | number;
+}
+/** Evaluated model variant when it differs from the base model. */
+export interface Variant {
+    reasoning?: boolean | null;
+    reasoning_effort?: ReasoningEffort | null;
+    reasoning_mode?: ReasoningMode | null;
+    harness?: string | null;
+    context?: number | null;
+}
+/** Evaluated model variant when it differs from the base model. */
+export interface Variant1 {
+    reasoning?: boolean | null;
+    reasoning_effort?: ReasoningEffort | null;
+    reasoning_mode?: ReasoningMode | null;
+    harness?: string | null;
+    context?: number | null;
+}
+/** Evaluated model variant when it differs from the base model. */
+export interface Variant2 {
+    reasoning?: boolean | null;
+    reasoning_effort?: ReasoningEffort | null;
+    reasoning_mode?: ReasoningMode | null;
+    harness?: string | null;
+    context?: number | null;
+}

package/dist/browser.d.ts

@@ -0,0 +1,7 @@
+import type { CatalogClient } from "./types.js";
+export type * from "./_generated/schemas.js";
+export type * from "./types.js";
+export interface CatalogClientOptions {
+    baseUrl: string;
+}
+export declare function createCatalogClient(options: CatalogClientOptions): CatalogClient;