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

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 (173) hide show
  1. package/CHANGELOG.md +57 -0
  2. package/README.md +15 -5
  3. package/client.d.mts +11 -4
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +11 -4
  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/lib/runAndEvaluate.d.mts.map +1 -1
  40. package/lib/runAndEvaluate.d.ts.map +1 -1
  41. package/lib/runAndEvaluate.js +1 -5
  42. package/lib/runAndEvaluate.js.map +1 -1
  43. package/lib/runAndEvaluate.mjs +1 -5
  44. package/lib/runAndEvaluate.mjs.map +1 -1
  45. package/package.json +1 -5
  46. package/resources/index.d.mts +3 -2
  47. package/resources/index.d.mts.map +1 -1
  48. package/resources/index.d.ts +3 -2
  49. package/resources/index.d.ts.map +1 -1
  50. package/resources/index.js +3 -1
  51. package/resources/index.js.map +1 -1
  52. package/resources/index.mjs +1 -0
  53. package/resources/index.mjs.map +1 -1
  54. package/resources/projects.d.mts +39 -4
  55. package/resources/projects.d.mts.map +1 -1
  56. package/resources/projects.d.ts +39 -4
  57. package/resources/projects.d.ts.map +1 -1
  58. package/resources/projects.js +23 -4
  59. package/resources/projects.js.map +1 -1
  60. package/resources/projects.mjs +23 -4
  61. package/resources/projects.mjs.map +1 -1
  62. package/resources/records.d.mts +20 -8
  63. package/resources/records.d.mts.map +1 -1
  64. package/resources/records.d.ts +20 -8
  65. package/resources/records.d.ts.map +1 -1
  66. package/resources/records.js +12 -0
  67. package/resources/records.js.map +1 -1
  68. package/resources/records.mjs +12 -0
  69. package/resources/records.mjs.map +1 -1
  70. package/resources/runs.d.mts +10 -21
  71. package/resources/runs.d.mts.map +1 -1
  72. package/resources/runs.d.ts +10 -21
  73. package/resources/runs.d.ts.map +1 -1
  74. package/resources/runs.js +9 -6
  75. package/resources/runs.js.map +1 -1
  76. package/resources/runs.mjs +9 -6
  77. package/resources/runs.mjs.map +1 -1
  78. package/resources/scores.d.mts +83 -0
  79. package/resources/scores.d.mts.map +1 -0
  80. package/resources/scores.d.ts +83 -0
  81. package/resources/scores.d.ts.map +1 -0
  82. package/resources/scores.js +35 -0
  83. package/resources/scores.js.map +1 -0
  84. package/resources/scores.mjs +31 -0
  85. package/resources/scores.mjs.map +1 -0
  86. package/resources/system-configs.d.mts +33 -0
  87. package/resources/system-configs.d.mts.map +1 -1
  88. package/resources/system-configs.d.ts +33 -0
  89. package/resources/system-configs.d.ts.map +1 -1
  90. package/resources/system-configs.js +33 -0
  91. package/resources/system-configs.js.map +1 -1
  92. package/resources/system-configs.mjs +33 -0
  93. package/resources/system-configs.mjs.map +1 -1
  94. package/resources/systems.d.mts +73 -0
  95. package/resources/systems.d.mts.map +1 -1
  96. package/resources/systems.d.ts +73 -0
  97. package/resources/systems.d.ts.map +1 -1
  98. package/resources/systems.js +73 -0
  99. package/resources/systems.js.map +1 -1
  100. package/resources/systems.mjs +73 -0
  101. package/resources/systems.mjs.map +1 -1
  102. package/resources/testcases.d.mts +72 -18
  103. package/resources/testcases.d.mts.map +1 -1
  104. package/resources/testcases.d.ts +72 -18
  105. package/resources/testcases.d.ts.map +1 -1
  106. package/resources/testcases.js +62 -0
  107. package/resources/testcases.js.map +1 -1
  108. package/resources/testcases.mjs +62 -0
  109. package/resources/testcases.mjs.map +1 -1
  110. package/resources/testsets.d.mts +78 -30
  111. package/resources/testsets.d.mts.map +1 -1
  112. package/resources/testsets.d.ts +78 -30
  113. package/resources/testsets.d.ts.map +1 -1
  114. package/resources/testsets.js +48 -0
  115. package/resources/testsets.js.map +1 -1
  116. package/resources/testsets.mjs +48 -0
  117. package/resources/testsets.mjs.map +1 -1
  118. package/src/client.ts +31 -12
  119. package/src/internal/headers.ts +1 -1
  120. package/src/internal/to-file.ts +4 -2
  121. package/src/internal/uploads.ts +16 -4
  122. package/src/internal/utils/uuid.ts +1 -3
  123. package/src/lib/runAndEvaluate.ts +1 -6
  124. package/src/resources/index.ts +5 -3
  125. package/src/resources/projects.ts +48 -9
  126. package/src/resources/records.ts +22 -10
  127. package/src/resources/runs.ts +10 -46
  128. package/src/resources/scores.ts +98 -0
  129. package/src/resources/system-configs.ts +33 -0
  130. package/src/resources/systems.ts +73 -0
  131. package/src/resources/testcases.ts +73 -19
  132. package/src/resources/testsets.ts +78 -30
  133. package/src/version.ts +1 -1
  134. package/version.d.mts +1 -1
  135. package/version.d.ts +1 -1
  136. package/version.js +1 -1
  137. package/version.mjs +1 -1
  138. package/internal/shims/crypto.d.mts +0 -13
  139. package/internal/shims/crypto.d.mts.map +0 -1
  140. package/internal/shims/crypto.d.ts +0 -13
  141. package/internal/shims/crypto.d.ts.map +0 -1
  142. package/internal/shims/crypto.js +0 -13
  143. package/internal/shims/crypto.js.map +0 -1
  144. package/internal/shims/crypto.mjs +0 -9
  145. package/internal/shims/crypto.mjs.map +0 -1
  146. package/internal/shims/file.d.mts +0 -22
  147. package/internal/shims/file.d.mts.map +0 -1
  148. package/internal/shims/file.d.ts +0 -22
  149. package/internal/shims/file.d.ts.map +0 -1
  150. package/internal/shims/file.js +0 -16
  151. package/internal/shims/file.js.map +0 -1
  152. package/internal/shims/file.mjs +0 -12
  153. package/internal/shims/file.mjs.map +0 -1
  154. package/internal/shims/getBuiltinModule.d.mts +0 -11
  155. package/internal/shims/getBuiltinModule.d.mts.map +0 -1
  156. package/internal/shims/getBuiltinModule.d.ts +0 -11
  157. package/internal/shims/getBuiltinModule.d.ts.map +0 -1
  158. package/internal/shims/getBuiltinModule.js +0 -71
  159. package/internal/shims/getBuiltinModule.js.map +0 -1
  160. package/internal/shims/getBuiltinModule.mjs +0 -67
  161. package/internal/shims/getBuiltinModule.mjs.map +0 -1
  162. package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
  163. package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
  164. package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
  165. package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
  166. package/internal/shims/nullGetBuiltinModule.js +0 -5
  167. package/internal/shims/nullGetBuiltinModule.js.map +0 -1
  168. package/internal/shims/nullGetBuiltinModule.mjs +0 -2
  169. package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
  170. package/src/internal/shims/crypto.ts +0 -18
  171. package/src/internal/shims/file.ts +0 -32
  172. package/src/internal/shims/getBuiltinModule.ts +0 -66
  173. package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
@@ -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
+ * expected: ['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
  }
@@ -40,9 +88,9 @@ export type TestsetsPaginatedResponse = PaginatedResponse<Testset>;
40
88
  /**
41
89
  * A collection of Testcases that share the same schema. Each Testset defines the
42
90
  * structure of its Testcases through a JSON schema. The `fieldMapping` object maps
43
- * top-level keys of the Testcase schema to their roles (input/label). Fields not
44
- * mentioned in the `fieldMapping` during creation or update are treated as
45
- * metadata.
91
+ * top-level keys of the Testcase schema to their roles (input/expected output).
92
+ * Fields not mentioned in the `fieldMapping` during creation or update are treated
93
+ * as metadata.
46
94
  *
47
95
  * ## JSON Schema validation constraints supported:
48
96
  *
@@ -73,8 +121,8 @@ export interface Testset {
73
121
  */
74
122
  description: string;
75
123
  /**
76
- * Maps top-level keys of the Testcase schema to their roles (input/label).
77
- * Unmapped fields are treated as metadata.
124
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
125
+ * output). Unmapped fields are treated as metadata.
78
126
  */
79
127
  fieldMapping: Testset.FieldMapping;
80
128
  /**
@@ -88,20 +136,20 @@ export interface Testset {
88
136
  }
89
137
  export declare namespace Testset {
90
138
  /**
91
- * Maps top-level keys of the Testcase schema to their roles (input/label).
92
- * Unmapped fields are treated as metadata.
139
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
140
+ * output). Unmapped fields are treated as metadata.
93
141
  */
94
142
  interface FieldMapping {
95
143
  /**
96
- * Fields that represent inputs to the AI system.
144
+ * Fields that represent expected outputs.
97
145
  */
98
- inputs: Array<string>;
146
+ expected: Array<string>;
99
147
  /**
100
- * Fields that represent expected outputs/labels.
148
+ * Fields that represent inputs to the AI system.
101
149
  */
102
- labels: Array<string>;
150
+ inputs: Array<string>;
103
151
  /**
104
- * Fields that are not inputs or labels.
152
+ * Fields that are not inputs or expected outputs.
105
153
  */
106
154
  metadata: Array<string>;
107
155
  }
@@ -118,8 +166,8 @@ export interface TestsetCreateParams {
118
166
  */
119
167
  description: string;
120
168
  /**
121
- * Maps top-level keys of the Testcase schema to their roles (input/label).
122
- * Unmapped fields are treated as metadata.
169
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
170
+ * output). Unmapped fields are treated as metadata.
123
171
  */
124
172
  fieldMapping: TestsetCreateParams.FieldMapping;
125
173
  /**
@@ -133,20 +181,20 @@ export interface TestsetCreateParams {
133
181
  }
134
182
  export declare namespace TestsetCreateParams {
135
183
  /**
136
- * Maps top-level keys of the Testcase schema to their roles (input/label).
137
- * Unmapped fields are treated as metadata.
184
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
185
+ * output). Unmapped fields are treated as metadata.
138
186
  */
139
187
  interface FieldMapping {
140
188
  /**
141
- * Fields that represent inputs to the AI system.
189
+ * Fields that represent expected outputs.
142
190
  */
143
- inputs: Array<string>;
191
+ expected: Array<string>;
144
192
  /**
145
- * Fields that represent expected outputs/labels.
193
+ * Fields that represent inputs to the AI system.
146
194
  */
147
- labels: Array<string>;
195
+ inputs: Array<string>;
148
196
  /**
149
- * Fields that are not inputs or labels.
197
+ * Fields that are not inputs or expected outputs.
150
198
  */
151
199
  metadata: Array<string>;
152
200
  }
@@ -157,8 +205,8 @@ export interface TestsetUpdateParams {
157
205
  */
158
206
  description?: string;
159
207
  /**
160
- * Maps top-level keys of the Testcase schema to their roles (input/label).
161
- * Unmapped fields are treated as metadata.
208
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
209
+ * output). Unmapped fields are treated as metadata.
162
210
  */
163
211
  fieldMapping?: TestsetUpdateParams.FieldMapping;
164
212
  /**
@@ -172,20 +220,20 @@ export interface TestsetUpdateParams {
172
220
  }
173
221
  export declare namespace TestsetUpdateParams {
174
222
  /**
175
- * Maps top-level keys of the Testcase schema to their roles (input/label).
176
- * Unmapped fields are treated as metadata.
223
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
224
+ * output). Unmapped fields are treated as metadata.
177
225
  */
178
226
  interface FieldMapping {
179
227
  /**
180
- * Fields that represent inputs to the AI system.
228
+ * Fields that represent expected outputs.
181
229
  */
182
- inputs: Array<string>;
230
+ expected: Array<string>;
183
231
  /**
184
- * Fields that represent expected outputs/labels.
232
+ * Fields that represent inputs to the AI system.
185
233
  */
186
- labels: Array<string>;
234
+ inputs: Array<string>;
187
235
  /**
188
- * Fields that are not inputs or labels.
236
+ * Fields that are not inputs or expected outputs.
189
237
  */
190
238
  metadata: Array<string>;
191
239
  }
@@ -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,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;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,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;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,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;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
+ * expected: ['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
  }
@@ -40,9 +88,9 @@ export type TestsetsPaginatedResponse = PaginatedResponse<Testset>;
40
88
  /**
41
89
  * A collection of Testcases that share the same schema. Each Testset defines the
42
90
  * structure of its Testcases through a JSON schema. The `fieldMapping` object maps
43
- * top-level keys of the Testcase schema to their roles (input/label). Fields not
44
- * mentioned in the `fieldMapping` during creation or update are treated as
45
- * metadata.
91
+ * top-level keys of the Testcase schema to their roles (input/expected output).
92
+ * Fields not mentioned in the `fieldMapping` during creation or update are treated
93
+ * as metadata.
46
94
  *
47
95
  * ## JSON Schema validation constraints supported:
48
96
  *
@@ -73,8 +121,8 @@ export interface Testset {
73
121
  */
74
122
  description: string;
75
123
  /**
76
- * Maps top-level keys of the Testcase schema to their roles (input/label).
77
- * Unmapped fields are treated as metadata.
124
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
125
+ * output). Unmapped fields are treated as metadata.
78
126
  */
79
127
  fieldMapping: Testset.FieldMapping;
80
128
  /**
@@ -88,20 +136,20 @@ export interface Testset {
88
136
  }
89
137
  export declare namespace Testset {
90
138
  /**
91
- * Maps top-level keys of the Testcase schema to their roles (input/label).
92
- * Unmapped fields are treated as metadata.
139
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
140
+ * output). Unmapped fields are treated as metadata.
93
141
  */
94
142
  interface FieldMapping {
95
143
  /**
96
- * Fields that represent inputs to the AI system.
144
+ * Fields that represent expected outputs.
97
145
  */
98
- inputs: Array<string>;
146
+ expected: Array<string>;
99
147
  /**
100
- * Fields that represent expected outputs/labels.
148
+ * Fields that represent inputs to the AI system.
101
149
  */
102
- labels: Array<string>;
150
+ inputs: Array<string>;
103
151
  /**
104
- * Fields that are not inputs or labels.
152
+ * Fields that are not inputs or expected outputs.
105
153
  */
106
154
  metadata: Array<string>;
107
155
  }
@@ -118,8 +166,8 @@ export interface TestsetCreateParams {
118
166
  */
119
167
  description: string;
120
168
  /**
121
- * Maps top-level keys of the Testcase schema to their roles (input/label).
122
- * Unmapped fields are treated as metadata.
169
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
170
+ * output). Unmapped fields are treated as metadata.
123
171
  */
124
172
  fieldMapping: TestsetCreateParams.FieldMapping;
125
173
  /**
@@ -133,20 +181,20 @@ export interface TestsetCreateParams {
133
181
  }
134
182
  export declare namespace TestsetCreateParams {
135
183
  /**
136
- * Maps top-level keys of the Testcase schema to their roles (input/label).
137
- * Unmapped fields are treated as metadata.
184
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
185
+ * output). Unmapped fields are treated as metadata.
138
186
  */
139
187
  interface FieldMapping {
140
188
  /**
141
- * Fields that represent inputs to the AI system.
189
+ * Fields that represent expected outputs.
142
190
  */
143
- inputs: Array<string>;
191
+ expected: Array<string>;
144
192
  /**
145
- * Fields that represent expected outputs/labels.
193
+ * Fields that represent inputs to the AI system.
146
194
  */
147
- labels: Array<string>;
195
+ inputs: Array<string>;
148
196
  /**
149
- * Fields that are not inputs or labels.
197
+ * Fields that are not inputs or expected outputs.
150
198
  */
151
199
  metadata: Array<string>;
152
200
  }
@@ -157,8 +205,8 @@ export interface TestsetUpdateParams {
157
205
  */
158
206
  description?: string;
159
207
  /**
160
- * Maps top-level keys of the Testcase schema to their roles (input/label).
161
- * Unmapped fields are treated as metadata.
208
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
209
+ * output). Unmapped fields are treated as metadata.
162
210
  */
163
211
  fieldMapping?: TestsetUpdateParams.FieldMapping;
164
212
  /**
@@ -172,20 +220,20 @@ export interface TestsetUpdateParams {
172
220
  }
173
221
  export declare namespace TestsetUpdateParams {
174
222
  /**
175
- * Maps top-level keys of the Testcase schema to their roles (input/label).
176
- * Unmapped fields are treated as metadata.
223
+ * Maps top-level keys of the Testcase schema to their roles (input/expected
224
+ * output). Unmapped fields are treated as metadata.
177
225
  */
178
226
  interface FieldMapping {
179
227
  /**
180
- * Fields that represent inputs to the AI system.
228
+ * Fields that represent expected outputs.
181
229
  */
182
- inputs: Array<string>;
230
+ expected: Array<string>;
183
231
  /**
184
- * Fields that represent expected outputs/labels.
232
+ * Fields that represent inputs to the AI system.
185
233
  */
186
- labels: Array<string>;
234
+ inputs: Array<string>;
187
235
  /**
188
- * Fields that are not inputs or labels.
236
+ * Fields that are not inputs or expected outputs.
189
237
  */
190
238
  metadata: Array<string>;
191
239
  }
@@ -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,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;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,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;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,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;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
+ * expected: ['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"}