notdiamond 2.0.0-rc1 → 2.0.0-rc10

package/resources/report.js

@@ -1,86 +1,6 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Report = void 0;
-const resource_1 = require("../core/resource.js");
-class Report extends resource_1.APIResource {
-    /**
-     * Evaluate Hallucination
-     *
-     * @example
-     * ```ts
-     * const response = await client.report.evaluateHallucination({
-     *   context: 'context',
-     *   prompt: 'prompt',
-     *   provider: { model: 'gpt-4o', provider: 'openai' },
-     *   response: 'response',
-     * });
-     * ```
-     */
-    evaluateHallucination(body, options) {
-        return this._client.post('/v2/report/hallucination', { body, ...options });
-    }
-    /**
-     * Report Latency
-     *
-     * @example
-     * ```ts
-     * const response = await client.report.latency({
-     *   feedback: { accuracy: 'bar' },
-     *   provider: { model: 'gpt-4o', provider: 'openai' },
-     *   session_id: 'session_id',
-     * });
-     * ```
-     */
-    latency(body, options) {
-        return this._client.post('/v2/report/metrics/latency', { body, ...options });
-    }
-    /**
-     * Submit feedback on a routing decision to improve future recommendations.
-     *
-     * This endpoint allows you to provide feedback on whether the router selected the
-     * right model for your query. Your feedback is used to:
-     *
-     * 1. Personalize routing decisions for your preference_id
-     * 2. Improve the overall routing quality
-     * 3. Train and refine custom routers
-     *
-     * **Feedback Format:**
-     *
-     * - `accuracy: 1` - Thumbs up (the model performed well)
-     * - `accuracy: 0` - Thumbs down (the model did not perform well)
-     *
-     * **Requirements:**
-     *
-     * - You must have used a preference_id in the original model_select() call
-     * - The session_id must be valid and belong to your account
-     * - The provider must match one of the providers returned by model_select()
-     *
-     * **How Feedback Works:** When you submit thumbs down, the router will:
-     *
-     * - Decrease the ranking of the selected model for similar queries
-     * - Consider alternative models more favorably
-     *
-     * When you submit thumbs up, the router will:
-     *
-     * - Increase the ranking of the selected model for similar queries
-     * - Prioritize this model for similar future requests
-     *
-     * **Note:** Feedback requires a valid preference_id. Create one via POST
-     * /v2/preferences/userPreferenceCreate
-     *
-     * @example
-     * ```ts
-     * const response = await client.report.submitFeedback({
-     *   feedback: { accuracy: 1 },
-     *   provider: { provider: 'openai', model: 'gpt-4o' },
-     *   session_id: '550e8400-e29b-41d4-a716-446655440000',
-     * });
-     * ```
-     */
-    submitFeedback(body, options) {
-        return this._client.post('/v2/report/metrics/feedback', { body, ...options });
-    }
-}
-exports.Report = Report;
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./report/index.js"), exports);
 //# sourceMappingURL=report.js.map

package/resources/report.js.map

@@ -1 +1 @@
-{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/resources/report.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,IAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,IAAyB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,cAAc,CACZ,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAtFD,wBAsFC"}
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/resources/report.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAA+B"}

package/resources/report.mjs

@@ -1,82 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../core/resource.mjs";
-export class Report extends APIResource {
-    /**
-     * Evaluate Hallucination
-     *
-     * @example
-     * ```ts
-     * const response = await client.report.evaluateHallucination({
-     *   context: 'context',
-     *   prompt: 'prompt',
-     *   provider: { model: 'gpt-4o', provider: 'openai' },
-     *   response: 'response',
-     * });
-     * ```
-     */
-    evaluateHallucination(body, options) {
-        return this._client.post('/v2/report/hallucination', { body, ...options });
-    }
-    /**
-     * Report Latency
-     *
-     * @example
-     * ```ts
-     * const response = await client.report.latency({
-     *   feedback: { accuracy: 'bar' },
-     *   provider: { model: 'gpt-4o', provider: 'openai' },
-     *   session_id: 'session_id',
-     * });
-     * ```
-     */
-    latency(body, options) {
-        return this._client.post('/v2/report/metrics/latency', { body, ...options });
-    }
-    /**
-     * Submit feedback on a routing decision to improve future recommendations.
-     *
-     * This endpoint allows you to provide feedback on whether the router selected the
-     * right model for your query. Your feedback is used to:
-     *
-     * 1. Personalize routing decisions for your preference_id
-     * 2. Improve the overall routing quality
-     * 3. Train and refine custom routers
-     *
-     * **Feedback Format:**
-     *
-     * - `accuracy: 1` - Thumbs up (the model performed well)
-     * - `accuracy: 0` - Thumbs down (the model did not perform well)
-     *
-     * **Requirements:**
-     *
-     * - You must have used a preference_id in the original model_select() call
-     * - The session_id must be valid and belong to your account
-     * - The provider must match one of the providers returned by model_select()
-     *
-     * **How Feedback Works:** When you submit thumbs down, the router will:
-     *
-     * - Decrease the ranking of the selected model for similar queries
-     * - Consider alternative models more favorably
-     *
-     * When you submit thumbs up, the router will:
-     *
-     * - Increase the ranking of the selected model for similar queries
-     * - Prioritize this model for similar future requests
-     *
-     * **Note:** Feedback requires a valid preference_id. Create one via POST
-     * /v2/preferences/userPreferenceCreate
-     *
-     * @example
-     * ```ts
-     * const response = await client.report.submitFeedback({
-     *   feedback: { accuracy: 1 },
-     *   provider: { provider: 'openai', model: 'gpt-4o' },
-     *   session_id: '550e8400-e29b-41d4-a716-446655440000',
-     * });
-     * ```
-     */
-    submitFeedback(body, options) {
-        return this._client.post('/v2/report/metrics/feedback', { body, ...options });
-    }
-}
+export * from "./report/index.mjs";
 //# sourceMappingURL=report.mjs.map

package/resources/report.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"report.mjs","sourceRoot":"","sources":["../src/resources/report.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,IAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,IAAyB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,cAAc,CACZ,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
+{"version":3,"file":"report.mjs","sourceRoot":"","sources":["../src/resources/report.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/src/client.ts

@@ -17,48 +17,37 @@ import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
-import { Admin } from './resources/admin';
-import { ModelListParams, ModelListResponse, Models } from './resources/models';
 import {
-  PreferenceCreateUserPreferenceParams,
-  PreferenceCreateUserPreferenceResponse,
-  PreferenceDeleteUserPreferenceResponse,
-  PreferenceRetrieveParams,
-  PreferenceRetrieveResponse,
-  PreferenceUpdateUserPreferenceParams,
-  PreferenceUpdateUserPreferenceResponse,
+  CustomRouter,
+  CustomRouterTrainCustomRouterParams,
+  CustomRouterTrainCustomRouterResponse,
+} from './resources/custom-router';
+import {
+  ModelRouter,
+  ModelRouterSelectModelParams,
+  ModelRouterSelectModelResponse,
+} from './resources/model-router';
+import { Model, ModelListParams, ModelListResponse, Models } from './resources/models';
+import {
+  PreferenceCreateParams,
+  PreferenceCreateResponse,
+  PreferenceDeleteResponse,
+  PreferenceUpdateParams,
+  PreferenceUpdateResponse,
   Preferences,
 } from './resources/preferences';
 import {
-  AdaptationRunResults,
+  GoldenRecord,
   JobStatus,
   PromptAdaptation,
-  PromptAdaptationAdaptParams,
-  PromptAdaptationAdaptResponse,
-  PromptAdaptationGetAdaptRunResultsParams,
-  PromptAdaptationGetAdaptRunsParams,
-  PromptAdaptationGetAdaptRunsResponse,
+  PromptAdaptationCreateParams,
+  PromptAdaptationCreateResponse,
+  PromptAdaptationGetAdaptResultsResponse,
   PromptAdaptationGetAdaptStatusResponse,
-  PromptAdaptationRetrieveCostsResponse,
+  PromptAdaptationGetCostsResponse,
+  RequestProvider,
 } from './resources/prompt-adaptation';
-import {
-  Report,
-  ReportEvaluateHallucinationParams,
-  ReportEvaluateHallucinationResponse,
-  ReportLatencyParams,
-  ReportLatencyResponse,
-  ReportSubmitFeedbackParams,
-  ReportSubmitFeedbackResponse,
-} from './resources/report';
-import {
-  Routing,
-  RoutingCreateSurveyResponseParams,
-  RoutingCreateSurveyResponseResponse,
-  RoutingSelectModelParams,
-  RoutingSelectModelResponse,
-  RoutingTrainCustomRouterParams,
-  RoutingTrainCustomRouterResponse,
-} from './resources/routing';
+import { Report } from './resources/report/report';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -72,26 +61,11 @@ import {
 } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
 
-const environments = {
-  production: 'https://api.notdiamond.ai',
-  staging: 'https://staging-api.notdiamond.ai',
-};
-type Environment = keyof typeof environments;
-
 export interface ClientOptions {
   /**
-   * Defaults to process.env['NOT_DIAMOND_API_KEY'].
-   */
-  apiKey?: string | null | undefined;
-
-  /**
-   * Specifies the environment to use for the API.
-   *
-   * Each environment maps to a different base URL:
-   * - `production` corresponds to `https://api.notdiamond.ai`
-   * - `staging` corresponds to `https://staging-api.notdiamond.ai`
+   * API key authentication using Bearer token
    */
-  environment?: Environment | undefined;
+  apiKey?: string | undefined;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -166,7 +140,7 @@ export interface ClientOptions {
  * API Client for interfacing with the Not Diamond API.
  */
 export class NotDiamond {
-  apiKey: string | null;
+  apiKey: string;
 
   baseURL: string;
   maxRetries: number;
@@ -183,8 +157,7 @@ export class NotDiamond {
   /**
    * API Client for interfacing with the Not Diamond API.
    *
-   * @param {string | null | undefined} [opts.apiKey=process.env['NOT_DIAMOND_API_KEY'] ?? null]
-   * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
+   * @param {string | undefined} [opts.apiKey=process.env['NOT_DIAMOND_API_KEY'] ?? undefined]
    * @param {string} [opts.baseURL=process.env['NOT_DIAMOND_BASE_URL'] ?? https://api.notdiamond.ai] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -195,23 +168,22 @@ export class NotDiamond {
    */
   constructor({
     baseURL = readEnv('NOT_DIAMOND_BASE_URL'),
-    apiKey = readEnv('NOT_DIAMOND_API_KEY') ?? null,
+    apiKey = readEnv('NOT_DIAMOND_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
+    if (apiKey === undefined) {
+      throw new Errors.NotDiamondError(
+        "The NOT_DIAMOND_API_KEY environment variable is missing or empty; either provide it, or instantiate the NotDiamond client with an apiKey option, like new NotDiamond({ apiKey: 'My API Key' }).",
+      );
+    }
+
     const options: ClientOptions = {
       apiKey,
       ...opts,
-      baseURL,
-      environment: opts.environment ?? 'production',
+      baseURL: baseURL || `https://api.notdiamond.ai`,
     };
 
-    if (baseURL && opts.environment) {
-      throw new Errors.NotDiamondError(
-        'Ambiguous URL; The `baseURL` option (or NOT_DIAMOND_BASE_URL env var) and the `environment` option are given. If you want to use the environment you must pass baseURL: null',
-      );
-    }
-
-    this.baseURL = options.baseURL || environments[options.environment || 'production'];
+    this.baseURL = options.baseURL!;
     this.timeout = options.timeout ?? NotDiamond.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
@@ -237,8 +209,7 @@ export class NotDiamond {
   withOptions(options: Partial<ClientOptions>): this {
     const client = new (this.constructor as any as new (props: ClientOptions) => typeof this)({
       ...this._options,
-      environment: options.environment ? options.environment : undefined,
-      baseURL: options.environment ? undefined : this.baseURL,
+      baseURL: this.baseURL,
       maxRetries: this.maxRetries,
       timeout: this.timeout,
       logger: this.logger,
@@ -255,7 +226,7 @@ export class NotDiamond {
    * Check whether the base URL is set to its default.
    */
   #baseURLOverridden(): boolean {
-    return this.baseURL !== environments[this._options.environment || 'production'];
+    return this.baseURL !== 'https://api.notdiamond.ai';
   }
 
   protected defaultQuery(): Record<string, string | undefined> | undefined {
@@ -263,22 +234,10 @@ export class NotDiamond {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.apiKey && values.get('authorization')) {
-      return;
-    }
-    if (nulls.has('authorization')) {
-      return;
-    }
-
-    throw new Error(
-      'Could not resolve authentication method. Expected the apiKey to be set. Or for the "Authorization" headers to be explicitly omitted',
-    );
+    return;
   }
 
   protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    if (this.apiKey == null) {
-      return undefined;
-    }
     return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
@@ -770,73 +729,63 @@ export class NotDiamond {
 
   static toFile = Uploads.toFile;
 
-  routing: API.Routing = new API.Routing(this);
+  modelRouter: API.ModelRouter = new API.ModelRouter(this);
+  report: API.Report = new API.Report(this);
   preferences: API.Preferences = new API.Preferences(this);
   promptAdaptation: API.PromptAdaptation = new API.PromptAdaptation(this);
-  report: API.Report = new API.Report(this);
+  customRouter: API.CustomRouter = new API.CustomRouter(this);
   models: API.Models = new API.Models(this);
-  admin: API.Admin = new API.Admin(this);
 }
 
-NotDiamond.Routing = Routing;
+NotDiamond.ModelRouter = ModelRouter;
+NotDiamond.Report = Report;
 NotDiamond.Preferences = Preferences;
 NotDiamond.PromptAdaptation = PromptAdaptation;
-NotDiamond.Report = Report;
+NotDiamond.CustomRouter = CustomRouter;
 NotDiamond.Models = Models;
-NotDiamond.Admin = Admin;
 
 export declare namespace NotDiamond {
   export type RequestOptions = Opts.RequestOptions;
 
   export {
-    Routing as Routing,
-    type RoutingCreateSurveyResponseResponse as RoutingCreateSurveyResponseResponse,
-    type RoutingSelectModelResponse as RoutingSelectModelResponse,
-    type RoutingTrainCustomRouterResponse as RoutingTrainCustomRouterResponse,
-    type RoutingCreateSurveyResponseParams as RoutingCreateSurveyResponseParams,
-    type RoutingSelectModelParams as RoutingSelectModelParams,
-    type RoutingTrainCustomRouterParams as RoutingTrainCustomRouterParams,
+    ModelRouter as ModelRouter,
+    type ModelRouterSelectModelResponse as ModelRouterSelectModelResponse,
+    type ModelRouterSelectModelParams as ModelRouterSelectModelParams,
   };
 
+  export { Report as Report };
+
   export {
     Preferences as Preferences,
-    type PreferenceRetrieveResponse as PreferenceRetrieveResponse,
-    type PreferenceCreateUserPreferenceResponse as PreferenceCreateUserPreferenceResponse,
-    type PreferenceDeleteUserPreferenceResponse as PreferenceDeleteUserPreferenceResponse,
-    type PreferenceUpdateUserPreferenceResponse as PreferenceUpdateUserPreferenceResponse,
-    type PreferenceRetrieveParams as PreferenceRetrieveParams,
-    type PreferenceCreateUserPreferenceParams as PreferenceCreateUserPreferenceParams,
-    type PreferenceUpdateUserPreferenceParams as PreferenceUpdateUserPreferenceParams,
+    type PreferenceCreateResponse as PreferenceCreateResponse,
+    type PreferenceUpdateResponse as PreferenceUpdateResponse,
+    type PreferenceDeleteResponse as PreferenceDeleteResponse,
+    type PreferenceCreateParams as PreferenceCreateParams,
+    type PreferenceUpdateParams as PreferenceUpdateParams,
   };
 
   export {
     PromptAdaptation as PromptAdaptation,
-    type AdaptationRunResults as AdaptationRunResults,
+    type GoldenRecord as GoldenRecord,
     type JobStatus as JobStatus,
-    type PromptAdaptationAdaptResponse as PromptAdaptationAdaptResponse,
-    type PromptAdaptationGetAdaptRunsResponse as PromptAdaptationGetAdaptRunsResponse,
+    type RequestProvider as RequestProvider,
+    type PromptAdaptationCreateResponse as PromptAdaptationCreateResponse,
+    type PromptAdaptationGetAdaptResultsResponse as PromptAdaptationGetAdaptResultsResponse,
     type PromptAdaptationGetAdaptStatusResponse as PromptAdaptationGetAdaptStatusResponse,
-    type PromptAdaptationRetrieveCostsResponse as PromptAdaptationRetrieveCostsResponse,
-    type PromptAdaptationAdaptParams as PromptAdaptationAdaptParams,
-    type PromptAdaptationGetAdaptRunResultsParams as PromptAdaptationGetAdaptRunResultsParams,
-    type PromptAdaptationGetAdaptRunsParams as PromptAdaptationGetAdaptRunsParams,
+    type PromptAdaptationGetCostsResponse as PromptAdaptationGetCostsResponse,
+    type PromptAdaptationCreateParams as PromptAdaptationCreateParams,
   };
 
   export {
-    Report as Report,
-    type ReportEvaluateHallucinationResponse as ReportEvaluateHallucinationResponse,
-    type ReportLatencyResponse as ReportLatencyResponse,
-    type ReportSubmitFeedbackResponse as ReportSubmitFeedbackResponse,
-    type ReportEvaluateHallucinationParams as ReportEvaluateHallucinationParams,
-    type ReportLatencyParams as ReportLatencyParams,
-    type ReportSubmitFeedbackParams as ReportSubmitFeedbackParams,
+    CustomRouter as CustomRouter,
+    type CustomRouterTrainCustomRouterResponse as CustomRouterTrainCustomRouterResponse,
+    type CustomRouterTrainCustomRouterParams as CustomRouterTrainCustomRouterParams,
   };
 
   export {
     Models as Models,
+    type Model as Model,
     type ModelListResponse as ModelListResponse,
     type ModelListParams as ModelListParams,
   };
-
-  export { Admin as Admin };
 }

package/src/internal/utils/env.ts

@@ -9,10 +9,12 @@
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    const value = (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    return value === '' ? undefined : value;
   }
   if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
+    const value = (globalThis as any).Deno.env?.get?.(env)?.trim();
+    return value === '' ? undefined : value;
   }
   return undefined;
 };

package/src/resources/custom-router.ts

@@ -0,0 +1,168 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { type Uploadable } from '../core/uploads';
+import { RequestOptions } from '../internal/request-options';
+import { multipartFormRequestOptions } from '../internal/uploads';
+
+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: CustomRouterTrainCustomRouterParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomRouterTrainCustomRouterResponse> {
+    return this._client.post(
+      '/v2/pzn/trainCustomRouter',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+/**
+ * Response model for POST /v2/pzn/trainCustomRouter endpoint.
+ *
+ * Returned immediately after submitting a custom router training request. The
+ * training process runs asynchronously (typically 5-15 minutes), so use the
+ * returned preference_id to make routing calls once training completes.
+ *
+ * **Next steps:**
+ *
+ * 1. Store the preference_id
+ * 2. Wait for training to complete (typically 5-15 minutes)
+ * 3. Use this preference_id in POST /v2/modelRouter/modelSelect requests
+ * 4. The router will use your custom-trained model to make routing decisions
+ *
+ * **How to use the preference_id:**
+ *
+ * - Include it in the 'preference_id' field of model_select() calls
+ * - The system automatically uses your custom router once training is complete
+ * - No need to poll status - you can start using it immediately (will use default
+ *   until ready)
+ */
+export interface CustomRouterTrainCustomRouterResponse {
+  /**
+   * Unique identifier for the custom router. Use this in model_select() calls to
+   * enable routing with your custom-trained router
+   */
+  preference_id: string;
+}
+
+export interface CustomRouterTrainCustomRouterParams {
+  /**
+   * CSV file containing evaluation data with prompt column and score/response
+   * columns for each model
+   */
+  dataset_file: Uploadable;
+
+  /**
+   * Language of the evaluation data. Use 'english' for English-only data or
+   * 'multilingual' for multi-language support
+   */
+  language: string;
+
+  /**
+   * JSON string array of LLM providers to train the router on. Format:
+   * '[{"provider": "openai", "model": "gpt-4o"}, {"provider": "anthropic", "model":
+   * "claude-sonnet-4-5-20250929"}]'
+   */
+  llm_providers: string;
+
+  /**
+   * Whether higher scores are better. Set to true if higher scores indicate better
+   * performance, false otherwise
+   */
+  maximize: boolean;
+
+  /**
+   * Name of the column in the CSV file that contains the prompts
+   */
+  prompt_column: string;
+
+  /**
+   * Whether to override an existing custom router for this preference_id
+   */
+  override?: boolean | null;
+
+  /**
+   * Optional preference ID to update an existing router. If not provided, a new
+   * preference will be created
+   */
+  preference_id?: string | null;
+}
+
+export declare namespace CustomRouter {
+  export {
+    type CustomRouterTrainCustomRouterResponse as CustomRouterTrainCustomRouterResponse,
+    type CustomRouterTrainCustomRouterParams as CustomRouterTrainCustomRouterParams,
+  };
+}