@orq-ai/node 4.3.3 → 4.4.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (482) hide show
  1. package/examples/package-lock.json +4 -7
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +2 -2
  4. package/lib/config.js +2 -2
  5. package/lib/config.js.map +1 -1
  6. package/models/components/conversationresponse.js +1 -1
  7. package/models/components/conversationwithmessagesresponse.js +1 -1
  8. package/models/components/partdoneevent.js +1 -1
  9. package/models/components/reasoningpart.js +1 -1
  10. package/models/operations/createcontact.js +1 -1
  11. package/models/operations/createconversation.js +1 -1
  12. package/models/operations/createconversationresponse.js +2 -2
  13. package/models/operations/createdataset.js +1 -1
  14. package/models/operations/createdatasetitem.js +4 -4
  15. package/models/operations/createdatasource.js +1 -1
  16. package/models/operations/createeval.js +14 -14
  17. package/models/operations/createidentity.js +1 -1
  18. package/models/operations/createtool.js +6 -6
  19. package/models/operations/fileget.js +1 -1
  20. package/models/operations/filelist.js +1 -1
  21. package/models/operations/fileupload.js +1 -1
  22. package/models/operations/generateconversationname.js +1 -1
  23. package/models/operations/getalltools.js +6 -6
  24. package/models/operations/getevals.js +14 -14
  25. package/models/operations/listdatasetdatapoints.js +4 -4
  26. package/models/operations/listdatasets.js +1 -1
  27. package/models/operations/listdatasources.js +1 -1
  28. package/models/operations/listidentities.js +1 -1
  29. package/models/operations/retrievedatapoint.js +4 -4
  30. package/models/operations/retrievedataset.js +1 -1
  31. package/models/operations/retrievedatasource.js +1 -1
  32. package/models/operations/retrieveidentity.js +1 -1
  33. package/models/operations/retrievetool.js +6 -6
  34. package/models/operations/runagent.js +1 -1
  35. package/models/operations/streamrunagent.js +1 -1
  36. package/models/operations/updateconversation.js +1 -1
  37. package/models/operations/updatedatapoint.js +4 -4
  38. package/models/operations/updatedataset.js +1 -1
  39. package/models/operations/updatedatasource.js +1 -1
  40. package/models/operations/updateeval.js +14 -14
  41. package/models/operations/updateidentity.js +1 -1
  42. package/models/operations/updatetool.js +7 -7
  43. package/package.json +4 -3
  44. package/src/lib/config.ts +2 -2
  45. package/src/models/components/conversationresponse.ts +1 -1
  46. package/src/models/components/conversationwithmessagesresponse.ts +1 -1
  47. package/src/models/components/partdoneevent.ts +1 -1
  48. package/src/models/components/reasoningpart.ts +1 -1
  49. package/src/models/operations/createcontact.ts +1 -1
  50. package/src/models/operations/createconversation.ts +1 -1
  51. package/src/models/operations/createconversationresponse.ts +2 -2
  52. package/src/models/operations/createdataset.ts +1 -1
  53. package/src/models/operations/createdatasetitem.ts +4 -4
  54. package/src/models/operations/createdatasource.ts +1 -1
  55. package/src/models/operations/createeval.ts +14 -14
  56. package/src/models/operations/createidentity.ts +1 -1
  57. package/src/models/operations/createtool.ts +6 -6
  58. package/src/models/operations/fileget.ts +1 -1
  59. package/src/models/operations/filelist.ts +1 -1
  60. package/src/models/operations/fileupload.ts +1 -1
  61. package/src/models/operations/generateconversationname.ts +1 -1
  62. package/src/models/operations/getalltools.ts +6 -6
  63. package/src/models/operations/getevals.ts +14 -14
  64. package/src/models/operations/listdatasetdatapoints.ts +4 -4
  65. package/src/models/operations/listdatasets.ts +1 -1
  66. package/src/models/operations/listdatasources.ts +1 -1
  67. package/src/models/operations/listidentities.ts +1 -1
  68. package/src/models/operations/retrievedatapoint.ts +4 -4
  69. package/src/models/operations/retrievedataset.ts +1 -1
  70. package/src/models/operations/retrievedatasource.ts +1 -1
  71. package/src/models/operations/retrieveidentity.ts +1 -1
  72. package/src/models/operations/retrievetool.ts +6 -6
  73. package/src/models/operations/runagent.ts +1 -1
  74. package/src/models/operations/streamrunagent.ts +1 -1
  75. package/src/models/operations/updateconversation.ts +1 -1
  76. package/src/models/operations/updatedatapoint.ts +4 -4
  77. package/src/models/operations/updatedataset.ts +1 -1
  78. package/src/models/operations/updatedatasource.ts +1 -1
  79. package/src/models/operations/updateeval.ts +14 -14
  80. package/src/models/operations/updateidentity.ts +1 -1
  81. package/src/models/operations/updatetool.ts +7 -7
  82. package/_speakeasy/.github/action-inputs-config.json +0 -53
  83. package/_speakeasy/.github/action-security-config.json +0 -88
  84. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
  85. package/packages/orq-rc/examples/package-lock.json +0 -610
  86. package/packages/orq-rc/examples/package.json +0 -18
  87. package/packages/orq-rc/jsr.json +0 -28
  88. package/packages/orq-rc/package-lock.json +0 -1740
  89. package/packages/orq-rc/package.json +0 -30
  90. package/packages/orq-rc/src/core.ts +0 -13
  91. package/packages/orq-rc/src/funcs/agentsCreate.ts +0 -161
  92. package/packages/orq-rc/src/funcs/agentsDelete.ts +0 -180
  93. package/packages/orq-rc/src/funcs/agentsInvoke.ts +0 -177
  94. package/packages/orq-rc/src/funcs/agentsList.ts +0 -179
  95. package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts +0 -183
  96. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +0 -180
  97. package/packages/orq-rc/src/funcs/agentsRun.ts +0 -162
  98. package/packages/orq-rc/src/funcs/agentsStream.ts +0 -201
  99. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +0 -186
  100. package/packages/orq-rc/src/funcs/agentsUpdate.ts +0 -184
  101. package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
  102. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -160
  103. package/packages/orq-rc/src/funcs/conversationsCreate.ts +0 -161
  104. package/packages/orq-rc/src/funcs/conversationsCreateConversationResponse.ts +0 -186
  105. package/packages/orq-rc/src/funcs/conversationsDelete.ts +0 -180
  106. package/packages/orq-rc/src/funcs/conversationsGenerateName.ts +0 -194
  107. package/packages/orq-rc/src/funcs/conversationsList.ts +0 -186
  108. package/packages/orq-rc/src/funcs/conversationsRetrieve.ts +0 -181
  109. package/packages/orq-rc/src/funcs/conversationsUpdate.ts +0 -184
  110. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
  111. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  112. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -171
  113. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
  114. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
  115. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  116. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
  117. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
  118. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
  119. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
  120. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
  121. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  122. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  123. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  124. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
  125. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -183
  126. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  127. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  128. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
  129. package/packages/orq-rc/src/funcs/evalsInvoke.ts +0 -181
  130. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
  131. package/packages/orq-rc/src/funcs/evaluatorsGetV2EvaluatorsIdVersions.ts +0 -183
  132. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -160
  133. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
  134. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
  135. package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
  136. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  137. package/packages/orq-rc/src/funcs/identitiesCreate.ts +0 -165
  138. package/packages/orq-rc/src/funcs/identitiesDelete.ts +0 -176
  139. package/packages/orq-rc/src/funcs/identitiesList.ts +0 -170
  140. package/packages/orq-rc/src/funcs/identitiesRetrieve.ts +0 -175
  141. package/packages/orq-rc/src/funcs/identitiesUpdate.ts +0 -176
  142. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
  143. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
  144. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
  145. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
  146. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
  147. package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +0 -170
  148. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
  149. package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +0 -170
  150. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  151. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
  152. package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +0 -171
  153. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
  154. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
  155. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
  156. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
  157. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
  158. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -164
  159. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
  160. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
  161. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +0 -162
  162. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +0 -176
  163. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +0 -170
  164. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +0 -168
  165. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +0 -185
  166. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +0 -180
  167. package/packages/orq-rc/src/funcs/memoryStoresList.ts +0 -178
  168. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +0 -184
  169. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +0 -177
  170. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +0 -177
  171. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +0 -179
  172. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +0 -174
  173. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +0 -168
  174. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +0 -180
  175. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +0 -175
  176. package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
  177. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  178. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -173
  179. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
  180. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  181. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
  182. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -166
  183. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
  184. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  185. package/packages/orq-rc/src/funcs/routerAudioSpeechCreate.ts +0 -161
  186. package/packages/orq-rc/src/funcs/routerAudioTranscriptionsCreate.ts +0 -262
  187. package/packages/orq-rc/src/funcs/routerAudioTranslationsCreate.ts +0 -252
  188. package/packages/orq-rc/src/funcs/routerChatCompletionsCreate.ts +0 -168
  189. package/packages/orq-rc/src/funcs/routerCompletionsCreate.ts +0 -168
  190. package/packages/orq-rc/src/funcs/routerEmbeddingsCreate.ts +0 -161
  191. package/packages/orq-rc/src/funcs/routerImagesEditsCreate.ts +0 -222
  192. package/packages/orq-rc/src/funcs/routerImagesGenerationsCreate.ts +0 -160
  193. package/packages/orq-rc/src/funcs/routerImagesVariationsCreate.ts +0 -218
  194. package/packages/orq-rc/src/funcs/routerModerationsCreate.ts +0 -167
  195. package/packages/orq-rc/src/funcs/routerOcr.ts +0 -158
  196. package/packages/orq-rc/src/funcs/routerRerankCreate.ts +0 -160
  197. package/packages/orq-rc/src/funcs/routerResponsesCreate.ts +0 -167
  198. package/packages/orq-rc/src/funcs/toolsCreate.ts +0 -163
  199. package/packages/orq-rc/src/funcs/toolsDelete.ts +0 -167
  200. package/packages/orq-rc/src/funcs/toolsGetV2ToolsToolIdVersions.ts +0 -183
  201. package/packages/orq-rc/src/funcs/toolsGetV2ToolsToolIdVersionsVersionId.ts +0 -190
  202. package/packages/orq-rc/src/funcs/toolsList.ts +0 -176
  203. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +0 -166
  204. package/packages/orq-rc/src/funcs/toolsUpdate.ts +0 -176
  205. package/packages/orq-rc/src/hooks/global.ts +0 -44
  206. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  207. package/packages/orq-rc/src/hooks/index.ts +0 -6
  208. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  209. package/packages/orq-rc/src/hooks/types.ts +0 -112
  210. package/packages/orq-rc/src/index.ts +0 -9
  211. package/packages/orq-rc/src/lib/base64.ts +0 -37
  212. package/packages/orq-rc/src/lib/config.ts +0 -74
  213. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  214. package/packages/orq-rc/src/lib/encodings.ts +0 -497
  215. package/packages/orq-rc/src/lib/env.ts +0 -89
  216. package/packages/orq-rc/src/lib/event-streams.ts +0 -152
  217. package/packages/orq-rc/src/lib/files.ts +0 -82
  218. package/packages/orq-rc/src/lib/http.ts +0 -323
  219. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  220. package/packages/orq-rc/src/lib/logger.ts +0 -9
  221. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  222. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  223. package/packages/orq-rc/src/lib/retries.ts +0 -218
  224. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  225. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  226. package/packages/orq-rc/src/lib/security.ts +0 -264
  227. package/packages/orq-rc/src/lib/url.ts +0 -33
  228. package/packages/orq-rc/src/models/components/actionreviewedstreamingevent.ts +0 -99
  229. package/packages/orq-rc/src/models/components/actionreviewrequestedstreamingevent.ts +0 -185
  230. package/packages/orq-rc/src/models/components/agenterroredstreamingevent.ts +0 -73
  231. package/packages/orq-rc/src/models/components/agentexecutionstartedstreamingevent.ts +0 -91
  232. package/packages/orq-rc/src/models/components/agenthandedoffstreamingevent.ts +0 -71
  233. package/packages/orq-rc/src/models/components/agentinactivestreamingevent.ts +0 -507
  234. package/packages/orq-rc/src/models/components/agentmessagecreatedstreamingevent.ts +0 -165
  235. package/packages/orq-rc/src/models/components/agentresponsemessage.ts +0 -103
  236. package/packages/orq-rc/src/models/components/agentstartedstreamingevent.ts +0 -503
  237. package/packages/orq-rc/src/models/components/agentthoughtstreamingevent.ts +0 -807
  238. package/packages/orq-rc/src/models/components/audiocontentpartschema.ts +0 -136
  239. package/packages/orq-rc/src/models/components/conversationresponse.ts +0 -132
  240. package/packages/orq-rc/src/models/components/conversationwithmessagesresponse.ts +0 -149
  241. package/packages/orq-rc/src/models/components/createagentresponse.ts +0 -299
  242. package/packages/orq-rc/src/models/components/datapart.ts +0 -38
  243. package/packages/orq-rc/src/models/components/errorpart.ts +0 -58
  244. package/packages/orq-rc/src/models/components/errorstreamingevent.ts +0 -66
  245. package/packages/orq-rc/src/models/components/executionnamedstreamingevent.ts +0 -71
  246. package/packages/orq-rc/src/models/components/executionreviewedstreamingevent.ts +0 -61
  247. package/packages/orq-rc/src/models/components/executionreviewrequiredstreamingevent.ts +0 -67
  248. package/packages/orq-rc/src/models/components/filecontentpartschema.ts +0 -87
  249. package/packages/orq-rc/src/models/components/filepart.ts +0 -218
  250. package/packages/orq-rc/src/models/components/imagecontentpartschema.ts +0 -268
  251. package/packages/orq-rc/src/models/components/index.ts +0 -60
  252. package/packages/orq-rc/src/models/components/invokedeploymentrequest.ts +0 -3457
  253. package/packages/orq-rc/src/models/components/messageresponse.ts +0 -127
  254. package/packages/orq-rc/src/models/components/partdelta.ts +0 -39
  255. package/packages/orq-rc/src/models/components/partdeltaevent.ts +0 -73
  256. package/packages/orq-rc/src/models/components/partdoneevent.ts +0 -139
  257. package/packages/orq-rc/src/models/components/publiccontact.ts +0 -71
  258. package/packages/orq-rc/src/models/components/publicidentity.ts +0 -69
  259. package/packages/orq-rc/src/models/components/reasoningpart.ts +0 -62
  260. package/packages/orq-rc/src/models/components/reasoningpartschema.ts +0 -71
  261. package/packages/orq-rc/src/models/components/redactedreasoningpartschema.ts +0 -66
  262. package/packages/orq-rc/src/models/components/refusalpartschema.ts +0 -64
  263. package/packages/orq-rc/src/models/components/responsedoneevent.ts +0 -318
  264. package/packages/orq-rc/src/models/components/responsefailedevent.ts +0 -72
  265. package/packages/orq-rc/src/models/components/responsestartedevent.ts +0 -91
  266. package/packages/orq-rc/src/models/components/responsestreamingevent.ts +0 -85
  267. package/packages/orq-rc/src/models/components/reviewoutcome.ts +0 -23
  268. package/packages/orq-rc/src/models/components/security.ts +0 -32
  269. package/packages/orq-rc/src/models/components/textcontentpartschema.ts +0 -207
  270. package/packages/orq-rc/src/models/components/textpart.ts +0 -54
  271. package/packages/orq-rc/src/models/components/thinkingconfigdisabledschema.ts +0 -59
  272. package/packages/orq-rc/src/models/components/thinkingconfigenabledschema.ts +0 -106
  273. package/packages/orq-rc/src/models/components/timeoutstreamingevent.ts +0 -64
  274. package/packages/orq-rc/src/models/components/toolcallpart.ts +0 -51
  275. package/packages/orq-rc/src/models/components/tooldoneevent.ts +0 -77
  276. package/packages/orq-rc/src/models/components/toolexecutionfailedstreamingevent.ts +0 -230
  277. package/packages/orq-rc/src/models/components/toolexecutionfinishedstreamingevent.ts +0 -214
  278. package/packages/orq-rc/src/models/components/toolexecutionstartedstreamingevent.ts +0 -200
  279. package/packages/orq-rc/src/models/components/toolfailedevent.ts +0 -77
  280. package/packages/orq-rc/src/models/components/toolresultpart.ts +0 -71
  281. package/packages/orq-rc/src/models/components/toolreviewdoneevent.ts +0 -78
  282. package/packages/orq-rc/src/models/components/toolreviewrequestedevent.ts +0 -87
  283. package/packages/orq-rc/src/models/components/toolstartedevent.ts +0 -82
  284. package/packages/orq-rc/src/models/components/usermessagerequest.ts +0 -136
  285. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  286. package/packages/orq-rc/src/models/errors/createeval.ts +0 -51
  287. package/packages/orq-rc/src/models/errors/createmoderation.ts +0 -84
  288. package/packages/orq-rc/src/models/errors/createtranscription.ts +0 -87
  289. package/packages/orq-rc/src/models/errors/createtranslation.ts +0 -87
  290. package/packages/orq-rc/src/models/errors/deleteagent.ts +0 -51
  291. package/packages/orq-rc/src/models/errors/deleteconversation.ts +0 -51
  292. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -51
  293. package/packages/orq-rc/src/models/errors/deleteidentity.ts +0 -62
  294. package/packages/orq-rc/src/models/errors/deleteprompt.ts +0 -51
  295. package/packages/orq-rc/src/models/errors/generateconversationname.ts +0 -99
  296. package/packages/orq-rc/src/models/errors/getevals.ts +0 -51
  297. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -51
  298. package/packages/orq-rc/src/models/errors/getv2evaluatorsidversions.ts +0 -51
  299. package/packages/orq-rc/src/models/errors/getv2toolstoolidversions.ts +0 -51
  300. package/packages/orq-rc/src/models/errors/getv2toolstoolidversionsversionid.ts +0 -52
  301. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -59
  302. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  303. package/packages/orq-rc/src/models/errors/index.ts +0 -37
  304. package/packages/orq-rc/src/models/errors/invokeeval.ts +0 -141
  305. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  306. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  307. package/packages/orq-rc/src/models/errors/retrieveagentrequest.ts +0 -51
  308. package/packages/orq-rc/src/models/errors/retrieveconversation.ts +0 -51
  309. package/packages/orq-rc/src/models/errors/retrieveidentity.ts +0 -62
  310. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  311. package/packages/orq-rc/src/models/errors/streamagent.ts +0 -51
  312. package/packages/orq-rc/src/models/errors/streamrunagent.ts +0 -51
  313. package/packages/orq-rc/src/models/errors/updateagent.ts +0 -51
  314. package/packages/orq-rc/src/models/errors/updateconversation.ts +0 -51
  315. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -51
  316. package/packages/orq-rc/src/models/errors/updateidentity.ts +0 -54
  317. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -51
  318. package/packages/orq-rc/src/models/errors/updatetool.ts +0 -62
  319. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -39
  320. package/packages/orq-rc/src/models/operations/createagentrequest.ts +0 -7093
  321. package/packages/orq-rc/src/models/operations/createagentresponserequest.ts +0 -609
  322. package/packages/orq-rc/src/models/operations/createchatcompletion.ts +0 -6381
  323. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -222
  324. package/packages/orq-rc/src/models/operations/createcompletion.ts +0 -3413
  325. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -156
  326. package/packages/orq-rc/src/models/operations/createconversation.ts +0 -227
  327. package/packages/orq-rc/src/models/operations/createconversationresponse.ts +0 -498
  328. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -162
  329. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -2551
  330. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -437
  331. package/packages/orq-rc/src/models/operations/createembedding.ts +0 -947
  332. package/packages/orq-rc/src/models/operations/createeval.ts +0 -3128
  333. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -144
  334. package/packages/orq-rc/src/models/operations/createidentity.ts +0 -162
  335. package/packages/orq-rc/src/models/operations/createimage.ts +0 -1028
  336. package/packages/orq-rc/src/models/operations/createimageedit.ts +0 -1045
  337. package/packages/orq-rc/src/models/operations/createimagevariation.ts +0 -1067
  338. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -944
  339. package/packages/orq-rc/src/models/operations/creatememory.ts +0 -142
  340. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +0 -152
  341. package/packages/orq-rc/src/models/operations/creatememorystore.ts +0 -199
  342. package/packages/orq-rc/src/models/operations/createmoderation.ts +0 -664
  343. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -5400
  344. package/packages/orq-rc/src/models/operations/creatererank.ts +0 -890
  345. package/packages/orq-rc/src/models/operations/createresponse.ts +0 -3294
  346. package/packages/orq-rc/src/models/operations/createspeech.ts +0 -700
  347. package/packages/orq-rc/src/models/operations/createtool.ts +0 -2499
  348. package/packages/orq-rc/src/models/operations/createtranscription.ts +0 -955
  349. package/packages/orq-rc/src/models/operations/createtranslation.ts +0 -930
  350. package/packages/orq-rc/src/models/operations/deleteagent.ts +0 -39
  351. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -53
  352. package/packages/orq-rc/src/models/operations/deletechunks.ts +0 -125
  353. package/packages/orq-rc/src/models/operations/deleteconversation.ts +0 -39
  354. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -46
  355. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -39
  356. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -46
  357. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -31
  358. package/packages/orq-rc/src/models/operations/deleteidentity.ts +0 -34
  359. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -39
  360. package/packages/orq-rc/src/models/operations/deletememory.ts +0 -46
  361. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +0 -55
  362. package/packages/orq-rc/src/models/operations/deletememorystore.ts +0 -39
  363. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -34
  364. package/packages/orq-rc/src/models/operations/deletetool.ts +0 -36
  365. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -2370
  366. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -4525
  367. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -689
  368. package/packages/orq-rc/src/models/operations/deployments.ts +0 -1267
  369. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -4613
  370. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -39
  371. package/packages/orq-rc/src/models/operations/fileget.ts +0 -116
  372. package/packages/orq-rc/src/models/operations/filelist.ts +0 -172
  373. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -170
  374. package/packages/orq-rc/src/models/operations/generateconversationname.ts +0 -207
  375. package/packages/orq-rc/src/models/operations/getallmemories.ts +0 -173
  376. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +0 -188
  377. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +0 -200
  378. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -3163
  379. package/packages/orq-rc/src/models/operations/getalltools.ts +0 -1398
  380. package/packages/orq-rc/src/models/operations/getchunkscount.ts +0 -121
  381. package/packages/orq-rc/src/models/operations/getevals.ts +0 -2330
  382. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -171
  383. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -652
  384. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -3088
  385. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -3133
  386. package/packages/orq-rc/src/models/operations/getv2evaluatorsidversions.ts +0 -162
  387. package/packages/orq-rc/src/models/operations/getv2toolstoolidversions.ts +0 -163
  388. package/packages/orq-rc/src/models/operations/getv2toolstoolidversionsversionid.ts +0 -110
  389. package/packages/orq-rc/src/models/operations/index.ts +0 -118
  390. package/packages/orq-rc/src/models/operations/invokeagent.ts +0 -733
  391. package/packages/orq-rc/src/models/operations/invokeeval.ts +0 -1129
  392. package/packages/orq-rc/src/models/operations/listagents.ts +0 -3018
  393. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -260
  394. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +0 -263
  395. package/packages/orq-rc/src/models/operations/listconversations.ts +0 -104
  396. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1498
  397. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -205
  398. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -235
  399. package/packages/orq-rc/src/models/operations/listidentities.ts +0 -275
  400. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -642
  401. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -143
  402. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -3208
  403. package/packages/orq-rc/src/models/operations/parse.ts +0 -777
  404. package/packages/orq-rc/src/models/operations/postv2routerocr.ts +0 -478
  405. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -108
  406. package/packages/orq-rc/src/models/operations/retrieveagentrequest.ts +0 -3104
  407. package/packages/orq-rc/src/models/operations/retrieveconversation.ts +0 -41
  408. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -1402
  409. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -150
  410. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -152
  411. package/packages/orq-rc/src/models/operations/retrieveidentity.ts +0 -117
  412. package/packages/orq-rc/src/models/operations/retrievememory.ts +0 -112
  413. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +0 -118
  414. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +0 -144
  415. package/packages/orq-rc/src/models/operations/retrievetool.ts +0 -1379
  416. package/packages/orq-rc/src/models/operations/runagent.ts +0 -5351
  417. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -1762
  418. package/packages/orq-rc/src/models/operations/streamagent.ts +0 -629
  419. package/packages/orq-rc/src/models/operations/streamrunagent.ts +0 -5546
  420. package/packages/orq-rc/src/models/operations/updateagent.ts +0 -7447
  421. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -236
  422. package/packages/orq-rc/src/models/operations/updateconversation.ts +0 -252
  423. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -2555
  424. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -206
  425. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -186
  426. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -3303
  427. package/packages/orq-rc/src/models/operations/updateidentity.ts +0 -189
  428. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -1231
  429. package/packages/orq-rc/src/models/operations/updatememory.ts +0 -142
  430. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +0 -159
  431. package/packages/orq-rc/src/models/operations/updatememorystore.ts +0 -245
  432. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -5471
  433. package/packages/orq-rc/src/models/operations/updatetool.ts +0 -2696
  434. package/packages/orq-rc/src/sdk/agents.ts +0 -196
  435. package/packages/orq-rc/src/sdk/audio.ts +0 -25
  436. package/packages/orq-rc/src/sdk/chat.ts +0 -13
  437. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  438. package/packages/orq-rc/src/sdk/completions.ts +0 -32
  439. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  440. package/packages/orq-rc/src/sdk/conversations.ts +0 -147
  441. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  442. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  443. package/packages/orq-rc/src/sdk/edits.ts +0 -27
  444. package/packages/orq-rc/src/sdk/embeddings.ts +0 -27
  445. package/packages/orq-rc/src/sdk/evals.ts +0 -84
  446. package/packages/orq-rc/src/sdk/evaluators.ts +0 -27
  447. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  448. package/packages/orq-rc/src/sdk/files.ts +0 -78
  449. package/packages/orq-rc/src/sdk/generations.ts +0 -27
  450. package/packages/orq-rc/src/sdk/identities.ts +0 -99
  451. package/packages/orq-rc/src/sdk/images.ts +0 -25
  452. package/packages/orq-rc/src/sdk/index.ts +0 -5
  453. package/packages/orq-rc/src/sdk/internal.ts +0 -28
  454. package/packages/orq-rc/src/sdk/knowledge.ts +0 -309
  455. package/packages/orq-rc/src/sdk/memorystores.ts +0 -286
  456. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  457. package/packages/orq-rc/src/sdk/models.ts +0 -25
  458. package/packages/orq-rc/src/sdk/moderations.ts +0 -24
  459. package/packages/orq-rc/src/sdk/orqcompletions.ts +0 -32
  460. package/packages/orq-rc/src/sdk/orqresponses.ts +0 -32
  461. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  462. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  463. package/packages/orq-rc/src/sdk/rerank.ts +0 -27
  464. package/packages/orq-rc/src/sdk/responses.ts +0 -34
  465. package/packages/orq-rc/src/sdk/router.ts +0 -72
  466. package/packages/orq-rc/src/sdk/sdk.ts +0 -121
  467. package/packages/orq-rc/src/sdk/speech.ts +0 -27
  468. package/packages/orq-rc/src/sdk/tools.ts +0 -135
  469. package/packages/orq-rc/src/sdk/transcriptions.ts +0 -24
  470. package/packages/orq-rc/src/sdk/translations.ts +0 -24
  471. package/packages/orq-rc/src/sdk/variations.ts +0 -27
  472. package/packages/orq-rc/src/types/async.ts +0 -68
  473. package/packages/orq-rc/src/types/blobs.ts +0 -32
  474. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  475. package/packages/orq-rc/src/types/enums.ts +0 -45
  476. package/packages/orq-rc/src/types/fp.ts +0 -50
  477. package/packages/orq-rc/src/types/index.ts +0 -11
  478. package/packages/orq-rc/src/types/operations.ts +0 -105
  479. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  480. package/packages/orq-rc/src/types/streams.ts +0 -21
  481. package/packages/orq-rc/src/types/unrecognized.ts +0 -35
  482. package/packages/orq-rc/tsconfig.json +0 -40
@@ -1,944 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod/v3";
6
- import { remap as remap$ } from "../../lib/primitives.js";
7
- import { safeParse } from "../../lib/schemas.js";
8
- import { ClosedEnum } from "../../types/enums.js";
9
- import { Result as SafeParseResult } from "../../types/fp.js";
10
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
-
12
- export const CreateKnowledgeRequestBodyKnowledgeType = {
13
- External: "external",
14
- } as const;
15
- export type CreateKnowledgeRequestBodyKnowledgeType = ClosedEnum<
16
- typeof CreateKnowledgeRequestBodyKnowledgeType
17
- >;
18
-
19
- export type ExternalConfig = {
20
- /**
21
- * The name of the external knowledge base.
22
- */
23
- name: string;
24
- /**
25
- * The API URL of the external knowledge base.
26
- */
27
- apiUrl: string;
28
- /**
29
- * The API key to access the external knowledge base.
30
- */
31
- apiKey: string;
32
- };
33
-
34
- export type RequestBody2 = {
35
- type?: CreateKnowledgeRequestBodyKnowledgeType | undefined;
36
- key: string;
37
- description?: string | undefined;
38
- externalConfig: ExternalConfig;
39
- };
40
-
41
- export const CreateKnowledgeRequestBodyType = {
42
- Internal: "internal",
43
- } as const;
44
- export type CreateKnowledgeRequestBodyType = ClosedEnum<
45
- typeof CreateKnowledgeRequestBodyType
46
- >;
47
-
48
- /**
49
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
50
- */
51
- export const RetrievalType = {
52
- VectorSearch: "vector_search",
53
- KeywordSearch: "keyword_search",
54
- HybridSearch: "hybrid_search",
55
- } as const;
56
- /**
57
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
58
- */
59
- export type RetrievalType = ClosedEnum<typeof RetrievalType>;
60
-
61
- /**
62
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
63
- */
64
- export type CreateKnowledgeRequestBodyRerankConfig = {
65
- /**
66
- * The number of results to return by the reranking model
67
- */
68
- topK?: number | undefined;
69
- /**
70
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
71
- */
72
- rerankThreshold?: number | undefined;
73
- /**
74
- * The rerank model to use for the knowledge base.
75
- */
76
- rerankModel: string;
77
- };
78
-
79
- /**
80
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
81
- */
82
- export type CreateKnowledgeRequestBodyAgenticRagConfig = {
83
- /**
84
- * The model to use for the Agentic RAG
85
- */
86
- model: string;
87
- };
88
-
89
- /**
90
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
91
- */
92
- export type RetrievalSettings = {
93
- /**
94
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
95
- */
96
- retrievalType?: RetrievalType | undefined;
97
- /**
98
- * The number of results to return from the search.
99
- */
100
- topK?: number | undefined;
101
- /**
102
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
103
- */
104
- threshold?: number | undefined;
105
- /**
106
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
107
- */
108
- rerankConfig?: CreateKnowledgeRequestBodyRerankConfig | null | undefined;
109
- /**
110
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
111
- */
112
- agenticRagConfig?:
113
- | CreateKnowledgeRequestBodyAgenticRagConfig
114
- | null
115
- | undefined;
116
- };
117
-
118
- export type RequestBody1 = {
119
- type?: CreateKnowledgeRequestBodyType | undefined;
120
- key: string;
121
- description?: string | undefined;
122
- /**
123
- * The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base.
124
- */
125
- embeddingModel: string;
126
- /**
127
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
128
- */
129
- retrievalSettings?: RetrievalSettings | undefined;
130
- /**
131
- * Entity storage path in the format: `project/folder/subfolder/...`
132
- *
133
- * @remarks
134
- *
135
- * The first element identifies the project, followed by nested folders (auto-created as needed).
136
- *
137
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
138
- */
139
- path: string;
140
- };
141
-
142
- export type CreateKnowledgeRequestBody = RequestBody1 | RequestBody2;
143
-
144
- export const CreateKnowledgeResponseBodyKnowledgeType = {
145
- External: "external",
146
- } as const;
147
- export type CreateKnowledgeResponseBodyKnowledgeType = ClosedEnum<
148
- typeof CreateKnowledgeResponseBodyKnowledgeType
149
- >;
150
-
151
- /**
152
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
153
- */
154
- export type CreateKnowledgeResponseBodyRerankConfig = {
155
- /**
156
- * The number of results to return by the reranking model
157
- */
158
- topK: number;
159
- /**
160
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
161
- */
162
- rerankThreshold: number;
163
- /**
164
- * The rerank model to use for the knowledge base.
165
- */
166
- rerankModel: string;
167
- };
168
-
169
- /**
170
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
171
- */
172
- export type CreateKnowledgeResponseBodyAgenticRagConfig = {
173
- /**
174
- * The model to use for the Agentic RAG
175
- */
176
- model: string;
177
- };
178
-
179
- /**
180
- * The retrieval settings for the knowledge base.
181
- */
182
- export type CreateKnowledgeResponseBodyRetrievalSettings = {
183
- /**
184
- * The number of results to return from the search.
185
- */
186
- topK: number;
187
- /**
188
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
189
- */
190
- threshold: number;
191
- /**
192
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
193
- */
194
- rerankConfig?: CreateKnowledgeResponseBodyRerankConfig | null | undefined;
195
- /**
196
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
197
- */
198
- agenticRagConfig?:
199
- | CreateKnowledgeResponseBodyAgenticRagConfig
200
- | null
201
- | undefined;
202
- };
203
-
204
- export type ResponseBodyExternalConfig = {
205
- /**
206
- * The name of the external knowledge base.
207
- */
208
- name: string;
209
- /**
210
- * The API URL of the external knowledge base.
211
- */
212
- apiUrl: string;
213
- };
214
-
215
- export type ResponseBody2 = {
216
- /**
217
- * The unique identifier of the knowledge base.
218
- */
219
- id: string;
220
- /**
221
- * The creation date of the knowledge base.
222
- */
223
- created: string;
224
- /**
225
- * The description of the knowledge base.
226
- */
227
- description?: string | undefined;
228
- /**
229
- * The unique key of the knowledge base.
230
- */
231
- key: string;
232
- /**
233
- * The project/domain ID of the knowledge base.
234
- */
235
- domainId: string;
236
- /**
237
- * Entity storage path in the format: `project/folder/subfolder/...`
238
- *
239
- * @remarks
240
- *
241
- * The first element identifies the project, followed by nested folders (auto-created as needed).
242
- *
243
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
244
- */
245
- path?: string | undefined;
246
- createdById?: string | null | undefined;
247
- updatedById?: string | null | undefined;
248
- /**
249
- * The last update date of the knowledge base.
250
- */
251
- updated: string;
252
- type: CreateKnowledgeResponseBodyKnowledgeType;
253
- /**
254
- * The retrieval settings for the knowledge base.
255
- */
256
- retrievalSettings?: CreateKnowledgeResponseBodyRetrievalSettings | undefined;
257
- externalConfig: ResponseBodyExternalConfig;
258
- };
259
-
260
- export const CreateKnowledgeResponseBodyType = {
261
- Internal: "internal",
262
- } as const;
263
- export type CreateKnowledgeResponseBodyType = ClosedEnum<
264
- typeof CreateKnowledgeResponseBodyType
265
- >;
266
-
267
- /**
268
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
269
- */
270
- export const ResponseBodyRetrievalType = {
271
- VectorSearch: "vector_search",
272
- KeywordSearch: "keyword_search",
273
- HybridSearch: "hybrid_search",
274
- } as const;
275
- /**
276
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
277
- */
278
- export type ResponseBodyRetrievalType = ClosedEnum<
279
- typeof ResponseBodyRetrievalType
280
- >;
281
-
282
- /**
283
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
284
- */
285
- export type ResponseBodyRerankConfig = {
286
- /**
287
- * The number of results to return by the reranking model
288
- */
289
- topK: number;
290
- /**
291
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
292
- */
293
- rerankThreshold: number;
294
- /**
295
- * The rerank model to use for the knowledge base.
296
- */
297
- rerankModel: string;
298
- };
299
-
300
- /**
301
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
302
- */
303
- export type ResponseBodyAgenticRagConfig = {
304
- /**
305
- * The model to use for the Agentic RAG
306
- */
307
- model: string;
308
- };
309
-
310
- /**
311
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
312
- */
313
- export type ResponseBodyRetrievalSettings = {
314
- /**
315
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
316
- */
317
- retrievalType: ResponseBodyRetrievalType;
318
- /**
319
- * The number of results to return from the search.
320
- */
321
- topK: number;
322
- /**
323
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
324
- */
325
- threshold: number;
326
- /**
327
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
328
- */
329
- rerankConfig?: ResponseBodyRerankConfig | null | undefined;
330
- /**
331
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
332
- */
333
- agenticRagConfig?: ResponseBodyAgenticRagConfig | null | undefined;
334
- };
335
-
336
- export type ResponseBody1 = {
337
- /**
338
- * The unique identifier of the knowledge base.
339
- */
340
- id: string;
341
- /**
342
- * The creation date of the knowledge base.
343
- */
344
- created: string;
345
- /**
346
- * The description of the knowledge base.
347
- */
348
- description?: string | undefined;
349
- /**
350
- * The unique key of the knowledge base.
351
- */
352
- key: string;
353
- /**
354
- * The project/domain ID of the knowledge base.
355
- */
356
- domainId: string;
357
- /**
358
- * Entity storage path in the format: `project/folder/subfolder/...`
359
- *
360
- * @remarks
361
- *
362
- * The first element identifies the project, followed by nested folders (auto-created as needed).
363
- *
364
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
365
- */
366
- path?: string | undefined;
367
- createdById?: string | null | undefined;
368
- updatedById?: string | null | undefined;
369
- /**
370
- * The last update date of the knowledge base.
371
- */
372
- updated: string;
373
- type: CreateKnowledgeResponseBodyType;
374
- /**
375
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
376
- */
377
- retrievalSettings?: ResponseBodyRetrievalSettings | undefined;
378
- /**
379
- * The embeddings model used for the knowledge base.
380
- */
381
- model: string;
382
- };
383
-
384
- /**
385
- * Knowledge successfully created
386
- */
387
- export type CreateKnowledgeResponseBody = ResponseBody1 | ResponseBody2;
388
-
389
- /** @internal */
390
- export const CreateKnowledgeRequestBodyKnowledgeType$outboundSchema:
391
- z.ZodNativeEnum<typeof CreateKnowledgeRequestBodyKnowledgeType> = z
392
- .nativeEnum(CreateKnowledgeRequestBodyKnowledgeType);
393
-
394
- /** @internal */
395
- export type ExternalConfig$Outbound = {
396
- name: string;
397
- api_url: string;
398
- api_key: string;
399
- };
400
-
401
- /** @internal */
402
- export const ExternalConfig$outboundSchema: z.ZodType<
403
- ExternalConfig$Outbound,
404
- z.ZodTypeDef,
405
- ExternalConfig
406
- > = z.object({
407
- name: z.string(),
408
- apiUrl: z.string(),
409
- apiKey: z.string(),
410
- }).transform((v) => {
411
- return remap$(v, {
412
- apiUrl: "api_url",
413
- apiKey: "api_key",
414
- });
415
- });
416
-
417
- export function externalConfigToJSON(externalConfig: ExternalConfig): string {
418
- return JSON.stringify(ExternalConfig$outboundSchema.parse(externalConfig));
419
- }
420
-
421
- /** @internal */
422
- export type RequestBody2$Outbound = {
423
- type: string;
424
- key: string;
425
- description?: string | undefined;
426
- external_config: ExternalConfig$Outbound;
427
- };
428
-
429
- /** @internal */
430
- export const RequestBody2$outboundSchema: z.ZodType<
431
- RequestBody2$Outbound,
432
- z.ZodTypeDef,
433
- RequestBody2
434
- > = z.object({
435
- type: CreateKnowledgeRequestBodyKnowledgeType$outboundSchema.default(
436
- "external",
437
- ),
438
- key: z.string(),
439
- description: z.string().optional(),
440
- externalConfig: z.lazy(() => ExternalConfig$outboundSchema),
441
- }).transform((v) => {
442
- return remap$(v, {
443
- externalConfig: "external_config",
444
- });
445
- });
446
-
447
- export function requestBody2ToJSON(requestBody2: RequestBody2): string {
448
- return JSON.stringify(RequestBody2$outboundSchema.parse(requestBody2));
449
- }
450
-
451
- /** @internal */
452
- export const CreateKnowledgeRequestBodyType$outboundSchema: z.ZodNativeEnum<
453
- typeof CreateKnowledgeRequestBodyType
454
- > = z.nativeEnum(CreateKnowledgeRequestBodyType);
455
-
456
- /** @internal */
457
- export const RetrievalType$outboundSchema: z.ZodNativeEnum<
458
- typeof RetrievalType
459
- > = z.nativeEnum(RetrievalType);
460
-
461
- /** @internal */
462
- export type CreateKnowledgeRequestBodyRerankConfig$Outbound = {
463
- top_k: number;
464
- rerank_threshold: number;
465
- rerank_model: string;
466
- };
467
-
468
- /** @internal */
469
- export const CreateKnowledgeRequestBodyRerankConfig$outboundSchema: z.ZodType<
470
- CreateKnowledgeRequestBodyRerankConfig$Outbound,
471
- z.ZodTypeDef,
472
- CreateKnowledgeRequestBodyRerankConfig
473
- > = z.object({
474
- topK: z.number().int().default(5),
475
- rerankThreshold: z.number().default(0.5),
476
- rerankModel: z.string(),
477
- }).transform((v) => {
478
- return remap$(v, {
479
- topK: "top_k",
480
- rerankThreshold: "rerank_threshold",
481
- rerankModel: "rerank_model",
482
- });
483
- });
484
-
485
- export function createKnowledgeRequestBodyRerankConfigToJSON(
486
- createKnowledgeRequestBodyRerankConfig:
487
- CreateKnowledgeRequestBodyRerankConfig,
488
- ): string {
489
- return JSON.stringify(
490
- CreateKnowledgeRequestBodyRerankConfig$outboundSchema.parse(
491
- createKnowledgeRequestBodyRerankConfig,
492
- ),
493
- );
494
- }
495
-
496
- /** @internal */
497
- export type CreateKnowledgeRequestBodyAgenticRagConfig$Outbound = {
498
- model: string;
499
- };
500
-
501
- /** @internal */
502
- export const CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema:
503
- z.ZodType<
504
- CreateKnowledgeRequestBodyAgenticRagConfig$Outbound,
505
- z.ZodTypeDef,
506
- CreateKnowledgeRequestBodyAgenticRagConfig
507
- > = z.object({
508
- model: z.string(),
509
- });
510
-
511
- export function createKnowledgeRequestBodyAgenticRagConfigToJSON(
512
- createKnowledgeRequestBodyAgenticRagConfig:
513
- CreateKnowledgeRequestBodyAgenticRagConfig,
514
- ): string {
515
- return JSON.stringify(
516
- CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema.parse(
517
- createKnowledgeRequestBodyAgenticRagConfig,
518
- ),
519
- );
520
- }
521
-
522
- /** @internal */
523
- export type RetrievalSettings$Outbound = {
524
- retrieval_type: string;
525
- top_k: number;
526
- threshold: number;
527
- rerank_config?:
528
- | CreateKnowledgeRequestBodyRerankConfig$Outbound
529
- | null
530
- | undefined;
531
- agentic_rag_config?:
532
- | CreateKnowledgeRequestBodyAgenticRagConfig$Outbound
533
- | null
534
- | undefined;
535
- };
536
-
537
- /** @internal */
538
- export const RetrievalSettings$outboundSchema: z.ZodType<
539
- RetrievalSettings$Outbound,
540
- z.ZodTypeDef,
541
- RetrievalSettings
542
- > = z.object({
543
- retrievalType: RetrievalType$outboundSchema.default("hybrid_search"),
544
- topK: z.number().int().default(5),
545
- threshold: z.number().default(0),
546
- rerankConfig: z.nullable(
547
- z.lazy(() => CreateKnowledgeRequestBodyRerankConfig$outboundSchema),
548
- ).optional(),
549
- agenticRagConfig: z.nullable(
550
- z.lazy(() => CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema),
551
- ).optional(),
552
- }).transform((v) => {
553
- return remap$(v, {
554
- retrievalType: "retrieval_type",
555
- topK: "top_k",
556
- rerankConfig: "rerank_config",
557
- agenticRagConfig: "agentic_rag_config",
558
- });
559
- });
560
-
561
- export function retrievalSettingsToJSON(
562
- retrievalSettings: RetrievalSettings,
563
- ): string {
564
- return JSON.stringify(
565
- RetrievalSettings$outboundSchema.parse(retrievalSettings),
566
- );
567
- }
568
-
569
- /** @internal */
570
- export type RequestBody1$Outbound = {
571
- type: string;
572
- key: string;
573
- description?: string | undefined;
574
- embedding_model: string;
575
- retrieval_settings?: RetrievalSettings$Outbound | undefined;
576
- path: string;
577
- };
578
-
579
- /** @internal */
580
- export const RequestBody1$outboundSchema: z.ZodType<
581
- RequestBody1$Outbound,
582
- z.ZodTypeDef,
583
- RequestBody1
584
- > = z.object({
585
- type: CreateKnowledgeRequestBodyType$outboundSchema.default("internal"),
586
- key: z.string(),
587
- description: z.string().optional(),
588
- embeddingModel: z.string(),
589
- retrievalSettings: z.lazy(() => RetrievalSettings$outboundSchema).optional(),
590
- path: z.string(),
591
- }).transform((v) => {
592
- return remap$(v, {
593
- embeddingModel: "embedding_model",
594
- retrievalSettings: "retrieval_settings",
595
- });
596
- });
597
-
598
- export function requestBody1ToJSON(requestBody1: RequestBody1): string {
599
- return JSON.stringify(RequestBody1$outboundSchema.parse(requestBody1));
600
- }
601
-
602
- /** @internal */
603
- export type CreateKnowledgeRequestBody$Outbound =
604
- | RequestBody1$Outbound
605
- | RequestBody2$Outbound;
606
-
607
- /** @internal */
608
- export const CreateKnowledgeRequestBody$outboundSchema: z.ZodType<
609
- CreateKnowledgeRequestBody$Outbound,
610
- z.ZodTypeDef,
611
- CreateKnowledgeRequestBody
612
- > = z.union([
613
- z.lazy(() => RequestBody1$outboundSchema),
614
- z.lazy(() => RequestBody2$outboundSchema),
615
- ]);
616
-
617
- export function createKnowledgeRequestBodyToJSON(
618
- createKnowledgeRequestBody: CreateKnowledgeRequestBody,
619
- ): string {
620
- return JSON.stringify(
621
- CreateKnowledgeRequestBody$outboundSchema.parse(createKnowledgeRequestBody),
622
- );
623
- }
624
-
625
- /** @internal */
626
- export const CreateKnowledgeResponseBodyKnowledgeType$inboundSchema:
627
- z.ZodNativeEnum<typeof CreateKnowledgeResponseBodyKnowledgeType> = z
628
- .nativeEnum(CreateKnowledgeResponseBodyKnowledgeType);
629
-
630
- /** @internal */
631
- export const CreateKnowledgeResponseBodyRerankConfig$inboundSchema: z.ZodType<
632
- CreateKnowledgeResponseBodyRerankConfig,
633
- z.ZodTypeDef,
634
- unknown
635
- > = z.object({
636
- top_k: z.number().int().default(5),
637
- rerank_threshold: z.number().default(0.5),
638
- rerank_model: z.string(),
639
- }).transform((v) => {
640
- return remap$(v, {
641
- "top_k": "topK",
642
- "rerank_threshold": "rerankThreshold",
643
- "rerank_model": "rerankModel",
644
- });
645
- });
646
-
647
- export function createKnowledgeResponseBodyRerankConfigFromJSON(
648
- jsonString: string,
649
- ): SafeParseResult<
650
- CreateKnowledgeResponseBodyRerankConfig,
651
- SDKValidationError
652
- > {
653
- return safeParse(
654
- jsonString,
655
- (x) =>
656
- CreateKnowledgeResponseBodyRerankConfig$inboundSchema.parse(
657
- JSON.parse(x),
658
- ),
659
- `Failed to parse 'CreateKnowledgeResponseBodyRerankConfig' from JSON`,
660
- );
661
- }
662
-
663
- /** @internal */
664
- export const CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema:
665
- z.ZodType<
666
- CreateKnowledgeResponseBodyAgenticRagConfig,
667
- z.ZodTypeDef,
668
- unknown
669
- > = z.object({
670
- model: z.string(),
671
- });
672
-
673
- export function createKnowledgeResponseBodyAgenticRagConfigFromJSON(
674
- jsonString: string,
675
- ): SafeParseResult<
676
- CreateKnowledgeResponseBodyAgenticRagConfig,
677
- SDKValidationError
678
- > {
679
- return safeParse(
680
- jsonString,
681
- (x) =>
682
- CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema.parse(
683
- JSON.parse(x),
684
- ),
685
- `Failed to parse 'CreateKnowledgeResponseBodyAgenticRagConfig' from JSON`,
686
- );
687
- }
688
-
689
- /** @internal */
690
- export const CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema:
691
- z.ZodType<
692
- CreateKnowledgeResponseBodyRetrievalSettings,
693
- z.ZodTypeDef,
694
- unknown
695
- > = z.object({
696
- top_k: z.number().int().default(5),
697
- threshold: z.number().default(0),
698
- rerank_config: z.nullable(
699
- z.lazy(() => CreateKnowledgeResponseBodyRerankConfig$inboundSchema),
700
- ).optional(),
701
- agentic_rag_config: z.nullable(
702
- z.lazy(() => CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema),
703
- ).optional(),
704
- }).transform((v) => {
705
- return remap$(v, {
706
- "top_k": "topK",
707
- "rerank_config": "rerankConfig",
708
- "agentic_rag_config": "agenticRagConfig",
709
- });
710
- });
711
-
712
- export function createKnowledgeResponseBodyRetrievalSettingsFromJSON(
713
- jsonString: string,
714
- ): SafeParseResult<
715
- CreateKnowledgeResponseBodyRetrievalSettings,
716
- SDKValidationError
717
- > {
718
- return safeParse(
719
- jsonString,
720
- (x) =>
721
- CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema.parse(
722
- JSON.parse(x),
723
- ),
724
- `Failed to parse 'CreateKnowledgeResponseBodyRetrievalSettings' from JSON`,
725
- );
726
- }
727
-
728
- /** @internal */
729
- export const ResponseBodyExternalConfig$inboundSchema: z.ZodType<
730
- ResponseBodyExternalConfig,
731
- z.ZodTypeDef,
732
- unknown
733
- > = z.object({
734
- name: z.string(),
735
- api_url: z.string(),
736
- }).transform((v) => {
737
- return remap$(v, {
738
- "api_url": "apiUrl",
739
- });
740
- });
741
-
742
- export function responseBodyExternalConfigFromJSON(
743
- jsonString: string,
744
- ): SafeParseResult<ResponseBodyExternalConfig, SDKValidationError> {
745
- return safeParse(
746
- jsonString,
747
- (x) => ResponseBodyExternalConfig$inboundSchema.parse(JSON.parse(x)),
748
- `Failed to parse 'ResponseBodyExternalConfig' from JSON`,
749
- );
750
- }
751
-
752
- /** @internal */
753
- export const ResponseBody2$inboundSchema: z.ZodType<
754
- ResponseBody2,
755
- z.ZodTypeDef,
756
- unknown
757
- > = z.object({
758
- _id: z.string(),
759
- created: z.string(),
760
- description: z.string().optional(),
761
- key: z.string(),
762
- domain_id: z.string(),
763
- path: z.string().optional(),
764
- created_by_id: z.nullable(z.string()).optional(),
765
- updated_by_id: z.nullable(z.string()).optional(),
766
- updated: z.string(),
767
- type: CreateKnowledgeResponseBodyKnowledgeType$inboundSchema.default(
768
- "external",
769
- ),
770
- retrieval_settings: z.lazy(() =>
771
- CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema
772
- ).optional(),
773
- external_config: z.lazy(() => ResponseBodyExternalConfig$inboundSchema),
774
- }).transform((v) => {
775
- return remap$(v, {
776
- "_id": "id",
777
- "domain_id": "domainId",
778
- "created_by_id": "createdById",
779
- "updated_by_id": "updatedById",
780
- "retrieval_settings": "retrievalSettings",
781
- "external_config": "externalConfig",
782
- });
783
- });
784
-
785
- export function responseBody2FromJSON(
786
- jsonString: string,
787
- ): SafeParseResult<ResponseBody2, SDKValidationError> {
788
- return safeParse(
789
- jsonString,
790
- (x) => ResponseBody2$inboundSchema.parse(JSON.parse(x)),
791
- `Failed to parse 'ResponseBody2' from JSON`,
792
- );
793
- }
794
-
795
- /** @internal */
796
- export const CreateKnowledgeResponseBodyType$inboundSchema: z.ZodNativeEnum<
797
- typeof CreateKnowledgeResponseBodyType
798
- > = z.nativeEnum(CreateKnowledgeResponseBodyType);
799
-
800
- /** @internal */
801
- export const ResponseBodyRetrievalType$inboundSchema: z.ZodNativeEnum<
802
- typeof ResponseBodyRetrievalType
803
- > = z.nativeEnum(ResponseBodyRetrievalType);
804
-
805
- /** @internal */
806
- export const ResponseBodyRerankConfig$inboundSchema: z.ZodType<
807
- ResponseBodyRerankConfig,
808
- z.ZodTypeDef,
809
- unknown
810
- > = z.object({
811
- top_k: z.number().int().default(5),
812
- rerank_threshold: z.number().default(0.5),
813
- rerank_model: z.string(),
814
- }).transform((v) => {
815
- return remap$(v, {
816
- "top_k": "topK",
817
- "rerank_threshold": "rerankThreshold",
818
- "rerank_model": "rerankModel",
819
- });
820
- });
821
-
822
- export function responseBodyRerankConfigFromJSON(
823
- jsonString: string,
824
- ): SafeParseResult<ResponseBodyRerankConfig, SDKValidationError> {
825
- return safeParse(
826
- jsonString,
827
- (x) => ResponseBodyRerankConfig$inboundSchema.parse(JSON.parse(x)),
828
- `Failed to parse 'ResponseBodyRerankConfig' from JSON`,
829
- );
830
- }
831
-
832
- /** @internal */
833
- export const ResponseBodyAgenticRagConfig$inboundSchema: z.ZodType<
834
- ResponseBodyAgenticRagConfig,
835
- z.ZodTypeDef,
836
- unknown
837
- > = z.object({
838
- model: z.string(),
839
- });
840
-
841
- export function responseBodyAgenticRagConfigFromJSON(
842
- jsonString: string,
843
- ): SafeParseResult<ResponseBodyAgenticRagConfig, SDKValidationError> {
844
- return safeParse(
845
- jsonString,
846
- (x) => ResponseBodyAgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
847
- `Failed to parse 'ResponseBodyAgenticRagConfig' from JSON`,
848
- );
849
- }
850
-
851
- /** @internal */
852
- export const ResponseBodyRetrievalSettings$inboundSchema: z.ZodType<
853
- ResponseBodyRetrievalSettings,
854
- z.ZodTypeDef,
855
- unknown
856
- > = z.object({
857
- retrieval_type: ResponseBodyRetrievalType$inboundSchema.default(
858
- "hybrid_search",
859
- ),
860
- top_k: z.number().int().default(5),
861
- threshold: z.number().default(0),
862
- rerank_config: z.nullable(
863
- z.lazy(() => ResponseBodyRerankConfig$inboundSchema),
864
- ).optional(),
865
- agentic_rag_config: z.nullable(
866
- z.lazy(() => ResponseBodyAgenticRagConfig$inboundSchema),
867
- ).optional(),
868
- }).transform((v) => {
869
- return remap$(v, {
870
- "retrieval_type": "retrievalType",
871
- "top_k": "topK",
872
- "rerank_config": "rerankConfig",
873
- "agentic_rag_config": "agenticRagConfig",
874
- });
875
- });
876
-
877
- export function responseBodyRetrievalSettingsFromJSON(
878
- jsonString: string,
879
- ): SafeParseResult<ResponseBodyRetrievalSettings, SDKValidationError> {
880
- return safeParse(
881
- jsonString,
882
- (x) => ResponseBodyRetrievalSettings$inboundSchema.parse(JSON.parse(x)),
883
- `Failed to parse 'ResponseBodyRetrievalSettings' from JSON`,
884
- );
885
- }
886
-
887
- /** @internal */
888
- export const ResponseBody1$inboundSchema: z.ZodType<
889
- ResponseBody1,
890
- z.ZodTypeDef,
891
- unknown
892
- > = z.object({
893
- _id: z.string(),
894
- created: z.string(),
895
- description: z.string().optional(),
896
- key: z.string(),
897
- domain_id: z.string(),
898
- path: z.string().optional(),
899
- created_by_id: z.nullable(z.string()).optional(),
900
- updated_by_id: z.nullable(z.string()).optional(),
901
- updated: z.string(),
902
- type: CreateKnowledgeResponseBodyType$inboundSchema.default("internal"),
903
- retrieval_settings: z.lazy(() => ResponseBodyRetrievalSettings$inboundSchema)
904
- .optional(),
905
- model: z.string(),
906
- }).transform((v) => {
907
- return remap$(v, {
908
- "_id": "id",
909
- "domain_id": "domainId",
910
- "created_by_id": "createdById",
911
- "updated_by_id": "updatedById",
912
- "retrieval_settings": "retrievalSettings",
913
- });
914
- });
915
-
916
- export function responseBody1FromJSON(
917
- jsonString: string,
918
- ): SafeParseResult<ResponseBody1, SDKValidationError> {
919
- return safeParse(
920
- jsonString,
921
- (x) => ResponseBody1$inboundSchema.parse(JSON.parse(x)),
922
- `Failed to parse 'ResponseBody1' from JSON`,
923
- );
924
- }
925
-
926
- /** @internal */
927
- export const CreateKnowledgeResponseBody$inboundSchema: z.ZodType<
928
- CreateKnowledgeResponseBody,
929
- z.ZodTypeDef,
930
- unknown
931
- > = z.union([
932
- z.lazy(() => ResponseBody1$inboundSchema),
933
- z.lazy(() => ResponseBody2$inboundSchema),
934
- ]);
935
-
936
- export function createKnowledgeResponseBodyFromJSON(
937
- jsonString: string,
938
- ): SafeParseResult<CreateKnowledgeResponseBody, SDKValidationError> {
939
- return safeParse(
940
- jsonString,
941
- (x) => CreateKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
942
- `Failed to parse 'CreateKnowledgeResponseBody' from JSON`,
943
- );
944
- }