tekimax-ts 0.1.7 → 1.0.0-beta.1

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 (353) hide show
  1. package/README.md +155 -25
  2. package/dist/adapter-BtbeHotF.d.cts +81 -0
  3. package/dist/adapter-BtbeHotF.d.ts +81 -0
  4. package/dist/adapter-CMu9Gvvm.d.cts +81 -0
  5. package/dist/adapter-CMu9Gvvm.d.ts +81 -0
  6. package/dist/adapter-DeUJcFAn.d.cts +43 -0
  7. package/dist/adapter-DeUJcFAn.d.ts +43 -0
  8. package/dist/adapter-K9NFtBg8.d.cts +81 -0
  9. package/dist/adapter-K9NFtBg8.d.ts +81 -0
  10. package/dist/adapter-TuDzMu0Y.d.cts +43 -0
  11. package/dist/adapter-TuDzMu0Y.d.ts +43 -0
  12. package/dist/adapter-YcdKK3By.d.cts +63 -0
  13. package/dist/adapter-YcdKK3By.d.ts +63 -0
  14. package/dist/adapter-zXqUGXCx.d.cts +81 -0
  15. package/dist/adapter-zXqUGXCx.d.ts +81 -0
  16. package/dist/chunk-MLKGABMK.js +9 -0
  17. package/dist/gen/index.js +1572 -378
  18. package/dist/gen/types.js +290 -201
  19. package/dist/gen/zod/allowedToolChoiceSchema.js +17 -13
  20. package/dist/gen/zod/allowedToolsParamSchema.js +28 -13
  21. package/dist/gen/zod/annotationSchema.js +16 -11
  22. package/dist/gen/zod/assistantMessageItemParamSchema.js +52 -19
  23. package/dist/gen/zod/createResponseBodySchema.js +142 -44
  24. package/dist/gen/zod/createresponseSchema.js +23 -12
  25. package/dist/gen/zod/detailEnumSchema.js +8 -8
  26. package/dist/gen/zod/developerMessageItemParamSchema.js +35 -16
  27. package/dist/gen/zod/emptyModelParamSchema.js +8 -8
  28. package/dist/gen/zod/errorPayloadSchema.js +27 -14
  29. package/dist/gen/zod/errorSchema.js +17 -11
  30. package/dist/gen/zod/errorStreamingEventSchema.js +23 -13
  31. package/dist/gen/zod/functionCallItemParamSchema.js +38 -15
  32. package/dist/gen/zod/functionCallItemStatusSchema.js +12 -8
  33. package/dist/gen/zod/functionCallOutputItemParamSchema.js +90 -27
  34. package/dist/gen/zod/functionCallOutputSchema.js +67 -24
  35. package/dist/gen/zod/functionCallOutputStatusEnumSchema.js +12 -8
  36. package/dist/gen/zod/functionCallSchema.js +29 -16
  37. package/dist/gen/zod/functionCallStatusSchema.js +12 -8
  38. package/dist/gen/zod/functionToolChoiceSchema.js +10 -10
  39. package/dist/gen/zod/functionToolParamSchema.js +25 -14
  40. package/dist/gen/zod/functionToolSchema.js +24 -14
  41. package/dist/gen/zod/imageDetailSchema.js +8 -8
  42. package/dist/gen/zod/includeEnumSchema.js +11 -8
  43. package/dist/gen/zod/incompleteDetailsSchema.js +14 -10
  44. package/dist/gen/zod/index.js +871 -213
  45. package/dist/gen/zod/inputFileContentParamSchema.js +24 -13
  46. package/dist/gen/zod/inputFileContentSchema.js +23 -12
  47. package/dist/gen/zod/inputImageContentParamAutoParamSchema.js +29 -13
  48. package/dist/gen/zod/inputImageContentSchema.js +22 -13
  49. package/dist/gen/zod/inputTextContentParamSchema.js +19 -11
  50. package/dist/gen/zod/inputTextContentSchema.js +16 -11
  51. package/dist/gen/zod/inputTokensDetailsSchema.js +15 -10
  52. package/dist/gen/zod/inputVideoContentSchema.js +17 -11
  53. package/dist/gen/zod/itemFieldSchema.js +45 -20
  54. package/dist/gen/zod/itemParamSchema.js +55 -23
  55. package/dist/gen/zod/itemReferenceParamSchema.js +15 -11
  56. package/dist/gen/zod/jsonObjectResponseFormatSchema.js +9 -9
  57. package/dist/gen/zod/jsonSchemaResponseFormatParamSchema.js +38 -13
  58. package/dist/gen/zod/jsonSchemaResponseFormatSchema.js +13 -13
  59. package/dist/gen/zod/logProbSchema.js +20 -14
  60. package/dist/gen/zod/messageRoleSchema.js +13 -8
  61. package/dist/gen/zod/messageSchema.js +109 -43
  62. package/dist/gen/zod/messageStatusSchema.js +12 -8
  63. package/dist/gen/zod/metadataParamSchema.js +13 -8
  64. package/dist/gen/zod/outputTextContentParamSchema.js +21 -12
  65. package/dist/gen/zod/outputTextContentSchema.js +30 -15
  66. package/dist/gen/zod/outputTokensDetailsSchema.js +17 -10
  67. package/dist/gen/zod/reasoningBodySchema.js +173 -54
  68. package/dist/gen/zod/reasoningEffortEnumSchema.js +14 -8
  69. package/dist/gen/zod/reasoningItemParamSchema.js +26 -14
  70. package/dist/gen/zod/reasoningParamSchema.js +33 -13
  71. package/dist/gen/zod/reasoningSchema.js +27 -13
  72. package/dist/gen/zod/reasoningSummaryContentParamSchema.js +13 -10
  73. package/dist/gen/zod/reasoningSummaryEnumSchema.js +12 -8
  74. package/dist/gen/zod/reasoningTextContentSchema.js +16 -11
  75. package/dist/gen/zod/refusalContentParamSchema.js +13 -10
  76. package/dist/gen/zod/refusalContentSchema.js +18 -11
  77. package/dist/gen/zod/responseCompletedStreamingEventSchema.js +23 -13
  78. package/dist/gen/zod/responseContentPartAddedStreamingEventSchema.js +98 -39
  79. package/dist/gen/zod/responseContentPartDoneStreamingEventSchema.js +98 -39
  80. package/dist/gen/zod/responseCreatedStreamingEventSchema.js +23 -13
  81. package/dist/gen/zod/responseFailedStreamingEventSchema.js +23 -13
  82. package/dist/gen/zod/responseFunctionCallArgumentsDeltaStreamingEventSchema.js +38 -15
  83. package/dist/gen/zod/responseFunctionCallArgumentsDoneStreamingEventSchema.js +33 -14
  84. package/dist/gen/zod/responseInProgressStreamingEventSchema.js +23 -13
  85. package/dist/gen/zod/responseIncompleteStreamingEventSchema.js +23 -13
  86. package/dist/gen/zod/responseOutputItemAddedStreamingEventSchema.js +32 -14
  87. package/dist/gen/zod/responseOutputItemDoneStreamingEventSchema.js +30 -14
  88. package/dist/gen/zod/responseOutputTextAnnotationAddedStreamingEventSchema.js +43 -17
  89. package/dist/gen/zod/responseOutputTextDeltaStreamingEventSchema.js +48 -18
  90. package/dist/gen/zod/responseOutputTextDoneStreamingEventSchema.js +39 -17
  91. package/dist/gen/zod/responseQueuedStreamingEventSchema.js +23 -13
  92. package/dist/gen/zod/responseReasoningDeltaStreamingEventSchema.js +40 -16
  93. package/dist/gen/zod/responseReasoningDoneStreamingEventSchema.js +31 -15
  94. package/dist/gen/zod/responseReasoningSummaryDeltaStreamingEventSchema.js +42 -16
  95. package/dist/gen/zod/responseReasoningSummaryDoneStreamingEventSchema.js +33 -15
  96. package/dist/gen/zod/responseReasoningSummaryPartAddedStreamingEventSchema.js +102 -39
  97. package/dist/gen/zod/responseReasoningSummaryPartDoneStreamingEventSchema.js +102 -39
  98. package/dist/gen/zod/responseRefusalDeltaStreamingEventSchema.js +33 -15
  99. package/dist/gen/zod/responseRefusalDoneStreamingEventSchema.js +31 -15
  100. package/dist/gen/zod/responseResourceSchema.js +146 -51
  101. package/dist/gen/zod/responsesToolParamSchema.js +15 -11
  102. package/dist/gen/zod/serviceTierEnumSchema.js +13 -8
  103. package/dist/gen/zod/specificFunctionParamSchema.js +13 -10
  104. package/dist/gen/zod/specificToolChoiceParamSchema.js +11 -9
  105. package/dist/gen/zod/streamOptionsParamSchema.js +18 -10
  106. package/dist/gen/zod/summaryTextContentSchema.js +18 -11
  107. package/dist/gen/zod/systemMessageItemParamSchema.js +35 -16
  108. package/dist/gen/zod/textContentSchema.js +13 -11
  109. package/dist/gen/zod/textFieldSchema.js +24 -14
  110. package/dist/gen/zod/textFormatParamSchema.js +16 -10
  111. package/dist/gen/zod/textParamSchema.js +23 -12
  112. package/dist/gen/zod/textResponseFormatSchema.js +9 -9
  113. package/dist/gen/zod/toolChoiceParamSchema.js +21 -11
  114. package/dist/gen/zod/toolChoiceValueEnumSchema.js +8 -8
  115. package/dist/gen/zod/toolSchema.js +16 -11
  116. package/dist/gen/zod/topLogProbSchema.js +14 -12
  117. package/dist/gen/zod/truncationEnumSchema.js +8 -8
  118. package/dist/gen/zod/urlCitationBodySchema.js +29 -14
  119. package/dist/gen/zod/urlCitationParamSchema.js +28 -13
  120. package/dist/gen/zod/usageSchema.js +35 -16
  121. package/dist/gen/zod/userMessageItemParamSchema.js +64 -22
  122. package/dist/gen/zod/verbosityEnumSchema.js +8 -8
  123. package/dist/index.cjs +740 -0
  124. package/dist/index.d.cts +2742 -0
  125. package/dist/index.d.mts +51000 -31111
  126. package/dist/index.d.ts +962 -29932
  127. package/dist/index.js +347 -1431
  128. package/dist/index.mjs +2441 -1010
  129. package/dist/react/index.cjs +119 -0
  130. package/dist/react/index.d.cts +21 -0
  131. package/dist/react/index.d.ts +21 -0
  132. package/dist/react/index.js +94 -0
  133. package/package.json +40 -8
  134. package/.dockerignore +0 -5
  135. package/Dockerfile +0 -25
  136. package/kubb.config.js +0 -30
  137. package/kubb.config.ts +0 -35
  138. package/public/logos/tekimax-logo-ScreenRGB-2.png +0 -0
  139. package/spec/openapi.json +0 -3876
  140. package/src/client.ts +0 -129
  141. package/src/gen/.kubb/config.ts +0 -43
  142. package/src/gen/client/createresponse.ts +0 -27
  143. package/src/gen/client/index.ts +0 -1
  144. package/src/gen/index.ts +0 -187
  145. package/src/gen/schemas/allowedToolChoice.json +0 -1
  146. package/src/gen/schemas/allowedToolsParam.json +0 -1
  147. package/src/gen/schemas/annotation.json +0 -1
  148. package/src/gen/schemas/assistantMessageItemParam.json +0 -1
  149. package/src/gen/schemas/createResponseBody.json +0 -1
  150. package/src/gen/schemas/detailEnum.json +0 -1
  151. package/src/gen/schemas/developerMessageItemParam.json +0 -1
  152. package/src/gen/schemas/emptyModelParam.json +0 -1
  153. package/src/gen/schemas/error.json +0 -1
  154. package/src/gen/schemas/errorPayload.json +0 -1
  155. package/src/gen/schemas/errorStreamingEvent.json +0 -1
  156. package/src/gen/schemas/functionCall.json +0 -1
  157. package/src/gen/schemas/functionCallItemParam.json +0 -1
  158. package/src/gen/schemas/functionCallItemStatus.json +0 -1
  159. package/src/gen/schemas/functionCallOutput.json +0 -1
  160. package/src/gen/schemas/functionCallOutputItemParam.json +0 -1
  161. package/src/gen/schemas/functionCallOutputStatusEnum.json +0 -1
  162. package/src/gen/schemas/functionCallStatus.json +0 -1
  163. package/src/gen/schemas/functionTool.json +0 -1
  164. package/src/gen/schemas/functionToolChoice.json +0 -1
  165. package/src/gen/schemas/functionToolParam.json +0 -1
  166. package/src/gen/schemas/imageDetail.json +0 -1
  167. package/src/gen/schemas/includeEnum.json +0 -1
  168. package/src/gen/schemas/incompleteDetails.json +0 -1
  169. package/src/gen/schemas/inputFileContent.json +0 -1
  170. package/src/gen/schemas/inputFileContentParam.json +0 -1
  171. package/src/gen/schemas/inputImageContent.json +0 -1
  172. package/src/gen/schemas/inputImageContentParamAutoParam.json +0 -1
  173. package/src/gen/schemas/inputTextContent.json +0 -1
  174. package/src/gen/schemas/inputTextContentParam.json +0 -1
  175. package/src/gen/schemas/inputTokensDetails.json +0 -1
  176. package/src/gen/schemas/inputVideoContent.json +0 -1
  177. package/src/gen/schemas/itemField.json +0 -1
  178. package/src/gen/schemas/itemParam.json +0 -1
  179. package/src/gen/schemas/itemReferenceParam.json +0 -1
  180. package/src/gen/schemas/jsonObjectResponseFormat.json +0 -1
  181. package/src/gen/schemas/jsonSchemaResponseFormat.json +0 -1
  182. package/src/gen/schemas/jsonSchemaResponseFormatParam.json +0 -1
  183. package/src/gen/schemas/logProb.json +0 -1
  184. package/src/gen/schemas/message.json +0 -1
  185. package/src/gen/schemas/messageRole.json +0 -1
  186. package/src/gen/schemas/messageStatus.json +0 -1
  187. package/src/gen/schemas/metadataParam.json +0 -1
  188. package/src/gen/schemas/outputTextContent.json +0 -1
  189. package/src/gen/schemas/outputTextContentParam.json +0 -1
  190. package/src/gen/schemas/outputTokensDetails.json +0 -1
  191. package/src/gen/schemas/reasoning.json +0 -1
  192. package/src/gen/schemas/reasoningBody.json +0 -1
  193. package/src/gen/schemas/reasoningEffortEnum.json +0 -1
  194. package/src/gen/schemas/reasoningItemParam.json +0 -1
  195. package/src/gen/schemas/reasoningParam.json +0 -1
  196. package/src/gen/schemas/reasoningSummaryContentParam.json +0 -1
  197. package/src/gen/schemas/reasoningSummaryEnum.json +0 -1
  198. package/src/gen/schemas/reasoningTextContent.json +0 -1
  199. package/src/gen/schemas/refusalContent.json +0 -1
  200. package/src/gen/schemas/refusalContentParam.json +0 -1
  201. package/src/gen/schemas/responseCompletedStreamingEvent.json +0 -1
  202. package/src/gen/schemas/responseContentPartAddedStreamingEvent.json +0 -1
  203. package/src/gen/schemas/responseContentPartDoneStreamingEvent.json +0 -1
  204. package/src/gen/schemas/responseCreatedStreamingEvent.json +0 -1
  205. package/src/gen/schemas/responseFailedStreamingEvent.json +0 -1
  206. package/src/gen/schemas/responseFunctionCallArgumentsDeltaStreamingEvent.json +0 -1
  207. package/src/gen/schemas/responseFunctionCallArgumentsDoneStreamingEvent.json +0 -1
  208. package/src/gen/schemas/responseInProgressStreamingEvent.json +0 -1
  209. package/src/gen/schemas/responseIncompleteStreamingEvent.json +0 -1
  210. package/src/gen/schemas/responseOutputItemAddedStreamingEvent.json +0 -1
  211. package/src/gen/schemas/responseOutputItemDoneStreamingEvent.json +0 -1
  212. package/src/gen/schemas/responseOutputTextAnnotationAddedStreamingEvent.json +0 -1
  213. package/src/gen/schemas/responseOutputTextDeltaStreamingEvent.json +0 -1
  214. package/src/gen/schemas/responseOutputTextDoneStreamingEvent.json +0 -1
  215. package/src/gen/schemas/responseQueuedStreamingEvent.json +0 -1
  216. package/src/gen/schemas/responseReasoningDeltaStreamingEvent.json +0 -1
  217. package/src/gen/schemas/responseReasoningDoneStreamingEvent.json +0 -1
  218. package/src/gen/schemas/responseReasoningSummaryDeltaStreamingEvent.json +0 -1
  219. package/src/gen/schemas/responseReasoningSummaryDoneStreamingEvent.json +0 -1
  220. package/src/gen/schemas/responseReasoningSummaryPartAddedStreamingEvent.json +0 -1
  221. package/src/gen/schemas/responseReasoningSummaryPartDoneStreamingEvent.json +0 -1
  222. package/src/gen/schemas/responseRefusalDeltaStreamingEvent.json +0 -1
  223. package/src/gen/schemas/responseRefusalDoneStreamingEvent.json +0 -1
  224. package/src/gen/schemas/responseResource.json +0 -1
  225. package/src/gen/schemas/responsesToolParam.json +0 -1
  226. package/src/gen/schemas/serviceTierEnum.json +0 -1
  227. package/src/gen/schemas/specificFunctionParam.json +0 -1
  228. package/src/gen/schemas/specificToolChoiceParam.json +0 -1
  229. package/src/gen/schemas/streamOptionsParam.json +0 -1
  230. package/src/gen/schemas/summaryTextContent.json +0 -1
  231. package/src/gen/schemas/systemMessageItemParam.json +0 -1
  232. package/src/gen/schemas/textContent.json +0 -1
  233. package/src/gen/schemas/textField.json +0 -1
  234. package/src/gen/schemas/textFormatParam.json +0 -1
  235. package/src/gen/schemas/textParam.json +0 -1
  236. package/src/gen/schemas/textResponseFormat.json +0 -1
  237. package/src/gen/schemas/tool.json +0 -1
  238. package/src/gen/schemas/toolChoiceParam.json +0 -1
  239. package/src/gen/schemas/toolChoiceValueEnum.json +0 -1
  240. package/src/gen/schemas/topLogProb.json +0 -1
  241. package/src/gen/schemas/truncationEnum.json +0 -1
  242. package/src/gen/schemas/urlCitationBody.json +0 -1
  243. package/src/gen/schemas/urlCitationParam.json +0 -1
  244. package/src/gen/schemas/usage.json +0 -1
  245. package/src/gen/schemas/userMessageItemParam.json +0 -1
  246. package/src/gen/schemas/verbosityEnum.json +0 -1
  247. package/src/gen/types.ts +0 -2613
  248. package/src/gen/zod/allowedToolChoiceSchema.ts +0 -14
  249. package/src/gen/zod/allowedToolsParamSchema.ts +0 -14
  250. package/src/gen/zod/annotationSchema.ts +0 -14
  251. package/src/gen/zod/assistantMessageItemParamSchema.ts +0 -20
  252. package/src/gen/zod/createResponseBodySchema.ts +0 -45
  253. package/src/gen/zod/createresponseSchema.ts +0 -17
  254. package/src/gen/zod/detailEnumSchema.ts +0 -8
  255. package/src/gen/zod/developerMessageItemParamSchema.ts +0 -17
  256. package/src/gen/zod/emptyModelParamSchema.ts +0 -10
  257. package/src/gen/zod/errorPayloadSchema.ts +0 -19
  258. package/src/gen/zod/errorSchema.ts +0 -14
  259. package/src/gen/zod/errorStreamingEventSchema.ts +0 -16
  260. package/src/gen/zod/functionCallItemParamSchema.ts +0 -16
  261. package/src/gen/zod/functionCallItemStatusSchema.ts +0 -8
  262. package/src/gen/zod/functionCallOutputItemParamSchema.ts +0 -30
  263. package/src/gen/zod/functionCallOutputSchema.ts +0 -27
  264. package/src/gen/zod/functionCallOutputStatusEnumSchema.ts +0 -11
  265. package/src/gen/zod/functionCallSchema.ts +0 -19
  266. package/src/gen/zod/functionCallStatusSchema.ts +0 -8
  267. package/src/gen/zod/functionToolChoiceSchema.ts +0 -11
  268. package/src/gen/zod/functionToolParamSchema.ts +0 -15
  269. package/src/gen/zod/functionToolSchema.ts +0 -19
  270. package/src/gen/zod/imageDetailSchema.ts +0 -8
  271. package/src/gen/zod/includeEnumSchema.ts +0 -8
  272. package/src/gen/zod/incompleteDetailsSchema.ts +0 -13
  273. package/src/gen/zod/index.ts +0 -103
  274. package/src/gen/zod/inputFileContentParamSchema.ts +0 -16
  275. package/src/gen/zod/inputFileContentSchema.ts +0 -15
  276. package/src/gen/zod/inputImageContentParamAutoParamSchema.ts +0 -16
  277. package/src/gen/zod/inputImageContentSchema.ts +0 -16
  278. package/src/gen/zod/inputTextContentParamSchema.ts +0 -14
  279. package/src/gen/zod/inputTextContentSchema.ts +0 -14
  280. package/src/gen/zod/inputTokensDetailsSchema.ts +0 -13
  281. package/src/gen/zod/inputVideoContentSchema.ts +0 -14
  282. package/src/gen/zod/itemFieldSchema.ts +0 -23
  283. package/src/gen/zod/itemParamSchema.ts +0 -23
  284. package/src/gen/zod/itemReferenceParamSchema.ts +0 -14
  285. package/src/gen/zod/jsonObjectResponseFormatSchema.ts +0 -10
  286. package/src/gen/zod/jsonSchemaResponseFormatParamSchema.ts +0 -16
  287. package/src/gen/zod/jsonSchemaResponseFormatSchema.ts +0 -14
  288. package/src/gen/zod/logProbSchema.ts +0 -17
  289. package/src/gen/zod/messageRoleSchema.ts +0 -8
  290. package/src/gen/zod/messageSchema.ts +0 -46
  291. package/src/gen/zod/messageStatusSchema.ts +0 -8
  292. package/src/gen/zod/metadataParamSchema.ts +0 -13
  293. package/src/gen/zod/outputTextContentParamSchema.ts +0 -13
  294. package/src/gen/zod/outputTextContentSchema.ts +0 -18
  295. package/src/gen/zod/outputTokensDetailsSchema.ts +0 -13
  296. package/src/gen/zod/reasoningBodySchema.ts +0 -57
  297. package/src/gen/zod/reasoningEffortEnumSchema.ts +0 -8
  298. package/src/gen/zod/reasoningItemParamSchema.ts +0 -15
  299. package/src/gen/zod/reasoningParamSchema.ts +0 -16
  300. package/src/gen/zod/reasoningSchema.ts +0 -16
  301. package/src/gen/zod/reasoningSummaryContentParamSchema.ts +0 -11
  302. package/src/gen/zod/reasoningSummaryEnumSchema.ts +0 -8
  303. package/src/gen/zod/reasoningTextContentSchema.ts +0 -14
  304. package/src/gen/zod/refusalContentParamSchema.ts +0 -11
  305. package/src/gen/zod/refusalContentSchema.ts +0 -14
  306. package/src/gen/zod/responseCompletedStreamingEventSchema.ts +0 -16
  307. package/src/gen/zod/responseContentPartAddedStreamingEventSchema.ts +0 -42
  308. package/src/gen/zod/responseContentPartDoneStreamingEventSchema.ts +0 -42
  309. package/src/gen/zod/responseCreatedStreamingEventSchema.ts +0 -16
  310. package/src/gen/zod/responseFailedStreamingEventSchema.ts +0 -16
  311. package/src/gen/zod/responseFunctionCallArgumentsDeltaStreamingEventSchema.ts +0 -18
  312. package/src/gen/zod/responseFunctionCallArgumentsDoneStreamingEventSchema.ts +0 -17
  313. package/src/gen/zod/responseInProgressStreamingEventSchema.ts +0 -16
  314. package/src/gen/zod/responseIncompleteStreamingEventSchema.ts +0 -16
  315. package/src/gen/zod/responseOutputItemAddedStreamingEventSchema.ts +0 -17
  316. package/src/gen/zod/responseOutputItemDoneStreamingEventSchema.ts +0 -17
  317. package/src/gen/zod/responseOutputTextAnnotationAddedStreamingEventSchema.ts +0 -20
  318. package/src/gen/zod/responseOutputTextDeltaStreamingEventSchema.ts +0 -21
  319. package/src/gen/zod/responseOutputTextDoneStreamingEventSchema.ts +0 -20
  320. package/src/gen/zod/responseQueuedStreamingEventSchema.ts +0 -16
  321. package/src/gen/zod/responseReasoningDeltaStreamingEventSchema.ts +0 -19
  322. package/src/gen/zod/responseReasoningDoneStreamingEventSchema.ts +0 -18
  323. package/src/gen/zod/responseReasoningSummaryDeltaStreamingEventSchema.ts +0 -19
  324. package/src/gen/zod/responseReasoningSummaryDoneStreamingEventSchema.ts +0 -18
  325. package/src/gen/zod/responseReasoningSummaryPartAddedStreamingEventSchema.ts +0 -42
  326. package/src/gen/zod/responseReasoningSummaryPartDoneStreamingEventSchema.ts +0 -42
  327. package/src/gen/zod/responseRefusalDeltaStreamingEventSchema.ts +0 -18
  328. package/src/gen/zod/responseRefusalDoneStreamingEventSchema.ts +0 -18
  329. package/src/gen/zod/responseResourceSchema.ts +0 -54
  330. package/src/gen/zod/responsesToolParamSchema.ts +0 -11
  331. package/src/gen/zod/serviceTierEnumSchema.ts +0 -8
  332. package/src/gen/zod/specificFunctionParamSchema.ts +0 -11
  333. package/src/gen/zod/specificToolChoiceParamSchema.ts +0 -9
  334. package/src/gen/zod/streamOptionsParamSchema.ts +0 -13
  335. package/src/gen/zod/summaryTextContentSchema.ts +0 -14
  336. package/src/gen/zod/systemMessageItemParamSchema.ts +0 -17
  337. package/src/gen/zod/textContentSchema.ts +0 -14
  338. package/src/gen/zod/textFieldSchema.ts +0 -15
  339. package/src/gen/zod/textFormatParamSchema.ts +0 -10
  340. package/src/gen/zod/textParamSchema.ts +0 -13
  341. package/src/gen/zod/textResponseFormatSchema.ts +0 -10
  342. package/src/gen/zod/toolChoiceParamSchema.ts +0 -14
  343. package/src/gen/zod/toolChoiceValueEnumSchema.ts +0 -8
  344. package/src/gen/zod/toolSchema.ts +0 -14
  345. package/src/gen/zod/topLogProbSchema.ts +0 -15
  346. package/src/gen/zod/truncationEnumSchema.ts +0 -8
  347. package/src/gen/zod/urlCitationBodySchema.ts +0 -17
  348. package/src/gen/zod/urlCitationParamSchema.ts +0 -14
  349. package/src/gen/zod/usageSchema.ts +0 -19
  350. package/src/gen/zod/userMessageItemParamSchema.ts +0 -23
  351. package/src/gen/zod/verbosityEnumSchema.ts +0 -8
  352. package/src/index.ts +0 -3
  353. package/tsconfig.json +0 -21
package/src/gen/types.ts DELETED
@@ -1,2613 +0,0 @@
1
- /**
2
- * Generated by Kubb (https://kubb.dev/).
3
- * Do not edit manually.
4
- */
5
-
6
-
7
- export const itemReferenceParamTypeEnum = {
8
- item_reference: "item_reference"
9
- } as const;
10
-
11
- export type ItemReferenceParamTypeEnumKey = (typeof itemReferenceParamTypeEnum)[keyof typeof itemReferenceParamTypeEnum];
12
-
13
- /**
14
- * @description An internal identifier for an item to reference.
15
- */
16
- export type ItemReferenceParam = {
17
- type?: (ItemReferenceParamTypeEnumKey | null);
18
- /**
19
- * @description The ID of the item to reference.
20
- * @type string
21
- */
22
- id: string;
23
- };
24
-
25
- export const reasoningSummaryContentParamTypeEnum = {
26
- summary_text: "summary_text"
27
- } as const;
28
-
29
- export type ReasoningSummaryContentParamTypeEnumKey = (typeof reasoningSummaryContentParamTypeEnum)[keyof typeof reasoningSummaryContentParamTypeEnum];
30
-
31
- export type ReasoningSummaryContentParam = {
32
- /**
33
- * @description The content type. Always `summary_text`.
34
- * @default "summary_text"
35
- * @type string
36
- */
37
- type: ReasoningSummaryContentParamTypeEnumKey;
38
- /**
39
- * @description The reasoning summary text.
40
- * @maxLength 10485760
41
- * @type string
42
- */
43
- text: string;
44
- };
45
-
46
- export const reasoningItemParamTypeEnum = {
47
- reasoning: "reasoning"
48
- } as const;
49
-
50
- export type ReasoningItemParamTypeEnumKey = (typeof reasoningItemParamTypeEnum)[keyof typeof reasoningItemParamTypeEnum];
51
-
52
- export type ReasoningItemParam = {
53
- id?: (string | null);
54
- /**
55
- * @description The item type. Always `reasoning`.
56
- * @default "reasoning"
57
- * @type string
58
- */
59
- type: ReasoningItemParamTypeEnumKey;
60
- /**
61
- * @description Reasoning summary content associated with this item.
62
- * @type array
63
- */
64
- summary: ReasoningSummaryContentParam[];
65
- content?: null;
66
- encrypted_content?: (string | null);
67
- };
68
-
69
- export const inputTextContentParamTypeEnum = {
70
- input_text: "input_text"
71
- } as const;
72
-
73
- export type InputTextContentParamTypeEnumKey = (typeof inputTextContentParamTypeEnum)[keyof typeof inputTextContentParamTypeEnum];
74
-
75
- /**
76
- * @description A text input to the model.
77
- */
78
- export type InputTextContentParam = {
79
- /**
80
- * @description The type of the input item. Always `input_text`.
81
- * @default "input_text"
82
- * @type string
83
- */
84
- type: InputTextContentParamTypeEnumKey;
85
- /**
86
- * @description The text input to the model.
87
- * @maxLength 10485760
88
- * @type string
89
- */
90
- text: string;
91
- };
92
-
93
- export const detailEnumEnum = {
94
- low: "low",
95
- high: "high",
96
- auto: "auto"
97
- } as const;
98
-
99
- export type DetailEnumEnumKey = (typeof detailEnumEnum)[keyof typeof detailEnumEnum];
100
-
101
- export type DetailEnum = DetailEnumEnumKey;
102
-
103
- export const imageDetailEnum = {
104
- low: "low",
105
- high: "high",
106
- auto: "auto"
107
- } as const;
108
-
109
- export type ImageDetailEnumKey = (typeof imageDetailEnum)[keyof typeof imageDetailEnum];
110
-
111
- export type ImageDetail = ImageDetailEnumKey;
112
-
113
- export const inputImageContentParamAutoParamTypeEnum = {
114
- input_image: "input_image"
115
- } as const;
116
-
117
- export type InputImageContentParamAutoParamTypeEnumKey = (typeof inputImageContentParamAutoParamTypeEnum)[keyof typeof inputImageContentParamAutoParamTypeEnum];
118
-
119
- /**
120
- * @description An image input to the model. Learn about [image inputs](/docs/guides/vision)
121
- */
122
- export type InputImageContentParamAutoParam = {
123
- /**
124
- * @description The type of the input item. Always `input_image`.
125
- * @default "input_image"
126
- * @type string
127
- */
128
- type: InputImageContentParamAutoParamTypeEnumKey;
129
- image_url?: (string | null);
130
- detail?: ((ImageDetail & any) | null);
131
- };
132
-
133
- export const inputFileContentParamTypeEnum = {
134
- input_file: "input_file"
135
- } as const;
136
-
137
- export type InputFileContentParamTypeEnumKey = (typeof inputFileContentParamTypeEnum)[keyof typeof inputFileContentParamTypeEnum];
138
-
139
- /**
140
- * @description A file input to the model.
141
- */
142
- export type InputFileContentParam = {
143
- /**
144
- * @description The type of the input item. Always `input_file`.
145
- * @default "input_file"
146
- * @type string
147
- */
148
- type: InputFileContentParamTypeEnumKey;
149
- filename?: (string | null);
150
- file_data?: (string | null);
151
- file_url?: (string | null);
152
- };
153
-
154
- export const userMessageItemParamTypeEnum = {
155
- message: "message"
156
- } as const;
157
-
158
- export type UserMessageItemParamTypeEnumKey = (typeof userMessageItemParamTypeEnum)[keyof typeof userMessageItemParamTypeEnum];
159
-
160
- export const userMessageItemParamRoleEnum = {
161
- user: "user"
162
- } as const;
163
-
164
- export type UserMessageItemParamRoleEnumKey = (typeof userMessageItemParamRoleEnum)[keyof typeof userMessageItemParamRoleEnum];
165
-
166
- export type UserMessageItemParam = {
167
- id?: (string | null);
168
- /**
169
- * @description The item type. Always `message`.
170
- * @default "message"
171
- * @type string
172
- */
173
- type: UserMessageItemParamTypeEnumKey;
174
- /**
175
- * @description The message role. Always `user`.
176
- * @default "user"
177
- * @type string
178
- */
179
- role: UserMessageItemParamRoleEnumKey;
180
- /**
181
- * @description The message content, as an array of content parts.
182
- */
183
- content: (((InputTextContentParam & {
184
- type: "input_text";
185
- }) | (InputImageContentParamAutoParam & {
186
- type: "input_image";
187
- }) | (InputFileContentParam & {
188
- type: "input_file";
189
- }))[] | string);
190
- status?: (string | null);
191
- };
192
-
193
- export const systemMessageItemParamTypeEnum = {
194
- message: "message"
195
- } as const;
196
-
197
- export type SystemMessageItemParamTypeEnumKey = (typeof systemMessageItemParamTypeEnum)[keyof typeof systemMessageItemParamTypeEnum];
198
-
199
- export const systemMessageItemParamRoleEnum = {
200
- system: "system"
201
- } as const;
202
-
203
- export type SystemMessageItemParamRoleEnumKey = (typeof systemMessageItemParamRoleEnum)[keyof typeof systemMessageItemParamRoleEnum];
204
-
205
- export type SystemMessageItemParam = {
206
- id?: (string | null);
207
- /**
208
- * @description The item type. Always `message`.
209
- * @default "message"
210
- * @type string
211
- */
212
- type: SystemMessageItemParamTypeEnumKey;
213
- /**
214
- * @description The message role. Always `system`.
215
- * @default "system"
216
- * @type string
217
- */
218
- role: SystemMessageItemParamRoleEnumKey;
219
- /**
220
- * @description The message content, as an array of content parts.
221
- */
222
- content: ((InputTextContentParam & {
223
- type: "input_text";
224
- })[] | string);
225
- status?: (string | null);
226
- };
227
-
228
- export const developerMessageItemParamTypeEnum = {
229
- message: "message"
230
- } as const;
231
-
232
- export type DeveloperMessageItemParamTypeEnumKey = (typeof developerMessageItemParamTypeEnum)[keyof typeof developerMessageItemParamTypeEnum];
233
-
234
- export const developerMessageItemParamRoleEnum = {
235
- developer: "developer"
236
- } as const;
237
-
238
- export type DeveloperMessageItemParamRoleEnumKey = (typeof developerMessageItemParamRoleEnum)[keyof typeof developerMessageItemParamRoleEnum];
239
-
240
- export type DeveloperMessageItemParam = {
241
- id?: (string | null);
242
- /**
243
- * @description The item type. Always `message`.
244
- * @default "message"
245
- * @type string
246
- */
247
- type: DeveloperMessageItemParamTypeEnumKey;
248
- /**
249
- * @description The message role. Always `developer`.
250
- * @default "developer"
251
- * @type string
252
- */
253
- role: DeveloperMessageItemParamRoleEnumKey;
254
- /**
255
- * @description The message content, as an array of content parts.
256
- */
257
- content: ((InputTextContentParam & {
258
- type: "input_text";
259
- })[] | string);
260
- status?: (string | null);
261
- };
262
-
263
- export const urlCitationParamTypeEnum = {
264
- url_citation: "url_citation"
265
- } as const;
266
-
267
- export type UrlCitationParamTypeEnumKey = (typeof urlCitationParamTypeEnum)[keyof typeof urlCitationParamTypeEnum];
268
-
269
- export type UrlCitationParam = {
270
- /**
271
- * @description The citation type. Always `url_citation`.
272
- * @default "url_citation"
273
- * @type string
274
- */
275
- type: UrlCitationParamTypeEnumKey;
276
- /**
277
- * @description The index of the first character of the citation in the message.
278
- * @minLength 0
279
- * @type integer
280
- */
281
- start_index: number;
282
- /**
283
- * @description The index of the last character of the citation in the message.
284
- * @minLength 0
285
- * @type integer
286
- */
287
- end_index: number;
288
- /**
289
- * @description The URL of the cited resource.
290
- * @type string
291
- */
292
- url: string;
293
- /**
294
- * @description The title of the cited resource.
295
- * @type string
296
- */
297
- title: string;
298
- };
299
-
300
- export const outputTextContentParamTypeEnum = {
301
- output_text: "output_text"
302
- } as const;
303
-
304
- export type OutputTextContentParamTypeEnumKey = (typeof outputTextContentParamTypeEnum)[keyof typeof outputTextContentParamTypeEnum];
305
-
306
- export type OutputTextContentParam = {
307
- /**
308
- * @description The content type. Always `output_text`.
309
- * @default "output_text"
310
- * @type string
311
- */
312
- type: OutputTextContentParamTypeEnumKey;
313
- /**
314
- * @description The text content.
315
- * @maxLength 10485760
316
- * @type string
317
- */
318
- text: string;
319
- /**
320
- * @description Citations associated with the text content.
321
- */
322
- annotations?: UrlCitationParam[];
323
- };
324
-
325
- export const refusalContentParamTypeEnum = {
326
- refusal: "refusal"
327
- } as const;
328
-
329
- export type RefusalContentParamTypeEnumKey = (typeof refusalContentParamTypeEnum)[keyof typeof refusalContentParamTypeEnum];
330
-
331
- export type RefusalContentParam = {
332
- /**
333
- * @description The content type. Always `refusal`.
334
- * @default "refusal"
335
- * @type string
336
- */
337
- type: RefusalContentParamTypeEnumKey;
338
- /**
339
- * @description The refusal text.
340
- * @maxLength 10485760
341
- * @type string
342
- */
343
- refusal: string;
344
- };
345
-
346
- export const assistantMessageItemParamTypeEnum = {
347
- message: "message"
348
- } as const;
349
-
350
- export type AssistantMessageItemParamTypeEnumKey = (typeof assistantMessageItemParamTypeEnum)[keyof typeof assistantMessageItemParamTypeEnum];
351
-
352
- export const assistantMessageItemParamRoleEnum = {
353
- assistant: "assistant"
354
- } as const;
355
-
356
- export type AssistantMessageItemParamRoleEnumKey = (typeof assistantMessageItemParamRoleEnum)[keyof typeof assistantMessageItemParamRoleEnum];
357
-
358
- export type AssistantMessageItemParam = {
359
- id?: (string | null);
360
- /**
361
- * @description The item type. Always `message`.
362
- * @default "message"
363
- * @type string
364
- */
365
- type: AssistantMessageItemParamTypeEnumKey;
366
- /**
367
- * @description The role of the message author. Always `assistant`.
368
- * @default "assistant"
369
- * @type string
370
- */
371
- role: AssistantMessageItemParamRoleEnumKey;
372
- /**
373
- * @description The message content, as an array of content parts.
374
- */
375
- content: (((OutputTextContentParam & {
376
- type: "output_text";
377
- }) | (RefusalContentParam & {
378
- type: "refusal";
379
- }))[] | string);
380
- status?: (string | null);
381
- };
382
-
383
- export const functionCallItemStatusEnum = {
384
- in_progress: "in_progress",
385
- completed: "completed",
386
- incomplete: "incomplete"
387
- } as const;
388
-
389
- export type FunctionCallItemStatusEnumKey = (typeof functionCallItemStatusEnum)[keyof typeof functionCallItemStatusEnum];
390
-
391
- export type FunctionCallItemStatus = FunctionCallItemStatusEnumKey;
392
-
393
- export const functionCallStatusEnum = {
394
- in_progress: "in_progress",
395
- completed: "completed",
396
- incomplete: "incomplete"
397
- } as const;
398
-
399
- export type FunctionCallStatusEnumKey = (typeof functionCallStatusEnum)[keyof typeof functionCallStatusEnum];
400
-
401
- export type FunctionCallStatus = FunctionCallStatusEnumKey;
402
-
403
- export const functionCallItemParamTypeEnum = {
404
- function_call: "function_call"
405
- } as const;
406
-
407
- export type FunctionCallItemParamTypeEnumKey = (typeof functionCallItemParamTypeEnum)[keyof typeof functionCallItemParamTypeEnum];
408
-
409
- export type FunctionCallItemParam = {
410
- id?: (string | null);
411
- /**
412
- * @description The unique ID of the function tool call generated by the model.
413
- * @minLength 1
414
- * @maxLength 64
415
- * @type string
416
- */
417
- call_id: string;
418
- /**
419
- * @description The item type. Always `function_call`.
420
- * @default "function_call"
421
- * @type string
422
- */
423
- type: FunctionCallItemParamTypeEnumKey;
424
- /**
425
- * @description The name of the function to call.
426
- * @minLength 1
427
- * @maxLength 64
428
- * @pattern ^[a-zA-Z0-9_-]+$
429
- * @type string
430
- */
431
- name: string;
432
- /**
433
- * @description The function arguments as a JSON string.
434
- * @type string
435
- */
436
- arguments: string;
437
- status?: ((FunctionCallStatus & any) | null);
438
- };
439
-
440
- export const inputVideoContentTypeEnum = {
441
- input_video: "input_video"
442
- } as const;
443
-
444
- export type InputVideoContentTypeEnumKey = (typeof inputVideoContentTypeEnum)[keyof typeof inputVideoContentTypeEnum];
445
-
446
- /**
447
- * @description A content block representing a video input to the model.
448
- */
449
- export type InputVideoContent = {
450
- /**
451
- * @description The type of the input content. Always `input_video`.
452
- * @type string
453
- */
454
- type: InputVideoContentTypeEnumKey;
455
- /**
456
- * @description A base64 or remote url that resolves to a video file.
457
- * @type string
458
- */
459
- video_url: string;
460
- };
461
-
462
- export const functionCallOutputItemParamTypeEnum = {
463
- function_call_output: "function_call_output"
464
- } as const;
465
-
466
- export type FunctionCallOutputItemParamTypeEnumKey = (typeof functionCallOutputItemParamTypeEnum)[keyof typeof functionCallOutputItemParamTypeEnum];
467
-
468
- /**
469
- * @description The output of a function tool call.
470
- */
471
- export type FunctionCallOutputItemParam = {
472
- id?: (string | null);
473
- /**
474
- * @description The unique ID of the function tool call generated by the model.
475
- * @minLength 1
476
- * @maxLength 64
477
- * @type string
478
- */
479
- call_id: string;
480
- /**
481
- * @description The type of the function tool call output. Always `function_call_output`.
482
- * @default "function_call_output"
483
- * @type string
484
- */
485
- type: FunctionCallOutputItemParamTypeEnumKey;
486
- /**
487
- * @description Text, image, or file output of the function tool call.
488
- */
489
- output: (string | ((InputTextContentParam & {
490
- type: "input_text";
491
- }) | (InputImageContentParamAutoParam & {
492
- type: "input_image";
493
- }) | (InputFileContentParam & {
494
- type: "input_file";
495
- }) | (InputVideoContent & {
496
- type: "input_video";
497
- }))[]);
498
- status?: ((FunctionCallStatus & any) | null);
499
- };
500
-
501
- export type ItemParam = ((ItemReferenceParam & {
502
- type: "Item reference";
503
- }) | (ReasoningItemParam & {
504
- type: "reasoning";
505
- }) | (AssistantMessageItemParam & {
506
- type: "message";
507
- }) | (FunctionCallItemParam & {
508
- type: "function_call";
509
- }) | (FunctionCallOutputItemParam & {
510
- type: "function_call_output";
511
- }));
512
-
513
- export const includeEnumEnum = {
514
- "reasoning.encrypted_content": "reasoning.encrypted_content",
515
- "message.output_text.logprobs": "message.output_text.logprobs"
516
- } as const;
517
-
518
- export type IncludeEnumEnumKey = (typeof includeEnumEnum)[keyof typeof includeEnumEnum];
519
-
520
- export type IncludeEnum = IncludeEnumEnumKey;
521
-
522
- export type EmptyModelParam = object;
523
-
524
- export const functionToolParamTypeEnum = {
525
- function: "function"
526
- } as const;
527
-
528
- export type FunctionToolParamTypeEnumKey = (typeof functionToolParamTypeEnum)[keyof typeof functionToolParamTypeEnum];
529
-
530
- export type FunctionToolParam = {
531
- /**
532
- * @minLength 1
533
- * @maxLength 64
534
- * @pattern ^[a-zA-Z0-9_-]+$
535
- * @type string
536
- */
537
- name: string;
538
- description?: (string | null);
539
- parameters?: (EmptyModelParam | null);
540
- /**
541
- * @type boolean | undefined
542
- */
543
- strict?: boolean;
544
- /**
545
- * @default "function"
546
- * @type string
547
- */
548
- type: FunctionToolParamTypeEnumKey;
549
- };
550
-
551
- export type ResponsesToolParam = (FunctionToolParam & {
552
- type: "function";
553
- });
554
-
555
- export const specificFunctionParamTypeEnum = {
556
- function: "function"
557
- } as const;
558
-
559
- export type SpecificFunctionParamTypeEnumKey = (typeof specificFunctionParamTypeEnum)[keyof typeof specificFunctionParamTypeEnum];
560
-
561
- export type SpecificFunctionParam = {
562
- /**
563
- * @description The tool to call. Always `function`.
564
- * @default "function"
565
- * @type string
566
- */
567
- type: SpecificFunctionParamTypeEnumKey;
568
- /**
569
- * @description The name of the function tool to call.
570
- * @type string
571
- */
572
- name: string;
573
- };
574
-
575
- export type SpecificToolChoiceParam = SpecificFunctionParam;
576
-
577
- export const toolChoiceValueEnumEnum = {
578
- none: "none",
579
- auto: "auto",
580
- required: "required"
581
- } as const;
582
-
583
- export type ToolChoiceValueEnumEnumKey = (typeof toolChoiceValueEnumEnum)[keyof typeof toolChoiceValueEnumEnum];
584
-
585
- export type ToolChoiceValueEnum = ToolChoiceValueEnumEnumKey;
586
-
587
- export const allowedToolsParamTypeEnum = {
588
- allowed_tools: "allowed_tools"
589
- } as const;
590
-
591
- export type AllowedToolsParamTypeEnumKey = (typeof allowedToolsParamTypeEnum)[keyof typeof allowedToolsParamTypeEnum];
592
-
593
- export type AllowedToolsParam = {
594
- /**
595
- * @description The tool choice type. Always `allowed_tools`.
596
- * @default "allowed_tools"
597
- * @type string
598
- */
599
- type: AllowedToolsParamTypeEnumKey;
600
- /**
601
- * @description The list of tools that are permitted for this request.
602
- * @type array
603
- */
604
- tools: SpecificToolChoiceParam[];
605
- mode?: (ToolChoiceValueEnum & any);
606
- };
607
-
608
- /**
609
- * @description Controls which tool the model should use, if any.
610
- */
611
- export type ToolChoiceParam = (SpecificToolChoiceParam | ToolChoiceValueEnum | AllowedToolsParam);
612
-
613
- /**
614
- * @description Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
615
- */
616
- export type MetadataParam = {
617
- [key: string]: string;
618
- };
619
-
620
- export const verbosityEnumEnum = {
621
- low: "low",
622
- medium: "medium",
623
- high: "high"
624
- } as const;
625
-
626
- export type VerbosityEnumEnumKey = (typeof verbosityEnumEnum)[keyof typeof verbosityEnumEnum];
627
-
628
- export type VerbosityEnum = VerbosityEnumEnumKey;
629
-
630
- export const textResponseFormatTypeEnum = {
631
- text: "text"
632
- } as const;
633
-
634
- export type TextResponseFormatTypeEnumKey = (typeof textResponseFormatTypeEnum)[keyof typeof textResponseFormatTypeEnum];
635
-
636
- export type TextResponseFormat = {
637
- /**
638
- * @default "text"
639
- * @type string
640
- */
641
- type: TextResponseFormatTypeEnumKey;
642
- };
643
-
644
- export const jsonSchemaResponseFormatParamTypeEnum = {
645
- json_schema: "json_schema"
646
- } as const;
647
-
648
- export type JsonSchemaResponseFormatParamTypeEnumKey = (typeof jsonSchemaResponseFormatParamTypeEnum)[keyof typeof jsonSchemaResponseFormatParamTypeEnum];
649
-
650
- export type JsonSchemaResponseFormatParam = {
651
- /**
652
- * @description The type of response format being defined. Always `json_schema`.
653
- * @type string | undefined
654
- */
655
- type?: JsonSchemaResponseFormatParamTypeEnumKey;
656
- /**
657
- * @description A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n
658
- * @type string | undefined
659
- */
660
- description?: string;
661
- /**
662
- * @description The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n
663
- * @type string | undefined
664
- */
665
- name?: string;
666
- /**
667
- * @description The schema for the response format, described as a JSON Schema object.\n
668
- * @type object | undefined
669
- */
670
- schema?: {
671
- [key: string]: any;
672
- };
673
- strict?: (boolean | null);
674
- };
675
-
676
- export type TextFormatParam = (TextResponseFormat | JsonSchemaResponseFormatParam);
677
-
678
- export type TextParam = {
679
- /**
680
- * @description The format configuration for text output.
681
- */
682
- format?: (TextFormatParam | null);
683
- verbosity?: (VerbosityEnum & any);
684
- };
685
-
686
- /**
687
- * @description Options that control streamed response behavior.
688
- */
689
- export type StreamOptionsParam = {
690
- /**
691
- * @description Whether to obfuscate sensitive information in streamed output. Defaults to `true`.
692
- * @type boolean | undefined
693
- */
694
- include_obfuscation?: boolean;
695
- };
696
-
697
- export const reasoningEffortEnumEnum = {
698
- none: "none",
699
- low: "low",
700
- medium: "medium",
701
- high: "high",
702
- xhigh: "xhigh"
703
- } as const;
704
-
705
- export type ReasoningEffortEnumEnumKey = (typeof reasoningEffortEnumEnum)[keyof typeof reasoningEffortEnumEnum];
706
-
707
- export type ReasoningEffortEnum = ReasoningEffortEnumEnumKey;
708
-
709
- export const reasoningSummaryEnumEnum = {
710
- concise: "concise",
711
- detailed: "detailed",
712
- auto: "auto"
713
- } as const;
714
-
715
- export type ReasoningSummaryEnumEnumKey = (typeof reasoningSummaryEnumEnum)[keyof typeof reasoningSummaryEnumEnum];
716
-
717
- export type ReasoningSummaryEnum = ReasoningSummaryEnumEnumKey;
718
-
719
- /**
720
- * @description **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).
721
- */
722
- export type ReasoningParam = {
723
- effort?: (ReasoningEffortEnum | null);
724
- summary?: ((ReasoningSummaryEnum & any) | null);
725
- };
726
-
727
- export const truncationEnumEnum = {
728
- auto: "auto",
729
- disabled: "disabled"
730
- } as const;
731
-
732
- export type TruncationEnumEnumKey = (typeof truncationEnumEnum)[keyof typeof truncationEnumEnum];
733
-
734
- export type TruncationEnum = TruncationEnumEnumKey;
735
-
736
- export const serviceTierEnumEnum = {
737
- auto: "auto",
738
- default: "default",
739
- flex: "flex",
740
- priority: "priority"
741
- } as const;
742
-
743
- export type ServiceTierEnumEnumKey = (typeof serviceTierEnumEnum)[keyof typeof serviceTierEnumEnum];
744
-
745
- export type ServiceTierEnum = ServiceTierEnumEnumKey;
746
-
747
- export type CreateResponseBody = {
748
- model?: (string | null);
749
- input?: ((string | ItemParam[]) | null);
750
- previous_response_id?: (string | null);
751
- /**
752
- * @type array | undefined
753
- */
754
- include?: IncludeEnum[];
755
- tools?: (ResponsesToolParam[] | null);
756
- tool_choice?: ((ToolChoiceParam & any) | null);
757
- metadata?: ((MetadataParam & any) | null);
758
- text?: ((TextParam & any) | null);
759
- temperature?: (number | null);
760
- top_p?: (number | null);
761
- presence_penalty?: (number | null);
762
- frequency_penalty?: (number | null);
763
- parallel_tool_calls?: (boolean | null);
764
- /**
765
- * @description Whether to stream response events as server-sent events.
766
- * @type boolean | undefined
767
- */
768
- stream?: boolean;
769
- stream_options?: ((StreamOptionsParam & any) | null);
770
- /**
771
- * @description Whether to run the request in the background and return immediately.
772
- * @type boolean | undefined
773
- */
774
- background?: boolean;
775
- max_output_tokens?: (number | null);
776
- max_tool_calls?: (number | null);
777
- reasoning?: ((ReasoningParam & any) | null);
778
- safety_identifier?: (string | null);
779
- prompt_cache_key?: (string | null);
780
- truncation?: (TruncationEnum & any);
781
- instructions?: (string | null);
782
- /**
783
- * @description Whether to store the response so it can be retrieved later.
784
- * @type boolean | undefined
785
- */
786
- store?: boolean;
787
- service_tier?: (ServiceTierEnum & any);
788
- top_logprobs?: (number | null);
789
- };
790
-
791
- /**
792
- * @description Details about why the response was incomplete.
793
- */
794
- export type IncompleteDetails = {
795
- /**
796
- * @description The reason the response could not be completed.
797
- * @type string
798
- */
799
- reason: string;
800
- };
801
-
802
- export const messageRoleEnum = {
803
- user: "user",
804
- assistant: "assistant",
805
- system: "system",
806
- developer: "developer"
807
- } as const;
808
-
809
- export type MessageRoleEnumKey = (typeof messageRoleEnum)[keyof typeof messageRoleEnum];
810
-
811
- export type MessageRole = MessageRoleEnumKey;
812
-
813
- export const inputTextContentTypeEnum = {
814
- input_text: "input_text"
815
- } as const;
816
-
817
- export type InputTextContentTypeEnumKey = (typeof inputTextContentTypeEnum)[keyof typeof inputTextContentTypeEnum];
818
-
819
- /**
820
- * @description A text input to the model.
821
- */
822
- export type InputTextContent = {
823
- /**
824
- * @description The type of the input item. Always `input_text`.
825
- * @default "input_text"
826
- * @type string
827
- */
828
- type: InputTextContentTypeEnumKey;
829
- /**
830
- * @description The text input to the model.
831
- * @type string
832
- */
833
- text: string;
834
- };
835
-
836
- export const urlCitationBodyTypeEnum = {
837
- url_citation: "url_citation"
838
- } as const;
839
-
840
- export type UrlCitationBodyTypeEnumKey = (typeof urlCitationBodyTypeEnum)[keyof typeof urlCitationBodyTypeEnum];
841
-
842
- /**
843
- * @description A citation for a web resource used to generate a model response.
844
- */
845
- export type UrlCitationBody = {
846
- /**
847
- * @description The type of the URL citation. Always `url_citation`.
848
- * @default "url_citation"
849
- * @type string
850
- */
851
- type: UrlCitationBodyTypeEnumKey;
852
- /**
853
- * @description The URL of the web resource.
854
- * @type string
855
- */
856
- url: string;
857
- /**
858
- * @description The index of the first character of the URL citation in the message.
859
- * @type integer
860
- */
861
- start_index: number;
862
- /**
863
- * @description The index of the last character of the URL citation in the message.
864
- * @type integer
865
- */
866
- end_index: number;
867
- /**
868
- * @description The title of the web resource.
869
- * @type string
870
- */
871
- title: string;
872
- };
873
-
874
- /**
875
- * @description An annotation that applies to a span of output text.
876
- */
877
- export type Annotation = (UrlCitationBody & {
878
- type: "url_citation";
879
- });
880
-
881
- /**
882
- * @description The top log probability of a token.
883
- */
884
- export type TopLogProb = {
885
- /**
886
- * @type string
887
- */
888
- token: string;
889
- /**
890
- * @type number
891
- */
892
- logprob: number;
893
- /**
894
- * @type array
895
- */
896
- bytes: number[];
897
- };
898
-
899
- /**
900
- * @description The log probability of a token.
901
- */
902
- export type LogProb = {
903
- /**
904
- * @type string
905
- */
906
- token: string;
907
- /**
908
- * @type number
909
- */
910
- logprob: number;
911
- /**
912
- * @type array
913
- */
914
- bytes: number[];
915
- /**
916
- * @type array
917
- */
918
- top_logprobs: TopLogProb[];
919
- };
920
-
921
- export const outputTextContentTypeEnum = {
922
- output_text: "output_text"
923
- } as const;
924
-
925
- export type OutputTextContentTypeEnumKey = (typeof outputTextContentTypeEnum)[keyof typeof outputTextContentTypeEnum];
926
-
927
- /**
928
- * @description A text output from the model.
929
- */
930
- export type OutputTextContent = {
931
- /**
932
- * @description The type of the output text. Always `output_text`.
933
- * @default "output_text"
934
- * @type string
935
- */
936
- type: OutputTextContentTypeEnumKey;
937
- /**
938
- * @description The text output from the model.
939
- * @type string
940
- */
941
- text: string;
942
- /**
943
- * @description The annotations of the text output.
944
- * @type array
945
- */
946
- annotations: Annotation[];
947
- /**
948
- * @type array
949
- */
950
- logprobs: LogProb[];
951
- };
952
-
953
- export const textContentTypeEnum = {
954
- text: "text"
955
- } as const;
956
-
957
- export type TextContentTypeEnumKey = (typeof textContentTypeEnum)[keyof typeof textContentTypeEnum];
958
-
959
- /**
960
- * @description A text content.
961
- */
962
- export type TextContent = {
963
- /**
964
- * @default "text"
965
- * @type string
966
- */
967
- type: TextContentTypeEnumKey;
968
- /**
969
- * @type string
970
- */
971
- text: string;
972
- };
973
-
974
- export const summaryTextContentTypeEnum = {
975
- summary_text: "summary_text"
976
- } as const;
977
-
978
- export type SummaryTextContentTypeEnumKey = (typeof summaryTextContentTypeEnum)[keyof typeof summaryTextContentTypeEnum];
979
-
980
- /**
981
- * @description A summary text from the model.
982
- */
983
- export type SummaryTextContent = {
984
- /**
985
- * @description The type of the object. Always `summary_text`.
986
- * @default "summary_text"
987
- * @type string
988
- */
989
- type: SummaryTextContentTypeEnumKey;
990
- /**
991
- * @description A summary of the reasoning output from the model so far.
992
- * @type string
993
- */
994
- text: string;
995
- };
996
-
997
- export const reasoningTextContentTypeEnum = {
998
- reasoning_text: "reasoning_text"
999
- } as const;
1000
-
1001
- export type ReasoningTextContentTypeEnumKey = (typeof reasoningTextContentTypeEnum)[keyof typeof reasoningTextContentTypeEnum];
1002
-
1003
- /**
1004
- * @description Reasoning text from the model.
1005
- */
1006
- export type ReasoningTextContent = {
1007
- /**
1008
- * @description The type of the reasoning text. Always `reasoning_text`.
1009
- * @default "reasoning_text"
1010
- * @type string
1011
- */
1012
- type: ReasoningTextContentTypeEnumKey;
1013
- /**
1014
- * @description The reasoning text from the model.
1015
- * @type string
1016
- */
1017
- text: string;
1018
- };
1019
-
1020
- export const refusalContentTypeEnum = {
1021
- refusal: "refusal"
1022
- } as const;
1023
-
1024
- export type RefusalContentTypeEnumKey = (typeof refusalContentTypeEnum)[keyof typeof refusalContentTypeEnum];
1025
-
1026
- /**
1027
- * @description A refusal from the model.
1028
- */
1029
- export type RefusalContent = {
1030
- /**
1031
- * @description The type of the refusal. Always `refusal`.
1032
- * @default "refusal"
1033
- * @type string
1034
- */
1035
- type: RefusalContentTypeEnumKey;
1036
- /**
1037
- * @description The refusal explanation from the model.
1038
- * @type string
1039
- */
1040
- refusal: string;
1041
- };
1042
-
1043
- export const inputImageContentTypeEnum = {
1044
- input_image: "input_image"
1045
- } as const;
1046
-
1047
- export type InputImageContentTypeEnumKey = (typeof inputImageContentTypeEnum)[keyof typeof inputImageContentTypeEnum];
1048
-
1049
- /**
1050
- * @description An image input to the model. Learn about [image inputs](/docs/guides/vision).
1051
- */
1052
- export type InputImageContent = {
1053
- /**
1054
- * @description The type of the input item. Always `input_image`.
1055
- * @default "input_image"
1056
- * @type string
1057
- */
1058
- type: InputImageContentTypeEnumKey;
1059
- image_url: (string | null);
1060
- detail: (ImageDetail & any);
1061
- };
1062
-
1063
- export const inputFileContentTypeEnum = {
1064
- input_file: "input_file"
1065
- } as const;
1066
-
1067
- export type InputFileContentTypeEnumKey = (typeof inputFileContentTypeEnum)[keyof typeof inputFileContentTypeEnum];
1068
-
1069
- /**
1070
- * @description A file input to the model.
1071
- */
1072
- export type InputFileContent = {
1073
- /**
1074
- * @description The type of the input item. Always `input_file`.
1075
- * @default "input_file"
1076
- * @type string
1077
- */
1078
- type: InputFileContentTypeEnumKey;
1079
- /**
1080
- * @description The name of the file to be sent to the model.
1081
- * @type string | undefined
1082
- */
1083
- filename?: string;
1084
- /**
1085
- * @description The URL of the file to be sent to the model.
1086
- * @type string | undefined
1087
- */
1088
- file_url?: string;
1089
- };
1090
-
1091
- export const messageStatusEnum = {
1092
- in_progress: "in_progress",
1093
- completed: "completed",
1094
- incomplete: "incomplete"
1095
- } as const;
1096
-
1097
- export type MessageStatusEnumKey = (typeof messageStatusEnum)[keyof typeof messageStatusEnum];
1098
-
1099
- export type MessageStatus = MessageStatusEnumKey;
1100
-
1101
- export const messageTypeEnum = {
1102
- message: "message"
1103
- } as const;
1104
-
1105
- export type MessageTypeEnumKey = (typeof messageTypeEnum)[keyof typeof messageTypeEnum];
1106
-
1107
- /**
1108
- * @description A message to or from the model.
1109
- */
1110
- export type Message = {
1111
- /**
1112
- * @description The type of the message. Always set to `message`.
1113
- * @default "message"
1114
- * @type string
1115
- */
1116
- type: MessageTypeEnumKey;
1117
- /**
1118
- * @description The unique ID of the message.
1119
- * @type string
1120
- */
1121
- id: string;
1122
- status: (MessageStatus & any);
1123
- role: (MessageRole & any);
1124
- /**
1125
- * @description The content of the message
1126
- * @type array
1127
- */
1128
- content: ((InputTextContent & {
1129
- type: "input_text";
1130
- }) | (OutputTextContent & {
1131
- type: "output_text";
1132
- }) | (TextContent & {
1133
- type: "text";
1134
- }) | (SummaryTextContent & {
1135
- type: "summary_text";
1136
- }) | (ReasoningTextContent & {
1137
- type: "reasoning_text";
1138
- }) | (RefusalContent & {
1139
- type: "refusal";
1140
- }) | (InputImageContent & {
1141
- type: "input_image";
1142
- }) | (InputFileContent & {
1143
- type: "input_file";
1144
- }) | (InputVideoContent & {
1145
- type: "input_video";
1146
- }))[];
1147
- };
1148
-
1149
- export const functionCallTypeEnum = {
1150
- function_call: "function_call"
1151
- } as const;
1152
-
1153
- export type FunctionCallTypeEnumKey = (typeof functionCallTypeEnum)[keyof typeof functionCallTypeEnum];
1154
-
1155
- /**
1156
- * @description A function tool call that was generated by the model.
1157
- */
1158
- export type FunctionCall = {
1159
- /**
1160
- * @description The type of the item. Always `function_call`.
1161
- * @default "function_call"
1162
- * @type string
1163
- */
1164
- type: FunctionCallTypeEnumKey;
1165
- /**
1166
- * @description The unique ID of the function call item.
1167
- * @type string
1168
- */
1169
- id: string;
1170
- /**
1171
- * @description The unique ID of the function tool call that was generated.
1172
- * @type string
1173
- */
1174
- call_id: string;
1175
- /**
1176
- * @description The name of the function that was called.
1177
- * @type string
1178
- */
1179
- name: string;
1180
- /**
1181
- * @description The arguments JSON string that was generated.
1182
- * @type string
1183
- */
1184
- arguments: string;
1185
- status: (FunctionCallStatus & any);
1186
- };
1187
-
1188
- export const functionCallOutputStatusEnumEnum = {
1189
- in_progress: "in_progress",
1190
- completed: "completed",
1191
- incomplete: "incomplete"
1192
- } as const;
1193
-
1194
- export type FunctionCallOutputStatusEnumEnumKey = (typeof functionCallOutputStatusEnumEnum)[keyof typeof functionCallOutputStatusEnumEnum];
1195
-
1196
- /**
1197
- * @description Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.
1198
- */
1199
- export type FunctionCallOutputStatusEnum = FunctionCallOutputStatusEnumEnumKey;
1200
-
1201
- export const functionCallOutputTypeEnum = {
1202
- function_call_output: "function_call_output"
1203
- } as const;
1204
-
1205
- export type FunctionCallOutputTypeEnumKey = (typeof functionCallOutputTypeEnum)[keyof typeof functionCallOutputTypeEnum];
1206
-
1207
- /**
1208
- * @description A function tool call output that was returned by the tool.
1209
- */
1210
- export type FunctionCallOutput = {
1211
- /**
1212
- * @description The type of the function tool call output. Always `function_call_output`.
1213
- * @default "function_call_output"
1214
- * @type string
1215
- */
1216
- type: FunctionCallOutputTypeEnumKey;
1217
- /**
1218
- * @description The unique ID of the function tool call output. Populated when this item is returned via API.
1219
- * @type string
1220
- */
1221
- id: string;
1222
- /**
1223
- * @description The unique ID of the function tool call generated by the model.
1224
- * @type string
1225
- */
1226
- call_id: string;
1227
- output: (string | ((InputTextContent & {
1228
- type: "input_text";
1229
- }) | (InputImageContent & {
1230
- type: "input_image";
1231
- }) | (InputFileContent & {
1232
- type: "input_file";
1233
- }))[]);
1234
- status: (FunctionCallOutputStatusEnum & any);
1235
- };
1236
-
1237
- export const reasoningBodyTypeEnum = {
1238
- reasoning: "reasoning"
1239
- } as const;
1240
-
1241
- export type ReasoningBodyTypeEnumKey = (typeof reasoningBodyTypeEnum)[keyof typeof reasoningBodyTypeEnum];
1242
-
1243
- /**
1244
- * @description A reasoning item that was generated by the model.
1245
- */
1246
- export type ReasoningBody = {
1247
- /**
1248
- * @description The type of the item. Always `reasoning`.
1249
- * @default "reasoning"
1250
- * @type string
1251
- */
1252
- type: ReasoningBodyTypeEnumKey;
1253
- /**
1254
- * @description The unique ID of the reasoning item.
1255
- * @type string
1256
- */
1257
- id: string;
1258
- /**
1259
- * @description The reasoning content that was generated.
1260
- * @type array | undefined
1261
- */
1262
- content?: ((InputTextContent & {
1263
- type: "input_text";
1264
- }) | (OutputTextContent & {
1265
- type: "output_text";
1266
- }) | (TextContent & {
1267
- type: "text";
1268
- }) | (SummaryTextContent & {
1269
- type: "summary_text";
1270
- }) | (ReasoningTextContent & {
1271
- type: "reasoning_text";
1272
- }) | (RefusalContent & {
1273
- type: "refusal";
1274
- }) | (InputImageContent & {
1275
- type: "input_image";
1276
- }) | (InputFileContent & {
1277
- type: "input_file";
1278
- }))[];
1279
- /**
1280
- * @description The reasoning summary content that was generated.
1281
- * @type array
1282
- */
1283
- summary: ((InputTextContent & {
1284
- type: "input_text";
1285
- }) | (OutputTextContent & {
1286
- type: "output_text";
1287
- }) | (TextContent & {
1288
- type: "text";
1289
- }) | (SummaryTextContent & {
1290
- type: "summary_text";
1291
- }) | (ReasoningTextContent & {
1292
- type: "reasoning_text";
1293
- }) | (RefusalContent & {
1294
- type: "refusal";
1295
- }) | (InputImageContent & {
1296
- type: "input_image";
1297
- }) | (InputFileContent & {
1298
- type: "input_file";
1299
- }))[];
1300
- /**
1301
- * @description The encrypted reasoning content that was generated.
1302
- * @type string | undefined
1303
- */
1304
- encrypted_content?: string;
1305
- };
1306
-
1307
- /**
1308
- * @description An item representing a message, tool call, tool output, reasoning, or other response element.
1309
- */
1310
- export type ItemField = ((Message & {
1311
- type: "message";
1312
- }) | (FunctionCall & {
1313
- type: "function_call";
1314
- }) | (FunctionCallOutput & {
1315
- type: "function_call_output";
1316
- }) | (ReasoningBody & {
1317
- type: "reasoning";
1318
- }));
1319
-
1320
- /**
1321
- * @description An error that occurred while generating the response.
1322
- */
1323
- export type Error = {
1324
- /**
1325
- * @description A machine-readable error code that was returned.
1326
- * @type string
1327
- */
1328
- code: string;
1329
- /**
1330
- * @description A human-readable description of the error that was returned.
1331
- * @type string
1332
- */
1333
- message: string;
1334
- };
1335
-
1336
- export const functionToolTypeEnum = {
1337
- function: "function"
1338
- } as const;
1339
-
1340
- export type FunctionToolTypeEnumKey = (typeof functionToolTypeEnum)[keyof typeof functionToolTypeEnum];
1341
-
1342
- /**
1343
- * @description Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).
1344
- */
1345
- export type FunctionTool = {
1346
- /**
1347
- * @description The type of the function tool. Always `function`.
1348
- * @default "function"
1349
- * @type string
1350
- */
1351
- type: FunctionToolTypeEnumKey;
1352
- /**
1353
- * @description The name of the function to call.
1354
- * @type string
1355
- */
1356
- name: string;
1357
- description: (string | null);
1358
- parameters: ({
1359
- [key: string]: any;
1360
- } | null);
1361
- strict: (boolean | null);
1362
- };
1363
-
1364
- /**
1365
- * @description A tool that can be used to generate a response.
1366
- */
1367
- export type Tool = (FunctionTool & {
1368
- type: "function";
1369
- });
1370
-
1371
- export const functionToolChoiceTypeEnum = {
1372
- function: "function"
1373
- } as const;
1374
-
1375
- export type FunctionToolChoiceTypeEnumKey = (typeof functionToolChoiceTypeEnum)[keyof typeof functionToolChoiceTypeEnum];
1376
-
1377
- export type FunctionToolChoice = {
1378
- /**
1379
- * @default "function"
1380
- * @type string
1381
- */
1382
- type: FunctionToolChoiceTypeEnumKey;
1383
- /**
1384
- * @type string | undefined
1385
- */
1386
- name?: string;
1387
- };
1388
-
1389
- export const allowedToolChoiceTypeEnum = {
1390
- allowed_tools: "allowed_tools"
1391
- } as const;
1392
-
1393
- export type AllowedToolChoiceTypeEnumKey = (typeof allowedToolChoiceTypeEnum)[keyof typeof allowedToolChoiceTypeEnum];
1394
-
1395
- export type AllowedToolChoice = {
1396
- /**
1397
- * @default "allowed_tools"
1398
- * @type string
1399
- */
1400
- type: AllowedToolChoiceTypeEnumKey;
1401
- /**
1402
- * @type array
1403
- */
1404
- tools: FunctionToolChoice[];
1405
- /**
1406
- * @type string
1407
- */
1408
- mode: ToolChoiceValueEnum;
1409
- };
1410
-
1411
- export const jsonObjectResponseFormatTypeEnum = {
1412
- json_object: "json_object"
1413
- } as const;
1414
-
1415
- export type JsonObjectResponseFormatTypeEnumKey = (typeof jsonObjectResponseFormatTypeEnum)[keyof typeof jsonObjectResponseFormatTypeEnum];
1416
-
1417
- export type JsonObjectResponseFormat = {
1418
- /**
1419
- * @default "json_object"
1420
- * @type string
1421
- */
1422
- type: JsonObjectResponseFormatTypeEnumKey;
1423
- };
1424
-
1425
- export const jsonSchemaResponseFormatTypeEnum = {
1426
- json_schema: "json_schema"
1427
- } as const;
1428
-
1429
- export type JsonSchemaResponseFormatTypeEnumKey = (typeof jsonSchemaResponseFormatTypeEnum)[keyof typeof jsonSchemaResponseFormatTypeEnum];
1430
-
1431
- export type JsonSchemaResponseFormat = {
1432
- /**
1433
- * @default "json_schema"
1434
- * @type string
1435
- */
1436
- type: JsonSchemaResponseFormatTypeEnumKey;
1437
- /**
1438
- * @type string
1439
- */
1440
- name: string;
1441
- description: (string | null);
1442
- schema: null;
1443
- /**
1444
- * @type boolean
1445
- */
1446
- strict: boolean;
1447
- };
1448
-
1449
- export type TextField = {
1450
- format: (TextResponseFormat | JsonObjectResponseFormat | JsonSchemaResponseFormat);
1451
- /**
1452
- * @type string | undefined
1453
- */
1454
- verbosity?: VerbosityEnum;
1455
- };
1456
-
1457
- /**
1458
- * @description Reasoning configuration and metadata that were used for the response.
1459
- */
1460
- export type Reasoning = {
1461
- effort: (ReasoningEffortEnum | null);
1462
- summary: ((ReasoningSummaryEnum & any) | null);
1463
- };
1464
-
1465
- /**
1466
- * @description A breakdown of input token usage that was recorded.
1467
- */
1468
- export type InputTokensDetails = {
1469
- /**
1470
- * @description The number of input tokens that were served from cache.
1471
- * @type integer
1472
- */
1473
- cached_tokens: number;
1474
- };
1475
-
1476
- /**
1477
- * @description A breakdown of output token usage that was recorded.
1478
- */
1479
- export type OutputTokensDetails = {
1480
- /**
1481
- * @description The number of output tokens that were attributed to reasoning.
1482
- * @type integer
1483
- */
1484
- reasoning_tokens: number;
1485
- };
1486
-
1487
- /**
1488
- * @description Token usage statistics that were recorded for the response.
1489
- */
1490
- export type Usage = {
1491
- /**
1492
- * @description The number of input tokens that were used to generate the response.
1493
- * @type integer
1494
- */
1495
- input_tokens: number;
1496
- /**
1497
- * @description The number of output tokens that were generated by the model.
1498
- * @type integer
1499
- */
1500
- output_tokens: number;
1501
- /**
1502
- * @description The total number of tokens that were used.
1503
- * @type integer
1504
- */
1505
- total_tokens: number;
1506
- input_tokens_details: (InputTokensDetails & any);
1507
- output_tokens_details: (OutputTokensDetails & any);
1508
- };
1509
-
1510
- export const responseResourceObjectEnum = {
1511
- response: "response"
1512
- } as const;
1513
-
1514
- export type ResponseResourceObjectEnumKey = (typeof responseResourceObjectEnum)[keyof typeof responseResourceObjectEnum];
1515
-
1516
- /**
1517
- * @description The complete response object that was returned by the Responses API.
1518
- * @example [object Object]
1519
- */
1520
- export type ResponseResource = {
1521
- /**
1522
- * @description The unique ID of the response that was created.
1523
- * @type string
1524
- */
1525
- id: string;
1526
- /**
1527
- * @description The object type, which was always `response`.
1528
- * @default "response"
1529
- * @type string
1530
- */
1531
- object: ResponseResourceObjectEnumKey;
1532
- /**
1533
- * @description The Unix timestamp (in seconds) for when the response was created.
1534
- * @type integer
1535
- */
1536
- created_at: number;
1537
- completed_at: (number | null);
1538
- /**
1539
- * @description The status that was set for the response.
1540
- * @type string
1541
- */
1542
- status: string;
1543
- incomplete_details: ((IncompleteDetails & any) | null);
1544
- /**
1545
- * @description The model that generated this response.
1546
- * @type string
1547
- */
1548
- model: string;
1549
- previous_response_id: (string | null);
1550
- instructions: (string | null);
1551
- /**
1552
- * @description The output items that were generated by the model.
1553
- * @type array
1554
- */
1555
- output: ItemField[];
1556
- error: ((Error & any) | null);
1557
- /**
1558
- * @description The tools that were available to the model during response generation.
1559
- * @type array
1560
- */
1561
- tools: Tool[];
1562
- tool_choice: (FunctionToolChoice | ToolChoiceValueEnum | AllowedToolChoice);
1563
- truncation: (TruncationEnum & any);
1564
- /**
1565
- * @description Whether the model was allowed to call multiple tools in parallel.
1566
- * @type boolean
1567
- */
1568
- parallel_tool_calls: boolean;
1569
- text: (TextField & any);
1570
- /**
1571
- * @description The nucleus sampling parameter that was used for this response.
1572
- * @type number
1573
- */
1574
- top_p: number;
1575
- /**
1576
- * @description The presence penalty that was used to penalize new tokens based on whether they appear in the text so far.
1577
- * @type number
1578
- */
1579
- presence_penalty: number;
1580
- /**
1581
- * @description The frequency penalty that was used to penalize new tokens based on their frequency in the text so far.
1582
- * @type number
1583
- */
1584
- frequency_penalty: number;
1585
- /**
1586
- * @description The number of most likely tokens that were returned at each position, along with their log probabilities.
1587
- * @type integer
1588
- */
1589
- top_logprobs: number;
1590
- /**
1591
- * @description The sampling temperature that was used for this response.
1592
- * @type number
1593
- */
1594
- temperature: number;
1595
- reasoning: ((Reasoning & any) | null);
1596
- usage: ((Usage & any) | null);
1597
- max_output_tokens: (number | null);
1598
- max_tool_calls: (number | null);
1599
- /**
1600
- * @description Whether this response was stored so it can be retrieved later.
1601
- * @type boolean
1602
- */
1603
- store: boolean;
1604
- /**
1605
- * @description Whether this request was run in the background.
1606
- * @type boolean
1607
- */
1608
- background: boolean;
1609
- /**
1610
- * @description The service tier that was used for this response.
1611
- * @type string
1612
- */
1613
- service_tier: string;
1614
- /**
1615
- * @description Developer-defined metadata that was associated with the response.
1616
- */
1617
- metadata: any;
1618
- safety_identifier: (string | null);
1619
- prompt_cache_key: (string | null);
1620
- };
1621
-
1622
- export const responseCreatedStreamingEventTypeEnum = {
1623
- "response.created": "response.created"
1624
- } as const;
1625
-
1626
- export type ResponseCreatedStreamingEventTypeEnumKey = (typeof responseCreatedStreamingEventTypeEnum)[keyof typeof responseCreatedStreamingEventTypeEnum];
1627
-
1628
- /**
1629
- * @description A streaming event that indicated the response was created.
1630
- */
1631
- export type ResponseCreatedStreamingEvent = {
1632
- /**
1633
- * @description The type of the event, always `response.created`.
1634
- * @default "response.created"
1635
- * @type string
1636
- */
1637
- type: ResponseCreatedStreamingEventTypeEnumKey;
1638
- /**
1639
- * @description The sequence number of the event that was emitted.
1640
- * @type integer
1641
- */
1642
- sequence_number: number;
1643
- response: (ResponseResource & any);
1644
- };
1645
-
1646
- export const responseQueuedStreamingEventTypeEnum = {
1647
- "response.queued": "response.queued"
1648
- } as const;
1649
-
1650
- export type ResponseQueuedStreamingEventTypeEnumKey = (typeof responseQueuedStreamingEventTypeEnum)[keyof typeof responseQueuedStreamingEventTypeEnum];
1651
-
1652
- /**
1653
- * @description A streaming event that indicated the response was queued.
1654
- */
1655
- export type ResponseQueuedStreamingEvent = {
1656
- /**
1657
- * @description The type of the event, always `response.queued`.
1658
- * @default "response.queued"
1659
- * @type string
1660
- */
1661
- type: ResponseQueuedStreamingEventTypeEnumKey;
1662
- /**
1663
- * @description The sequence number of the event that was emitted.
1664
- * @type integer
1665
- */
1666
- sequence_number: number;
1667
- response: (ResponseResource & any);
1668
- };
1669
-
1670
- export const responseInProgressStreamingEventTypeEnum = {
1671
- "response.in_progress": "response.in_progress"
1672
- } as const;
1673
-
1674
- export type ResponseInProgressStreamingEventTypeEnumKey = (typeof responseInProgressStreamingEventTypeEnum)[keyof typeof responseInProgressStreamingEventTypeEnum];
1675
-
1676
- /**
1677
- * @description A streaming event that indicated the response was in progress.
1678
- */
1679
- export type ResponseInProgressStreamingEvent = {
1680
- /**
1681
- * @description The type of the event, always `response.in_progress`.
1682
- * @default "response.in_progress"
1683
- * @type string
1684
- */
1685
- type: ResponseInProgressStreamingEventTypeEnumKey;
1686
- /**
1687
- * @description The sequence number of the event that was emitted.
1688
- * @type integer
1689
- */
1690
- sequence_number: number;
1691
- response: (ResponseResource & any);
1692
- };
1693
-
1694
- export const responseCompletedStreamingEventTypeEnum = {
1695
- "response.completed": "response.completed"
1696
- } as const;
1697
-
1698
- export type ResponseCompletedStreamingEventTypeEnumKey = (typeof responseCompletedStreamingEventTypeEnum)[keyof typeof responseCompletedStreamingEventTypeEnum];
1699
-
1700
- /**
1701
- * @description A streaming event that indicated the response was completed.
1702
- */
1703
- export type ResponseCompletedStreamingEvent = {
1704
- /**
1705
- * @description The type of the event, always `response.completed`.
1706
- * @default "response.completed"
1707
- * @type string
1708
- */
1709
- type: ResponseCompletedStreamingEventTypeEnumKey;
1710
- /**
1711
- * @description The sequence number of the event that was emitted.
1712
- * @type integer
1713
- */
1714
- sequence_number: number;
1715
- response: (ResponseResource & any);
1716
- };
1717
-
1718
- export const responseFailedStreamingEventTypeEnum = {
1719
- "response.failed": "response.failed"
1720
- } as const;
1721
-
1722
- export type ResponseFailedStreamingEventTypeEnumKey = (typeof responseFailedStreamingEventTypeEnum)[keyof typeof responseFailedStreamingEventTypeEnum];
1723
-
1724
- /**
1725
- * @description A streaming event that indicated the response had failed.
1726
- */
1727
- export type ResponseFailedStreamingEvent = {
1728
- /**
1729
- * @description The type of the event, always `response.failed`.
1730
- * @default "response.failed"
1731
- * @type string
1732
- */
1733
- type: ResponseFailedStreamingEventTypeEnumKey;
1734
- /**
1735
- * @description The sequence number of the event that was emitted.
1736
- * @type integer
1737
- */
1738
- sequence_number: number;
1739
- response: (ResponseResource & any);
1740
- };
1741
-
1742
- export const responseIncompleteStreamingEventTypeEnum = {
1743
- "response.incomplete": "response.incomplete"
1744
- } as const;
1745
-
1746
- export type ResponseIncompleteStreamingEventTypeEnumKey = (typeof responseIncompleteStreamingEventTypeEnum)[keyof typeof responseIncompleteStreamingEventTypeEnum];
1747
-
1748
- /**
1749
- * @description A streaming event that indicated the response was incomplete.
1750
- */
1751
- export type ResponseIncompleteStreamingEvent = {
1752
- /**
1753
- * @description The type of the event, always `response.incomplete`.
1754
- * @default "response.incomplete"
1755
- * @type string
1756
- */
1757
- type: ResponseIncompleteStreamingEventTypeEnumKey;
1758
- /**
1759
- * @description The sequence number of the event that was emitted.
1760
- * @type integer
1761
- */
1762
- sequence_number: number;
1763
- response: (ResponseResource & any);
1764
- };
1765
-
1766
- export const responseOutputItemAddedStreamingEventTypeEnum = {
1767
- "response.output_item.added": "response.output_item.added"
1768
- } as const;
1769
-
1770
- export type ResponseOutputItemAddedStreamingEventTypeEnumKey = (typeof responseOutputItemAddedStreamingEventTypeEnum)[keyof typeof responseOutputItemAddedStreamingEventTypeEnum];
1771
-
1772
- /**
1773
- * @description A streaming event that indicated an output item was added to the response.
1774
- */
1775
- export type ResponseOutputItemAddedStreamingEvent = {
1776
- /**
1777
- * @description The type of the event, always `response.output_item.added`.
1778
- * @default "response.output_item.added"
1779
- * @type string
1780
- */
1781
- type: ResponseOutputItemAddedStreamingEventTypeEnumKey;
1782
- /**
1783
- * @description The sequence number of the event that was emitted.
1784
- * @type integer
1785
- */
1786
- sequence_number: number;
1787
- /**
1788
- * @description The index of the output item that was added.
1789
- * @type integer
1790
- */
1791
- output_index: number;
1792
- item: ((ItemField & any) | null);
1793
- };
1794
-
1795
- export const responseOutputItemDoneStreamingEventTypeEnum = {
1796
- "response.output_item.done": "response.output_item.done"
1797
- } as const;
1798
-
1799
- export type ResponseOutputItemDoneStreamingEventTypeEnumKey = (typeof responseOutputItemDoneStreamingEventTypeEnum)[keyof typeof responseOutputItemDoneStreamingEventTypeEnum];
1800
-
1801
- /**
1802
- * @description A streaming event that indicated an output item was completed.
1803
- */
1804
- export type ResponseOutputItemDoneStreamingEvent = {
1805
- /**
1806
- * @description The type of the event, always `response.output_item.done`.
1807
- * @default "response.output_item.done"
1808
- * @type string
1809
- */
1810
- type: ResponseOutputItemDoneStreamingEventTypeEnumKey;
1811
- /**
1812
- * @description The sequence number of the event that was emitted.
1813
- * @type integer
1814
- */
1815
- sequence_number: number;
1816
- /**
1817
- * @description The index of the output item that was completed.
1818
- * @type integer
1819
- */
1820
- output_index: number;
1821
- item: ((ItemField & any) | null);
1822
- };
1823
-
1824
- export const responseReasoningSummaryPartAddedStreamingEventTypeEnum = {
1825
- "response.reasoning_summary_part.added": "response.reasoning_summary_part.added"
1826
- } as const;
1827
-
1828
- export type ResponseReasoningSummaryPartAddedStreamingEventTypeEnumKey = (typeof responseReasoningSummaryPartAddedStreamingEventTypeEnum)[keyof typeof responseReasoningSummaryPartAddedStreamingEventTypeEnum];
1829
-
1830
- /**
1831
- * @description A streaming event that indicated a reasoning summary part was added.
1832
- */
1833
- export type ResponseReasoningSummaryPartAddedStreamingEvent = {
1834
- /**
1835
- * @description The type of the event, always `response.reasoning_summary_part.added`.
1836
- * @default "response.reasoning_summary_part.added"
1837
- * @type string
1838
- */
1839
- type: ResponseReasoningSummaryPartAddedStreamingEventTypeEnumKey;
1840
- /**
1841
- * @description The sequence number of the event that was emitted.
1842
- * @type integer
1843
- */
1844
- sequence_number: number;
1845
- /**
1846
- * @description The ID of the item that was updated.
1847
- * @type string
1848
- */
1849
- item_id: string;
1850
- /**
1851
- * @description The index of the output item that was updated.
1852
- * @type integer
1853
- */
1854
- output_index: number;
1855
- /**
1856
- * @description The index of the summary part that was added.
1857
- * @type integer
1858
- */
1859
- summary_index: number;
1860
- /**
1861
- * @description A content part that makes up an input or output item.
1862
- */
1863
- part: ((InputTextContent & {
1864
- type: "input_text";
1865
- }) | (OutputTextContent & {
1866
- type: "output_text";
1867
- }) | (TextContent & {
1868
- type: "text";
1869
- }) | (SummaryTextContent & {
1870
- type: "summary_text";
1871
- }) | (ReasoningTextContent & {
1872
- type: "reasoning_text";
1873
- }) | (RefusalContent & {
1874
- type: "refusal";
1875
- }) | (InputImageContent & {
1876
- type: "input_image";
1877
- }) | (InputFileContent & {
1878
- type: "input_file";
1879
- }));
1880
- };
1881
-
1882
- export const responseReasoningSummaryPartDoneStreamingEventTypeEnum = {
1883
- "response.reasoning_summary_part.done": "response.reasoning_summary_part.done"
1884
- } as const;
1885
-
1886
- export type ResponseReasoningSummaryPartDoneStreamingEventTypeEnumKey = (typeof responseReasoningSummaryPartDoneStreamingEventTypeEnum)[keyof typeof responseReasoningSummaryPartDoneStreamingEventTypeEnum];
1887
-
1888
- /**
1889
- * @description A streaming event that indicated a reasoning summary part was completed.
1890
- */
1891
- export type ResponseReasoningSummaryPartDoneStreamingEvent = {
1892
- /**
1893
- * @description The type of the event, always `response.reasoning_summary_part.done`.
1894
- * @default "response.reasoning_summary_part.done"
1895
- * @type string
1896
- */
1897
- type: ResponseReasoningSummaryPartDoneStreamingEventTypeEnumKey;
1898
- /**
1899
- * @description The sequence number of the event that was emitted.
1900
- * @type integer
1901
- */
1902
- sequence_number: number;
1903
- /**
1904
- * @description The ID of the item that was updated.
1905
- * @type string
1906
- */
1907
- item_id: string;
1908
- /**
1909
- * @description The index of the output item that was updated.
1910
- * @type integer
1911
- */
1912
- output_index: number;
1913
- /**
1914
- * @description The index of the summary part that was completed.
1915
- * @type integer
1916
- */
1917
- summary_index: number;
1918
- /**
1919
- * @description A content part that makes up an input or output item.
1920
- */
1921
- part: ((InputTextContent & {
1922
- type: "input_text";
1923
- }) | (OutputTextContent & {
1924
- type: "output_text";
1925
- }) | (TextContent & {
1926
- type: "text";
1927
- }) | (SummaryTextContent & {
1928
- type: "summary_text";
1929
- }) | (ReasoningTextContent & {
1930
- type: "reasoning_text";
1931
- }) | (RefusalContent & {
1932
- type: "refusal";
1933
- }) | (InputImageContent & {
1934
- type: "input_image";
1935
- }) | (InputFileContent & {
1936
- type: "input_file";
1937
- }));
1938
- };
1939
-
1940
- export const responseContentPartAddedStreamingEventTypeEnum = {
1941
- "response.content_part.added": "response.content_part.added"
1942
- } as const;
1943
-
1944
- export type ResponseContentPartAddedStreamingEventTypeEnumKey = (typeof responseContentPartAddedStreamingEventTypeEnum)[keyof typeof responseContentPartAddedStreamingEventTypeEnum];
1945
-
1946
- /**
1947
- * @description A streaming event that indicated a content part was added.
1948
- */
1949
- export type ResponseContentPartAddedStreamingEvent = {
1950
- /**
1951
- * @description The type of the event, always `response.content_part.added`.
1952
- * @default "response.content_part.added"
1953
- * @type string
1954
- */
1955
- type: ResponseContentPartAddedStreamingEventTypeEnumKey;
1956
- /**
1957
- * @description The sequence number of the event that was emitted.
1958
- * @type integer
1959
- */
1960
- sequence_number: number;
1961
- /**
1962
- * @description The ID of the item that was updated.
1963
- * @type string
1964
- */
1965
- item_id: string;
1966
- /**
1967
- * @description The index of the output item that was updated.
1968
- * @type integer
1969
- */
1970
- output_index: number;
1971
- /**
1972
- * @description The index of the content part that was added.
1973
- * @type integer
1974
- */
1975
- content_index: number;
1976
- /**
1977
- * @description A content part that makes up an input or output item.
1978
- */
1979
- part: ((InputTextContent & {
1980
- type: "input_text";
1981
- }) | (OutputTextContent & {
1982
- type: "output_text";
1983
- }) | (TextContent & {
1984
- type: "text";
1985
- }) | (SummaryTextContent & {
1986
- type: "summary_text";
1987
- }) | (ReasoningTextContent & {
1988
- type: "reasoning_text";
1989
- }) | (RefusalContent & {
1990
- type: "refusal";
1991
- }) | (InputImageContent & {
1992
- type: "input_image";
1993
- }) | (InputFileContent & {
1994
- type: "input_file";
1995
- }));
1996
- };
1997
-
1998
- export const responseContentPartDoneStreamingEventTypeEnum = {
1999
- "response.content_part.done": "response.content_part.done"
2000
- } as const;
2001
-
2002
- export type ResponseContentPartDoneStreamingEventTypeEnumKey = (typeof responseContentPartDoneStreamingEventTypeEnum)[keyof typeof responseContentPartDoneStreamingEventTypeEnum];
2003
-
2004
- /**
2005
- * @description A streaming event that indicated a content part was completed.
2006
- */
2007
- export type ResponseContentPartDoneStreamingEvent = {
2008
- /**
2009
- * @description The type of the event, always `response.content_part.done`.
2010
- * @default "response.content_part.done"
2011
- * @type string
2012
- */
2013
- type: ResponseContentPartDoneStreamingEventTypeEnumKey;
2014
- /**
2015
- * @description The sequence number of the event that was emitted.
2016
- * @type integer
2017
- */
2018
- sequence_number: number;
2019
- /**
2020
- * @description The ID of the item that was updated.
2021
- * @type string
2022
- */
2023
- item_id: string;
2024
- /**
2025
- * @description The index of the output item that was updated.
2026
- * @type integer
2027
- */
2028
- output_index: number;
2029
- /**
2030
- * @description The index of the content part that was completed.
2031
- * @type integer
2032
- */
2033
- content_index: number;
2034
- /**
2035
- * @description A content part that makes up an input or output item.
2036
- */
2037
- part: ((InputTextContent & {
2038
- type: "input_text";
2039
- }) | (OutputTextContent & {
2040
- type: "output_text";
2041
- }) | (TextContent & {
2042
- type: "text";
2043
- }) | (SummaryTextContent & {
2044
- type: "summary_text";
2045
- }) | (ReasoningTextContent & {
2046
- type: "reasoning_text";
2047
- }) | (RefusalContent & {
2048
- type: "refusal";
2049
- }) | (InputImageContent & {
2050
- type: "input_image";
2051
- }) | (InputFileContent & {
2052
- type: "input_file";
2053
- }));
2054
- };
2055
-
2056
- export const responseOutputTextDeltaStreamingEventTypeEnum = {
2057
- "response.output_text.delta": "response.output_text.delta"
2058
- } as const;
2059
-
2060
- export type ResponseOutputTextDeltaStreamingEventTypeEnumKey = (typeof responseOutputTextDeltaStreamingEventTypeEnum)[keyof typeof responseOutputTextDeltaStreamingEventTypeEnum];
2061
-
2062
- /**
2063
- * @description A streaming event that indicated output text was incrementally added.
2064
- */
2065
- export type ResponseOutputTextDeltaStreamingEvent = {
2066
- /**
2067
- * @description The type of the event, always `response.output_text.delta`.
2068
- * @default "response.output_text.delta"
2069
- * @type string
2070
- */
2071
- type: ResponseOutputTextDeltaStreamingEventTypeEnumKey;
2072
- /**
2073
- * @description The sequence number of the event that was emitted.
2074
- * @type integer
2075
- */
2076
- sequence_number: number;
2077
- /**
2078
- * @description The ID of the item that was updated.
2079
- * @type string
2080
- */
2081
- item_id: string;
2082
- /**
2083
- * @description The index of the output item that was updated.
2084
- * @type integer
2085
- */
2086
- output_index: number;
2087
- /**
2088
- * @description The index of the content part that was updated.
2089
- * @type integer
2090
- */
2091
- content_index: number;
2092
- /**
2093
- * @description The text delta that was appended.
2094
- * @type string
2095
- */
2096
- delta: string;
2097
- /**
2098
- * @description The token log probabilities that were emitted with the delta, if any.
2099
- * @type array
2100
- */
2101
- logprobs: LogProb[];
2102
- /**
2103
- * @description An obfuscation string that was added to pad the event payload.
2104
- * @type string | undefined
2105
- */
2106
- obfuscation?: string;
2107
- };
2108
-
2109
- export const responseOutputTextDoneStreamingEventTypeEnum = {
2110
- "response.output_text.done": "response.output_text.done"
2111
- } as const;
2112
-
2113
- export type ResponseOutputTextDoneStreamingEventTypeEnumKey = (typeof responseOutputTextDoneStreamingEventTypeEnum)[keyof typeof responseOutputTextDoneStreamingEventTypeEnum];
2114
-
2115
- /**
2116
- * @description A streaming event that indicated output text was completed.
2117
- */
2118
- export type ResponseOutputTextDoneStreamingEvent = {
2119
- /**
2120
- * @description The type of the event, always `response.output_text.done`.
2121
- * @default "response.output_text.done"
2122
- * @type string
2123
- */
2124
- type: ResponseOutputTextDoneStreamingEventTypeEnumKey;
2125
- /**
2126
- * @description The sequence number of the event that was emitted.
2127
- * @type integer
2128
- */
2129
- sequence_number: number;
2130
- /**
2131
- * @description The ID of the item that was updated.
2132
- * @type string
2133
- */
2134
- item_id: string;
2135
- /**
2136
- * @description The index of the output item that was updated.
2137
- * @type integer
2138
- */
2139
- output_index: number;
2140
- /**
2141
- * @description The index of the content part that was completed.
2142
- * @type integer
2143
- */
2144
- content_index: number;
2145
- /**
2146
- * @description The final text that was emitted.
2147
- * @type string
2148
- */
2149
- text: string;
2150
- /**
2151
- * @description The token log probabilities that were emitted with the final text, if any.
2152
- * @type array
2153
- */
2154
- logprobs: LogProb[];
2155
- };
2156
-
2157
- export const responseRefusalDeltaStreamingEventTypeEnum = {
2158
- "response.refusal.delta": "response.refusal.delta"
2159
- } as const;
2160
-
2161
- export type ResponseRefusalDeltaStreamingEventTypeEnumKey = (typeof responseRefusalDeltaStreamingEventTypeEnum)[keyof typeof responseRefusalDeltaStreamingEventTypeEnum];
2162
-
2163
- /**
2164
- * @description A streaming event that indicated refusal text was incrementally added.
2165
- */
2166
- export type ResponseRefusalDeltaStreamingEvent = {
2167
- /**
2168
- * @description The type of the event, always `response.refusal.delta`.
2169
- * @default "response.refusal.delta"
2170
- * @type string
2171
- */
2172
- type: ResponseRefusalDeltaStreamingEventTypeEnumKey;
2173
- /**
2174
- * @description The sequence number of the event that was emitted.
2175
- * @type integer
2176
- */
2177
- sequence_number: number;
2178
- /**
2179
- * @description The ID of the item that was updated.
2180
- * @type string
2181
- */
2182
- item_id: string;
2183
- /**
2184
- * @description The index of the output item that was updated.
2185
- * @type integer
2186
- */
2187
- output_index: number;
2188
- /**
2189
- * @description The index of the refusal content that was updated.
2190
- * @type integer
2191
- */
2192
- content_index: number;
2193
- /**
2194
- * @description The refusal text delta that was appended.
2195
- * @type string
2196
- */
2197
- delta: string;
2198
- };
2199
-
2200
- export const responseRefusalDoneStreamingEventTypeEnum = {
2201
- "response.refusal.done": "response.refusal.done"
2202
- } as const;
2203
-
2204
- export type ResponseRefusalDoneStreamingEventTypeEnumKey = (typeof responseRefusalDoneStreamingEventTypeEnum)[keyof typeof responseRefusalDoneStreamingEventTypeEnum];
2205
-
2206
- /**
2207
- * @description A streaming event that indicated refusal text was completed.
2208
- */
2209
- export type ResponseRefusalDoneStreamingEvent = {
2210
- /**
2211
- * @description The type of the event, always `response.refusal.done`.
2212
- * @default "response.refusal.done"
2213
- * @type string
2214
- */
2215
- type: ResponseRefusalDoneStreamingEventTypeEnumKey;
2216
- /**
2217
- * @description The sequence number of the event that was emitted.
2218
- * @type integer
2219
- */
2220
- sequence_number: number;
2221
- /**
2222
- * @description The ID of the item that was updated.
2223
- * @type string
2224
- */
2225
- item_id: string;
2226
- /**
2227
- * @description The index of the output item that was updated.
2228
- * @type integer
2229
- */
2230
- output_index: number;
2231
- /**
2232
- * @description The index of the refusal content that was completed.
2233
- * @type integer
2234
- */
2235
- content_index: number;
2236
- /**
2237
- * @description The final refusal text that was emitted.
2238
- * @type string
2239
- */
2240
- refusal: string;
2241
- };
2242
-
2243
- export const responseReasoningDeltaStreamingEventTypeEnum = {
2244
- "response.reasoning.delta": "response.reasoning.delta"
2245
- } as const;
2246
-
2247
- export type ResponseReasoningDeltaStreamingEventTypeEnumKey = (typeof responseReasoningDeltaStreamingEventTypeEnum)[keyof typeof responseReasoningDeltaStreamingEventTypeEnum];
2248
-
2249
- /**
2250
- * @description A streaming event that indicated reasoning text was incrementally added.
2251
- */
2252
- export type ResponseReasoningDeltaStreamingEvent = {
2253
- /**
2254
- * @description The type of the event, always `response.reasoning.delta`.
2255
- * @default "response.reasoning.delta"
2256
- * @type string
2257
- */
2258
- type: ResponseReasoningDeltaStreamingEventTypeEnumKey;
2259
- /**
2260
- * @description The sequence number of the event that was emitted.
2261
- * @type integer
2262
- */
2263
- sequence_number: number;
2264
- /**
2265
- * @description The ID of the item that was updated.
2266
- * @type string
2267
- */
2268
- item_id: string;
2269
- /**
2270
- * @description The index of the output item that was updated.
2271
- * @type integer
2272
- */
2273
- output_index: number;
2274
- /**
2275
- * @description The index of the reasoning content that was updated.
2276
- * @type integer
2277
- */
2278
- content_index: number;
2279
- /**
2280
- * @description The reasoning text delta that was appended.
2281
- * @type string
2282
- */
2283
- delta: string;
2284
- /**
2285
- * @description An obfuscation string that was added to pad the event payload.
2286
- * @type string | undefined
2287
- */
2288
- obfuscation?: string;
2289
- };
2290
-
2291
- export const responseReasoningDoneStreamingEventTypeEnum = {
2292
- "response.reasoning.done": "response.reasoning.done"
2293
- } as const;
2294
-
2295
- export type ResponseReasoningDoneStreamingEventTypeEnumKey = (typeof responseReasoningDoneStreamingEventTypeEnum)[keyof typeof responseReasoningDoneStreamingEventTypeEnum];
2296
-
2297
- /**
2298
- * @description A streaming event that indicated reasoning text was completed.
2299
- */
2300
- export type ResponseReasoningDoneStreamingEvent = {
2301
- /**
2302
- * @description The type of the event, always `response.reasoning.done`.
2303
- * @default "response.reasoning.done"
2304
- * @type string
2305
- */
2306
- type: ResponseReasoningDoneStreamingEventTypeEnumKey;
2307
- /**
2308
- * @description The sequence number of the event that was emitted.
2309
- * @type integer
2310
- */
2311
- sequence_number: number;
2312
- /**
2313
- * @description The ID of the item that was updated.
2314
- * @type string
2315
- */
2316
- item_id: string;
2317
- /**
2318
- * @description The index of the output item that was updated.
2319
- * @type integer
2320
- */
2321
- output_index: number;
2322
- /**
2323
- * @description The index of the reasoning content that was completed.
2324
- * @type integer
2325
- */
2326
- content_index: number;
2327
- /**
2328
- * @description The final reasoning text that was emitted.
2329
- * @type string
2330
- */
2331
- text: string;
2332
- };
2333
-
2334
- export const responseReasoningSummaryDeltaStreamingEventTypeEnum = {
2335
- "response.reasoning_summary_text.delta": "response.reasoning_summary_text.delta"
2336
- } as const;
2337
-
2338
- export type ResponseReasoningSummaryDeltaStreamingEventTypeEnumKey = (typeof responseReasoningSummaryDeltaStreamingEventTypeEnum)[keyof typeof responseReasoningSummaryDeltaStreamingEventTypeEnum];
2339
-
2340
- /**
2341
- * @description A streaming event that indicated a reasoning summary was incrementally added.
2342
- */
2343
- export type ResponseReasoningSummaryDeltaStreamingEvent = {
2344
- /**
2345
- * @description The type of the event, always `response.reasoning_summary.delta`.
2346
- * @default "response.reasoning_summary_text.delta"
2347
- * @type string
2348
- */
2349
- type: ResponseReasoningSummaryDeltaStreamingEventTypeEnumKey;
2350
- /**
2351
- * @description The sequence number of the event that was emitted.
2352
- * @type integer
2353
- */
2354
- sequence_number: number;
2355
- /**
2356
- * @description The ID of the item that was updated.
2357
- * @type string
2358
- */
2359
- item_id: string;
2360
- /**
2361
- * @description The index of the output item that was updated.
2362
- * @type integer
2363
- */
2364
- output_index: number;
2365
- /**
2366
- * @description The index of the summary content that was updated.
2367
- * @type integer
2368
- */
2369
- summary_index: number;
2370
- /**
2371
- * @description The summary text delta that was appended.
2372
- * @type string
2373
- */
2374
- delta: string;
2375
- /**
2376
- * @description An obfuscation string that was added to pad the event payload.
2377
- * @type string | undefined
2378
- */
2379
- obfuscation?: string;
2380
- };
2381
-
2382
- export const responseReasoningSummaryDoneStreamingEventTypeEnum = {
2383
- "response.reasoning_summary_text.done": "response.reasoning_summary_text.done"
2384
- } as const;
2385
-
2386
- export type ResponseReasoningSummaryDoneStreamingEventTypeEnumKey = (typeof responseReasoningSummaryDoneStreamingEventTypeEnum)[keyof typeof responseReasoningSummaryDoneStreamingEventTypeEnum];
2387
-
2388
- /**
2389
- * @description A streaming event that indicated a reasoning summary was completed.
2390
- */
2391
- export type ResponseReasoningSummaryDoneStreamingEvent = {
2392
- /**
2393
- * @description The type of the event, always `response.reasoning_summary.done`.
2394
- * @default "response.reasoning_summary_text.done"
2395
- * @type string
2396
- */
2397
- type: ResponseReasoningSummaryDoneStreamingEventTypeEnumKey;
2398
- /**
2399
- * @description The sequence number of the event that was emitted.
2400
- * @type integer
2401
- */
2402
- sequence_number: number;
2403
- /**
2404
- * @description The ID of the item that was updated.
2405
- * @type string
2406
- */
2407
- item_id: string;
2408
- /**
2409
- * @description The index of the output item that was updated.
2410
- * @type integer
2411
- */
2412
- output_index: number;
2413
- /**
2414
- * @description The index of the summary content that was completed.
2415
- * @type integer
2416
- */
2417
- summary_index: number;
2418
- /**
2419
- * @description The final summary text that was emitted.
2420
- * @type string
2421
- */
2422
- text: string;
2423
- };
2424
-
2425
- export const responseOutputTextAnnotationAddedStreamingEventTypeEnum = {
2426
- "response.output_text.annotation.added": "response.output_text.annotation.added"
2427
- } as const;
2428
-
2429
- export type ResponseOutputTextAnnotationAddedStreamingEventTypeEnumKey = (typeof responseOutputTextAnnotationAddedStreamingEventTypeEnum)[keyof typeof responseOutputTextAnnotationAddedStreamingEventTypeEnum];
2430
-
2431
- /**
2432
- * @description A streaming event that indicated an output text annotation was added.
2433
- */
2434
- export type ResponseOutputTextAnnotationAddedStreamingEvent = {
2435
- /**
2436
- * @description The type of the event, always `response.output_text.annotation.added`.
2437
- * @default "response.output_text.annotation.added"
2438
- * @type string
2439
- */
2440
- type: ResponseOutputTextAnnotationAddedStreamingEventTypeEnumKey;
2441
- /**
2442
- * @description The sequence number of the event that was emitted.
2443
- * @type integer
2444
- */
2445
- sequence_number: number;
2446
- /**
2447
- * @description The ID of the item that was updated.
2448
- * @type string
2449
- */
2450
- item_id: string;
2451
- /**
2452
- * @description The index of the output item that was updated.
2453
- * @type integer
2454
- */
2455
- output_index: number;
2456
- /**
2457
- * @description The index of the output text content that was updated.
2458
- * @type integer
2459
- */
2460
- content_index: number;
2461
- /**
2462
- * @description The index of the annotation that was added.
2463
- * @type integer
2464
- */
2465
- annotation_index: number;
2466
- annotation: ((Annotation & any) | null);
2467
- };
2468
-
2469
- export const responseFunctionCallArgumentsDeltaStreamingEventTypeEnum = {
2470
- "response.function_call_arguments.delta": "response.function_call_arguments.delta"
2471
- } as const;
2472
-
2473
- export type ResponseFunctionCallArgumentsDeltaStreamingEventTypeEnumKey = (typeof responseFunctionCallArgumentsDeltaStreamingEventTypeEnum)[keyof typeof responseFunctionCallArgumentsDeltaStreamingEventTypeEnum];
2474
-
2475
- /**
2476
- * @description A streaming event that indicated function call arguments were incrementally added.
2477
- */
2478
- export type ResponseFunctionCallArgumentsDeltaStreamingEvent = {
2479
- /**
2480
- * @description The type of the event, always `response.function_call_arguments.delta`.
2481
- * @default "response.function_call_arguments.delta"
2482
- * @type string
2483
- */
2484
- type: ResponseFunctionCallArgumentsDeltaStreamingEventTypeEnumKey;
2485
- /**
2486
- * @description The sequence number of the event that was emitted.
2487
- * @type integer
2488
- */
2489
- sequence_number: number;
2490
- /**
2491
- * @description The ID of the tool call item that was updated.
2492
- * @type string
2493
- */
2494
- item_id: string;
2495
- /**
2496
- * @description The index of the output item that was updated.
2497
- * @type integer
2498
- */
2499
- output_index: number;
2500
- /**
2501
- * @description The arguments delta that was appended.
2502
- * @type string
2503
- */
2504
- delta: string;
2505
- /**
2506
- * @description An obfuscation string that was added to pad the event payload.
2507
- * @type string | undefined
2508
- */
2509
- obfuscation?: string;
2510
- };
2511
-
2512
- export const responseFunctionCallArgumentsDoneStreamingEventTypeEnum = {
2513
- "response.function_call_arguments.done": "response.function_call_arguments.done"
2514
- } as const;
2515
-
2516
- export type ResponseFunctionCallArgumentsDoneStreamingEventTypeEnumKey = (typeof responseFunctionCallArgumentsDoneStreamingEventTypeEnum)[keyof typeof responseFunctionCallArgumentsDoneStreamingEventTypeEnum];
2517
-
2518
- /**
2519
- * @description A streaming event that indicated function call arguments were completed.
2520
- */
2521
- export type ResponseFunctionCallArgumentsDoneStreamingEvent = {
2522
- /**
2523
- * @description The type of the event, always `response.function_call_arguments.done`.
2524
- * @default "response.function_call_arguments.done"
2525
- * @type string
2526
- */
2527
- type: ResponseFunctionCallArgumentsDoneStreamingEventTypeEnumKey;
2528
- /**
2529
- * @description The sequence number of the event that was emitted.
2530
- * @type integer
2531
- */
2532
- sequence_number: number;
2533
- /**
2534
- * @description The ID of the tool call item that was updated.
2535
- * @type string
2536
- */
2537
- item_id: string;
2538
- /**
2539
- * @description The index of the output item that was updated.
2540
- * @type integer
2541
- */
2542
- output_index: number;
2543
- /**
2544
- * @description The final arguments string that was emitted.
2545
- * @type string
2546
- */
2547
- arguments: string;
2548
- };
2549
-
2550
- /**
2551
- * @description An error payload that was emitted for a streaming error event.
2552
- */
2553
- export type ErrorPayload = {
2554
- /**
2555
- * @description The error type that was emitted.
2556
- * @type string
2557
- */
2558
- type: string;
2559
- code: (string | null);
2560
- /**
2561
- * @description The human-readable error message that was emitted.
2562
- * @type string
2563
- */
2564
- message: string;
2565
- param: (string | null);
2566
- /**
2567
- * @description The response headers that were emitted with the error, if any.
2568
- * @type object | undefined
2569
- */
2570
- headers?: {
2571
- [key: string]: string;
2572
- };
2573
- };
2574
-
2575
- export const errorStreamingEventTypeEnum = {
2576
- error: "error"
2577
- } as const;
2578
-
2579
- export type ErrorStreamingEventTypeEnumKey = (typeof errorStreamingEventTypeEnum)[keyof typeof errorStreamingEventTypeEnum];
2580
-
2581
- /**
2582
- * @description A streaming event that indicated an error was emitted.
2583
- */
2584
- export type ErrorStreamingEvent = {
2585
- /**
2586
- * @description The type of the event, always `error`.
2587
- * @default "error"
2588
- * @type string
2589
- */
2590
- type: ErrorStreamingEventTypeEnumKey;
2591
- /**
2592
- * @description The sequence number of the event that was emitted.
2593
- * @type integer
2594
- */
2595
- sequence_number: number;
2596
- error: (ErrorPayload & any);
2597
- };
2598
-
2599
- /**
2600
- * @description Success
2601
- * @example [object Object]
2602
- */
2603
- export type Createresponse200 = ResponseResource;
2604
-
2605
- export type CreateresponseMutationRequest = CreateResponseBody;
2606
-
2607
- export type CreateresponseMutationResponse = Createresponse200;
2608
-
2609
- export type CreateresponseMutation = {
2610
- Response: Createresponse200;
2611
- Request: CreateresponseMutationRequest;
2612
- Errors: any;
2613
- };