notdiamond 2.0.0-rc2 → 2.0.0-rc20

package/src/resources/preferences.ts

@@ -2,34 +2,10 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
-import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Preferences extends APIResource {
-  /**
-   * Get User Preference By Id
-   *
-   * @example
-   * ```ts
-   * const preference = await client.preferences.retrieve(
-   *   'preference_id',
-   *   { user_id: 'user_id', 'x-token': 'x-token' },
-   * );
-   * ```
-   */
-  retrieve(
-    preferenceID: string,
-    params: PreferenceRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<unknown> {
-    const { user_id, 'x-token': xToken } = params;
-    return this._client.get(path`/v2/preferences/${user_id}/${preferenceID}`, {
-      ...options,
-      headers: buildHeaders([{ 'x-token': xToken }, options?.headers]),
-    });
-  }
-
   /**
    * Create a new preference ID for personalized LLM routing.
    *
@@ -37,20 +13,17 @@ export class Preferences extends APIResource {
    * learning your preferences over time. Once created, you can:
    *
    * 1. Use it in model_select() calls to get personalized routing decisions
-   * 2. Submit feedback via the feedback endpoint to improve routing quality
-   * 3. Train a custom router specific to your use case
+   * 2. Train a custom router specific to your use case
    *
    * **Workflow:**
    *
    * 1. Create a preference ID (this endpoint)
    * 2. Use the preference_id in POST /v2/modelRouter/modelSelect requests
-   * 3. Submit feedback on routing decisions via POST /v2/report/metrics/feedback
-   * 4. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
+   * 3. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
    *
    * **Benefits:**
    *
-   * - Personalized routing that learns from your feedback
-   * - Improved accuracy for your specific use case
+   * - Personalized routing for your specific use case
    * - Ability to train custom routers on your evaluation data
    *
    * **Note:** If you don't provide a preference_id in model_select() calls, the
@@ -58,88 +31,77 @@ export class Preferences extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.preferences.createUserPreference();
+   * const preference = await client.preferences.create();
    * ```
    */
-  createUserPreference(
-    body: PreferenceCreateUserPreferenceParams,
-    options?: RequestOptions,
-  ): APIPromise<PreferenceCreateUserPreferenceResponse> {
+  create(body: PreferenceCreateParams, options?: RequestOptions): APIPromise<PreferenceCreateResponse> {
     return this._client.post('/v2/preferences/userPreferenceCreate', { body, ...options });
   }
 
   /**
-   * Delete User Preference
+   * Update User Preference
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.preferences.deleteUserPreference(
-   *     'preference_id',
-   *   );
+   * const preference = await client.preferences.update({
+   *   preference_id: 'preference_id',
+   * });
    * ```
    */
-  deleteUserPreference(preferenceID: string, options?: RequestOptions): APIPromise<unknown> {
-    return this._client.delete(path`/v2/preferences/userPreferenceDelete/${preferenceID}`, options);
+  update(body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.put('/v2/preferences/userPreferenceUpdate', { body, ...options });
   }
 
   /**
-   * Update User Preference
+   * Delete User Preference
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.preferences.updateUserPreference({
-   *     preference_id: 'preference_id',
-   *   });
+   * const preference = await client.preferences.delete(
+   *   'preference_id',
+   * );
    * ```
    */
-  updateUserPreference(
-    body: PreferenceUpdateUserPreferenceParams,
-    options?: RequestOptions,
-  ): APIPromise<unknown> {
-    return this._client.put('/v2/preferences/userPreferenceUpdate', { body, ...options });
+  delete(preferenceID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/v2/preferences/userPreferenceDelete/${preferenceID}`, options);
   }
 }
 
-export type PreferenceRetrieveResponse = unknown;
-
 /**
- * Response from preference creation endpoint.
+ * Response model for POST /v2/preferences/userPreferenceCreate endpoint.
+ *
+ * Returns the newly created preference ID which can be used to enable personalized
+ * LLM routing. Store this ID and include it in subsequent model_select() calls to
+ * activate personalized routing based on your feedback and usage patterns.
+ *
+ * **Next steps after creation:**
+ *
+ * 1. Use the preference_id in POST /v2/modelRouter/modelSelect requests
+ * 2. Submit feedback on routing decisions to improve accuracy
+ * 3. Optionally train a custom router using your evaluation data
  */
-export interface PreferenceCreateUserPreferenceResponse {
+export interface PreferenceCreateResponse {
   /**
-   * The newly created preference ID. Use this in model_select() calls for
-   * personalized routing
+   * Unique identifier for the newly created preference. Use this in the
+   * 'preference_id' parameter of model_select() calls to enable personalized routing
    */
   preference_id: string;
 }
 
-export type PreferenceDeleteUserPreferenceResponse = unknown;
+export type PreferenceUpdateResponse = unknown;
 
-export type PreferenceUpdateUserPreferenceResponse = unknown;
-
-export interface PreferenceRetrieveParams {
-  /**
-   * Path param:
-   */
-  user_id: string;
-
-  /**
-   * Header param:
-   */
-  'x-token': string;
-}
+export type PreferenceDeleteResponse = unknown;
 
-export interface PreferenceCreateUserPreferenceParams {
+export interface PreferenceCreateParams {
   /**
-   * Optional name for the preference
+   * Optional name for the preference. If not provided, an auto-generated timestamp
+   * will be used. Use descriptive names like 'Production API' or 'Customer Support
+   * Bot' for easy identification
    */
   name?: string | null;
 }
 
-export interface PreferenceUpdateUserPreferenceParams {
+export interface PreferenceUpdateParams {
   preference_id: string;
 
   name?: string | null;
@@ -147,12 +109,10 @@ export interface PreferenceUpdateUserPreferenceParams {
 
 export declare namespace Preferences {
   export {
-    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,
   };
 }