notdiamond 2.0.0-rc4 → 2.0.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,15 +136,15 @@ export interface ClientOptions {
 }
 
 /**
- * API Client for interfacing with the Not Diamond API.
+ * API Client for interfacing with the Notdiamond API.
  */
-export class NotDiamond {
+export class Notdiamond {
   apiKey: string;
 
   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'] ?? /] - 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,31 +166,31 @@ 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 = {}) {
     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' }).",
+      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: baseURL || `/`,
+      baseURL: baseURL || `https://api.notdiamond.ai`,
     };
 
     this.baseURL = options.baseURL!;
-    this.timeout = options.timeout ?? NotDiamond.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? Notdiamond.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
     // Set default logLevel early so that we can log a warning in parseLogLevel.
     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;
@@ -227,7 +225,7 @@ export class NotDiamond {
    * Check whether the base URL is set to its default.
    */
   #baseURLOverridden(): boolean {
-    return this.baseURL !== '/';
+    return this.baseURL !== 'https://api.notdiamond.ai';
   }
 
   protected defaultQuery(): Record<string, string | undefined> | undefined {
@@ -711,10 +709,10 @@ export class NotDiamond {
     }
   }
 
-  static NotDiamond = this;
+  static Notdiamond = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static NotDiamondError = Errors.NotDiamondError;
+  static NotdiamondError = Errors.NotdiamondError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -731,57 +729,52 @@ 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.Models = Models;
+Notdiamond.ModelRouter = ModelRouter;
+Notdiamond.Preferences = Preferences;
+Notdiamond.PromptAdaptation = PromptAdaptation;
+Notdiamond.CustomRouter = CustomRouter;
+Notdiamond.Models = Models;
 
-export declare namespace NotDiamond {
+export declare namespace Notdiamond {
   export type RequestOptions = Opts.RequestOptions;
 
   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/core/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type NotDiamond } from '../client';
+import { type Notdiamond } from '../client';
 
 import { type PromiseOrValue } from '../internal/types';
 import { APIResponseProps, defaultParseResponse } from '../internal/parse';
@@ -11,13 +11,13 @@ import { APIResponseProps, defaultParseResponse } from '../internal/parse';
  */
 export class APIPromise<T> extends Promise<T> {
   private parsedPromise: Promise<T> | undefined;
-  #client: NotDiamond;
+  #client: Notdiamond;
 
   constructor(
-    client: NotDiamond,
+    client: Notdiamond,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: NotDiamond,
+      client: Notdiamond,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

package/src/core/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from '../internal/errors';
 
-export class NotDiamondError extends Error {}
+export class NotdiamondError extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends NotDiamondError {
+> extends NotdiamondError {
   /** HTTP status for the response that caused the error */
   readonly status: TStatus;
   /** HTTP headers for the response that caused the error */

package/src/core/resource.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import type { NotDiamond } from '../client';
+import type { Notdiamond } from '../client';
 
 export abstract class APIResource {
-  protected _client: NotDiamond;
+  protected _client: Notdiamond;
 
-  constructor(client: NotDiamond) {
+  constructor(client: Notdiamond) {
     this._client = client;
   }
 }

package/src/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { NotDiamond as default } from './client';
+export { Notdiamond as default } from './client';
 
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
-export { NotDiamond, type ClientOptions } from './client';
+export { Notdiamond, type ClientOptions } from './client';
 export {
-  NotDiamondError,
+  NotdiamondError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

package/src/internal/parse.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
-import { type NotDiamond } from '../client';
+import { type Notdiamond } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
 export type APIResponseProps = {
@@ -13,7 +13,7 @@ export type APIResponseProps = {
   startTime: number;
 };
 
-export async function defaultParseResponse<T>(client: NotDiamond, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: Notdiamond, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
     // fetch refuses to read the body when the status code is 204.

package/src/internal/shims.ts

@@ -16,7 +16,7 @@ export function getDefaultFetch(): Fetch {
   }
 
   throw new Error(
-    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new NotDiamond({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
+    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new Notdiamond({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
   );
 }
 

package/src/internal/uploads.ts

@@ -1,6 +1,6 @@
 import { type RequestOptions } from './request-options';
 import type { FilePropertyBag, Fetch } from './builtin-types';
-import type { NotDiamond } from '../client';
+import type { Notdiamond } from '../client';
 import { ReadableStreamFrom } from './shims';
 
 export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
@@ -74,7 +74,7 @@ export const isAsyncIterable = (value: any): value is AsyncIterable<any> =>
  */
 export const maybeMultipartFormRequestOptions = async (
   opts: RequestOptions,
-  fetch: NotDiamond | Fetch,
+  fetch: Notdiamond | Fetch,
 ): Promise<RequestOptions> => {
   if (!hasUploadableValue(opts.body)) return opts;
 
@@ -85,7 +85,7 @@ type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & { body: unknow
 
 export const multipartFormRequestOptions = async (
   opts: MultipartFormRequestOptions,
-  fetch: NotDiamond | Fetch,
+  fetch: Notdiamond | Fetch,
 ): Promise<RequestOptions> => {
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
@@ -98,7 +98,7 @@ const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>
  * This function detects if the fetch function provided supports the global FormData object to avoid
  * confusing error messages later on.
  */
-function supportsFormData(fetchObject: NotDiamond | Fetch): Promise<boolean> {
+function supportsFormData(fetchObject: Notdiamond | Fetch): Promise<boolean> {
   const fetch: Fetch = typeof fetchObject === 'function' ? fetchObject : (fetchObject as any).fetch;
   const cached = supportsFormDataMap.get(fetch);
   if (cached) return cached;
@@ -124,7 +124,7 @@ function supportsFormData(fetchObject: NotDiamond | Fetch): Promise<boolean> {
 
 export const createForm = async <T = Record<string, unknown>>(
   body: T | undefined,
-  fetch: NotDiamond | Fetch,
+  fetch: Notdiamond | Fetch,
 ): Promise<FormData> => {
   if (!(await supportsFormData(fetch))) {
     throw new TypeError(

package/src/internal/utils/base64.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { NotDiamondError } from '../../core/error';
+import { NotdiamondError } from '../../core/error';
 import { encodeUTF8 } from './bytes';
 
 export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
@@ -18,7 +18,7 @@ export const toBase64 = (data: string | Uint8Array | null | undefined): string =
     return btoa(String.fromCharCode.apply(null, data as any));
   }
 
-  throw new NotDiamondError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
+  throw new NotdiamondError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
 };
 
 export const fromBase64 = (str: string): Uint8Array => {
@@ -36,5 +36,5 @@ export const fromBase64 = (str: string): Uint8Array => {
     return buf;
   }
 
-  throw new NotDiamondError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
+  throw new NotdiamondError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
 };

package/src/internal/utils/log.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { hasOwn } from './values';
-import { type NotDiamond } from '../../client';
+import { type Notdiamond } from '../../client';
 import { RequestOptions } from '../request-options';
 
 type LogFn = (message: string, ...rest: unknown[]) => void;
@@ -24,7 +24,7 @@ const levelNumbers = {
 export const parseLogLevel = (
   maybeLevel: string | undefined,
   sourceName: string,
-  client: NotDiamond,
+  client: Notdiamond,
 ): LogLevel | undefined => {
   if (!maybeLevel) {
     return undefined;
@@ -60,7 +60,7 @@ const noopLogger = {
 
 let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
-export function loggerFor(client: NotDiamond): Logger {
+export function loggerFor(client: Notdiamond): Logger {
   const logger = client.logger;
   const logLevel = client.logLevel ?? 'off';
   if (!logger) {

package/src/internal/utils/path.ts

@@ -1,4 +1,4 @@
-import { NotDiamondError } from '../../core/error';
+import { NotdiamondError } from '../../core/error';
 
 /**
  * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
@@ -72,7 +72,7 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new NotDiamondError(
+      throw new NotdiamondError(
         `Path parameters result in path with invalid segments:\n${invalidSegments
           .map((e) => e.error)
           .join('\n')}\n${path}\n${underline}`,

package/src/internal/utils/values.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { NotDiamondError } from '../../core/error';
+import { NotdiamondError } from '../../core/error';
 
 // https://url.spec.whatwg.org/#url-scheme-string
 const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
@@ -39,7 +39,7 @@ export function isObj(obj: unknown): obj is Record<string, unknown> {
 
 export const ensurePresent = <T>(value: T | null | undefined): T => {
   if (value == null) {
-    throw new NotDiamondError(`Expected a value to be given but received ${value} instead.`);
+    throw new NotdiamondError(`Expected a value to be given but received ${value} instead.`);
   }
 
   return value;
@@ -47,10 +47,10 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 
 export const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {
-    throw new NotDiamondError(`${name} must be an integer`);
+    throw new NotdiamondError(`${name} must be an integer`);
   }
   if (n < 0) {
-    throw new NotDiamondError(`${name} must be a positive integer`);
+    throw new NotdiamondError(`${name} must be a positive integer`);
   }
   return n;
 };
@@ -59,14 +59,14 @@ export const coerceInteger = (value: unknown): number => {
   if (typeof value === 'number') return Math.round(value);
   if (typeof value === 'string') return parseInt(value, 10);
 
-  throw new NotDiamondError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new NotdiamondError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceFloat = (value: unknown): number => {
   if (typeof value === 'number') return value;
   if (typeof value === 'string') return parseFloat(value);
 
-  throw new NotDiamondError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new NotdiamondError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceBoolean = (value: unknown): boolean => {