@superinterface/react 5.1.3 → 5.2.0-beta.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 (413) hide show
  1. package/dist/index.d.cts +5 -5
  2. package/dist/index.d.ts +5 -5
  3. package/dist/server.d.cts +1 -1
  4. package/dist/server.d.ts +1 -1
  5. package/package.json +8 -6
  6. package/types/index.d.ts +4 -0
  7. package/types/node_modules/openai/LICENSE +201 -0
  8. package/types/node_modules/openai/_vendor/partial-json-parser/parser.d.mts +7 -0
  9. package/types/node_modules/openai/_vendor/partial-json-parser/parser.d.ts +7 -0
  10. package/types/node_modules/openai/_vendor/zod-to-json-schema/Options.d.mts +32 -0
  11. package/types/node_modules/openai/_vendor/zod-to-json-schema/Options.d.ts +32 -0
  12. package/types/node_modules/openai/_vendor/zod-to-json-schema/Refs.d.mts +21 -0
  13. package/types/node_modules/openai/_vendor/zod-to-json-schema/Refs.d.ts +21 -0
  14. package/types/node_modules/openai/_vendor/zod-to-json-schema/errorMessages.d.mts +12 -0
  15. package/types/node_modules/openai/_vendor/zod-to-json-schema/errorMessages.d.ts +12 -0
  16. package/types/node_modules/openai/_vendor/zod-to-json-schema/index.d.mts +38 -0
  17. package/types/node_modules/openai/_vendor/zod-to-json-schema/index.d.ts +38 -0
  18. package/types/node_modules/openai/_vendor/zod-to-json-schema/parseDef.d.mts +38 -0
  19. package/types/node_modules/openai/_vendor/zod-to-json-schema/parseDef.d.ts +38 -0
  20. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/any.d.mts +3 -0
  21. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/any.d.ts +3 -0
  22. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/array.d.mts +13 -0
  23. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/array.d.ts +13 -0
  24. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/bigint.d.mts +15 -0
  25. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/bigint.d.ts +15 -0
  26. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/boolean.d.mts +5 -0
  27. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/boolean.d.ts +5 -0
  28. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/branded.d.mts +4 -0
  29. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/branded.d.ts +4 -0
  30. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/catch.d.mts +4 -0
  31. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/catch.d.ts +4 -0
  32. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/date.d.mts +16 -0
  33. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/date.d.ts +16 -0
  34. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/default.d.mts +7 -0
  35. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/default.d.ts +7 -0
  36. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/effects.d.mts +5 -0
  37. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/effects.d.ts +5 -0
  38. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/enum.d.mts +7 -0
  39. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/enum.d.ts +7 -0
  40. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/intersection.d.mts +9 -0
  41. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/intersection.d.ts +9 -0
  42. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/literal.d.mts +10 -0
  43. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/literal.d.ts +10 -0
  44. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/map.d.mts +16 -0
  45. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/map.d.ts +16 -0
  46. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/nativeEnum.d.mts +7 -0
  47. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/nativeEnum.d.ts +7 -0
  48. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/never.d.mts +5 -0
  49. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/never.d.ts +5 -0
  50. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/null.d.mts +6 -0
  51. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/null.d.ts +6 -0
  52. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/nullable.d.mts +11 -0
  53. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/nullable.d.ts +11 -0
  54. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/number.d.mts +14 -0
  55. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/number.d.ts +14 -0
  56. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/object.d.mts +11 -0
  57. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/object.d.ts +11 -0
  58. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/optional.d.mts +5 -0
  59. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/optional.d.ts +5 -0
  60. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/pipeline.d.mts +6 -0
  61. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/pipeline.d.ts +6 -0
  62. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/promise.d.mts +5 -0
  63. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/promise.d.ts +5 -0
  64. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/readonly.d.mts +4 -0
  65. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/readonly.d.ts +4 -0
  66. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/record.d.mts +14 -0
  67. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/record.d.ts +14 -0
  68. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/set.d.mts +14 -0
  69. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/set.d.ts +14 -0
  70. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/string.d.mts +70 -0
  71. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/string.d.ts +70 -0
  72. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/tuple.d.mts +14 -0
  73. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/tuple.d.ts +14 -0
  74. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/undefined.d.mts +5 -0
  75. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/undefined.d.ts +5 -0
  76. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/union.d.mts +24 -0
  77. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/union.d.ts +24 -0
  78. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/unknown.d.mts +3 -0
  79. package/types/node_modules/openai/_vendor/zod-to-json-schema/parsers/unknown.d.ts +3 -0
  80. package/types/node_modules/openai/_vendor/zod-to-json-schema/util.d.mts +4 -0
  81. package/types/node_modules/openai/_vendor/zod-to-json-schema/util.d.ts +4 -0
  82. package/types/node_modules/openai/_vendor/zod-to-json-schema/zodToJsonSchema.d.mts +11 -0
  83. package/types/node_modules/openai/_vendor/zod-to-json-schema/zodToJsonSchema.d.ts +11 -0
  84. package/types/node_modules/openai/api-promise.d.mts +2 -0
  85. package/types/node_modules/openai/api-promise.d.ts +2 -0
  86. package/types/node_modules/openai/azure.d.mts +63 -0
  87. package/types/node_modules/openai/azure.d.ts +63 -0
  88. package/types/node_modules/openai/beta/realtime/index.d.mts +2 -0
  89. package/types/node_modules/openai/beta/realtime/index.d.ts +2 -0
  90. package/types/node_modules/openai/beta/realtime/internal-base.d.mts +45 -0
  91. package/types/node_modules/openai/beta/realtime/internal-base.d.ts +45 -0
  92. package/types/node_modules/openai/beta/realtime/websocket.d.mts +36 -0
  93. package/types/node_modules/openai/beta/realtime/websocket.d.ts +36 -0
  94. package/types/node_modules/openai/beta/realtime/ws.d.mts +27 -0
  95. package/types/node_modules/openai/beta/realtime/ws.d.ts +27 -0
  96. package/types/node_modules/openai/client.d.mts +297 -0
  97. package/types/node_modules/openai/client.d.ts +297 -0
  98. package/types/node_modules/openai/core/api-promise.d.mts +49 -0
  99. package/types/node_modules/openai/core/api-promise.d.ts +49 -0
  100. package/types/node_modules/openai/core/error.d.mts +59 -0
  101. package/types/node_modules/openai/core/error.d.ts +59 -0
  102. package/types/node_modules/openai/core/pagination.d.mts +89 -0
  103. package/types/node_modules/openai/core/pagination.d.ts +89 -0
  104. package/types/node_modules/openai/core/resource.d.mts +6 -0
  105. package/types/node_modules/openai/core/resource.d.ts +6 -0
  106. package/types/node_modules/openai/core/streaming.d.mts +33 -0
  107. package/types/node_modules/openai/core/streaming.d.ts +33 -0
  108. package/types/node_modules/openai/core/uploads.d.mts +3 -0
  109. package/types/node_modules/openai/core/uploads.d.ts +3 -0
  110. package/types/node_modules/openai/error.d.mts +2 -0
  111. package/types/node_modules/openai/error.d.ts +2 -0
  112. package/types/node_modules/openai/helpers/audio.d.mts +9 -0
  113. package/types/node_modules/openai/helpers/audio.d.ts +9 -0
  114. package/types/node_modules/openai/helpers/zod.d.mts +70 -0
  115. package/types/node_modules/openai/helpers/zod.d.ts +70 -0
  116. package/types/node_modules/openai/index.d.mts +8 -0
  117. package/types/node_modules/openai/index.d.ts +8 -0
  118. package/types/node_modules/openai/internal/builtin-types.d.mts +73 -0
  119. package/types/node_modules/openai/internal/builtin-types.d.ts +73 -0
  120. package/types/node_modules/openai/internal/decoders/line.d.mts +17 -0
  121. package/types/node_modules/openai/internal/decoders/line.d.ts +17 -0
  122. package/types/node_modules/openai/internal/detect-platform.d.mts +15 -0
  123. package/types/node_modules/openai/internal/detect-platform.d.ts +15 -0
  124. package/types/node_modules/openai/internal/errors.d.mts +3 -0
  125. package/types/node_modules/openai/internal/errors.d.ts +3 -0
  126. package/types/node_modules/openai/internal/headers.d.mts +20 -0
  127. package/types/node_modules/openai/internal/headers.d.ts +20 -0
  128. package/types/node_modules/openai/internal/parse.d.mts +17 -0
  129. package/types/node_modules/openai/internal/parse.d.ts +17 -0
  130. package/types/node_modules/openai/internal/qs/formats.d.mts +7 -0
  131. package/types/node_modules/openai/internal/qs/formats.d.ts +7 -0
  132. package/types/node_modules/openai/internal/qs/index.d.mts +10 -0
  133. package/types/node_modules/openai/internal/qs/index.d.ts +10 -0
  134. package/types/node_modules/openai/internal/qs/stringify.d.mts +3 -0
  135. package/types/node_modules/openai/internal/qs/stringify.d.ts +3 -0
  136. package/types/node_modules/openai/internal/qs/types.d.mts +57 -0
  137. package/types/node_modules/openai/internal/qs/types.d.ts +57 -0
  138. package/types/node_modules/openai/internal/qs/utils.d.mts +15 -0
  139. package/types/node_modules/openai/internal/qs/utils.d.ts +15 -0
  140. package/types/node_modules/openai/internal/request-options.d.mts +78 -0
  141. package/types/node_modules/openai/internal/request-options.d.ts +78 -0
  142. package/types/node_modules/openai/internal/shim-types.d.mts +17 -0
  143. package/types/node_modules/openai/internal/shim-types.d.ts +17 -0
  144. package/types/node_modules/openai/internal/shims.d.mts +20 -0
  145. package/types/node_modules/openai/internal/shims.d.ts +20 -0
  146. package/types/node_modules/openai/internal/stream-utils.d.mts +8 -0
  147. package/types/node_modules/openai/internal/stream-utils.d.ts +8 -0
  148. package/types/node_modules/openai/internal/to-file.d.mts +45 -0
  149. package/types/node_modules/openai/internal/to-file.d.ts +45 -0
  150. package/types/node_modules/openai/internal/types.d.mts +69 -0
  151. package/types/node_modules/openai/internal/types.d.ts +69 -0
  152. package/types/node_modules/openai/internal/uploads.d.mts +42 -0
  153. package/types/node_modules/openai/internal/uploads.d.ts +42 -0
  154. package/types/node_modules/openai/internal/utils/base64.d.mts +9 -0
  155. package/types/node_modules/openai/internal/utils/base64.d.ts +9 -0
  156. package/types/node_modules/openai/internal/utils/bytes.d.mts +4 -0
  157. package/types/node_modules/openai/internal/utils/bytes.d.ts +4 -0
  158. package/types/node_modules/openai/internal/utils/env.d.mts +9 -0
  159. package/types/node_modules/openai/internal/utils/env.d.ts +9 -0
  160. package/types/node_modules/openai/internal/utils/log.d.mts +37 -0
  161. package/types/node_modules/openai/internal/utils/log.d.ts +37 -0
  162. package/types/node_modules/openai/internal/utils/path.d.mts +15 -0
  163. package/types/node_modules/openai/internal/utils/path.d.ts +15 -0
  164. package/types/node_modules/openai/internal/utils/sleep.d.mts +2 -0
  165. package/types/node_modules/openai/internal/utils/sleep.d.ts +2 -0
  166. package/types/node_modules/openai/internal/utils/uuid.d.mts +5 -0
  167. package/types/node_modules/openai/internal/utils/uuid.d.ts +5 -0
  168. package/types/node_modules/openai/internal/utils/values.d.mts +18 -0
  169. package/types/node_modules/openai/internal/utils/values.d.ts +18 -0
  170. package/types/node_modules/openai/internal/utils.d.mts +7 -0
  171. package/types/node_modules/openai/internal/utils.d.ts +7 -0
  172. package/types/node_modules/openai/lib/AbstractChatCompletionRunner.d.mts +59 -0
  173. package/types/node_modules/openai/lib/AbstractChatCompletionRunner.d.ts +59 -0
  174. package/types/node_modules/openai/lib/AssistantStream.d.mts +60 -0
  175. package/types/node_modules/openai/lib/AssistantStream.d.ts +60 -0
  176. package/types/node_modules/openai/lib/ChatCompletionRunner.d.mts +16 -0
  177. package/types/node_modules/openai/lib/ChatCompletionRunner.d.ts +16 -0
  178. package/types/node_modules/openai/lib/ChatCompletionStream.d.mts +208 -0
  179. package/types/node_modules/openai/lib/ChatCompletionStream.d.ts +208 -0
  180. package/types/node_modules/openai/lib/ChatCompletionStreamingRunner.d.mts +19 -0
  181. package/types/node_modules/openai/lib/ChatCompletionStreamingRunner.d.ts +19 -0
  182. package/types/node_modules/openai/lib/EventEmitter.d.mts +45 -0
  183. package/types/node_modules/openai/lib/EventEmitter.d.ts +45 -0
  184. package/types/node_modules/openai/lib/EventStream.d.mts +62 -0
  185. package/types/node_modules/openai/lib/EventStream.d.ts +62 -0
  186. package/types/node_modules/openai/lib/ResponsesParser.d.mts +36 -0
  187. package/types/node_modules/openai/lib/ResponsesParser.d.ts +36 -0
  188. package/types/node_modules/openai/lib/RunnableFunction.d.mts +83 -0
  189. package/types/node_modules/openai/lib/RunnableFunction.d.ts +83 -0
  190. package/types/node_modules/openai/lib/Util.d.mts +5 -0
  191. package/types/node_modules/openai/lib/Util.d.ts +5 -0
  192. package/types/node_modules/openai/lib/chatCompletionUtils.d.mts +5 -0
  193. package/types/node_modules/openai/lib/chatCompletionUtils.d.ts +5 -0
  194. package/types/node_modules/openai/lib/jsonschema.d.mts +106 -0
  195. package/types/node_modules/openai/lib/jsonschema.d.ts +106 -0
  196. package/types/node_modules/openai/lib/parser.d.mts +47 -0
  197. package/types/node_modules/openai/lib/parser.d.ts +47 -0
  198. package/types/node_modules/openai/lib/responses/EventTypes.d.mts +9 -0
  199. package/types/node_modules/openai/lib/responses/EventTypes.d.ts +9 -0
  200. package/types/node_modules/openai/lib/responses/ResponseStream.d.mts +59 -0
  201. package/types/node_modules/openai/lib/responses/ResponseStream.d.ts +59 -0
  202. package/types/node_modules/openai/package.json +233 -0
  203. package/types/node_modules/openai/pagination.d.mts +2 -0
  204. package/types/node_modules/openai/pagination.d.ts +2 -0
  205. package/types/node_modules/openai/realtime/index.d.mts +2 -0
  206. package/types/node_modules/openai/realtime/index.d.ts +2 -0
  207. package/types/node_modules/openai/realtime/internal-base.d.mts +45 -0
  208. package/types/node_modules/openai/realtime/internal-base.d.ts +45 -0
  209. package/types/node_modules/openai/realtime/websocket.d.mts +36 -0
  210. package/types/node_modules/openai/realtime/websocket.d.ts +36 -0
  211. package/types/node_modules/openai/realtime/ws.d.mts +27 -0
  212. package/types/node_modules/openai/realtime/ws.d.ts +27 -0
  213. package/types/node_modules/openai/resource.d.mts +2 -0
  214. package/types/node_modules/openai/resource.d.ts +2 -0
  215. package/types/node_modules/openai/resources/audio/audio.d.mts +26 -0
  216. package/types/node_modules/openai/resources/audio/audio.d.ts +26 -0
  217. package/types/node_modules/openai/resources/audio/index.d.mts +5 -0
  218. package/types/node_modules/openai/resources/audio/index.d.ts +5 -0
  219. package/types/node_modules/openai/resources/audio/speech.d.mts +64 -0
  220. package/types/node_modules/openai/resources/audio/speech.d.ts +64 -0
  221. package/types/node_modules/openai/resources/audio/transcriptions.d.mts +485 -0
  222. package/types/node_modules/openai/resources/audio/transcriptions.d.ts +485 -0
  223. package/types/node_modules/openai/resources/audio/translations.d.mts +81 -0
  224. package/types/node_modules/openai/resources/audio/translations.d.ts +81 -0
  225. package/types/node_modules/openai/resources/audio.d.mts +2 -0
  226. package/types/node_modules/openai/resources/audio.d.ts +2 -0
  227. package/types/node_modules/openai/resources/batches.d.mts +279 -0
  228. package/types/node_modules/openai/resources/batches.d.ts +279 -0
  229. package/types/node_modules/openai/resources/beta/assistants.d.mts +1232 -0
  230. package/types/node_modules/openai/resources/beta/assistants.d.ts +1232 -0
  231. package/types/node_modules/openai/resources/beta/beta.d.mts +18 -0
  232. package/types/node_modules/openai/resources/beta/beta.d.ts +18 -0
  233. package/types/node_modules/openai/resources/beta/index.d.mts +5 -0
  234. package/types/node_modules/openai/resources/beta/index.d.ts +5 -0
  235. package/types/node_modules/openai/resources/beta/realtime/index.d.mts +4 -0
  236. package/types/node_modules/openai/resources/beta/realtime/index.d.ts +4 -0
  237. package/types/node_modules/openai/resources/beta/realtime/realtime.d.mts +2332 -0
  238. package/types/node_modules/openai/resources/beta/realtime/realtime.d.ts +2332 -0
  239. package/types/node_modules/openai/resources/beta/realtime/sessions.d.mts +744 -0
  240. package/types/node_modules/openai/resources/beta/realtime/sessions.d.ts +744 -0
  241. package/types/node_modules/openai/resources/beta/realtime/transcription-sessions.d.mts +299 -0
  242. package/types/node_modules/openai/resources/beta/realtime/transcription-sessions.d.ts +299 -0
  243. package/types/node_modules/openai/resources/beta/realtime.d.mts +2 -0
  244. package/types/node_modules/openai/resources/beta/realtime.d.ts +2 -0
  245. package/types/node_modules/openai/resources/beta/threads/index.d.mts +4 -0
  246. package/types/node_modules/openai/resources/beta/threads/index.d.ts +4 -0
  247. package/types/node_modules/openai/resources/beta/threads/messages.d.mts +594 -0
  248. package/types/node_modules/openai/resources/beta/threads/messages.d.ts +594 -0
  249. package/types/node_modules/openai/resources/beta/threads/runs/index.d.mts +3 -0
  250. package/types/node_modules/openai/resources/beta/threads/runs/index.d.ts +3 -0
  251. package/types/node_modules/openai/resources/beta/threads/runs/runs.d.mts +733 -0
  252. package/types/node_modules/openai/resources/beta/threads/runs/runs.d.ts +733 -0
  253. package/types/node_modules/openai/resources/beta/threads/runs/steps.d.mts +615 -0
  254. package/types/node_modules/openai/resources/beta/threads/runs/steps.d.ts +615 -0
  255. package/types/node_modules/openai/resources/beta/threads/runs.d.mts +2 -0
  256. package/types/node_modules/openai/resources/beta/threads/runs.d.ts +2 -0
  257. package/types/node_modules/openai/resources/beta/threads/threads.d.mts +1044 -0
  258. package/types/node_modules/openai/resources/beta/threads/threads.d.ts +1044 -0
  259. package/types/node_modules/openai/resources/beta/threads.d.mts +2 -0
  260. package/types/node_modules/openai/resources/beta/threads.d.ts +2 -0
  261. package/types/node_modules/openai/resources/beta.d.mts +2 -0
  262. package/types/node_modules/openai/resources/beta.d.ts +2 -0
  263. package/types/node_modules/openai/resources/chat/chat.d.mts +13 -0
  264. package/types/node_modules/openai/resources/chat/chat.d.ts +13 -0
  265. package/types/node_modules/openai/resources/chat/completions/completions.d.mts +1627 -0
  266. package/types/node_modules/openai/resources/chat/completions/completions.d.ts +1627 -0
  267. package/types/node_modules/openai/resources/chat/completions/index.d.mts +4 -0
  268. package/types/node_modules/openai/resources/chat/completions/index.d.ts +4 -0
  269. package/types/node_modules/openai/resources/chat/completions/messages.d.mts +34 -0
  270. package/types/node_modules/openai/resources/chat/completions/messages.d.ts +34 -0
  271. package/types/node_modules/openai/resources/chat/completions.d.mts +2 -0
  272. package/types/node_modules/openai/resources/chat/completions.d.ts +2 -0
  273. package/types/node_modules/openai/resources/chat/index.d.mts +3 -0
  274. package/types/node_modules/openai/resources/chat/index.d.ts +3 -0
  275. package/types/node_modules/openai/resources/chat.d.mts +2 -0
  276. package/types/node_modules/openai/resources/chat.d.ts +2 -0
  277. package/types/node_modules/openai/resources/completions.d.mts +329 -0
  278. package/types/node_modules/openai/resources/completions.d.ts +329 -0
  279. package/types/node_modules/openai/resources/containers/containers.d.mts +200 -0
  280. package/types/node_modules/openai/resources/containers/containers.d.ts +200 -0
  281. package/types/node_modules/openai/resources/containers/files/content.d.mts +16 -0
  282. package/types/node_modules/openai/resources/containers/files/content.d.ts +16 -0
  283. package/types/node_modules/openai/resources/containers/files/files.d.mts +148 -0
  284. package/types/node_modules/openai/resources/containers/files/files.d.ts +148 -0
  285. package/types/node_modules/openai/resources/containers/files/index.d.mts +3 -0
  286. package/types/node_modules/openai/resources/containers/files/index.d.ts +3 -0
  287. package/types/node_modules/openai/resources/containers/files.d.mts +2 -0
  288. package/types/node_modules/openai/resources/containers/files.d.ts +2 -0
  289. package/types/node_modules/openai/resources/containers/index.d.mts +3 -0
  290. package/types/node_modules/openai/resources/containers/index.d.ts +3 -0
  291. package/types/node_modules/openai/resources/containers.d.mts +2 -0
  292. package/types/node_modules/openai/resources/containers.d.ts +2 -0
  293. package/types/node_modules/openai/resources/conversations/conversations.d.mts +176 -0
  294. package/types/node_modules/openai/resources/conversations/conversations.d.ts +176 -0
  295. package/types/node_modules/openai/resources/conversations/index.d.mts +3 -0
  296. package/types/node_modules/openai/resources/conversations/index.d.ts +3 -0
  297. package/types/node_modules/openai/resources/conversations/items.d.mts +367 -0
  298. package/types/node_modules/openai/resources/conversations/items.d.ts +367 -0
  299. package/types/node_modules/openai/resources/conversations.d.mts +2 -0
  300. package/types/node_modules/openai/resources/conversations.d.ts +2 -0
  301. package/types/node_modules/openai/resources/embeddings.d.mts +113 -0
  302. package/types/node_modules/openai/resources/embeddings.d.ts +113 -0
  303. package/types/node_modules/openai/resources/evals/evals.d.mts +735 -0
  304. package/types/node_modules/openai/resources/evals/evals.d.ts +735 -0
  305. package/types/node_modules/openai/resources/evals/index.d.mts +3 -0
  306. package/types/node_modules/openai/resources/evals/index.d.ts +3 -0
  307. package/types/node_modules/openai/resources/evals/runs/index.d.mts +3 -0
  308. package/types/node_modules/openai/resources/evals/runs/index.d.ts +3 -0
  309. package/types/node_modules/openai/resources/evals/runs/output-items.d.mts +382 -0
  310. package/types/node_modules/openai/resources/evals/runs/output-items.d.ts +382 -0
  311. package/types/node_modules/openai/resources/evals/runs/runs.d.mts +2290 -0
  312. package/types/node_modules/openai/resources/evals/runs/runs.d.ts +2290 -0
  313. package/types/node_modules/openai/resources/evals/runs.d.mts +2 -0
  314. package/types/node_modules/openai/resources/evals/runs.d.ts +2 -0
  315. package/types/node_modules/openai/resources/evals.d.mts +2 -0
  316. package/types/node_modules/openai/resources/evals.d.ts +2 -0
  317. package/types/node_modules/openai/resources/files.d.mts +164 -0
  318. package/types/node_modules/openai/resources/files.d.ts +164 -0
  319. package/types/node_modules/openai/resources/fine-tuning/alpha/alpha.d.mts +10 -0
  320. package/types/node_modules/openai/resources/fine-tuning/alpha/alpha.d.ts +10 -0
  321. package/types/node_modules/openai/resources/fine-tuning/alpha/graders.d.mts +119 -0
  322. package/types/node_modules/openai/resources/fine-tuning/alpha/graders.d.ts +119 -0
  323. package/types/node_modules/openai/resources/fine-tuning/alpha/index.d.mts +3 -0
  324. package/types/node_modules/openai/resources/fine-tuning/alpha/index.d.ts +3 -0
  325. package/types/node_modules/openai/resources/fine-tuning/alpha.d.mts +2 -0
  326. package/types/node_modules/openai/resources/fine-tuning/alpha.d.ts +2 -0
  327. package/types/node_modules/openai/resources/fine-tuning/checkpoints/checkpoints.d.mts +10 -0
  328. package/types/node_modules/openai/resources/fine-tuning/checkpoints/checkpoints.d.ts +10 -0
  329. package/types/node_modules/openai/resources/fine-tuning/checkpoints/index.d.mts +3 -0
  330. package/types/node_modules/openai/resources/fine-tuning/checkpoints/index.d.ts +3 -0
  331. package/types/node_modules/openai/resources/fine-tuning/checkpoints/permissions.d.mts +160 -0
  332. package/types/node_modules/openai/resources/fine-tuning/checkpoints/permissions.d.ts +160 -0
  333. package/types/node_modules/openai/resources/fine-tuning/checkpoints.d.mts +2 -0
  334. package/types/node_modules/openai/resources/fine-tuning/checkpoints.d.ts +2 -0
  335. package/types/node_modules/openai/resources/fine-tuning/fine-tuning.d.mts +22 -0
  336. package/types/node_modules/openai/resources/fine-tuning/fine-tuning.d.ts +22 -0
  337. package/types/node_modules/openai/resources/fine-tuning/index.d.mts +6 -0
  338. package/types/node_modules/openai/resources/fine-tuning/index.d.ts +6 -0
  339. package/types/node_modules/openai/resources/fine-tuning/jobs/checkpoints.d.mts +74 -0
  340. package/types/node_modules/openai/resources/fine-tuning/jobs/checkpoints.d.ts +74 -0
  341. package/types/node_modules/openai/resources/fine-tuning/jobs/index.d.mts +3 -0
  342. package/types/node_modules/openai/resources/fine-tuning/jobs/index.d.ts +3 -0
  343. package/types/node_modules/openai/resources/fine-tuning/jobs/jobs.d.mts +528 -0
  344. package/types/node_modules/openai/resources/fine-tuning/jobs/jobs.d.ts +528 -0
  345. package/types/node_modules/openai/resources/fine-tuning/jobs.d.mts +2 -0
  346. package/types/node_modules/openai/resources/fine-tuning/jobs.d.ts +2 -0
  347. package/types/node_modules/openai/resources/fine-tuning/methods.d.mts +120 -0
  348. package/types/node_modules/openai/resources/fine-tuning/methods.d.ts +120 -0
  349. package/types/node_modules/openai/resources/fine-tuning.d.mts +2 -0
  350. package/types/node_modules/openai/resources/fine-tuning.d.ts +2 -0
  351. package/types/node_modules/openai/resources/graders/grader-models.d.mts +304 -0
  352. package/types/node_modules/openai/resources/graders/grader-models.d.ts +304 -0
  353. package/types/node_modules/openai/resources/graders/graders.d.mts +10 -0
  354. package/types/node_modules/openai/resources/graders/graders.d.ts +10 -0
  355. package/types/node_modules/openai/resources/graders/index.d.mts +3 -0
  356. package/types/node_modules/openai/resources/graders/index.d.ts +3 -0
  357. package/types/node_modules/openai/resources/graders.d.mts +2 -0
  358. package/types/node_modules/openai/resources/graders.d.ts +2 -0
  359. package/types/node_modules/openai/resources/images.d.mts +653 -0
  360. package/types/node_modules/openai/resources/images.d.ts +653 -0
  361. package/types/node_modules/openai/resources/index.d.mts +22 -0
  362. package/types/node_modules/openai/resources/index.d.ts +22 -0
  363. package/types/node_modules/openai/resources/models.d.mts +52 -0
  364. package/types/node_modules/openai/resources/models.d.ts +52 -0
  365. package/types/node_modules/openai/resources/moderations.d.mts +295 -0
  366. package/types/node_modules/openai/resources/moderations.d.ts +295 -0
  367. package/types/node_modules/openai/resources/realtime/client-secrets.d.mts +594 -0
  368. package/types/node_modules/openai/resources/realtime/client-secrets.d.ts +594 -0
  369. package/types/node_modules/openai/resources/realtime/index.d.mts +3 -0
  370. package/types/node_modules/openai/resources/realtime/index.d.ts +3 -0
  371. package/types/node_modules/openai/resources/realtime/realtime.d.mts +3828 -0
  372. package/types/node_modules/openai/resources/realtime/realtime.d.ts +3828 -0
  373. package/types/node_modules/openai/resources/realtime.d.mts +2 -0
  374. package/types/node_modules/openai/resources/realtime.d.ts +2 -0
  375. package/types/node_modules/openai/resources/responses/index.d.mts +3 -0
  376. package/types/node_modules/openai/resources/responses/index.d.ts +3 -0
  377. package/types/node_modules/openai/resources/responses/input-items.d.mts +65 -0
  378. package/types/node_modules/openai/resources/responses/input-items.d.ts +65 -0
  379. package/types/node_modules/openai/resources/responses/responses.d.mts +4705 -0
  380. package/types/node_modules/openai/resources/responses/responses.d.ts +4705 -0
  381. package/types/node_modules/openai/resources/responses.d.mts +2 -0
  382. package/types/node_modules/openai/resources/responses.d.ts +2 -0
  383. package/types/node_modules/openai/resources/shared.d.mts +265 -0
  384. package/types/node_modules/openai/resources/shared.d.ts +265 -0
  385. package/types/node_modules/openai/resources/uploads/index.d.mts +3 -0
  386. package/types/node_modules/openai/resources/uploads/index.d.ts +3 -0
  387. package/types/node_modules/openai/resources/uploads/parts.d.mts +51 -0
  388. package/types/node_modules/openai/resources/uploads/parts.d.ts +51 -0
  389. package/types/node_modules/openai/resources/uploads/uploads.d.mts +157 -0
  390. package/types/node_modules/openai/resources/uploads/uploads.d.ts +157 -0
  391. package/types/node_modules/openai/resources/uploads.d.mts +2 -0
  392. package/types/node_modules/openai/resources/uploads.d.ts +2 -0
  393. package/types/node_modules/openai/resources/vector-stores/file-batches.d.mts +172 -0
  394. package/types/node_modules/openai/resources/vector-stores/file-batches.d.ts +172 -0
  395. package/types/node_modules/openai/resources/vector-stores/files.d.mts +231 -0
  396. package/types/node_modules/openai/resources/vector-stores/files.d.ts +231 -0
  397. package/types/node_modules/openai/resources/vector-stores/index.d.mts +4 -0
  398. package/types/node_modules/openai/resources/vector-stores/index.d.ts +4 -0
  399. package/types/node_modules/openai/resources/vector-stores/vector-stores.d.mts +373 -0
  400. package/types/node_modules/openai/resources/vector-stores/vector-stores.d.ts +373 -0
  401. package/types/node_modules/openai/resources/vector-stores.d.mts +2 -0
  402. package/types/node_modules/openai/resources/vector-stores.d.ts +2 -0
  403. package/types/node_modules/openai/resources/webhooks.d.mts +587 -0
  404. package/types/node_modules/openai/resources/webhooks.d.ts +587 -0
  405. package/types/node_modules/openai/resources.d.mts +2 -0
  406. package/types/node_modules/openai/resources.d.ts +2 -0
  407. package/types/node_modules/openai/src/_vendor/zod-to-json-schema/LICENSE +15 -0
  408. package/types/node_modules/openai/streaming.d.mts +2 -0
  409. package/types/node_modules/openai/streaming.d.ts +2 -0
  410. package/types/node_modules/openai/uploads.d.mts +2 -0
  411. package/types/node_modules/openai/uploads.d.ts +2 -0
  412. package/types/node_modules/openai/version.d.mts +2 -0
  413. package/types/node_modules/openai/version.d.ts +2 -0
@@ -0,0 +1,735 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import * as Shared from "../shared.js";
3
+ import * as GraderModelsAPI from "../graders/grader-models.js";
4
+ import * as ResponsesAPI from "../responses/responses.js";
5
+ import * as RunsAPI from "./runs/runs.js";
6
+ import { CreateEvalCompletionsRunDataSource, CreateEvalJSONLRunDataSource, EvalAPIError, RunCancelParams, RunCancelResponse, RunCreateParams, RunCreateResponse, RunDeleteParams, RunDeleteResponse, RunListParams, RunListResponse, RunListResponsesPage, RunRetrieveParams, RunRetrieveResponse, Runs } from "./runs/runs.js";
7
+ import { APIPromise } from "../../core/api-promise.js";
8
+ import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
9
+ import { RequestOptions } from "../../internal/request-options.js";
10
+ export declare class Evals extends APIResource {
11
+ runs: RunsAPI.Runs;
12
+ /**
13
+ * Create the structure of an evaluation that can be used to test a model's
14
+ * performance. An evaluation is a set of testing criteria and the config for a
15
+ * data source, which dictates the schema of the data used in the evaluation. After
16
+ * creating an evaluation, you can run it on different models and model parameters.
17
+ * We support several types of graders and datasources. For more information, see
18
+ * the [Evals guide](https://platform.openai.com/docs/guides/evals).
19
+ */
20
+ create(body: EvalCreateParams, options?: RequestOptions): APIPromise<EvalCreateResponse>;
21
+ /**
22
+ * Get an evaluation by ID.
23
+ */
24
+ retrieve(evalID: string, options?: RequestOptions): APIPromise<EvalRetrieveResponse>;
25
+ /**
26
+ * Update certain properties of an evaluation.
27
+ */
28
+ update(evalID: string, body: EvalUpdateParams, options?: RequestOptions): APIPromise<EvalUpdateResponse>;
29
+ /**
30
+ * List evaluations for a project.
31
+ */
32
+ list(query?: EvalListParams | null | undefined, options?: RequestOptions): PagePromise<EvalListResponsesPage, EvalListResponse>;
33
+ /**
34
+ * Delete an evaluation.
35
+ */
36
+ delete(evalID: string, options?: RequestOptions): APIPromise<EvalDeleteResponse>;
37
+ }
38
+ export type EvalListResponsesPage = CursorPage<EvalListResponse>;
39
+ /**
40
+ * A CustomDataSourceConfig which specifies the schema of your `item` and
41
+ * optionally `sample` namespaces. The response schema defines the shape of the
42
+ * data that will be:
43
+ *
44
+ * - Used to define your testing criteria and
45
+ * - What data is required when creating a run
46
+ */
47
+ export interface EvalCustomDataSourceConfig {
48
+ /**
49
+ * The json schema for the run data source items. Learn how to build JSON schemas
50
+ * [here](https://json-schema.org/).
51
+ */
52
+ schema: {
53
+ [key: string]: unknown;
54
+ };
55
+ /**
56
+ * The type of data source. Always `custom`.
57
+ */
58
+ type: 'custom';
59
+ }
60
+ /**
61
+ * @deprecated Deprecated in favor of LogsDataSourceConfig.
62
+ */
63
+ export interface EvalStoredCompletionsDataSourceConfig {
64
+ /**
65
+ * The json schema for the run data source items. Learn how to build JSON schemas
66
+ * [here](https://json-schema.org/).
67
+ */
68
+ schema: {
69
+ [key: string]: unknown;
70
+ };
71
+ /**
72
+ * The type of data source. Always `stored_completions`.
73
+ */
74
+ type: 'stored_completions';
75
+ /**
76
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
77
+ * for storing additional information about the object in a structured format, and
78
+ * querying for objects via API or the dashboard.
79
+ *
80
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
81
+ * a maximum length of 512 characters.
82
+ */
83
+ metadata?: Shared.Metadata | null;
84
+ }
85
+ /**
86
+ * An Eval object with a data source config and testing criteria. An Eval
87
+ * represents a task to be done for your LLM integration. Like:
88
+ *
89
+ * - Improve the quality of my chatbot
90
+ * - See how well my chatbot handles customer support
91
+ * - Check if o4-mini is better at my usecase than gpt-4o
92
+ */
93
+ export interface EvalCreateResponse {
94
+ /**
95
+ * Unique identifier for the evaluation.
96
+ */
97
+ id: string;
98
+ /**
99
+ * The Unix timestamp (in seconds) for when the eval was created.
100
+ */
101
+ created_at: number;
102
+ /**
103
+ * Configuration of data sources used in runs of the evaluation.
104
+ */
105
+ data_source_config: EvalCustomDataSourceConfig | EvalCreateResponse.Logs | EvalStoredCompletionsDataSourceConfig;
106
+ /**
107
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
108
+ * for storing additional information about the object in a structured format, and
109
+ * querying for objects via API or the dashboard.
110
+ *
111
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
112
+ * a maximum length of 512 characters.
113
+ */
114
+ metadata: Shared.Metadata | null;
115
+ /**
116
+ * The name of the evaluation.
117
+ */
118
+ name: string;
119
+ /**
120
+ * The object type.
121
+ */
122
+ object: 'eval';
123
+ /**
124
+ * A list of testing criteria.
125
+ */
126
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalCreateResponse.EvalGraderTextSimilarity | EvalCreateResponse.EvalGraderPython | EvalCreateResponse.EvalGraderScoreModel>;
127
+ }
128
+ export declare namespace EvalCreateResponse {
129
+ /**
130
+ * A LogsDataSourceConfig which specifies the metadata property of your logs query.
131
+ * This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc. The
132
+ * schema returned by this data source config is used to defined what variables are
133
+ * available in your evals. `item` and `sample` are both defined when using this
134
+ * data source config.
135
+ */
136
+ interface Logs {
137
+ /**
138
+ * The json schema for the run data source items. Learn how to build JSON schemas
139
+ * [here](https://json-schema.org/).
140
+ */
141
+ schema: {
142
+ [key: string]: unknown;
143
+ };
144
+ /**
145
+ * The type of data source. Always `logs`.
146
+ */
147
+ type: 'logs';
148
+ /**
149
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
150
+ * for storing additional information about the object in a structured format, and
151
+ * querying for objects via API or the dashboard.
152
+ *
153
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
154
+ * a maximum length of 512 characters.
155
+ */
156
+ metadata?: Shared.Metadata | null;
157
+ }
158
+ /**
159
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
160
+ */
161
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
162
+ /**
163
+ * The threshold for the score.
164
+ */
165
+ pass_threshold: number;
166
+ }
167
+ /**
168
+ * A PythonGrader object that runs a python script on the input.
169
+ */
170
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
171
+ /**
172
+ * The threshold for the score.
173
+ */
174
+ pass_threshold?: number;
175
+ }
176
+ /**
177
+ * A ScoreModelGrader object that uses a model to assign a score to the input.
178
+ */
179
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
180
+ /**
181
+ * The threshold for the score.
182
+ */
183
+ pass_threshold?: number;
184
+ }
185
+ }
186
+ /**
187
+ * An Eval object with a data source config and testing criteria. An Eval
188
+ * represents a task to be done for your LLM integration. Like:
189
+ *
190
+ * - Improve the quality of my chatbot
191
+ * - See how well my chatbot handles customer support
192
+ * - Check if o4-mini is better at my usecase than gpt-4o
193
+ */
194
+ export interface EvalRetrieveResponse {
195
+ /**
196
+ * Unique identifier for the evaluation.
197
+ */
198
+ id: string;
199
+ /**
200
+ * The Unix timestamp (in seconds) for when the eval was created.
201
+ */
202
+ created_at: number;
203
+ /**
204
+ * Configuration of data sources used in runs of the evaluation.
205
+ */
206
+ data_source_config: EvalCustomDataSourceConfig | EvalRetrieveResponse.Logs | EvalStoredCompletionsDataSourceConfig;
207
+ /**
208
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
209
+ * for storing additional information about the object in a structured format, and
210
+ * querying for objects via API or the dashboard.
211
+ *
212
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
213
+ * a maximum length of 512 characters.
214
+ */
215
+ metadata: Shared.Metadata | null;
216
+ /**
217
+ * The name of the evaluation.
218
+ */
219
+ name: string;
220
+ /**
221
+ * The object type.
222
+ */
223
+ object: 'eval';
224
+ /**
225
+ * A list of testing criteria.
226
+ */
227
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalRetrieveResponse.EvalGraderTextSimilarity | EvalRetrieveResponse.EvalGraderPython | EvalRetrieveResponse.EvalGraderScoreModel>;
228
+ }
229
+ export declare namespace EvalRetrieveResponse {
230
+ /**
231
+ * A LogsDataSourceConfig which specifies the metadata property of your logs query.
232
+ * This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc. The
233
+ * schema returned by this data source config is used to defined what variables are
234
+ * available in your evals. `item` and `sample` are both defined when using this
235
+ * data source config.
236
+ */
237
+ interface Logs {
238
+ /**
239
+ * The json schema for the run data source items. Learn how to build JSON schemas
240
+ * [here](https://json-schema.org/).
241
+ */
242
+ schema: {
243
+ [key: string]: unknown;
244
+ };
245
+ /**
246
+ * The type of data source. Always `logs`.
247
+ */
248
+ type: 'logs';
249
+ /**
250
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
251
+ * for storing additional information about the object in a structured format, and
252
+ * querying for objects via API or the dashboard.
253
+ *
254
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
255
+ * a maximum length of 512 characters.
256
+ */
257
+ metadata?: Shared.Metadata | null;
258
+ }
259
+ /**
260
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
261
+ */
262
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
263
+ /**
264
+ * The threshold for the score.
265
+ */
266
+ pass_threshold: number;
267
+ }
268
+ /**
269
+ * A PythonGrader object that runs a python script on the input.
270
+ */
271
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
272
+ /**
273
+ * The threshold for the score.
274
+ */
275
+ pass_threshold?: number;
276
+ }
277
+ /**
278
+ * A ScoreModelGrader object that uses a model to assign a score to the input.
279
+ */
280
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
281
+ /**
282
+ * The threshold for the score.
283
+ */
284
+ pass_threshold?: number;
285
+ }
286
+ }
287
+ /**
288
+ * An Eval object with a data source config and testing criteria. An Eval
289
+ * represents a task to be done for your LLM integration. Like:
290
+ *
291
+ * - Improve the quality of my chatbot
292
+ * - See how well my chatbot handles customer support
293
+ * - Check if o4-mini is better at my usecase than gpt-4o
294
+ */
295
+ export interface EvalUpdateResponse {
296
+ /**
297
+ * Unique identifier for the evaluation.
298
+ */
299
+ id: string;
300
+ /**
301
+ * The Unix timestamp (in seconds) for when the eval was created.
302
+ */
303
+ created_at: number;
304
+ /**
305
+ * Configuration of data sources used in runs of the evaluation.
306
+ */
307
+ data_source_config: EvalCustomDataSourceConfig | EvalUpdateResponse.Logs | EvalStoredCompletionsDataSourceConfig;
308
+ /**
309
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
310
+ * for storing additional information about the object in a structured format, and
311
+ * querying for objects via API or the dashboard.
312
+ *
313
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
314
+ * a maximum length of 512 characters.
315
+ */
316
+ metadata: Shared.Metadata | null;
317
+ /**
318
+ * The name of the evaluation.
319
+ */
320
+ name: string;
321
+ /**
322
+ * The object type.
323
+ */
324
+ object: 'eval';
325
+ /**
326
+ * A list of testing criteria.
327
+ */
328
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalUpdateResponse.EvalGraderTextSimilarity | EvalUpdateResponse.EvalGraderPython | EvalUpdateResponse.EvalGraderScoreModel>;
329
+ }
330
+ export declare namespace EvalUpdateResponse {
331
+ /**
332
+ * A LogsDataSourceConfig which specifies the metadata property of your logs query.
333
+ * This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc. The
334
+ * schema returned by this data source config is used to defined what variables are
335
+ * available in your evals. `item` and `sample` are both defined when using this
336
+ * data source config.
337
+ */
338
+ interface Logs {
339
+ /**
340
+ * The json schema for the run data source items. Learn how to build JSON schemas
341
+ * [here](https://json-schema.org/).
342
+ */
343
+ schema: {
344
+ [key: string]: unknown;
345
+ };
346
+ /**
347
+ * The type of data source. Always `logs`.
348
+ */
349
+ type: 'logs';
350
+ /**
351
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
352
+ * for storing additional information about the object in a structured format, and
353
+ * querying for objects via API or the dashboard.
354
+ *
355
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
356
+ * a maximum length of 512 characters.
357
+ */
358
+ metadata?: Shared.Metadata | null;
359
+ }
360
+ /**
361
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
362
+ */
363
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
364
+ /**
365
+ * The threshold for the score.
366
+ */
367
+ pass_threshold: number;
368
+ }
369
+ /**
370
+ * A PythonGrader object that runs a python script on the input.
371
+ */
372
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
373
+ /**
374
+ * The threshold for the score.
375
+ */
376
+ pass_threshold?: number;
377
+ }
378
+ /**
379
+ * A ScoreModelGrader object that uses a model to assign a score to the input.
380
+ */
381
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
382
+ /**
383
+ * The threshold for the score.
384
+ */
385
+ pass_threshold?: number;
386
+ }
387
+ }
388
+ /**
389
+ * An Eval object with a data source config and testing criteria. An Eval
390
+ * represents a task to be done for your LLM integration. Like:
391
+ *
392
+ * - Improve the quality of my chatbot
393
+ * - See how well my chatbot handles customer support
394
+ * - Check if o4-mini is better at my usecase than gpt-4o
395
+ */
396
+ export interface EvalListResponse {
397
+ /**
398
+ * Unique identifier for the evaluation.
399
+ */
400
+ id: string;
401
+ /**
402
+ * The Unix timestamp (in seconds) for when the eval was created.
403
+ */
404
+ created_at: number;
405
+ /**
406
+ * Configuration of data sources used in runs of the evaluation.
407
+ */
408
+ data_source_config: EvalCustomDataSourceConfig | EvalListResponse.Logs | EvalStoredCompletionsDataSourceConfig;
409
+ /**
410
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
411
+ * for storing additional information about the object in a structured format, and
412
+ * querying for objects via API or the dashboard.
413
+ *
414
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
415
+ * a maximum length of 512 characters.
416
+ */
417
+ metadata: Shared.Metadata | null;
418
+ /**
419
+ * The name of the evaluation.
420
+ */
421
+ name: string;
422
+ /**
423
+ * The object type.
424
+ */
425
+ object: 'eval';
426
+ /**
427
+ * A list of testing criteria.
428
+ */
429
+ testing_criteria: Array<GraderModelsAPI.LabelModelGrader | GraderModelsAPI.StringCheckGrader | EvalListResponse.EvalGraderTextSimilarity | EvalListResponse.EvalGraderPython | EvalListResponse.EvalGraderScoreModel>;
430
+ }
431
+ export declare namespace EvalListResponse {
432
+ /**
433
+ * A LogsDataSourceConfig which specifies the metadata property of your logs query.
434
+ * This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc. The
435
+ * schema returned by this data source config is used to defined what variables are
436
+ * available in your evals. `item` and `sample` are both defined when using this
437
+ * data source config.
438
+ */
439
+ interface Logs {
440
+ /**
441
+ * The json schema for the run data source items. Learn how to build JSON schemas
442
+ * [here](https://json-schema.org/).
443
+ */
444
+ schema: {
445
+ [key: string]: unknown;
446
+ };
447
+ /**
448
+ * The type of data source. Always `logs`.
449
+ */
450
+ type: 'logs';
451
+ /**
452
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
453
+ * for storing additional information about the object in a structured format, and
454
+ * querying for objects via API or the dashboard.
455
+ *
456
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
457
+ * a maximum length of 512 characters.
458
+ */
459
+ metadata?: Shared.Metadata | null;
460
+ }
461
+ /**
462
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
463
+ */
464
+ interface EvalGraderTextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
465
+ /**
466
+ * The threshold for the score.
467
+ */
468
+ pass_threshold: number;
469
+ }
470
+ /**
471
+ * A PythonGrader object that runs a python script on the input.
472
+ */
473
+ interface EvalGraderPython extends GraderModelsAPI.PythonGrader {
474
+ /**
475
+ * The threshold for the score.
476
+ */
477
+ pass_threshold?: number;
478
+ }
479
+ /**
480
+ * A ScoreModelGrader object that uses a model to assign a score to the input.
481
+ */
482
+ interface EvalGraderScoreModel extends GraderModelsAPI.ScoreModelGrader {
483
+ /**
484
+ * The threshold for the score.
485
+ */
486
+ pass_threshold?: number;
487
+ }
488
+ }
489
+ export interface EvalDeleteResponse {
490
+ deleted: boolean;
491
+ eval_id: string;
492
+ object: string;
493
+ }
494
+ export interface EvalCreateParams {
495
+ /**
496
+ * The configuration for the data source used for the evaluation runs. Dictates the
497
+ * schema of the data used in the evaluation.
498
+ */
499
+ data_source_config: EvalCreateParams.Custom | EvalCreateParams.Logs | EvalCreateParams.StoredCompletions;
500
+ /**
501
+ * A list of graders for all eval runs in this group. Graders can reference
502
+ * variables in the data source using double curly braces notation, like
503
+ * `{{item.variable_name}}`. To reference the model's output, use the `sample`
504
+ * namespace (ie, `{{sample.output_text}}`).
505
+ */
506
+ testing_criteria: Array<EvalCreateParams.LabelModel | GraderModelsAPI.StringCheckGrader | EvalCreateParams.TextSimilarity | EvalCreateParams.Python | EvalCreateParams.ScoreModel>;
507
+ /**
508
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
509
+ * for storing additional information about the object in a structured format, and
510
+ * querying for objects via API or the dashboard.
511
+ *
512
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
513
+ * a maximum length of 512 characters.
514
+ */
515
+ metadata?: Shared.Metadata | null;
516
+ /**
517
+ * The name of the evaluation.
518
+ */
519
+ name?: string;
520
+ }
521
+ export declare namespace EvalCreateParams {
522
+ /**
523
+ * A CustomDataSourceConfig object that defines the schema for the data source used
524
+ * for the evaluation runs. This schema is used to define the shape of the data
525
+ * that will be:
526
+ *
527
+ * - Used to define your testing criteria and
528
+ * - What data is required when creating a run
529
+ */
530
+ interface Custom {
531
+ /**
532
+ * The json schema for each row in the data source.
533
+ */
534
+ item_schema: {
535
+ [key: string]: unknown;
536
+ };
537
+ /**
538
+ * The type of data source. Always `custom`.
539
+ */
540
+ type: 'custom';
541
+ /**
542
+ * Whether the eval should expect you to populate the sample namespace (ie, by
543
+ * generating responses off of your data source)
544
+ */
545
+ include_sample_schema?: boolean;
546
+ }
547
+ /**
548
+ * A data source config which specifies the metadata property of your logs query.
549
+ * This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc.
550
+ */
551
+ interface Logs {
552
+ /**
553
+ * The type of data source. Always `logs`.
554
+ */
555
+ type: 'logs';
556
+ /**
557
+ * Metadata filters for the logs data source.
558
+ */
559
+ metadata?: {
560
+ [key: string]: unknown;
561
+ };
562
+ }
563
+ /**
564
+ * @deprecated Deprecated in favor of LogsDataSourceConfig.
565
+ */
566
+ interface StoredCompletions {
567
+ /**
568
+ * The type of data source. Always `stored_completions`.
569
+ */
570
+ type: 'stored_completions';
571
+ /**
572
+ * Metadata filters for the stored completions data source.
573
+ */
574
+ metadata?: {
575
+ [key: string]: unknown;
576
+ };
577
+ }
578
+ /**
579
+ * A LabelModelGrader object which uses a model to assign labels to each item in
580
+ * the evaluation.
581
+ */
582
+ interface LabelModel {
583
+ /**
584
+ * A list of chat messages forming the prompt or context. May include variable
585
+ * references to the `item` namespace, ie {{item.name}}.
586
+ */
587
+ input: Array<LabelModel.SimpleInputMessage | LabelModel.EvalItem>;
588
+ /**
589
+ * The labels to classify to each item in the evaluation.
590
+ */
591
+ labels: Array<string>;
592
+ /**
593
+ * The model to use for the evaluation. Must support structured outputs.
594
+ */
595
+ model: string;
596
+ /**
597
+ * The name of the grader.
598
+ */
599
+ name: string;
600
+ /**
601
+ * The labels that indicate a passing result. Must be a subset of labels.
602
+ */
603
+ passing_labels: Array<string>;
604
+ /**
605
+ * The object type, which is always `label_model`.
606
+ */
607
+ type: 'label_model';
608
+ }
609
+ namespace LabelModel {
610
+ interface SimpleInputMessage {
611
+ /**
612
+ * The content of the message.
613
+ */
614
+ content: string;
615
+ /**
616
+ * The role of the message (e.g. "system", "assistant", "user").
617
+ */
618
+ role: string;
619
+ }
620
+ /**
621
+ * A message input to the model with a role indicating instruction following
622
+ * hierarchy. Instructions given with the `developer` or `system` role take
623
+ * precedence over instructions given with the `user` role. Messages with the
624
+ * `assistant` role are presumed to have been generated by the model in previous
625
+ * interactions.
626
+ */
627
+ interface EvalItem {
628
+ /**
629
+ * Inputs to the model - can contain template strings.
630
+ */
631
+ content: string | ResponsesAPI.ResponseInputText | EvalItem.OutputText | EvalItem.InputImage | ResponsesAPI.ResponseInputAudio | Array<unknown>;
632
+ /**
633
+ * The role of the message input. One of `user`, `assistant`, `system`, or
634
+ * `developer`.
635
+ */
636
+ role: 'user' | 'assistant' | 'system' | 'developer';
637
+ /**
638
+ * The type of the message input. Always `message`.
639
+ */
640
+ type?: 'message';
641
+ }
642
+ namespace EvalItem {
643
+ /**
644
+ * A text output from the model.
645
+ */
646
+ interface OutputText {
647
+ /**
648
+ * The text output from the model.
649
+ */
650
+ text: string;
651
+ /**
652
+ * The type of the output text. Always `output_text`.
653
+ */
654
+ type: 'output_text';
655
+ }
656
+ /**
657
+ * An image input to the model.
658
+ */
659
+ interface InputImage {
660
+ /**
661
+ * The URL of the image input.
662
+ */
663
+ image_url: string;
664
+ /**
665
+ * The type of the image input. Always `input_image`.
666
+ */
667
+ type: 'input_image';
668
+ /**
669
+ * The detail level of the image to be sent to the model. One of `high`, `low`, or
670
+ * `auto`. Defaults to `auto`.
671
+ */
672
+ detail?: string;
673
+ }
674
+ }
675
+ }
676
+ /**
677
+ * A TextSimilarityGrader object which grades text based on similarity metrics.
678
+ */
679
+ interface TextSimilarity extends GraderModelsAPI.TextSimilarityGrader {
680
+ /**
681
+ * The threshold for the score.
682
+ */
683
+ pass_threshold: number;
684
+ }
685
+ /**
686
+ * A PythonGrader object that runs a python script on the input.
687
+ */
688
+ interface Python extends GraderModelsAPI.PythonGrader {
689
+ /**
690
+ * The threshold for the score.
691
+ */
692
+ pass_threshold?: number;
693
+ }
694
+ /**
695
+ * A ScoreModelGrader object that uses a model to assign a score to the input.
696
+ */
697
+ interface ScoreModel extends GraderModelsAPI.ScoreModelGrader {
698
+ /**
699
+ * The threshold for the score.
700
+ */
701
+ pass_threshold?: number;
702
+ }
703
+ }
704
+ export interface EvalUpdateParams {
705
+ /**
706
+ * Set of 16 key-value pairs that can be attached to an object. This can be useful
707
+ * for storing additional information about the object in a structured format, and
708
+ * querying for objects via API or the dashboard.
709
+ *
710
+ * Keys are strings with a maximum length of 64 characters. Values are strings with
711
+ * a maximum length of 512 characters.
712
+ */
713
+ metadata?: Shared.Metadata | null;
714
+ /**
715
+ * Rename the evaluation.
716
+ */
717
+ name?: string;
718
+ }
719
+ export interface EvalListParams extends CursorPageParams {
720
+ /**
721
+ * Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for
722
+ * descending order.
723
+ */
724
+ order?: 'asc' | 'desc';
725
+ /**
726
+ * Evals can be ordered by creation time or last updated time. Use `created_at` for
727
+ * creation time or `updated_at` for last updated time.
728
+ */
729
+ order_by?: 'created_at' | 'updated_at';
730
+ }
731
+ export declare namespace Evals {
732
+ 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, type EvalListResponsesPage as EvalListResponsesPage, type EvalCreateParams as EvalCreateParams, type EvalUpdateParams as EvalUpdateParams, type EvalListParams as EvalListParams, };
733
+ 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, type RunListResponsesPage as RunListResponsesPage, type RunCreateParams as RunCreateParams, type RunRetrieveParams as RunRetrieveParams, type RunListParams as RunListParams, type RunDeleteParams as RunDeleteParams, type RunCancelParams as RunCancelParams, };
734
+ }
735
+ //# sourceMappingURL=evals.d.ts.map