@orq-ai/node 4.7.0-rc.58 → 4.7.3

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