notdiamond 2.0.0-rc2 → 2.0.0-rc20

package/resources/model-router.d.ts

@@ -0,0 +1,194 @@
+import { APIResource } from "../core/resource.js";
+import * as PromptAdaptationAPI from "./prompt-adaptation.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class ModelRouter extends APIResource {
+    /**
+     * Select the optimal LLM to handle your query based on Not Diamond's routing
+     * algorithm.
+     *
+     * This endpoint analyzes your messages and returns the best-suited model from your
+     * specified models. The router considers factors like query complexity, model
+     * capabilities, cost, and latency based on your preferences.
+     *
+     * **Key Features:**
+     *
+     * - Intelligent routing across multiple LLM providers
+     * - Support for custom routers trained on your evaluation data
+     * - Optional cost/latency optimization
+     * - Function calling support for compatible models
+     *
+     * **Usage:**
+     *
+     * 1. Pass your messages in OpenAI format (array of objects with 'role' and
+     *    'content')
+     * 2. Specify which LLM providers you want to route between
+     * 3. Optionally provide a preference_id to use a custom router that you've trained
+     * 4. Receive a recommended model and session_id
+     * 5. Use the session_id to submit feedback and improve routing
+     *
+     * **Related Endpoints:**
+     *
+     * - `POST /v2/preferences/userPreferenceCreate` - Create a preference ID for
+     *   personalized routing
+     * - `POST /v2/pzn/trainCustomRouter` - Train a custom router on your evaluation
+     *   data
+     *
+     * @example
+     * ```ts
+     * const response = await client.modelRouter.selectModel({
+     *   llm_providers: [
+     *     { provider: 'openai', model: 'gpt-4o' },
+     *     {
+     *       provider: 'anthropic',
+     *       model: 'claude-sonnet-4-5-20250929',
+     *     },
+     *     { provider: 'google', model: 'gemini-2.5-flash' },
+     *   ],
+     *   messages: [
+     *     {
+     *       role: 'system',
+     *       content: 'You are a helpful assistant.',
+     *     },
+     *     {
+     *       role: 'user',
+     *       content: 'Explain quantum computing in simple terms',
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    selectModel(params: ModelRouterSelectModelParams, options?: RequestOptions): APIPromise<ModelRouterSelectModelResponse>;
+}
+/**
+ * Response from model selection endpoint.
+ */
+export interface ModelRouterSelectModelResponse {
+    /**
+     * List containing the selected provider
+     */
+    providers: Array<ModelRouterSelectModelResponse.Provider>;
+    /**
+     * Unique session ID for this routing decision
+     */
+    session_id: string;
+}
+export declare namespace ModelRouterSelectModelResponse {
+    /**
+     * Selected LLM provider information from model selection endpoints.
+     *
+     * Part of ModelSelectResponse. Contains the provider and model that Not Diamond's
+     * routing algorithm selected as optimal for your query. Use these values to make
+     * your LLM API call to the recommended model.
+     */
+    interface Provider {
+        /**
+         * Model identifier for the selected model (e.g., 'gpt-4o',
+         * 'claude-3-opus-20240229')
+         */
+        model: string;
+        /**
+         * Provider name for the selected model (e.g., 'openai', 'anthropic', 'google')
+         */
+        provider: string;
+    }
+}
+export interface ModelRouterSelectModelParams {
+    /**
+     * Body param: List of LLM providers to route between. Specify at least one
+     * provider in format {provider, model}
+     */
+    llm_providers: Array<PromptAdaptationAPI.RequestProvider | ModelRouterSelectModelParams.OpenRouterProvider>;
+    /**
+     * Body param: Array of message objects in OpenAI format (with 'role' and 'content'
+     * keys)
+     */
+    messages: Array<{
+        [key: string]: string | Array<unknown>;
+    }> | string;
+    /**
+     * Query param: Optional format type. Use 'openrouter' to accept and return
+     * OpenRouter-format model identifiers
+     */
+    type?: string | null;
+    /**
+     * Body param: Whether to hash message content for privacy
+     */
+    hash_content?: boolean;
+    /**
+     * Body param: Maximum number of models to consider for routing. If not specified,
+     * considers all provided models
+     */
+    max_model_depth?: number | null;
+    /**
+     * Body param: Optimization metric for model selection
+     */
+    metric?: string;
+    /**
+     * Body param: Preference ID for personalized routing. Create one via POST
+     * /v2/preferences/userPreferenceCreate
+     */
+    preference_id?: string | null;
+    /**
+     * Body param: Previous session ID to link related requests
+     */
+    previous_session?: string | null;
+    /**
+     * Body param: OpenAI-format function calling tools
+     */
+    tools?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Body param: Optimization tradeoff strategy. Use 'cost' to prioritize cost
+     * savings or 'latency' to prioritize speed
+     */
+    tradeoff?: string | null;
+}
+export declare namespace ModelRouterSelectModelParams {
+    /**
+     * Model for specifying an LLM provider using OpenRouter format.
+     *
+     * Used in model routing requests when you want to specify providers using the
+     * OpenRouter naming convention (combined 'provider/model' format). This is an
+     * alternative to the standard RequestProvider which uses separate provider and
+     * model fields.
+     *
+     * **When to use:**
+     *
+     * - When working with OpenRouter-compatible systems
+     * - When you prefer the unified 'provider/model' format
+     * - For models accessed via OpenRouter proxy
+     */
+    interface OpenRouterProvider {
+        /**
+         * OpenRouter model identifier in 'provider/model' format (e.g., 'openai/gpt-4o',
+         * 'anthropic/claude-sonnet-4-5-20250929')
+         */
+        model: string;
+        /**
+         * Maximum context length for the model (required for custom models)
+         */
+        context_length?: number | null;
+        /**
+         * Input token price per million tokens in USD (required for custom models)
+         */
+        input_price?: number | null;
+        /**
+         * Whether this is a custom model not in Not Diamond's supported model list
+         */
+        is_custom?: boolean;
+        /**
+         * Average latency in seconds (required for custom models)
+         */
+        latency?: number | null;
+        /**
+         * Output token price per million tokens in USD (required for custom models)
+         */
+        output_price?: number | null;
+    }
+}
+export declare namespace ModelRouter {
+    export { type ModelRouterSelectModelResponse as ModelRouterSelectModelResponse, type ModelRouterSelectModelParams as ModelRouterSelectModelParams, };
+}
+//# sourceMappingURL=model-router.d.ts.map

package/resources/model-router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-router.d.ts","sourceRoot":"","sources":["../src/resources/model-router.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,WAAW,CACT,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAI9C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;IAE1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,mBAAmB,CAAC,eAAe,GAAG,4BAA4B,CAAC,kBAAkB,CAAC,CAAC;IAE5G;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC,GAAG,MAAM,CAAC;IAErE;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;;;;;;;;;;;OAaG;IACH,UAAiB,kBAAkB;QACjC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/model-router.js

@@ -0,0 +1,68 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelRouter = void 0;
+const resource_1 = require("../core/resource.js");
+class ModelRouter extends resource_1.APIResource {
+    /**
+     * Select the optimal LLM to handle your query based on Not Diamond's routing
+     * algorithm.
+     *
+     * This endpoint analyzes your messages and returns the best-suited model from your
+     * specified models. The router considers factors like query complexity, model
+     * capabilities, cost, and latency based on your preferences.
+     *
+     * **Key Features:**
+     *
+     * - Intelligent routing across multiple LLM providers
+     * - Support for custom routers trained on your evaluation data
+     * - Optional cost/latency optimization
+     * - Function calling support for compatible models
+     *
+     * **Usage:**
+     *
+     * 1. Pass your messages in OpenAI format (array of objects with 'role' and
+     *    'content')
+     * 2. Specify which LLM providers you want to route between
+     * 3. Optionally provide a preference_id to use a custom router that you've trained
+     * 4. Receive a recommended model and session_id
+     * 5. Use the session_id to submit feedback and improve routing
+     *
+     * **Related Endpoints:**
+     *
+     * - `POST /v2/preferences/userPreferenceCreate` - Create a preference ID for
+     *   personalized routing
+     * - `POST /v2/pzn/trainCustomRouter` - Train a custom router on your evaluation
+     *   data
+     *
+     * @example
+     * ```ts
+     * const response = await client.modelRouter.selectModel({
+     *   llm_providers: [
+     *     { provider: 'openai', model: 'gpt-4o' },
+     *     {
+     *       provider: 'anthropic',
+     *       model: 'claude-sonnet-4-5-20250929',
+     *     },
+     *     { provider: 'google', model: 'gemini-2.5-flash' },
+     *   ],
+     *   messages: [
+     *     {
+     *       role: 'system',
+     *       content: 'You are a helpful assistant.',
+     *     },
+     *     {
+     *       role: 'user',
+     *       content: 'Explain quantum computing in simple terms',
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    selectModel(params, options) {
+        const { type, ...body } = params;
+        return this._client.post('/v2/modelRouter/modelSelect', { query: { type }, body, ...options });
+    }
+}
+exports.ModelRouter = ModelRouter;
+//# sourceMappingURL=model-router.js.map

package/resources/model-router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-router.js","sourceRoot":"","sources":["../src/resources/model-router.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,WAAW,CACT,MAAoC,EACpC,OAAwB;QAExB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF;AA/DD,kCA+DC"}

package/resources/model-router.mjs

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class ModelRouter extends APIResource {
+    /**
+     * Select the optimal LLM to handle your query based on Not Diamond's routing
+     * algorithm.
+     *
+     * This endpoint analyzes your messages and returns the best-suited model from your
+     * specified models. The router considers factors like query complexity, model
+     * capabilities, cost, and latency based on your preferences.
+     *
+     * **Key Features:**
+     *
+     * - Intelligent routing across multiple LLM providers
+     * - Support for custom routers trained on your evaluation data
+     * - Optional cost/latency optimization
+     * - Function calling support for compatible models
+     *
+     * **Usage:**
+     *
+     * 1. Pass your messages in OpenAI format (array of objects with 'role' and
+     *    'content')
+     * 2. Specify which LLM providers you want to route between
+     * 3. Optionally provide a preference_id to use a custom router that you've trained
+     * 4. Receive a recommended model and session_id
+     * 5. Use the session_id to submit feedback and improve routing
+     *
+     * **Related Endpoints:**
+     *
+     * - `POST /v2/preferences/userPreferenceCreate` - Create a preference ID for
+     *   personalized routing
+     * - `POST /v2/pzn/trainCustomRouter` - Train a custom router on your evaluation
+     *   data
+     *
+     * @example
+     * ```ts
+     * const response = await client.modelRouter.selectModel({
+     *   llm_providers: [
+     *     { provider: 'openai', model: 'gpt-4o' },
+     *     {
+     *       provider: 'anthropic',
+     *       model: 'claude-sonnet-4-5-20250929',
+     *     },
+     *     { provider: 'google', model: 'gemini-2.5-flash' },
+     *   ],
+     *   messages: [
+     *     {
+     *       role: 'system',
+     *       content: 'You are a helpful assistant.',
+     *     },
+     *     {
+     *       role: 'user',
+     *       content: 'Explain quantum computing in simple terms',
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    selectModel(params, options) {
+        const { type, ...body } = params;
+        return this._client.post('/v2/modelRouter/modelSelect', { query: { type }, body, ...options });
+    }
+}
+//# sourceMappingURL=model-router.mjs.map

package/resources/model-router.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-router.mjs","sourceRoot":"","sources":["../src/resources/model-router.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,WAAW,CACT,MAAoC,EACpC,OAAwB;QAExB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF"}

package/resources/models.d.mts

@@ -33,40 +33,65 @@ export declare class Models extends APIResource {
      * **Caching:**
      *
      * - Response is cacheable for 1 hour (model list rarely changes)
+     *
+     * @example
+     * ```ts
+     * const models = await client.models.list();
+     * ```
      */
     list(query?: ModelListParams | null | undefined, options?: RequestOptions): APIPromise<ModelListResponse>;
 }
 /**
- * Response for models list endpoint.
+ * Response model for a single LLM model from GET /v2/models endpoint.
+ *
+ * Contains metadata about a supported text generation model including pricing,
+ * context limits, and availability information.
  */
-export interface ModelListResponse {
-    deprecated_models: Array<ModelListResponse.DeprecatedModel>;
-    models: Array<ModelListResponse.Model>;
-    total: number;
+export interface Model {
+    /**
+     * Maximum context window size in tokens
+     */
+    context_length: number;
+    /**
+     * Price per million input tokens in USD
+     */
+    input_price: number;
+    /**
+     * Model identifier (e.g., 'gpt-4', 'claude-3-opus-20240229')
+     */
+    model: string;
+    /**
+     * Price per million output tokens in USD
+     */
+    output_price: number;
+    /**
+     * Provider name (e.g., 'openai', 'anthropic', 'google')
+     */
+    provider: string;
+    /**
+     * OpenRouter model identifier if available, null if not supported via OpenRouter
+     */
+    openrouter_model?: string | null;
 }
-export declare namespace ModelListResponse {
+/**
+ * Response model for GET /v2/models endpoint.
+ *
+ * Returns a list of all supported text generation models with their metadata,
+ * separated into active and deprecated models.
+ */
+export interface ModelListResponse {
     /**
-     * Response model for a single LLM provider.
+     * List of deprecated models that are no longer recommended but may still work
      */
-    interface DeprecatedModel {
-        context_length: number;
-        input_price: number;
-        model: string;
-        output_price: number;
-        provider: string;
-        openrouter_model?: string | null;
-    }
+    deprecated_models: Array<Model>;
     /**
-     * Response model for a single LLM provider.
+     * List of active/supported text generation models with their metadata
      */
-    interface Model {
-        context_length: number;
-        input_price: number;
-        model: string;
-        output_price: number;
-        provider: string;
-        openrouter_model?: string | null;
-    }
+    models: Array<Model>;
+    /**
+     * Total count of active models in the response
+     */
+    total: number;
 }
 export interface ModelListParams {
     /**
@@ -80,6 +105,6 @@ export interface ModelListParams {
     provider?: Array<string> | null;
 }
 export declare namespace Models {
-    export { type ModelListResponse as ModelListResponse, type ModelListParams as ModelListParams };
+    export { type Model as Model, type ModelListResponse as ModelListResponse, type ModelListParams as ModelListParams, };
 }
 //# sourceMappingURL=models.d.mts.map

package/resources/models.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"models.d.mts","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAE5D,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,eAAe;QAC9B,cAAc,EAAE,MAAM,CAAC;QAEvB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,CAAC;QAErB,QAAQ,EAAE,MAAM,CAAC;QAEjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB,cAAc,EAAE,MAAM,CAAC;QAEvB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,CAAC;QAErB,QAAQ,EAAE,MAAM,CAAC;QAEjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACjG"}
+{"version":3,"file":"models.d.mts","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/models.d.ts

@@ -33,40 +33,65 @@ export declare class Models extends APIResource {
      * **Caching:**
      *
      * - Response is cacheable for 1 hour (model list rarely changes)
+     *
+     * @example
+     * ```ts
+     * const models = await client.models.list();
+     * ```
      */
     list(query?: ModelListParams | null | undefined, options?: RequestOptions): APIPromise<ModelListResponse>;
 }
 /**
- * Response for models list endpoint.
+ * Response model for a single LLM model from GET /v2/models endpoint.
+ *
+ * Contains metadata about a supported text generation model including pricing,
+ * context limits, and availability information.
  */
-export interface ModelListResponse {
-    deprecated_models: Array<ModelListResponse.DeprecatedModel>;
-    models: Array<ModelListResponse.Model>;
-    total: number;
+export interface Model {
+    /**
+     * Maximum context window size in tokens
+     */
+    context_length: number;
+    /**
+     * Price per million input tokens in USD
+     */
+    input_price: number;
+    /**
+     * Model identifier (e.g., 'gpt-4', 'claude-3-opus-20240229')
+     */
+    model: string;
+    /**
+     * Price per million output tokens in USD
+     */
+    output_price: number;
+    /**
+     * Provider name (e.g., 'openai', 'anthropic', 'google')
+     */
+    provider: string;
+    /**
+     * OpenRouter model identifier if available, null if not supported via OpenRouter
+     */
+    openrouter_model?: string | null;
 }
-export declare namespace ModelListResponse {
+/**
+ * Response model for GET /v2/models endpoint.
+ *
+ * Returns a list of all supported text generation models with their metadata,
+ * separated into active and deprecated models.
+ */
+export interface ModelListResponse {
     /**
-     * Response model for a single LLM provider.
+     * List of deprecated models that are no longer recommended but may still work
      */
-    interface DeprecatedModel {
-        context_length: number;
-        input_price: number;
-        model: string;
-        output_price: number;
-        provider: string;
-        openrouter_model?: string | null;
-    }
+    deprecated_models: Array<Model>;
     /**
-     * Response model for a single LLM provider.
+     * List of active/supported text generation models with their metadata
      */
-    interface Model {
-        context_length: number;
-        input_price: number;
-        model: string;
-        output_price: number;
-        provider: string;
-        openrouter_model?: string | null;
-    }
+    models: Array<Model>;
+    /**
+     * Total count of active models in the response
+     */
+    total: number;
 }
 export interface ModelListParams {
     /**
@@ -80,6 +105,6 @@ export interface ModelListParams {
     provider?: Array<string> | null;
 }
 export declare namespace Models {
-    export { type ModelListResponse as ModelListResponse, type ModelListParams as ModelListParams };
+    export { type Model as Model, type ModelListResponse as ModelListResponse, type ModelListParams as ModelListParams, };
 }
 //# sourceMappingURL=models.d.ts.map

package/resources/models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAE5D,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,eAAe;QAC9B,cAAc,EAAE,MAAM,CAAC;QAEvB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,CAAC;QAErB,QAAQ,EAAE,MAAM,CAAC;QAEjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB,cAAc,EAAE,MAAM,CAAC;QAEvB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,CAAC;QAErB,QAAQ,EAAE,MAAM,CAAC;QAEjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACjG"}
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/models.js

@@ -35,6 +35,11 @@ class Models extends resource_1.APIResource {
      * **Caching:**
      *
      * - Response is cacheable for 1 hour (model list rarely changes)
+     *
+     * @example
+     * ```ts
+     * const models = await client.models.list();
+     * ```
      */
     list(query = {}, options) {
         return this._client.get('/v2/models', { query, ...options });

package/resources/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AAvCD,wBAuCC"}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AA5CD,wBA4CC"}

package/resources/models.mjs

@@ -32,6 +32,11 @@ export class Models extends APIResource {
      * **Caching:**
      *
      * - Response is cacheable for 1 hour (model list rarely changes)
+     *
+     * @example
+     * ```ts
+     * const models = await client.models.list();
+     * ```
      */
     list(query = {}, options) {
         return this._client.get('/v2/models', { query, ...options });

package/resources/models.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"models.mjs","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF"}
+{"version":3,"file":"models.mjs","sourceRoot":"","sources":["../src/resources/models.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF"}