notdiamond 2.0.0-rc2 → 2.0.0-rc20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/CHANGELOG.md +185 -0
  2. package/LICENSE +1 -1
  3. package/README.md +261 -168
  4. package/client.d.mts +26 -43
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +26 -43
  7. package/client.d.ts.map +1 -1
  8. package/client.js +49 -68
  9. package/client.js.map +1 -1
  10. package/client.mjs +47 -66
  11. package/client.mjs.map +1 -1
  12. package/core/api-promise.d.mts +2 -2
  13. package/core/api-promise.d.ts +2 -2
  14. package/core/error.d.mts +2 -2
  15. package/core/error.d.ts +2 -2
  16. package/core/error.js +4 -4
  17. package/core/error.mjs +2 -2
  18. package/core/resource.d.mts +3 -3
  19. package/core/resource.d.ts +3 -3
  20. package/index.d.mts +3 -3
  21. package/index.d.ts +3 -3
  22. package/index.js +4 -4
  23. package/index.mjs +3 -3
  24. package/internal/parse.d.mts +2 -2
  25. package/internal/parse.d.ts +2 -2
  26. package/internal/shims.js +1 -1
  27. package/internal/shims.mjs +1 -1
  28. package/internal/uploads.d.mts +4 -4
  29. package/internal/uploads.d.ts +4 -4
  30. package/internal/utils/base64.js +2 -2
  31. package/internal/utils/base64.mjs +3 -3
  32. package/internal/utils/env.d.mts.map +1 -1
  33. package/internal/utils/env.d.ts.map +1 -1
  34. package/internal/utils/env.js +4 -2
  35. package/internal/utils/env.js.map +1 -1
  36. package/internal/utils/env.mjs +4 -2
  37. package/internal/utils/env.mjs.map +1 -1
  38. package/internal/utils/log.d.mts +3 -3
  39. package/internal/utils/log.d.ts +3 -3
  40. package/internal/utils/path.js +1 -1
  41. package/internal/utils/path.mjs +2 -2
  42. package/internal/utils/values.js +5 -5
  43. package/internal/utils/values.mjs +6 -6
  44. package/package.json +11 -12
  45. package/resources/custom-router.d.mts +145 -0
  46. package/resources/custom-router.d.mts.map +1 -0
  47. package/resources/custom-router.d.ts +145 -0
  48. package/resources/custom-router.d.ts.map +1 -0
  49. package/resources/custom-router.js +83 -0
  50. package/resources/custom-router.js.map +1 -0
  51. package/resources/custom-router.mjs +79 -0
  52. package/resources/custom-router.mjs.map +1 -0
  53. package/resources/index.d.mts +5 -6
  54. package/resources/index.d.mts.map +1 -1
  55. package/resources/index.d.ts +5 -6
  56. package/resources/index.d.ts.map +1 -1
  57. package/resources/index.js +5 -7
  58. package/resources/index.js.map +1 -1
  59. package/resources/index.mjs +2 -3
  60. package/resources/index.mjs.map +1 -1
  61. package/resources/model-router.d.mts +194 -0
  62. package/resources/model-router.d.mts.map +1 -0
  63. package/resources/model-router.d.ts +194 -0
  64. package/resources/model-router.d.ts.map +1 -0
  65. package/resources/model-router.js +68 -0
  66. package/resources/model-router.js.map +1 -0
  67. package/resources/model-router.mjs +64 -0
  68. package/resources/model-router.mjs.map +1 -0
  69. package/resources/models.d.mts +50 -25
  70. package/resources/models.d.mts.map +1 -1
  71. package/resources/models.d.ts +50 -25
  72. package/resources/models.d.ts.map +1 -1
  73. package/resources/models.js +5 -0
  74. package/resources/models.js.map +1 -1
  75. package/resources/models.mjs +5 -0
  76. package/resources/models.mjs.map +1 -1
  77. package/resources/preferences.d.mts +37 -54
  78. package/resources/preferences.d.mts.map +1 -1
  79. package/resources/preferences.d.ts +37 -54
  80. package/resources/preferences.d.ts.map +1 -1
  81. package/resources/preferences.js +17 -42
  82. package/resources/preferences.js.map +1 -1
  83. package/resources/preferences.mjs +17 -42
  84. package/resources/preferences.mjs.map +1 -1
  85. package/resources/prompt-adaptation.d.mts +340 -249
  86. package/resources/prompt-adaptation.d.mts.map +1 -1
  87. package/resources/prompt-adaptation.d.ts +340 -249
  88. package/resources/prompt-adaptation.d.ts.map +1 -1
  89. package/resources/prompt-adaptation.js +36 -79
  90. package/resources/prompt-adaptation.js.map +1 -1
  91. package/resources/prompt-adaptation.mjs +36 -79
  92. package/resources/prompt-adaptation.mjs.map +1 -1
  93. package/src/client.ts +72 -128
  94. package/src/core/api-promise.ts +4 -4
  95. package/src/core/error.ts +2 -2
  96. package/src/core/resource.ts +3 -3
  97. package/src/index.ts +3 -3
  98. package/src/internal/parse.ts +2 -2
  99. package/src/internal/shims.ts +1 -1
  100. package/src/internal/uploads.ts +5 -5
  101. package/src/internal/utils/base64.ts +3 -3
  102. package/src/internal/utils/env.ts +4 -2
  103. package/src/internal/utils/log.ts +3 -3
  104. package/src/internal/utils/path.ts +2 -2
  105. package/src/internal/utils/values.ts +6 -6
  106. package/src/resources/custom-router.ts +168 -0
  107. package/src/resources/index.ts +20 -32
  108. package/src/resources/model-router.ts +222 -0
  109. package/src/resources/models.ts +55 -32
  110. package/src/resources/preferences.ts +43 -83
  111. package/src/resources/prompt-adaptation.ts +358 -300
  112. package/src/version.ts +1 -1
  113. package/version.d.mts +1 -1
  114. package/version.d.mts.map +1 -1
  115. package/version.d.ts +1 -1
  116. package/version.d.ts.map +1 -1
  117. package/version.js +1 -1
  118. package/version.js.map +1 -1
  119. package/version.mjs +1 -1
  120. package/version.mjs.map +1 -1
  121. package/resources/admin.d.mts +0 -4
  122. package/resources/admin.d.mts.map +0 -1
  123. package/resources/admin.d.ts +0 -4
  124. package/resources/admin.d.ts.map +0 -1
  125. package/resources/admin.js +0 -9
  126. package/resources/admin.js.map +0 -1
  127. package/resources/admin.mjs +0 -5
  128. package/resources/admin.mjs.map +0 -1
  129. package/resources/report.d.mts +0 -245
  130. package/resources/report.d.mts.map +0 -1
  131. package/resources/report.d.ts +0 -245
  132. package/resources/report.d.ts.map +0 -1
  133. package/resources/report.js +0 -86
  134. package/resources/report.js.map +0 -1
  135. package/resources/report.mjs +0 -82
  136. package/resources/report.mjs.map +0 -1
  137. package/resources/routing.d.mts +0 -391
  138. package/resources/routing.d.mts.map +0 -1
  139. package/resources/routing.d.ts +0 -391
  140. package/resources/routing.d.ts.map +0 -1
  141. package/resources/routing.js +0 -163
  142. package/resources/routing.js.map +0 -1
  143. package/resources/routing.mjs +0 -159
  144. package/resources/routing.mjs.map +0 -1
  145. package/src/resources/admin.ts +0 -5
  146. package/src/resources/report.ts +0 -300
  147. package/src/resources/routing.ts +0 -476
@@ -2,18 +2,6 @@ import { APIResource } from "../core/resource.mjs";
2
2
  import { APIPromise } from "../core/api-promise.mjs";
3
3
  import { RequestOptions } from "../internal/request-options.mjs";
4
4
  export declare class Preferences extends APIResource {
5
- /**
6
- * Get User Preference By Id
7
- *
8
- * @example
9
- * ```ts
10
- * const preference = await client.preferences.retrieve(
11
- * 'preference_id',
12
- * { user_id: 'user_id', 'x-token': 'x-token' },
13
- * );
14
- * ```
15
- */
16
- retrieve(preferenceID: string, params: PreferenceRetrieveParams, options?: RequestOptions): APIPromise<unknown>;
17
5
  /**
18
6
  * Create a new preference ID for personalized LLM routing.
19
7
  *
@@ -21,20 +9,17 @@ export declare class Preferences extends APIResource {
21
9
  * learning your preferences over time. Once created, you can:
22
10
  *
23
11
  * 1. Use it in model_select() calls to get personalized routing decisions
24
- * 2. Submit feedback via the feedback endpoint to improve routing quality
25
- * 3. Train a custom router specific to your use case
12
+ * 2. Train a custom router specific to your use case
26
13
  *
27
14
  * **Workflow:**
28
15
  *
29
16
  * 1. Create a preference ID (this endpoint)
30
17
  * 2. Use the preference_id in POST /v2/modelRouter/modelSelect requests
31
- * 3. Submit feedback on routing decisions via POST /v2/report/metrics/feedback
32
- * 4. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
18
+ * 3. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
33
19
  *
34
20
  * **Benefits:**
35
21
  *
36
- * - Personalized routing that learns from your feedback
37
- * - Improved accuracy for your specific use case
22
+ * - Personalized routing for your specific use case
38
23
  * - Ability to train custom routers on your evaluation data
39
24
  *
40
25
  * **Note:** If you don't provide a preference_id in model_select() calls, the
@@ -42,70 +27,68 @@ export declare class Preferences extends APIResource {
42
27
  *
43
28
  * @example
44
29
  * ```ts
45
- * const response =
46
- * await client.preferences.createUserPreference();
30
+ * const preference = await client.preferences.create();
47
31
  * ```
48
32
  */
49
- createUserPreference(body: PreferenceCreateUserPreferenceParams, options?: RequestOptions): APIPromise<PreferenceCreateUserPreferenceResponse>;
33
+ create(body: PreferenceCreateParams, options?: RequestOptions): APIPromise<PreferenceCreateResponse>;
50
34
  /**
51
- * Delete User Preference
35
+ * Update User Preference
52
36
  *
53
37
  * @example
54
38
  * ```ts
55
- * const response =
56
- * await client.preferences.deleteUserPreference(
57
- * 'preference_id',
58
- * );
39
+ * const preference = await client.preferences.update({
40
+ * preference_id: 'preference_id',
41
+ * });
59
42
  * ```
60
43
  */
61
- deleteUserPreference(preferenceID: string, options?: RequestOptions): APIPromise<unknown>;
44
+ update(body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<unknown>;
62
45
  /**
63
- * Update User Preference
46
+ * Delete User Preference
64
47
  *
65
48
  * @example
66
49
  * ```ts
67
- * const response =
68
- * await client.preferences.updateUserPreference({
69
- * preference_id: 'preference_id',
70
- * });
50
+ * const preference = await client.preferences.delete(
51
+ * 'preference_id',
52
+ * );
71
53
  * ```
72
54
  */
73
- updateUserPreference(body: PreferenceUpdateUserPreferenceParams, options?: RequestOptions): APIPromise<unknown>;
55
+ delete(preferenceID: string, options?: RequestOptions): APIPromise<unknown>;
74
56
  }
75
- export type PreferenceRetrieveResponse = unknown;
76
57
  /**
77
- * Response from preference creation endpoint.
58
+ * Response model for POST /v2/preferences/userPreferenceCreate endpoint.
59
+ *
60
+ * Returns the newly created preference ID which can be used to enable personalized
61
+ * LLM routing. Store this ID and include it in subsequent model_select() calls to
62
+ * activate personalized routing based on your feedback and usage patterns.
63
+ *
64
+ * **Next steps after creation:**
65
+ *
66
+ * 1. Use the preference_id in POST /v2/modelRouter/modelSelect requests
67
+ * 2. Submit feedback on routing decisions to improve accuracy
68
+ * 3. Optionally train a custom router using your evaluation data
78
69
  */
79
- export interface PreferenceCreateUserPreferenceResponse {
70
+ export interface PreferenceCreateResponse {
80
71
  /**
81
- * The newly created preference ID. Use this in model_select() calls for
82
- * personalized routing
72
+ * Unique identifier for the newly created preference. Use this in the
73
+ * 'preference_id' parameter of model_select() calls to enable personalized routing
83
74
  */
84
75
  preference_id: string;
85
76
  }
86
- export type PreferenceDeleteUserPreferenceResponse = unknown;
87
- export type PreferenceUpdateUserPreferenceResponse = unknown;
88
- export interface PreferenceRetrieveParams {
89
- /**
90
- * Path param:
91
- */
92
- user_id: string;
93
- /**
94
- * Header param:
95
- */
96
- 'x-token': string;
97
- }
98
- export interface PreferenceCreateUserPreferenceParams {
77
+ export type PreferenceUpdateResponse = unknown;
78
+ export type PreferenceDeleteResponse = unknown;
79
+ export interface PreferenceCreateParams {
99
80
  /**
100
- * Optional name for the preference
81
+ * Optional name for the preference. If not provided, an auto-generated timestamp
82
+ * will be used. Use descriptive names like 'Production API' or 'Customer Support
83
+ * Bot' for easy identification
101
84
  */
102
85
  name?: string | null;
103
86
  }
104
- export interface PreferenceUpdateUserPreferenceParams {
87
+ export interface PreferenceUpdateParams {
105
88
  preference_id: string;
106
89
  name?: string | null;
107
90
  }
108
91
  export declare namespace Preferences {
109
- 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, };
92
+ export { type PreferenceCreateResponse as PreferenceCreateResponse, type PreferenceUpdateResponse as PreferenceUpdateResponse, type PreferenceDeleteResponse as PreferenceDeleteResponse, type PreferenceCreateParams as PreferenceCreateParams, type PreferenceUpdateParams as PreferenceUpdateParams, };
110
93
  }
111
94
  //# sourceMappingURL=preferences.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAQtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,oBAAoB,CAClB,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIzF;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;CAGvB;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,sCAAsC,GAAG,OAAO,CAAC;AAE7D,MAAM,MAAM,sCAAsC,GAAG,OAAO,CAAC;AAE7D,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,oCAAoC;IACnD,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}
1
+ {"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInF;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAG5E;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
@@ -2,18 +2,6 @@ import { APIResource } from "../core/resource.js";
2
2
  import { APIPromise } from "../core/api-promise.js";
3
3
  import { RequestOptions } from "../internal/request-options.js";
4
4
  export declare class Preferences extends APIResource {
5
- /**
6
- * Get User Preference By Id
7
- *
8
- * @example
9
- * ```ts
10
- * const preference = await client.preferences.retrieve(
11
- * 'preference_id',
12
- * { user_id: 'user_id', 'x-token': 'x-token' },
13
- * );
14
- * ```
15
- */
16
- retrieve(preferenceID: string, params: PreferenceRetrieveParams, options?: RequestOptions): APIPromise<unknown>;
17
5
  /**
18
6
  * Create a new preference ID for personalized LLM routing.
19
7
  *
@@ -21,20 +9,17 @@ export declare class Preferences extends APIResource {
21
9
  * learning your preferences over time. Once created, you can:
22
10
  *
23
11
  * 1. Use it in model_select() calls to get personalized routing decisions
24
- * 2. Submit feedback via the feedback endpoint to improve routing quality
25
- * 3. Train a custom router specific to your use case
12
+ * 2. Train a custom router specific to your use case
26
13
  *
27
14
  * **Workflow:**
28
15
  *
29
16
  * 1. Create a preference ID (this endpoint)
30
17
  * 2. Use the preference_id in POST /v2/modelRouter/modelSelect requests
31
- * 3. Submit feedback on routing decisions via POST /v2/report/metrics/feedback
32
- * 4. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
18
+ * 3. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
33
19
  *
34
20
  * **Benefits:**
35
21
  *
36
- * - Personalized routing that learns from your feedback
37
- * - Improved accuracy for your specific use case
22
+ * - Personalized routing for your specific use case
38
23
  * - Ability to train custom routers on your evaluation data
39
24
  *
40
25
  * **Note:** If you don't provide a preference_id in model_select() calls, the
@@ -42,70 +27,68 @@ export declare class Preferences extends APIResource {
42
27
  *
43
28
  * @example
44
29
  * ```ts
45
- * const response =
46
- * await client.preferences.createUserPreference();
30
+ * const preference = await client.preferences.create();
47
31
  * ```
48
32
  */
49
- createUserPreference(body: PreferenceCreateUserPreferenceParams, options?: RequestOptions): APIPromise<PreferenceCreateUserPreferenceResponse>;
33
+ create(body: PreferenceCreateParams, options?: RequestOptions): APIPromise<PreferenceCreateResponse>;
50
34
  /**
51
- * Delete User Preference
35
+ * Update User Preference
52
36
  *
53
37
  * @example
54
38
  * ```ts
55
- * const response =
56
- * await client.preferences.deleteUserPreference(
57
- * 'preference_id',
58
- * );
39
+ * const preference = await client.preferences.update({
40
+ * preference_id: 'preference_id',
41
+ * });
59
42
  * ```
60
43
  */
61
- deleteUserPreference(preferenceID: string, options?: RequestOptions): APIPromise<unknown>;
44
+ update(body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<unknown>;
62
45
  /**
63
- * Update User Preference
46
+ * Delete User Preference
64
47
  *
65
48
  * @example
66
49
  * ```ts
67
- * const response =
68
- * await client.preferences.updateUserPreference({
69
- * preference_id: 'preference_id',
70
- * });
50
+ * const preference = await client.preferences.delete(
51
+ * 'preference_id',
52
+ * );
71
53
  * ```
72
54
  */
73
- updateUserPreference(body: PreferenceUpdateUserPreferenceParams, options?: RequestOptions): APIPromise<unknown>;
55
+ delete(preferenceID: string, options?: RequestOptions): APIPromise<unknown>;
74
56
  }
75
- export type PreferenceRetrieveResponse = unknown;
76
57
  /**
77
- * Response from preference creation endpoint.
58
+ * Response model for POST /v2/preferences/userPreferenceCreate endpoint.
59
+ *
60
+ * Returns the newly created preference ID which can be used to enable personalized
61
+ * LLM routing. Store this ID and include it in subsequent model_select() calls to
62
+ * activate personalized routing based on your feedback and usage patterns.
63
+ *
64
+ * **Next steps after creation:**
65
+ *
66
+ * 1. Use the preference_id in POST /v2/modelRouter/modelSelect requests
67
+ * 2. Submit feedback on routing decisions to improve accuracy
68
+ * 3. Optionally train a custom router using your evaluation data
78
69
  */
79
- export interface PreferenceCreateUserPreferenceResponse {
70
+ export interface PreferenceCreateResponse {
80
71
  /**
81
- * The newly created preference ID. Use this in model_select() calls for
82
- * personalized routing
72
+ * Unique identifier for the newly created preference. Use this in the
73
+ * 'preference_id' parameter of model_select() calls to enable personalized routing
83
74
  */
84
75
  preference_id: string;
85
76
  }
86
- export type PreferenceDeleteUserPreferenceResponse = unknown;
87
- export type PreferenceUpdateUserPreferenceResponse = unknown;
88
- export interface PreferenceRetrieveParams {
89
- /**
90
- * Path param:
91
- */
92
- user_id: string;
93
- /**
94
- * Header param:
95
- */
96
- 'x-token': string;
97
- }
98
- export interface PreferenceCreateUserPreferenceParams {
77
+ export type PreferenceUpdateResponse = unknown;
78
+ export type PreferenceDeleteResponse = unknown;
79
+ export interface PreferenceCreateParams {
99
80
  /**
100
- * Optional name for the preference
81
+ * Optional name for the preference. If not provided, an auto-generated timestamp
82
+ * will be used. Use descriptive names like 'Production API' or 'Customer Support
83
+ * Bot' for easy identification
101
84
  */
102
85
  name?: string | null;
103
86
  }
104
- export interface PreferenceUpdateUserPreferenceParams {
87
+ export interface PreferenceUpdateParams {
105
88
  preference_id: string;
106
89
  name?: string | null;
107
90
  }
108
91
  export declare namespace Preferences {
109
- 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, };
92
+ export { type PreferenceCreateResponse as PreferenceCreateResponse, type PreferenceUpdateResponse as PreferenceUpdateResponse, type PreferenceDeleteResponse as PreferenceDeleteResponse, type PreferenceCreateParams as PreferenceCreateParams, type PreferenceUpdateParams as PreferenceUpdateParams, };
110
93
  }
111
94
  //# sourceMappingURL=preferences.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAQtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,oBAAoB,CAClB,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIzF;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;CAGvB;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,sCAAsC,GAAG,OAAO,CAAC;AAE7D,MAAM,MAAM,sCAAsC,GAAG,OAAO,CAAC;AAE7D,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,oCAAoC;IACnD,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}
1
+ {"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInF;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAG5E;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
@@ -3,27 +3,8 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Preferences = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
- const headers_1 = require("../internal/headers.js");
7
6
  const path_1 = require("../internal/utils/path.js");
8
7
  class Preferences extends resource_1.APIResource {
9
- /**
10
- * Get User Preference By Id
11
- *
12
- * @example
13
- * ```ts
14
- * const preference = await client.preferences.retrieve(
15
- * 'preference_id',
16
- * { user_id: 'user_id', 'x-token': 'x-token' },
17
- * );
18
- * ```
19
- */
20
- retrieve(preferenceID, params, options) {
21
- const { user_id, 'x-token': xToken } = params;
22
- return this._client.get((0, path_1.path) `/v2/preferences/${user_id}/${preferenceID}`, {
23
- ...options,
24
- headers: (0, headers_1.buildHeaders)([{ 'x-token': xToken }, options?.headers]),
25
- });
26
- }
27
8
  /**
28
9
  * Create a new preference ID for personalized LLM routing.
29
10
  *
@@ -31,20 +12,17 @@ class Preferences extends resource_1.APIResource {
31
12
  * learning your preferences over time. Once created, you can:
32
13
  *
33
14
  * 1. Use it in model_select() calls to get personalized routing decisions
34
- * 2. Submit feedback via the feedback endpoint to improve routing quality
35
- * 3. Train a custom router specific to your use case
15
+ * 2. Train a custom router specific to your use case
36
16
  *
37
17
  * **Workflow:**
38
18
  *
39
19
  * 1. Create a preference ID (this endpoint)
40
20
  * 2. Use the preference_id in POST /v2/modelRouter/modelSelect requests
41
- * 3. Submit feedback on routing decisions via POST /v2/report/metrics/feedback
42
- * 4. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
21
+ * 3. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
43
22
  *
44
23
  * **Benefits:**
45
24
  *
46
- * - Personalized routing that learns from your feedback
47
- * - Improved accuracy for your specific use case
25
+ * - Personalized routing for your specific use case
48
26
  * - Ability to train custom routers on your evaluation data
49
27
  *
50
28
  * **Note:** If you don't provide a preference_id in model_select() calls, the
@@ -52,40 +30,37 @@ class Preferences extends resource_1.APIResource {
52
30
  *
53
31
  * @example
54
32
  * ```ts
55
- * const response =
56
- * await client.preferences.createUserPreference();
33
+ * const preference = await client.preferences.create();
57
34
  * ```
58
35
  */
59
- createUserPreference(body, options) {
36
+ create(body, options) {
60
37
  return this._client.post('/v2/preferences/userPreferenceCreate', { body, ...options });
61
38
  }
62
39
  /**
63
- * Delete User Preference
40
+ * Update User Preference
64
41
  *
65
42
  * @example
66
43
  * ```ts
67
- * const response =
68
- * await client.preferences.deleteUserPreference(
69
- * 'preference_id',
70
- * );
44
+ * const preference = await client.preferences.update({
45
+ * preference_id: 'preference_id',
46
+ * });
71
47
  * ```
72
48
  */
73
- deleteUserPreference(preferenceID, options) {
74
- return this._client.delete((0, path_1.path) `/v2/preferences/userPreferenceDelete/${preferenceID}`, options);
49
+ update(body, options) {
50
+ return this._client.put('/v2/preferences/userPreferenceUpdate', { body, ...options });
75
51
  }
76
52
  /**
77
- * Update User Preference
53
+ * Delete User Preference
78
54
  *
79
55
  * @example
80
56
  * ```ts
81
- * const response =
82
- * await client.preferences.updateUserPreference({
83
- * preference_id: 'preference_id',
84
- * });
57
+ * const preference = await client.preferences.delete(
58
+ * 'preference_id',
59
+ * );
85
60
  * ```
86
61
  */
87
- updateUserPreference(body, options) {
88
- return this._client.put('/v2/preferences/userPreferenceUpdate', { body, ...options });
62
+ delete(preferenceID, options) {
63
+ return this._client.delete((0, path_1.path) `/v2/preferences/userPreferenceDelete/${preferenceID}`, options);
89
64
  }
90
65
  }
91
66
  exports.Preferences = Preferences;
@@ -1 +1 @@
1
- {"version":3,"file":"preferences.js","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,OAAO,IAAI,YAAY,EAAE,EAAE;YACxE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,oBAAoB,CAClB,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,YAAoB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wCAAwC,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AA/FD,kCA+FC"}
1
+ {"version":3,"file":"preferences.js","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wCAAwC,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACF;AA5DD,kCA4DC"}
@@ -1,26 +1,7 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../core/resource.mjs";
3
- import { buildHeaders } from "../internal/headers.mjs";
4
3
  import { path } from "../internal/utils/path.mjs";
5
4
  export class Preferences extends APIResource {
6
- /**
7
- * Get User Preference By Id
8
- *
9
- * @example
10
- * ```ts
11
- * const preference = await client.preferences.retrieve(
12
- * 'preference_id',
13
- * { user_id: 'user_id', 'x-token': 'x-token' },
14
- * );
15
- * ```
16
- */
17
- retrieve(preferenceID, params, options) {
18
- const { user_id, 'x-token': xToken } = params;
19
- return this._client.get(path `/v2/preferences/${user_id}/${preferenceID}`, {
20
- ...options,
21
- headers: buildHeaders([{ 'x-token': xToken }, options?.headers]),
22
- });
23
- }
24
5
  /**
25
6
  * Create a new preference ID for personalized LLM routing.
26
7
  *
@@ -28,20 +9,17 @@ export class Preferences extends APIResource {
28
9
  * learning your preferences over time. Once created, you can:
29
10
  *
30
11
  * 1. Use it in model_select() calls to get personalized routing decisions
31
- * 2. Submit feedback via the feedback endpoint to improve routing quality
32
- * 3. Train a custom router specific to your use case
12
+ * 2. Train a custom router specific to your use case
33
13
  *
34
14
  * **Workflow:**
35
15
  *
36
16
  * 1. Create a preference ID (this endpoint)
37
17
  * 2. Use the preference_id in POST /v2/modelRouter/modelSelect requests
38
- * 3. Submit feedback on routing decisions via POST /v2/report/metrics/feedback
39
- * 4. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
18
+ * 3. Optionally train a custom router via POST /v2/pzn/trainCustomRouter
40
19
  *
41
20
  * **Benefits:**
42
21
  *
43
- * - Personalized routing that learns from your feedback
44
- * - Improved accuracy for your specific use case
22
+ * - Personalized routing for your specific use case
45
23
  * - Ability to train custom routers on your evaluation data
46
24
  *
47
25
  * **Note:** If you don't provide a preference_id in model_select() calls, the
@@ -49,40 +27,37 @@ export class Preferences extends APIResource {
49
27
  *
50
28
  * @example
51
29
  * ```ts
52
- * const response =
53
- * await client.preferences.createUserPreference();
30
+ * const preference = await client.preferences.create();
54
31
  * ```
55
32
  */
56
- createUserPreference(body, options) {
33
+ create(body, options) {
57
34
  return this._client.post('/v2/preferences/userPreferenceCreate', { body, ...options });
58
35
  }
59
36
  /**
60
- * Delete User Preference
37
+ * Update User Preference
61
38
  *
62
39
  * @example
63
40
  * ```ts
64
- * const response =
65
- * await client.preferences.deleteUserPreference(
66
- * 'preference_id',
67
- * );
41
+ * const preference = await client.preferences.update({
42
+ * preference_id: 'preference_id',
43
+ * });
68
44
  * ```
69
45
  */
70
- deleteUserPreference(preferenceID, options) {
71
- return this._client.delete(path `/v2/preferences/userPreferenceDelete/${preferenceID}`, options);
46
+ update(body, options) {
47
+ return this._client.put('/v2/preferences/userPreferenceUpdate', { body, ...options });
72
48
  }
73
49
  /**
74
- * Update User Preference
50
+ * Delete User Preference
75
51
  *
76
52
  * @example
77
53
  * ```ts
78
- * const response =
79
- * await client.preferences.updateUserPreference({
80
- * preference_id: 'preference_id',
81
- * });
54
+ * const preference = await client.preferences.delete(
55
+ * 'preference_id',
56
+ * );
82
57
  * ```
83
58
  */
84
- updateUserPreference(body, options) {
85
- return this._client.put('/v2/preferences/userPreferenceUpdate', { body, ...options });
59
+ delete(preferenceID, options) {
60
+ return this._client.delete(path `/v2/preferences/userPreferenceDelete/${preferenceID}`, options);
86
61
  }
87
62
  }
88
63
  //# sourceMappingURL=preferences.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"preferences.mjs","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,OAAO,IAAI,YAAY,EAAE,EAAE;YACxE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,oBAAoB,CAClB,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,YAAoB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wCAAwC,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF"}
1
+ {"version":3,"file":"preferences.mjs","sourceRoot":"","sources":["../src/resources/preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wCAAwC,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACF"}