openai 4.96.2 → 4.98.0

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 (235) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +1 -1
  3. package/index.d.mts +5 -2
  4. package/index.d.ts +5 -2
  5. package/index.d.ts.map +1 -1
  6. package/index.js +3 -0
  7. package/index.js.map +1 -1
  8. package/index.mjs +3 -0
  9. package/index.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/audio/speech.d.ts +13 -1
  12. package/resources/audio/speech.d.ts.map +1 -1
  13. package/resources/audio/speech.js +12 -0
  14. package/resources/audio/speech.js.map +1 -1
  15. package/resources/audio/speech.mjs +12 -0
  16. package/resources/audio/speech.mjs.map +1 -1
  17. package/resources/audio/transcriptions.d.ts +9 -0
  18. package/resources/audio/transcriptions.d.ts.map +1 -1
  19. package/resources/audio/transcriptions.js.map +1 -1
  20. package/resources/audio/transcriptions.mjs.map +1 -1
  21. package/resources/audio/translations.d.ts +8 -0
  22. package/resources/audio/translations.d.ts.map +1 -1
  23. package/resources/audio/translations.js.map +1 -1
  24. package/resources/audio/translations.mjs.map +1 -1
  25. package/resources/beta/assistants.d.ts +36 -0
  26. package/resources/beta/assistants.d.ts.map +1 -1
  27. package/resources/beta/assistants.js +28 -0
  28. package/resources/beta/assistants.js.map +1 -1
  29. package/resources/beta/assistants.mjs +28 -0
  30. package/resources/beta/assistants.mjs.map +1 -1
  31. package/resources/beta/realtime/sessions.d.ts +6 -0
  32. package/resources/beta/realtime/sessions.d.ts.map +1 -1
  33. package/resources/beta/realtime/sessions.js +6 -0
  34. package/resources/beta/realtime/sessions.js.map +1 -1
  35. package/resources/beta/realtime/sessions.mjs +6 -0
  36. package/resources/beta/realtime/sessions.mjs.map +1 -1
  37. package/resources/beta/realtime/transcription-sessions.d.ts +6 -0
  38. package/resources/beta/realtime/transcription-sessions.d.ts.map +1 -1
  39. package/resources/beta/realtime/transcription-sessions.js +6 -0
  40. package/resources/beta/realtime/transcription-sessions.js.map +1 -1
  41. package/resources/beta/realtime/transcription-sessions.mjs +6 -0
  42. package/resources/beta/realtime/transcription-sessions.mjs.map +1 -1
  43. package/resources/beta/threads/messages.d.ts +43 -0
  44. package/resources/beta/threads/messages.d.ts.map +1 -1
  45. package/resources/beta/threads/messages.js +33 -0
  46. package/resources/beta/threads/messages.js.map +1 -1
  47. package/resources/beta/threads/messages.mjs +33 -0
  48. package/resources/beta/threads/messages.mjs.map +1 -1
  49. package/resources/beta/threads/runs/runs.d.ts +52 -0
  50. package/resources/beta/threads/runs/runs.d.ts.map +1 -1
  51. package/resources/beta/threads/runs/runs.js +24 -0
  52. package/resources/beta/threads/runs/runs.js.map +1 -1
  53. package/resources/beta/threads/runs/runs.mjs +24 -0
  54. package/resources/beta/threads/runs/runs.mjs.map +1 -1
  55. package/resources/beta/threads/runs/steps.d.ts +21 -0
  56. package/resources/beta/threads/runs/steps.d.ts.map +1 -1
  57. package/resources/beta/threads/runs/steps.js.map +1 -1
  58. package/resources/beta/threads/runs/steps.mjs.map +1 -1
  59. package/resources/beta/threads/threads.d.ts +33 -0
  60. package/resources/beta/threads/threads.d.ts.map +1 -1
  61. package/resources/beta/threads/threads.js +21 -0
  62. package/resources/beta/threads/threads.js.map +1 -1
  63. package/resources/beta/threads/threads.mjs +21 -0
  64. package/resources/beta/threads/threads.mjs.map +1 -1
  65. package/resources/chat/completions/completions.d.ts +42 -4
  66. package/resources/chat/completions/completions.d.ts.map +1 -1
  67. package/resources/chat/completions/completions.js +20 -0
  68. package/resources/chat/completions/completions.js.map +1 -1
  69. package/resources/chat/completions/completions.mjs +20 -0
  70. package/resources/chat/completions/completions.mjs.map +1 -1
  71. package/resources/chat/completions/messages.d.ts +10 -0
  72. package/resources/chat/completions/messages.d.ts.map +1 -1
  73. package/resources/chat/completions/messages.js.map +1 -1
  74. package/resources/chat/completions/messages.mjs.map +1 -1
  75. package/resources/completions.d.ts +8 -0
  76. package/resources/completions.d.ts.map +1 -1
  77. package/resources/completions.js.map +1 -1
  78. package/resources/completions.mjs.map +1 -1
  79. package/resources/embeddings.d.ts +9 -0
  80. package/resources/embeddings.d.ts.map +1 -1
  81. package/resources/embeddings.js +9 -0
  82. package/resources/embeddings.js.map +1 -1
  83. package/resources/embeddings.mjs +9 -0
  84. package/resources/embeddings.mjs.map +1 -1
  85. package/resources/evals/evals.d.ts +62 -533
  86. package/resources/evals/evals.d.ts.map +1 -1
  87. package/resources/evals/evals.js.map +1 -1
  88. package/resources/evals/evals.mjs.map +1 -1
  89. package/resources/evals/index.d.ts +1 -1
  90. package/resources/evals/index.d.ts.map +1 -1
  91. package/resources/evals/index.js.map +1 -1
  92. package/resources/evals/index.mjs.map +1 -1
  93. package/resources/fine-tuning/alpha/alpha.d.ts +10 -0
  94. package/resources/fine-tuning/alpha/alpha.d.ts.map +1 -0
  95. package/resources/fine-tuning/alpha/alpha.js +39 -0
  96. package/resources/fine-tuning/alpha/alpha.js.map +1 -0
  97. package/resources/fine-tuning/alpha/alpha.mjs +12 -0
  98. package/resources/fine-tuning/alpha/alpha.mjs.map +1 -0
  99. package/resources/fine-tuning/alpha/graders.d.ts +107 -0
  100. package/resources/fine-tuning/alpha/graders.d.ts.map +1 -0
  101. package/resources/fine-tuning/alpha/graders.js +50 -0
  102. package/resources/fine-tuning/alpha/graders.js.map +1 -0
  103. package/resources/fine-tuning/alpha/graders.mjs +46 -0
  104. package/resources/fine-tuning/alpha/graders.mjs.map +1 -0
  105. package/resources/fine-tuning/alpha/index.d.ts +3 -0
  106. package/resources/fine-tuning/alpha/index.d.ts.map +1 -0
  107. package/resources/fine-tuning/alpha/index.js +9 -0
  108. package/resources/fine-tuning/alpha/index.js.map +1 -0
  109. package/resources/fine-tuning/alpha/index.mjs +4 -0
  110. package/resources/fine-tuning/alpha/index.mjs.map +1 -0
  111. package/resources/fine-tuning/alpha.d.ts +2 -0
  112. package/resources/fine-tuning/alpha.d.ts.map +1 -0
  113. package/resources/fine-tuning/alpha.js +19 -0
  114. package/resources/fine-tuning/alpha.js.map +1 -0
  115. package/resources/fine-tuning/alpha.mjs +3 -0
  116. package/resources/fine-tuning/alpha.mjs.map +1 -0
  117. package/resources/fine-tuning/checkpoints/permissions.d.ts +28 -0
  118. package/resources/fine-tuning/checkpoints/permissions.d.ts.map +1 -1
  119. package/resources/fine-tuning/checkpoints/permissions.js +20 -0
  120. package/resources/fine-tuning/checkpoints/permissions.js.map +1 -1
  121. package/resources/fine-tuning/checkpoints/permissions.mjs +20 -0
  122. package/resources/fine-tuning/checkpoints/permissions.mjs.map +1 -1
  123. package/resources/fine-tuning/fine-tuning.d.ts +8 -0
  124. package/resources/fine-tuning/fine-tuning.d.ts.map +1 -1
  125. package/resources/fine-tuning/fine-tuning.js +8 -0
  126. package/resources/fine-tuning/fine-tuning.js.map +1 -1
  127. package/resources/fine-tuning/fine-tuning.mjs +8 -0
  128. package/resources/fine-tuning/fine-tuning.mjs.map +1 -1
  129. package/resources/fine-tuning/index.d.ts +2 -0
  130. package/resources/fine-tuning/index.d.ts.map +1 -1
  131. package/resources/fine-tuning/index.js +11 -7
  132. package/resources/fine-tuning/index.js.map +1 -1
  133. package/resources/fine-tuning/index.mjs +2 -0
  134. package/resources/fine-tuning/index.mjs.map +1 -1
  135. package/resources/fine-tuning/jobs/checkpoints.d.ts +10 -0
  136. package/resources/fine-tuning/jobs/checkpoints.d.ts.map +1 -1
  137. package/resources/fine-tuning/jobs/checkpoints.js.map +1 -1
  138. package/resources/fine-tuning/jobs/checkpoints.mjs.map +1 -1
  139. package/resources/fine-tuning/jobs/jobs.d.ts +80 -146
  140. package/resources/fine-tuning/jobs/jobs.d.ts.map +1 -1
  141. package/resources/fine-tuning/jobs/jobs.js +48 -0
  142. package/resources/fine-tuning/jobs/jobs.js.map +1 -1
  143. package/resources/fine-tuning/jobs/jobs.mjs +48 -0
  144. package/resources/fine-tuning/jobs/jobs.mjs.map +1 -1
  145. package/resources/fine-tuning/methods.d.ts +120 -0
  146. package/resources/fine-tuning/methods.d.ts.map +1 -0
  147. package/resources/fine-tuning/methods.js +9 -0
  148. package/resources/fine-tuning/methods.js.map +1 -0
  149. package/resources/fine-tuning/methods.mjs +5 -0
  150. package/resources/fine-tuning/methods.mjs.map +1 -0
  151. package/resources/graders/grader-models.d.ts +234 -0
  152. package/resources/graders/grader-models.d.ts.map +1 -0
  153. package/resources/graders/grader-models.js +9 -0
  154. package/resources/graders/grader-models.js.map +1 -0
  155. package/resources/graders/grader-models.mjs +5 -0
  156. package/resources/graders/grader-models.mjs.map +1 -0
  157. package/resources/graders/graders.d.ts +10 -0
  158. package/resources/graders/graders.d.ts.map +1 -0
  159. package/resources/graders/graders.js +39 -0
  160. package/resources/graders/graders.js.map +1 -0
  161. package/resources/graders/graders.mjs +12 -0
  162. package/resources/graders/graders.mjs.map +1 -0
  163. package/resources/graders/index.d.ts +3 -0
  164. package/resources/graders/index.d.ts.map +1 -0
  165. package/resources/graders/index.js +9 -0
  166. package/resources/graders/index.js.map +1 -0
  167. package/resources/graders/index.mjs +4 -0
  168. package/resources/graders/index.mjs.map +1 -0
  169. package/resources/graders.d.ts +2 -0
  170. package/resources/graders.d.ts.map +1 -0
  171. package/resources/graders.js +19 -0
  172. package/resources/graders.js.map +1 -0
  173. package/resources/graders.mjs +3 -0
  174. package/resources/graders.mjs.map +1 -0
  175. package/resources/images.d.ts +40 -5
  176. package/resources/images.d.ts.map +1 -1
  177. package/resources/images.js +22 -0
  178. package/resources/images.js.map +1 -1
  179. package/resources/images.mjs +22 -0
  180. package/resources/images.mjs.map +1 -1
  181. package/resources/index.d.ts +2 -1
  182. package/resources/index.d.ts.map +1 -1
  183. package/resources/index.js +3 -1
  184. package/resources/index.js.map +1 -1
  185. package/resources/index.mjs +1 -0
  186. package/resources/index.mjs.map +1 -1
  187. package/resources/responses/input-items.d.ts +10 -0
  188. package/resources/responses/input-items.d.ts.map +1 -1
  189. package/resources/responses/input-items.js.map +1 -1
  190. package/resources/responses/input-items.mjs.map +1 -1
  191. package/resources/responses/responses.d.ts +70 -29
  192. package/resources/responses/responses.d.ts.map +1 -1
  193. package/resources/responses/responses.js +7 -0
  194. package/resources/responses/responses.js.map +1 -1
  195. package/resources/responses/responses.mjs +7 -0
  196. package/resources/responses/responses.mjs.map +1 -1
  197. package/src/index.ts +5 -6
  198. package/src/resources/audio/speech.ts +13 -1
  199. package/src/resources/audio/transcriptions.ts +9 -0
  200. package/src/resources/audio/translations.ts +8 -0
  201. package/src/resources/beta/assistants.ts +36 -0
  202. package/src/resources/beta/realtime/sessions.ts +6 -0
  203. package/src/resources/beta/realtime/transcription-sessions.ts +6 -0
  204. package/src/resources/beta/threads/messages.ts +43 -0
  205. package/src/resources/beta/threads/runs/runs.ts +52 -0
  206. package/src/resources/beta/threads/runs/steps.ts +21 -0
  207. package/src/resources/beta/threads/threads.ts +33 -0
  208. package/src/resources/chat/completions/completions.ts +42 -4
  209. package/src/resources/chat/completions/messages.ts +10 -0
  210. package/src/resources/completions.ts +8 -0
  211. package/src/resources/embeddings.ts +9 -0
  212. package/src/resources/evals/evals.ts +78 -654
  213. package/src/resources/evals/index.ts +0 -3
  214. package/src/resources/fine-tuning/alpha/alpha.ts +27 -0
  215. package/src/resources/fine-tuning/alpha/graders.ts +168 -0
  216. package/src/resources/fine-tuning/alpha/index.ts +10 -0
  217. package/src/resources/fine-tuning/alpha.ts +3 -0
  218. package/src/resources/fine-tuning/checkpoints/permissions.ts +28 -0
  219. package/src/resources/fine-tuning/fine-tuning.ts +28 -0
  220. package/src/resources/fine-tuning/index.ts +10 -0
  221. package/src/resources/fine-tuning/jobs/checkpoints.ts +10 -0
  222. package/src/resources/fine-tuning/jobs/jobs.ts +86 -162
  223. package/src/resources/fine-tuning/methods.ts +152 -0
  224. package/src/resources/graders/grader-models.ts +296 -0
  225. package/src/resources/graders/graders.ts +31 -0
  226. package/src/resources/graders/index.ts +12 -0
  227. package/src/resources/graders.ts +3 -0
  228. package/src/resources/images.ts +41 -5
  229. package/src/resources/index.ts +1 -3
  230. package/src/resources/responses/input-items.ts +10 -0
  231. package/src/resources/responses/responses.ts +72 -29
  232. package/src/version.ts +1 -1
  233. package/version.d.ts +1 -1
  234. package/version.js +1 -1
  235. package/version.mjs +1 -1
@@ -1,6 +1,7 @@
1
1
  import { APIResource } from "../../resource.js";
2
2
  import * as Core from "../../core.js";
3
3
  import * as Shared from "../shared.js";
4
+ import * as GraderModelsAPI from "../graders/grader-models.js";
4
5
  import * as ResponsesAPI from "../responses/responses.js";
5
6
  import * as RunsAPI from "./runs/runs.js";
6
7
  import { CreateEvalCompletionsRunDataSource, CreateEvalJSONLRunDataSource, EvalAPIError, RunCancelResponse, RunCreateParams, RunCreateResponse, RunDeleteResponse, RunListParams, RunListResponse, RunListResponsesPage, RunRetrieveResponse, Runs } from "./runs/runs.js";
@@ -54,72 +55,6 @@ export interface EvalCustomDataSourceConfig {
54
55
  */
55
56
  type: 'custom';
56
57
  }
57
- /**
58
- * A LabelModelGrader object which uses a model to assign labels to each item in
59
- * the evaluation.
60
- */
61
- export interface EvalLabelModelGrader {
62
- input: Array<EvalLabelModelGrader.Input>;
63
- /**
64
- * The labels to assign to each item in the evaluation.
65
- */
66
- labels: Array<string>;
67
- /**
68
- * The model to use for the evaluation. Must support structured outputs.
69
- */
70
- model: string;
71
- /**
72
- * The name of the grader.
73
- */
74
- name: string;
75
- /**
76
- * The labels that indicate a passing result. Must be a subset of labels.
77
- */
78
- passing_labels: Array<string>;
79
- /**
80
- * The object type, which is always `label_model`.
81
- */
82
- type: 'label_model';
83
- }
84
- export declare namespace EvalLabelModelGrader {
85
- /**
86
- * A message input to the model with a role indicating instruction following
87
- * hierarchy. Instructions given with the `developer` or `system` role take
88
- * precedence over instructions given with the `user` role. Messages with the
89
- * `assistant` role are presumed to have been generated by the model in previous
90
- * interactions.
91
- */
92
- interface Input {
93
- /**
94
- * Text inputs to the model - can contain template strings.
95
- */
96
- content: string | ResponsesAPI.ResponseInputText | Input.OutputText;
97
- /**
98
- * The role of the message input. One of `user`, `assistant`, `system`, or
99
- * `developer`.
100
- */
101
- role: 'user' | 'assistant' | 'system' | 'developer';
102
- /**
103
- * The type of the message input. Always `message`.
104
- */
105
- type?: 'message';
106
- }
107
- namespace Input {
108
- /**
109
- * A text output from the model.
110
- */
111
- interface OutputText {
112
- /**
113
- * The text output from the model.
114
- */
115
- text: string;
116
- /**
117
- * The type of the output text. Always `output_text`.
118
- */
119
- type: 'output_text';
120
- }
121
- }
122
- }
123
58
  /**
124
59
  * A StoredCompletionsDataSourceConfig which specifies the metadata property of
125
60
  * your stored completions query. This is usually metadata like `usecase=chatbot`
@@ -147,62 +82,6 @@ export interface EvalStoredCompletionsDataSourceConfig {
147
82
  */
148
83
  metadata?: Shared.Metadata | null;
149
84
  }
150
- /**
151
- * A StringCheckGrader object that performs a string comparison between input and
152
- * reference using a specified operation.
153
- */
154
- export interface EvalStringCheckGrader {
155
- /**
156
- * The input text. This may include template strings.
157
- */
158
- input: string;
159
- /**
160
- * The name of the grader.
161
- */
162
- name: string;
163
- /**
164
- * The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
165
- */
166
- operation: 'eq' | 'ne' | 'like' | 'ilike';
167
- /**
168
- * The reference text. This may include template strings.
169
- */
170
- reference: string;
171
- /**
172
- * The object type, which is always `string_check`.
173
- */
174
- type: 'string_check';
175
- }
176
- /**
177
- * A TextSimilarityGrader object which grades text based on similarity metrics.
178
- */
179
- export interface EvalTextSimilarityGrader {
180
- /**
181
- * The evaluation metric to use. One of `fuzzy_match`, `bleu`, `gleu`, `meteor`,
182
- * `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.
183
- */
184
- evaluation_metric: 'fuzzy_match' | 'bleu' | 'gleu' | 'meteor' | 'rouge_1' | 'rouge_2' | 'rouge_3' | 'rouge_4' | 'rouge_5' | 'rouge_l';
185
- /**
186
- * The text being graded.
187
- */
188
- input: string;
189
- /**
190
- * A float score where a value greater than or equal indicates a passing grade.
191
- */
192
- pass_threshold: number;
193
- /**
194
- * The text being graded against.
195
- */
196
- reference: string;
197
- /**
198
- * The type of grader.
199
- */
200
- type: 'text_similarity';
201
- /**
202
- * The name of the grader.
203
- */
204
- name?: string;
205
- }
206
85
  /**
207
86
  * An Eval object with a data source config and testing criteria. An Eval
208
87
  * represents a task to be done for your LLM integration. Like:
@@ -244,29 +123,22 @@ export interface EvalCreateResponse {
244
123
  /**
245
124
  * A list of testing criteria.
246
125
  */
247
- testing_criteria: Array<EvalLabelModelGrader | EvalStringCheckGrader | EvalTextSimilarityGrader | EvalCreateResponse.Python | EvalCreateResponse.ScoreModel>;
126
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalCreateResponse.EvalGraderTextSimilarity | EvalCreateResponse.EvalGraderPython | EvalCreateResponse.EvalGraderScoreModel>;
248
127
  }
249
128
  export declare namespace EvalCreateResponse {
250
129
  /**
251
- * A PythonGrader object that runs a python script on the input.
130
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
252
131
  */
253
- interface Python {
254
- /**
255
- * The name of the grader.
256
- */
257
- name: string;
258
- /**
259
- * The source code of the python script.
260
- */
261
- source: string;
132
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
262
133
  /**
263
- * The object type, which is always `python`.
264
- */
265
- type: 'python';
266
- /**
267
- * The image tag to use for the python script.
134
+ * The threshold for the score.
268
135
  */
269
- image_tag?: string;
136
+ pass_threshold: number;
137
+ }
138
+ /**
139
+ * A PythonGrader object that runs a python script on the input.
140
+ */
141
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
270
142
  /**
271
143
  * The threshold for the score.
272
144
  */
@@ -275,74 +147,11 @@ export declare namespace EvalCreateResponse {
275
147
  /**
276
148
  * A ScoreModelGrader object that uses a model to assign a score to the input.
277
149
  */
278
- interface ScoreModel {
279
- /**
280
- * The input text. This may include template strings.
281
- */
282
- input: Array<ScoreModel.Input>;
283
- /**
284
- * The model to use for the evaluation.
285
- */
286
- model: string;
287
- /**
288
- * The name of the grader.
289
- */
290
- name: string;
291
- /**
292
- * The object type, which is always `score_model`.
293
- */
294
- type: 'score_model';
150
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
295
151
  /**
296
152
  * The threshold for the score.
297
153
  */
298
154
  pass_threshold?: number;
299
- /**
300
- * The range of the score. Defaults to `[0, 1]`.
301
- */
302
- range?: Array<number>;
303
- /**
304
- * The sampling parameters for the model.
305
- */
306
- sampling_params?: unknown;
307
- }
308
- namespace ScoreModel {
309
- /**
310
- * A message input to the model with a role indicating instruction following
311
- * hierarchy. Instructions given with the `developer` or `system` role take
312
- * precedence over instructions given with the `user` role. Messages with the
313
- * `assistant` role are presumed to have been generated by the model in previous
314
- * interactions.
315
- */
316
- interface Input {
317
- /**
318
- * Text inputs to the model - can contain template strings.
319
- */
320
- content: string | ResponsesAPI.ResponseInputText | Input.OutputText;
321
- /**
322
- * The role of the message input. One of `user`, `assistant`, `system`, or
323
- * `developer`.
324
- */
325
- role: 'user' | 'assistant' | 'system' | 'developer';
326
- /**
327
- * The type of the message input. Always `message`.
328
- */
329
- type?: 'message';
330
- }
331
- namespace Input {
332
- /**
333
- * A text output from the model.
334
- */
335
- interface OutputText {
336
- /**
337
- * The text output from the model.
338
- */
339
- text: string;
340
- /**
341
- * The type of the output text. Always `output_text`.
342
- */
343
- type: 'output_text';
344
- }
345
- }
346
155
  }
347
156
  }
348
157
  /**
@@ -386,29 +195,22 @@ export interface EvalRetrieveResponse {
386
195
  /**
387
196
  * A list of testing criteria.
388
197
  */
389
- testing_criteria: Array<EvalLabelModelGrader | EvalStringCheckGrader | EvalTextSimilarityGrader | EvalRetrieveResponse.Python | EvalRetrieveResponse.ScoreModel>;
198
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalRetrieveResponse.EvalGraderTextSimilarity | EvalRetrieveResponse.EvalGraderPython | EvalRetrieveResponse.EvalGraderScoreModel>;
390
199
  }
391
200
  export declare namespace EvalRetrieveResponse {
392
201
  /**
393
- * A PythonGrader object that runs a python script on the input.
202
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
394
203
  */
395
- interface Python {
396
- /**
397
- * The name of the grader.
398
- */
399
- name: string;
400
- /**
401
- * The source code of the python script.
402
- */
403
- source: string;
404
- /**
405
- * The object type, which is always `python`.
406
- */
407
- type: 'python';
204
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
408
205
  /**
409
- * The image tag to use for the python script.
206
+ * The threshold for the score.
410
207
  */
411
- image_tag?: string;
208
+ pass_threshold: number;
209
+ }
210
+ /**
211
+ * A PythonGrader object that runs a python script on the input.
212
+ */
213
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
412
214
  /**
413
215
  * The threshold for the score.
414
216
  */
@@ -417,74 +219,11 @@ export declare namespace EvalRetrieveResponse {
417
219
  /**
418
220
  * A ScoreModelGrader object that uses a model to assign a score to the input.
419
221
  */
420
- interface ScoreModel {
421
- /**
422
- * The input text. This may include template strings.
423
- */
424
- input: Array<ScoreModel.Input>;
425
- /**
426
- * The model to use for the evaluation.
427
- */
428
- model: string;
429
- /**
430
- * The name of the grader.
431
- */
432
- name: string;
433
- /**
434
- * The object type, which is always `score_model`.
435
- */
436
- type: 'score_model';
222
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
437
223
  /**
438
224
  * The threshold for the score.
439
225
  */
440
226
  pass_threshold?: number;
441
- /**
442
- * The range of the score. Defaults to `[0, 1]`.
443
- */
444
- range?: Array<number>;
445
- /**
446
- * The sampling parameters for the model.
447
- */
448
- sampling_params?: unknown;
449
- }
450
- namespace ScoreModel {
451
- /**
452
- * A message input to the model with a role indicating instruction following
453
- * hierarchy. Instructions given with the `developer` or `system` role take
454
- * precedence over instructions given with the `user` role. Messages with the
455
- * `assistant` role are presumed to have been generated by the model in previous
456
- * interactions.
457
- */
458
- interface Input {
459
- /**
460
- * Text inputs to the model - can contain template strings.
461
- */
462
- content: string | ResponsesAPI.ResponseInputText | Input.OutputText;
463
- /**
464
- * The role of the message input. One of `user`, `assistant`, `system`, or
465
- * `developer`.
466
- */
467
- role: 'user' | 'assistant' | 'system' | 'developer';
468
- /**
469
- * The type of the message input. Always `message`.
470
- */
471
- type?: 'message';
472
- }
473
- namespace Input {
474
- /**
475
- * A text output from the model.
476
- */
477
- interface OutputText {
478
- /**
479
- * The text output from the model.
480
- */
481
- text: string;
482
- /**
483
- * The type of the output text. Always `output_text`.
484
- */
485
- type: 'output_text';
486
- }
487
- }
488
227
  }
489
228
  }
490
229
  /**
@@ -528,29 +267,22 @@ export interface EvalUpdateResponse {
528
267
  /**
529
268
  * A list of testing criteria.
530
269
  */
531
- testing_criteria: Array<EvalLabelModelGrader | EvalStringCheckGrader | EvalTextSimilarityGrader | EvalUpdateResponse.Python | EvalUpdateResponse.ScoreModel>;
270
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalUpdateResponse.EvalGraderTextSimilarity | EvalUpdateResponse.EvalGraderPython | EvalUpdateResponse.EvalGraderScoreModel>;
532
271
  }
533
272
  export declare namespace EvalUpdateResponse {
534
273
  /**
535
- * A PythonGrader object that runs a python script on the input.
274
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
536
275
  */
537
- interface Python {
276
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
538
277
  /**
539
- * The name of the grader.
540
- */
541
- name: string;
542
- /**
543
- * The source code of the python script.
544
- */
545
- source: string;
546
- /**
547
- * The object type, which is always `python`.
548
- */
549
- type: 'python';
550
- /**
551
- * The image tag to use for the python script.
278
+ * The threshold for the score.
552
279
  */
553
- image_tag?: string;
280
+ pass_threshold: number;
281
+ }
282
+ /**
283
+ * A PythonGrader object that runs a python script on the input.
284
+ */
285
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
554
286
  /**
555
287
  * The threshold for the score.
556
288
  */
@@ -559,74 +291,11 @@ export declare namespace EvalUpdateResponse {
559
291
  /**
560
292
  * A ScoreModelGrader object that uses a model to assign a score to the input.
561
293
  */
562
- interface ScoreModel {
563
- /**
564
- * The input text. This may include template strings.
565
- */
566
- input: Array<ScoreModel.Input>;
567
- /**
568
- * The model to use for the evaluation.
569
- */
570
- model: string;
571
- /**
572
- * The name of the grader.
573
- */
574
- name: string;
575
- /**
576
- * The object type, which is always `score_model`.
577
- */
578
- type: 'score_model';
294
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
579
295
  /**
580
296
  * The threshold for the score.
581
297
  */
582
298
  pass_threshold?: number;
583
- /**
584
- * The range of the score. Defaults to `[0, 1]`.
585
- */
586
- range?: Array<number>;
587
- /**
588
- * The sampling parameters for the model.
589
- */
590
- sampling_params?: unknown;
591
- }
592
- namespace ScoreModel {
593
- /**
594
- * A message input to the model with a role indicating instruction following
595
- * hierarchy. Instructions given with the `developer` or `system` role take
596
- * precedence over instructions given with the `user` role. Messages with the
597
- * `assistant` role are presumed to have been generated by the model in previous
598
- * interactions.
599
- */
600
- interface Input {
601
- /**
602
- * Text inputs to the model - can contain template strings.
603
- */
604
- content: string | ResponsesAPI.ResponseInputText | Input.OutputText;
605
- /**
606
- * The role of the message input. One of `user`, `assistant`, `system`, or
607
- * `developer`.
608
- */
609
- role: 'user' | 'assistant' | 'system' | 'developer';
610
- /**
611
- * The type of the message input. Always `message`.
612
- */
613
- type?: 'message';
614
- }
615
- namespace Input {
616
- /**
617
- * A text output from the model.
618
- */
619
- interface OutputText {
620
- /**
621
- * The text output from the model.
622
- */
623
- text: string;
624
- /**
625
- * The type of the output text. Always `output_text`.
626
- */
627
- type: 'output_text';
628
- }
629
- }
630
299
  }
631
300
  }
632
301
  /**
@@ -670,29 +339,22 @@ export interface EvalListResponse {
670
339
  /**
671
340
  * A list of testing criteria.
672
341
  */
673
- testing_criteria: Array<EvalLabelModelGrader | EvalStringCheckGrader | EvalTextSimilarityGrader | EvalListResponse.Python | EvalListResponse.ScoreModel>;
342
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalListResponse.EvalGraderTextSimilarity | EvalListResponse.EvalGraderPython | EvalListResponse.EvalGraderScoreModel>;
674
343
  }
675
344
  export declare namespace EvalListResponse {
676
345
  /**
677
- * A PythonGrader object that runs a python script on the input.
346
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
678
347
  */
679
- interface Python {
680
- /**
681
- * The name of the grader.
682
- */
683
- name: string;
684
- /**
685
- * The source code of the python script.
686
- */
687
- source: string;
688
- /**
689
- * The object type, which is always `python`.
690
- */
691
- type: 'python';
348
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
692
349
  /**
693
- * The image tag to use for the python script.
350
+ * The threshold for the score.
694
351
  */
695
- image_tag?: string;
352
+ pass_threshold: number;
353
+ }
354
+ /**
355
+ * A PythonGrader object that runs a python script on the input.
356
+ */
357
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
696
358
  /**
697
359
  * The threshold for the score.
698
360
  */
@@ -701,74 +363,11 @@ export declare namespace EvalListResponse {
701
363
  /**
702
364
  * A ScoreModelGrader object that uses a model to assign a score to the input.
703
365
  */
704
- interface ScoreModel {
705
- /**
706
- * The input text. This may include template strings.
707
- */
708
- input: Array<ScoreModel.Input>;
709
- /**
710
- * The model to use for the evaluation.
711
- */
712
- model: string;
713
- /**
714
- * The name of the grader.
715
- */
716
- name: string;
717
- /**
718
- * The object type, which is always `score_model`.
719
- */
720
- type: 'score_model';
366
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
721
367
  /**
722
368
  * The threshold for the score.
723
369
  */
724
370
  pass_threshold?: number;
725
- /**
726
- * The range of the score. Defaults to `[0, 1]`.
727
- */
728
- range?: Array<number>;
729
- /**
730
- * The sampling parameters for the model.
731
- */
732
- sampling_params?: unknown;
733
- }
734
- namespace ScoreModel {
735
- /**
736
- * A message input to the model with a role indicating instruction following
737
- * hierarchy. Instructions given with the `developer` or `system` role take
738
- * precedence over instructions given with the `user` role. Messages with the
739
- * `assistant` role are presumed to have been generated by the model in previous
740
- * interactions.
741
- */
742
- interface Input {
743
- /**
744
- * Text inputs to the model - can contain template strings.
745
- */
746
- content: string | ResponsesAPI.ResponseInputText | Input.OutputText;
747
- /**
748
- * The role of the message input. One of `user`, `assistant`, `system`, or
749
- * `developer`.
750
- */
751
- role: 'user' | 'assistant' | 'system' | 'developer';
752
- /**
753
- * The type of the message input. Always `message`.
754
- */
755
- type?: 'message';
756
- }
757
- namespace Input {
758
- /**
759
- * A text output from the model.
760
- */
761
- interface OutputText {
762
- /**
763
- * The text output from the model.
764
- */
765
- text: string;
766
- /**
767
- * The type of the output text. Always `output_text`.
768
- */
769
- type: 'output_text';
770
- }
771
- }
772
371
  }
773
372
  }
774
373
  export interface EvalDeleteResponse {
@@ -780,11 +379,11 @@ export interface EvalCreateParams {
780
379
  /**
781
380
  * The configuration for the data source used for the evaluation runs.
782
381
  */
783
- data_source_config: EvalCreateParams.Custom | EvalCreateParams.Logs;
382
+ data_source_config: EvalCreateParams.Custom | EvalCreateParams.StoredCompletions;
784
383
  /**
785
384
  * A list of graders for all eval runs in this group.
786
385
  */
787
- testing_criteria: Array<EvalCreateParams.LabelModel | EvalStringCheckGrader | EvalTextSimilarityGrader | EvalCreateParams.Python | EvalCreateParams.ScoreModel>;
386
+ testing_criteria: Array<EvalCreateParams.LabelModel | GraderModelsAPI.StringCheckGrader | EvalCreateParams.TextSimilarity | EvalCreateParams.Python | EvalCreateParams.ScoreModel>;
788
387
  /**
789
388
  * Set of 16 key-value pairs that can be attached to an object. This can be useful
790
389
  * for storing additional information about the object in a structured format, and
@@ -828,13 +427,13 @@ export declare namespace EvalCreateParams {
828
427
  * completions query. This is usually metadata like `usecase=chatbot` or
829
428
  * `prompt-version=v2`, etc.
830
429
  */
831
- interface Logs {
430
+ interface StoredCompletions {
832
431
  /**
833
- * The type of data source. Always `logs`.
432
+ * The type of data source. Always `stored_completions`.
834
433
  */
835
- type: 'logs';
434
+ type: 'stored_completions';
836
435
  /**
837
- * Metadata filters for the logs data source.
436
+ * Metadata filters for the stored completions data source.
838
437
  */
839
438
  metadata?: Record<string, unknown>;
840
439
  }
@@ -919,25 +518,18 @@ export declare namespace EvalCreateParams {
919
518
  }
920
519
  }
921
520
  /**
922
- * A PythonGrader object that runs a python script on the input.
521
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
923
522
  */
924
- interface Python {
925
- /**
926
- * The name of the grader.
927
- */
928
- name: string;
523
+ interface TextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
929
524
  /**
930
- * The source code of the python script.
931
- */
932
- source: string;
933
- /**
934
- * The object type, which is always `python`.
935
- */
936
- type: 'python';
937
- /**
938
- * The image tag to use for the python script.
525
+ * The threshold for the score.
939
526
  */
940
- image_tag?: string;
527
+ pass_threshold: number;
528
+ }
529
+ /**
530
+ * A PythonGrader object that runs a python script on the input.
531
+ */
532
+ interface Python extends GraderModelsAPI.PythonGrader {
941
533
  /**
942
534
  * The threshold for the score.
943
535
  */
@@ -946,74 +538,11 @@ export declare namespace EvalCreateParams {
946
538
  /**
947
539
  * A ScoreModelGrader object that uses a model to assign a score to the input.
948
540
  */
949
- interface ScoreModel {
950
- /**
951
- * The input text. This may include template strings.
952
- */
953
- input: Array<ScoreModel.Input>;
954
- /**
955
- * The model to use for the evaluation.
956
- */
957
- model: string;
958
- /**
959
- * The name of the grader.
960
- */
961
- name: string;
962
- /**
963
- * The object type, which is always `score_model`.
964
- */
965
- type: 'score_model';
541
+ interface ScoreModel extends GraderModelsAPI.ScoreModelGrader {
966
542
  /**
967
543
  * The threshold for the score.
968
544
  */
969
545
  pass_threshold?: number;
970
- /**
971
- * The range of the score. Defaults to `[0, 1]`.
972
- */
973
- range?: Array<number>;
974
- /**
975
- * The sampling parameters for the model.
976
- */
977
- sampling_params?: unknown;
978
- }
979
- namespace ScoreModel {
980
- /**
981
- * A message input to the model with a role indicating instruction following
982
- * hierarchy. Instructions given with the `developer` or `system` role take
983
- * precedence over instructions given with the `user` role. Messages with the
984
- * `assistant` role are presumed to have been generated by the model in previous
985
- * interactions.
986
- */
987
- interface Input {
988
- /**
989
- * Text inputs to the model - can contain template strings.
990
- */
991
- content: string | ResponsesAPI.ResponseInputText | Input.OutputText;
992
- /**
993
- * The role of the message input. One of `user`, `assistant`, `system`, or
994
- * `developer`.
995
- */
996
- role: 'user' | 'assistant' | 'system' | 'developer';
997
- /**
998
- * The type of the message input. Always `message`.
999
- */
1000
- type?: 'message';
1001
- }
1002
- namespace Input {
1003
- /**
1004
- * A text output from the model.
1005
- */
1006
- interface OutputText {
1007
- /**
1008
- * The text output from the model.
1009
- */
1010
- text: string;
1011
- /**
1012
- * The type of the output text. Always `output_text`.
1013
- */
1014
- type: 'output_text';
1015
- }
1016
- }
1017
546
  }
1018
547
  }
1019
548
  export interface EvalUpdateParams {
@@ -1044,7 +573,7 @@ export interface EvalListParams extends CursorPageParams {
1044
573
  order_by?: 'created_at' | 'updated_at';
1045
574
  }
1046
575
  export declare namespace Evals {
1047
- export { type EvalCustomDataSourceConfig as EvalCustomDataSourceConfig, type EvalLabelModelGrader as EvalLabelModelGrader, type EvalStoredCompletionsDataSourceConfig as EvalStoredCompletionsDataSourceConfig, type EvalStringCheckGrader as EvalStringCheckGrader, type EvalTextSimilarityGrader as EvalTextSimilarityGrader, type EvalCreateResponse as EvalCreateResponse, type EvalRetrieveResponse as EvalRetrieveResponse, type EvalUpdateResponse as EvalUpdateResponse, type EvalListResponse as EvalListResponse, type EvalDeleteResponse as EvalDeleteResponse, EvalListResponsesPage as EvalListResponsesPage, type EvalCreateParams as EvalCreateParams, type EvalUpdateParams as EvalUpdateParams, type EvalListParams as EvalListParams, };
576
+ export { type EvalCustomDataSourceConfig as EvalCustomDataSourceConfig, type EvalStoredCompletionsDataSourceConfig as EvalStoredCompletionsDataSourceConfig, type EvalCreateResponse as EvalCreateResponse, type EvalRetrieveResponse as EvalRetrieveResponse, type EvalUpdateResponse as EvalUpdateResponse, type EvalListResponse as EvalListResponse, type EvalDeleteResponse as EvalDeleteResponse, EvalListResponsesPage as EvalListResponsesPage, type EvalCreateParams as EvalCreateParams, type EvalUpdateParams as EvalUpdateParams, type EvalListParams as EvalListParams, };
1048
577
  export { Runs as Runs, type CreateEvalCompletionsRunDataSource as CreateEvalCompletionsRunDataSource, type CreateEvalJSONLRunDataSource as CreateEvalJSONLRunDataSource, type EvalAPIError as EvalAPIError, type RunCreateResponse as RunCreateResponse, type RunRetrieveResponse as RunRetrieveResponse, type RunListResponse as RunListResponse, type RunDeleteResponse as RunDeleteResponse, type RunCancelResponse as RunCancelResponse, RunListResponsesPage as RunListResponsesPage, type RunCreateParams as RunCreateParams, type RunListParams as RunListParams, };
1049
578
  }
1050
579
  //# sourceMappingURL=evals.d.ts.map