scorecard-ai 1.0.0-alpha.6 → 1.0.0-alpha.7

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 (166) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +15 -5
  3. package/client.d.mts +9 -2
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +9 -2
  6. package/client.d.ts.map +1 -1
  7. package/client.js +20 -0
  8. package/client.js.map +1 -1
  9. package/client.mjs +20 -0
  10. package/client.mjs.map +1 -1
  11. package/internal/headers.js +1 -1
  12. package/internal/headers.js.map +1 -1
  13. package/internal/headers.mjs +1 -1
  14. package/internal/headers.mjs.map +1 -1
  15. package/internal/to-file.d.mts +0 -1
  16. package/internal/to-file.d.mts.map +1 -1
  17. package/internal/to-file.d.ts +0 -1
  18. package/internal/to-file.d.ts.map +1 -1
  19. package/internal/to-file.js +3 -2
  20. package/internal/to-file.js.map +1 -1
  21. package/internal/to-file.mjs +3 -2
  22. package/internal/to-file.mjs.map +1 -1
  23. package/internal/uploads.d.mts +1 -1
  24. package/internal/uploads.d.mts.map +1 -1
  25. package/internal/uploads.d.ts +1 -1
  26. package/internal/uploads.d.ts.map +1 -1
  27. package/internal/uploads.js +14 -4
  28. package/internal/uploads.js.map +1 -1
  29. package/internal/uploads.mjs +12 -3
  30. package/internal/uploads.mjs.map +1 -1
  31. package/internal/utils/uuid.d.mts +1 -1
  32. package/internal/utils/uuid.d.mts.map +1 -1
  33. package/internal/utils/uuid.d.ts +1 -1
  34. package/internal/utils/uuid.d.ts.map +1 -1
  35. package/internal/utils/uuid.js +1 -2
  36. package/internal/utils/uuid.js.map +1 -1
  37. package/internal/utils/uuid.mjs +1 -2
  38. package/internal/utils/uuid.mjs.map +1 -1
  39. package/package.json +1 -5
  40. package/resources/index.d.mts +2 -1
  41. package/resources/index.d.mts.map +1 -1
  42. package/resources/index.d.ts +2 -1
  43. package/resources/index.d.ts.map +1 -1
  44. package/resources/index.js +3 -1
  45. package/resources/index.js.map +1 -1
  46. package/resources/index.mjs +1 -0
  47. package/resources/index.mjs.map +1 -1
  48. package/resources/projects.d.mts +39 -4
  49. package/resources/projects.d.mts.map +1 -1
  50. package/resources/projects.d.ts +39 -4
  51. package/resources/projects.d.ts.map +1 -1
  52. package/resources/projects.js +23 -4
  53. package/resources/projects.js.map +1 -1
  54. package/resources/projects.mjs +23 -4
  55. package/resources/projects.mjs.map +1 -1
  56. package/resources/records.d.mts +10 -0
  57. package/resources/records.d.mts.map +1 -1
  58. package/resources/records.d.ts +10 -0
  59. package/resources/records.d.ts.map +1 -1
  60. package/resources/records.js +10 -0
  61. package/resources/records.js.map +1 -1
  62. package/resources/records.mjs +10 -0
  63. package/resources/records.mjs.map +1 -1
  64. package/resources/runs.d.mts +16 -0
  65. package/resources/runs.d.mts.map +1 -1
  66. package/resources/runs.d.ts +16 -0
  67. package/resources/runs.d.ts.map +1 -1
  68. package/resources/runs.js +16 -0
  69. package/resources/runs.js.map +1 -1
  70. package/resources/runs.mjs +16 -0
  71. package/resources/runs.mjs.map +1 -1
  72. package/resources/scores.d.mts +83 -0
  73. package/resources/scores.d.mts.map +1 -0
  74. package/resources/scores.d.ts +83 -0
  75. package/resources/scores.d.ts.map +1 -0
  76. package/resources/scores.js +35 -0
  77. package/resources/scores.js.map +1 -0
  78. package/resources/scores.mjs +31 -0
  79. package/resources/scores.mjs.map +1 -0
  80. package/resources/system-configs.d.mts +33 -0
  81. package/resources/system-configs.d.mts.map +1 -1
  82. package/resources/system-configs.d.ts +33 -0
  83. package/resources/system-configs.d.ts.map +1 -1
  84. package/resources/system-configs.js +33 -0
  85. package/resources/system-configs.js.map +1 -1
  86. package/resources/system-configs.mjs +33 -0
  87. package/resources/system-configs.mjs.map +1 -1
  88. package/resources/systems.d.mts +73 -0
  89. package/resources/systems.d.mts.map +1 -1
  90. package/resources/systems.d.ts +73 -0
  91. package/resources/systems.d.ts.map +1 -1
  92. package/resources/systems.js +73 -0
  93. package/resources/systems.js.map +1 -1
  94. package/resources/systems.mjs +73 -0
  95. package/resources/systems.mjs.map +1 -1
  96. package/resources/testcases.d.mts +62 -0
  97. package/resources/testcases.d.mts.map +1 -1
  98. package/resources/testcases.d.ts +62 -0
  99. package/resources/testcases.d.ts.map +1 -1
  100. package/resources/testcases.js +62 -0
  101. package/resources/testcases.js.map +1 -1
  102. package/resources/testcases.mjs +62 -0
  103. package/resources/testcases.mjs.map +1 -1
  104. package/resources/testsets.d.mts +48 -0
  105. package/resources/testsets.d.mts.map +1 -1
  106. package/resources/testsets.d.ts +48 -0
  107. package/resources/testsets.d.ts.map +1 -1
  108. package/resources/testsets.js +48 -0
  109. package/resources/testsets.js.map +1 -1
  110. package/resources/testsets.mjs +48 -0
  111. package/resources/testsets.mjs.map +1 -1
  112. package/src/client.ts +29 -4
  113. package/src/internal/headers.ts +1 -1
  114. package/src/internal/to-file.ts +4 -2
  115. package/src/internal/uploads.ts +16 -4
  116. package/src/internal/utils/uuid.ts +1 -3
  117. package/src/resources/index.ts +4 -2
  118. package/src/resources/projects.ts +48 -9
  119. package/src/resources/records.ts +10 -0
  120. package/src/resources/runs.ts +16 -0
  121. package/src/resources/scores.ts +98 -0
  122. package/src/resources/system-configs.ts +33 -0
  123. package/src/resources/systems.ts +73 -0
  124. package/src/resources/testcases.ts +62 -0
  125. package/src/resources/testsets.ts +48 -0
  126. package/src/version.ts +1 -1
  127. package/version.d.mts +1 -1
  128. package/version.d.ts +1 -1
  129. package/version.js +1 -1
  130. package/version.mjs +1 -1
  131. package/internal/shims/crypto.d.mts +0 -13
  132. package/internal/shims/crypto.d.mts.map +0 -1
  133. package/internal/shims/crypto.d.ts +0 -13
  134. package/internal/shims/crypto.d.ts.map +0 -1
  135. package/internal/shims/crypto.js +0 -13
  136. package/internal/shims/crypto.js.map +0 -1
  137. package/internal/shims/crypto.mjs +0 -9
  138. package/internal/shims/crypto.mjs.map +0 -1
  139. package/internal/shims/file.d.mts +0 -22
  140. package/internal/shims/file.d.mts.map +0 -1
  141. package/internal/shims/file.d.ts +0 -22
  142. package/internal/shims/file.d.ts.map +0 -1
  143. package/internal/shims/file.js +0 -16
  144. package/internal/shims/file.js.map +0 -1
  145. package/internal/shims/file.mjs +0 -12
  146. package/internal/shims/file.mjs.map +0 -1
  147. package/internal/shims/getBuiltinModule.d.mts +0 -11
  148. package/internal/shims/getBuiltinModule.d.mts.map +0 -1
  149. package/internal/shims/getBuiltinModule.d.ts +0 -11
  150. package/internal/shims/getBuiltinModule.d.ts.map +0 -1
  151. package/internal/shims/getBuiltinModule.js +0 -71
  152. package/internal/shims/getBuiltinModule.js.map +0 -1
  153. package/internal/shims/getBuiltinModule.mjs +0 -67
  154. package/internal/shims/getBuiltinModule.mjs.map +0 -1
  155. package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
  156. package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
  157. package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
  158. package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
  159. package/internal/shims/nullGetBuiltinModule.js +0 -5
  160. package/internal/shims/nullGetBuiltinModule.js.map +0 -1
  161. package/internal/shims/nullGetBuiltinModule.mjs +0 -2
  162. package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
  163. package/src/internal/shims/crypto.ts +0 -18
  164. package/src/internal/shims/file.ts +0 -32
  165. package/src/internal/shims/getBuiltinModule.ts +0 -66
  166. package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
@@ -5,22 +5,84 @@ import { RequestOptions } from "../internal/request-options.mjs";
5
5
  export declare class Testcases extends APIResource {
6
6
  /**
7
7
  * Create multiple Testcases in the specified Testset.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const testcase = await client.testcases.create('246', {
12
+ * items: [
13
+ * {
14
+ * jsonData: {
15
+ * question: 'What is the capital of France?',
16
+ * idealAnswer: 'Paris',
17
+ * provenance: 'hand_curated',
18
+ * },
19
+ * },
20
+ * {
21
+ * jsonData: {
22
+ * question:
23
+ * 'What is the largest planet in our solar system?',
24
+ * idealAnswer: 'Jupiter',
25
+ * provenance: 'synthetic',
26
+ * },
27
+ * },
28
+ * {
29
+ * jsonData: {
30
+ * question:
31
+ * 'How many planets are in our solar system?',
32
+ * idealAnswer: 8,
33
+ * provenance: 'user_feedback',
34
+ * },
35
+ * },
36
+ * ],
37
+ * });
38
+ * ```
8
39
  */
9
40
  create(testsetID: string, body: TestcaseCreateParams, options?: RequestOptions): APIPromise<TestcaseCreateResponse>;
10
41
  /**
11
42
  * Replace the data of an existing Testcase while keeping its ID.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * const testcase = await client.testcases.update('248', {
47
+ * jsonData: {
48
+ * question: 'What is the capital of France?',
49
+ * idealAnswer: 'Paris is the capital of France',
50
+ * provenance: 'hand_curated',
51
+ * },
52
+ * });
53
+ * ```
12
54
  */
13
55
  update(testcaseID: string, body: TestcaseUpdateParams, options?: RequestOptions): APIPromise<Testcase>;
14
56
  /**
15
57
  * Retrieve a paginated list of Testcases belonging to a Testset.
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * // Automatically fetches more pages as needed.
62
+ * for await (const testcase of client.testcases.list('246')) {
63
+ * // ...
64
+ * }
65
+ * ```
16
66
  */
17
67
  list(testsetID: string, query?: TestcaseListParams | null | undefined, options?: RequestOptions): PagePromise<TestcasesPaginatedResponse, Testcase>;
18
68
  /**
19
69
  * Delete multiple Testcases by their IDs.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const testcase = await client.testcases.delete({
74
+ * ids: ['123', '124', '125'],
75
+ * });
76
+ * ```
20
77
  */
21
78
  delete(body: TestcaseDeleteParams, options?: RequestOptions): APIPromise<TestcaseDeleteResponse>;
22
79
  /**
23
80
  * Retrieve a specific Testcase by ID.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const testcase = await client.testcases.get('248');
85
+ * ```
24
86
  */
25
87
  get(testcaseID: string, options?: RequestOptions): APIPromise<Testcase>;
26
88
  }
@@ -1 +1 @@
1
- {"version":3,"file":"testcases.d.mts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;OAEG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;;;;;OAOG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"testcases.d.mts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;OAOG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;;;;;OAOG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -5,22 +5,84 @@ import { RequestOptions } from "../internal/request-options.js";
5
5
  export declare class Testcases extends APIResource {
6
6
  /**
7
7
  * Create multiple Testcases in the specified Testset.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const testcase = await client.testcases.create('246', {
12
+ * items: [
13
+ * {
14
+ * jsonData: {
15
+ * question: 'What is the capital of France?',
16
+ * idealAnswer: 'Paris',
17
+ * provenance: 'hand_curated',
18
+ * },
19
+ * },
20
+ * {
21
+ * jsonData: {
22
+ * question:
23
+ * 'What is the largest planet in our solar system?',
24
+ * idealAnswer: 'Jupiter',
25
+ * provenance: 'synthetic',
26
+ * },
27
+ * },
28
+ * {
29
+ * jsonData: {
30
+ * question:
31
+ * 'How many planets are in our solar system?',
32
+ * idealAnswer: 8,
33
+ * provenance: 'user_feedback',
34
+ * },
35
+ * },
36
+ * ],
37
+ * });
38
+ * ```
8
39
  */
9
40
  create(testsetID: string, body: TestcaseCreateParams, options?: RequestOptions): APIPromise<TestcaseCreateResponse>;
10
41
  /**
11
42
  * Replace the data of an existing Testcase while keeping its ID.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * const testcase = await client.testcases.update('248', {
47
+ * jsonData: {
48
+ * question: 'What is the capital of France?',
49
+ * idealAnswer: 'Paris is the capital of France',
50
+ * provenance: 'hand_curated',
51
+ * },
52
+ * });
53
+ * ```
12
54
  */
13
55
  update(testcaseID: string, body: TestcaseUpdateParams, options?: RequestOptions): APIPromise<Testcase>;
14
56
  /**
15
57
  * Retrieve a paginated list of Testcases belonging to a Testset.
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * // Automatically fetches more pages as needed.
62
+ * for await (const testcase of client.testcases.list('246')) {
63
+ * // ...
64
+ * }
65
+ * ```
16
66
  */
17
67
  list(testsetID: string, query?: TestcaseListParams | null | undefined, options?: RequestOptions): PagePromise<TestcasesPaginatedResponse, Testcase>;
18
68
  /**
19
69
  * Delete multiple Testcases by their IDs.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const testcase = await client.testcases.delete({
74
+ * ids: ['123', '124', '125'],
75
+ * });
76
+ * ```
20
77
  */
21
78
  delete(body: TestcaseDeleteParams, options?: RequestOptions): APIPromise<TestcaseDeleteResponse>;
22
79
  /**
23
80
  * Retrieve a specific Testcase by ID.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const testcase = await client.testcases.get('248');
85
+ * ```
24
86
  */
25
87
  get(testcaseID: string, options?: RequestOptions): APIPromise<Testcase>;
26
88
  }
@@ -1 +1 @@
1
- {"version":3,"file":"testcases.d.ts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;OAEG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;;;;;OAOG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"testcases.d.ts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;OAOG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;;;;;OAOG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -8,18 +8,68 @@ const path_1 = require("../internal/utils/path.js");
8
8
  class Testcases extends resource_1.APIResource {
9
9
  /**
10
10
  * Create multiple Testcases in the specified Testset.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const testcase = await client.testcases.create('246', {
15
+ * items: [
16
+ * {
17
+ * jsonData: {
18
+ * question: 'What is the capital of France?',
19
+ * idealAnswer: 'Paris',
20
+ * provenance: 'hand_curated',
21
+ * },
22
+ * },
23
+ * {
24
+ * jsonData: {
25
+ * question:
26
+ * 'What is the largest planet in our solar system?',
27
+ * idealAnswer: 'Jupiter',
28
+ * provenance: 'synthetic',
29
+ * },
30
+ * },
31
+ * {
32
+ * jsonData: {
33
+ * question:
34
+ * 'How many planets are in our solar system?',
35
+ * idealAnswer: 8,
36
+ * provenance: 'user_feedback',
37
+ * },
38
+ * },
39
+ * ],
40
+ * });
41
+ * ```
11
42
  */
12
43
  create(testsetID, body, options) {
13
44
  return this._client.post((0, path_1.path) `/testsets/${testsetID}/testcases`, { body, ...options });
14
45
  }
15
46
  /**
16
47
  * Replace the data of an existing Testcase while keeping its ID.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const testcase = await client.testcases.update('248', {
52
+ * jsonData: {
53
+ * question: 'What is the capital of France?',
54
+ * idealAnswer: 'Paris is the capital of France',
55
+ * provenance: 'hand_curated',
56
+ * },
57
+ * });
58
+ * ```
17
59
  */
18
60
  update(testcaseID, body, options) {
19
61
  return this._client.put((0, path_1.path) `/testcases/${testcaseID}`, { body, ...options });
20
62
  }
21
63
  /**
22
64
  * Retrieve a paginated list of Testcases belonging to a Testset.
65
+ *
66
+ * @example
67
+ * ```ts
68
+ * // Automatically fetches more pages as needed.
69
+ * for await (const testcase of client.testcases.list('246')) {
70
+ * // ...
71
+ * }
72
+ * ```
23
73
  */
24
74
  list(testsetID, query = {}, options) {
25
75
  return this._client.getAPIList((0, path_1.path) `/testsets/${testsetID}/testcases`, (pagination_1.PaginatedResponse), {
@@ -29,12 +79,24 @@ class Testcases extends resource_1.APIResource {
29
79
  }
30
80
  /**
31
81
  * Delete multiple Testcases by their IDs.
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * const testcase = await client.testcases.delete({
86
+ * ids: ['123', '124', '125'],
87
+ * });
88
+ * ```
32
89
  */
33
90
  delete(body, options) {
34
91
  return this._client.post('/testcases/bulk-delete', { body, ...options });
35
92
  }
36
93
  /**
37
94
  * Retrieve a specific Testcase by ID.
95
+ *
96
+ * @example
97
+ * ```ts
98
+ * const testcase = await client.testcases.get('248');
99
+ * ```
38
100
  */
39
101
  get(testcaseID, options) {
40
102
  return this._client.get((0, path_1.path) `/testcases/${testcaseID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"testcases.js","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAkB,EAAE,IAA0B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,CAAA,8BAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AA9CD,8BA8CC"}
1
+ {"version":3,"file":"testcases.js","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAkB,EAAE,IAA0B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,CAAA,8BAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AA5GD,8BA4GC"}
@@ -5,18 +5,68 @@ import { path } from "../internal/utils/path.mjs";
5
5
  export class Testcases extends APIResource {
6
6
  /**
7
7
  * Create multiple Testcases in the specified Testset.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const testcase = await client.testcases.create('246', {
12
+ * items: [
13
+ * {
14
+ * jsonData: {
15
+ * question: 'What is the capital of France?',
16
+ * idealAnswer: 'Paris',
17
+ * provenance: 'hand_curated',
18
+ * },
19
+ * },
20
+ * {
21
+ * jsonData: {
22
+ * question:
23
+ * 'What is the largest planet in our solar system?',
24
+ * idealAnswer: 'Jupiter',
25
+ * provenance: 'synthetic',
26
+ * },
27
+ * },
28
+ * {
29
+ * jsonData: {
30
+ * question:
31
+ * 'How many planets are in our solar system?',
32
+ * idealAnswer: 8,
33
+ * provenance: 'user_feedback',
34
+ * },
35
+ * },
36
+ * ],
37
+ * });
38
+ * ```
8
39
  */
9
40
  create(testsetID, body, options) {
10
41
  return this._client.post(path `/testsets/${testsetID}/testcases`, { body, ...options });
11
42
  }
12
43
  /**
13
44
  * Replace the data of an existing Testcase while keeping its ID.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * const testcase = await client.testcases.update('248', {
49
+ * jsonData: {
50
+ * question: 'What is the capital of France?',
51
+ * idealAnswer: 'Paris is the capital of France',
52
+ * provenance: 'hand_curated',
53
+ * },
54
+ * });
55
+ * ```
14
56
  */
15
57
  update(testcaseID, body, options) {
16
58
  return this._client.put(path `/testcases/${testcaseID}`, { body, ...options });
17
59
  }
18
60
  /**
19
61
  * Retrieve a paginated list of Testcases belonging to a Testset.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * // Automatically fetches more pages as needed.
66
+ * for await (const testcase of client.testcases.list('246')) {
67
+ * // ...
68
+ * }
69
+ * ```
20
70
  */
21
71
  list(testsetID, query = {}, options) {
22
72
  return this._client.getAPIList(path `/testsets/${testsetID}/testcases`, (PaginatedResponse), {
@@ -26,12 +76,24 @@ export class Testcases extends APIResource {
26
76
  }
27
77
  /**
28
78
  * Delete multiple Testcases by their IDs.
79
+ *
80
+ * @example
81
+ * ```ts
82
+ * const testcase = await client.testcases.delete({
83
+ * ids: ['123', '124', '125'],
84
+ * });
85
+ * ```
29
86
  */
30
87
  delete(body, options) {
31
88
  return this._client.post('/testcases/bulk-delete', { body, ...options });
32
89
  }
33
90
  /**
34
91
  * Retrieve a specific Testcase by ID.
92
+ *
93
+ * @example
94
+ * ```ts
95
+ * const testcase = await client.testcases.get('248');
96
+ * ```
35
97
  */
36
98
  get(testcaseID, options) {
37
99
  return this._client.get(path `/testcases/${testcaseID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"testcases.mjs","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAkB,EAAE,IAA0B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,YAAY,EAAE,CAAA,iBAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}
1
+ {"version":3,"file":"testcases.mjs","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAkB,EAAE,IAA0B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,YAAY,EAAE,CAAA,iBAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}
@@ -6,6 +6,28 @@ export declare class Testsets extends APIResource {
6
6
  /**
7
7
  * Create a new Testset for a Project. The Testset will be created in the Project
8
8
  * specified in the path.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const testset = await client.testsets.create('314', {
13
+ * description: 'Testset for long context Q&A chatbot.',
14
+ * fieldMapping: {
15
+ * inputs: ['question'],
16
+ * labels: ['idealAnswer'],
17
+ * metadata: [],
18
+ * },
19
+ * jsonSchema: {
20
+ * type: 'object',
21
+ * properties: {
22
+ * question: { type: 'string' },
23
+ * idealAnswer: { type: 'string' },
24
+ * provenance: { type: 'string' },
25
+ * geo: { type: 'string' },
26
+ * },
27
+ * },
28
+ * name: 'Long Context Q&A',
29
+ * });
30
+ * ```
9
31
  */
10
32
  create(projectID: string, body: TestsetCreateParams, options?: RequestOptions): APIPromise<Testset>;
11
33
  /**
@@ -21,18 +43,44 @@ export declare class Testsets extends APIResource {
21
43
  * updated schema
22
44
  * - For complete control, provide both schema and fieldMapping when updating the
23
45
  * schema
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const testset = await client.testsets.update('246', {
50
+ * description: 'Updated description for the Q&A Testset.',
51
+ * name: 'Updated Q&A Testset',
52
+ * });
53
+ * ```
24
54
  */
25
55
  update(testsetID: string, body?: TestsetUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Testset>;
26
56
  /**
27
57
  * Retrieve a paginated list of Testsets belonging to a Project.
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * // Automatically fetches more pages as needed.
62
+ * for await (const testset of client.testsets.list('314')) {
63
+ * // ...
64
+ * }
65
+ * ```
28
66
  */
29
67
  list(projectID: string, query?: TestsetListParams | null | undefined, options?: RequestOptions): PagePromise<TestsetsPaginatedResponse, Testset>;
30
68
  /**
31
69
  * Delete Testset
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const testset = await client.testsets.delete('246');
74
+ * ```
32
75
  */
33
76
  delete(testsetID: string, options?: RequestOptions): APIPromise<TestsetDeleteResponse>;
34
77
  /**
35
78
  * Get Testset by ID
79
+ *
80
+ * @example
81
+ * ```ts
82
+ * const testset = await client.testsets.get('246');
83
+ * ```
36
84
  */
37
85
  get(testsetID: string, options?: RequestOptions): APIPromise<Testset>;
38
86
  }
@@ -1 +1 @@
1
- {"version":3,"file":"testsets.d.mts","sourceRoot":"","sources":["../src/resources/testsets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;OAEG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,OAAO,CAAC;IAOlD;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGtE;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;CAAG;AAErE,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
1
+ {"version":3,"file":"testsets.d.mts","sourceRoot":"","sources":["../src/resources/testsets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,OAAO,CAAC;IAOlD;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;OAOG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGtE;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;CAAG;AAErE,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
@@ -6,6 +6,28 @@ export declare class Testsets extends APIResource {
6
6
  /**
7
7
  * Create a new Testset for a Project. The Testset will be created in the Project
8
8
  * specified in the path.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const testset = await client.testsets.create('314', {
13
+ * description: 'Testset for long context Q&A chatbot.',
14
+ * fieldMapping: {
15
+ * inputs: ['question'],
16
+ * labels: ['idealAnswer'],
17
+ * metadata: [],
18
+ * },
19
+ * jsonSchema: {
20
+ * type: 'object',
21
+ * properties: {
22
+ * question: { type: 'string' },
23
+ * idealAnswer: { type: 'string' },
24
+ * provenance: { type: 'string' },
25
+ * geo: { type: 'string' },
26
+ * },
27
+ * },
28
+ * name: 'Long Context Q&A',
29
+ * });
30
+ * ```
9
31
  */
10
32
  create(projectID: string, body: TestsetCreateParams, options?: RequestOptions): APIPromise<Testset>;
11
33
  /**
@@ -21,18 +43,44 @@ export declare class Testsets extends APIResource {
21
43
  * updated schema
22
44
  * - For complete control, provide both schema and fieldMapping when updating the
23
45
  * schema
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const testset = await client.testsets.update('246', {
50
+ * description: 'Updated description for the Q&A Testset.',
51
+ * name: 'Updated Q&A Testset',
52
+ * });
53
+ * ```
24
54
  */
25
55
  update(testsetID: string, body?: TestsetUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Testset>;
26
56
  /**
27
57
  * Retrieve a paginated list of Testsets belonging to a Project.
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * // Automatically fetches more pages as needed.
62
+ * for await (const testset of client.testsets.list('314')) {
63
+ * // ...
64
+ * }
65
+ * ```
28
66
  */
29
67
  list(projectID: string, query?: TestsetListParams | null | undefined, options?: RequestOptions): PagePromise<TestsetsPaginatedResponse, Testset>;
30
68
  /**
31
69
  * Delete Testset
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const testset = await client.testsets.delete('246');
74
+ * ```
32
75
  */
33
76
  delete(testsetID: string, options?: RequestOptions): APIPromise<TestsetDeleteResponse>;
34
77
  /**
35
78
  * Get Testset by ID
79
+ *
80
+ * @example
81
+ * ```ts
82
+ * const testset = await client.testsets.get('246');
83
+ * ```
36
84
  */
37
85
  get(testsetID: string, options?: RequestOptions): APIPromise<Testset>;
38
86
  }
@@ -1 +1 @@
1
- {"version":3,"file":"testsets.d.ts","sourceRoot":"","sources":["../src/resources/testsets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;OAEG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,OAAO,CAAC;IAOlD;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGtE;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;CAAG;AAErE,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
1
+ {"version":3,"file":"testsets.d.ts","sourceRoot":"","sources":["../src/resources/testsets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,OAAO,CAAC;IAOlD;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;OAOG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGtE;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;CAAG;AAErE,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
@@ -9,6 +9,28 @@ class Testsets extends resource_1.APIResource {
9
9
  /**
10
10
  * Create a new Testset for a Project. The Testset will be created in the Project
11
11
  * specified in the path.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const testset = await client.testsets.create('314', {
16
+ * description: 'Testset for long context Q&A chatbot.',
17
+ * fieldMapping: {
18
+ * inputs: ['question'],
19
+ * labels: ['idealAnswer'],
20
+ * metadata: [],
21
+ * },
22
+ * jsonSchema: {
23
+ * type: 'object',
24
+ * properties: {
25
+ * question: { type: 'string' },
26
+ * idealAnswer: { type: 'string' },
27
+ * provenance: { type: 'string' },
28
+ * geo: { type: 'string' },
29
+ * },
30
+ * },
31
+ * name: 'Long Context Q&A',
32
+ * });
33
+ * ```
12
34
  */
13
35
  create(projectID, body, options) {
14
36
  return this._client.post((0, path_1.path) `/projects/${projectID}/testsets`, { body, ...options });
@@ -26,12 +48,28 @@ class Testsets extends resource_1.APIResource {
26
48
  * updated schema
27
49
  * - For complete control, provide both schema and fieldMapping when updating the
28
50
  * schema
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const testset = await client.testsets.update('246', {
55
+ * description: 'Updated description for the Q&A Testset.',
56
+ * name: 'Updated Q&A Testset',
57
+ * });
58
+ * ```
29
59
  */
30
60
  update(testsetID, body = {}, options) {
31
61
  return this._client.patch((0, path_1.path) `/testsets/${testsetID}`, { body, ...options });
32
62
  }
33
63
  /**
34
64
  * Retrieve a paginated list of Testsets belonging to a Project.
65
+ *
66
+ * @example
67
+ * ```ts
68
+ * // Automatically fetches more pages as needed.
69
+ * for await (const testset of client.testsets.list('314')) {
70
+ * // ...
71
+ * }
72
+ * ```
35
73
  */
36
74
  list(projectID, query = {}, options) {
37
75
  return this._client.getAPIList((0, path_1.path) `/projects/${projectID}/testsets`, (pagination_1.PaginatedResponse), {
@@ -41,12 +79,22 @@ class Testsets extends resource_1.APIResource {
41
79
  }
42
80
  /**
43
81
  * Delete Testset
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * const testset = await client.testsets.delete('246');
86
+ * ```
44
87
  */
45
88
  delete(testsetID, options) {
46
89
  return this._client.delete((0, path_1.path) `/testsets/${testsetID}`, options);
47
90
  }
48
91
  /**
49
92
  * Get Testset by ID
93
+ *
94
+ * @example
95
+ * ```ts
96
+ * const testset = await client.testsets.get('246');
97
+ * ```
50
98
  */
51
99
  get(testsetID, options) {
52
100
  return this._client.get((0, path_1.path) `/testsets/${testsetID}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"testsets.js","sourceRoot":"","sources":["../src/resources/testsets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;OAGG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,SAAiB,EACjB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,SAAiB,EACjB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,WAAW,EAAE,CAAA,8BAA0B,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AA1DD,4BA0DC"}
1
+ {"version":3,"file":"testsets.js","sourceRoot":"","sources":["../src/resources/testsets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,SAAiB,EACjB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,WAAW,EAAE,CAAA,8BAA0B,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AA1GD,4BA0GC"}