llama-stack-client 0.4.3 → 0.4.5

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 (932) hide show
  1. package/.devcontainer/devcontainer.json +15 -0
  2. package/.eslintrc.js +16 -0
  3. package/.github/workflows/ci.yml +88 -0
  4. package/.github/workflows/integration-tests.yml +133 -0
  5. package/.github/workflows/release-doctor.yml +19 -0
  6. package/.gitignore +12 -0
  7. package/.prettierignore +7 -0
  8. package/.prettierrc.json +7 -0
  9. package/.release-please-manifest.json +3 -0
  10. package/.stats.yml +4 -0
  11. package/Brewfile +1 -0
  12. package/CHANGELOG.md +41 -0
  13. package/CODE_OF_CONDUCT.md +80 -0
  14. package/CONTRIBUTING.md +98 -0
  15. package/LICENSE +1 -1
  16. package/README.md +10 -5
  17. package/SECURITY.md +27 -0
  18. package/api.md +491 -0
  19. package/bin/check-release-environment +18 -0
  20. package/bin/publish-npm +61 -0
  21. package/dist/CHANGELOG.md +393 -0
  22. package/dist/LICENSE +7 -0
  23. package/dist/README.md +369 -0
  24. package/dist/core.d.ts.map +1 -0
  25. package/dist/core.js +945 -0
  26. package/dist/core.js.map +1 -0
  27. package/dist/core.mjs +913 -0
  28. package/dist/core.mjs.map +1 -0
  29. package/dist/package.json +108 -0
  30. package/dist/resources/alpha/alpha.d.ts +26 -0
  31. package/dist/resources/alpha/alpha.d.ts.map +1 -0
  32. package/dist/resources/alpha/alpha.js +61 -0
  33. package/dist/resources/alpha/alpha.js.map +1 -0
  34. package/dist/resources/alpha/alpha.mjs +34 -0
  35. package/dist/resources/alpha/alpha.mjs.map +1 -0
  36. package/dist/resources/alpha/eval/eval.d.ts +181 -0
  37. package/dist/resources/alpha/eval/eval.d.ts.map +1 -0
  38. package/dist/resources/alpha/eval/eval.js.map +1 -0
  39. package/dist/resources/alpha/eval/eval.mjs.map +1 -0
  40. package/dist/resources/alpha/inference.d.ts +136 -0
  41. package/dist/resources/alpha/inference.d.ts.map +1 -0
  42. package/dist/resources/alpha/post-training/index.d.ts +3 -0
  43. package/dist/resources/alpha/post-training/index.d.ts.map +1 -0
  44. package/dist/resources/alpha/post-training/index.js.map +1 -0
  45. package/dist/resources/alpha/post-training/index.mjs +10 -0
  46. package/dist/resources/alpha/post-training/index.mjs.map +1 -0
  47. package/dist/resources/alpha/post-training/job.d.ts +104 -0
  48. package/dist/resources/alpha/post-training/job.d.ts.map +1 -0
  49. package/dist/resources/alpha/post-training/job.js +42 -0
  50. package/dist/resources/alpha/post-training/job.js.map +1 -0
  51. package/dist/resources/alpha/post-training/job.mjs +38 -0
  52. package/dist/resources/alpha/post-training/job.mjs.map +1 -0
  53. package/dist/resources/alpha/post-training/post-training.d.ts +269 -0
  54. package/dist/resources/alpha/post-training/post-training.d.ts.map +1 -0
  55. package/dist/resources/alpha/post-training/post-training.js.map +1 -0
  56. package/dist/resources/alpha/post-training/post-training.mjs +30 -0
  57. package/dist/resources/alpha/post-training/post-training.mjs.map +1 -0
  58. package/dist/resources/beta/datasets.d.ts +351 -0
  59. package/dist/resources/beta/datasets.d.ts.map +1 -0
  60. package/dist/resources/chat/chat.d.ts +274 -0
  61. package/dist/resources/chat/chat.d.ts.map +1 -0
  62. package/dist/resources/chat/chat.js.map +1 -0
  63. package/dist/resources/chat/chat.mjs.map +1 -0
  64. package/dist/resources/chat/completions.d.ts +2413 -0
  65. package/dist/resources/chat/completions.d.ts.map +1 -0
  66. package/dist/resources/chat/completions.js +31 -0
  67. package/dist/resources/chat/completions.js.map +1 -0
  68. package/dist/resources/chat/completions.mjs +27 -0
  69. package/dist/resources/chat/completions.mjs.map +1 -0
  70. package/dist/resources/completions.d.ts +267 -0
  71. package/dist/resources/completions.d.ts.map +1 -0
  72. package/dist/resources/completions.js.map +1 -0
  73. package/dist/resources/completions.mjs.map +1 -0
  74. package/dist/resources/conversations/conversations.d.ts +336 -0
  75. package/dist/resources/conversations/conversations.d.ts.map +1 -0
  76. package/dist/resources/conversations/conversations.js +70 -0
  77. package/dist/resources/conversations/conversations.js.map +1 -0
  78. package/dist/resources/conversations/conversations.mjs +43 -0
  79. package/dist/resources/conversations/conversations.mjs.map +1 -0
  80. package/dist/resources/conversations/items.d.ts +1045 -0
  81. package/dist/resources/conversations/items.d.ts.map +1 -0
  82. package/dist/resources/conversations/items.js +45 -0
  83. package/dist/resources/conversations/items.js.map +1 -0
  84. package/dist/resources/conversations/items.mjs +40 -0
  85. package/dist/resources/conversations/items.mjs.map +1 -0
  86. package/dist/resources/embeddings.d.ts +90 -0
  87. package/dist/resources/embeddings.d.ts.map +1 -0
  88. package/dist/resources/embeddings.js +22 -0
  89. package/dist/resources/embeddings.js.map +1 -0
  90. package/dist/resources/embeddings.mjs +18 -0
  91. package/dist/resources/embeddings.mjs.map +1 -0
  92. package/dist/resources/files.d.ts +147 -0
  93. package/dist/resources/files.d.ts.map +1 -0
  94. package/dist/resources/files.js +75 -0
  95. package/dist/resources/files.js.map +1 -0
  96. package/dist/resources/files.mjs +47 -0
  97. package/dist/resources/files.mjs.map +1 -0
  98. package/dist/resources/models/models.d.ts +142 -0
  99. package/dist/resources/models/models.d.ts.map +1 -0
  100. package/dist/resources/models/models.js +76 -0
  101. package/dist/resources/models/models.js.map +1 -0
  102. package/dist/resources/models/models.mjs +49 -0
  103. package/dist/resources/models/models.mjs.map +1 -0
  104. package/dist/resources/moderations.d.ts +80 -0
  105. package/dist/resources/moderations.d.ts.map +1 -0
  106. package/dist/resources/moderations.js +21 -0
  107. package/dist/resources/moderations.js.map +1 -0
  108. package/dist/resources/moderations.mjs +17 -0
  109. package/dist/resources/moderations.mjs.map +1 -0
  110. package/dist/resources/prompts/prompts.d.ts +110 -0
  111. package/dist/resources/prompts/prompts.d.ts.map +1 -0
  112. package/dist/resources/prompts/prompts.js +85 -0
  113. package/dist/resources/prompts/prompts.js.map +1 -0
  114. package/dist/resources/prompts/prompts.mjs +58 -0
  115. package/dist/resources/prompts/prompts.mjs.map +1 -0
  116. package/dist/resources/prompts/versions.d.ts +10 -0
  117. package/dist/resources/prompts/versions.d.ts.map +1 -0
  118. package/dist/resources/prompts/versions.js +21 -0
  119. package/dist/resources/prompts/versions.js.map +1 -0
  120. package/dist/resources/prompts/versions.mjs +17 -0
  121. package/dist/resources/prompts/versions.mjs.map +1 -0
  122. package/dist/resources/responses/input-items.d.ts +410 -0
  123. package/dist/resources/responses/input-items.d.ts.map +1 -0
  124. package/dist/resources/responses/responses.d.ts +3180 -0
  125. package/dist/resources/responses/responses.d.ts.map +1 -0
  126. package/dist/resources/responses/responses.js.map +1 -0
  127. package/dist/resources/responses/responses.mjs.map +1 -0
  128. package/dist/resources/safety.d.ts +294 -0
  129. package/dist/resources/safety.d.ts.map +1 -0
  130. package/dist/resources/safety.js +21 -0
  131. package/dist/resources/safety.js.map +1 -0
  132. package/dist/resources/safety.mjs +17 -0
  133. package/dist/resources/safety.mjs.map +1 -0
  134. package/dist/resources/scoring-functions.d.ts +232 -0
  135. package/dist/resources/scoring-functions.d.ts.map +1 -0
  136. package/dist/resources/scoring.d.ts +157 -0
  137. package/dist/resources/scoring.d.ts.map +1 -0
  138. package/dist/resources/shared.d.ts +464 -0
  139. package/dist/resources/shared.d.ts.map +1 -0
  140. package/dist/resources/shields.d.ts +82 -0
  141. package/dist/resources/shields.d.ts.map +1 -0
  142. package/dist/resources/vector-io.d.ts +375 -0
  143. package/dist/resources/vector-io.d.ts.map +1 -0
  144. package/dist/resources/vector-io.js +31 -0
  145. package/dist/resources/vector-io.mjs +27 -0
  146. package/dist/resources/vector-stores/file-batches.d.ts +117 -0
  147. package/dist/resources/vector-stores/file-batches.d.ts.map +1 -0
  148. package/dist/resources/vector-stores/file-batches.js +42 -0
  149. package/dist/resources/vector-stores/file-batches.js.map +1 -0
  150. package/dist/resources/vector-stores/file-batches.mjs +38 -0
  151. package/dist/resources/vector-stores/file-batches.mjs.map +1 -0
  152. package/dist/resources/vector-stores/files.d.ts +235 -0
  153. package/dist/resources/vector-stores/files.d.ts.map +1 -0
  154. package/dist/resources/vector-stores/files.js +60 -0
  155. package/dist/resources/vector-stores/files.js.map +1 -0
  156. package/dist/resources/vector-stores/files.mjs +55 -0
  157. package/dist/resources/vector-stores/files.mjs.map +1 -0
  158. package/dist/resources/vector-stores/vector-stores.d.ts +322 -0
  159. package/dist/resources/vector-stores/vector-stores.d.ts.map +1 -0
  160. package/dist/resources/vector-stores/vector-stores.js +92 -0
  161. package/dist/resources/vector-stores/vector-stores.js.map +1 -0
  162. package/dist/resources/vector-stores/vector-stores.mjs +64 -0
  163. package/dist/resources/vector-stores/vector-stores.mjs.map +1 -0
  164. package/dist/src/_shims/MultipartBody.ts +15 -0
  165. package/dist/src/_shims/README.md +46 -0
  166. package/dist/src/_shims/auto/runtime-bun.ts +10 -0
  167. package/dist/src/_shims/auto/runtime-node.ts +10 -0
  168. package/dist/src/_shims/auto/runtime.ts +10 -0
  169. package/dist/src/_shims/auto/types-node.ts +10 -0
  170. package/dist/src/_shims/auto/types.d.ts +107 -0
  171. package/dist/src/_shims/auto/types.js +9 -0
  172. package/dist/src/_shims/auto/types.mjs +10 -0
  173. package/dist/src/_shims/bun-runtime.ts +20 -0
  174. package/dist/src/_shims/index.d.ts +89 -0
  175. package/dist/src/_shims/index.js +23 -0
  176. package/dist/src/_shims/index.mjs +18 -0
  177. package/dist/src/_shims/manual-types.d.ts +18 -0
  178. package/dist/src/_shims/manual-types.js +9 -0
  179. package/dist/src/_shims/manual-types.mjs +10 -0
  180. package/dist/src/_shims/node-runtime.ts +87 -0
  181. package/dist/src/_shims/node-types.d.ts +48 -0
  182. package/dist/src/_shims/node-types.js +9 -0
  183. package/dist/src/_shims/node-types.mjs +10 -0
  184. package/dist/src/_shims/registry.ts +73 -0
  185. package/dist/src/_shims/web-runtime.ts +109 -0
  186. package/dist/src/_shims/web-types.d.ts +89 -0
  187. package/dist/src/_shims/web-types.js +9 -0
  188. package/dist/src/_shims/web-types.mjs +10 -0
  189. package/dist/src/core.ts +1265 -0
  190. package/dist/src/error.ts +137 -0
  191. package/dist/src/index.ts +586 -0
  192. package/dist/src/internal/decoders/line.ts +182 -0
  193. package/dist/src/internal/qs/LICENSE.md +13 -0
  194. package/dist/src/internal/qs/README.md +3 -0
  195. package/dist/src/internal/qs/formats.ts +15 -0
  196. package/dist/src/internal/qs/index.ts +19 -0
  197. package/dist/src/internal/qs/stringify.ts +394 -0
  198. package/dist/src/internal/qs/types.ts +77 -0
  199. package/dist/src/internal/qs/utils.ts +271 -0
  200. package/dist/src/internal/stream-utils.ts +38 -0
  201. package/dist/src/lib/.keep +4 -0
  202. package/dist/src/lib/response-helpers.ts +60 -0
  203. package/dist/src/pagination.ts +134 -0
  204. package/dist/src/resource.ts +18 -0
  205. package/dist/src/resources/alpha/admin.ts +84 -0
  206. package/dist/src/resources/alpha/alpha.ts +93 -0
  207. package/dist/src/resources/alpha/benchmarks.ts +152 -0
  208. package/dist/src/resources/alpha/eval/eval.ts +255 -0
  209. package/dist/src/resources/alpha/eval/index.ts +19 -0
  210. package/dist/src/resources/alpha/eval/jobs.ts +41 -0
  211. package/dist/src/resources/alpha/eval.ts +10 -0
  212. package/dist/src/resources/alpha/index.ts +36 -0
  213. package/dist/src/resources/alpha/inference.ts +183 -0
  214. package/dist/src/resources/alpha/post-training/index.ts +17 -0
  215. package/dist/src/resources/alpha/post-training/job.ts +161 -0
  216. package/dist/src/resources/alpha/post-training/post-training.ts +385 -0
  217. package/dist/src/resources/alpha/post-training.ts +9 -0
  218. package/dist/src/resources/alpha.ts +9 -0
  219. package/dist/src/resources/batches.ts +572 -0
  220. package/dist/src/resources/beta/beta.ts +41 -0
  221. package/dist/src/resources/beta/datasets.ts +445 -0
  222. package/dist/src/resources/beta/index.ts +20 -0
  223. package/dist/src/resources/beta.ts +9 -0
  224. package/dist/src/resources/chat/chat.ts +348 -0
  225. package/dist/src/resources/chat/completions.ts +2934 -0
  226. package/dist/src/resources/chat/index.ts +19 -0
  227. package/dist/src/resources/chat.ts +9 -0
  228. package/dist/src/resources/completions.ts +344 -0
  229. package/dist/src/resources/conversations/conversations.ts +507 -0
  230. package/dist/src/resources/conversations/index.ts +25 -0
  231. package/dist/src/resources/conversations/items.ts +1590 -0
  232. package/dist/src/resources/conversations.ts +9 -0
  233. package/dist/src/resources/embeddings.ts +122 -0
  234. package/dist/src/resources/files.ts +211 -0
  235. package/dist/src/resources/index.ts +139 -0
  236. package/dist/src/resources/inspect.ts +27 -0
  237. package/dist/src/resources/models/index.ts +18 -0
  238. package/dist/src/resources/models/models.ts +194 -0
  239. package/dist/src/resources/models/openai.ts +22 -0
  240. package/dist/src/resources/models.ts +9 -0
  241. package/dist/src/resources/moderations.ts +94 -0
  242. package/dist/src/resources/prompts/index.ts +19 -0
  243. package/dist/src/resources/prompts/prompts.ts +185 -0
  244. package/dist/src/resources/prompts/versions.ts +24 -0
  245. package/dist/src/resources/prompts.ts +9 -0
  246. package/dist/src/resources/providers.ts +38 -0
  247. package/dist/src/resources/responses/index.ts +21 -0
  248. package/dist/src/resources/responses/input-items.ts +631 -0
  249. package/dist/src/resources/responses/responses.ts +4569 -0
  250. package/dist/src/resources/responses.ts +9 -0
  251. package/dist/src/resources/routes.ts +52 -0
  252. package/dist/src/resources/safety.ts +364 -0
  253. package/dist/src/resources/scoring-functions.ts +365 -0
  254. package/dist/src/resources/scoring.ts +221 -0
  255. package/dist/src/resources/shared.ts +559 -0
  256. package/dist/src/resources/shields.ts +119 -0
  257. package/dist/src/resources/tool-runtime.ts +217 -0
  258. package/dist/src/resources/toolgroups.ts +135 -0
  259. package/dist/src/resources/tools.ts +52 -0
  260. package/dist/src/resources/vector-io.ts +485 -0
  261. package/dist/src/resources/vector-stores/file-batches.ts +207 -0
  262. package/dist/src/resources/vector-stores/files.ts +378 -0
  263. package/dist/src/resources/vector-stores/index.ts +38 -0
  264. package/dist/src/resources/vector-stores/vector-stores.ts +476 -0
  265. package/dist/src/resources/vector-stores.ts +9 -0
  266. package/dist/src/resources.ts +7 -0
  267. package/dist/src/shims/node.ts +56 -0
  268. package/dist/src/shims/web.ts +56 -0
  269. package/dist/src/streaming.ts +297 -0
  270. package/dist/src/uploads.ts +261 -0
  271. package/dist/src/version.ts +7 -0
  272. package/dist/version.d.ts +2 -0
  273. package/dist/version.js +10 -0
  274. package/dist/version.mjs +7 -0
  275. package/examples/.keep +4 -0
  276. package/jest.config.ts +29 -0
  277. package/package.json +55 -35
  278. package/release-please-config.json +64 -0
  279. package/scripts/bootstrap +30 -0
  280. package/scripts/build +56 -0
  281. package/scripts/fast-format +40 -0
  282. package/scripts/format +8 -0
  283. package/scripts/lint +11 -0
  284. package/scripts/mock +41 -0
  285. package/scripts/test +56 -0
  286. package/scripts/utils/check-is-in-git-install.sh +15 -0
  287. package/scripts/utils/check-version.cjs +27 -0
  288. package/scripts/utils/fix-index-exports.cjs +21 -0
  289. package/scripts/utils/git-swap.sh +19 -0
  290. package/scripts/utils/make-dist-package-json.cjs +28 -0
  291. package/scripts/utils/postprocess-files.cjs +172 -0
  292. package/scripts/utils/upload-artifact.sh +33 -0
  293. package/src/_shims/auto/runtime-deno.ts +10 -0
  294. package/src/_shims/auto/types-deno.ts +10 -0
  295. package/src/_shims/auto/types.d.ts +18 -18
  296. package/src/_shims/index-deno.ts +118 -0
  297. package/src/_shims/index.d.ts +1 -1
  298. package/src/_shims/index.mjs +1 -1
  299. package/src/core.ts +6 -0
  300. package/src/resources/alpha/alpha.ts +8 -8
  301. package/src/resources/alpha/eval/eval.ts +28 -7
  302. package/src/resources/alpha/inference.ts +58 -7
  303. package/src/resources/alpha/post-training/index.ts +1 -9
  304. package/src/resources/alpha/post-training/job.ts +5 -21
  305. package/src/resources/alpha/post-training/post-training.ts +33 -20
  306. package/src/resources/beta/datasets.ts +14 -0
  307. package/src/resources/chat/chat.ts +118 -16
  308. package/src/resources/chat/completions.ts +1126 -67
  309. package/src/resources/completions.ts +133 -24
  310. package/src/resources/conversations/conversations.ts +30 -14
  311. package/src/resources/conversations/items.ts +361 -136
  312. package/src/resources/embeddings.ts +46 -8
  313. package/src/resources/files.ts +58 -31
  314. package/src/resources/models/models.ts +21 -6
  315. package/src/resources/moderations.ts +38 -5
  316. package/src/resources/prompts/prompts.ts +26 -12
  317. package/src/resources/prompts/versions.ts +0 -2
  318. package/src/resources/responses/input-items.ts +64 -13
  319. package/src/resources/responses/responses.ts +523 -252
  320. package/src/resources/safety.ts +131 -8
  321. package/src/resources/scoring-functions.ts +23 -1
  322. package/src/resources/scoring.ts +24 -0
  323. package/src/resources/shared.ts +53 -7
  324. package/src/resources/shields.ts +21 -0
  325. package/src/resources/vector-io.ts +95 -78
  326. package/src/resources/vector-stores/file-batches.ts +13 -7
  327. package/src/resources/vector-stores/files.ts +31 -11
  328. package/src/resources/vector-stores/vector-stores.ts +89 -15
  329. package/src/version.ts +1 -1
  330. package/tests/api-resources/alpha/admin.test.ts +111 -0
  331. package/tests/api-resources/alpha/benchmarks.test.ts +94 -0
  332. package/tests/api-resources/alpha/eval/eval.test.ts +206 -0
  333. package/tests/api-resources/alpha/eval/jobs.test.ts +68 -0
  334. package/tests/api-resources/alpha/inference.test.ts +38 -0
  335. package/tests/api-resources/alpha/post-training/job.test.ts +86 -0
  336. package/tests/api-resources/alpha/post-training/post-training.test.ts +134 -0
  337. package/tests/api-resources/batches.test.ts +100 -0
  338. package/tests/api-resources/beta/datasets.test.ts +141 -0
  339. package/tests/api-resources/chat/completions.test.ts +115 -0
  340. package/tests/api-resources/completions.test.ts +48 -0
  341. package/tests/api-resources/conversations/conversations.test.ts +76 -0
  342. package/tests/api-resources/conversations/items.test.ts +117 -0
  343. package/tests/api-resources/embeddings.test.ts +35 -0
  344. package/tests/api-resources/files.test.ts +123 -0
  345. package/tests/api-resources/inspect.test.ts +50 -0
  346. package/tests/api-resources/models/models.test.ts +89 -0
  347. package/tests/api-resources/models/openai.test.ts +32 -0
  348. package/tests/api-resources/moderations.test.ts +29 -0
  349. package/tests/api-resources/prompts/prompts.test.ts +125 -0
  350. package/tests/api-resources/prompts/versions.test.ts +32 -0
  351. package/tests/api-resources/providers.test.ts +50 -0
  352. package/tests/api-resources/responses/input-items.test.ts +49 -0
  353. package/tests/api-resources/responses/responses.test.ts +132 -0
  354. package/tests/api-resources/routes.test.ts +39 -0
  355. package/tests/api-resources/safety.test.ts +41 -0
  356. package/tests/api-resources/scoring-functions.test.ts +100 -0
  357. package/tests/api-resources/scoring.test.ts +73 -0
  358. package/tests/api-resources/shields.test.ts +88 -0
  359. package/tests/api-resources/tool-runtime.test.ts +68 -0
  360. package/tests/api-resources/toolgroups.test.ts +91 -0
  361. package/tests/api-resources/tools.test.ts +57 -0
  362. package/tests/api-resources/vector-io.test.ts +84 -0
  363. package/tests/api-resources/vector-stores/file-batches.test.ts +113 -0
  364. package/tests/api-resources/vector-stores/files.test.ts +153 -0
  365. package/tests/api-resources/vector-stores/vector-stores.test.ts +134 -0
  366. package/tests/form.test.ts +71 -0
  367. package/tests/index.test.ts +438 -0
  368. package/tests/internal/decoders/line.test.ts +134 -0
  369. package/tests/qs/empty-keys-cases.ts +277 -0
  370. package/tests/qs/stringify.test.ts +2238 -0
  371. package/tests/qs/utils.test.ts +175 -0
  372. package/tests/responses.test.ts +91 -0
  373. package/tests/streaming.test.ts +250 -0
  374. package/tests/stringifyQuery.test.ts +29 -0
  375. package/tests/uploads.test.ts +71 -0
  376. package/tsc-multi.json +7 -0
  377. package/tsconfig.build.json +18 -0
  378. package/tsconfig.deno.json +15 -0
  379. package/tsconfig.dist-src.json +11 -0
  380. package/tsconfig.json +38 -0
  381. package/core.d.ts.map +0 -1
  382. package/core.js +0 -940
  383. package/core.js.map +0 -1
  384. package/core.mjs +0 -908
  385. package/core.mjs.map +0 -1
  386. package/resources/alpha/alpha.d.ts +0 -26
  387. package/resources/alpha/alpha.d.ts.map +0 -1
  388. package/resources/alpha/alpha.js +0 -61
  389. package/resources/alpha/alpha.js.map +0 -1
  390. package/resources/alpha/alpha.mjs +0 -34
  391. package/resources/alpha/alpha.mjs.map +0 -1
  392. package/resources/alpha/eval/eval.d.ts +0 -160
  393. package/resources/alpha/eval/eval.d.ts.map +0 -1
  394. package/resources/alpha/eval/eval.js.map +0 -1
  395. package/resources/alpha/eval/eval.mjs.map +0 -1
  396. package/resources/alpha/inference.d.ts +0 -85
  397. package/resources/alpha/inference.d.ts.map +0 -1
  398. package/resources/alpha/post-training/index.d.ts +0 -3
  399. package/resources/alpha/post-training/index.d.ts.map +0 -1
  400. package/resources/alpha/post-training/index.js.map +0 -1
  401. package/resources/alpha/post-training/index.mjs +0 -10
  402. package/resources/alpha/post-training/index.mjs.map +0 -1
  403. package/resources/alpha/post-training/job.d.ts +0 -113
  404. package/resources/alpha/post-training/job.d.ts.map +0 -1
  405. package/resources/alpha/post-training/job.js +0 -43
  406. package/resources/alpha/post-training/job.js.map +0 -1
  407. package/resources/alpha/post-training/job.mjs +0 -39
  408. package/resources/alpha/post-training/job.mjs.map +0 -1
  409. package/resources/alpha/post-training/post-training.d.ts +0 -245
  410. package/resources/alpha/post-training/post-training.d.ts.map +0 -1
  411. package/resources/alpha/post-training/post-training.js.map +0 -1
  412. package/resources/alpha/post-training/post-training.mjs +0 -30
  413. package/resources/alpha/post-training/post-training.mjs.map +0 -1
  414. package/resources/beta/datasets.d.ts +0 -338
  415. package/resources/beta/datasets.d.ts.map +0 -1
  416. package/resources/chat/chat.d.ts +0 -172
  417. package/resources/chat/chat.d.ts.map +0 -1
  418. package/resources/chat/chat.js.map +0 -1
  419. package/resources/chat/chat.mjs.map +0 -1
  420. package/resources/chat/completions.d.ts +0 -1356
  421. package/resources/chat/completions.d.ts.map +0 -1
  422. package/resources/chat/completions.js +0 -33
  423. package/resources/chat/completions.js.map +0 -1
  424. package/resources/chat/completions.mjs +0 -29
  425. package/resources/chat/completions.mjs.map +0 -1
  426. package/resources/completions.d.ts +0 -158
  427. package/resources/completions.d.ts.map +0 -1
  428. package/resources/completions.js.map +0 -1
  429. package/resources/completions.mjs.map +0 -1
  430. package/resources/conversations/conversations.d.ts +0 -320
  431. package/resources/conversations/conversations.d.ts.map +0 -1
  432. package/resources/conversations/conversations.js +0 -78
  433. package/resources/conversations/conversations.js.map +0 -1
  434. package/resources/conversations/conversations.mjs +0 -51
  435. package/resources/conversations/conversations.mjs.map +0 -1
  436. package/resources/conversations/items.d.ts +0 -874
  437. package/resources/conversations/items.d.ts.map +0 -1
  438. package/resources/conversations/items.js +0 -51
  439. package/resources/conversations/items.js.map +0 -1
  440. package/resources/conversations/items.mjs +0 -46
  441. package/resources/conversations/items.mjs.map +0 -1
  442. package/resources/embeddings.d.ts +0 -52
  443. package/resources/embeddings.d.ts.map +0 -1
  444. package/resources/embeddings.js +0 -24
  445. package/resources/embeddings.js.map +0 -1
  446. package/resources/embeddings.mjs +0 -20
  447. package/resources/embeddings.mjs.map +0 -1
  448. package/resources/files.d.ts +0 -120
  449. package/resources/files.d.ts.map +0 -1
  450. package/resources/files.js +0 -87
  451. package/resources/files.js.map +0 -1
  452. package/resources/files.mjs +0 -59
  453. package/resources/files.mjs.map +0 -1
  454. package/resources/models/models.d.ts +0 -127
  455. package/resources/models/models.d.ts.map +0 -1
  456. package/resources/models/models.js +0 -82
  457. package/resources/models/models.js.map +0 -1
  458. package/resources/models/models.mjs +0 -55
  459. package/resources/models/models.mjs.map +0 -1
  460. package/resources/moderations.d.ts +0 -47
  461. package/resources/moderations.d.ts.map +0 -1
  462. package/resources/moderations.js +0 -23
  463. package/resources/moderations.js.map +0 -1
  464. package/resources/moderations.mjs +0 -19
  465. package/resources/moderations.mjs.map +0 -1
  466. package/resources/prompts/prompts.d.ts +0 -96
  467. package/resources/prompts/prompts.d.ts.map +0 -1
  468. package/resources/prompts/prompts.js +0 -93
  469. package/resources/prompts/prompts.js.map +0 -1
  470. package/resources/prompts/prompts.mjs +0 -66
  471. package/resources/prompts/prompts.mjs.map +0 -1
  472. package/resources/prompts/versions.d.ts +0 -12
  473. package/resources/prompts/versions.d.ts.map +0 -1
  474. package/resources/prompts/versions.js +0 -23
  475. package/resources/prompts/versions.js.map +0 -1
  476. package/resources/prompts/versions.mjs +0 -19
  477. package/resources/prompts/versions.mjs.map +0 -1
  478. package/resources/responses/input-items.d.ts +0 -367
  479. package/resources/responses/input-items.d.ts.map +0 -1
  480. package/resources/responses/responses.d.ts +0 -2871
  481. package/resources/responses/responses.d.ts.map +0 -1
  482. package/resources/responses/responses.js.map +0 -1
  483. package/resources/responses/responses.mjs.map +0 -1
  484. package/resources/safety.d.ts +0 -172
  485. package/resources/safety.d.ts.map +0 -1
  486. package/resources/safety.js +0 -23
  487. package/resources/safety.js.map +0 -1
  488. package/resources/safety.mjs +0 -19
  489. package/resources/safety.mjs.map +0 -1
  490. package/resources/scoring-functions.d.ts +0 -210
  491. package/resources/scoring-functions.d.ts.map +0 -1
  492. package/resources/scoring.d.ts +0 -133
  493. package/resources/scoring.d.ts.map +0 -1
  494. package/resources/shared.d.ts +0 -418
  495. package/resources/shared.d.ts.map +0 -1
  496. package/resources/shields.d.ts +0 -61
  497. package/resources/shields.d.ts.map +0 -1
  498. package/resources/vector-io.d.ts +0 -358
  499. package/resources/vector-io.d.ts.map +0 -1
  500. package/resources/vector-io.js +0 -31
  501. package/resources/vector-io.mjs +0 -27
  502. package/resources/vector-stores/file-batches.d.ts +0 -111
  503. package/resources/vector-stores/file-batches.d.ts.map +0 -1
  504. package/resources/vector-stores/file-batches.js +0 -45
  505. package/resources/vector-stores/file-batches.js.map +0 -1
  506. package/resources/vector-stores/file-batches.mjs +0 -41
  507. package/resources/vector-stores/file-batches.mjs.map +0 -1
  508. package/resources/vector-stores/files.d.ts +0 -213
  509. package/resources/vector-stores/files.d.ts.map +0 -1
  510. package/resources/vector-stores/files.js +0 -60
  511. package/resources/vector-stores/files.js.map +0 -1
  512. package/resources/vector-stores/files.mjs +0 -55
  513. package/resources/vector-stores/files.mjs.map +0 -1
  514. package/resources/vector-stores/vector-stores.d.ts +0 -248
  515. package/resources/vector-stores/vector-stores.d.ts.map +0 -1
  516. package/resources/vector-stores/vector-stores.js +0 -97
  517. package/resources/vector-stores/vector-stores.js.map +0 -1
  518. package/resources/vector-stores/vector-stores.mjs +0 -69
  519. package/resources/vector-stores/vector-stores.mjs.map +0 -1
  520. package/version.d.ts +0 -2
  521. package/version.js +0 -10
  522. package/version.mjs +0 -7
  523. /package/{_shims → dist/_shims}/MultipartBody.d.ts +0 -0
  524. /package/{_shims → dist/_shims}/MultipartBody.d.ts.map +0 -0
  525. /package/{_shims → dist/_shims}/MultipartBody.js +0 -0
  526. /package/{_shims → dist/_shims}/MultipartBody.js.map +0 -0
  527. /package/{_shims → dist/_shims}/MultipartBody.mjs +0 -0
  528. /package/{_shims → dist/_shims}/MultipartBody.mjs.map +0 -0
  529. /package/{_shims → dist/_shims}/README.md +0 -0
  530. /package/{_shims → dist/_shims}/auto/runtime-bun.d.ts +0 -0
  531. /package/{_shims → dist/_shims}/auto/runtime-bun.d.ts.map +0 -0
  532. /package/{_shims → dist/_shims}/auto/runtime-bun.js +0 -0
  533. /package/{_shims → dist/_shims}/auto/runtime-bun.js.map +0 -0
  534. /package/{_shims → dist/_shims}/auto/runtime-bun.mjs +0 -0
  535. /package/{_shims → dist/_shims}/auto/runtime-bun.mjs.map +0 -0
  536. /package/{_shims → dist/_shims}/auto/runtime-node.d.ts +0 -0
  537. /package/{_shims → dist/_shims}/auto/runtime-node.d.ts.map +0 -0
  538. /package/{_shims → dist/_shims}/auto/runtime-node.js +0 -0
  539. /package/{_shims → dist/_shims}/auto/runtime-node.js.map +0 -0
  540. /package/{_shims → dist/_shims}/auto/runtime-node.mjs +0 -0
  541. /package/{_shims → dist/_shims}/auto/runtime-node.mjs.map +0 -0
  542. /package/{_shims → dist/_shims}/auto/runtime.d.ts +0 -0
  543. /package/{_shims → dist/_shims}/auto/runtime.d.ts.map +0 -0
  544. /package/{_shims → dist/_shims}/auto/runtime.js +0 -0
  545. /package/{_shims → dist/_shims}/auto/runtime.js.map +0 -0
  546. /package/{_shims → dist/_shims}/auto/runtime.mjs +0 -0
  547. /package/{_shims → dist/_shims}/auto/runtime.mjs.map +0 -0
  548. /package/{_shims → dist/_shims}/auto/types-node.d.ts +0 -0
  549. /package/{_shims → dist/_shims}/auto/types-node.d.ts.map +0 -0
  550. /package/{_shims → dist/_shims}/auto/types-node.js +0 -0
  551. /package/{_shims → dist/_shims}/auto/types-node.js.map +0 -0
  552. /package/{_shims → dist/_shims}/auto/types-node.mjs +0 -0
  553. /package/{_shims → dist/_shims}/auto/types-node.mjs.map +0 -0
  554. /package/{_shims → dist/_shims}/auto/types.d.ts +0 -0
  555. /package/{_shims → dist/_shims}/auto/types.js +0 -0
  556. /package/{_shims → dist/_shims}/auto/types.mjs +0 -0
  557. /package/{_shims → dist/_shims}/bun-runtime.d.ts +0 -0
  558. /package/{_shims → dist/_shims}/bun-runtime.d.ts.map +0 -0
  559. /package/{_shims → dist/_shims}/bun-runtime.js +0 -0
  560. /package/{_shims → dist/_shims}/bun-runtime.js.map +0 -0
  561. /package/{_shims → dist/_shims}/bun-runtime.mjs +0 -0
  562. /package/{_shims → dist/_shims}/bun-runtime.mjs.map +0 -0
  563. /package/{_shims → dist/_shims}/index.d.ts +0 -0
  564. /package/{_shims → dist/_shims}/index.js +0 -0
  565. /package/{_shims → dist/_shims}/index.mjs +0 -0
  566. /package/{_shims → dist/_shims}/manual-types.d.ts +0 -0
  567. /package/{_shims → dist/_shims}/manual-types.js +0 -0
  568. /package/{_shims → dist/_shims}/manual-types.mjs +0 -0
  569. /package/{_shims → dist/_shims}/node-runtime.d.ts +0 -0
  570. /package/{_shims → dist/_shims}/node-runtime.d.ts.map +0 -0
  571. /package/{_shims → dist/_shims}/node-runtime.js +0 -0
  572. /package/{_shims → dist/_shims}/node-runtime.js.map +0 -0
  573. /package/{_shims → dist/_shims}/node-runtime.mjs +0 -0
  574. /package/{_shims → dist/_shims}/node-runtime.mjs.map +0 -0
  575. /package/{_shims → dist/_shims}/node-types.d.ts +0 -0
  576. /package/{_shims → dist/_shims}/node-types.js +0 -0
  577. /package/{_shims → dist/_shims}/node-types.mjs +0 -0
  578. /package/{_shims → dist/_shims}/registry.d.ts +0 -0
  579. /package/{_shims → dist/_shims}/registry.d.ts.map +0 -0
  580. /package/{_shims → dist/_shims}/registry.js +0 -0
  581. /package/{_shims → dist/_shims}/registry.js.map +0 -0
  582. /package/{_shims → dist/_shims}/registry.mjs +0 -0
  583. /package/{_shims → dist/_shims}/registry.mjs.map +0 -0
  584. /package/{_shims → dist/_shims}/web-runtime.d.ts +0 -0
  585. /package/{_shims → dist/_shims}/web-runtime.d.ts.map +0 -0
  586. /package/{_shims → dist/_shims}/web-runtime.js +0 -0
  587. /package/{_shims → dist/_shims}/web-runtime.js.map +0 -0
  588. /package/{_shims → dist/_shims}/web-runtime.mjs +0 -0
  589. /package/{_shims → dist/_shims}/web-runtime.mjs.map +0 -0
  590. /package/{_shims → dist/_shims}/web-types.d.ts +0 -0
  591. /package/{_shims → dist/_shims}/web-types.js +0 -0
  592. /package/{_shims → dist/_shims}/web-types.mjs +0 -0
  593. /package/{core.d.ts → dist/core.d.ts} +0 -0
  594. /package/{error.d.ts → dist/error.d.ts} +0 -0
  595. /package/{error.d.ts.map → dist/error.d.ts.map} +0 -0
  596. /package/{error.js → dist/error.js} +0 -0
  597. /package/{error.js.map → dist/error.js.map} +0 -0
  598. /package/{error.mjs → dist/error.mjs} +0 -0
  599. /package/{error.mjs.map → dist/error.mjs.map} +0 -0
  600. /package/{index.d.mts → dist/index.d.mts} +0 -0
  601. /package/{index.d.ts → dist/index.d.ts} +0 -0
  602. /package/{index.d.ts.map → dist/index.d.ts.map} +0 -0
  603. /package/{index.js → dist/index.js} +0 -0
  604. /package/{index.js.map → dist/index.js.map} +0 -0
  605. /package/{index.mjs → dist/index.mjs} +0 -0
  606. /package/{index.mjs.map → dist/index.mjs.map} +0 -0
  607. /package/{internal → dist/internal}/decoders/line.d.ts +0 -0
  608. /package/{internal → dist/internal}/decoders/line.d.ts.map +0 -0
  609. /package/{internal → dist/internal}/decoders/line.js +0 -0
  610. /package/{internal → dist/internal}/decoders/line.js.map +0 -0
  611. /package/{internal → dist/internal}/decoders/line.mjs +0 -0
  612. /package/{internal → dist/internal}/decoders/line.mjs.map +0 -0
  613. /package/{internal → dist/internal}/qs/formats.d.ts +0 -0
  614. /package/{internal → dist/internal}/qs/formats.d.ts.map +0 -0
  615. /package/{internal → dist/internal}/qs/formats.js +0 -0
  616. /package/{internal → dist/internal}/qs/formats.js.map +0 -0
  617. /package/{internal → dist/internal}/qs/formats.mjs +0 -0
  618. /package/{internal → dist/internal}/qs/formats.mjs.map +0 -0
  619. /package/{internal → dist/internal}/qs/index.d.ts +0 -0
  620. /package/{internal → dist/internal}/qs/index.d.ts.map +0 -0
  621. /package/{internal → dist/internal}/qs/index.js +0 -0
  622. /package/{internal → dist/internal}/qs/index.js.map +0 -0
  623. /package/{internal → dist/internal}/qs/index.mjs +0 -0
  624. /package/{internal → dist/internal}/qs/index.mjs.map +0 -0
  625. /package/{internal → dist/internal}/qs/stringify.d.ts +0 -0
  626. /package/{internal → dist/internal}/qs/stringify.d.ts.map +0 -0
  627. /package/{internal → dist/internal}/qs/stringify.js +0 -0
  628. /package/{internal → dist/internal}/qs/stringify.js.map +0 -0
  629. /package/{internal → dist/internal}/qs/stringify.mjs +0 -0
  630. /package/{internal → dist/internal}/qs/stringify.mjs.map +0 -0
  631. /package/{internal → dist/internal}/qs/types.d.ts +0 -0
  632. /package/{internal → dist/internal}/qs/types.d.ts.map +0 -0
  633. /package/{internal → dist/internal}/qs/types.js +0 -0
  634. /package/{internal → dist/internal}/qs/types.js.map +0 -0
  635. /package/{internal → dist/internal}/qs/types.mjs +0 -0
  636. /package/{internal → dist/internal}/qs/types.mjs.map +0 -0
  637. /package/{internal → dist/internal}/qs/utils.d.ts +0 -0
  638. /package/{internal → dist/internal}/qs/utils.d.ts.map +0 -0
  639. /package/{internal → dist/internal}/qs/utils.js +0 -0
  640. /package/{internal → dist/internal}/qs/utils.js.map +0 -0
  641. /package/{internal → dist/internal}/qs/utils.mjs +0 -0
  642. /package/{internal → dist/internal}/qs/utils.mjs.map +0 -0
  643. /package/{internal → dist/internal}/stream-utils.d.ts +0 -0
  644. /package/{internal → dist/internal}/stream-utils.d.ts.map +0 -0
  645. /package/{internal → dist/internal}/stream-utils.js +0 -0
  646. /package/{internal → dist/internal}/stream-utils.js.map +0 -0
  647. /package/{internal → dist/internal}/stream-utils.mjs +0 -0
  648. /package/{internal → dist/internal}/stream-utils.mjs.map +0 -0
  649. /package/{lib → dist/lib}/response-helpers.d.ts +0 -0
  650. /package/{lib → dist/lib}/response-helpers.d.ts.map +0 -0
  651. /package/{lib → dist/lib}/response-helpers.js +0 -0
  652. /package/{lib → dist/lib}/response-helpers.js.map +0 -0
  653. /package/{lib → dist/lib}/response-helpers.mjs +0 -0
  654. /package/{lib → dist/lib}/response-helpers.mjs.map +0 -0
  655. /package/{pagination.d.ts → dist/pagination.d.ts} +0 -0
  656. /package/{pagination.d.ts.map → dist/pagination.d.ts.map} +0 -0
  657. /package/{pagination.js → dist/pagination.js} +0 -0
  658. /package/{pagination.js.map → dist/pagination.js.map} +0 -0
  659. /package/{pagination.mjs → dist/pagination.mjs} +0 -0
  660. /package/{pagination.mjs.map → dist/pagination.mjs.map} +0 -0
  661. /package/{resource.d.ts → dist/resource.d.ts} +0 -0
  662. /package/{resource.d.ts.map → dist/resource.d.ts.map} +0 -0
  663. /package/{resource.js → dist/resource.js} +0 -0
  664. /package/{resource.js.map → dist/resource.js.map} +0 -0
  665. /package/{resource.mjs → dist/resource.mjs} +0 -0
  666. /package/{resource.mjs.map → dist/resource.mjs.map} +0 -0
  667. /package/{resources → dist/resources}/alpha/admin.d.ts +0 -0
  668. /package/{resources → dist/resources}/alpha/admin.d.ts.map +0 -0
  669. /package/{resources → dist/resources}/alpha/admin.js +0 -0
  670. /package/{resources → dist/resources}/alpha/admin.js.map +0 -0
  671. /package/{resources → dist/resources}/alpha/admin.mjs +0 -0
  672. /package/{resources → dist/resources}/alpha/admin.mjs.map +0 -0
  673. /package/{resources → dist/resources}/alpha/benchmarks.d.ts +0 -0
  674. /package/{resources → dist/resources}/alpha/benchmarks.d.ts.map +0 -0
  675. /package/{resources → dist/resources}/alpha/benchmarks.js +0 -0
  676. /package/{resources → dist/resources}/alpha/benchmarks.js.map +0 -0
  677. /package/{resources → dist/resources}/alpha/benchmarks.mjs +0 -0
  678. /package/{resources → dist/resources}/alpha/benchmarks.mjs.map +0 -0
  679. /package/{resources → dist/resources}/alpha/eval/eval.js +0 -0
  680. /package/{resources → dist/resources}/alpha/eval/eval.mjs +0 -0
  681. /package/{resources → dist/resources}/alpha/eval/index.d.ts +0 -0
  682. /package/{resources → dist/resources}/alpha/eval/index.d.ts.map +0 -0
  683. /package/{resources → dist/resources}/alpha/eval/index.js +0 -0
  684. /package/{resources → dist/resources}/alpha/eval/index.js.map +0 -0
  685. /package/{resources → dist/resources}/alpha/eval/index.mjs +0 -0
  686. /package/{resources → dist/resources}/alpha/eval/index.mjs.map +0 -0
  687. /package/{resources → dist/resources}/alpha/eval/jobs.d.ts +0 -0
  688. /package/{resources → dist/resources}/alpha/eval/jobs.d.ts.map +0 -0
  689. /package/{resources → dist/resources}/alpha/eval/jobs.js +0 -0
  690. /package/{resources → dist/resources}/alpha/eval/jobs.js.map +0 -0
  691. /package/{resources → dist/resources}/alpha/eval/jobs.mjs +0 -0
  692. /package/{resources → dist/resources}/alpha/eval/jobs.mjs.map +0 -0
  693. /package/{resources → dist/resources}/alpha/eval.d.ts +0 -0
  694. /package/{resources → dist/resources}/alpha/eval.d.ts.map +0 -0
  695. /package/{resources → dist/resources}/alpha/eval.js +0 -0
  696. /package/{resources → dist/resources}/alpha/eval.js.map +0 -0
  697. /package/{resources → dist/resources}/alpha/eval.mjs +0 -0
  698. /package/{resources → dist/resources}/alpha/eval.mjs.map +0 -0
  699. /package/{resources → dist/resources}/alpha/index.d.ts +0 -0
  700. /package/{resources → dist/resources}/alpha/index.d.ts.map +0 -0
  701. /package/{resources → dist/resources}/alpha/index.js +0 -0
  702. /package/{resources → dist/resources}/alpha/index.js.map +0 -0
  703. /package/{resources → dist/resources}/alpha/index.mjs +0 -0
  704. /package/{resources → dist/resources}/alpha/index.mjs.map +0 -0
  705. /package/{resources → dist/resources}/alpha/inference.js +0 -0
  706. /package/{resources → dist/resources}/alpha/inference.js.map +0 -0
  707. /package/{resources → dist/resources}/alpha/inference.mjs +0 -0
  708. /package/{resources → dist/resources}/alpha/inference.mjs.map +0 -0
  709. /package/{resources → dist/resources}/alpha/post-training/index.js +0 -0
  710. /package/{resources → dist/resources}/alpha/post-training/post-training.js +0 -0
  711. /package/{resources → dist/resources}/alpha/post-training.d.ts +0 -0
  712. /package/{resources → dist/resources}/alpha/post-training.d.ts.map +0 -0
  713. /package/{resources → dist/resources}/alpha/post-training.js +0 -0
  714. /package/{resources → dist/resources}/alpha/post-training.js.map +0 -0
  715. /package/{resources → dist/resources}/alpha/post-training.mjs +0 -0
  716. /package/{resources → dist/resources}/alpha/post-training.mjs.map +0 -0
  717. /package/{resources → dist/resources}/alpha.d.ts +0 -0
  718. /package/{resources → dist/resources}/alpha.d.ts.map +0 -0
  719. /package/{resources → dist/resources}/alpha.js +0 -0
  720. /package/{resources → dist/resources}/alpha.js.map +0 -0
  721. /package/{resources → dist/resources}/alpha.mjs +0 -0
  722. /package/{resources → dist/resources}/alpha.mjs.map +0 -0
  723. /package/{resources → dist/resources}/batches.d.ts +0 -0
  724. /package/{resources → dist/resources}/batches.d.ts.map +0 -0
  725. /package/{resources → dist/resources}/batches.js +0 -0
  726. /package/{resources → dist/resources}/batches.js.map +0 -0
  727. /package/{resources → dist/resources}/batches.mjs +0 -0
  728. /package/{resources → dist/resources}/batches.mjs.map +0 -0
  729. /package/{resources → dist/resources}/beta/beta.d.ts +0 -0
  730. /package/{resources → dist/resources}/beta/beta.d.ts.map +0 -0
  731. /package/{resources → dist/resources}/beta/beta.js +0 -0
  732. /package/{resources → dist/resources}/beta/beta.js.map +0 -0
  733. /package/{resources → dist/resources}/beta/beta.mjs +0 -0
  734. /package/{resources → dist/resources}/beta/beta.mjs.map +0 -0
  735. /package/{resources → dist/resources}/beta/datasets.js +0 -0
  736. /package/{resources → dist/resources}/beta/datasets.js.map +0 -0
  737. /package/{resources → dist/resources}/beta/datasets.mjs +0 -0
  738. /package/{resources → dist/resources}/beta/datasets.mjs.map +0 -0
  739. /package/{resources → dist/resources}/beta/index.d.ts +0 -0
  740. /package/{resources → dist/resources}/beta/index.d.ts.map +0 -0
  741. /package/{resources → dist/resources}/beta/index.js +0 -0
  742. /package/{resources → dist/resources}/beta/index.js.map +0 -0
  743. /package/{resources → dist/resources}/beta/index.mjs +0 -0
  744. /package/{resources → dist/resources}/beta/index.mjs.map +0 -0
  745. /package/{resources → dist/resources}/beta.d.ts +0 -0
  746. /package/{resources → dist/resources}/beta.d.ts.map +0 -0
  747. /package/{resources → dist/resources}/beta.js +0 -0
  748. /package/{resources → dist/resources}/beta.js.map +0 -0
  749. /package/{resources → dist/resources}/beta.mjs +0 -0
  750. /package/{resources → dist/resources}/beta.mjs.map +0 -0
  751. /package/{resources → dist/resources}/chat/chat.js +0 -0
  752. /package/{resources → dist/resources}/chat/chat.mjs +0 -0
  753. /package/{resources → dist/resources}/chat/index.d.ts +0 -0
  754. /package/{resources → dist/resources}/chat/index.d.ts.map +0 -0
  755. /package/{resources → dist/resources}/chat/index.js +0 -0
  756. /package/{resources → dist/resources}/chat/index.js.map +0 -0
  757. /package/{resources → dist/resources}/chat/index.mjs +0 -0
  758. /package/{resources → dist/resources}/chat/index.mjs.map +0 -0
  759. /package/{resources → dist/resources}/chat.d.ts +0 -0
  760. /package/{resources → dist/resources}/chat.d.ts.map +0 -0
  761. /package/{resources → dist/resources}/chat.js +0 -0
  762. /package/{resources → dist/resources}/chat.js.map +0 -0
  763. /package/{resources → dist/resources}/chat.mjs +0 -0
  764. /package/{resources → dist/resources}/chat.mjs.map +0 -0
  765. /package/{resources → dist/resources}/completions.js +0 -0
  766. /package/{resources → dist/resources}/completions.mjs +0 -0
  767. /package/{resources → dist/resources}/conversations/index.d.ts +0 -0
  768. /package/{resources → dist/resources}/conversations/index.d.ts.map +0 -0
  769. /package/{resources → dist/resources}/conversations/index.js +0 -0
  770. /package/{resources → dist/resources}/conversations/index.js.map +0 -0
  771. /package/{resources → dist/resources}/conversations/index.mjs +0 -0
  772. /package/{resources → dist/resources}/conversations/index.mjs.map +0 -0
  773. /package/{resources → dist/resources}/conversations.d.ts +0 -0
  774. /package/{resources → dist/resources}/conversations.d.ts.map +0 -0
  775. /package/{resources → dist/resources}/conversations.js +0 -0
  776. /package/{resources → dist/resources}/conversations.js.map +0 -0
  777. /package/{resources → dist/resources}/conversations.mjs +0 -0
  778. /package/{resources → dist/resources}/conversations.mjs.map +0 -0
  779. /package/{resources → dist/resources}/index.d.ts +0 -0
  780. /package/{resources → dist/resources}/index.d.ts.map +0 -0
  781. /package/{resources → dist/resources}/index.js +0 -0
  782. /package/{resources → dist/resources}/index.js.map +0 -0
  783. /package/{resources → dist/resources}/index.mjs +0 -0
  784. /package/{resources → dist/resources}/index.mjs.map +0 -0
  785. /package/{resources → dist/resources}/inspect.d.ts +0 -0
  786. /package/{resources → dist/resources}/inspect.d.ts.map +0 -0
  787. /package/{resources → dist/resources}/inspect.js +0 -0
  788. /package/{resources → dist/resources}/inspect.js.map +0 -0
  789. /package/{resources → dist/resources}/inspect.mjs +0 -0
  790. /package/{resources → dist/resources}/inspect.mjs.map +0 -0
  791. /package/{resources → dist/resources}/models/index.d.ts +0 -0
  792. /package/{resources → dist/resources}/models/index.d.ts.map +0 -0
  793. /package/{resources → dist/resources}/models/index.js +0 -0
  794. /package/{resources → dist/resources}/models/index.js.map +0 -0
  795. /package/{resources → dist/resources}/models/index.mjs +0 -0
  796. /package/{resources → dist/resources}/models/index.mjs.map +0 -0
  797. /package/{resources → dist/resources}/models/openai.d.ts +0 -0
  798. /package/{resources → dist/resources}/models/openai.d.ts.map +0 -0
  799. /package/{resources → dist/resources}/models/openai.js +0 -0
  800. /package/{resources → dist/resources}/models/openai.js.map +0 -0
  801. /package/{resources → dist/resources}/models/openai.mjs +0 -0
  802. /package/{resources → dist/resources}/models/openai.mjs.map +0 -0
  803. /package/{resources → dist/resources}/models.d.ts +0 -0
  804. /package/{resources → dist/resources}/models.d.ts.map +0 -0
  805. /package/{resources → dist/resources}/models.js +0 -0
  806. /package/{resources → dist/resources}/models.js.map +0 -0
  807. /package/{resources → dist/resources}/models.mjs +0 -0
  808. /package/{resources → dist/resources}/models.mjs.map +0 -0
  809. /package/{resources → dist/resources}/prompts/index.d.ts +0 -0
  810. /package/{resources → dist/resources}/prompts/index.d.ts.map +0 -0
  811. /package/{resources → dist/resources}/prompts/index.js +0 -0
  812. /package/{resources → dist/resources}/prompts/index.js.map +0 -0
  813. /package/{resources → dist/resources}/prompts/index.mjs +0 -0
  814. /package/{resources → dist/resources}/prompts/index.mjs.map +0 -0
  815. /package/{resources → dist/resources}/prompts.d.ts +0 -0
  816. /package/{resources → dist/resources}/prompts.d.ts.map +0 -0
  817. /package/{resources → dist/resources}/prompts.js +0 -0
  818. /package/{resources → dist/resources}/prompts.js.map +0 -0
  819. /package/{resources → dist/resources}/prompts.mjs +0 -0
  820. /package/{resources → dist/resources}/prompts.mjs.map +0 -0
  821. /package/{resources → dist/resources}/providers.d.ts +0 -0
  822. /package/{resources → dist/resources}/providers.d.ts.map +0 -0
  823. /package/{resources → dist/resources}/providers.js +0 -0
  824. /package/{resources → dist/resources}/providers.js.map +0 -0
  825. /package/{resources → dist/resources}/providers.mjs +0 -0
  826. /package/{resources → dist/resources}/providers.mjs.map +0 -0
  827. /package/{resources → dist/resources}/responses/index.d.ts +0 -0
  828. /package/{resources → dist/resources}/responses/index.d.ts.map +0 -0
  829. /package/{resources → dist/resources}/responses/index.js +0 -0
  830. /package/{resources → dist/resources}/responses/index.js.map +0 -0
  831. /package/{resources → dist/resources}/responses/index.mjs +0 -0
  832. /package/{resources → dist/resources}/responses/index.mjs.map +0 -0
  833. /package/{resources → dist/resources}/responses/input-items.js +0 -0
  834. /package/{resources → dist/resources}/responses/input-items.js.map +0 -0
  835. /package/{resources → dist/resources}/responses/input-items.mjs +0 -0
  836. /package/{resources → dist/resources}/responses/input-items.mjs.map +0 -0
  837. /package/{resources → dist/resources}/responses/responses.js +0 -0
  838. /package/{resources → dist/resources}/responses/responses.mjs +0 -0
  839. /package/{resources → dist/resources}/responses.d.ts +0 -0
  840. /package/{resources → dist/resources}/responses.d.ts.map +0 -0
  841. /package/{resources → dist/resources}/responses.js +0 -0
  842. /package/{resources → dist/resources}/responses.js.map +0 -0
  843. /package/{resources → dist/resources}/responses.mjs +0 -0
  844. /package/{resources → dist/resources}/responses.mjs.map +0 -0
  845. /package/{resources → dist/resources}/routes.d.ts +0 -0
  846. /package/{resources → dist/resources}/routes.d.ts.map +0 -0
  847. /package/{resources → dist/resources}/routes.js +0 -0
  848. /package/{resources → dist/resources}/routes.js.map +0 -0
  849. /package/{resources → dist/resources}/routes.mjs +0 -0
  850. /package/{resources → dist/resources}/routes.mjs.map +0 -0
  851. /package/{resources → dist/resources}/scoring-functions.js +0 -0
  852. /package/{resources → dist/resources}/scoring-functions.js.map +0 -0
  853. /package/{resources → dist/resources}/scoring-functions.mjs +0 -0
  854. /package/{resources → dist/resources}/scoring-functions.mjs.map +0 -0
  855. /package/{resources → dist/resources}/scoring.js +0 -0
  856. /package/{resources → dist/resources}/scoring.js.map +0 -0
  857. /package/{resources → dist/resources}/scoring.mjs +0 -0
  858. /package/{resources → dist/resources}/scoring.mjs.map +0 -0
  859. /package/{resources → dist/resources}/shared.js +0 -0
  860. /package/{resources → dist/resources}/shared.js.map +0 -0
  861. /package/{resources → dist/resources}/shared.mjs +0 -0
  862. /package/{resources → dist/resources}/shared.mjs.map +0 -0
  863. /package/{resources → dist/resources}/shields.js +0 -0
  864. /package/{resources → dist/resources}/shields.js.map +0 -0
  865. /package/{resources → dist/resources}/shields.mjs +0 -0
  866. /package/{resources → dist/resources}/shields.mjs.map +0 -0
  867. /package/{resources → dist/resources}/tool-runtime.d.ts +0 -0
  868. /package/{resources → dist/resources}/tool-runtime.d.ts.map +0 -0
  869. /package/{resources → dist/resources}/tool-runtime.js +0 -0
  870. /package/{resources → dist/resources}/tool-runtime.js.map +0 -0
  871. /package/{resources → dist/resources}/tool-runtime.mjs +0 -0
  872. /package/{resources → dist/resources}/tool-runtime.mjs.map +0 -0
  873. /package/{resources → dist/resources}/toolgroups.d.ts +0 -0
  874. /package/{resources → dist/resources}/toolgroups.d.ts.map +0 -0
  875. /package/{resources → dist/resources}/toolgroups.js +0 -0
  876. /package/{resources → dist/resources}/toolgroups.js.map +0 -0
  877. /package/{resources → dist/resources}/toolgroups.mjs +0 -0
  878. /package/{resources → dist/resources}/toolgroups.mjs.map +0 -0
  879. /package/{resources → dist/resources}/tools.d.ts +0 -0
  880. /package/{resources → dist/resources}/tools.d.ts.map +0 -0
  881. /package/{resources → dist/resources}/tools.js +0 -0
  882. /package/{resources → dist/resources}/tools.js.map +0 -0
  883. /package/{resources → dist/resources}/tools.mjs +0 -0
  884. /package/{resources → dist/resources}/tools.mjs.map +0 -0
  885. /package/{resources → dist/resources}/vector-io.js.map +0 -0
  886. /package/{resources → dist/resources}/vector-io.mjs.map +0 -0
  887. /package/{resources → dist/resources}/vector-stores/index.d.ts +0 -0
  888. /package/{resources → dist/resources}/vector-stores/index.d.ts.map +0 -0
  889. /package/{resources → dist/resources}/vector-stores/index.js +0 -0
  890. /package/{resources → dist/resources}/vector-stores/index.js.map +0 -0
  891. /package/{resources → dist/resources}/vector-stores/index.mjs +0 -0
  892. /package/{resources → dist/resources}/vector-stores/index.mjs.map +0 -0
  893. /package/{resources → dist/resources}/vector-stores.d.ts +0 -0
  894. /package/{resources → dist/resources}/vector-stores.d.ts.map +0 -0
  895. /package/{resources → dist/resources}/vector-stores.js +0 -0
  896. /package/{resources → dist/resources}/vector-stores.js.map +0 -0
  897. /package/{resources → dist/resources}/vector-stores.mjs +0 -0
  898. /package/{resources → dist/resources}/vector-stores.mjs.map +0 -0
  899. /package/{resources.d.ts → dist/resources.d.ts} +0 -0
  900. /package/{resources.d.ts.map → dist/resources.d.ts.map} +0 -0
  901. /package/{resources.js → dist/resources.js} +0 -0
  902. /package/{resources.js.map → dist/resources.js.map} +0 -0
  903. /package/{resources.mjs → dist/resources.mjs} +0 -0
  904. /package/{resources.mjs.map → dist/resources.mjs.map} +0 -0
  905. /package/{shims → dist/shims}/node.d.ts +0 -0
  906. /package/{shims → dist/shims}/node.d.ts.map +0 -0
  907. /package/{shims → dist/shims}/node.js +0 -0
  908. /package/{shims → dist/shims}/node.js.map +0 -0
  909. /package/{shims → dist/shims}/node.mjs +0 -0
  910. /package/{shims → dist/shims}/node.mjs.map +0 -0
  911. /package/{shims → dist/shims}/web.d.ts +0 -0
  912. /package/{shims → dist/shims}/web.d.ts.map +0 -0
  913. /package/{shims → dist/shims}/web.js +0 -0
  914. /package/{shims → dist/shims}/web.js.map +0 -0
  915. /package/{shims → dist/shims}/web.mjs +0 -0
  916. /package/{shims → dist/shims}/web.mjs.map +0 -0
  917. /package/{src → dist/src}/tsconfig.json +0 -0
  918. /package/{streaming.d.ts → dist/streaming.d.ts} +0 -0
  919. /package/{streaming.d.ts.map → dist/streaming.d.ts.map} +0 -0
  920. /package/{streaming.js → dist/streaming.js} +0 -0
  921. /package/{streaming.js.map → dist/streaming.js.map} +0 -0
  922. /package/{streaming.mjs → dist/streaming.mjs} +0 -0
  923. /package/{streaming.mjs.map → dist/streaming.mjs.map} +0 -0
  924. /package/{uploads.d.ts → dist/uploads.d.ts} +0 -0
  925. /package/{uploads.d.ts.map → dist/uploads.d.ts.map} +0 -0
  926. /package/{uploads.js → dist/uploads.js} +0 -0
  927. /package/{uploads.js.map → dist/uploads.js.map} +0 -0
  928. /package/{uploads.mjs → dist/uploads.mjs} +0 -0
  929. /package/{uploads.mjs.map → dist/uploads.mjs.map} +0 -0
  930. /package/{version.d.ts.map → dist/version.d.ts.map} +0 -0
  931. /package/{version.js.map → dist/version.js.map} +0 -0
  932. /package/{version.mjs.map → dist/version.mjs.map} +0 -0
@@ -1,2871 +0,0 @@
1
- import { APIResource } from "../../resource.js";
2
- import { APIPromise } from "../../core.js";
3
- import * as Core from "../../core.js";
4
- import * as ResponsesAPI from "./responses.js";
5
- import * as InputItemsAPI from "./input-items.js";
6
- import { InputItemListParams, InputItemListResponse, InputItems } from "./input-items.js";
7
- import { OpenAICursorPage, type OpenAICursorPageParams } from "../../pagination.js";
8
- import { Stream } from "../../streaming.js";
9
- export declare class Responses extends APIResource {
10
- inputItems: InputItemsAPI.InputItems;
11
- /**
12
- * Create a model response.
13
- */
14
- create(body: ResponseCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<ResponseObject>;
15
- create(body: ResponseCreateParamsStreaming, options?: Core.RequestOptions): APIPromise<Stream<ResponseObjectStream>>;
16
- create(body: ResponseCreateParamsBase, options?: Core.RequestOptions): APIPromise<Stream<ResponseObjectStream> | ResponseObject>;
17
- /**
18
- * Get a model response.
19
- */
20
- retrieve(responseId: string, options?: Core.RequestOptions): Core.APIPromise<ResponseObject>;
21
- /**
22
- * List all responses.
23
- */
24
- list(query?: ResponseListParams, options?: Core.RequestOptions): Core.PagePromise<ResponseListResponsesOpenAICursorPage, ResponseListResponse>;
25
- list(options?: Core.RequestOptions): Core.PagePromise<ResponseListResponsesOpenAICursorPage, ResponseListResponse>;
26
- /**
27
- * Delete a response.
28
- */
29
- delete(responseId: string, options?: Core.RequestOptions): Core.APIPromise<ResponseDeleteResponse>;
30
- }
31
- export declare class ResponseListResponsesOpenAICursorPage extends OpenAICursorPage<ResponseListResponse> {
32
- }
33
- /**
34
- * Complete OpenAI response object containing generation results and metadata.
35
- */
36
- export interface ResponseObject {
37
- id: string;
38
- created_at: number;
39
- model: string;
40
- output: Array<ResponseObject.OpenAIResponseMessageOutput | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFunctionToolCall | ResponseObject.OpenAIResponseOutputMessageMcpCall | ResponseObject.OpenAIResponseOutputMessageMcpListTools | ResponseObject.OpenAIResponseMcpApprovalRequest>;
41
- status: string;
42
- /**
43
- * Error details for failed OpenAI response requests.
44
- */
45
- error?: ResponseObject.Error | null;
46
- instructions?: string | null;
47
- max_tool_calls?: number | null;
48
- metadata?: {
49
- [key: string]: string;
50
- } | null;
51
- object?: 'response';
52
- parallel_tool_calls?: boolean | null;
53
- previous_response_id?: string | null;
54
- /**
55
- * OpenAI compatible Prompt object that is used in OpenAI responses.
56
- */
57
- prompt?: ResponseObject.Prompt | null;
58
- temperature?: number | null;
59
- /**
60
- * Text response configuration for OpenAI responses.
61
- */
62
- text?: ResponseObject.Text;
63
- /**
64
- * Constrains the tools available to the model to a pre-defined set.
65
- */
66
- tool_choice?: 'auto' | 'required' | 'none' | ResponseObject.OpenAIResponseInputToolChoiceAllowedTools | ResponseObject.OpenAIResponseInputToolChoiceFileSearch | ResponseObject.OpenAIResponseInputToolChoiceWebSearch | ResponseObject.OpenAIResponseInputToolChoiceFunctionTool | ResponseObject.OpenAIResponseInputToolChoiceMcpTool | ResponseObject.OpenAIResponseInputToolChoiceCustomTool | null;
67
- tools?: Array<ResponseObject.OpenAIResponseInputToolWebSearch | ResponseObject.OpenAIResponseInputToolFileSearch | ResponseObject.OpenAIResponseInputToolFunction | ResponseObject.OpenAIResponseToolMcp> | null;
68
- top_p?: number | null;
69
- truncation?: string | null;
70
- /**
71
- * Usage information for OpenAI response.
72
- */
73
- usage?: ResponseObject.Usage | null;
74
- }
75
- export declare namespace ResponseObject {
76
- /**
77
- * Corresponds to the various Message types in the Responses API. They are all
78
- * under one type because the Responses API gives them all the same "type" value,
79
- * and there is no way to tell them apart in certain scenarios.
80
- */
81
- interface OpenAIResponseMessageOutput {
82
- content: string | Array<OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal>;
83
- role: 'system' | 'developer' | 'user' | 'assistant';
84
- id?: string | null;
85
- status?: string | null;
86
- type?: 'message';
87
- }
88
- namespace OpenAIResponseMessageOutput {
89
- /**
90
- * Text content for input messages in OpenAI response format.
91
- */
92
- interface OpenAIResponseInputMessageContentText {
93
- text: string;
94
- type?: 'input_text';
95
- }
96
- /**
97
- * Image content for input messages in OpenAI response format.
98
- */
99
- interface OpenAIResponseInputMessageContentImage {
100
- detail?: 'low' | 'high' | 'auto';
101
- file_id?: string | null;
102
- image_url?: string | null;
103
- type?: 'input_image';
104
- }
105
- /**
106
- * File content for input messages in OpenAI response format.
107
- */
108
- interface OpenAIResponseInputMessageContentFile {
109
- file_data?: string | null;
110
- file_id?: string | null;
111
- file_url?: string | null;
112
- filename?: string | null;
113
- type?: 'input_file';
114
- }
115
- interface OpenAIResponseOutputMessageContentOutputTextOutput {
116
- text: string;
117
- annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
118
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
119
- type?: 'output_text';
120
- }
121
- namespace OpenAIResponseOutputMessageContentOutputTextOutput {
122
- /**
123
- * File citation annotation for referencing specific files in response content.
124
- */
125
- interface OpenAIResponseAnnotationFileCitation {
126
- file_id: string;
127
- filename: string;
128
- index: number;
129
- type?: 'file_citation';
130
- }
131
- /**
132
- * URL citation annotation for referencing external web resources.
133
- */
134
- interface OpenAIResponseAnnotationCitation {
135
- end_index: number;
136
- start_index: number;
137
- title: string;
138
- url: string;
139
- type?: 'url_citation';
140
- }
141
- interface OpenAIResponseAnnotationContainerFileCitation {
142
- container_id: string;
143
- end_index: number;
144
- file_id: string;
145
- filename: string;
146
- start_index: number;
147
- type?: 'container_file_citation';
148
- }
149
- interface OpenAIResponseAnnotationFilePath {
150
- file_id: string;
151
- index: number;
152
- type?: 'file_path';
153
- }
154
- /**
155
- * The log probability for a token from an OpenAI-compatible chat completion
156
- * response.
157
- *
158
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
159
- * probability of the token :top_logprobs: The top log probabilities for the token
160
- */
161
- interface Logprob {
162
- token: string;
163
- logprob: number;
164
- bytes?: Array<number> | null;
165
- top_logprobs?: Array<Logprob.TopLogprob> | null;
166
- }
167
- namespace Logprob {
168
- /**
169
- * The top log probability for a token from an OpenAI-compatible chat completion
170
- * response.
171
- *
172
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
173
- * probability of the token
174
- */
175
- interface TopLogprob {
176
- token: string;
177
- logprob: number;
178
- bytes?: Array<number> | null;
179
- }
180
- }
181
- }
182
- /**
183
- * Refusal content within a streamed response part.
184
- */
185
- interface OpenAIResponseContentPartRefusal {
186
- refusal: string;
187
- type?: 'refusal';
188
- }
189
- }
190
- /**
191
- * Web search tool call output message for OpenAI responses.
192
- */
193
- interface OpenAIResponseOutputMessageWebSearchToolCall {
194
- id: string;
195
- status: string;
196
- type?: 'web_search_call';
197
- }
198
- /**
199
- * File search tool call output message for OpenAI responses.
200
- */
201
- interface OpenAIResponseOutputMessageFileSearchToolCall {
202
- id: string;
203
- queries: Array<string>;
204
- status: string;
205
- results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
206
- type?: 'file_search_call';
207
- }
208
- namespace OpenAIResponseOutputMessageFileSearchToolCall {
209
- /**
210
- * Search results returned by the file search operation.
211
- */
212
- interface Result {
213
- attributes: {
214
- [key: string]: unknown;
215
- };
216
- file_id: string;
217
- filename: string;
218
- score: number;
219
- text: string;
220
- }
221
- }
222
- /**
223
- * Function tool call output message for OpenAI responses.
224
- */
225
- interface OpenAIResponseOutputMessageFunctionToolCall {
226
- arguments: string;
227
- call_id: string;
228
- name: string;
229
- id?: string | null;
230
- status?: string | null;
231
- type?: 'function_call';
232
- }
233
- /**
234
- * Model Context Protocol (MCP) call output message for OpenAI responses.
235
- */
236
- interface OpenAIResponseOutputMessageMcpCall {
237
- id: string;
238
- arguments: string;
239
- name: string;
240
- server_label: string;
241
- error?: string | null;
242
- output?: string | null;
243
- type?: 'mcp_call';
244
- }
245
- /**
246
- * MCP list tools output message containing available tools from an MCP server.
247
- */
248
- interface OpenAIResponseOutputMessageMcpListTools {
249
- id: string;
250
- server_label: string;
251
- tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
252
- type?: 'mcp_list_tools';
253
- }
254
- namespace OpenAIResponseOutputMessageMcpListTools {
255
- /**
256
- * Tool definition returned by MCP list tools operation.
257
- */
258
- interface Tool {
259
- input_schema: {
260
- [key: string]: unknown;
261
- };
262
- name: string;
263
- description?: string | null;
264
- }
265
- }
266
- /**
267
- * A request for human approval of a tool invocation.
268
- */
269
- interface OpenAIResponseMcpApprovalRequest {
270
- id: string;
271
- arguments: string;
272
- name: string;
273
- server_label: string;
274
- type?: 'mcp_approval_request';
275
- }
276
- /**
277
- * Error details for failed OpenAI response requests.
278
- */
279
- interface Error {
280
- code: string;
281
- message: string;
282
- }
283
- /**
284
- * OpenAI compatible Prompt object that is used in OpenAI responses.
285
- */
286
- interface Prompt {
287
- id: string;
288
- variables?: {
289
- [key: string]: Prompt.OpenAIResponseInputMessageContentText | Prompt.OpenAIResponseInputMessageContentImage | Prompt.OpenAIResponseInputMessageContentFile;
290
- } | null;
291
- version?: string | null;
292
- }
293
- namespace Prompt {
294
- /**
295
- * Text content for input messages in OpenAI response format.
296
- */
297
- interface OpenAIResponseInputMessageContentText {
298
- text: string;
299
- type?: 'input_text';
300
- }
301
- /**
302
- * Image content for input messages in OpenAI response format.
303
- */
304
- interface OpenAIResponseInputMessageContentImage {
305
- detail?: 'low' | 'high' | 'auto';
306
- file_id?: string | null;
307
- image_url?: string | null;
308
- type?: 'input_image';
309
- }
310
- /**
311
- * File content for input messages in OpenAI response format.
312
- */
313
- interface OpenAIResponseInputMessageContentFile {
314
- file_data?: string | null;
315
- file_id?: string | null;
316
- file_url?: string | null;
317
- filename?: string | null;
318
- type?: 'input_file';
319
- }
320
- }
321
- /**
322
- * Text response configuration for OpenAI responses.
323
- */
324
- interface Text {
325
- /**
326
- * Configuration for Responses API text format.
327
- */
328
- format?: Text.Format | null;
329
- }
330
- namespace Text {
331
- /**
332
- * Configuration for Responses API text format.
333
- */
334
- interface Format {
335
- description?: string | null;
336
- name?: string | null;
337
- schema?: {
338
- [key: string]: unknown;
339
- } | null;
340
- strict?: boolean | null;
341
- type?: 'text' | 'json_schema' | 'json_object';
342
- }
343
- }
344
- /**
345
- * Constrains the tools available to the model to a pre-defined set.
346
- */
347
- interface OpenAIResponseInputToolChoiceAllowedTools {
348
- tools: Array<{
349
- [key: string]: string;
350
- }>;
351
- mode?: 'auto' | 'required';
352
- type?: 'allowed_tools';
353
- }
354
- /**
355
- * Indicates that the model should use file search to generate a response.
356
- */
357
- interface OpenAIResponseInputToolChoiceFileSearch {
358
- type?: 'file_search';
359
- }
360
- /**
361
- * Indicates that the model should use web search to generate a response
362
- */
363
- interface OpenAIResponseInputToolChoiceWebSearch {
364
- type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
365
- }
366
- /**
367
- * Forces the model to call a specific function.
368
- */
369
- interface OpenAIResponseInputToolChoiceFunctionTool {
370
- name: string;
371
- type?: 'function';
372
- }
373
- /**
374
- * Forces the model to call a specific tool on a remote MCP server
375
- */
376
- interface OpenAIResponseInputToolChoiceMcpTool {
377
- server_label: string;
378
- name?: string | null;
379
- type?: 'mcp';
380
- }
381
- /**
382
- * Forces the model to call a custom tool.
383
- */
384
- interface OpenAIResponseInputToolChoiceCustomTool {
385
- name: string;
386
- type?: 'custom';
387
- }
388
- /**
389
- * Web search tool configuration for OpenAI response inputs.
390
- */
391
- interface OpenAIResponseInputToolWebSearch {
392
- search_context_size?: string | null;
393
- type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
394
- }
395
- /**
396
- * File search tool configuration for OpenAI response inputs.
397
- */
398
- interface OpenAIResponseInputToolFileSearch {
399
- vector_store_ids: Array<string>;
400
- filters?: {
401
- [key: string]: unknown;
402
- } | null;
403
- max_num_results?: number | null;
404
- /**
405
- * Options for ranking and filtering search results.
406
- */
407
- ranking_options?: OpenAIResponseInputToolFileSearch.RankingOptions | null;
408
- type?: 'file_search';
409
- }
410
- namespace OpenAIResponseInputToolFileSearch {
411
- /**
412
- * Options for ranking and filtering search results.
413
- */
414
- interface RankingOptions {
415
- ranker?: string | null;
416
- score_threshold?: number | null;
417
- }
418
- }
419
- /**
420
- * Function tool configuration for OpenAI response inputs.
421
- */
422
- interface OpenAIResponseInputToolFunction {
423
- name: string;
424
- parameters: {
425
- [key: string]: unknown;
426
- } | null;
427
- description?: string | null;
428
- strict?: boolean | null;
429
- type?: 'function';
430
- }
431
- /**
432
- * Model Context Protocol (MCP) tool configuration for OpenAI response object.
433
- */
434
- interface OpenAIResponseToolMcp {
435
- server_label: string;
436
- /**
437
- * Filter configuration for restricting which MCP tools can be used.
438
- */
439
- allowed_tools?: Array<string> | OpenAIResponseToolMcp.AllowedToolsFilter | null;
440
- type?: 'mcp';
441
- }
442
- namespace OpenAIResponseToolMcp {
443
- /**
444
- * Filter configuration for restricting which MCP tools can be used.
445
- */
446
- interface AllowedToolsFilter {
447
- tool_names?: Array<string> | null;
448
- }
449
- }
450
- /**
451
- * Usage information for OpenAI response.
452
- */
453
- interface Usage {
454
- input_tokens: number;
455
- output_tokens: number;
456
- total_tokens: number;
457
- /**
458
- * Token details for input tokens in OpenAI response usage.
459
- */
460
- input_tokens_details?: Usage.InputTokensDetails | null;
461
- /**
462
- * Token details for output tokens in OpenAI response usage.
463
- */
464
- output_tokens_details?: Usage.OutputTokensDetails | null;
465
- }
466
- namespace Usage {
467
- /**
468
- * Token details for input tokens in OpenAI response usage.
469
- */
470
- interface InputTokensDetails {
471
- cached_tokens?: number | null;
472
- }
473
- /**
474
- * Token details for output tokens in OpenAI response usage.
475
- */
476
- interface OutputTokensDetails {
477
- reasoning_tokens?: number | null;
478
- }
479
- }
480
- }
481
- /**
482
- * Streaming event indicating a new response has been created.
483
- */
484
- export type ResponseObjectStream = ResponseObjectStream.OpenAIResponseObjectStreamResponseCreated | ResponseObjectStream.OpenAIResponseObjectStreamResponseInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputItemAdded | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputItemDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputTextDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputTextDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallSearching | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsFailed | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallArgumentsDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallFailed | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseContentPartAdded | ResponseObjectStream.OpenAIResponseObjectStreamResponseContentPartDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseReasoningTextDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseReasoningTextDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded | ResponseObjectStream.OpenAIResponseObjectStreamResponseReasoningSummaryPartDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseReasoningSummaryTextDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseRefusalDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseRefusalDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded | ResponseObjectStream.OpenAIResponseObjectStreamResponseFileSearchCallInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseFileSearchCallSearching | ResponseObjectStream.OpenAIResponseObjectStreamResponseFileSearchCallCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseIncomplete | ResponseObjectStream.OpenAIResponseObjectStreamResponseFailed | ResponseObjectStream.OpenAIResponseObjectStreamResponseCompleted;
485
- export declare namespace ResponseObjectStream {
486
- /**
487
- * Streaming event indicating a new response has been created.
488
- */
489
- interface OpenAIResponseObjectStreamResponseCreated {
490
- /**
491
- * Complete OpenAI response object containing generation results and metadata.
492
- */
493
- response: ResponsesAPI.ResponseObject;
494
- type?: 'response.created';
495
- }
496
- /**
497
- * Streaming event indicating the response remains in progress.
498
- */
499
- interface OpenAIResponseObjectStreamResponseInProgress {
500
- /**
501
- * Complete OpenAI response object containing generation results and metadata.
502
- */
503
- response: ResponsesAPI.ResponseObject;
504
- sequence_number: number;
505
- type?: 'response.in_progress';
506
- }
507
- /**
508
- * Streaming event for when a new output item is added to the response.
509
- */
510
- interface OpenAIResponseObjectStreamResponseOutputItemAdded {
511
- /**
512
- * Corresponds to the various Message types in the Responses API. They are all
513
- * under one type because the Responses API gives them all the same "type" value,
514
- * and there is no way to tell them apart in certain scenarios.
515
- */
516
- item: OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpListTools | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMcpApprovalRequest;
517
- output_index: number;
518
- response_id: string;
519
- sequence_number: number;
520
- type?: 'response.output_item.added';
521
- }
522
- namespace OpenAIResponseObjectStreamResponseOutputItemAdded {
523
- /**
524
- * Corresponds to the various Message types in the Responses API. They are all
525
- * under one type because the Responses API gives them all the same "type" value,
526
- * and there is no way to tell them apart in certain scenarios.
527
- */
528
- interface OpenAIResponseMessage {
529
- content: string | Array<OpenAIResponseMessage.OpenAIResponseInputMessageContentText | OpenAIResponseMessage.OpenAIResponseInputMessageContentImage | OpenAIResponseMessage.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessage.OpenAIResponseOutputMessageContentOutputText | OpenAIResponseMessage.OpenAIResponseContentPartRefusal>;
530
- role: 'system' | 'developer' | 'user' | 'assistant';
531
- id?: string | null;
532
- status?: string | null;
533
- type?: 'message';
534
- }
535
- namespace OpenAIResponseMessage {
536
- /**
537
- * Text content for input messages in OpenAI response format.
538
- */
539
- interface OpenAIResponseInputMessageContentText {
540
- text: string;
541
- type?: 'input_text';
542
- }
543
- /**
544
- * Image content for input messages in OpenAI response format.
545
- */
546
- interface OpenAIResponseInputMessageContentImage {
547
- detail?: 'low' | 'high' | 'auto';
548
- file_id?: string | null;
549
- image_url?: string | null;
550
- type?: 'input_image';
551
- }
552
- /**
553
- * File content for input messages in OpenAI response format.
554
- */
555
- interface OpenAIResponseInputMessageContentFile {
556
- file_data?: string | null;
557
- file_id?: string | null;
558
- file_url?: string | null;
559
- filename?: string | null;
560
- type?: 'input_file';
561
- }
562
- interface OpenAIResponseOutputMessageContentOutputText {
563
- text: string;
564
- annotations?: Array<OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFilePath>;
565
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputText.Logprob> | null;
566
- type?: 'output_text';
567
- }
568
- namespace OpenAIResponseOutputMessageContentOutputText {
569
- /**
570
- * File citation annotation for referencing specific files in response content.
571
- */
572
- interface OpenAIResponseAnnotationFileCitation {
573
- file_id: string;
574
- filename: string;
575
- index: number;
576
- type?: 'file_citation';
577
- }
578
- /**
579
- * URL citation annotation for referencing external web resources.
580
- */
581
- interface OpenAIResponseAnnotationCitation {
582
- end_index: number;
583
- start_index: number;
584
- title: string;
585
- url: string;
586
- type?: 'url_citation';
587
- }
588
- interface OpenAIResponseAnnotationContainerFileCitation {
589
- container_id: string;
590
- end_index: number;
591
- file_id: string;
592
- filename: string;
593
- start_index: number;
594
- type?: 'container_file_citation';
595
- }
596
- interface OpenAIResponseAnnotationFilePath {
597
- file_id: string;
598
- index: number;
599
- type?: 'file_path';
600
- }
601
- /**
602
- * The log probability for a token from an OpenAI-compatible chat completion
603
- * response.
604
- *
605
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
606
- * probability of the token :top_logprobs: The top log probabilities for the token
607
- */
608
- interface Logprob {
609
- token: string;
610
- logprob: number;
611
- bytes?: Array<number> | null;
612
- top_logprobs?: Array<Logprob.TopLogprob> | null;
613
- }
614
- namespace Logprob {
615
- /**
616
- * The top log probability for a token from an OpenAI-compatible chat completion
617
- * response.
618
- *
619
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
620
- * probability of the token
621
- */
622
- interface TopLogprob {
623
- token: string;
624
- logprob: number;
625
- bytes?: Array<number> | null;
626
- }
627
- }
628
- }
629
- /**
630
- * Refusal content within a streamed response part.
631
- */
632
- interface OpenAIResponseContentPartRefusal {
633
- refusal: string;
634
- type?: 'refusal';
635
- }
636
- }
637
- /**
638
- * Web search tool call output message for OpenAI responses.
639
- */
640
- interface OpenAIResponseOutputMessageWebSearchToolCall {
641
- id: string;
642
- status: string;
643
- type?: 'web_search_call';
644
- }
645
- /**
646
- * File search tool call output message for OpenAI responses.
647
- */
648
- interface OpenAIResponseOutputMessageFileSearchToolCall {
649
- id: string;
650
- queries: Array<string>;
651
- status: string;
652
- results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
653
- type?: 'file_search_call';
654
- }
655
- namespace OpenAIResponseOutputMessageFileSearchToolCall {
656
- /**
657
- * Search results returned by the file search operation.
658
- */
659
- interface Result {
660
- attributes: {
661
- [key: string]: unknown;
662
- };
663
- file_id: string;
664
- filename: string;
665
- score: number;
666
- text: string;
667
- }
668
- }
669
- /**
670
- * Function tool call output message for OpenAI responses.
671
- */
672
- interface OpenAIResponseOutputMessageFunctionToolCall {
673
- arguments: string;
674
- call_id: string;
675
- name: string;
676
- id?: string | null;
677
- status?: string | null;
678
- type?: 'function_call';
679
- }
680
- /**
681
- * Model Context Protocol (MCP) call output message for OpenAI responses.
682
- */
683
- interface OpenAIResponseOutputMessageMcpCall {
684
- id: string;
685
- arguments: string;
686
- name: string;
687
- server_label: string;
688
- error?: string | null;
689
- output?: string | null;
690
- type?: 'mcp_call';
691
- }
692
- /**
693
- * MCP list tools output message containing available tools from an MCP server.
694
- */
695
- interface OpenAIResponseOutputMessageMcpListTools {
696
- id: string;
697
- server_label: string;
698
- tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
699
- type?: 'mcp_list_tools';
700
- }
701
- namespace OpenAIResponseOutputMessageMcpListTools {
702
- /**
703
- * Tool definition returned by MCP list tools operation.
704
- */
705
- interface Tool {
706
- input_schema: {
707
- [key: string]: unknown;
708
- };
709
- name: string;
710
- description?: string | null;
711
- }
712
- }
713
- /**
714
- * A request for human approval of a tool invocation.
715
- */
716
- interface OpenAIResponseMcpApprovalRequest {
717
- id: string;
718
- arguments: string;
719
- name: string;
720
- server_label: string;
721
- type?: 'mcp_approval_request';
722
- }
723
- }
724
- /**
725
- * Streaming event for when an output item is completed.
726
- */
727
- interface OpenAIResponseObjectStreamResponseOutputItemDone {
728
- /**
729
- * Corresponds to the various Message types in the Responses API. They are all
730
- * under one type because the Responses API gives them all the same "type" value,
731
- * and there is no way to tell them apart in certain scenarios.
732
- */
733
- item: OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpListTools | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMcpApprovalRequest;
734
- output_index: number;
735
- response_id: string;
736
- sequence_number: number;
737
- type?: 'response.output_item.done';
738
- }
739
- namespace OpenAIResponseObjectStreamResponseOutputItemDone {
740
- /**
741
- * Corresponds to the various Message types in the Responses API. They are all
742
- * under one type because the Responses API gives them all the same "type" value,
743
- * and there is no way to tell them apart in certain scenarios.
744
- */
745
- interface OpenAIResponseMessage {
746
- content: string | Array<OpenAIResponseMessage.OpenAIResponseInputMessageContentText | OpenAIResponseMessage.OpenAIResponseInputMessageContentImage | OpenAIResponseMessage.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessage.OpenAIResponseOutputMessageContentOutputText | OpenAIResponseMessage.OpenAIResponseContentPartRefusal>;
747
- role: 'system' | 'developer' | 'user' | 'assistant';
748
- id?: string | null;
749
- status?: string | null;
750
- type?: 'message';
751
- }
752
- namespace OpenAIResponseMessage {
753
- /**
754
- * Text content for input messages in OpenAI response format.
755
- */
756
- interface OpenAIResponseInputMessageContentText {
757
- text: string;
758
- type?: 'input_text';
759
- }
760
- /**
761
- * Image content for input messages in OpenAI response format.
762
- */
763
- interface OpenAIResponseInputMessageContentImage {
764
- detail?: 'low' | 'high' | 'auto';
765
- file_id?: string | null;
766
- image_url?: string | null;
767
- type?: 'input_image';
768
- }
769
- /**
770
- * File content for input messages in OpenAI response format.
771
- */
772
- interface OpenAIResponseInputMessageContentFile {
773
- file_data?: string | null;
774
- file_id?: string | null;
775
- file_url?: string | null;
776
- filename?: string | null;
777
- type?: 'input_file';
778
- }
779
- interface OpenAIResponseOutputMessageContentOutputText {
780
- text: string;
781
- annotations?: Array<OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFilePath>;
782
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputText.Logprob> | null;
783
- type?: 'output_text';
784
- }
785
- namespace OpenAIResponseOutputMessageContentOutputText {
786
- /**
787
- * File citation annotation for referencing specific files in response content.
788
- */
789
- interface OpenAIResponseAnnotationFileCitation {
790
- file_id: string;
791
- filename: string;
792
- index: number;
793
- type?: 'file_citation';
794
- }
795
- /**
796
- * URL citation annotation for referencing external web resources.
797
- */
798
- interface OpenAIResponseAnnotationCitation {
799
- end_index: number;
800
- start_index: number;
801
- title: string;
802
- url: string;
803
- type?: 'url_citation';
804
- }
805
- interface OpenAIResponseAnnotationContainerFileCitation {
806
- container_id: string;
807
- end_index: number;
808
- file_id: string;
809
- filename: string;
810
- start_index: number;
811
- type?: 'container_file_citation';
812
- }
813
- interface OpenAIResponseAnnotationFilePath {
814
- file_id: string;
815
- index: number;
816
- type?: 'file_path';
817
- }
818
- /**
819
- * The log probability for a token from an OpenAI-compatible chat completion
820
- * response.
821
- *
822
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
823
- * probability of the token :top_logprobs: The top log probabilities for the token
824
- */
825
- interface Logprob {
826
- token: string;
827
- logprob: number;
828
- bytes?: Array<number> | null;
829
- top_logprobs?: Array<Logprob.TopLogprob> | null;
830
- }
831
- namespace Logprob {
832
- /**
833
- * The top log probability for a token from an OpenAI-compatible chat completion
834
- * response.
835
- *
836
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
837
- * probability of the token
838
- */
839
- interface TopLogprob {
840
- token: string;
841
- logprob: number;
842
- bytes?: Array<number> | null;
843
- }
844
- }
845
- }
846
- /**
847
- * Refusal content within a streamed response part.
848
- */
849
- interface OpenAIResponseContentPartRefusal {
850
- refusal: string;
851
- type?: 'refusal';
852
- }
853
- }
854
- /**
855
- * Web search tool call output message for OpenAI responses.
856
- */
857
- interface OpenAIResponseOutputMessageWebSearchToolCall {
858
- id: string;
859
- status: string;
860
- type?: 'web_search_call';
861
- }
862
- /**
863
- * File search tool call output message for OpenAI responses.
864
- */
865
- interface OpenAIResponseOutputMessageFileSearchToolCall {
866
- id: string;
867
- queries: Array<string>;
868
- status: string;
869
- results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
870
- type?: 'file_search_call';
871
- }
872
- namespace OpenAIResponseOutputMessageFileSearchToolCall {
873
- /**
874
- * Search results returned by the file search operation.
875
- */
876
- interface Result {
877
- attributes: {
878
- [key: string]: unknown;
879
- };
880
- file_id: string;
881
- filename: string;
882
- score: number;
883
- text: string;
884
- }
885
- }
886
- /**
887
- * Function tool call output message for OpenAI responses.
888
- */
889
- interface OpenAIResponseOutputMessageFunctionToolCall {
890
- arguments: string;
891
- call_id: string;
892
- name: string;
893
- id?: string | null;
894
- status?: string | null;
895
- type?: 'function_call';
896
- }
897
- /**
898
- * Model Context Protocol (MCP) call output message for OpenAI responses.
899
- */
900
- interface OpenAIResponseOutputMessageMcpCall {
901
- id: string;
902
- arguments: string;
903
- name: string;
904
- server_label: string;
905
- error?: string | null;
906
- output?: string | null;
907
- type?: 'mcp_call';
908
- }
909
- /**
910
- * MCP list tools output message containing available tools from an MCP server.
911
- */
912
- interface OpenAIResponseOutputMessageMcpListTools {
913
- id: string;
914
- server_label: string;
915
- tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
916
- type?: 'mcp_list_tools';
917
- }
918
- namespace OpenAIResponseOutputMessageMcpListTools {
919
- /**
920
- * Tool definition returned by MCP list tools operation.
921
- */
922
- interface Tool {
923
- input_schema: {
924
- [key: string]: unknown;
925
- };
926
- name: string;
927
- description?: string | null;
928
- }
929
- }
930
- /**
931
- * A request for human approval of a tool invocation.
932
- */
933
- interface OpenAIResponseMcpApprovalRequest {
934
- id: string;
935
- arguments: string;
936
- name: string;
937
- server_label: string;
938
- type?: 'mcp_approval_request';
939
- }
940
- }
941
- /**
942
- * Streaming event for incremental text content updates.
943
- */
944
- interface OpenAIResponseObjectStreamResponseOutputTextDelta {
945
- content_index: number;
946
- delta: string;
947
- item_id: string;
948
- output_index: number;
949
- sequence_number: number;
950
- logprobs?: Array<OpenAIResponseObjectStreamResponseOutputTextDelta.Logprob> | null;
951
- type?: 'response.output_text.delta';
952
- }
953
- namespace OpenAIResponseObjectStreamResponseOutputTextDelta {
954
- /**
955
- * The log probability for a token from an OpenAI-compatible chat completion
956
- * response.
957
- *
958
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
959
- * probability of the token :top_logprobs: The top log probabilities for the token
960
- */
961
- interface Logprob {
962
- token: string;
963
- logprob: number;
964
- bytes?: Array<number> | null;
965
- top_logprobs?: Array<Logprob.TopLogprob> | null;
966
- }
967
- namespace Logprob {
968
- /**
969
- * The top log probability for a token from an OpenAI-compatible chat completion
970
- * response.
971
- *
972
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
973
- * probability of the token
974
- */
975
- interface TopLogprob {
976
- token: string;
977
- logprob: number;
978
- bytes?: Array<number> | null;
979
- }
980
- }
981
- }
982
- /**
983
- * Streaming event for when text output is completed.
984
- */
985
- interface OpenAIResponseObjectStreamResponseOutputTextDone {
986
- content_index: number;
987
- item_id: string;
988
- output_index: number;
989
- sequence_number: number;
990
- text: string;
991
- type?: 'response.output_text.done';
992
- }
993
- /**
994
- * Streaming event for incremental function call argument updates.
995
- */
996
- interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta {
997
- delta: string;
998
- item_id: string;
999
- output_index: number;
1000
- sequence_number: number;
1001
- type?: 'response.function_call_arguments.delta';
1002
- }
1003
- /**
1004
- * Streaming event for when function call arguments are completed.
1005
- */
1006
- interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone {
1007
- arguments: string;
1008
- item_id: string;
1009
- output_index: number;
1010
- sequence_number: number;
1011
- type?: 'response.function_call_arguments.done';
1012
- }
1013
- /**
1014
- * Streaming event for web search calls in progress.
1015
- */
1016
- interface OpenAIResponseObjectStreamResponseWebSearchCallInProgress {
1017
- item_id: string;
1018
- output_index: number;
1019
- sequence_number: number;
1020
- type?: 'response.web_search_call.in_progress';
1021
- }
1022
- interface OpenAIResponseObjectStreamResponseWebSearchCallSearching {
1023
- item_id: string;
1024
- output_index: number;
1025
- sequence_number: number;
1026
- type?: 'response.web_search_call.searching';
1027
- }
1028
- /**
1029
- * Streaming event for completed web search calls.
1030
- */
1031
- interface OpenAIResponseObjectStreamResponseWebSearchCallCompleted {
1032
- item_id: string;
1033
- output_index: number;
1034
- sequence_number: number;
1035
- type?: 'response.web_search_call.completed';
1036
- }
1037
- interface OpenAIResponseObjectStreamResponseMcpListToolsInProgress {
1038
- sequence_number: number;
1039
- type?: 'response.mcp_list_tools.in_progress';
1040
- }
1041
- interface OpenAIResponseObjectStreamResponseMcpListToolsFailed {
1042
- sequence_number: number;
1043
- type?: 'response.mcp_list_tools.failed';
1044
- }
1045
- interface OpenAIResponseObjectStreamResponseMcpListToolsCompleted {
1046
- sequence_number: number;
1047
- type?: 'response.mcp_list_tools.completed';
1048
- }
1049
- interface OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta {
1050
- delta: string;
1051
- item_id: string;
1052
- output_index: number;
1053
- sequence_number: number;
1054
- type?: 'response.mcp_call.arguments.delta';
1055
- }
1056
- interface OpenAIResponseObjectStreamResponseMcpCallArgumentsDone {
1057
- arguments: string;
1058
- item_id: string;
1059
- output_index: number;
1060
- sequence_number: number;
1061
- type?: 'response.mcp_call.arguments.done';
1062
- }
1063
- /**
1064
- * Streaming event for MCP calls in progress.
1065
- */
1066
- interface OpenAIResponseObjectStreamResponseMcpCallInProgress {
1067
- item_id: string;
1068
- output_index: number;
1069
- sequence_number: number;
1070
- type?: 'response.mcp_call.in_progress';
1071
- }
1072
- /**
1073
- * Streaming event for failed MCP calls.
1074
- */
1075
- interface OpenAIResponseObjectStreamResponseMcpCallFailed {
1076
- sequence_number: number;
1077
- type?: 'response.mcp_call.failed';
1078
- }
1079
- /**
1080
- * Streaming event for completed MCP calls.
1081
- */
1082
- interface OpenAIResponseObjectStreamResponseMcpCallCompleted {
1083
- sequence_number: number;
1084
- type?: 'response.mcp_call.completed';
1085
- }
1086
- /**
1087
- * Streaming event for when a new content part is added to a response item.
1088
- */
1089
- interface OpenAIResponseObjectStreamResponseContentPartAdded {
1090
- content_index: number;
1091
- item_id: string;
1092
- output_index: number;
1093
- /**
1094
- * Text content within a streamed response part.
1095
- */
1096
- part: OpenAIResponseObjectStreamResponseContentPartAdded.OpenAIResponseContentPartOutputText | OpenAIResponseObjectStreamResponseContentPartAdded.OpenAIResponseContentPartRefusal | OpenAIResponseObjectStreamResponseContentPartAdded.OpenAIResponseContentPartReasoningText;
1097
- response_id: string;
1098
- sequence_number: number;
1099
- type?: 'response.content_part.added';
1100
- }
1101
- namespace OpenAIResponseObjectStreamResponseContentPartAdded {
1102
- /**
1103
- * Text content within a streamed response part.
1104
- */
1105
- interface OpenAIResponseContentPartOutputText {
1106
- text: string;
1107
- annotations?: Array<OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationFileCitation | OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationCitation | OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationFilePath>;
1108
- logprobs?: Array<OpenAIResponseContentPartOutputText.Logprob> | null;
1109
- type?: 'output_text';
1110
- }
1111
- namespace OpenAIResponseContentPartOutputText {
1112
- /**
1113
- * File citation annotation for referencing specific files in response content.
1114
- */
1115
- interface OpenAIResponseAnnotationFileCitation {
1116
- file_id: string;
1117
- filename: string;
1118
- index: number;
1119
- type?: 'file_citation';
1120
- }
1121
- /**
1122
- * URL citation annotation for referencing external web resources.
1123
- */
1124
- interface OpenAIResponseAnnotationCitation {
1125
- end_index: number;
1126
- start_index: number;
1127
- title: string;
1128
- url: string;
1129
- type?: 'url_citation';
1130
- }
1131
- interface OpenAIResponseAnnotationContainerFileCitation {
1132
- container_id: string;
1133
- end_index: number;
1134
- file_id: string;
1135
- filename: string;
1136
- start_index: number;
1137
- type?: 'container_file_citation';
1138
- }
1139
- interface OpenAIResponseAnnotationFilePath {
1140
- file_id: string;
1141
- index: number;
1142
- type?: 'file_path';
1143
- }
1144
- /**
1145
- * The log probability for a token from an OpenAI-compatible chat completion
1146
- * response.
1147
- *
1148
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1149
- * probability of the token :top_logprobs: The top log probabilities for the token
1150
- */
1151
- interface Logprob {
1152
- token: string;
1153
- logprob: number;
1154
- bytes?: Array<number> | null;
1155
- top_logprobs?: Array<Logprob.TopLogprob> | null;
1156
- }
1157
- namespace Logprob {
1158
- /**
1159
- * The top log probability for a token from an OpenAI-compatible chat completion
1160
- * response.
1161
- *
1162
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1163
- * probability of the token
1164
- */
1165
- interface TopLogprob {
1166
- token: string;
1167
- logprob: number;
1168
- bytes?: Array<number> | null;
1169
- }
1170
- }
1171
- }
1172
- /**
1173
- * Refusal content within a streamed response part.
1174
- */
1175
- interface OpenAIResponseContentPartRefusal {
1176
- refusal: string;
1177
- type?: 'refusal';
1178
- }
1179
- /**
1180
- * Reasoning text emitted as part of a streamed response.
1181
- */
1182
- interface OpenAIResponseContentPartReasoningText {
1183
- text: string;
1184
- type?: 'reasoning_text';
1185
- }
1186
- }
1187
- /**
1188
- * Streaming event for when a content part is completed.
1189
- */
1190
- interface OpenAIResponseObjectStreamResponseContentPartDone {
1191
- content_index: number;
1192
- item_id: string;
1193
- output_index: number;
1194
- /**
1195
- * Text content within a streamed response part.
1196
- */
1197
- part: OpenAIResponseObjectStreamResponseContentPartDone.OpenAIResponseContentPartOutputText | OpenAIResponseObjectStreamResponseContentPartDone.OpenAIResponseContentPartRefusal | OpenAIResponseObjectStreamResponseContentPartDone.OpenAIResponseContentPartReasoningText;
1198
- response_id: string;
1199
- sequence_number: number;
1200
- type?: 'response.content_part.done';
1201
- }
1202
- namespace OpenAIResponseObjectStreamResponseContentPartDone {
1203
- /**
1204
- * Text content within a streamed response part.
1205
- */
1206
- interface OpenAIResponseContentPartOutputText {
1207
- text: string;
1208
- annotations?: Array<OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationFileCitation | OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationCitation | OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseContentPartOutputText.OpenAIResponseAnnotationFilePath>;
1209
- logprobs?: Array<OpenAIResponseContentPartOutputText.Logprob> | null;
1210
- type?: 'output_text';
1211
- }
1212
- namespace OpenAIResponseContentPartOutputText {
1213
- /**
1214
- * File citation annotation for referencing specific files in response content.
1215
- */
1216
- interface OpenAIResponseAnnotationFileCitation {
1217
- file_id: string;
1218
- filename: string;
1219
- index: number;
1220
- type?: 'file_citation';
1221
- }
1222
- /**
1223
- * URL citation annotation for referencing external web resources.
1224
- */
1225
- interface OpenAIResponseAnnotationCitation {
1226
- end_index: number;
1227
- start_index: number;
1228
- title: string;
1229
- url: string;
1230
- type?: 'url_citation';
1231
- }
1232
- interface OpenAIResponseAnnotationContainerFileCitation {
1233
- container_id: string;
1234
- end_index: number;
1235
- file_id: string;
1236
- filename: string;
1237
- start_index: number;
1238
- type?: 'container_file_citation';
1239
- }
1240
- interface OpenAIResponseAnnotationFilePath {
1241
- file_id: string;
1242
- index: number;
1243
- type?: 'file_path';
1244
- }
1245
- /**
1246
- * The log probability for a token from an OpenAI-compatible chat completion
1247
- * response.
1248
- *
1249
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1250
- * probability of the token :top_logprobs: The top log probabilities for the token
1251
- */
1252
- interface Logprob {
1253
- token: string;
1254
- logprob: number;
1255
- bytes?: Array<number> | null;
1256
- top_logprobs?: Array<Logprob.TopLogprob> | null;
1257
- }
1258
- namespace Logprob {
1259
- /**
1260
- * The top log probability for a token from an OpenAI-compatible chat completion
1261
- * response.
1262
- *
1263
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1264
- * probability of the token
1265
- */
1266
- interface TopLogprob {
1267
- token: string;
1268
- logprob: number;
1269
- bytes?: Array<number> | null;
1270
- }
1271
- }
1272
- }
1273
- /**
1274
- * Refusal content within a streamed response part.
1275
- */
1276
- interface OpenAIResponseContentPartRefusal {
1277
- refusal: string;
1278
- type?: 'refusal';
1279
- }
1280
- /**
1281
- * Reasoning text emitted as part of a streamed response.
1282
- */
1283
- interface OpenAIResponseContentPartReasoningText {
1284
- text: string;
1285
- type?: 'reasoning_text';
1286
- }
1287
- }
1288
- /**
1289
- * Streaming event for incremental reasoning text updates.
1290
- */
1291
- interface OpenAIResponseObjectStreamResponseReasoningTextDelta {
1292
- content_index: number;
1293
- delta: string;
1294
- item_id: string;
1295
- output_index: number;
1296
- sequence_number: number;
1297
- type?: 'response.reasoning_text.delta';
1298
- }
1299
- /**
1300
- * Streaming event for when reasoning text is completed.
1301
- */
1302
- interface OpenAIResponseObjectStreamResponseReasoningTextDone {
1303
- content_index: number;
1304
- item_id: string;
1305
- output_index: number;
1306
- sequence_number: number;
1307
- text: string;
1308
- type?: 'response.reasoning_text.done';
1309
- }
1310
- /**
1311
- * Streaming event for when a new reasoning summary part is added.
1312
- */
1313
- interface OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded {
1314
- item_id: string;
1315
- output_index: number;
1316
- /**
1317
- * Reasoning summary part in a streamed response.
1318
- */
1319
- part: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded.Part;
1320
- sequence_number: number;
1321
- summary_index: number;
1322
- type?: 'response.reasoning_summary_part.added';
1323
- }
1324
- namespace OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded {
1325
- /**
1326
- * Reasoning summary part in a streamed response.
1327
- */
1328
- interface Part {
1329
- text: string;
1330
- type?: 'summary_text';
1331
- }
1332
- }
1333
- /**
1334
- * Streaming event for when a reasoning summary part is completed.
1335
- */
1336
- interface OpenAIResponseObjectStreamResponseReasoningSummaryPartDone {
1337
- item_id: string;
1338
- output_index: number;
1339
- /**
1340
- * Reasoning summary part in a streamed response.
1341
- */
1342
- part: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone.Part;
1343
- sequence_number: number;
1344
- summary_index: number;
1345
- type?: 'response.reasoning_summary_part.done';
1346
- }
1347
- namespace OpenAIResponseObjectStreamResponseReasoningSummaryPartDone {
1348
- /**
1349
- * Reasoning summary part in a streamed response.
1350
- */
1351
- interface Part {
1352
- text: string;
1353
- type?: 'summary_text';
1354
- }
1355
- }
1356
- /**
1357
- * Streaming event for incremental reasoning summary text updates.
1358
- */
1359
- interface OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta {
1360
- delta: string;
1361
- item_id: string;
1362
- output_index: number;
1363
- sequence_number: number;
1364
- summary_index: number;
1365
- type?: 'response.reasoning_summary_text.delta';
1366
- }
1367
- /**
1368
- * Streaming event for when reasoning summary text is completed.
1369
- */
1370
- interface OpenAIResponseObjectStreamResponseReasoningSummaryTextDone {
1371
- item_id: string;
1372
- output_index: number;
1373
- sequence_number: number;
1374
- summary_index: number;
1375
- text: string;
1376
- type?: 'response.reasoning_summary_text.done';
1377
- }
1378
- /**
1379
- * Streaming event for incremental refusal text updates.
1380
- */
1381
- interface OpenAIResponseObjectStreamResponseRefusalDelta {
1382
- content_index: number;
1383
- delta: string;
1384
- item_id: string;
1385
- output_index: number;
1386
- sequence_number: number;
1387
- type?: 'response.refusal.delta';
1388
- }
1389
- /**
1390
- * Streaming event for when refusal text is completed.
1391
- */
1392
- interface OpenAIResponseObjectStreamResponseRefusalDone {
1393
- content_index: number;
1394
- item_id: string;
1395
- output_index: number;
1396
- refusal: string;
1397
- sequence_number: number;
1398
- type?: 'response.refusal.done';
1399
- }
1400
- /**
1401
- * Streaming event for when an annotation is added to output text.
1402
- */
1403
- interface OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded {
1404
- /**
1405
- * File citation annotation for referencing specific files in response content.
1406
- */
1407
- annotation: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded.OpenAIResponseAnnotationFileCitation | OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded.OpenAIResponseAnnotationCitation | OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded.OpenAIResponseAnnotationFilePath;
1408
- annotation_index: number;
1409
- content_index: number;
1410
- item_id: string;
1411
- output_index: number;
1412
- sequence_number: number;
1413
- type?: 'response.output_text.annotation.added';
1414
- }
1415
- namespace OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded {
1416
- /**
1417
- * File citation annotation for referencing specific files in response content.
1418
- */
1419
- interface OpenAIResponseAnnotationFileCitation {
1420
- file_id: string;
1421
- filename: string;
1422
- index: number;
1423
- type?: 'file_citation';
1424
- }
1425
- /**
1426
- * URL citation annotation for referencing external web resources.
1427
- */
1428
- interface OpenAIResponseAnnotationCitation {
1429
- end_index: number;
1430
- start_index: number;
1431
- title: string;
1432
- url: string;
1433
- type?: 'url_citation';
1434
- }
1435
- interface OpenAIResponseAnnotationContainerFileCitation {
1436
- container_id: string;
1437
- end_index: number;
1438
- file_id: string;
1439
- filename: string;
1440
- start_index: number;
1441
- type?: 'container_file_citation';
1442
- }
1443
- interface OpenAIResponseAnnotationFilePath {
1444
- file_id: string;
1445
- index: number;
1446
- type?: 'file_path';
1447
- }
1448
- }
1449
- /**
1450
- * Streaming event for file search calls in progress.
1451
- */
1452
- interface OpenAIResponseObjectStreamResponseFileSearchCallInProgress {
1453
- item_id: string;
1454
- output_index: number;
1455
- sequence_number: number;
1456
- type?: 'response.file_search_call.in_progress';
1457
- }
1458
- /**
1459
- * Streaming event for file search currently searching.
1460
- */
1461
- interface OpenAIResponseObjectStreamResponseFileSearchCallSearching {
1462
- item_id: string;
1463
- output_index: number;
1464
- sequence_number: number;
1465
- type?: 'response.file_search_call.searching';
1466
- }
1467
- /**
1468
- * Streaming event for completed file search calls.
1469
- */
1470
- interface OpenAIResponseObjectStreamResponseFileSearchCallCompleted {
1471
- item_id: string;
1472
- output_index: number;
1473
- sequence_number: number;
1474
- type?: 'response.file_search_call.completed';
1475
- }
1476
- /**
1477
- * Streaming event emitted when a response ends in an incomplete state.
1478
- */
1479
- interface OpenAIResponseObjectStreamResponseIncomplete {
1480
- /**
1481
- * Complete OpenAI response object containing generation results and metadata.
1482
- */
1483
- response: ResponsesAPI.ResponseObject;
1484
- sequence_number: number;
1485
- type?: 'response.incomplete';
1486
- }
1487
- /**
1488
- * Streaming event emitted when a response fails.
1489
- */
1490
- interface OpenAIResponseObjectStreamResponseFailed {
1491
- /**
1492
- * Complete OpenAI response object containing generation results and metadata.
1493
- */
1494
- response: ResponsesAPI.ResponseObject;
1495
- sequence_number: number;
1496
- type?: 'response.failed';
1497
- }
1498
- /**
1499
- * Streaming event indicating a response has been completed.
1500
- */
1501
- interface OpenAIResponseObjectStreamResponseCompleted {
1502
- /**
1503
- * Complete OpenAI response object containing generation results and metadata.
1504
- */
1505
- response: ResponsesAPI.ResponseObject;
1506
- type?: 'response.completed';
1507
- }
1508
- }
1509
- /**
1510
- * OpenAI response object extended with input context information.
1511
- */
1512
- export interface ResponseListResponse {
1513
- id: string;
1514
- created_at: number;
1515
- input: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest | ResponseListResponse.OpenAIResponseInputFunctionToolCallOutput | ResponseListResponse.OpenAIResponseMcpApprovalResponse | ResponseListResponse.OpenAIResponseMessageOutput>;
1516
- model: string;
1517
- output: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest>;
1518
- status: string;
1519
- /**
1520
- * Error details for failed OpenAI response requests.
1521
- */
1522
- error?: ResponseListResponse.Error | null;
1523
- instructions?: string | null;
1524
- max_tool_calls?: number | null;
1525
- metadata?: {
1526
- [key: string]: string;
1527
- } | null;
1528
- object?: 'response';
1529
- parallel_tool_calls?: boolean | null;
1530
- previous_response_id?: string | null;
1531
- /**
1532
- * OpenAI compatible Prompt object that is used in OpenAI responses.
1533
- */
1534
- prompt?: ResponseListResponse.Prompt | null;
1535
- temperature?: number | null;
1536
- /**
1537
- * Text response configuration for OpenAI responses.
1538
- */
1539
- text?: ResponseListResponse.Text;
1540
- /**
1541
- * Constrains the tools available to the model to a pre-defined set.
1542
- */
1543
- tool_choice?: 'auto' | 'required' | 'none' | ResponseListResponse.OpenAIResponseInputToolChoiceAllowedTools | ResponseListResponse.OpenAIResponseInputToolChoiceFileSearch | ResponseListResponse.OpenAIResponseInputToolChoiceWebSearch | ResponseListResponse.OpenAIResponseInputToolChoiceFunctionTool | ResponseListResponse.OpenAIResponseInputToolChoiceMcpTool | ResponseListResponse.OpenAIResponseInputToolChoiceCustomTool | null;
1544
- tools?: Array<ResponseListResponse.OpenAIResponseInputToolWebSearch | ResponseListResponse.OpenAIResponseInputToolFileSearch | ResponseListResponse.OpenAIResponseInputToolFunction | ResponseListResponse.OpenAIResponseToolMcp> | null;
1545
- top_p?: number | null;
1546
- truncation?: string | null;
1547
- /**
1548
- * Usage information for OpenAI response.
1549
- */
1550
- usage?: ResponseListResponse.Usage | null;
1551
- }
1552
- export declare namespace ResponseListResponse {
1553
- /**
1554
- * Corresponds to the various Message types in the Responses API. They are all
1555
- * under one type because the Responses API gives them all the same "type" value,
1556
- * and there is no way to tell them apart in certain scenarios.
1557
- */
1558
- interface OpenAIResponseMessageOutput {
1559
- content: string | Array<OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal>;
1560
- role: 'system' | 'developer' | 'user' | 'assistant';
1561
- id?: string | null;
1562
- status?: string | null;
1563
- type?: 'message';
1564
- }
1565
- namespace OpenAIResponseMessageOutput {
1566
- /**
1567
- * Text content for input messages in OpenAI response format.
1568
- */
1569
- interface OpenAIResponseInputMessageContentText {
1570
- text: string;
1571
- type?: 'input_text';
1572
- }
1573
- /**
1574
- * Image content for input messages in OpenAI response format.
1575
- */
1576
- interface OpenAIResponseInputMessageContentImage {
1577
- detail?: 'low' | 'high' | 'auto';
1578
- file_id?: string | null;
1579
- image_url?: string | null;
1580
- type?: 'input_image';
1581
- }
1582
- /**
1583
- * File content for input messages in OpenAI response format.
1584
- */
1585
- interface OpenAIResponseInputMessageContentFile {
1586
- file_data?: string | null;
1587
- file_id?: string | null;
1588
- file_url?: string | null;
1589
- filename?: string | null;
1590
- type?: 'input_file';
1591
- }
1592
- interface OpenAIResponseOutputMessageContentOutputTextOutput {
1593
- text: string;
1594
- annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
1595
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
1596
- type?: 'output_text';
1597
- }
1598
- namespace OpenAIResponseOutputMessageContentOutputTextOutput {
1599
- /**
1600
- * File citation annotation for referencing specific files in response content.
1601
- */
1602
- interface OpenAIResponseAnnotationFileCitation {
1603
- file_id: string;
1604
- filename: string;
1605
- index: number;
1606
- type?: 'file_citation';
1607
- }
1608
- /**
1609
- * URL citation annotation for referencing external web resources.
1610
- */
1611
- interface OpenAIResponseAnnotationCitation {
1612
- end_index: number;
1613
- start_index: number;
1614
- title: string;
1615
- url: string;
1616
- type?: 'url_citation';
1617
- }
1618
- interface OpenAIResponseAnnotationContainerFileCitation {
1619
- container_id: string;
1620
- end_index: number;
1621
- file_id: string;
1622
- filename: string;
1623
- start_index: number;
1624
- type?: 'container_file_citation';
1625
- }
1626
- interface OpenAIResponseAnnotationFilePath {
1627
- file_id: string;
1628
- index: number;
1629
- type?: 'file_path';
1630
- }
1631
- /**
1632
- * The log probability for a token from an OpenAI-compatible chat completion
1633
- * response.
1634
- *
1635
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1636
- * probability of the token :top_logprobs: The top log probabilities for the token
1637
- */
1638
- interface Logprob {
1639
- token: string;
1640
- logprob: number;
1641
- bytes?: Array<number> | null;
1642
- top_logprobs?: Array<Logprob.TopLogprob> | null;
1643
- }
1644
- namespace Logprob {
1645
- /**
1646
- * The top log probability for a token from an OpenAI-compatible chat completion
1647
- * response.
1648
- *
1649
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1650
- * probability of the token
1651
- */
1652
- interface TopLogprob {
1653
- token: string;
1654
- logprob: number;
1655
- bytes?: Array<number> | null;
1656
- }
1657
- }
1658
- }
1659
- /**
1660
- * Refusal content within a streamed response part.
1661
- */
1662
- interface OpenAIResponseContentPartRefusal {
1663
- refusal: string;
1664
- type?: 'refusal';
1665
- }
1666
- }
1667
- /**
1668
- * Web search tool call output message for OpenAI responses.
1669
- */
1670
- interface OpenAIResponseOutputMessageWebSearchToolCall {
1671
- id: string;
1672
- status: string;
1673
- type?: 'web_search_call';
1674
- }
1675
- /**
1676
- * File search tool call output message for OpenAI responses.
1677
- */
1678
- interface OpenAIResponseOutputMessageFileSearchToolCall {
1679
- id: string;
1680
- queries: Array<string>;
1681
- status: string;
1682
- results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
1683
- type?: 'file_search_call';
1684
- }
1685
- namespace OpenAIResponseOutputMessageFileSearchToolCall {
1686
- /**
1687
- * Search results returned by the file search operation.
1688
- */
1689
- interface Result {
1690
- attributes: {
1691
- [key: string]: unknown;
1692
- };
1693
- file_id: string;
1694
- filename: string;
1695
- score: number;
1696
- text: string;
1697
- }
1698
- }
1699
- /**
1700
- * Function tool call output message for OpenAI responses.
1701
- */
1702
- interface OpenAIResponseOutputMessageFunctionToolCall {
1703
- arguments: string;
1704
- call_id: string;
1705
- name: string;
1706
- id?: string | null;
1707
- status?: string | null;
1708
- type?: 'function_call';
1709
- }
1710
- /**
1711
- * Model Context Protocol (MCP) call output message for OpenAI responses.
1712
- */
1713
- interface OpenAIResponseOutputMessageMcpCall {
1714
- id: string;
1715
- arguments: string;
1716
- name: string;
1717
- server_label: string;
1718
- error?: string | null;
1719
- output?: string | null;
1720
- type?: 'mcp_call';
1721
- }
1722
- /**
1723
- * MCP list tools output message containing available tools from an MCP server.
1724
- */
1725
- interface OpenAIResponseOutputMessageMcpListTools {
1726
- id: string;
1727
- server_label: string;
1728
- tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
1729
- type?: 'mcp_list_tools';
1730
- }
1731
- namespace OpenAIResponseOutputMessageMcpListTools {
1732
- /**
1733
- * Tool definition returned by MCP list tools operation.
1734
- */
1735
- interface Tool {
1736
- input_schema: {
1737
- [key: string]: unknown;
1738
- };
1739
- name: string;
1740
- description?: string | null;
1741
- }
1742
- }
1743
- /**
1744
- * A request for human approval of a tool invocation.
1745
- */
1746
- interface OpenAIResponseMcpApprovalRequest {
1747
- id: string;
1748
- arguments: string;
1749
- name: string;
1750
- server_label: string;
1751
- type?: 'mcp_approval_request';
1752
- }
1753
- /**
1754
- * This represents the output of a function call that gets passed back to the
1755
- * model.
1756
- */
1757
- interface OpenAIResponseInputFunctionToolCallOutput {
1758
- call_id: string;
1759
- output: string;
1760
- id?: string | null;
1761
- status?: string | null;
1762
- type?: 'function_call_output';
1763
- }
1764
- /**
1765
- * A response to an MCP approval request.
1766
- */
1767
- interface OpenAIResponseMcpApprovalResponse {
1768
- approval_request_id: string;
1769
- approve: boolean;
1770
- id?: string | null;
1771
- reason?: string | null;
1772
- type?: 'mcp_approval_response';
1773
- }
1774
- /**
1775
- * Corresponds to the various Message types in the Responses API. They are all
1776
- * under one type because the Responses API gives them all the same "type" value,
1777
- * and there is no way to tell them apart in certain scenarios.
1778
- */
1779
- interface OpenAIResponseMessageOutput {
1780
- content: string | Array<OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal>;
1781
- role: 'system' | 'developer' | 'user' | 'assistant';
1782
- id?: string | null;
1783
- status?: string | null;
1784
- type?: 'message';
1785
- }
1786
- namespace OpenAIResponseMessageOutput {
1787
- /**
1788
- * Text content for input messages in OpenAI response format.
1789
- */
1790
- interface OpenAIResponseInputMessageContentText {
1791
- text: string;
1792
- type?: 'input_text';
1793
- }
1794
- /**
1795
- * Image content for input messages in OpenAI response format.
1796
- */
1797
- interface OpenAIResponseInputMessageContentImage {
1798
- detail?: 'low' | 'high' | 'auto';
1799
- file_id?: string | null;
1800
- image_url?: string | null;
1801
- type?: 'input_image';
1802
- }
1803
- /**
1804
- * File content for input messages in OpenAI response format.
1805
- */
1806
- interface OpenAIResponseInputMessageContentFile {
1807
- file_data?: string | null;
1808
- file_id?: string | null;
1809
- file_url?: string | null;
1810
- filename?: string | null;
1811
- type?: 'input_file';
1812
- }
1813
- interface OpenAIResponseOutputMessageContentOutputTextOutput {
1814
- text: string;
1815
- annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
1816
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
1817
- type?: 'output_text';
1818
- }
1819
- namespace OpenAIResponseOutputMessageContentOutputTextOutput {
1820
- /**
1821
- * File citation annotation for referencing specific files in response content.
1822
- */
1823
- interface OpenAIResponseAnnotationFileCitation {
1824
- file_id: string;
1825
- filename: string;
1826
- index: number;
1827
- type?: 'file_citation';
1828
- }
1829
- /**
1830
- * URL citation annotation for referencing external web resources.
1831
- */
1832
- interface OpenAIResponseAnnotationCitation {
1833
- end_index: number;
1834
- start_index: number;
1835
- title: string;
1836
- url: string;
1837
- type?: 'url_citation';
1838
- }
1839
- interface OpenAIResponseAnnotationContainerFileCitation {
1840
- container_id: string;
1841
- end_index: number;
1842
- file_id: string;
1843
- filename: string;
1844
- start_index: number;
1845
- type?: 'container_file_citation';
1846
- }
1847
- interface OpenAIResponseAnnotationFilePath {
1848
- file_id: string;
1849
- index: number;
1850
- type?: 'file_path';
1851
- }
1852
- /**
1853
- * The log probability for a token from an OpenAI-compatible chat completion
1854
- * response.
1855
- *
1856
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1857
- * probability of the token :top_logprobs: The top log probabilities for the token
1858
- */
1859
- interface Logprob {
1860
- token: string;
1861
- logprob: number;
1862
- bytes?: Array<number> | null;
1863
- top_logprobs?: Array<Logprob.TopLogprob> | null;
1864
- }
1865
- namespace Logprob {
1866
- /**
1867
- * The top log probability for a token from an OpenAI-compatible chat completion
1868
- * response.
1869
- *
1870
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1871
- * probability of the token
1872
- */
1873
- interface TopLogprob {
1874
- token: string;
1875
- logprob: number;
1876
- bytes?: Array<number> | null;
1877
- }
1878
- }
1879
- }
1880
- /**
1881
- * Refusal content within a streamed response part.
1882
- */
1883
- interface OpenAIResponseContentPartRefusal {
1884
- refusal: string;
1885
- type?: 'refusal';
1886
- }
1887
- }
1888
- /**
1889
- * Corresponds to the various Message types in the Responses API. They are all
1890
- * under one type because the Responses API gives them all the same "type" value,
1891
- * and there is no way to tell them apart in certain scenarios.
1892
- */
1893
- interface OpenAIResponseMessageOutput {
1894
- content: string | Array<OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal>;
1895
- role: 'system' | 'developer' | 'user' | 'assistant';
1896
- id?: string | null;
1897
- status?: string | null;
1898
- type?: 'message';
1899
- }
1900
- namespace OpenAIResponseMessageOutput {
1901
- /**
1902
- * Text content for input messages in OpenAI response format.
1903
- */
1904
- interface OpenAIResponseInputMessageContentText {
1905
- text: string;
1906
- type?: 'input_text';
1907
- }
1908
- /**
1909
- * Image content for input messages in OpenAI response format.
1910
- */
1911
- interface OpenAIResponseInputMessageContentImage {
1912
- detail?: 'low' | 'high' | 'auto';
1913
- file_id?: string | null;
1914
- image_url?: string | null;
1915
- type?: 'input_image';
1916
- }
1917
- /**
1918
- * File content for input messages in OpenAI response format.
1919
- */
1920
- interface OpenAIResponseInputMessageContentFile {
1921
- file_data?: string | null;
1922
- file_id?: string | null;
1923
- file_url?: string | null;
1924
- filename?: string | null;
1925
- type?: 'input_file';
1926
- }
1927
- interface OpenAIResponseOutputMessageContentOutputTextOutput {
1928
- text: string;
1929
- annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
1930
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
1931
- type?: 'output_text';
1932
- }
1933
- namespace OpenAIResponseOutputMessageContentOutputTextOutput {
1934
- /**
1935
- * File citation annotation for referencing specific files in response content.
1936
- */
1937
- interface OpenAIResponseAnnotationFileCitation {
1938
- file_id: string;
1939
- filename: string;
1940
- index: number;
1941
- type?: 'file_citation';
1942
- }
1943
- /**
1944
- * URL citation annotation for referencing external web resources.
1945
- */
1946
- interface OpenAIResponseAnnotationCitation {
1947
- end_index: number;
1948
- start_index: number;
1949
- title: string;
1950
- url: string;
1951
- type?: 'url_citation';
1952
- }
1953
- interface OpenAIResponseAnnotationContainerFileCitation {
1954
- container_id: string;
1955
- end_index: number;
1956
- file_id: string;
1957
- filename: string;
1958
- start_index: number;
1959
- type?: 'container_file_citation';
1960
- }
1961
- interface OpenAIResponseAnnotationFilePath {
1962
- file_id: string;
1963
- index: number;
1964
- type?: 'file_path';
1965
- }
1966
- /**
1967
- * The log probability for a token from an OpenAI-compatible chat completion
1968
- * response.
1969
- *
1970
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1971
- * probability of the token :top_logprobs: The top log probabilities for the token
1972
- */
1973
- interface Logprob {
1974
- token: string;
1975
- logprob: number;
1976
- bytes?: Array<number> | null;
1977
- top_logprobs?: Array<Logprob.TopLogprob> | null;
1978
- }
1979
- namespace Logprob {
1980
- /**
1981
- * The top log probability for a token from an OpenAI-compatible chat completion
1982
- * response.
1983
- *
1984
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
1985
- * probability of the token
1986
- */
1987
- interface TopLogprob {
1988
- token: string;
1989
- logprob: number;
1990
- bytes?: Array<number> | null;
1991
- }
1992
- }
1993
- }
1994
- /**
1995
- * Refusal content within a streamed response part.
1996
- */
1997
- interface OpenAIResponseContentPartRefusal {
1998
- refusal: string;
1999
- type?: 'refusal';
2000
- }
2001
- }
2002
- /**
2003
- * Web search tool call output message for OpenAI responses.
2004
- */
2005
- interface OpenAIResponseOutputMessageWebSearchToolCall {
2006
- id: string;
2007
- status: string;
2008
- type?: 'web_search_call';
2009
- }
2010
- /**
2011
- * File search tool call output message for OpenAI responses.
2012
- */
2013
- interface OpenAIResponseOutputMessageFileSearchToolCall {
2014
- id: string;
2015
- queries: Array<string>;
2016
- status: string;
2017
- results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
2018
- type?: 'file_search_call';
2019
- }
2020
- namespace OpenAIResponseOutputMessageFileSearchToolCall {
2021
- /**
2022
- * Search results returned by the file search operation.
2023
- */
2024
- interface Result {
2025
- attributes: {
2026
- [key: string]: unknown;
2027
- };
2028
- file_id: string;
2029
- filename: string;
2030
- score: number;
2031
- text: string;
2032
- }
2033
- }
2034
- /**
2035
- * Function tool call output message for OpenAI responses.
2036
- */
2037
- interface OpenAIResponseOutputMessageFunctionToolCall {
2038
- arguments: string;
2039
- call_id: string;
2040
- name: string;
2041
- id?: string | null;
2042
- status?: string | null;
2043
- type?: 'function_call';
2044
- }
2045
- /**
2046
- * Model Context Protocol (MCP) call output message for OpenAI responses.
2047
- */
2048
- interface OpenAIResponseOutputMessageMcpCall {
2049
- id: string;
2050
- arguments: string;
2051
- name: string;
2052
- server_label: string;
2053
- error?: string | null;
2054
- output?: string | null;
2055
- type?: 'mcp_call';
2056
- }
2057
- /**
2058
- * MCP list tools output message containing available tools from an MCP server.
2059
- */
2060
- interface OpenAIResponseOutputMessageMcpListTools {
2061
- id: string;
2062
- server_label: string;
2063
- tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
2064
- type?: 'mcp_list_tools';
2065
- }
2066
- namespace OpenAIResponseOutputMessageMcpListTools {
2067
- /**
2068
- * Tool definition returned by MCP list tools operation.
2069
- */
2070
- interface Tool {
2071
- input_schema: {
2072
- [key: string]: unknown;
2073
- };
2074
- name: string;
2075
- description?: string | null;
2076
- }
2077
- }
2078
- /**
2079
- * A request for human approval of a tool invocation.
2080
- */
2081
- interface OpenAIResponseMcpApprovalRequest {
2082
- id: string;
2083
- arguments: string;
2084
- name: string;
2085
- server_label: string;
2086
- type?: 'mcp_approval_request';
2087
- }
2088
- /**
2089
- * Error details for failed OpenAI response requests.
2090
- */
2091
- interface Error {
2092
- code: string;
2093
- message: string;
2094
- }
2095
- /**
2096
- * OpenAI compatible Prompt object that is used in OpenAI responses.
2097
- */
2098
- interface Prompt {
2099
- id: string;
2100
- variables?: {
2101
- [key: string]: Prompt.OpenAIResponseInputMessageContentText | Prompt.OpenAIResponseInputMessageContentImage | Prompt.OpenAIResponseInputMessageContentFile;
2102
- } | null;
2103
- version?: string | null;
2104
- }
2105
- namespace Prompt {
2106
- /**
2107
- * Text content for input messages in OpenAI response format.
2108
- */
2109
- interface OpenAIResponseInputMessageContentText {
2110
- text: string;
2111
- type?: 'input_text';
2112
- }
2113
- /**
2114
- * Image content for input messages in OpenAI response format.
2115
- */
2116
- interface OpenAIResponseInputMessageContentImage {
2117
- detail?: 'low' | 'high' | 'auto';
2118
- file_id?: string | null;
2119
- image_url?: string | null;
2120
- type?: 'input_image';
2121
- }
2122
- /**
2123
- * File content for input messages in OpenAI response format.
2124
- */
2125
- interface OpenAIResponseInputMessageContentFile {
2126
- file_data?: string | null;
2127
- file_id?: string | null;
2128
- file_url?: string | null;
2129
- filename?: string | null;
2130
- type?: 'input_file';
2131
- }
2132
- }
2133
- /**
2134
- * Text response configuration for OpenAI responses.
2135
- */
2136
- interface Text {
2137
- /**
2138
- * Configuration for Responses API text format.
2139
- */
2140
- format?: Text.Format | null;
2141
- }
2142
- namespace Text {
2143
- /**
2144
- * Configuration for Responses API text format.
2145
- */
2146
- interface Format {
2147
- description?: string | null;
2148
- name?: string | null;
2149
- schema?: {
2150
- [key: string]: unknown;
2151
- } | null;
2152
- strict?: boolean | null;
2153
- type?: 'text' | 'json_schema' | 'json_object';
2154
- }
2155
- }
2156
- /**
2157
- * Constrains the tools available to the model to a pre-defined set.
2158
- */
2159
- interface OpenAIResponseInputToolChoiceAllowedTools {
2160
- tools: Array<{
2161
- [key: string]: string;
2162
- }>;
2163
- mode?: 'auto' | 'required';
2164
- type?: 'allowed_tools';
2165
- }
2166
- /**
2167
- * Indicates that the model should use file search to generate a response.
2168
- */
2169
- interface OpenAIResponseInputToolChoiceFileSearch {
2170
- type?: 'file_search';
2171
- }
2172
- /**
2173
- * Indicates that the model should use web search to generate a response
2174
- */
2175
- interface OpenAIResponseInputToolChoiceWebSearch {
2176
- type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
2177
- }
2178
- /**
2179
- * Forces the model to call a specific function.
2180
- */
2181
- interface OpenAIResponseInputToolChoiceFunctionTool {
2182
- name: string;
2183
- type?: 'function';
2184
- }
2185
- /**
2186
- * Forces the model to call a specific tool on a remote MCP server
2187
- */
2188
- interface OpenAIResponseInputToolChoiceMcpTool {
2189
- server_label: string;
2190
- name?: string | null;
2191
- type?: 'mcp';
2192
- }
2193
- /**
2194
- * Forces the model to call a custom tool.
2195
- */
2196
- interface OpenAIResponseInputToolChoiceCustomTool {
2197
- name: string;
2198
- type?: 'custom';
2199
- }
2200
- /**
2201
- * Web search tool configuration for OpenAI response inputs.
2202
- */
2203
- interface OpenAIResponseInputToolWebSearch {
2204
- search_context_size?: string | null;
2205
- type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
2206
- }
2207
- /**
2208
- * File search tool configuration for OpenAI response inputs.
2209
- */
2210
- interface OpenAIResponseInputToolFileSearch {
2211
- vector_store_ids: Array<string>;
2212
- filters?: {
2213
- [key: string]: unknown;
2214
- } | null;
2215
- max_num_results?: number | null;
2216
- /**
2217
- * Options for ranking and filtering search results.
2218
- */
2219
- ranking_options?: OpenAIResponseInputToolFileSearch.RankingOptions | null;
2220
- type?: 'file_search';
2221
- }
2222
- namespace OpenAIResponseInputToolFileSearch {
2223
- /**
2224
- * Options for ranking and filtering search results.
2225
- */
2226
- interface RankingOptions {
2227
- ranker?: string | null;
2228
- score_threshold?: number | null;
2229
- }
2230
- }
2231
- /**
2232
- * Function tool configuration for OpenAI response inputs.
2233
- */
2234
- interface OpenAIResponseInputToolFunction {
2235
- name: string;
2236
- parameters: {
2237
- [key: string]: unknown;
2238
- } | null;
2239
- description?: string | null;
2240
- strict?: boolean | null;
2241
- type?: 'function';
2242
- }
2243
- /**
2244
- * Model Context Protocol (MCP) tool configuration for OpenAI response object.
2245
- */
2246
- interface OpenAIResponseToolMcp {
2247
- server_label: string;
2248
- /**
2249
- * Filter configuration for restricting which MCP tools can be used.
2250
- */
2251
- allowed_tools?: Array<string> | OpenAIResponseToolMcp.AllowedToolsFilter | null;
2252
- type?: 'mcp';
2253
- }
2254
- namespace OpenAIResponseToolMcp {
2255
- /**
2256
- * Filter configuration for restricting which MCP tools can be used.
2257
- */
2258
- interface AllowedToolsFilter {
2259
- tool_names?: Array<string> | null;
2260
- }
2261
- }
2262
- /**
2263
- * Usage information for OpenAI response.
2264
- */
2265
- interface Usage {
2266
- input_tokens: number;
2267
- output_tokens: number;
2268
- total_tokens: number;
2269
- /**
2270
- * Token details for input tokens in OpenAI response usage.
2271
- */
2272
- input_tokens_details?: Usage.InputTokensDetails | null;
2273
- /**
2274
- * Token details for output tokens in OpenAI response usage.
2275
- */
2276
- output_tokens_details?: Usage.OutputTokensDetails | null;
2277
- }
2278
- namespace Usage {
2279
- /**
2280
- * Token details for input tokens in OpenAI response usage.
2281
- */
2282
- interface InputTokensDetails {
2283
- cached_tokens?: number | null;
2284
- }
2285
- /**
2286
- * Token details for output tokens in OpenAI response usage.
2287
- */
2288
- interface OutputTokensDetails {
2289
- reasoning_tokens?: number | null;
2290
- }
2291
- }
2292
- }
2293
- /**
2294
- * Response object confirming deletion of an OpenAI response.
2295
- */
2296
- export interface ResponseDeleteResponse {
2297
- id: string;
2298
- deleted?: boolean;
2299
- object?: 'response';
2300
- }
2301
- export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCreateParamsStreaming;
2302
- export interface ResponseCreateParamsBase {
2303
- input: string | Array<ResponseCreateParams.OpenAIResponseMessageInput | ResponseCreateParams.OpenAIResponseOutputMessageWebSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpListTools | ResponseCreateParams.OpenAIResponseMcpApprovalRequest | ResponseCreateParams.OpenAIResponseInputFunctionToolCallOutput | ResponseCreateParams.OpenAIResponseMcpApprovalResponse | ResponseCreateParams.OpenAIResponseMessageInput>;
2304
- model: string;
2305
- conversation?: string | null;
2306
- include?: Array<'web_search_call.action.sources' | 'code_interpreter_call.outputs' | 'computer_call_output.output.image_url' | 'file_search_call.results' | 'message.input_image.image_url' | 'message.output_text.logprobs' | 'reasoning.encrypted_content'> | null;
2307
- instructions?: string | null;
2308
- max_infer_iters?: number | null;
2309
- max_tool_calls?: number | null;
2310
- metadata?: {
2311
- [key: string]: string;
2312
- } | null;
2313
- parallel_tool_calls?: boolean | null;
2314
- previous_response_id?: string | null;
2315
- /**
2316
- * OpenAI compatible Prompt object that is used in OpenAI responses.
2317
- */
2318
- prompt?: ResponseCreateParams.Prompt | null;
2319
- store?: boolean | null;
2320
- stream?: boolean | null;
2321
- temperature?: number | null;
2322
- /**
2323
- * Text response configuration for OpenAI responses.
2324
- */
2325
- text?: ResponseCreateParams.Text | null;
2326
- /**
2327
- * Constrains the tools available to the model to a pre-defined set.
2328
- */
2329
- tool_choice?: 'auto' | 'required' | 'none' | ResponseCreateParams.OpenAIResponseInputToolChoiceAllowedTools | ResponseCreateParams.OpenAIResponseInputToolChoiceFileSearch | ResponseCreateParams.OpenAIResponseInputToolChoiceWebSearch | ResponseCreateParams.OpenAIResponseInputToolChoiceFunctionTool | ResponseCreateParams.OpenAIResponseInputToolChoiceMcpTool | ResponseCreateParams.OpenAIResponseInputToolChoiceCustomTool | null;
2330
- tools?: Array<ResponseCreateParams.OpenAIResponseInputToolWebSearch | ResponseCreateParams.OpenAIResponseInputToolFileSearch | ResponseCreateParams.OpenAIResponseInputToolFunction | ResponseCreateParams.OpenAIResponseInputToolMcp> | null;
2331
- }
2332
- export declare namespace ResponseCreateParams {
2333
- /**
2334
- * Corresponds to the various Message types in the Responses API. They are all
2335
- * under one type because the Responses API gives them all the same "type" value,
2336
- * and there is no way to tell them apart in certain scenarios.
2337
- */
2338
- interface OpenAIResponseMessageInput {
2339
- content: string | Array<OpenAIResponseMessageInput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageInput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageInput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageInput.OpenAIResponseOutputMessageContentOutputTextInput | OpenAIResponseMessageInput.OpenAIResponseContentPartRefusal>;
2340
- role: 'system' | 'developer' | 'user' | 'assistant';
2341
- id?: string | null;
2342
- status?: string | null;
2343
- type?: 'message';
2344
- }
2345
- namespace OpenAIResponseMessageInput {
2346
- /**
2347
- * Text content for input messages in OpenAI response format.
2348
- */
2349
- interface OpenAIResponseInputMessageContentText {
2350
- text: string;
2351
- type?: 'input_text';
2352
- }
2353
- /**
2354
- * Image content for input messages in OpenAI response format.
2355
- */
2356
- interface OpenAIResponseInputMessageContentImage {
2357
- detail?: 'low' | 'high' | 'auto';
2358
- file_id?: string | null;
2359
- image_url?: string | null;
2360
- type?: 'input_image';
2361
- }
2362
- /**
2363
- * File content for input messages in OpenAI response format.
2364
- */
2365
- interface OpenAIResponseInputMessageContentFile {
2366
- file_data?: string | null;
2367
- file_id?: string | null;
2368
- file_url?: string | null;
2369
- filename?: string | null;
2370
- type?: 'input_file';
2371
- }
2372
- interface OpenAIResponseOutputMessageContentOutputTextInput {
2373
- text: string;
2374
- annotations?: Array<OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFilePath>;
2375
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextInput.Logprob> | null;
2376
- type?: 'output_text';
2377
- }
2378
- namespace OpenAIResponseOutputMessageContentOutputTextInput {
2379
- /**
2380
- * File citation annotation for referencing specific files in response content.
2381
- */
2382
- interface OpenAIResponseAnnotationFileCitation {
2383
- file_id: string;
2384
- filename: string;
2385
- index: number;
2386
- type?: 'file_citation';
2387
- }
2388
- /**
2389
- * URL citation annotation for referencing external web resources.
2390
- */
2391
- interface OpenAIResponseAnnotationCitation {
2392
- end_index: number;
2393
- start_index: number;
2394
- title: string;
2395
- url: string;
2396
- type?: 'url_citation';
2397
- }
2398
- interface OpenAIResponseAnnotationContainerFileCitation {
2399
- container_id: string;
2400
- end_index: number;
2401
- file_id: string;
2402
- filename: string;
2403
- start_index: number;
2404
- type?: 'container_file_citation';
2405
- }
2406
- interface OpenAIResponseAnnotationFilePath {
2407
- file_id: string;
2408
- index: number;
2409
- type?: 'file_path';
2410
- }
2411
- /**
2412
- * The log probability for a token from an OpenAI-compatible chat completion
2413
- * response.
2414
- *
2415
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
2416
- * probability of the token :top_logprobs: The top log probabilities for the token
2417
- */
2418
- interface Logprob {
2419
- token: string;
2420
- logprob: number;
2421
- bytes?: Array<number> | null;
2422
- top_logprobs?: Array<Logprob.TopLogprob> | null;
2423
- }
2424
- namespace Logprob {
2425
- /**
2426
- * The top log probability for a token from an OpenAI-compatible chat completion
2427
- * response.
2428
- *
2429
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
2430
- * probability of the token
2431
- */
2432
- interface TopLogprob {
2433
- token: string;
2434
- logprob: number;
2435
- bytes?: Array<number> | null;
2436
- }
2437
- }
2438
- }
2439
- /**
2440
- * Refusal content within a streamed response part.
2441
- */
2442
- interface OpenAIResponseContentPartRefusal {
2443
- refusal: string;
2444
- type?: 'refusal';
2445
- }
2446
- }
2447
- /**
2448
- * Web search tool call output message for OpenAI responses.
2449
- */
2450
- interface OpenAIResponseOutputMessageWebSearchToolCall {
2451
- id: string;
2452
- status: string;
2453
- type?: 'web_search_call';
2454
- }
2455
- /**
2456
- * File search tool call output message for OpenAI responses.
2457
- */
2458
- interface OpenAIResponseOutputMessageFileSearchToolCall {
2459
- id: string;
2460
- queries: Array<string>;
2461
- status: string;
2462
- results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
2463
- type?: 'file_search_call';
2464
- }
2465
- namespace OpenAIResponseOutputMessageFileSearchToolCall {
2466
- /**
2467
- * Search results returned by the file search operation.
2468
- */
2469
- interface Result {
2470
- attributes: {
2471
- [key: string]: unknown;
2472
- };
2473
- file_id: string;
2474
- filename: string;
2475
- score: number;
2476
- text: string;
2477
- }
2478
- }
2479
- /**
2480
- * Function tool call output message for OpenAI responses.
2481
- */
2482
- interface OpenAIResponseOutputMessageFunctionToolCall {
2483
- arguments: string;
2484
- call_id: string;
2485
- name: string;
2486
- id?: string | null;
2487
- status?: string | null;
2488
- type?: 'function_call';
2489
- }
2490
- /**
2491
- * Model Context Protocol (MCP) call output message for OpenAI responses.
2492
- */
2493
- interface OpenAIResponseOutputMessageMcpCall {
2494
- id: string;
2495
- arguments: string;
2496
- name: string;
2497
- server_label: string;
2498
- error?: string | null;
2499
- output?: string | null;
2500
- type?: 'mcp_call';
2501
- }
2502
- /**
2503
- * MCP list tools output message containing available tools from an MCP server.
2504
- */
2505
- interface OpenAIResponseOutputMessageMcpListTools {
2506
- id: string;
2507
- server_label: string;
2508
- tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
2509
- type?: 'mcp_list_tools';
2510
- }
2511
- namespace OpenAIResponseOutputMessageMcpListTools {
2512
- /**
2513
- * Tool definition returned by MCP list tools operation.
2514
- */
2515
- interface Tool {
2516
- input_schema: {
2517
- [key: string]: unknown;
2518
- };
2519
- name: string;
2520
- description?: string | null;
2521
- }
2522
- }
2523
- /**
2524
- * A request for human approval of a tool invocation.
2525
- */
2526
- interface OpenAIResponseMcpApprovalRequest {
2527
- id: string;
2528
- arguments: string;
2529
- name: string;
2530
- server_label: string;
2531
- type?: 'mcp_approval_request';
2532
- }
2533
- /**
2534
- * This represents the output of a function call that gets passed back to the
2535
- * model.
2536
- */
2537
- interface OpenAIResponseInputFunctionToolCallOutput {
2538
- call_id: string;
2539
- output: string;
2540
- id?: string | null;
2541
- status?: string | null;
2542
- type?: 'function_call_output';
2543
- }
2544
- /**
2545
- * A response to an MCP approval request.
2546
- */
2547
- interface OpenAIResponseMcpApprovalResponse {
2548
- approval_request_id: string;
2549
- approve: boolean;
2550
- id?: string | null;
2551
- reason?: string | null;
2552
- type?: 'mcp_approval_response';
2553
- }
2554
- /**
2555
- * Corresponds to the various Message types in the Responses API. They are all
2556
- * under one type because the Responses API gives them all the same "type" value,
2557
- * and there is no way to tell them apart in certain scenarios.
2558
- */
2559
- interface OpenAIResponseMessageInput {
2560
- content: string | Array<OpenAIResponseMessageInput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageInput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageInput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageInput.OpenAIResponseOutputMessageContentOutputTextInput | OpenAIResponseMessageInput.OpenAIResponseContentPartRefusal>;
2561
- role: 'system' | 'developer' | 'user' | 'assistant';
2562
- id?: string | null;
2563
- status?: string | null;
2564
- type?: 'message';
2565
- }
2566
- namespace OpenAIResponseMessageInput {
2567
- /**
2568
- * Text content for input messages in OpenAI response format.
2569
- */
2570
- interface OpenAIResponseInputMessageContentText {
2571
- text: string;
2572
- type?: 'input_text';
2573
- }
2574
- /**
2575
- * Image content for input messages in OpenAI response format.
2576
- */
2577
- interface OpenAIResponseInputMessageContentImage {
2578
- detail?: 'low' | 'high' | 'auto';
2579
- file_id?: string | null;
2580
- image_url?: string | null;
2581
- type?: 'input_image';
2582
- }
2583
- /**
2584
- * File content for input messages in OpenAI response format.
2585
- */
2586
- interface OpenAIResponseInputMessageContentFile {
2587
- file_data?: string | null;
2588
- file_id?: string | null;
2589
- file_url?: string | null;
2590
- filename?: string | null;
2591
- type?: 'input_file';
2592
- }
2593
- interface OpenAIResponseOutputMessageContentOutputTextInput {
2594
- text: string;
2595
- annotations?: Array<OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFilePath>;
2596
- logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextInput.Logprob> | null;
2597
- type?: 'output_text';
2598
- }
2599
- namespace OpenAIResponseOutputMessageContentOutputTextInput {
2600
- /**
2601
- * File citation annotation for referencing specific files in response content.
2602
- */
2603
- interface OpenAIResponseAnnotationFileCitation {
2604
- file_id: string;
2605
- filename: string;
2606
- index: number;
2607
- type?: 'file_citation';
2608
- }
2609
- /**
2610
- * URL citation annotation for referencing external web resources.
2611
- */
2612
- interface OpenAIResponseAnnotationCitation {
2613
- end_index: number;
2614
- start_index: number;
2615
- title: string;
2616
- url: string;
2617
- type?: 'url_citation';
2618
- }
2619
- interface OpenAIResponseAnnotationContainerFileCitation {
2620
- container_id: string;
2621
- end_index: number;
2622
- file_id: string;
2623
- filename: string;
2624
- start_index: number;
2625
- type?: 'container_file_citation';
2626
- }
2627
- interface OpenAIResponseAnnotationFilePath {
2628
- file_id: string;
2629
- index: number;
2630
- type?: 'file_path';
2631
- }
2632
- /**
2633
- * The log probability for a token from an OpenAI-compatible chat completion
2634
- * response.
2635
- *
2636
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
2637
- * probability of the token :top_logprobs: The top log probabilities for the token
2638
- */
2639
- interface Logprob {
2640
- token: string;
2641
- logprob: number;
2642
- bytes?: Array<number> | null;
2643
- top_logprobs?: Array<Logprob.TopLogprob> | null;
2644
- }
2645
- namespace Logprob {
2646
- /**
2647
- * The top log probability for a token from an OpenAI-compatible chat completion
2648
- * response.
2649
- *
2650
- * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
2651
- * probability of the token
2652
- */
2653
- interface TopLogprob {
2654
- token: string;
2655
- logprob: number;
2656
- bytes?: Array<number> | null;
2657
- }
2658
- }
2659
- }
2660
- /**
2661
- * Refusal content within a streamed response part.
2662
- */
2663
- interface OpenAIResponseContentPartRefusal {
2664
- refusal: string;
2665
- type?: 'refusal';
2666
- }
2667
- }
2668
- /**
2669
- * OpenAI compatible Prompt object that is used in OpenAI responses.
2670
- */
2671
- interface Prompt {
2672
- id: string;
2673
- variables?: {
2674
- [key: string]: Prompt.OpenAIResponseInputMessageContentText | Prompt.OpenAIResponseInputMessageContentImage | Prompt.OpenAIResponseInputMessageContentFile;
2675
- } | null;
2676
- version?: string | null;
2677
- }
2678
- namespace Prompt {
2679
- /**
2680
- * Text content for input messages in OpenAI response format.
2681
- */
2682
- interface OpenAIResponseInputMessageContentText {
2683
- text: string;
2684
- type?: 'input_text';
2685
- }
2686
- /**
2687
- * Image content for input messages in OpenAI response format.
2688
- */
2689
- interface OpenAIResponseInputMessageContentImage {
2690
- detail?: 'low' | 'high' | 'auto';
2691
- file_id?: string | null;
2692
- image_url?: string | null;
2693
- type?: 'input_image';
2694
- }
2695
- /**
2696
- * File content for input messages in OpenAI response format.
2697
- */
2698
- interface OpenAIResponseInputMessageContentFile {
2699
- file_data?: string | null;
2700
- file_id?: string | null;
2701
- file_url?: string | null;
2702
- filename?: string | null;
2703
- type?: 'input_file';
2704
- }
2705
- }
2706
- /**
2707
- * Text response configuration for OpenAI responses.
2708
- */
2709
- interface Text {
2710
- /**
2711
- * Configuration for Responses API text format.
2712
- */
2713
- format?: Text.Format | null;
2714
- }
2715
- namespace Text {
2716
- /**
2717
- * Configuration for Responses API text format.
2718
- */
2719
- interface Format {
2720
- description?: string | null;
2721
- name?: string | null;
2722
- schema?: {
2723
- [key: string]: unknown;
2724
- } | null;
2725
- strict?: boolean | null;
2726
- type?: 'text' | 'json_schema' | 'json_object';
2727
- }
2728
- }
2729
- /**
2730
- * Constrains the tools available to the model to a pre-defined set.
2731
- */
2732
- interface OpenAIResponseInputToolChoiceAllowedTools {
2733
- tools: Array<{
2734
- [key: string]: string;
2735
- }>;
2736
- mode?: 'auto' | 'required';
2737
- type?: 'allowed_tools';
2738
- }
2739
- /**
2740
- * Indicates that the model should use file search to generate a response.
2741
- */
2742
- interface OpenAIResponseInputToolChoiceFileSearch {
2743
- type?: 'file_search';
2744
- }
2745
- /**
2746
- * Indicates that the model should use web search to generate a response
2747
- */
2748
- interface OpenAIResponseInputToolChoiceWebSearch {
2749
- type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
2750
- }
2751
- /**
2752
- * Forces the model to call a specific function.
2753
- */
2754
- interface OpenAIResponseInputToolChoiceFunctionTool {
2755
- name: string;
2756
- type?: 'function';
2757
- }
2758
- /**
2759
- * Forces the model to call a specific tool on a remote MCP server
2760
- */
2761
- interface OpenAIResponseInputToolChoiceMcpTool {
2762
- server_label: string;
2763
- name?: string | null;
2764
- type?: 'mcp';
2765
- }
2766
- /**
2767
- * Forces the model to call a custom tool.
2768
- */
2769
- interface OpenAIResponseInputToolChoiceCustomTool {
2770
- name: string;
2771
- type?: 'custom';
2772
- }
2773
- /**
2774
- * Web search tool configuration for OpenAI response inputs.
2775
- */
2776
- interface OpenAIResponseInputToolWebSearch {
2777
- search_context_size?: string | null;
2778
- type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
2779
- }
2780
- /**
2781
- * File search tool configuration for OpenAI response inputs.
2782
- */
2783
- interface OpenAIResponseInputToolFileSearch {
2784
- vector_store_ids: Array<string>;
2785
- filters?: {
2786
- [key: string]: unknown;
2787
- } | null;
2788
- max_num_results?: number | null;
2789
- /**
2790
- * Options for ranking and filtering search results.
2791
- */
2792
- ranking_options?: OpenAIResponseInputToolFileSearch.RankingOptions | null;
2793
- type?: 'file_search';
2794
- }
2795
- namespace OpenAIResponseInputToolFileSearch {
2796
- /**
2797
- * Options for ranking and filtering search results.
2798
- */
2799
- interface RankingOptions {
2800
- ranker?: string | null;
2801
- score_threshold?: number | null;
2802
- }
2803
- }
2804
- /**
2805
- * Function tool configuration for OpenAI response inputs.
2806
- */
2807
- interface OpenAIResponseInputToolFunction {
2808
- name: string;
2809
- parameters: {
2810
- [key: string]: unknown;
2811
- } | null;
2812
- description?: string | null;
2813
- strict?: boolean | null;
2814
- type?: 'function';
2815
- }
2816
- /**
2817
- * Model Context Protocol (MCP) tool configuration for OpenAI response inputs.
2818
- */
2819
- interface OpenAIResponseInputToolMcp {
2820
- server_label: string;
2821
- server_url: string;
2822
- /**
2823
- * Filter configuration for restricting which MCP tools can be used.
2824
- */
2825
- allowed_tools?: Array<string> | OpenAIResponseInputToolMcp.AllowedToolsFilter | null;
2826
- authorization?: string | null;
2827
- headers?: {
2828
- [key: string]: unknown;
2829
- } | null;
2830
- /**
2831
- * Filter configuration for MCP tool approval requirements.
2832
- */
2833
- require_approval?: 'always' | 'never' | OpenAIResponseInputToolMcp.ApprovalFilter;
2834
- type?: 'mcp';
2835
- }
2836
- namespace OpenAIResponseInputToolMcp {
2837
- /**
2838
- * Filter configuration for restricting which MCP tools can be used.
2839
- */
2840
- interface AllowedToolsFilter {
2841
- tool_names?: Array<string> | null;
2842
- }
2843
- /**
2844
- * Filter configuration for MCP tool approval requirements.
2845
- */
2846
- interface ApprovalFilter {
2847
- always?: Array<string> | null;
2848
- never?: Array<string> | null;
2849
- }
2850
- }
2851
- type ResponseCreateParamsNonStreaming = ResponsesAPI.ResponseCreateParamsNonStreaming;
2852
- type ResponseCreateParamsStreaming = ResponsesAPI.ResponseCreateParamsStreaming;
2853
- }
2854
- export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBase {
2855
- stream?: false | null;
2856
- }
2857
- export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase {
2858
- stream: true;
2859
- }
2860
- export interface ResponseListParams extends OpenAICursorPageParams {
2861
- model?: string | null;
2862
- /**
2863
- * Sort order for paginated responses.
2864
- */
2865
- order?: 'asc' | 'desc' | null;
2866
- }
2867
- export declare namespace Responses {
2868
- export { type ResponseObject as ResponseObject, type ResponseObjectStream as ResponseObjectStream, type ResponseListResponse as ResponseListResponse, type ResponseDeleteResponse as ResponseDeleteResponse, ResponseListResponsesOpenAICursorPage as ResponseListResponsesOpenAICursorPage, type ResponseCreateParams as ResponseCreateParams, type ResponseCreateParamsNonStreaming as ResponseCreateParamsNonStreaming, type ResponseCreateParamsStreaming as ResponseCreateParamsStreaming, type ResponseListParams as ResponseListParams, };
2869
- export { InputItems as InputItems, type InputItemListResponse as InputItemListResponse, type InputItemListParams as InputItemListParams, };
2870
- }
2871
- //# sourceMappingURL=responses.d.ts.map