@orq-ai/node 4.7.3 → 4.8.0-rc.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 (517) hide show
  1. package/README.md +1 -1
  2. package/funcs/filesGetContent.d.ts +1 -1
  3. package/funcs/filesGetContent.js +3 -3
  4. package/funcs/filesGetContent.js.map +1 -1
  5. package/jsr.json +1 -1
  6. package/lib/config.d.ts +2 -2
  7. package/lib/config.js +2 -2
  8. package/lib/config.js.map +1 -1
  9. package/models/components/reasoningpart.js +1 -1
  10. package/models/operations/createcontact.js +1 -1
  11. package/models/operations/createdataset.js +1 -1
  12. package/models/operations/createdatasetitem.js +4 -4
  13. package/models/operations/createdatasource.js +1 -1
  14. package/models/operations/createeval.js +16 -16
  15. package/models/operations/createidentity.js +1 -1
  16. package/models/operations/createtool.js +6 -6
  17. package/models/operations/filecontent.d.ts +3 -3
  18. package/models/operations/filecontent.d.ts.map +1 -1
  19. package/models/operations/filecontent.js +2 -2
  20. package/models/operations/filecontent.js.map +1 -1
  21. package/models/operations/getalltools.js +6 -6
  22. package/models/operations/getevals.js +16 -16
  23. package/models/operations/getv2humanevals.js +6 -6
  24. package/models/operations/getv2humanevalsets.js +2 -2
  25. package/models/operations/getv2humanevalsetsid.js +2 -2
  26. package/models/operations/getv2humanevalsid.js +6 -6
  27. package/models/operations/listdatasetdatapoints.js +4 -4
  28. package/models/operations/listdatasets.js +1 -1
  29. package/models/operations/listdatasources.js +1 -1
  30. package/models/operations/listidentities.js +1 -1
  31. package/models/operations/patchv2humanevalsetsid.js +2 -2
  32. package/models/operations/patchv2humanevalsid.js +12 -12
  33. package/models/operations/postv2feedbackevaluation.js +3 -3
  34. package/models/operations/postv2humanevals.js +12 -12
  35. package/models/operations/postv2humanevalsets.js +2 -2
  36. package/models/operations/retrievedatapoint.js +4 -4
  37. package/models/operations/retrievedataset.js +1 -1
  38. package/models/operations/retrievedatasource.js +1 -1
  39. package/models/operations/retrieveidentity.js +1 -1
  40. package/models/operations/retrievetool.js +6 -6
  41. package/models/operations/runagent.js +1 -1
  42. package/models/operations/streamrunagent.js +1 -1
  43. package/models/operations/updatedatapoint.js +4 -4
  44. package/models/operations/updatedataset.js +1 -1
  45. package/models/operations/updatedatasource.js +1 -1
  46. package/models/operations/updateeval.js +16 -16
  47. package/models/operations/updateidentity.js +1 -1
  48. package/models/operations/updatetool.js +7 -7
  49. package/package.json +4 -3
  50. package/sdk/files.d.ts +7 -7
  51. package/sdk/files.d.ts.map +1 -1
  52. package/sdk/files.js +9 -9
  53. package/sdk/files.js.map +1 -1
  54. package/src/funcs/filesGetContent.ts +3 -3
  55. package/src/lib/config.ts +2 -2
  56. package/src/models/components/reasoningpart.ts +1 -1
  57. package/src/models/operations/createcontact.ts +1 -1
  58. package/src/models/operations/createdataset.ts +1 -1
  59. package/src/models/operations/createdatasetitem.ts +4 -4
  60. package/src/models/operations/createdatasource.ts +1 -1
  61. package/src/models/operations/createeval.ts +16 -16
  62. package/src/models/operations/createidentity.ts +1 -1
  63. package/src/models/operations/createtool.ts +6 -6
  64. package/src/models/operations/filecontent.ts +5 -5
  65. package/src/models/operations/getalltools.ts +6 -6
  66. package/src/models/operations/getevals.ts +16 -16
  67. package/src/models/operations/getv2humanevals.ts +6 -6
  68. package/src/models/operations/getv2humanevalsets.ts +2 -2
  69. package/src/models/operations/getv2humanevalsetsid.ts +2 -2
  70. package/src/models/operations/getv2humanevalsid.ts +6 -6
  71. package/src/models/operations/listdatasetdatapoints.ts +4 -4
  72. package/src/models/operations/listdatasets.ts +1 -1
  73. package/src/models/operations/listdatasources.ts +1 -1
  74. package/src/models/operations/listidentities.ts +1 -1
  75. package/src/models/operations/patchv2humanevalsetsid.ts +2 -2
  76. package/src/models/operations/patchv2humanevalsid.ts +12 -12
  77. package/src/models/operations/postv2feedbackevaluation.ts +3 -3
  78. package/src/models/operations/postv2humanevals.ts +12 -12
  79. package/src/models/operations/postv2humanevalsets.ts +2 -2
  80. package/src/models/operations/retrievedatapoint.ts +4 -4
  81. package/src/models/operations/retrievedataset.ts +1 -1
  82. package/src/models/operations/retrievedatasource.ts +1 -1
  83. package/src/models/operations/retrieveidentity.ts +1 -1
  84. package/src/models/operations/retrievetool.ts +6 -6
  85. package/src/models/operations/runagent.ts +1 -1
  86. package/src/models/operations/streamrunagent.ts +1 -1
  87. package/src/models/operations/updatedatapoint.ts +4 -4
  88. package/src/models/operations/updatedataset.ts +1 -1
  89. package/src/models/operations/updatedatasource.ts +1 -1
  90. package/src/models/operations/updateeval.ts +16 -16
  91. package/src/models/operations/updateidentity.ts +1 -1
  92. package/src/models/operations/updatetool.ts +7 -7
  93. package/src/sdk/files.ts +17 -17
  94. package/packages/orq-rc/examples/postV2Feedback.example.ts +0 -26
  95. package/packages/orq-rc/src/core.ts +0 -13
  96. package/packages/orq-rc/src/funcs/agentsCreate.ts +0 -161
  97. package/packages/orq-rc/src/funcs/agentsDelete.ts +0 -179
  98. package/packages/orq-rc/src/funcs/agentsInvoke.ts +0 -176
  99. package/packages/orq-rc/src/funcs/agentsList.ts +0 -184
  100. package/packages/orq-rc/src/funcs/agentsPostV2AgentsA2a.ts +0 -178
  101. package/packages/orq-rc/src/funcs/agentsPostV2AgentsKeyCardRefresh.ts +0 -186
  102. package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts +0 -182
  103. package/packages/orq-rc/src/funcs/agentsResponsesGet.ts +0 -181
  104. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +0 -179
  105. package/packages/orq-rc/src/funcs/agentsRun.ts +0 -162
  106. package/packages/orq-rc/src/funcs/agentsStream.ts +0 -203
  107. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +0 -189
  108. package/packages/orq-rc/src/funcs/agentsUpdate.ts +0 -183
  109. package/packages/orq-rc/src/funcs/annotationsCreate.ts +0 -170
  110. package/packages/orq-rc/src/funcs/annotationsDelete.ts +0 -170
  111. package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
  112. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -160
  113. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -166
  114. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  115. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -170
  116. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -166
  117. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -181
  118. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  119. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -173
  120. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -174
  121. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -180
  122. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -175
  123. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -178
  124. package/packages/orq-rc/src/funcs/deleteV2HumanEvalsId.ts +0 -169
  125. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  126. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  127. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  128. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -169
  129. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -186
  130. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  131. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  132. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -172
  133. package/packages/orq-rc/src/funcs/evalsInvoke.ts +0 -180
  134. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -172
  135. package/packages/orq-rc/src/funcs/evaluatorsGetV2EvaluatorsIdVersions.ts +0 -182
  136. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -194
  137. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -163
  138. package/packages/orq-rc/src/funcs/filesGet.ts +0 -165
  139. package/packages/orq-rc/src/funcs/filesGetContent.ts +0 -166
  140. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  141. package/packages/orq-rc/src/funcs/filesUpdate.ts +0 -166
  142. package/packages/orq-rc/src/funcs/getV2HumanEvals.ts +0 -169
  143. package/packages/orq-rc/src/funcs/getV2HumanEvalsId.ts +0 -168
  144. package/packages/orq-rc/src/funcs/humanReviewSetsDeleteV2HumanEvalSetsId.ts +0 -164
  145. package/packages/orq-rc/src/funcs/humanReviewSetsGetV2HumanEvalSets.ts +0 -168
  146. package/packages/orq-rc/src/funcs/humanReviewSetsGetV2HumanEvalSetsId.ts +0 -163
  147. package/packages/orq-rc/src/funcs/humanReviewSetsPatchV2HumanEvalSetsId.ts +0 -164
  148. package/packages/orq-rc/src/funcs/humanReviewSetsPostV2HumanEvalSets.ts +0 -162
  149. package/packages/orq-rc/src/funcs/identitiesCreate.ts +0 -165
  150. package/packages/orq-rc/src/funcs/identitiesDelete.ts +0 -175
  151. package/packages/orq-rc/src/funcs/identitiesList.ts +0 -170
  152. package/packages/orq-rc/src/funcs/identitiesRetrieve.ts +0 -183
  153. package/packages/orq-rc/src/funcs/identitiesUpdate.ts +0 -175
  154. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
  155. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -170
  156. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -165
  157. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -166
  158. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -173
  159. package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +0 -169
  160. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -172
  161. package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +0 -169
  162. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  163. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -177
  164. package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +0 -170
  165. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -173
  166. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -165
  167. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -172
  168. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -168
  169. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -166
  170. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -163
  171. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -173
  172. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -169
  173. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +0 -162
  174. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +0 -175
  175. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +0 -169
  176. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +0 -167
  177. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +0 -184
  178. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +0 -179
  179. package/packages/orq-rc/src/funcs/memoryStoresList.ts +0 -178
  180. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +0 -183
  181. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +0 -176
  182. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +0 -176
  183. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +0 -178
  184. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +0 -173
  185. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +0 -167
  186. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +0 -179
  187. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +0 -174
  188. package/packages/orq-rc/src/funcs/modelsList.ts +0 -165
  189. package/packages/orq-rc/src/funcs/patchV2HumanEvalsId.ts +0 -170
  190. package/packages/orq-rc/src/funcs/postV2Feedback.ts +0 -172
  191. package/packages/orq-rc/src/funcs/postV2FeedbackEvaluation.ts +0 -159
  192. package/packages/orq-rc/src/funcs/postV2FeedbackEvaluationRemove.ts +0 -159
  193. package/packages/orq-rc/src/funcs/postV2FeedbackRemove.ts +0 -167
  194. package/packages/orq-rc/src/funcs/postV2HumanEvals.ts +0 -168
  195. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  196. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -172
  197. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -180
  198. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  199. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -172
  200. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -165
  201. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -172
  202. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  203. package/packages/orq-rc/src/funcs/routerAudioSpeechCreate.ts +0 -161
  204. package/packages/orq-rc/src/funcs/routerAudioTranscriptionsCreate.ts +0 -269
  205. package/packages/orq-rc/src/funcs/routerAudioTranslationsCreate.ts +0 -259
  206. package/packages/orq-rc/src/funcs/routerChatCompletionsCreate.ts +0 -168
  207. package/packages/orq-rc/src/funcs/routerCompletionsCreate.ts +0 -168
  208. package/packages/orq-rc/src/funcs/routerEmbeddingsCreate.ts +0 -161
  209. package/packages/orq-rc/src/funcs/routerImagesEditsCreate.ts +0 -222
  210. package/packages/orq-rc/src/funcs/routerImagesGenerationsCreate.ts +0 -160
  211. package/packages/orq-rc/src/funcs/routerImagesVariationsCreate.ts +0 -218
  212. package/packages/orq-rc/src/funcs/routerModerationsCreate.ts +0 -167
  213. package/packages/orq-rc/src/funcs/routerOcr.ts +0 -158
  214. package/packages/orq-rc/src/funcs/routerRerankCreate.ts +0 -160
  215. package/packages/orq-rc/src/funcs/routerResponsesCreate.ts +0 -167
  216. package/packages/orq-rc/src/funcs/toolsCreate.ts +0 -163
  217. package/packages/orq-rc/src/funcs/toolsDelete.ts +0 -166
  218. package/packages/orq-rc/src/funcs/toolsGetV2ToolsToolIdVersions.ts +0 -182
  219. package/packages/orq-rc/src/funcs/toolsGetV2ToolsToolIdVersionsVersionId.ts +0 -189
  220. package/packages/orq-rc/src/funcs/toolsList.ts +0 -176
  221. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +0 -165
  222. package/packages/orq-rc/src/funcs/toolsUpdate.ts +0 -175
  223. package/packages/orq-rc/src/hooks/global.ts +0 -44
  224. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  225. package/packages/orq-rc/src/hooks/index.ts +0 -6
  226. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  227. package/packages/orq-rc/src/hooks/types.ts +0 -112
  228. package/packages/orq-rc/src/index.ts +0 -9
  229. package/packages/orq-rc/src/lib/base64.ts +0 -37
  230. package/packages/orq-rc/src/lib/config.ts +0 -74
  231. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  232. package/packages/orq-rc/src/lib/encodings.ts +0 -516
  233. package/packages/orq-rc/src/lib/env.ts +0 -89
  234. package/packages/orq-rc/src/lib/event-streams.ts +0 -165
  235. package/packages/orq-rc/src/lib/files.ts +0 -104
  236. package/packages/orq-rc/src/lib/http.ts +0 -323
  237. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  238. package/packages/orq-rc/src/lib/logger.ts +0 -9
  239. package/packages/orq-rc/src/lib/matchers.ts +0 -346
  240. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  241. package/packages/orq-rc/src/lib/retries.ts +0 -218
  242. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  243. package/packages/orq-rc/src/lib/sdks.ts +0 -409
  244. package/packages/orq-rc/src/lib/security.ts +0 -275
  245. package/packages/orq-rc/src/lib/url.ts +0 -35
  246. package/packages/orq-rc/src/models/components/actionreviewedstreamingevent.ts +0 -99
  247. package/packages/orq-rc/src/models/components/actionreviewrequestedstreamingevent.ts +0 -185
  248. package/packages/orq-rc/src/models/components/agenterroredstreamingevent.ts +0 -73
  249. package/packages/orq-rc/src/models/components/agentexecutionstartedstreamingevent.ts +0 -91
  250. package/packages/orq-rc/src/models/components/agenthandedoffstreamingevent.ts +0 -71
  251. package/packages/orq-rc/src/models/components/agentinactivestreamingevent.ts +0 -507
  252. package/packages/orq-rc/src/models/components/agentmessagecreatedstreamingevent.ts +0 -165
  253. package/packages/orq-rc/src/models/components/agentresponsemessage.ts +0 -103
  254. package/packages/orq-rc/src/models/components/agentstartedstreamingevent.ts +0 -517
  255. package/packages/orq-rc/src/models/components/agentthoughtstreamingevent.ts +0 -807
  256. package/packages/orq-rc/src/models/components/audiocontentpartschema.ts +0 -136
  257. package/packages/orq-rc/src/models/components/createagentresponse.ts +0 -305
  258. package/packages/orq-rc/src/models/components/datapart.ts +0 -38
  259. package/packages/orq-rc/src/models/components/errorpart.ts +0 -58
  260. package/packages/orq-rc/src/models/components/errorstreamingevent.ts +0 -66
  261. package/packages/orq-rc/src/models/components/executionnamedstreamingevent.ts +0 -71
  262. package/packages/orq-rc/src/models/components/executionreviewedstreamingevent.ts +0 -61
  263. package/packages/orq-rc/src/models/components/executionreviewrequiredstreamingevent.ts +0 -67
  264. package/packages/orq-rc/src/models/components/extendedmessage.ts +0 -146
  265. package/packages/orq-rc/src/models/components/filecontentpartschema.ts +0 -87
  266. package/packages/orq-rc/src/models/components/filedocument.ts +0 -48
  267. package/packages/orq-rc/src/models/components/filepart.ts +0 -218
  268. package/packages/orq-rc/src/models/components/getagentresponse.ts +0 -348
  269. package/packages/orq-rc/src/models/components/imagecontentpartschema.ts +0 -268
  270. package/packages/orq-rc/src/models/components/index.ts +0 -61
  271. package/packages/orq-rc/src/models/components/invokedeploymentrequest.ts +0 -3450
  272. package/packages/orq-rc/src/models/components/partdelta.ts +0 -39
  273. package/packages/orq-rc/src/models/components/partdeltaevent.ts +0 -73
  274. package/packages/orq-rc/src/models/components/partdoneevent.ts +0 -70
  275. package/packages/orq-rc/src/models/components/publiccontact.ts +0 -71
  276. package/packages/orq-rc/src/models/components/publicidentity.ts +0 -69
  277. package/packages/orq-rc/src/models/components/reasoningpart.ts +0 -62
  278. package/packages/orq-rc/src/models/components/reasoningpartschema.ts +0 -71
  279. package/packages/orq-rc/src/models/components/redactedreasoningpartschema.ts +0 -66
  280. package/packages/orq-rc/src/models/components/refusalpartschema.ts +0 -64
  281. package/packages/orq-rc/src/models/components/responsedoneevent.ts +0 -324
  282. package/packages/orq-rc/src/models/components/responsefailedevent.ts +0 -72
  283. package/packages/orq-rc/src/models/components/responsestartedevent.ts +0 -97
  284. package/packages/orq-rc/src/models/components/responsestreamingevent.ts +0 -85
  285. package/packages/orq-rc/src/models/components/reviewoutcome.ts +0 -23
  286. package/packages/orq-rc/src/models/components/security.ts +0 -32
  287. package/packages/orq-rc/src/models/components/telemetry.ts +0 -48
  288. package/packages/orq-rc/src/models/components/textcontentpartschema.ts +0 -207
  289. package/packages/orq-rc/src/models/components/textpart.ts +0 -54
  290. package/packages/orq-rc/src/models/components/thinkingconfigadaptiveschema.ts +0 -59
  291. package/packages/orq-rc/src/models/components/thinkingconfigdisabledschema.ts +0 -59
  292. package/packages/orq-rc/src/models/components/thinkingconfigenabledschema.ts +0 -106
  293. package/packages/orq-rc/src/models/components/timeoutstreamingevent.ts +0 -64
  294. package/packages/orq-rc/src/models/components/toolcallpart.ts +0 -51
  295. package/packages/orq-rc/src/models/components/tooldoneevent.ts +0 -77
  296. package/packages/orq-rc/src/models/components/toolexecutionfailedstreamingevent.ts +0 -235
  297. package/packages/orq-rc/src/models/components/toolexecutionfinishedstreamingevent.ts +0 -219
  298. package/packages/orq-rc/src/models/components/toolexecutionstartedstreamingevent.ts +0 -205
  299. package/packages/orq-rc/src/models/components/toolfailedevent.ts +0 -77
  300. package/packages/orq-rc/src/models/components/toolresultpart.ts +0 -71
  301. package/packages/orq-rc/src/models/components/toolreviewdoneevent.ts +0 -78
  302. package/packages/orq-rc/src/models/components/toolreviewrequestedevent.ts +0 -87
  303. package/packages/orq-rc/src/models/components/toolstartedevent.ts +0 -82
  304. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  305. package/packages/orq-rc/src/models/errors/createeval.ts +0 -51
  306. package/packages/orq-rc/src/models/errors/createmoderation.ts +0 -84
  307. package/packages/orq-rc/src/models/errors/createtranscription.ts +0 -87
  308. package/packages/orq-rc/src/models/errors/createtranslation.ts +0 -87
  309. package/packages/orq-rc/src/models/errors/deleteagent.ts +0 -51
  310. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -51
  311. package/packages/orq-rc/src/models/errors/deleteidentity.ts +0 -62
  312. package/packages/orq-rc/src/models/errors/deleteprompt.ts +0 -51
  313. package/packages/orq-rc/src/models/errors/deletev2humanevalsid.ts +0 -51
  314. package/packages/orq-rc/src/models/errors/getevals.ts +0 -51
  315. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -51
  316. package/packages/orq-rc/src/models/errors/getv2evaluatorsidversions.ts +0 -51
  317. package/packages/orq-rc/src/models/errors/getv2humanevals.ts +0 -51
  318. package/packages/orq-rc/src/models/errors/getv2humanevalsid.ts +0 -51
  319. package/packages/orq-rc/src/models/errors/getv2toolstoolidversions.ts +0 -51
  320. package/packages/orq-rc/src/models/errors/getv2toolstoolidversionsversionid.ts +0 -52
  321. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -59
  322. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  323. package/packages/orq-rc/src/models/errors/index.ts +0 -42
  324. package/packages/orq-rc/src/models/errors/invokeeval.ts +0 -141
  325. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  326. package/packages/orq-rc/src/models/errors/patchv2humanevalsid.ts +0 -51
  327. package/packages/orq-rc/src/models/errors/postv2agentsa2a.ts +0 -96
  328. package/packages/orq-rc/src/models/errors/postv2agentskeycardrefresh.ts +0 -97
  329. package/packages/orq-rc/src/models/errors/postv2feedback.ts +0 -96
  330. package/packages/orq-rc/src/models/errors/postv2feedbackremove.ts +0 -51
  331. package/packages/orq-rc/src/models/errors/postv2humanevals.ts +0 -51
  332. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  333. package/packages/orq-rc/src/models/errors/retrieveagentrequest.ts +0 -51
  334. package/packages/orq-rc/src/models/errors/retrieveidentity.ts +0 -118
  335. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  336. package/packages/orq-rc/src/models/errors/streamagent.ts +0 -51
  337. package/packages/orq-rc/src/models/errors/streamrunagent.ts +0 -51
  338. package/packages/orq-rc/src/models/errors/updateagent.ts +0 -51
  339. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -51
  340. package/packages/orq-rc/src/models/errors/updateidentity.ts +0 -54
  341. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -51
  342. package/packages/orq-rc/src/models/errors/updatetool.ts +0 -62
  343. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -39
  344. package/packages/orq-rc/src/models/operations/createagentrequest.ts +0 -6459
  345. package/packages/orq-rc/src/models/operations/createagentresponserequest.ts +0 -670
  346. package/packages/orq-rc/src/models/operations/createannotation.ts +0 -166
  347. package/packages/orq-rc/src/models/operations/createchatcompletion.ts +0 -6398
  348. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -222
  349. package/packages/orq-rc/src/models/operations/createcompletion.ts +0 -3473
  350. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -156
  351. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -162
  352. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -2554
  353. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -437
  354. package/packages/orq-rc/src/models/operations/createembedding.ts +0 -947
  355. package/packages/orq-rc/src/models/operations/createeval.ts +0 -4229
  356. package/packages/orq-rc/src/models/operations/createidentity.ts +0 -162
  357. package/packages/orq-rc/src/models/operations/createimage.ts +0 -1034
  358. package/packages/orq-rc/src/models/operations/createimageedit.ts +0 -1045
  359. package/packages/orq-rc/src/models/operations/createimagevariation.ts +0 -1067
  360. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -960
  361. package/packages/orq-rc/src/models/operations/creatememory.ts +0 -142
  362. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +0 -152
  363. package/packages/orq-rc/src/models/operations/creatememorystore.ts +0 -199
  364. package/packages/orq-rc/src/models/operations/createmoderation.ts +0 -664
  365. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -5405
  366. package/packages/orq-rc/src/models/operations/creatererank.ts +0 -890
  367. package/packages/orq-rc/src/models/operations/createresponse.ts +0 -3864
  368. package/packages/orq-rc/src/models/operations/createspeech.ts +0 -700
  369. package/packages/orq-rc/src/models/operations/createtool.ts +0 -2509
  370. package/packages/orq-rc/src/models/operations/createtranscription.ts +0 -955
  371. package/packages/orq-rc/src/models/operations/createtranslation.ts +0 -930
  372. package/packages/orq-rc/src/models/operations/deleteagent.ts +0 -39
  373. package/packages/orq-rc/src/models/operations/deleteannotation.ts +0 -82
  374. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -53
  375. package/packages/orq-rc/src/models/operations/deletechunks.ts +0 -125
  376. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -46
  377. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -39
  378. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -46
  379. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -31
  380. package/packages/orq-rc/src/models/operations/deleteidentity.ts +0 -34
  381. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -39
  382. package/packages/orq-rc/src/models/operations/deletememory.ts +0 -46
  383. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +0 -55
  384. package/packages/orq-rc/src/models/operations/deletememorystore.ts +0 -39
  385. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -34
  386. package/packages/orq-rc/src/models/operations/deletetool.ts +0 -36
  387. package/packages/orq-rc/src/models/operations/deletev2humanevalsetsid.ts +0 -36
  388. package/packages/orq-rc/src/models/operations/deletev2humanevalsid.ts +0 -67
  389. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -2370
  390. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -4526
  391. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -735
  392. package/packages/orq-rc/src/models/operations/deployments.ts +0 -1273
  393. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -4659
  394. package/packages/orq-rc/src/models/operations/filecontent.ts +0 -39
  395. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -39
  396. package/packages/orq-rc/src/models/operations/fileget.ts +0 -80
  397. package/packages/orq-rc/src/models/operations/filelist.ts +0 -85
  398. package/packages/orq-rc/src/models/operations/fileupdate.ts +0 -118
  399. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -135
  400. package/packages/orq-rc/src/models/operations/getagentresponse.ts +0 -46
  401. package/packages/orq-rc/src/models/operations/getallmemories.ts +0 -173
  402. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +0 -188
  403. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +0 -200
  404. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -3173
  405. package/packages/orq-rc/src/models/operations/getalltools.ts +0 -1404
  406. package/packages/orq-rc/src/models/operations/getchunkscount.ts +0 -121
  407. package/packages/orq-rc/src/models/operations/getevals.ts +0 -2868
  408. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -171
  409. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -652
  410. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -3098
  411. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -3143
  412. package/packages/orq-rc/src/models/operations/getv2evaluatorsidversions.ts +0 -162
  413. package/packages/orq-rc/src/models/operations/getv2humanevals.ts +0 -696
  414. package/packages/orq-rc/src/models/operations/getv2humanevalsets.ts +0 -234
  415. package/packages/orq-rc/src/models/operations/getv2humanevalsetsid.ts +0 -235
  416. package/packages/orq-rc/src/models/operations/getv2humanevalsid.ts +0 -707
  417. package/packages/orq-rc/src/models/operations/getv2toolstoolidversions.ts +0 -163
  418. package/packages/orq-rc/src/models/operations/getv2toolstoolidversionsversionid.ts +0 -110
  419. package/packages/orq-rc/src/models/operations/index.ts +0 -131
  420. package/packages/orq-rc/src/models/operations/invokeagent.ts +0 -801
  421. package/packages/orq-rc/src/models/operations/invokeeval.ts +0 -1254
  422. package/packages/orq-rc/src/models/operations/listagents.ts +0 -2781
  423. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -260
  424. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +0 -263
  425. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1498
  426. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -205
  427. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -235
  428. package/packages/orq-rc/src/models/operations/listidentities.ts +0 -275
  429. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -642
  430. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -169
  431. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -3218
  432. package/packages/orq-rc/src/models/operations/parse.ts +0 -784
  433. package/packages/orq-rc/src/models/operations/patchv2humanevalsetsid.ts +0 -415
  434. package/packages/orq-rc/src/models/operations/patchv2humanevalsid.ts +0 -1362
  435. package/packages/orq-rc/src/models/operations/postv2agentsa2a.ts +0 -255
  436. package/packages/orq-rc/src/models/operations/postv2agentskeycardrefresh.ts +0 -100
  437. package/packages/orq-rc/src/models/operations/postv2feedback.ts +0 -207
  438. package/packages/orq-rc/src/models/operations/postv2feedbackevaluation.ts +0 -321
  439. package/packages/orq-rc/src/models/operations/postv2feedbackevaluationremove.ts +0 -43
  440. package/packages/orq-rc/src/models/operations/postv2feedbackremove.ts +0 -138
  441. package/packages/orq-rc/src/models/operations/postv2humanevals.ts +0 -1193
  442. package/packages/orq-rc/src/models/operations/postv2humanevalsets.ts +0 -365
  443. package/packages/orq-rc/src/models/operations/postv2routerocr.ts +0 -478
  444. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -108
  445. package/packages/orq-rc/src/models/operations/retrieveagentrequest.ts +0 -2843
  446. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -1402
  447. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -150
  448. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -152
  449. package/packages/orq-rc/src/models/operations/retrieveidentity.ts +0 -174
  450. package/packages/orq-rc/src/models/operations/retrievememory.ts +0 -112
  451. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +0 -118
  452. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +0 -144
  453. package/packages/orq-rc/src/models/operations/retrievetool.ts +0 -1385
  454. package/packages/orq-rc/src/models/operations/runagent.ts +0 -4963
  455. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -1762
  456. package/packages/orq-rc/src/models/operations/streamagent.ts +0 -692
  457. package/packages/orq-rc/src/models/operations/streamrunagent.ts +0 -5125
  458. package/packages/orq-rc/src/models/operations/updateagent.ts +0 -6889
  459. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -236
  460. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -2555
  461. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -206
  462. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -186
  463. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -3160
  464. package/packages/orq-rc/src/models/operations/updateidentity.ts +0 -189
  465. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -1231
  466. package/packages/orq-rc/src/models/operations/updatememory.ts +0 -142
  467. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +0 -159
  468. package/packages/orq-rc/src/models/operations/updatememorystore.ts +0 -188
  469. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -5487
  470. package/packages/orq-rc/src/models/operations/updatetool.ts +0 -2816
  471. package/packages/orq-rc/src/sdk/agents.ts +0 -234
  472. package/packages/orq-rc/src/sdk/annotations.ts +0 -39
  473. package/packages/orq-rc/src/sdk/audio.ts +0 -25
  474. package/packages/orq-rc/src/sdk/chat.ts +0 -13
  475. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  476. package/packages/orq-rc/src/sdk/completions.ts +0 -32
  477. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  478. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  479. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  480. package/packages/orq-rc/src/sdk/edits.ts +0 -27
  481. package/packages/orq-rc/src/sdk/embeddings.ts +0 -27
  482. package/packages/orq-rc/src/sdk/evals.ts +0 -84
  483. package/packages/orq-rc/src/sdk/evaluators.ts +0 -27
  484. package/packages/orq-rc/src/sdk/files.ts +0 -114
  485. package/packages/orq-rc/src/sdk/generations.ts +0 -27
  486. package/packages/orq-rc/src/sdk/humanreviewsets.ts +0 -84
  487. package/packages/orq-rc/src/sdk/identities.ts +0 -99
  488. package/packages/orq-rc/src/sdk/images.ts +0 -25
  489. package/packages/orq-rc/src/sdk/index.ts +0 -5
  490. package/packages/orq-rc/src/sdk/knowledge.ts +0 -309
  491. package/packages/orq-rc/src/sdk/memorystores.ts +0 -286
  492. package/packages/orq-rc/src/sdk/metrics.ts +0 -29
  493. package/packages/orq-rc/src/sdk/models.ts +0 -27
  494. package/packages/orq-rc/src/sdk/moderations.ts +0 -24
  495. package/packages/orq-rc/src/sdk/orqcompletions.ts +0 -32
  496. package/packages/orq-rc/src/sdk/orqresponses.ts +0 -32
  497. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  498. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  499. package/packages/orq-rc/src/sdk/rerank.ts +0 -27
  500. package/packages/orq-rc/src/sdk/responses.ts +0 -53
  501. package/packages/orq-rc/src/sdk/router.ts +0 -72
  502. package/packages/orq-rc/src/sdk/sdk.ts +0 -225
  503. package/packages/orq-rc/src/sdk/speech.ts +0 -27
  504. package/packages/orq-rc/src/sdk/tools.ts +0 -135
  505. package/packages/orq-rc/src/sdk/transcriptions.ts +0 -24
  506. package/packages/orq-rc/src/sdk/translations.ts +0 -24
  507. package/packages/orq-rc/src/sdk/variations.ts +0 -27
  508. package/packages/orq-rc/src/types/async.ts +0 -68
  509. package/packages/orq-rc/src/types/blobs.ts +0 -32
  510. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  511. package/packages/orq-rc/src/types/enums.ts +0 -45
  512. package/packages/orq-rc/src/types/fp.ts +0 -50
  513. package/packages/orq-rc/src/types/index.ts +0 -11
  514. package/packages/orq-rc/src/types/operations.ts +0 -105
  515. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  516. package/packages/orq-rc/src/types/streams.ts +0 -21
  517. package/packages/orq-rc/src/types/unrecognized.ts +0 -35
@@ -1,1231 +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
- /**
13
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
14
- */
15
- export const RequestBodyRetrievalType = {
16
- VectorSearch: "vector_search",
17
- KeywordSearch: "keyword_search",
18
- HybridSearch: "hybrid_search",
19
- } as const;
20
- /**
21
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
22
- */
23
- export type RequestBodyRetrievalType = ClosedEnum<
24
- typeof RequestBodyRetrievalType
25
- >;
26
-
27
- /**
28
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
29
- */
30
- export type UpdateKnowledgeRequestBodyRerankConfig = {
31
- /**
32
- * The number of results to return by the reranking model
33
- */
34
- topK?: number | undefined;
35
- /**
36
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
37
- */
38
- rerankThreshold?: number | undefined;
39
- /**
40
- * The rerank model to use for the knowledge base.
41
- */
42
- rerankModel: string;
43
- };
44
-
45
- /**
46
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
47
- */
48
- export type UpdateKnowledgeRequestBodyAgenticRagConfig = {
49
- /**
50
- * The model to use for the Agentic RAG
51
- */
52
- model: string;
53
- };
54
-
55
- /**
56
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
57
- */
58
- export type UpdateKnowledgeRequestBodyRetrievalSettings = {
59
- /**
60
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
61
- */
62
- retrievalType?: RequestBodyRetrievalType | undefined;
63
- /**
64
- * The number of results to return from the search.
65
- */
66
- topK?: number | undefined;
67
- /**
68
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
69
- */
70
- threshold?: number | undefined;
71
- /**
72
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
73
- */
74
- rerankConfig?: UpdateKnowledgeRequestBodyRerankConfig | null | undefined;
75
- /**
76
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
77
- */
78
- agenticRagConfig?:
79
- | UpdateKnowledgeRequestBodyAgenticRagConfig
80
- | null
81
- | undefined;
82
- };
83
-
84
- export const UpdateKnowledgeRequestBodyKnowledgeType = {
85
- Internal: "internal",
86
- } as const;
87
- export type UpdateKnowledgeRequestBodyKnowledgeType = ClosedEnum<
88
- typeof UpdateKnowledgeRequestBodyKnowledgeType
89
- >;
90
-
91
- export type UpdateKnowledgeRequestBody2 = {
92
- /**
93
- * The description of the knowledge base.
94
- */
95
- description?: string | null | undefined;
96
- /**
97
- * The embeddings model used for the knowledge base. If the models is provided and is different than the previous set model, all the datasources in the knowledge base will be re-embedded.
98
- */
99
- embeddingModel?: string | undefined;
100
- /**
101
- * Entity storage path in the format: `project/folder/subfolder/...`
102
- *
103
- * @remarks
104
- *
105
- * The first element identifies the project, followed by nested folders (auto-created as needed).
106
- *
107
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
108
- */
109
- path?: string | undefined;
110
- /**
111
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
112
- */
113
- retrievalSettings?: UpdateKnowledgeRequestBodyRetrievalSettings | undefined;
114
- type?: UpdateKnowledgeRequestBodyKnowledgeType | undefined;
115
- };
116
-
117
- /**
118
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
119
- */
120
- export type RequestBodyRerankConfig = {
121
- /**
122
- * The number of results to return by the reranking model
123
- */
124
- topK?: number | undefined;
125
- /**
126
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
127
- */
128
- rerankThreshold?: number | undefined;
129
- /**
130
- * The rerank model to use for the knowledge base.
131
- */
132
- rerankModel: string;
133
- };
134
-
135
- /**
136
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
137
- */
138
- export type RequestBodyAgenticRagConfig = {
139
- /**
140
- * The model to use for the Agentic RAG
141
- */
142
- model: string;
143
- };
144
-
145
- /**
146
- * The retrieval settings for the knowledge base.
147
- */
148
- export type RequestBodyRetrievalSettings = {
149
- /**
150
- * The number of results to return from the search.
151
- */
152
- topK?: number | undefined;
153
- /**
154
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
155
- */
156
- threshold?: number | undefined;
157
- /**
158
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
159
- */
160
- rerankConfig?: RequestBodyRerankConfig | null | undefined;
161
- /**
162
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
163
- */
164
- agenticRagConfig?: RequestBodyAgenticRagConfig | null | undefined;
165
- };
166
-
167
- /**
168
- * Configuration for the external knowledge base.
169
- */
170
- export type RequestBodyExternalConfig = {
171
- /**
172
- * The name of the external knowledge base.
173
- */
174
- name?: string | undefined;
175
- /**
176
- * The API URL for the external knowledge base.
177
- */
178
- apiUrl?: string | undefined;
179
- /**
180
- * The API key for the external knowledge base.
181
- */
182
- apiKey?: string | undefined;
183
- };
184
-
185
- export const UpdateKnowledgeRequestBodyType = {
186
- External: "external",
187
- } as const;
188
- export type UpdateKnowledgeRequestBodyType = ClosedEnum<
189
- typeof UpdateKnowledgeRequestBodyType
190
- >;
191
-
192
- export type UpdateKnowledgeRequestBody1 = {
193
- /**
194
- * The description of the knowledge base.
195
- */
196
- description?: string | null | undefined;
197
- /**
198
- * Entity storage path in the format: `project/folder/subfolder/...`
199
- *
200
- * @remarks
201
- *
202
- * The first element identifies the project, followed by nested folders (auto-created as needed).
203
- *
204
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
205
- */
206
- path?: string | undefined;
207
- /**
208
- * The retrieval settings for the knowledge base.
209
- */
210
- retrievalSettings?: RequestBodyRetrievalSettings | undefined;
211
- /**
212
- * Configuration for the external knowledge base.
213
- */
214
- externalConfig?: RequestBodyExternalConfig | undefined;
215
- type?: UpdateKnowledgeRequestBodyType | undefined;
216
- };
217
-
218
- export type UpdateKnowledgeRequestBody =
219
- | UpdateKnowledgeRequestBody1
220
- | UpdateKnowledgeRequestBody2;
221
-
222
- export type UpdateKnowledgeRequest = {
223
- /**
224
- * The unique identifier of the knowledge base
225
- */
226
- knowledgeId: string;
227
- requestBody: UpdateKnowledgeRequestBody1 | UpdateKnowledgeRequestBody2;
228
- };
229
-
230
- export const UpdateKnowledgeResponseBodyKnowledgeType = {
231
- External: "external",
232
- } as const;
233
- export type UpdateKnowledgeResponseBodyKnowledgeType = ClosedEnum<
234
- typeof UpdateKnowledgeResponseBodyKnowledgeType
235
- >;
236
-
237
- /**
238
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
239
- */
240
- export type UpdateKnowledgeResponseBodyKnowledgeRerankConfig = {
241
- /**
242
- * The number of results to return by the reranking model
243
- */
244
- topK: number;
245
- /**
246
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
247
- */
248
- rerankThreshold: number;
249
- /**
250
- * The rerank model to use for the knowledge base.
251
- */
252
- rerankModel: string;
253
- };
254
-
255
- /**
256
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
257
- */
258
- export type UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig = {
259
- /**
260
- * The model to use for the Agentic RAG
261
- */
262
- model: string;
263
- };
264
-
265
- /**
266
- * The retrieval settings for the knowledge base.
267
- */
268
- export type UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings = {
269
- /**
270
- * The number of results to return from the search.
271
- */
272
- topK: number;
273
- /**
274
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
275
- */
276
- threshold: number;
277
- /**
278
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
279
- */
280
- rerankConfig?:
281
- | UpdateKnowledgeResponseBodyKnowledgeRerankConfig
282
- | null
283
- | undefined;
284
- /**
285
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
286
- */
287
- agenticRagConfig?:
288
- | UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig
289
- | null
290
- | undefined;
291
- };
292
-
293
- export type UpdateKnowledgeResponseBodyExternalConfig = {
294
- /**
295
- * The name of the external knowledge base.
296
- */
297
- name: string;
298
- /**
299
- * The API URL of the external knowledge base.
300
- */
301
- apiUrl: string;
302
- };
303
-
304
- export type UpdateKnowledgeResponseBody2 = {
305
- /**
306
- * The unique identifier of the knowledge base.
307
- */
308
- id: string;
309
- /**
310
- * The creation date of the knowledge base.
311
- */
312
- created: string;
313
- /**
314
- * The description of the knowledge base.
315
- */
316
- description?: string | undefined;
317
- /**
318
- * The unique key of the knowledge base.
319
- */
320
- key: string;
321
- /**
322
- * The project/domain ID of the knowledge base.
323
- */
324
- domainId: string;
325
- /**
326
- * Entity storage path in the format: `project/folder/subfolder/...`
327
- *
328
- * @remarks
329
- *
330
- * The first element identifies the project, followed by nested folders (auto-created as needed).
331
- *
332
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
333
- */
334
- path?: string | undefined;
335
- createdById?: string | null | undefined;
336
- updatedById?: string | null | undefined;
337
- /**
338
- * The last update date of the knowledge base.
339
- */
340
- updated: string;
341
- type: UpdateKnowledgeResponseBodyKnowledgeType;
342
- /**
343
- * The retrieval settings for the knowledge base.
344
- */
345
- retrievalSettings?:
346
- | UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings
347
- | undefined;
348
- externalConfig: UpdateKnowledgeResponseBodyExternalConfig;
349
- };
350
-
351
- export const UpdateKnowledgeResponseBodyType = {
352
- Internal: "internal",
353
- } as const;
354
- export type UpdateKnowledgeResponseBodyType = ClosedEnum<
355
- typeof UpdateKnowledgeResponseBodyType
356
- >;
357
-
358
- /**
359
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
360
- */
361
- export const UpdateKnowledgeResponseBodyRetrievalType = {
362
- VectorSearch: "vector_search",
363
- KeywordSearch: "keyword_search",
364
- HybridSearch: "hybrid_search",
365
- } as const;
366
- /**
367
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
368
- */
369
- export type UpdateKnowledgeResponseBodyRetrievalType = ClosedEnum<
370
- typeof UpdateKnowledgeResponseBodyRetrievalType
371
- >;
372
-
373
- /**
374
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
375
- */
376
- export type UpdateKnowledgeResponseBodyRerankConfig = {
377
- /**
378
- * The number of results to return by the reranking model
379
- */
380
- topK: number;
381
- /**
382
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
383
- */
384
- rerankThreshold: number;
385
- /**
386
- * The rerank model to use for the knowledge base.
387
- */
388
- rerankModel: string;
389
- };
390
-
391
- /**
392
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
393
- */
394
- export type UpdateKnowledgeResponseBodyAgenticRagConfig = {
395
- /**
396
- * The model to use for the Agentic RAG
397
- */
398
- model: string;
399
- };
400
-
401
- /**
402
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
403
- */
404
- export type UpdateKnowledgeResponseBodyRetrievalSettings = {
405
- /**
406
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
407
- */
408
- retrievalType: UpdateKnowledgeResponseBodyRetrievalType;
409
- /**
410
- * The number of results to return from the search.
411
- */
412
- topK: number;
413
- /**
414
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
415
- */
416
- threshold: number;
417
- /**
418
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
419
- */
420
- rerankConfig?: UpdateKnowledgeResponseBodyRerankConfig | null | undefined;
421
- /**
422
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
423
- */
424
- agenticRagConfig?:
425
- | UpdateKnowledgeResponseBodyAgenticRagConfig
426
- | null
427
- | undefined;
428
- };
429
-
430
- export type UpdateKnowledgeResponseBody1 = {
431
- /**
432
- * The unique identifier of the knowledge base.
433
- */
434
- id: string;
435
- /**
436
- * The creation date of the knowledge base.
437
- */
438
- created: string;
439
- /**
440
- * The description of the knowledge base.
441
- */
442
- description?: string | undefined;
443
- /**
444
- * The unique key of the knowledge base.
445
- */
446
- key: string;
447
- /**
448
- * The project/domain ID of the knowledge base.
449
- */
450
- domainId: string;
451
- /**
452
- * Entity storage path in the format: `project/folder/subfolder/...`
453
- *
454
- * @remarks
455
- *
456
- * The first element identifies the project, followed by nested folders (auto-created as needed).
457
- *
458
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
459
- */
460
- path?: string | undefined;
461
- createdById?: string | null | undefined;
462
- updatedById?: string | null | undefined;
463
- /**
464
- * The last update date of the knowledge base.
465
- */
466
- updated: string;
467
- type: UpdateKnowledgeResponseBodyType;
468
- /**
469
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
470
- */
471
- retrievalSettings?: UpdateKnowledgeResponseBodyRetrievalSettings | undefined;
472
- /**
473
- * The embeddings model used for the knowledge base.
474
- */
475
- model: string;
476
- };
477
-
478
- /**
479
- * Knowledge successfully updated
480
- */
481
- export type UpdateKnowledgeResponseBody =
482
- | UpdateKnowledgeResponseBody1
483
- | UpdateKnowledgeResponseBody2;
484
-
485
- /** @internal */
486
- export const RequestBodyRetrievalType$outboundSchema: z.ZodNativeEnum<
487
- typeof RequestBodyRetrievalType
488
- > = z.nativeEnum(RequestBodyRetrievalType);
489
-
490
- /** @internal */
491
- export type UpdateKnowledgeRequestBodyRerankConfig$Outbound = {
492
- top_k: number;
493
- rerank_threshold: number;
494
- rerank_model: string;
495
- };
496
-
497
- /** @internal */
498
- export const UpdateKnowledgeRequestBodyRerankConfig$outboundSchema: z.ZodType<
499
- UpdateKnowledgeRequestBodyRerankConfig$Outbound,
500
- z.ZodTypeDef,
501
- UpdateKnowledgeRequestBodyRerankConfig
502
- > = z.object({
503
- topK: z.number().int().default(5),
504
- rerankThreshold: z.number().default(0.5),
505
- rerankModel: z.string(),
506
- }).transform((v) => {
507
- return remap$(v, {
508
- topK: "top_k",
509
- rerankThreshold: "rerank_threshold",
510
- rerankModel: "rerank_model",
511
- });
512
- });
513
-
514
- export function updateKnowledgeRequestBodyRerankConfigToJSON(
515
- updateKnowledgeRequestBodyRerankConfig:
516
- UpdateKnowledgeRequestBodyRerankConfig,
517
- ): string {
518
- return JSON.stringify(
519
- UpdateKnowledgeRequestBodyRerankConfig$outboundSchema.parse(
520
- updateKnowledgeRequestBodyRerankConfig,
521
- ),
522
- );
523
- }
524
-
525
- /** @internal */
526
- export type UpdateKnowledgeRequestBodyAgenticRagConfig$Outbound = {
527
- model: string;
528
- };
529
-
530
- /** @internal */
531
- export const UpdateKnowledgeRequestBodyAgenticRagConfig$outboundSchema:
532
- z.ZodType<
533
- UpdateKnowledgeRequestBodyAgenticRagConfig$Outbound,
534
- z.ZodTypeDef,
535
- UpdateKnowledgeRequestBodyAgenticRagConfig
536
- > = z.object({
537
- model: z.string(),
538
- });
539
-
540
- export function updateKnowledgeRequestBodyAgenticRagConfigToJSON(
541
- updateKnowledgeRequestBodyAgenticRagConfig:
542
- UpdateKnowledgeRequestBodyAgenticRagConfig,
543
- ): string {
544
- return JSON.stringify(
545
- UpdateKnowledgeRequestBodyAgenticRagConfig$outboundSchema.parse(
546
- updateKnowledgeRequestBodyAgenticRagConfig,
547
- ),
548
- );
549
- }
550
-
551
- /** @internal */
552
- export type UpdateKnowledgeRequestBodyRetrievalSettings$Outbound = {
553
- retrieval_type: string;
554
- top_k: number;
555
- threshold: number;
556
- rerank_config?:
557
- | UpdateKnowledgeRequestBodyRerankConfig$Outbound
558
- | null
559
- | undefined;
560
- agentic_rag_config?:
561
- | UpdateKnowledgeRequestBodyAgenticRagConfig$Outbound
562
- | null
563
- | undefined;
564
- };
565
-
566
- /** @internal */
567
- export const UpdateKnowledgeRequestBodyRetrievalSettings$outboundSchema:
568
- z.ZodType<
569
- UpdateKnowledgeRequestBodyRetrievalSettings$Outbound,
570
- z.ZodTypeDef,
571
- UpdateKnowledgeRequestBodyRetrievalSettings
572
- > = z.object({
573
- retrievalType: RequestBodyRetrievalType$outboundSchema.default(
574
- "hybrid_search",
575
- ),
576
- topK: z.number().int().default(5),
577
- threshold: z.number().default(0),
578
- rerankConfig: z.nullable(
579
- z.lazy(() => UpdateKnowledgeRequestBodyRerankConfig$outboundSchema),
580
- ).optional(),
581
- agenticRagConfig: z.nullable(
582
- z.lazy(() => UpdateKnowledgeRequestBodyAgenticRagConfig$outboundSchema),
583
- ).optional(),
584
- }).transform((v) => {
585
- return remap$(v, {
586
- retrievalType: "retrieval_type",
587
- topK: "top_k",
588
- rerankConfig: "rerank_config",
589
- agenticRagConfig: "agentic_rag_config",
590
- });
591
- });
592
-
593
- export function updateKnowledgeRequestBodyRetrievalSettingsToJSON(
594
- updateKnowledgeRequestBodyRetrievalSettings:
595
- UpdateKnowledgeRequestBodyRetrievalSettings,
596
- ): string {
597
- return JSON.stringify(
598
- UpdateKnowledgeRequestBodyRetrievalSettings$outboundSchema.parse(
599
- updateKnowledgeRequestBodyRetrievalSettings,
600
- ),
601
- );
602
- }
603
-
604
- /** @internal */
605
- export const UpdateKnowledgeRequestBodyKnowledgeType$outboundSchema:
606
- z.ZodNativeEnum<typeof UpdateKnowledgeRequestBodyKnowledgeType> = z
607
- .nativeEnum(UpdateKnowledgeRequestBodyKnowledgeType);
608
-
609
- /** @internal */
610
- export type UpdateKnowledgeRequestBody2$Outbound = {
611
- description?: string | null | undefined;
612
- embedding_model?: string | undefined;
613
- path?: string | undefined;
614
- retrieval_settings?:
615
- | UpdateKnowledgeRequestBodyRetrievalSettings$Outbound
616
- | undefined;
617
- type: string;
618
- };
619
-
620
- /** @internal */
621
- export const UpdateKnowledgeRequestBody2$outboundSchema: z.ZodType<
622
- UpdateKnowledgeRequestBody2$Outbound,
623
- z.ZodTypeDef,
624
- UpdateKnowledgeRequestBody2
625
- > = z.object({
626
- description: z.nullable(z.string()).optional(),
627
- embeddingModel: z.string().optional(),
628
- path: z.string().optional(),
629
- retrievalSettings: z.lazy(() =>
630
- UpdateKnowledgeRequestBodyRetrievalSettings$outboundSchema
631
- ).optional(),
632
- type: UpdateKnowledgeRequestBodyKnowledgeType$outboundSchema.default(
633
- "internal",
634
- ),
635
- }).transform((v) => {
636
- return remap$(v, {
637
- embeddingModel: "embedding_model",
638
- retrievalSettings: "retrieval_settings",
639
- });
640
- });
641
-
642
- export function updateKnowledgeRequestBody2ToJSON(
643
- updateKnowledgeRequestBody2: UpdateKnowledgeRequestBody2,
644
- ): string {
645
- return JSON.stringify(
646
- UpdateKnowledgeRequestBody2$outboundSchema.parse(
647
- updateKnowledgeRequestBody2,
648
- ),
649
- );
650
- }
651
-
652
- /** @internal */
653
- export type RequestBodyRerankConfig$Outbound = {
654
- top_k: number;
655
- rerank_threshold: number;
656
- rerank_model: string;
657
- };
658
-
659
- /** @internal */
660
- export const RequestBodyRerankConfig$outboundSchema: z.ZodType<
661
- RequestBodyRerankConfig$Outbound,
662
- z.ZodTypeDef,
663
- RequestBodyRerankConfig
664
- > = z.object({
665
- topK: z.number().int().default(5),
666
- rerankThreshold: z.number().default(0.5),
667
- rerankModel: z.string(),
668
- }).transform((v) => {
669
- return remap$(v, {
670
- topK: "top_k",
671
- rerankThreshold: "rerank_threshold",
672
- rerankModel: "rerank_model",
673
- });
674
- });
675
-
676
- export function requestBodyRerankConfigToJSON(
677
- requestBodyRerankConfig: RequestBodyRerankConfig,
678
- ): string {
679
- return JSON.stringify(
680
- RequestBodyRerankConfig$outboundSchema.parse(requestBodyRerankConfig),
681
- );
682
- }
683
-
684
- /** @internal */
685
- export type RequestBodyAgenticRagConfig$Outbound = {
686
- model: string;
687
- };
688
-
689
- /** @internal */
690
- export const RequestBodyAgenticRagConfig$outboundSchema: z.ZodType<
691
- RequestBodyAgenticRagConfig$Outbound,
692
- z.ZodTypeDef,
693
- RequestBodyAgenticRagConfig
694
- > = z.object({
695
- model: z.string(),
696
- });
697
-
698
- export function requestBodyAgenticRagConfigToJSON(
699
- requestBodyAgenticRagConfig: RequestBodyAgenticRagConfig,
700
- ): string {
701
- return JSON.stringify(
702
- RequestBodyAgenticRagConfig$outboundSchema.parse(
703
- requestBodyAgenticRagConfig,
704
- ),
705
- );
706
- }
707
-
708
- /** @internal */
709
- export type RequestBodyRetrievalSettings$Outbound = {
710
- top_k: number;
711
- threshold: number;
712
- rerank_config?: RequestBodyRerankConfig$Outbound | null | undefined;
713
- agentic_rag_config?: RequestBodyAgenticRagConfig$Outbound | null | undefined;
714
- };
715
-
716
- /** @internal */
717
- export const RequestBodyRetrievalSettings$outboundSchema: z.ZodType<
718
- RequestBodyRetrievalSettings$Outbound,
719
- z.ZodTypeDef,
720
- RequestBodyRetrievalSettings
721
- > = z.object({
722
- topK: z.number().int().default(5),
723
- threshold: z.number().default(0),
724
- rerankConfig: z.nullable(z.lazy(() => RequestBodyRerankConfig$outboundSchema))
725
- .optional(),
726
- agenticRagConfig: z.nullable(
727
- z.lazy(() => RequestBodyAgenticRagConfig$outboundSchema),
728
- ).optional(),
729
- }).transform((v) => {
730
- return remap$(v, {
731
- topK: "top_k",
732
- rerankConfig: "rerank_config",
733
- agenticRagConfig: "agentic_rag_config",
734
- });
735
- });
736
-
737
- export function requestBodyRetrievalSettingsToJSON(
738
- requestBodyRetrievalSettings: RequestBodyRetrievalSettings,
739
- ): string {
740
- return JSON.stringify(
741
- RequestBodyRetrievalSettings$outboundSchema.parse(
742
- requestBodyRetrievalSettings,
743
- ),
744
- );
745
- }
746
-
747
- /** @internal */
748
- export type RequestBodyExternalConfig$Outbound = {
749
- name?: string | undefined;
750
- api_url?: string | undefined;
751
- api_key?: string | undefined;
752
- };
753
-
754
- /** @internal */
755
- export const RequestBodyExternalConfig$outboundSchema: z.ZodType<
756
- RequestBodyExternalConfig$Outbound,
757
- z.ZodTypeDef,
758
- RequestBodyExternalConfig
759
- > = z.object({
760
- name: z.string().optional(),
761
- apiUrl: z.string().optional(),
762
- apiKey: z.string().optional(),
763
- }).transform((v) => {
764
- return remap$(v, {
765
- apiUrl: "api_url",
766
- apiKey: "api_key",
767
- });
768
- });
769
-
770
- export function requestBodyExternalConfigToJSON(
771
- requestBodyExternalConfig: RequestBodyExternalConfig,
772
- ): string {
773
- return JSON.stringify(
774
- RequestBodyExternalConfig$outboundSchema.parse(requestBodyExternalConfig),
775
- );
776
- }
777
-
778
- /** @internal */
779
- export const UpdateKnowledgeRequestBodyType$outboundSchema: z.ZodNativeEnum<
780
- typeof UpdateKnowledgeRequestBodyType
781
- > = z.nativeEnum(UpdateKnowledgeRequestBodyType);
782
-
783
- /** @internal */
784
- export type UpdateKnowledgeRequestBody1$Outbound = {
785
- description?: string | null | undefined;
786
- path?: string | undefined;
787
- retrieval_settings?: RequestBodyRetrievalSettings$Outbound | undefined;
788
- external_config?: RequestBodyExternalConfig$Outbound | undefined;
789
- type: string;
790
- };
791
-
792
- /** @internal */
793
- export const UpdateKnowledgeRequestBody1$outboundSchema: z.ZodType<
794
- UpdateKnowledgeRequestBody1$Outbound,
795
- z.ZodTypeDef,
796
- UpdateKnowledgeRequestBody1
797
- > = z.object({
798
- description: z.nullable(z.string()).optional(),
799
- path: z.string().optional(),
800
- retrievalSettings: z.lazy(() => RequestBodyRetrievalSettings$outboundSchema)
801
- .optional(),
802
- externalConfig: z.lazy(() => RequestBodyExternalConfig$outboundSchema)
803
- .optional(),
804
- type: UpdateKnowledgeRequestBodyType$outboundSchema.default("external"),
805
- }).transform((v) => {
806
- return remap$(v, {
807
- retrievalSettings: "retrieval_settings",
808
- externalConfig: "external_config",
809
- });
810
- });
811
-
812
- export function updateKnowledgeRequestBody1ToJSON(
813
- updateKnowledgeRequestBody1: UpdateKnowledgeRequestBody1,
814
- ): string {
815
- return JSON.stringify(
816
- UpdateKnowledgeRequestBody1$outboundSchema.parse(
817
- updateKnowledgeRequestBody1,
818
- ),
819
- );
820
- }
821
-
822
- /** @internal */
823
- export type UpdateKnowledgeRequestBody$Outbound =
824
- | UpdateKnowledgeRequestBody1$Outbound
825
- | UpdateKnowledgeRequestBody2$Outbound;
826
-
827
- /** @internal */
828
- export const UpdateKnowledgeRequestBody$outboundSchema: z.ZodType<
829
- UpdateKnowledgeRequestBody$Outbound,
830
- z.ZodTypeDef,
831
- UpdateKnowledgeRequestBody
832
- > = z.union([
833
- z.lazy(() => UpdateKnowledgeRequestBody1$outboundSchema),
834
- z.lazy(() => UpdateKnowledgeRequestBody2$outboundSchema),
835
- ]);
836
-
837
- export function updateKnowledgeRequestBodyToJSON(
838
- updateKnowledgeRequestBody: UpdateKnowledgeRequestBody,
839
- ): string {
840
- return JSON.stringify(
841
- UpdateKnowledgeRequestBody$outboundSchema.parse(updateKnowledgeRequestBody),
842
- );
843
- }
844
-
845
- /** @internal */
846
- export type UpdateKnowledgeRequest$Outbound = {
847
- knowledge_id: string;
848
- RequestBody:
849
- | UpdateKnowledgeRequestBody1$Outbound
850
- | UpdateKnowledgeRequestBody2$Outbound;
851
- };
852
-
853
- /** @internal */
854
- export const UpdateKnowledgeRequest$outboundSchema: z.ZodType<
855
- UpdateKnowledgeRequest$Outbound,
856
- z.ZodTypeDef,
857
- UpdateKnowledgeRequest
858
- > = z.object({
859
- knowledgeId: z.string(),
860
- requestBody: z.union([
861
- z.lazy(() => UpdateKnowledgeRequestBody1$outboundSchema),
862
- z.lazy(() => UpdateKnowledgeRequestBody2$outboundSchema),
863
- ]),
864
- }).transform((v) => {
865
- return remap$(v, {
866
- knowledgeId: "knowledge_id",
867
- requestBody: "RequestBody",
868
- });
869
- });
870
-
871
- export function updateKnowledgeRequestToJSON(
872
- updateKnowledgeRequest: UpdateKnowledgeRequest,
873
- ): string {
874
- return JSON.stringify(
875
- UpdateKnowledgeRequest$outboundSchema.parse(updateKnowledgeRequest),
876
- );
877
- }
878
-
879
- /** @internal */
880
- export const UpdateKnowledgeResponseBodyKnowledgeType$inboundSchema:
881
- z.ZodNativeEnum<typeof UpdateKnowledgeResponseBodyKnowledgeType> = z
882
- .nativeEnum(UpdateKnowledgeResponseBodyKnowledgeType);
883
-
884
- /** @internal */
885
- export const UpdateKnowledgeResponseBodyKnowledgeRerankConfig$inboundSchema:
886
- z.ZodType<
887
- UpdateKnowledgeResponseBodyKnowledgeRerankConfig,
888
- z.ZodTypeDef,
889
- unknown
890
- > = z.object({
891
- top_k: z.number().int().default(5),
892
- rerank_threshold: z.number().default(0.5),
893
- rerank_model: z.string(),
894
- }).transform((v) => {
895
- return remap$(v, {
896
- "top_k": "topK",
897
- "rerank_threshold": "rerankThreshold",
898
- "rerank_model": "rerankModel",
899
- });
900
- });
901
-
902
- export function updateKnowledgeResponseBodyKnowledgeRerankConfigFromJSON(
903
- jsonString: string,
904
- ): SafeParseResult<
905
- UpdateKnowledgeResponseBodyKnowledgeRerankConfig,
906
- SDKValidationError
907
- > {
908
- return safeParse(
909
- jsonString,
910
- (x) =>
911
- UpdateKnowledgeResponseBodyKnowledgeRerankConfig$inboundSchema.parse(
912
- JSON.parse(x),
913
- ),
914
- `Failed to parse 'UpdateKnowledgeResponseBodyKnowledgeRerankConfig' from JSON`,
915
- );
916
- }
917
-
918
- /** @internal */
919
- export const UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig$inboundSchema:
920
- z.ZodType<
921
- UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig,
922
- z.ZodTypeDef,
923
- unknown
924
- > = z.object({
925
- model: z.string(),
926
- });
927
-
928
- export function updateKnowledgeResponseBodyKnowledgeAgenticRagConfigFromJSON(
929
- jsonString: string,
930
- ): SafeParseResult<
931
- UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig,
932
- SDKValidationError
933
- > {
934
- return safeParse(
935
- jsonString,
936
- (x) =>
937
- UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig$inboundSchema.parse(
938
- JSON.parse(x),
939
- ),
940
- `Failed to parse 'UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig' from JSON`,
941
- );
942
- }
943
-
944
- /** @internal */
945
- export const UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings$inboundSchema:
946
- z.ZodType<
947
- UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings,
948
- z.ZodTypeDef,
949
- unknown
950
- > = z.object({
951
- top_k: z.number().int().default(5),
952
- threshold: z.number().default(0),
953
- rerank_config: z.nullable(
954
- z.lazy(() =>
955
- UpdateKnowledgeResponseBodyKnowledgeRerankConfig$inboundSchema
956
- ),
957
- ).optional(),
958
- agentic_rag_config: z.nullable(
959
- z.lazy(() =>
960
- UpdateKnowledgeResponseBodyKnowledgeAgenticRagConfig$inboundSchema
961
- ),
962
- ).optional(),
963
- }).transform((v) => {
964
- return remap$(v, {
965
- "top_k": "topK",
966
- "rerank_config": "rerankConfig",
967
- "agentic_rag_config": "agenticRagConfig",
968
- });
969
- });
970
-
971
- export function updateKnowledgeResponseBodyKnowledgeRetrievalSettingsFromJSON(
972
- jsonString: string,
973
- ): SafeParseResult<
974
- UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings,
975
- SDKValidationError
976
- > {
977
- return safeParse(
978
- jsonString,
979
- (x) =>
980
- UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings$inboundSchema.parse(
981
- JSON.parse(x),
982
- ),
983
- `Failed to parse 'UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings' from JSON`,
984
- );
985
- }
986
-
987
- /** @internal */
988
- export const UpdateKnowledgeResponseBodyExternalConfig$inboundSchema: z.ZodType<
989
- UpdateKnowledgeResponseBodyExternalConfig,
990
- z.ZodTypeDef,
991
- unknown
992
- > = z.object({
993
- name: z.string(),
994
- api_url: z.string(),
995
- }).transform((v) => {
996
- return remap$(v, {
997
- "api_url": "apiUrl",
998
- });
999
- });
1000
-
1001
- export function updateKnowledgeResponseBodyExternalConfigFromJSON(
1002
- jsonString: string,
1003
- ): SafeParseResult<
1004
- UpdateKnowledgeResponseBodyExternalConfig,
1005
- SDKValidationError
1006
- > {
1007
- return safeParse(
1008
- jsonString,
1009
- (x) =>
1010
- UpdateKnowledgeResponseBodyExternalConfig$inboundSchema.parse(
1011
- JSON.parse(x),
1012
- ),
1013
- `Failed to parse 'UpdateKnowledgeResponseBodyExternalConfig' from JSON`,
1014
- );
1015
- }
1016
-
1017
- /** @internal */
1018
- export const UpdateKnowledgeResponseBody2$inboundSchema: z.ZodType<
1019
- UpdateKnowledgeResponseBody2,
1020
- z.ZodTypeDef,
1021
- unknown
1022
- > = z.object({
1023
- _id: z.string(),
1024
- created: z.string(),
1025
- description: z.string().optional(),
1026
- key: z.string(),
1027
- domain_id: z.string(),
1028
- path: z.string().optional(),
1029
- created_by_id: z.nullable(z.string()).optional(),
1030
- updated_by_id: z.nullable(z.string()).optional(),
1031
- updated: z.string(),
1032
- type: UpdateKnowledgeResponseBodyKnowledgeType$inboundSchema.default(
1033
- "external",
1034
- ),
1035
- retrieval_settings: z.lazy(() =>
1036
- UpdateKnowledgeResponseBodyKnowledgeRetrievalSettings$inboundSchema
1037
- ).optional(),
1038
- external_config: z.lazy(() =>
1039
- UpdateKnowledgeResponseBodyExternalConfig$inboundSchema
1040
- ),
1041
- }).transform((v) => {
1042
- return remap$(v, {
1043
- "_id": "id",
1044
- "domain_id": "domainId",
1045
- "created_by_id": "createdById",
1046
- "updated_by_id": "updatedById",
1047
- "retrieval_settings": "retrievalSettings",
1048
- "external_config": "externalConfig",
1049
- });
1050
- });
1051
-
1052
- export function updateKnowledgeResponseBody2FromJSON(
1053
- jsonString: string,
1054
- ): SafeParseResult<UpdateKnowledgeResponseBody2, SDKValidationError> {
1055
- return safeParse(
1056
- jsonString,
1057
- (x) => UpdateKnowledgeResponseBody2$inboundSchema.parse(JSON.parse(x)),
1058
- `Failed to parse 'UpdateKnowledgeResponseBody2' from JSON`,
1059
- );
1060
- }
1061
-
1062
- /** @internal */
1063
- export const UpdateKnowledgeResponseBodyType$inboundSchema: z.ZodNativeEnum<
1064
- typeof UpdateKnowledgeResponseBodyType
1065
- > = z.nativeEnum(UpdateKnowledgeResponseBodyType);
1066
-
1067
- /** @internal */
1068
- export const UpdateKnowledgeResponseBodyRetrievalType$inboundSchema:
1069
- z.ZodNativeEnum<typeof UpdateKnowledgeResponseBodyRetrievalType> = z
1070
- .nativeEnum(UpdateKnowledgeResponseBodyRetrievalType);
1071
-
1072
- /** @internal */
1073
- export const UpdateKnowledgeResponseBodyRerankConfig$inboundSchema: z.ZodType<
1074
- UpdateKnowledgeResponseBodyRerankConfig,
1075
- z.ZodTypeDef,
1076
- unknown
1077
- > = z.object({
1078
- top_k: z.number().int().default(5),
1079
- rerank_threshold: z.number().default(0.5),
1080
- rerank_model: z.string(),
1081
- }).transform((v) => {
1082
- return remap$(v, {
1083
- "top_k": "topK",
1084
- "rerank_threshold": "rerankThreshold",
1085
- "rerank_model": "rerankModel",
1086
- });
1087
- });
1088
-
1089
- export function updateKnowledgeResponseBodyRerankConfigFromJSON(
1090
- jsonString: string,
1091
- ): SafeParseResult<
1092
- UpdateKnowledgeResponseBodyRerankConfig,
1093
- SDKValidationError
1094
- > {
1095
- return safeParse(
1096
- jsonString,
1097
- (x) =>
1098
- UpdateKnowledgeResponseBodyRerankConfig$inboundSchema.parse(
1099
- JSON.parse(x),
1100
- ),
1101
- `Failed to parse 'UpdateKnowledgeResponseBodyRerankConfig' from JSON`,
1102
- );
1103
- }
1104
-
1105
- /** @internal */
1106
- export const UpdateKnowledgeResponseBodyAgenticRagConfig$inboundSchema:
1107
- z.ZodType<
1108
- UpdateKnowledgeResponseBodyAgenticRagConfig,
1109
- z.ZodTypeDef,
1110
- unknown
1111
- > = z.object({
1112
- model: z.string(),
1113
- });
1114
-
1115
- export function updateKnowledgeResponseBodyAgenticRagConfigFromJSON(
1116
- jsonString: string,
1117
- ): SafeParseResult<
1118
- UpdateKnowledgeResponseBodyAgenticRagConfig,
1119
- SDKValidationError
1120
- > {
1121
- return safeParse(
1122
- jsonString,
1123
- (x) =>
1124
- UpdateKnowledgeResponseBodyAgenticRagConfig$inboundSchema.parse(
1125
- JSON.parse(x),
1126
- ),
1127
- `Failed to parse 'UpdateKnowledgeResponseBodyAgenticRagConfig' from JSON`,
1128
- );
1129
- }
1130
-
1131
- /** @internal */
1132
- export const UpdateKnowledgeResponseBodyRetrievalSettings$inboundSchema:
1133
- z.ZodType<
1134
- UpdateKnowledgeResponseBodyRetrievalSettings,
1135
- z.ZodTypeDef,
1136
- unknown
1137
- > = z.object({
1138
- retrieval_type: UpdateKnowledgeResponseBodyRetrievalType$inboundSchema
1139
- .default("hybrid_search"),
1140
- top_k: z.number().int().default(5),
1141
- threshold: z.number().default(0),
1142
- rerank_config: z.nullable(
1143
- z.lazy(() => UpdateKnowledgeResponseBodyRerankConfig$inboundSchema),
1144
- ).optional(),
1145
- agentic_rag_config: z.nullable(
1146
- z.lazy(() => UpdateKnowledgeResponseBodyAgenticRagConfig$inboundSchema),
1147
- ).optional(),
1148
- }).transform((v) => {
1149
- return remap$(v, {
1150
- "retrieval_type": "retrievalType",
1151
- "top_k": "topK",
1152
- "rerank_config": "rerankConfig",
1153
- "agentic_rag_config": "agenticRagConfig",
1154
- });
1155
- });
1156
-
1157
- export function updateKnowledgeResponseBodyRetrievalSettingsFromJSON(
1158
- jsonString: string,
1159
- ): SafeParseResult<
1160
- UpdateKnowledgeResponseBodyRetrievalSettings,
1161
- SDKValidationError
1162
- > {
1163
- return safeParse(
1164
- jsonString,
1165
- (x) =>
1166
- UpdateKnowledgeResponseBodyRetrievalSettings$inboundSchema.parse(
1167
- JSON.parse(x),
1168
- ),
1169
- `Failed to parse 'UpdateKnowledgeResponseBodyRetrievalSettings' from JSON`,
1170
- );
1171
- }
1172
-
1173
- /** @internal */
1174
- export const UpdateKnowledgeResponseBody1$inboundSchema: z.ZodType<
1175
- UpdateKnowledgeResponseBody1,
1176
- z.ZodTypeDef,
1177
- unknown
1178
- > = z.object({
1179
- _id: z.string(),
1180
- created: z.string(),
1181
- description: z.string().optional(),
1182
- key: z.string(),
1183
- domain_id: z.string(),
1184
- path: z.string().optional(),
1185
- created_by_id: z.nullable(z.string()).optional(),
1186
- updated_by_id: z.nullable(z.string()).optional(),
1187
- updated: z.string(),
1188
- type: UpdateKnowledgeResponseBodyType$inboundSchema.default("internal"),
1189
- retrieval_settings: z.lazy(() =>
1190
- UpdateKnowledgeResponseBodyRetrievalSettings$inboundSchema
1191
- ).optional(),
1192
- model: z.string(),
1193
- }).transform((v) => {
1194
- return remap$(v, {
1195
- "_id": "id",
1196
- "domain_id": "domainId",
1197
- "created_by_id": "createdById",
1198
- "updated_by_id": "updatedById",
1199
- "retrieval_settings": "retrievalSettings",
1200
- });
1201
- });
1202
-
1203
- export function updateKnowledgeResponseBody1FromJSON(
1204
- jsonString: string,
1205
- ): SafeParseResult<UpdateKnowledgeResponseBody1, SDKValidationError> {
1206
- return safeParse(
1207
- jsonString,
1208
- (x) => UpdateKnowledgeResponseBody1$inboundSchema.parse(JSON.parse(x)),
1209
- `Failed to parse 'UpdateKnowledgeResponseBody1' from JSON`,
1210
- );
1211
- }
1212
-
1213
- /** @internal */
1214
- export const UpdateKnowledgeResponseBody$inboundSchema: z.ZodType<
1215
- UpdateKnowledgeResponseBody,
1216
- z.ZodTypeDef,
1217
- unknown
1218
- > = z.union([
1219
- z.lazy(() => UpdateKnowledgeResponseBody1$inboundSchema),
1220
- z.lazy(() => UpdateKnowledgeResponseBody2$inboundSchema),
1221
- ]);
1222
-
1223
- export function updateKnowledgeResponseBodyFromJSON(
1224
- jsonString: string,
1225
- ): SafeParseResult<UpdateKnowledgeResponseBody, SDKValidationError> {
1226
- return safeParse(
1227
- jsonString,
1228
- (x) => UpdateKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
1229
- `Failed to parse 'UpdateKnowledgeResponseBody' from JSON`,
1230
- );
1231
- }