notdiamond 2.0.0-rc5 → 2.1.0

package/src/client.ts

@@ -17,10 +17,13 @@ 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 {
+  CustomRouter,
+  CustomRouterTrainCustomRouterParams,
+  CustomRouterTrainCustomRouterResponse,
+} from './resources/custom-router';
 import {
   ModelRouter,
-  ModelRouterOpenHandsSelectParams,
-  ModelRouterOpenHandsSelectResponse,
   ModelRouterSelectModelParams,
   ModelRouterSelectModelResponse,
 } from './resources/model-router';
@@ -29,26 +32,21 @@ import {
   PreferenceCreateParams,
   PreferenceCreateResponse,
   PreferenceDeleteResponse,
-  PreferenceRetrieveParams,
-  PreferenceRetrieveResponse,
   PreferenceUpdateParams,
   PreferenceUpdateResponse,
   Preferences,
 } from './resources/preferences';
 import {
-  Pzn,
-  PznSubmitSurveyResponseParams,
-  PznSubmitSurveyResponseResponse,
-  PznTrainCustomRouterParams,
-  PznTrainCustomRouterResponse,
-} from './resources/pzn';
-import {
+  GoldenRecord,
   JobStatus,
-  Prompt,
-  PromptGetAdaptResultsResponse,
-  PromptGetAdaptStatusResponse,
-} from './resources/prompt/prompt';
-import { Report } from './resources/report/report';
+  PromptAdaptation,
+  PromptAdaptationAdaptParams,
+  PromptAdaptationAdaptResponse,
+  PromptAdaptationGetAdaptResultsResponse,
+  PromptAdaptationGetAdaptStatusResponse,
+  PromptAdaptationGetCostResponse,
+  RequestProvider,
+} from './resources/prompt-adaptation';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -71,7 +69,7 @@ export interface ClientOptions {
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
-   * Defaults to process.env['NOT_DIAMOND_BASE_URL'].
+   * Defaults to process.env['NOTDIAMOND_BASE_URL'].
    */
   baseURL?: string | null | undefined;
 
@@ -125,7 +123,7 @@ export interface ClientOptions {
   /**
    * Set the log level.
    *
-   * Defaults to process.env['NOT_DIAMOND_LOG'] or 'warn' if it isn't set.
+   * Defaults to process.env['NOTDIAMOND_LOG'] or 'warn' if it isn't set.
    */
   logLevel?: LogLevel | undefined;
 
@@ -138,7 +136,7 @@ export interface ClientOptions {
 }
 
 /**
- * API Client for interfacing with the Not Diamond API.
+ * API Client for interfacing with the Notdiamond API.
  */
 export class NotDiamond {
   apiKey: string;
@@ -146,7 +144,7 @@ export class NotDiamond {
   baseURL: string;
   maxRetries: number;
   timeout: number;
-  logger: Logger | undefined;
+  logger: Logger;
   logLevel: LogLevel | undefined;
   fetchOptions: MergedRequestInit | undefined;
 
@@ -156,10 +154,10 @@ export class NotDiamond {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the Not Diamond API.
+   * API Client for interfacing with the Notdiamond 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 {string} [opts.baseURL=process.env['NOTDIAMOND_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.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -168,7 +166,7 @@ export class NotDiamond {
    * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
   constructor({
-    baseURL = readEnv('NOT_DIAMOND_BASE_URL'),
+    baseURL = readEnv('NOTDIAMOND_BASE_URL'),
     apiKey = readEnv('NOT_DIAMOND_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
@@ -192,7 +190,7 @@ export class NotDiamond {
     this.logLevel = defaultLogLevel;
     this.logLevel =
       parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
-      parseLogLevel(readEnv('NOT_DIAMOND_LOG'), "process.env['NOT_DIAMOND_LOG']", this) ??
+      parseLogLevel(readEnv('NOTDIAMOND_LOG'), "process.env['NOTDIAMOND_LOG']", this) ??
       defaultLogLevel;
     this.fetchOptions = options.fetchOptions;
     this.maxRetries = options.maxRetries ?? 2;
@@ -731,18 +729,16 @@ export class NotDiamond {
   static toFile = Uploads.toFile;
 
   modelRouter: API.ModelRouter = new API.ModelRouter(this);
-  report: API.Report = new API.Report(this);
   preferences: API.Preferences = new API.Preferences(this);
-  prompt: API.Prompt = new API.Prompt(this);
-  pzn: API.Pzn = new API.Pzn(this);
+  promptAdaptation: API.PromptAdaptation = new API.PromptAdaptation(this);
+  customRouter: API.CustomRouter = new API.CustomRouter(this);
   models: API.Models = new API.Models(this);
 }
 
 NotDiamond.ModelRouter = ModelRouter;
-NotDiamond.Report = Report;
 NotDiamond.Preferences = Preferences;
-NotDiamond.Prompt = Prompt;
-NotDiamond.Pzn = Pzn;
+NotDiamond.PromptAdaptation = PromptAdaptation;
+NotDiamond.CustomRouter = CustomRouter;
 NotDiamond.Models = Models;
 
 export declare namespace NotDiamond {
@@ -750,38 +746,35 @@ export declare namespace NotDiamond {
 
   export {
     ModelRouter as ModelRouter,
-    type ModelRouterOpenHandsSelectResponse as ModelRouterOpenHandsSelectResponse,
     type ModelRouterSelectModelResponse as ModelRouterSelectModelResponse,
-    type ModelRouterOpenHandsSelectParams as ModelRouterOpenHandsSelectParams,
     type ModelRouterSelectModelParams as ModelRouterSelectModelParams,
   };
 
-  export { Report as Report };
-
   export {
     Preferences as Preferences,
     type PreferenceCreateResponse as PreferenceCreateResponse,
-    type PreferenceRetrieveResponse as PreferenceRetrieveResponse,
     type PreferenceUpdateResponse as PreferenceUpdateResponse,
     type PreferenceDeleteResponse as PreferenceDeleteResponse,
     type PreferenceCreateParams as PreferenceCreateParams,
-    type PreferenceRetrieveParams as PreferenceRetrieveParams,
     type PreferenceUpdateParams as PreferenceUpdateParams,
   };
 
   export {
-    Prompt as Prompt,
+    PromptAdaptation as PromptAdaptation,
+    type GoldenRecord as GoldenRecord,
     type JobStatus as JobStatus,
-    type PromptGetAdaptResultsResponse as PromptGetAdaptResultsResponse,
-    type PromptGetAdaptStatusResponse as PromptGetAdaptStatusResponse,
+    type RequestProvider as RequestProvider,
+    type PromptAdaptationAdaptResponse as PromptAdaptationAdaptResponse,
+    type PromptAdaptationGetAdaptResultsResponse as PromptAdaptationGetAdaptResultsResponse,
+    type PromptAdaptationGetAdaptStatusResponse as PromptAdaptationGetAdaptStatusResponse,
+    type PromptAdaptationGetCostResponse as PromptAdaptationGetCostResponse,
+    type PromptAdaptationAdaptParams as PromptAdaptationAdaptParams,
   };
 
   export {
-    Pzn as Pzn,
-    type PznSubmitSurveyResponseResponse as PznSubmitSurveyResponseResponse,
-    type PznTrainCustomRouterResponse as PznTrainCustomRouterResponse,
-    type PznSubmitSurveyResponseParams as PznSubmitSurveyResponseParams,
-    type PznTrainCustomRouterParams as PznTrainCustomRouterParams,
+    CustomRouter as CustomRouter,
+    type CustomRouterTrainCustomRouterResponse as CustomRouterTrainCustomRouterResponse,
+    type CustomRouterTrainCustomRouterParams as CustomRouterTrainCustomRouterParams,
   };
 
   export {

package/src/resources/{pzn.ts → custom-router.ts}

@@ -3,55 +3,10 @@
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { type Uploadable } from '../core/uploads';
-import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { multipartFormRequestOptions } from '../internal/uploads';
 
-export class Pzn extends APIResource {
-  /**
-   * Submit a survey response for personalized routing setup.
-   *
-   * This admin endpoint processes survey responses to set up personalized routing
-   * configurations for users based on their use case, LLM preferences, and
-   * constraints.
-   *
-   * **Survey Data:**
-   *
-   * - User information and use case description
-   * - Preferred LLM providers and models
-   * - Constraint priorities (quality, cost, latency)
-   * - Optional prompts and evaluation datasets
-   *
-   * **File Uploads:**
-   *
-   * - `prompt_file`: Optional CSV file with prompts
-   * - `dataset_file`: Optional CSV file with evaluation dataset
-   *
-   * **Note:** This is an admin-only endpoint for internal use.
-   *
-   * @example
-   * ```ts
-   * const response = await client.pzn.submitSurveyResponse({
-   *   constraint_priorities: 'constraint_priorities',
-   *   email: 'email',
-   *   llm_providers: 'llm_providers',
-   *   use_case_desc: 'use_case_desc',
-   *   user_id: 'user_id',
-   *   'x-token': 'x-token',
-   * });
-   * ```
-   */
-  submitSurveyResponse(params: PznSubmitSurveyResponseParams, options?: RequestOptions): APIPromise<unknown> {
-    const { 'x-token': xToken, ...body } = params;
-    return this._client.post(
-      '/v2/pzn/surveyResponse',
-      multipartFormRequestOptions(
-        { body, ...options, headers: buildHeaders([{ 'x-token': xToken }, options?.headers]) },
-        this._client,
-      ),
-    );
-  }
-
+export class CustomRouter extends APIResource {
   /**
    * Train a custom router on your evaluation data to optimize routing for your
    * specific use case.
@@ -111,20 +66,21 @@ export class Pzn extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.pzn.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',
-   * });
+   * 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: PznTrainCustomRouterParams,
+    body: CustomRouterTrainCustomRouterParams,
     options?: RequestOptions,
-  ): APIPromise<PznTrainCustomRouterResponse> {
+  ): APIPromise<CustomRouterTrainCustomRouterResponse> {
     return this._client.post(
       '/v2/pzn/trainCustomRouter',
       multipartFormRequestOptions({ body, ...options }, this._client),
@@ -132,8 +88,6 @@ export class Pzn extends APIResource {
   }
 }
 
-export type PznSubmitSurveyResponseResponse = unknown;
-
 /**
  * Response model for POST /v2/pzn/trainCustomRouter endpoint.
  *
@@ -155,7 +109,7 @@ export type PznSubmitSurveyResponseResponse = unknown;
  * - No need to poll status - you can start using it immediately (will use default
  *   until ready)
  */
-export interface PznTrainCustomRouterResponse {
+export interface CustomRouterTrainCustomRouterResponse {
   /**
    * Unique identifier for the custom router. Use this in model_select() calls to
    * enable routing with your custom-trained router
@@ -163,64 +117,7 @@ export interface PznTrainCustomRouterResponse {
   preference_id: string;
 }
 
-export interface PznSubmitSurveyResponseParams {
-  /**
-   * Body param: JSON string of constraint priorities object
-   */
-  constraint_priorities: string;
-
-  /**
-   * Body param: User email address
-   */
-  email: string;
-
-  /**
-   * Body param: JSON string of LLM providers array
-   */
-  llm_providers: string;
-
-  /**
-   * Body param: Description of the user's use case
-   */
-  use_case_desc: string;
-
-  /**
-   * Body param: User ID from Supabase
-   */
-  user_id: string;
-
-  /**
-   * Header param:
-   */
-  'x-token': string;
-
-  /**
-   * Body param: Optional additional preferences text
-   */
-  additional_preferences?: string | null;
-
-  /**
-   * Body param: Optional CSV file with evaluation dataset
-   */
-  dataset_file?: Uploadable | null;
-
-  /**
-   * Body param: Optional preference name
-   */
-  name?: string | null;
-
-  /**
-   * Body param: Optional CSV file with prompts
-   */
-  prompt_file?: Uploadable | null;
-
-  /**
-   * Body param: Optional JSON string of prompts array
-   */
-  prompts?: string | null;
-}
-
-export interface PznTrainCustomRouterParams {
+export interface CustomRouterTrainCustomRouterParams {
   /**
    * CSV file containing evaluation data with prompt column and score/response
    * columns for each model
@@ -263,11 +160,9 @@ export interface PznTrainCustomRouterParams {
   preference_id?: string | null;
 }
 
-export declare namespace Pzn {
+export declare namespace CustomRouter {
   export {
-    type PznSubmitSurveyResponseResponse as PznSubmitSurveyResponseResponse,
-    type PznTrainCustomRouterResponse as PznTrainCustomRouterResponse,
-    type PznSubmitSurveyResponseParams as PznSubmitSurveyResponseParams,
-    type PznTrainCustomRouterParams as PznTrainCustomRouterParams,
+    type CustomRouterTrainCustomRouterResponse as CustomRouterTrainCustomRouterResponse,
+    type CustomRouterTrainCustomRouterParams as CustomRouterTrainCustomRouterParams,
   };
 }

package/src/resources/index.ts

@@ -1,34 +1,32 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  CustomRouter,
+  type CustomRouterTrainCustomRouterResponse,
+  type CustomRouterTrainCustomRouterParams,
+} from './custom-router';
 export {
   ModelRouter,
-  type ModelRouterOpenHandsSelectResponse,
   type ModelRouterSelectModelResponse,
-  type ModelRouterOpenHandsSelectParams,
   type ModelRouterSelectModelParams,
 } from './model-router';
 export { Models, type Model, type ModelListResponse, type ModelListParams } from './models';
 export {
   Preferences,
   type PreferenceCreateResponse,
-  type PreferenceRetrieveResponse,
   type PreferenceUpdateResponse,
   type PreferenceDeleteResponse,
   type PreferenceCreateParams,
-  type PreferenceRetrieveParams,
   type PreferenceUpdateParams,
 } from './preferences';
 export {
-  Prompt,
+  PromptAdaptation,
+  type GoldenRecord,
   type JobStatus,
-  type PromptGetAdaptResultsResponse,
-  type PromptGetAdaptStatusResponse,
-} from './prompt/prompt';
-export {
-  Pzn,
-  type PznSubmitSurveyResponseResponse,
-  type PznTrainCustomRouterResponse,
-  type PznSubmitSurveyResponseParams,
-  type PznTrainCustomRouterParams,
-} from './pzn';
-export { Report } from './report/report';
+  type RequestProvider,
+  type PromptAdaptationAdaptResponse,
+  type PromptAdaptationGetAdaptResultsResponse,
+  type PromptAdaptationGetAdaptStatusResponse,
+  type PromptAdaptationGetCostResponse,
+  type PromptAdaptationAdaptParams,
+} from './prompt-adaptation';

package/src/resources/model-router.ts

@@ -1,45 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as AdaptAPI from './prompt/adapt';
+import * as PromptAdaptationAPI from './prompt-adaptation';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
 export class ModelRouter extends APIResource {
-  /**
-   * Openhands Model Select
-   *
-   * @example
-   * ```ts
-   * const response = await client.modelRouter.openHandsSelect({
-   *   llm_providers: [
-   *     { model: 'gpt-4o', provider: 'openai' },
-   *     {
-   *       model: 'claude-sonnet-4-5-20250929',
-   *       provider: 'anthropic',
-   *     },
-   *     { model: 'gemini-1.5-pro', provider: 'google' },
-   *   ],
-   *   messages: [
-   *     {
-   *       content: 'You are a helpful assistant.',
-   *       role: 'system',
-   *     },
-   *     { content: 'Explain quantum computing', role: 'user' },
-   *   ],
-   * });
-   * ```
-   */
-  openHandsSelect(body: ModelRouterOpenHandsSelectParams, options?: RequestOptions): APIPromise<unknown> {
-    return this._client.post('/v2/modelRouter/openHandsRouter', { body, ...options });
-  }
-
   /**
    * 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
+   * specified models. The router considers factors like query complexity, model
    * capabilities, cost, and latency based on your preferences.
    *
    * **Key Features:**
@@ -48,14 +20,13 @@ export class ModelRouter extends APIResource {
    * - 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
+   * 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
    *
@@ -63,7 +34,6 @@ export class ModelRouter extends APIResource {
    *
    * - `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
    *
@@ -76,7 +46,7 @@ export class ModelRouter extends APIResource {
    *       provider: 'anthropic',
    *       model: 'claude-sonnet-4-5-20250929',
    *     },
-   *     { provider: 'google', model: 'gemini-1.5-pro' },
+   *     { provider: 'google', model: 'gemini-2.5-flash' },
    *   ],
    *   messages: [
    *     {
@@ -100,8 +70,6 @@ export class ModelRouter extends APIResource {
   }
 }
 
-export type ModelRouterOpenHandsSelectResponse = unknown;
-
 /**
  * Response from model selection endpoint.
  */
@@ -139,112 +107,12 @@ export namespace ModelRouterSelectModelResponse {
   }
 }
 
-export interface ModelRouterOpenHandsSelectParams {
-  /**
-   * List of LLM providers to route between. Specify at least one provider in format
-   * {provider, model}
-   */
-  llm_providers: Array<AdaptAPI.RequestProvider | ModelRouterOpenHandsSelectParams.OpenRouterProvider>;
-
-  /**
-   * Array of message objects in OpenAI format (with 'role' and 'content' keys)
-   */
-  messages: Array<{ [key: string]: string | Array<unknown> }> | string;
-
-  /**
-   * Whether to hash message content for privacy
-   */
-  hash_content?: boolean;
-
-  /**
-   * Maximum number of models to consider for routing. If not specified, considers
-   * all provided models
-   */
-  max_model_depth?: number | null;
-
-  /**
-   * Optimization metric for model selection
-   */
-  metric?: string;
-
-  /**
-   * Preference ID for personalized routing. Create one via POST
-   * /v2/preferences/userPreferenceCreate
-   */
-  preference_id?: string | null;
-
-  /**
-   * Previous session ID to link related requests
-   */
-  previous_session?: string | null;
-
-  /**
-   * OpenAI-format function calling tools
-   */
-  tools?: Array<{ [key: string]: unknown }> | null;
-
-  /**
-   * Optimization tradeoff strategy. Use 'cost' to prioritize cost savings or
-   * 'latency' to prioritize speed
-   */
-  tradeoff?: string | null;
-}
-
-export namespace ModelRouterOpenHandsSelectParams {
-  /**
-   * 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
-   */
-  export 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 interface ModelRouterSelectModelParams {
   /**
    * Body param: List of LLM providers to route between. Specify at least one
    * provider in format {provider, model}
    */
-  llm_providers: Array<AdaptAPI.RequestProvider | ModelRouterSelectModelParams.OpenRouterProvider>;
+  llm_providers: Array<PromptAdaptationAPI.RequestProvider | ModelRouterSelectModelParams.OpenRouterProvider>;
 
   /**
    * Body param: Array of message objects in OpenAI format (with 'role' and 'content'
@@ -348,9 +216,7 @@ export namespace ModelRouterSelectModelParams {
 
 export declare namespace ModelRouter {
   export {
-    type ModelRouterOpenHandsSelectResponse as ModelRouterOpenHandsSelectResponse,
     type ModelRouterSelectModelResponse as ModelRouterSelectModelResponse,
-    type ModelRouterOpenHandsSelectParams as ModelRouterOpenHandsSelectParams,
     type ModelRouterSelectModelParams as ModelRouterSelectModelParams,
   };
 }