notdiamond 2.0.0-rc1 → 2.0.0-rc10

package/resources/custom-router.mjs

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { multipartFormRequestOptions } from "../internal/uploads.mjs";
+export class CustomRouter extends APIResource {
+    /**
+     * Train a custom router on your evaluation data to optimize routing for your
+     * specific use case.
+     *
+     * This endpoint allows you to train a domain-specific router that learns which
+     * models perform best for different types of queries in your application. The
+     * router analyzes your evaluation dataset, clusters similar queries, and learns
+     * model performance patterns.
+     *
+     * **Training Process:**
+     *
+     * 1. Upload a CSV file with your evaluation data
+     * 2. Specify which models to route between
+     * 3. Define the evaluation metric (score column)
+     * 4. The system trains asynchronously and returns a preference_id
+     * 5. Use the preference_id in model_select() calls once training completes
+     *
+     * **Dataset Requirements:**
+     *
+     * - Format: CSV file
+     * - Minimum samples: 25 (more is better for accuracy)
+     * - Required columns:
+     *   - Prompt column (specified in prompt_column parameter)
+     *   - For each model: `{provider}/{model}/score` and `{provider}/{model}/response`
+     *
+     * **Example CSV structure:**
+     *
+     * ```
+     * prompt,openai/gpt-4o/score,openai/gpt-4o/response,anthropic/claude-sonnet-4-5-20250929/score,anthropic/claude-sonnet-4-5-20250929/response
+     * "Explain quantum computing",0.95,"Quantum computing uses...",0.87,"Quantum computers leverage..."
+     * "Write a Python function",0.82,"def my_function()...",0.91,"Here's a Python function..."
+     * ```
+     *
+     * **Model Selection:**
+     *
+     * - Specify standard models: `{"provider": "openai", "model": "gpt-4o"}`
+     * - Or custom models with pricing:
+     *   `{"provider": "custom", "model": "my-model", "is_custom": true, "input_price": 10.0, "output_price": 30.0, "context_length": 8192, "latency": 1.5}`
+     *
+     * **Training Time:**
+     *
+     * - Training is asynchronous and typically takes 5-15 minutes
+     * - Larger datasets or more models take longer
+     * - You'll receive a preference_id immediately
+     * - Check training status by attempting to use the preference_id in model_select()
+     *
+     * **Best Practices:**
+     *
+     * 1. Use diverse, representative examples from your production workload
+     * 2. Include at least 50-100 samples for best results
+     * 3. Ensure consistent evaluation metrics across all models
+     * 4. Use the same models you plan to route between in production
+     *
+     * **Related Documentation:** See
+     * https://docs.notdiamond.ai/docs/adapting-prompts-to-new-models for detailed
+     * guide.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.customRouter.trainCustomRouter({
+     *     dataset_file: fs.createReadStream('path/to/file'),
+     *     language: 'english',
+     *     llm_providers:
+     *       '[{"provider": "openai", "model": "gpt-4o"}, {"provider": "anthropic", "model": "claude-sonnet-4-5-20250929"}]',
+     *     maximize: true,
+     *     prompt_column: 'prompt',
+     *   });
+     * ```
+     */
+    trainCustomRouter(body, options) {
+        return this._client.post('/v2/pzn/trainCustomRouter', multipartFormRequestOptions({ body, ...options }, this._client));
+    }
+}
+//# sourceMappingURL=custom-router.mjs.map

package/resources/custom-router.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-router.mjs","sourceRoot":"","sources":["../src/resources/custom-router.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,2BAA2B,EAAE;AAEtC,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,iBAAiB,CACf,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,2BAA2B,EAC3B,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF"}

package/resources/index.d.mts

@@ -1,7 +1,7 @@
-export { Admin } from "./admin.mjs";
-export { Models, type ModelListResponse, type ModelListParams } from "./models.mjs";
-export { Preferences, type PreferenceRetrieveResponse, type PreferenceCreateUserPreferenceResponse, type PreferenceDeleteUserPreferenceResponse, type PreferenceUpdateUserPreferenceResponse, type PreferenceRetrieveParams, type PreferenceCreateUserPreferenceParams, type PreferenceUpdateUserPreferenceParams, } from "./preferences.mjs";
-export { PromptAdaptation, type AdaptationRunResults, type JobStatus, type PromptAdaptationAdaptResponse, type PromptAdaptationGetAdaptRunsResponse, type PromptAdaptationGetAdaptStatusResponse, type PromptAdaptationRetrieveCostsResponse, type PromptAdaptationAdaptParams, type PromptAdaptationGetAdaptRunResultsParams, type PromptAdaptationGetAdaptRunsParams, } from "./prompt-adaptation.mjs";
-export { Report, type ReportEvaluateHallucinationResponse, type ReportLatencyResponse, type ReportSubmitFeedbackResponse, type ReportEvaluateHallucinationParams, type ReportLatencyParams, type ReportSubmitFeedbackParams, } from "./report.mjs";
-export { Routing, type RoutingCreateSurveyResponseResponse, type RoutingSelectModelResponse, type RoutingTrainCustomRouterResponse, type RoutingCreateSurveyResponseParams, type RoutingSelectModelParams, type RoutingTrainCustomRouterParams, } from "./routing.mjs";
+export { CustomRouter, type CustomRouterTrainCustomRouterResponse, type CustomRouterTrainCustomRouterParams, } from "./custom-router.mjs";
+export { ModelRouter, type ModelRouterSelectModelResponse, type ModelRouterSelectModelParams, } from "./model-router.mjs";
+export { Models, type Model, type ModelListResponse, type ModelListParams } from "./models.mjs";
+export { Preferences, type PreferenceCreateResponse, type PreferenceUpdateResponse, type PreferenceDeleteResponse, type PreferenceCreateParams, type PreferenceUpdateParams, } from "./preferences.mjs";
+export { PromptAdaptation, type GoldenRecord, type JobStatus, type RequestProvider, type PromptAdaptationCreateResponse, type PromptAdaptationGetAdaptResultsResponse, type PromptAdaptationGetAdaptStatusResponse, type PromptAdaptationGetCostsResponse, type PromptAdaptationCreateParams, } from "./prompt-adaptation.mjs";
+export { Report } from "./report/report.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,KAAK,EAAE;OACT,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE;OACxD,EACL,WAAW,EACX,KAAK,0BAA0B,EAC/B,KAAK,sCAAsC,EAC3C,KAAK,sCAAsC,EAC3C,KAAK,sCAAsC,EAC3C,KAAK,wBAAwB,EAC7B,KAAK,oCAAoC,EACzC,KAAK,oCAAoC,GAC1C;OACM,EACL,gBAAgB,EAChB,KAAK,oBAAoB,EACzB,KAAK,SAAS,EACd,KAAK,6BAA6B,EAClC,KAAK,oCAAoC,EACzC,KAAK,sCAAsC,EAC3C,KAAK,qCAAqC,EAC1C,KAAK,2BAA2B,EAChC,KAAK,wCAAwC,EAC7C,KAAK,kCAAkC,GACxC;OACM,EACL,MAAM,EACN,KAAK,mCAAmC,EACxC,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iCAAiC,EACtC,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,GAChC;OACM,EACL,OAAO,EACP,KAAK,mCAAmC,EACxC,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,wBAAwB,EAC7B,KAAK,8BAA8B,GACpC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,qCAAqC,EAC1C,KAAK,mCAAmC,GACzC;OACM,EACL,WAAW,EACX,KAAK,8BAA8B,EACnC,KAAK,4BAA4B,GAClC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE;OACpE,EACL,WAAW,EACX,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,GAC5B;OACM,EACL,gBAAgB,EAChB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,eAAe,EACpB,KAAK,8BAA8B,EACnC,KAAK,uCAAuC,EAC5C,KAAK,sCAAsC,EAC3C,KAAK,gCAAgC,EACrC,KAAK,4BAA4B,GAClC;OACM,EAAE,MAAM,EAAE"}

package/resources/index.d.ts

@@ -1,7 +1,7 @@
-export { Admin } from "./admin.js";
-export { Models, type ModelListResponse, type ModelListParams } from "./models.js";
-export { Preferences, type PreferenceRetrieveResponse, type PreferenceCreateUserPreferenceResponse, type PreferenceDeleteUserPreferenceResponse, type PreferenceUpdateUserPreferenceResponse, type PreferenceRetrieveParams, type PreferenceCreateUserPreferenceParams, type PreferenceUpdateUserPreferenceParams, } from "./preferences.js";
-export { PromptAdaptation, type AdaptationRunResults, type JobStatus, type PromptAdaptationAdaptResponse, type PromptAdaptationGetAdaptRunsResponse, type PromptAdaptationGetAdaptStatusResponse, type PromptAdaptationRetrieveCostsResponse, type PromptAdaptationAdaptParams, type PromptAdaptationGetAdaptRunResultsParams, type PromptAdaptationGetAdaptRunsParams, } from "./prompt-adaptation.js";
-export { Report, type ReportEvaluateHallucinationResponse, type ReportLatencyResponse, type ReportSubmitFeedbackResponse, type ReportEvaluateHallucinationParams, type ReportLatencyParams, type ReportSubmitFeedbackParams, } from "./report.js";
-export { Routing, type RoutingCreateSurveyResponseResponse, type RoutingSelectModelResponse, type RoutingTrainCustomRouterResponse, type RoutingCreateSurveyResponseParams, type RoutingSelectModelParams, type RoutingTrainCustomRouterParams, } from "./routing.js";
+export { CustomRouter, type CustomRouterTrainCustomRouterResponse, type CustomRouterTrainCustomRouterParams, } from "./custom-router.js";
+export { ModelRouter, type ModelRouterSelectModelResponse, type ModelRouterSelectModelParams, } from "./model-router.js";
+export { Models, type Model, type ModelListResponse, type ModelListParams } from "./models.js";
+export { Preferences, type PreferenceCreateResponse, type PreferenceUpdateResponse, type PreferenceDeleteResponse, type PreferenceCreateParams, type PreferenceUpdateParams, } from "./preferences.js";
+export { PromptAdaptation, type GoldenRecord, type JobStatus, type RequestProvider, type PromptAdaptationCreateResponse, type PromptAdaptationGetAdaptResultsResponse, type PromptAdaptationGetAdaptStatusResponse, type PromptAdaptationGetCostsResponse, type PromptAdaptationCreateParams, } from "./prompt-adaptation.js";
+export { Report } from "./report/report.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,KAAK,EAAE;OACT,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE;OACxD,EACL,WAAW,EACX,KAAK,0BAA0B,EAC/B,KAAK,sCAAsC,EAC3C,KAAK,sCAAsC,EAC3C,KAAK,sCAAsC,EAC3C,KAAK,wBAAwB,EAC7B,KAAK,oCAAoC,EACzC,KAAK,oCAAoC,GAC1C;OACM,EACL,gBAAgB,EAChB,KAAK,oBAAoB,EACzB,KAAK,SAAS,EACd,KAAK,6BAA6B,EAClC,KAAK,oCAAoC,EACzC,KAAK,sCAAsC,EAC3C,KAAK,qCAAqC,EAC1C,KAAK,2BAA2B,EAChC,KAAK,wCAAwC,EAC7C,KAAK,kCAAkC,GACxC;OACM,EACL,MAAM,EACN,KAAK,mCAAmC,EACxC,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iCAAiC,EACtC,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,GAChC;OACM,EACL,OAAO,EACP,KAAK,mCAAmC,EACxC,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,wBAAwB,EAC7B,KAAK,8BAA8B,GACpC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,qCAAqC,EAC1C,KAAK,mCAAmC,GACzC;OACM,EACL,WAAW,EACX,KAAK,8BAA8B,EACnC,KAAK,4BAA4B,GAClC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE;OACpE,EACL,WAAW,EACX,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,GAC5B;OACM,EACL,gBAAgB,EAChB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,eAAe,EACpB,KAAK,8BAA8B,EACnC,KAAK,uCAAuC,EAC5C,KAAK,sCAAsC,EAC3C,KAAK,gCAAgC,EACrC,KAAK,4BAA4B,GAClC;OACM,EAAE,MAAM,EAAE"}

package/resources/index.js

@@ -1,17 +1,17 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Routing = exports.Report = exports.PromptAdaptation = exports.Preferences = exports.Models = exports.Admin = void 0;
-var admin_1 = require("./admin.js");
-Object.defineProperty(exports, "Admin", { enumerable: true, get: function () { return admin_1.Admin; } });
+exports.Report = exports.PromptAdaptation = exports.Preferences = exports.Models = exports.ModelRouter = exports.CustomRouter = void 0;
+var custom_router_1 = require("./custom-router.js");
+Object.defineProperty(exports, "CustomRouter", { enumerable: true, get: function () { return custom_router_1.CustomRouter; } });
+var model_router_1 = require("./model-router.js");
+Object.defineProperty(exports, "ModelRouter", { enumerable: true, get: function () { return model_router_1.ModelRouter; } });
 var models_1 = require("./models.js");
 Object.defineProperty(exports, "Models", { enumerable: true, get: function () { return models_1.Models; } });
 var preferences_1 = require("./preferences.js");
 Object.defineProperty(exports, "Preferences", { enumerable: true, get: function () { return preferences_1.Preferences; } });
 var prompt_adaptation_1 = require("./prompt-adaptation.js");
 Object.defineProperty(exports, "PromptAdaptation", { enumerable: true, get: function () { return prompt_adaptation_1.PromptAdaptation; } });
-var report_1 = require("./report.js");
+var report_1 = require("./report/report.js");
 Object.defineProperty(exports, "Report", { enumerable: true, get: function () { return report_1.Report; } });
-var routing_1 = require("./routing.js");
-Object.defineProperty(exports, "Routing", { enumerable: true, get: function () { return routing_1.Routing; } });
 //# sourceMappingURL=index.js.map

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAAgC;AAAvB,8FAAA,KAAK,OAAA;AACd,sCAAgF;AAAvE,gGAAA,MAAM,OAAA;AACf,gDASuB;AARrB,0GAAA,WAAW,OAAA;AASb,4DAW6B;AAV3B,qHAAA,gBAAgB,OAAA;AAWlB,sCAQkB;AAPhB,gGAAA,MAAM,OAAA;AAQR,wCAQmB;AAPjB,kGAAA,OAAO,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oDAIyB;AAHvB,6GAAA,YAAY,OAAA;AAId,kDAIwB;AAHtB,2GAAA,WAAW,OAAA;AAIb,sCAA4F;AAAnF,gGAAA,MAAM,OAAA;AACf,gDAOuB;AANrB,0GAAA,WAAW,OAAA;AAOb,4DAU6B;AAT3B,qHAAA,gBAAgB,OAAA;AAUlB,6CAAyC;AAAhC,gGAAA,MAAM,OAAA"}

package/resources/index.mjs

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export { Admin } from "./admin.mjs";
+export { CustomRouter, } from "./custom-router.mjs";
+export { ModelRouter, } from "./model-router.mjs";
 export { Models } from "./models.mjs";
 export { Preferences, } from "./preferences.mjs";
 export { PromptAdaptation, } from "./prompt-adaptation.mjs";
-export { Report, } from "./report.mjs";
-export { Routing, } from "./routing.mjs";
+export { Report } from "./report/report.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,KAAK,EAAE;OACT,EAAE,MAAM,EAAgD;OACxD,EACL,WAAW,GAQZ;OACM,EACL,gBAAgB,GAUjB;OACM,EACL,MAAM,GAOP;OACM,EACL,OAAO,GAOR"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,YAAY,GAGb;OACM,EACL,WAAW,GAGZ;OACM,EAAE,MAAM,EAA4D;OACpE,EACL,WAAW,GAMZ;OACM,EACL,gBAAgB,GASjB;OACM,EAAE,MAAM,EAAE"}

package/resources/model-router.d.mts

@@ -0,0 +1,196 @@
+import { APIResource } from "../core/resource.mjs";
+import * as PromptAdaptationAPI from "./prompt-adaptation.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+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 providers. 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
+     * - Privacy-preserving content hashing
+     *
+     * **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 for personalized routing
+     * 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/report/metrics/feedback` - Submit feedback on routing decisions
+     * - `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.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"model-router.d.mts","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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;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.d.ts

@@ -0,0 +1,196 @@
+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 providers. 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
+     * - Privacy-preserving content hashing
+     *
+     * **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 for personalized routing
+     * 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/report/metrics/feedback` - Submit feedback on routing decisions
+     * - `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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;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,70 @@
+"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 providers. 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
+     * - Privacy-preserving content hashing
+     *
+     * **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 for personalized routing
+     * 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/report/metrics/feedback` - Submit feedback on routing decisions
+     * - `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