@orq-ai/node 3.14.5-rc.1 → 3.14.6

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 (494) hide show
  1. package/bin/mcp-server.js +213 -210
  2. package/bin/mcp-server.js.map +38 -38
  3. package/docs/sdks/agents/README.md +4 -8
  4. package/docs/sdks/budgets/README.md +2 -4
  5. package/docs/sdks/tools/README.md +2 -4
  6. package/examples/package-lock.json +6 -5
  7. package/jsr.json +1 -1
  8. package/lib/config.d.ts +2 -2
  9. package/lib/config.js +2 -2
  10. package/lib/config.js.map +1 -1
  11. package/mcp-server/mcp-server.js +1 -1
  12. package/mcp-server/mcp-server.js.map +1 -1
  13. package/mcp-server/server.js +1 -1
  14. package/mcp-server/server.js.map +1 -1
  15. package/models/operations/createbudget.js +2 -2
  16. package/models/operations/createcontact.js +2 -2
  17. package/models/operations/createdataset.js +2 -2
  18. package/models/operations/createdatasetitem.js +8 -8
  19. package/models/operations/createdatasource.js +2 -2
  20. package/models/operations/createeval.js +28 -28
  21. package/models/operations/createtool.js +10 -10
  22. package/models/operations/duplicatetool.js +10 -10
  23. package/models/operations/fileget.js +2 -2
  24. package/models/operations/filelist.js +2 -2
  25. package/models/operations/fileupload.js +2 -2
  26. package/models/operations/getalltools.js +10 -10
  27. package/models/operations/getbudget.js +2 -2
  28. package/models/operations/getevals.js +28 -28
  29. package/models/operations/listbudgets.js +2 -2
  30. package/models/operations/listcontacts.js +2 -2
  31. package/models/operations/listdatasetdatapoints.js +8 -8
  32. package/models/operations/listdatasets.js +2 -2
  33. package/models/operations/listdatasources.js +2 -2
  34. package/models/operations/retrievecontact.js +2 -2
  35. package/models/operations/retrievedatapoint.js +8 -8
  36. package/models/operations/retrievedataset.js +2 -2
  37. package/models/operations/retrievedatasource.js +2 -2
  38. package/models/operations/retrievetool.js +10 -10
  39. package/models/operations/updatebudget.js +2 -2
  40. package/models/operations/updatecontact.js +2 -2
  41. package/models/operations/updatedatapoint.js +8 -8
  42. package/models/operations/updatedataset.js +2 -2
  43. package/models/operations/updatedatasource.js +2 -2
  44. package/models/operations/updateeval.js +28 -28
  45. package/models/operations/updatetool.js +10 -10
  46. package/package.json +4 -4
  47. package/packages/orq-rc/FUNCTIONS.md +103 -0
  48. package/packages/orq-rc/README.md +909 -0
  49. package/packages/orq-rc/RUNTIMES.md +48 -0
  50. package/packages/orq-rc/docs/sdks/agents/README.md +1319 -0
  51. package/packages/orq-rc/docs/sdks/budgets/README.md +401 -0
  52. package/packages/orq-rc/docs/sdks/chunking/README.md +95 -0
  53. package/packages/orq-rc/docs/sdks/contacts/README.md +450 -0
  54. package/packages/orq-rc/docs/sdks/datasets/README.md +836 -0
  55. package/packages/orq-rc/docs/sdks/deployments/README.md +312 -0
  56. package/packages/orq-rc/docs/sdks/evals/README.md +339 -0
  57. package/packages/orq-rc/docs/sdks/feedback/README.md +89 -0
  58. package/packages/orq-rc/docs/sdks/files/README.md +301 -0
  59. package/packages/orq-rc/docs/sdks/knowledge/README.md +1489 -0
  60. package/packages/orq-rc/docs/sdks/memorystores/README.md +1172 -0
  61. package/packages/orq-rc/docs/sdks/metrics/README.md +83 -0
  62. package/packages/orq-rc/docs/sdks/models/README.md +76 -0
  63. package/packages/orq-rc/docs/sdks/prompts/README.md +591 -0
  64. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +77 -0
  65. package/packages/orq-rc/docs/sdks/tools/README.md +490 -0
  66. package/packages/orq-rc/examples/README.md +31 -0
  67. package/packages/orq-rc/examples/contactsCreate.example.ts +42 -0
  68. package/packages/orq-rc/examples/package-lock.json +627 -0
  69. package/packages/orq-rc/examples/package.json +18 -0
  70. package/packages/orq-rc/jsr.json +28 -0
  71. package/packages/orq-rc/package-lock.json +3071 -0
  72. package/packages/orq-rc/package.json +43 -0
  73. package/packages/orq-rc/src/core.ts +13 -0
  74. package/packages/orq-rc/src/funcs/agentsCreate.ts +172 -0
  75. package/packages/orq-rc/src/funcs/agentsDelete.ts +176 -0
  76. package/packages/orq-rc/src/funcs/agentsInvoke.ts +167 -0
  77. package/packages/orq-rc/src/funcs/agentsList.ts +167 -0
  78. package/packages/orq-rc/src/funcs/agentsListActions.ts +169 -0
  79. package/packages/orq-rc/src/funcs/agentsListTasks.ts +183 -0
  80. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +175 -0
  81. package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +173 -0
  82. package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +179 -0
  83. package/packages/orq-rc/src/funcs/agentsRun.ts +163 -0
  84. package/packages/orq-rc/src/funcs/agentsStream.ts +190 -0
  85. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +188 -0
  86. package/packages/orq-rc/src/funcs/agentsUpdate.ts +176 -0
  87. package/packages/orq-rc/src/funcs/budgetsCreate.ts +160 -0
  88. package/packages/orq-rc/src/funcs/budgetsDelete.ts +167 -0
  89. package/packages/orq-rc/src/funcs/budgetsGet.ts +166 -0
  90. package/packages/orq-rc/src/funcs/budgetsList.ts +170 -0
  91. package/packages/orq-rc/src/funcs/budgetsUpdate.ts +167 -0
  92. package/packages/orq-rc/src/funcs/chunkingParse.ts +160 -0
  93. package/packages/orq-rc/src/funcs/contactsCreate.ts +165 -0
  94. package/packages/orq-rc/src/funcs/contactsDelete.ts +176 -0
  95. package/packages/orq-rc/src/funcs/contactsList.ts +169 -0
  96. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +175 -0
  97. package/packages/orq-rc/src/funcs/contactsUpdate.ts +176 -0
  98. package/packages/orq-rc/src/funcs/datasetsClear.ts +167 -0
  99. package/packages/orq-rc/src/funcs/datasetsCreate.ts +165 -0
  100. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +171 -0
  101. package/packages/orq-rc/src/funcs/datasetsDelete.ts +167 -0
  102. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +182 -0
  103. package/packages/orq-rc/src/funcs/datasetsList.ts +167 -0
  104. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +174 -0
  105. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +175 -0
  106. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +181 -0
  107. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +176 -0
  108. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +179 -0
  109. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +168 -0
  110. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +176 -0
  111. package/packages/orq-rc/src/funcs/deploymentsList.ts +176 -0
  112. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +168 -0
  113. package/packages/orq-rc/src/funcs/deploymentsStream.ts +183 -0
  114. package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
  115. package/packages/orq-rc/src/funcs/evalsCreate.ts +169 -0
  116. package/packages/orq-rc/src/funcs/evalsDelete.ts +173 -0
  117. package/packages/orq-rc/src/funcs/evalsUpdate.ts +173 -0
  118. package/packages/orq-rc/src/funcs/feedbackCreate.ts +160 -0
  119. package/packages/orq-rc/src/funcs/filesCreate.ts +187 -0
  120. package/packages/orq-rc/src/funcs/filesDelete.ts +164 -0
  121. package/packages/orq-rc/src/funcs/filesGet.ts +166 -0
  122. package/packages/orq-rc/src/funcs/filesList.ts +167 -0
  123. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
  124. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +171 -0
  125. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +166 -0
  126. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +167 -0
  127. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +174 -0
  128. package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +170 -0
  129. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +173 -0
  130. package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +170 -0
  131. package/packages/orq-rc/src/funcs/knowledgeList.ts +169 -0
  132. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +178 -0
  133. package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +171 -0
  134. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +174 -0
  135. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +166 -0
  136. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +173 -0
  137. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +169 -0
  138. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +167 -0
  139. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +164 -0
  140. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +174 -0
  141. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +170 -0
  142. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +171 -0
  143. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +175 -0
  144. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +170 -0
  145. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +168 -0
  146. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +184 -0
  147. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +179 -0
  148. package/packages/orq-rc/src/funcs/memoryStoresList.ts +178 -0
  149. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +181 -0
  150. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +176 -0
  151. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +177 -0
  152. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +178 -0
  153. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +173 -0
  154. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +168 -0
  155. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +179 -0
  156. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +174 -0
  157. package/packages/orq-rc/src/funcs/modelsList.ts +142 -0
  158. package/packages/orq-rc/src/funcs/promptsCreate.ts +160 -0
  159. package/packages/orq-rc/src/funcs/promptsDelete.ts +164 -0
  160. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +181 -0
  161. package/packages/orq-rc/src/funcs/promptsList.ts +167 -0
  162. package/packages/orq-rc/src/funcs/promptsListVersions.ts +173 -0
  163. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +166 -0
  164. package/packages/orq-rc/src/funcs/promptsUpdate.ts +173 -0
  165. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +161 -0
  166. package/packages/orq-rc/src/funcs/toolsCreate.ts +163 -0
  167. package/packages/orq-rc/src/funcs/toolsDelete.ts +167 -0
  168. package/packages/orq-rc/src/funcs/toolsDuplicate.ts +175 -0
  169. package/packages/orq-rc/src/funcs/toolsList.ts +176 -0
  170. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +166 -0
  171. package/packages/orq-rc/src/funcs/toolsUpdate.ts +176 -0
  172. package/packages/orq-rc/src/hooks/global.ts +44 -0
  173. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  174. package/packages/orq-rc/src/hooks/index.ts +6 -0
  175. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  176. package/packages/orq-rc/src/hooks/types.ts +112 -0
  177. package/packages/orq-rc/src/index.ts +9 -0
  178. package/packages/orq-rc/src/lib/base64.ts +37 -0
  179. package/packages/orq-rc/src/lib/config.ts +74 -0
  180. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  181. package/packages/orq-rc/src/lib/encodings.ts +483 -0
  182. package/packages/orq-rc/src/lib/env.ts +89 -0
  183. package/packages/orq-rc/src/lib/event-streams.ts +135 -0
  184. package/packages/orq-rc/src/lib/files.ts +82 -0
  185. package/packages/orq-rc/src/lib/http.ts +323 -0
  186. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  187. package/packages/orq-rc/src/lib/logger.ts +9 -0
  188. package/packages/orq-rc/src/lib/matchers.ts +345 -0
  189. package/packages/orq-rc/src/lib/primitives.ts +150 -0
  190. package/packages/orq-rc/src/lib/retries.ts +218 -0
  191. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  192. package/packages/orq-rc/src/lib/sdks.ts +407 -0
  193. package/packages/orq-rc/src/lib/security.ts +264 -0
  194. package/packages/orq-rc/src/lib/url.ts +33 -0
  195. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +111 -0
  196. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +136 -0
  197. package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
  198. package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
  199. package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
  200. package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
  201. package/packages/orq-rc/src/mcp-server/prompts.ts +117 -0
  202. package/packages/orq-rc/src/mcp-server/resources.ts +172 -0
  203. package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
  204. package/packages/orq-rc/src/mcp-server/server.ts +259 -0
  205. package/packages/orq-rc/src/mcp-server/shared.ts +74 -0
  206. package/packages/orq-rc/src/mcp-server/tools/agentsCreate.ts +37 -0
  207. package/packages/orq-rc/src/mcp-server/tools/agentsDelete.ts +35 -0
  208. package/packages/orq-rc/src/mcp-server/tools/agentsInvoke.ts +37 -0
  209. package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +37 -0
  210. package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +35 -0
  211. package/packages/orq-rc/src/mcp-server/tools/agentsListTasks.ts +37 -0
  212. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +37 -0
  213. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +35 -0
  214. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +37 -0
  215. package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +37 -0
  216. package/packages/orq-rc/src/mcp-server/tools/agentsStream.ts +37 -0
  217. package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +37 -0
  218. package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +37 -0
  219. package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +37 -0
  220. package/packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts +35 -0
  221. package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +37 -0
  222. package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +37 -0
  223. package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +37 -0
  224. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +37 -0
  225. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
  226. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
  227. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
  228. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
  229. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
  230. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
  231. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
  232. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
  233. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
  234. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
  235. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
  236. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
  237. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
  238. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
  239. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
  240. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
  241. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
  242. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
  243. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
  244. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
  245. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
  246. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +35 -0
  247. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +35 -0
  248. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +33 -0
  249. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +35 -0
  250. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
  251. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
  252. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
  253. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
  254. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
  255. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
  256. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
  257. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
  258. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +35 -0
  259. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
  260. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunks.ts +35 -0
  261. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
  262. package/packages/orq-rc/src/mcp-server/tools/knowledgeGetChunksCount.ts +35 -0
  263. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +37 -0
  264. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
  265. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunksPaginated.ts +35 -0
  266. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
  267. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
  268. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
  269. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
  270. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +37 -0
  271. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
  272. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
  273. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
  274. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +35 -0
  275. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +37 -0
  276. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +37 -0
  277. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +35 -0
  278. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +40 -0
  279. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +40 -0
  280. package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +37 -0
  281. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +37 -0
  282. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +37 -0
  283. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +37 -0
  284. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +37 -0
  285. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +37 -0
  286. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +37 -0
  287. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +37 -0
  288. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +37 -0
  289. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +30 -0
  290. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
  291. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
  292. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
  293. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
  294. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
  295. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
  296. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
  297. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
  298. package/packages/orq-rc/src/mcp-server/tools/toolsCreate.ts +37 -0
  299. package/packages/orq-rc/src/mcp-server/tools/toolsDelete.ts +35 -0
  300. package/packages/orq-rc/src/mcp-server/tools/toolsDuplicate.ts +37 -0
  301. package/packages/orq-rc/src/mcp-server/tools/toolsList.ts +37 -0
  302. package/packages/orq-rc/src/mcp-server/tools/toolsRetrieve.ts +37 -0
  303. package/packages/orq-rc/src/mcp-server/tools/toolsUpdate.ts +37 -0
  304. package/packages/orq-rc/src/mcp-server/tools.ts +129 -0
  305. package/packages/orq-rc/src/models/components/deployments.ts +8147 -0
  306. package/packages/orq-rc/src/models/components/index.ts +6 -0
  307. package/packages/orq-rc/src/models/components/security.ts +71 -0
  308. package/packages/orq-rc/src/models/errors/apierror.ts +40 -0
  309. package/packages/orq-rc/src/models/errors/createagent.ts +80 -0
  310. package/packages/orq-rc/src/models/errors/createeval.ts +80 -0
  311. package/packages/orq-rc/src/models/errors/deleteagent.ts +80 -0
  312. package/packages/orq-rc/src/models/errors/deletecontact.ts +91 -0
  313. package/packages/orq-rc/src/models/errors/deleteeval.ts +80 -0
  314. package/packages/orq-rc/src/models/errors/duplicatetool.ts +91 -0
  315. package/packages/orq-rc/src/models/errors/getagent.ts +80 -0
  316. package/packages/orq-rc/src/models/errors/getagenttask.ts +80 -0
  317. package/packages/orq-rc/src/models/errors/getevals.ts +80 -0
  318. package/packages/orq-rc/src/models/errors/getpromptversion.ts +80 -0
  319. package/packages/orq-rc/src/models/errors/honoapierror.ts +90 -0
  320. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  321. package/packages/orq-rc/src/models/errors/index.ts +29 -0
  322. package/packages/orq-rc/src/models/errors/listagenttasks.ts +80 -0
  323. package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
  324. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
  325. package/packages/orq-rc/src/models/errors/retrievecontact.ts +91 -0
  326. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +109 -0
  327. package/packages/orq-rc/src/models/errors/streamagent.ts +80 -0
  328. package/packages/orq-rc/src/models/errors/streamrunagent.ts +80 -0
  329. package/packages/orq-rc/src/models/errors/updateagent.ts +80 -0
  330. package/packages/orq-rc/src/models/errors/updatecontact.ts +83 -0
  331. package/packages/orq-rc/src/models/errors/updateeval.ts +80 -0
  332. package/packages/orq-rc/src/models/errors/updateprompt.ts +80 -0
  333. package/packages/orq-rc/src/models/errors/updatetool.ts +91 -0
  334. package/packages/orq-rc/src/models/operations/cleardataset.ts +78 -0
  335. package/packages/orq-rc/src/models/operations/createagent.ts +3104 -0
  336. package/packages/orq-rc/src/models/operations/createbudget.ts +745 -0
  337. package/packages/orq-rc/src/models/operations/createchunk.ts +428 -0
  338. package/packages/orq-rc/src/models/operations/createcontact.ts +267 -0
  339. package/packages/orq-rc/src/models/operations/createdataset.ts +302 -0
  340. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +6943 -0
  341. package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -0
  342. package/packages/orq-rc/src/models/operations/createeval.ts +9341 -0
  343. package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
  344. package/packages/orq-rc/src/models/operations/createknowledge.ts +1850 -0
  345. package/packages/orq-rc/src/models/operations/creatememory.ts +274 -0
  346. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +287 -0
  347. package/packages/orq-rc/src/models/operations/creatememorystore.ts +2032 -0
  348. package/packages/orq-rc/src/models/operations/createprompt.ts +7812 -0
  349. package/packages/orq-rc/src/models/operations/createtool.ts +4077 -0
  350. package/packages/orq-rc/src/models/operations/deleteagent.ts +78 -0
  351. package/packages/orq-rc/src/models/operations/deletebudget.ts +69 -0
  352. package/packages/orq-rc/src/models/operations/deletechunk.ts +96 -0
  353. package/packages/orq-rc/src/models/operations/deletechunks.ts +243 -0
  354. package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
  355. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +87 -0
  356. package/packages/orq-rc/src/models/operations/deletedataset.ts +78 -0
  357. package/packages/orq-rc/src/models/operations/deletedatasource.ts +87 -0
  358. package/packages/orq-rc/src/models/operations/deleteeval.ts +66 -0
  359. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +78 -0
  360. package/packages/orq-rc/src/models/operations/deletememory.ts +87 -0
  361. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +98 -0
  362. package/packages/orq-rc/src/models/operations/deletememorystore.ts +78 -0
  363. package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
  364. package/packages/orq-rc/src/models/operations/deletetool.ts +75 -0
  365. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +6547 -0
  366. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +10532 -0
  367. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1266 -0
  368. package/packages/orq-rc/src/models/operations/deployments.ts +2606 -0
  369. package/packages/orq-rc/src/models/operations/deploymentstream.ts +10655 -0
  370. package/packages/orq-rc/src/models/operations/duplicatetool.ts +2349 -0
  371. package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
  372. package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
  373. package/packages/orq-rc/src/models/operations/filelist.ts +337 -0
  374. package/packages/orq-rc/src/models/operations/fileupload.ts +327 -0
  375. package/packages/orq-rc/src/models/operations/getagent.ts +957 -0
  376. package/packages/orq-rc/src/models/operations/getagenttask.ts +259 -0
  377. package/packages/orq-rc/src/models/operations/getallmemories.ts +318 -0
  378. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +338 -0
  379. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +1277 -0
  380. package/packages/orq-rc/src/models/operations/getallprompts.ts +2572 -0
  381. package/packages/orq-rc/src/models/operations/getalltools.ts +2308 -0
  382. package/packages/orq-rc/src/models/operations/getbudget.ts +441 -0
  383. package/packages/orq-rc/src/models/operations/getchunkscount.ts +230 -0
  384. package/packages/orq-rc/src/models/operations/getevals.ts +7486 -0
  385. package/packages/orq-rc/src/models/operations/getonechunk.ts +315 -0
  386. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +1292 -0
  387. package/packages/orq-rc/src/models/operations/getoneprompt.ts +2437 -0
  388. package/packages/orq-rc/src/models/operations/getpromptversion.ts +2444 -0
  389. package/packages/orq-rc/src/models/operations/index.ts +102 -0
  390. package/packages/orq-rc/src/models/operations/invokeagent.ts +1569 -0
  391. package/packages/orq-rc/src/models/operations/listactions.ts +526 -0
  392. package/packages/orq-rc/src/models/operations/listagents.ts +1077 -0
  393. package/packages/orq-rc/src/models/operations/listagenttasks.ts +1106 -0
  394. package/packages/orq-rc/src/models/operations/listbudgets.ts +617 -0
  395. package/packages/orq-rc/src/models/operations/listchunks.ts +494 -0
  396. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +507 -0
  397. package/packages/orq-rc/src/models/operations/listcontacts.ts +500 -0
  398. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +4086 -0
  399. package/packages/orq-rc/src/models/operations/listdatasets.ts +406 -0
  400. package/packages/orq-rc/src/models/operations/listdatasources.ts +454 -0
  401. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +1303 -0
  402. package/packages/orq-rc/src/models/operations/listmodels.ts +273 -0
  403. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2580 -0
  404. package/packages/orq-rc/src/models/operations/parse.ts +1295 -0
  405. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
  406. package/packages/orq-rc/src/models/operations/retrieveaction.ts +426 -0
  407. package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
  408. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +3853 -0
  409. package/packages/orq-rc/src/models/operations/retrievedataset.ts +291 -0
  410. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +273 -0
  411. package/packages/orq-rc/src/models/operations/retrievememory.ts +201 -0
  412. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +220 -0
  413. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +1160 -0
  414. package/packages/orq-rc/src/models/operations/retrievetool.ts +2333 -0
  415. package/packages/orq-rc/src/models/operations/runagent.ts +4342 -0
  416. package/packages/orq-rc/src/models/operations/searchknowledge.ts +3573 -0
  417. package/packages/orq-rc/src/models/operations/streamagent.ts +1367 -0
  418. package/packages/orq-rc/src/models/operations/streamrunagent.ts +4355 -0
  419. package/packages/orq-rc/src/models/operations/updateagent.ts +3321 -0
  420. package/packages/orq-rc/src/models/operations/updatebudget.ts +628 -0
  421. package/packages/orq-rc/src/models/operations/updatechunk.ts +448 -0
  422. package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
  423. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +6934 -0
  424. package/packages/orq-rc/src/models/operations/updatedataset.ts +386 -0
  425. package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
  426. package/packages/orq-rc/src/models/operations/updateeval.ts +9704 -0
  427. package/packages/orq-rc/src/models/operations/updateknowledge.ts +2341 -0
  428. package/packages/orq-rc/src/models/operations/updatememory.ts +283 -0
  429. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +296 -0
  430. package/packages/orq-rc/src/models/operations/updatememorystore.ts +1363 -0
  431. package/packages/orq-rc/src/models/operations/updateprompt.ts +8176 -0
  432. package/packages/orq-rc/src/models/operations/updatetool.ts +4288 -0
  433. package/packages/orq-rc/src/sdk/agents.ts +238 -0
  434. package/packages/orq-rc/src/sdk/budgets.ts +99 -0
  435. package/packages/orq-rc/src/sdk/chunking.ts +27 -0
  436. package/packages/orq-rc/src/sdk/contacts.ts +99 -0
  437. package/packages/orq-rc/src/sdk/datasets.ts +204 -0
  438. package/packages/orq-rc/src/sdk/deployments.ts +89 -0
  439. package/packages/orq-rc/src/sdk/evals.ts +69 -0
  440. package/packages/orq-rc/src/sdk/feedback.ts +27 -0
  441. package/packages/orq-rc/src/sdk/files.ts +78 -0
  442. package/packages/orq-rc/src/sdk/index.ts +5 -0
  443. package/packages/orq-rc/src/sdk/knowledge.ts +309 -0
  444. package/packages/orq-rc/src/sdk/memorystores.ts +286 -0
  445. package/packages/orq-rc/src/sdk/metrics.ts +27 -0
  446. package/packages/orq-rc/src/sdk/models.ts +25 -0
  447. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  448. package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
  449. package/packages/orq-rc/src/sdk/sdk.ts +97 -0
  450. package/packages/orq-rc/src/sdk/tools.ts +117 -0
  451. package/packages/orq-rc/src/types/async.ts +68 -0
  452. package/packages/orq-rc/src/types/blobs.ts +32 -0
  453. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  454. package/packages/orq-rc/src/types/enums.ts +16 -0
  455. package/packages/orq-rc/src/types/fp.ts +50 -0
  456. package/packages/orq-rc/src/types/index.ts +11 -0
  457. package/packages/orq-rc/src/types/operations.ts +105 -0
  458. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  459. package/packages/orq-rc/src/types/streams.ts +21 -0
  460. package/packages/orq-rc/tsconfig.json +41 -0
  461. package/src/lib/config.ts +2 -2
  462. package/src/mcp-server/mcp-server.ts +1 -1
  463. package/src/mcp-server/server.ts +1 -1
  464. package/src/models/operations/createbudget.ts +2 -2
  465. package/src/models/operations/createcontact.ts +2 -2
  466. package/src/models/operations/createdataset.ts +2 -2
  467. package/src/models/operations/createdatasetitem.ts +8 -8
  468. package/src/models/operations/createdatasource.ts +2 -2
  469. package/src/models/operations/createeval.ts +28 -28
  470. package/src/models/operations/createtool.ts +10 -10
  471. package/src/models/operations/duplicatetool.ts +10 -10
  472. package/src/models/operations/fileget.ts +2 -2
  473. package/src/models/operations/filelist.ts +2 -2
  474. package/src/models/operations/fileupload.ts +2 -2
  475. package/src/models/operations/getalltools.ts +10 -10
  476. package/src/models/operations/getbudget.ts +2 -2
  477. package/src/models/operations/getevals.ts +28 -28
  478. package/src/models/operations/listbudgets.ts +2 -2
  479. package/src/models/operations/listcontacts.ts +2 -2
  480. package/src/models/operations/listdatasetdatapoints.ts +8 -8
  481. package/src/models/operations/listdatasets.ts +2 -2
  482. package/src/models/operations/listdatasources.ts +2 -2
  483. package/src/models/operations/retrievecontact.ts +2 -2
  484. package/src/models/operations/retrievedatapoint.ts +8 -8
  485. package/src/models/operations/retrievedataset.ts +2 -2
  486. package/src/models/operations/retrievedatasource.ts +2 -2
  487. package/src/models/operations/retrievetool.ts +10 -10
  488. package/src/models/operations/updatebudget.ts +2 -2
  489. package/src/models/operations/updatecontact.ts +2 -2
  490. package/src/models/operations/updatedatapoint.ts +8 -8
  491. package/src/models/operations/updatedataset.ts +2 -2
  492. package/src/models/operations/updatedatasource.ts +2 -2
  493. package/src/models/operations/updateeval.ts +28 -28
  494. package/src/models/operations/updatetool.ts +10 -10
@@ -0,0 +1,1850 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export const CreateKnowledgeRequestBodyKnowledgeType = {
13
+ External: "external",
14
+ } as const;
15
+ export type CreateKnowledgeRequestBodyKnowledgeType = ClosedEnum<
16
+ typeof CreateKnowledgeRequestBodyKnowledgeType
17
+ >;
18
+
19
+ export type ExternalConfig = {
20
+ /**
21
+ * The name of the external knowledge base.
22
+ */
23
+ name: string;
24
+ /**
25
+ * The API URL of the external knowledge base.
26
+ */
27
+ apiUrl: string;
28
+ /**
29
+ * The API key to access the external knowledge base.
30
+ */
31
+ apiKey: string;
32
+ };
33
+
34
+ export type RequestBody2 = {
35
+ type?: CreateKnowledgeRequestBodyKnowledgeType | undefined;
36
+ key: string;
37
+ description?: string | undefined;
38
+ externalConfig: ExternalConfig;
39
+ };
40
+
41
+ export const CreateKnowledgeRequestBodyType = {
42
+ Internal: "internal",
43
+ } as const;
44
+ export type CreateKnowledgeRequestBodyType = ClosedEnum<
45
+ typeof CreateKnowledgeRequestBodyType
46
+ >;
47
+
48
+ /**
49
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
50
+ */
51
+ export const RetrievalType = {
52
+ VectorSearch: "vector_search",
53
+ KeywordSearch: "keyword_search",
54
+ HybridSearch: "hybrid_search",
55
+ } as const;
56
+ /**
57
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
58
+ */
59
+ export type RetrievalType = ClosedEnum<typeof RetrievalType>;
60
+
61
+ /**
62
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
63
+ */
64
+ export type CreateKnowledgeRequestBodyRerankConfig = {
65
+ /**
66
+ * The number of results to return by the reranking model
67
+ */
68
+ topK?: number | undefined;
69
+ /**
70
+ * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
71
+ */
72
+ rerankThreshold?: number | undefined;
73
+ /**
74
+ * The rerank model to use for the knowledge base.
75
+ */
76
+ rerankModel: string;
77
+ };
78
+
79
+ /**
80
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
81
+ */
82
+ export type CreateKnowledgeRequestBodyAgenticRagConfig = {
83
+ /**
84
+ * The model to use for the Agentic RAG
85
+ */
86
+ model: string;
87
+ };
88
+
89
+ /**
90
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
91
+ */
92
+ export type RetrievalSettings = {
93
+ /**
94
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
95
+ */
96
+ retrievalType?: RetrievalType | undefined;
97
+ /**
98
+ * The number of results to return from the search.
99
+ */
100
+ topK?: number | undefined;
101
+ /**
102
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
103
+ */
104
+ threshold?: number | undefined;
105
+ /**
106
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
107
+ */
108
+ rerankConfig?: CreateKnowledgeRequestBodyRerankConfig | null | undefined;
109
+ /**
110
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
111
+ */
112
+ agenticRagConfig?:
113
+ | CreateKnowledgeRequestBodyAgenticRagConfig
114
+ | null
115
+ | undefined;
116
+ };
117
+
118
+ export type RequestBody1 = {
119
+ type?: CreateKnowledgeRequestBodyType | undefined;
120
+ key: string;
121
+ description?: string | undefined;
122
+ /**
123
+ * The embeddings model to use for the knowledge base. This model will be used to embed the chunks when they are added to the knowledge base.
124
+ */
125
+ embeddingModel: string;
126
+ isPrivateModel?: boolean | undefined;
127
+ /**
128
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
129
+ */
130
+ retrievalSettings?: RetrievalSettings | undefined;
131
+ /**
132
+ * Entity storage path in the format: `project/folder/subfolder/...`
133
+ *
134
+ * @remarks
135
+ *
136
+ * The first element identifies the project, followed by nested folders (auto-created as needed).
137
+ *
138
+ * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
139
+ */
140
+ path: string;
141
+ };
142
+
143
+ export type CreateKnowledgeRequestBody = RequestBody1 | RequestBody2;
144
+
145
+ export const CreateKnowledgeResponseBodyKnowledgeType = {
146
+ External: "external",
147
+ } as const;
148
+ export type CreateKnowledgeResponseBodyKnowledgeType = ClosedEnum<
149
+ typeof CreateKnowledgeResponseBodyKnowledgeType
150
+ >;
151
+
152
+ /**
153
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
154
+ */
155
+ export type CreateKnowledgeResponseBodyRerankConfig = {
156
+ /**
157
+ * The number of results to return by the reranking model
158
+ */
159
+ topK?: number | undefined;
160
+ /**
161
+ * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
162
+ */
163
+ rerankThreshold?: number | undefined;
164
+ /**
165
+ * The rerank model to use for the knowledge base.
166
+ */
167
+ rerankModel: string;
168
+ };
169
+
170
+ /**
171
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
172
+ */
173
+ export type CreateKnowledgeResponseBodyAgenticRagConfig = {
174
+ /**
175
+ * The model to use for the Agentic RAG
176
+ */
177
+ model: string;
178
+ };
179
+
180
+ /**
181
+ * The retrieval settings for the knowledge base.
182
+ */
183
+ export type CreateKnowledgeResponseBodyRetrievalSettings = {
184
+ /**
185
+ * The number of results to return from the search.
186
+ */
187
+ topK?: number | undefined;
188
+ /**
189
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
190
+ */
191
+ threshold?: number | undefined;
192
+ /**
193
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
194
+ */
195
+ rerankConfig?: CreateKnowledgeResponseBodyRerankConfig | null | undefined;
196
+ /**
197
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
198
+ */
199
+ agenticRagConfig?:
200
+ | CreateKnowledgeResponseBodyAgenticRagConfig
201
+ | null
202
+ | undefined;
203
+ };
204
+
205
+ export type ResponseBodyExternalConfig = {
206
+ /**
207
+ * The name of the external knowledge base.
208
+ */
209
+ name: string;
210
+ /**
211
+ * The API URL of the external knowledge base.
212
+ */
213
+ apiUrl: string;
214
+ };
215
+
216
+ export type CreateKnowledgeResponseBody2 = {
217
+ /**
218
+ * The unique identifier of the knowledge base.
219
+ */
220
+ id: string;
221
+ /**
222
+ * The creation date of the knowledge base.
223
+ */
224
+ created: string;
225
+ /**
226
+ * The description of the knowledge base.
227
+ */
228
+ description?: string | undefined;
229
+ /**
230
+ * The unique key of the knowledge base.
231
+ */
232
+ key: string;
233
+ /**
234
+ * The project/domain ID of the knowledge base.
235
+ */
236
+ domainId: string;
237
+ /**
238
+ * Entity storage path in the format: `project/folder/subfolder/...`
239
+ *
240
+ * @remarks
241
+ *
242
+ * The first element identifies the project, followed by nested folders (auto-created as needed).
243
+ *
244
+ * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
245
+ */
246
+ path?: string | undefined;
247
+ createdById?: string | null | undefined;
248
+ updatedById?: string | null | undefined;
249
+ /**
250
+ * The last update date of the knowledge base.
251
+ */
252
+ updated: string;
253
+ type?: CreateKnowledgeResponseBodyKnowledgeType | undefined;
254
+ /**
255
+ * The retrieval settings for the knowledge base.
256
+ */
257
+ retrievalSettings?: CreateKnowledgeResponseBodyRetrievalSettings | undefined;
258
+ externalConfig: ResponseBodyExternalConfig;
259
+ };
260
+
261
+ export const CreateKnowledgeResponseBodyType = {
262
+ Internal: "internal",
263
+ } as const;
264
+ export type CreateKnowledgeResponseBodyType = ClosedEnum<
265
+ typeof CreateKnowledgeResponseBodyType
266
+ >;
267
+
268
+ /**
269
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
270
+ */
271
+ export const ResponseBodyRetrievalType = {
272
+ VectorSearch: "vector_search",
273
+ KeywordSearch: "keyword_search",
274
+ HybridSearch: "hybrid_search",
275
+ } as const;
276
+ /**
277
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
278
+ */
279
+ export type ResponseBodyRetrievalType = ClosedEnum<
280
+ typeof ResponseBodyRetrievalType
281
+ >;
282
+
283
+ /**
284
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
285
+ */
286
+ export type ResponseBodyRerankConfig = {
287
+ /**
288
+ * The number of results to return by the reranking model
289
+ */
290
+ topK?: number | undefined;
291
+ /**
292
+ * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
293
+ */
294
+ rerankThreshold?: number | undefined;
295
+ /**
296
+ * The rerank model to use for the knowledge base.
297
+ */
298
+ rerankModel: string;
299
+ };
300
+
301
+ /**
302
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
303
+ */
304
+ export type ResponseBodyAgenticRagConfig = {
305
+ /**
306
+ * The model to use for the Agentic RAG
307
+ */
308
+ model: string;
309
+ };
310
+
311
+ /**
312
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
313
+ */
314
+ export type ResponseBodyRetrievalSettings = {
315
+ /**
316
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
317
+ */
318
+ retrievalType?: ResponseBodyRetrievalType | undefined;
319
+ /**
320
+ * The number of results to return from the search.
321
+ */
322
+ topK?: number | undefined;
323
+ /**
324
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
325
+ */
326
+ threshold?: number | undefined;
327
+ /**
328
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
329
+ */
330
+ rerankConfig?: ResponseBodyRerankConfig | null | undefined;
331
+ /**
332
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
333
+ */
334
+ agenticRagConfig?: ResponseBodyAgenticRagConfig | null | undefined;
335
+ };
336
+
337
+ export type CreateKnowledgeResponseBody1 = {
338
+ /**
339
+ * The unique identifier of the knowledge base.
340
+ */
341
+ id: string;
342
+ /**
343
+ * The creation date of the knowledge base.
344
+ */
345
+ created: string;
346
+ /**
347
+ * The description of the knowledge base.
348
+ */
349
+ description?: string | undefined;
350
+ /**
351
+ * The unique key of the knowledge base.
352
+ */
353
+ key: string;
354
+ /**
355
+ * The project/domain ID of the knowledge base.
356
+ */
357
+ domainId: string;
358
+ /**
359
+ * Entity storage path in the format: `project/folder/subfolder/...`
360
+ *
361
+ * @remarks
362
+ *
363
+ * The first element identifies the project, followed by nested folders (auto-created as needed).
364
+ *
365
+ * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
366
+ */
367
+ path?: string | undefined;
368
+ createdById?: string | null | undefined;
369
+ updatedById?: string | null | undefined;
370
+ /**
371
+ * The last update date of the knowledge base.
372
+ */
373
+ updated: string;
374
+ type?: CreateKnowledgeResponseBodyType | undefined;
375
+ /**
376
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
377
+ */
378
+ retrievalSettings?: ResponseBodyRetrievalSettings | undefined;
379
+ /**
380
+ * The embeddings model used for the knowledge base.
381
+ */
382
+ model: string;
383
+ };
384
+
385
+ /**
386
+ * Knowledge successfully created
387
+ */
388
+ export type CreateKnowledgeResponseBody =
389
+ | CreateKnowledgeResponseBody1
390
+ | CreateKnowledgeResponseBody2;
391
+
392
+ /** @internal */
393
+ export const CreateKnowledgeRequestBodyKnowledgeType$inboundSchema:
394
+ z.ZodNativeEnum<typeof CreateKnowledgeRequestBodyKnowledgeType> = z
395
+ .nativeEnum(CreateKnowledgeRequestBodyKnowledgeType);
396
+
397
+ /** @internal */
398
+ export const CreateKnowledgeRequestBodyKnowledgeType$outboundSchema:
399
+ z.ZodNativeEnum<typeof CreateKnowledgeRequestBodyKnowledgeType> =
400
+ CreateKnowledgeRequestBodyKnowledgeType$inboundSchema;
401
+
402
+ /**
403
+ * @internal
404
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
405
+ */
406
+ export namespace CreateKnowledgeRequestBodyKnowledgeType$ {
407
+ /** @deprecated use `CreateKnowledgeRequestBodyKnowledgeType$inboundSchema` instead. */
408
+ export const inboundSchema =
409
+ CreateKnowledgeRequestBodyKnowledgeType$inboundSchema;
410
+ /** @deprecated use `CreateKnowledgeRequestBodyKnowledgeType$outboundSchema` instead. */
411
+ export const outboundSchema =
412
+ CreateKnowledgeRequestBodyKnowledgeType$outboundSchema;
413
+ }
414
+
415
+ /** @internal */
416
+ export const ExternalConfig$inboundSchema: z.ZodType<
417
+ ExternalConfig,
418
+ z.ZodTypeDef,
419
+ unknown
420
+ > = z.object({
421
+ name: z.string(),
422
+ api_url: z.string(),
423
+ api_key: z.string(),
424
+ }).transform((v) => {
425
+ return remap$(v, {
426
+ "api_url": "apiUrl",
427
+ "api_key": "apiKey",
428
+ });
429
+ });
430
+
431
+ /** @internal */
432
+ export type ExternalConfig$Outbound = {
433
+ name: string;
434
+ api_url: string;
435
+ api_key: string;
436
+ };
437
+
438
+ /** @internal */
439
+ export const ExternalConfig$outboundSchema: z.ZodType<
440
+ ExternalConfig$Outbound,
441
+ z.ZodTypeDef,
442
+ ExternalConfig
443
+ > = z.object({
444
+ name: z.string(),
445
+ apiUrl: z.string(),
446
+ apiKey: z.string(),
447
+ }).transform((v) => {
448
+ return remap$(v, {
449
+ apiUrl: "api_url",
450
+ apiKey: "api_key",
451
+ });
452
+ });
453
+
454
+ /**
455
+ * @internal
456
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
457
+ */
458
+ export namespace ExternalConfig$ {
459
+ /** @deprecated use `ExternalConfig$inboundSchema` instead. */
460
+ export const inboundSchema = ExternalConfig$inboundSchema;
461
+ /** @deprecated use `ExternalConfig$outboundSchema` instead. */
462
+ export const outboundSchema = ExternalConfig$outboundSchema;
463
+ /** @deprecated use `ExternalConfig$Outbound` instead. */
464
+ export type Outbound = ExternalConfig$Outbound;
465
+ }
466
+
467
+ export function externalConfigToJSON(externalConfig: ExternalConfig): string {
468
+ return JSON.stringify(ExternalConfig$outboundSchema.parse(externalConfig));
469
+ }
470
+
471
+ export function externalConfigFromJSON(
472
+ jsonString: string,
473
+ ): SafeParseResult<ExternalConfig, SDKValidationError> {
474
+ return safeParse(
475
+ jsonString,
476
+ (x) => ExternalConfig$inboundSchema.parse(JSON.parse(x)),
477
+ `Failed to parse 'ExternalConfig' from JSON`,
478
+ );
479
+ }
480
+
481
+ /** @internal */
482
+ export const RequestBody2$inboundSchema: z.ZodType<
483
+ RequestBody2,
484
+ z.ZodTypeDef,
485
+ unknown
486
+ > = z.object({
487
+ type: CreateKnowledgeRequestBodyKnowledgeType$inboundSchema.default(
488
+ "external",
489
+ ),
490
+ key: z.string(),
491
+ description: z.string().optional(),
492
+ external_config: z.lazy(() => ExternalConfig$inboundSchema),
493
+ }).transform((v) => {
494
+ return remap$(v, {
495
+ "external_config": "externalConfig",
496
+ });
497
+ });
498
+
499
+ /** @internal */
500
+ export type RequestBody2$Outbound = {
501
+ type: string;
502
+ key: string;
503
+ description?: string | undefined;
504
+ external_config: ExternalConfig$Outbound;
505
+ };
506
+
507
+ /** @internal */
508
+ export const RequestBody2$outboundSchema: z.ZodType<
509
+ RequestBody2$Outbound,
510
+ z.ZodTypeDef,
511
+ RequestBody2
512
+ > = z.object({
513
+ type: CreateKnowledgeRequestBodyKnowledgeType$outboundSchema.default(
514
+ "external",
515
+ ),
516
+ key: z.string(),
517
+ description: z.string().optional(),
518
+ externalConfig: z.lazy(() => ExternalConfig$outboundSchema),
519
+ }).transform((v) => {
520
+ return remap$(v, {
521
+ externalConfig: "external_config",
522
+ });
523
+ });
524
+
525
+ /**
526
+ * @internal
527
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
528
+ */
529
+ export namespace RequestBody2$ {
530
+ /** @deprecated use `RequestBody2$inboundSchema` instead. */
531
+ export const inboundSchema = RequestBody2$inboundSchema;
532
+ /** @deprecated use `RequestBody2$outboundSchema` instead. */
533
+ export const outboundSchema = RequestBody2$outboundSchema;
534
+ /** @deprecated use `RequestBody2$Outbound` instead. */
535
+ export type Outbound = RequestBody2$Outbound;
536
+ }
537
+
538
+ export function requestBody2ToJSON(requestBody2: RequestBody2): string {
539
+ return JSON.stringify(RequestBody2$outboundSchema.parse(requestBody2));
540
+ }
541
+
542
+ export function requestBody2FromJSON(
543
+ jsonString: string,
544
+ ): SafeParseResult<RequestBody2, SDKValidationError> {
545
+ return safeParse(
546
+ jsonString,
547
+ (x) => RequestBody2$inboundSchema.parse(JSON.parse(x)),
548
+ `Failed to parse 'RequestBody2' from JSON`,
549
+ );
550
+ }
551
+
552
+ /** @internal */
553
+ export const CreateKnowledgeRequestBodyType$inboundSchema: z.ZodNativeEnum<
554
+ typeof CreateKnowledgeRequestBodyType
555
+ > = z.nativeEnum(CreateKnowledgeRequestBodyType);
556
+
557
+ /** @internal */
558
+ export const CreateKnowledgeRequestBodyType$outboundSchema: z.ZodNativeEnum<
559
+ typeof CreateKnowledgeRequestBodyType
560
+ > = CreateKnowledgeRequestBodyType$inboundSchema;
561
+
562
+ /**
563
+ * @internal
564
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
565
+ */
566
+ export namespace CreateKnowledgeRequestBodyType$ {
567
+ /** @deprecated use `CreateKnowledgeRequestBodyType$inboundSchema` instead. */
568
+ export const inboundSchema = CreateKnowledgeRequestBodyType$inboundSchema;
569
+ /** @deprecated use `CreateKnowledgeRequestBodyType$outboundSchema` instead. */
570
+ export const outboundSchema = CreateKnowledgeRequestBodyType$outboundSchema;
571
+ }
572
+
573
+ /** @internal */
574
+ export const RetrievalType$inboundSchema: z.ZodNativeEnum<
575
+ typeof RetrievalType
576
+ > = z.nativeEnum(RetrievalType);
577
+
578
+ /** @internal */
579
+ export const RetrievalType$outboundSchema: z.ZodNativeEnum<
580
+ typeof RetrievalType
581
+ > = RetrievalType$inboundSchema;
582
+
583
+ /**
584
+ * @internal
585
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
586
+ */
587
+ export namespace RetrievalType$ {
588
+ /** @deprecated use `RetrievalType$inboundSchema` instead. */
589
+ export const inboundSchema = RetrievalType$inboundSchema;
590
+ /** @deprecated use `RetrievalType$outboundSchema` instead. */
591
+ export const outboundSchema = RetrievalType$outboundSchema;
592
+ }
593
+
594
+ /** @internal */
595
+ export const CreateKnowledgeRequestBodyRerankConfig$inboundSchema: z.ZodType<
596
+ CreateKnowledgeRequestBodyRerankConfig,
597
+ z.ZodTypeDef,
598
+ unknown
599
+ > = z.object({
600
+ top_k: z.number().int().default(5),
601
+ rerank_threshold: z.number().default(0.5),
602
+ rerank_model: z.string(),
603
+ }).transform((v) => {
604
+ return remap$(v, {
605
+ "top_k": "topK",
606
+ "rerank_threshold": "rerankThreshold",
607
+ "rerank_model": "rerankModel",
608
+ });
609
+ });
610
+
611
+ /** @internal */
612
+ export type CreateKnowledgeRequestBodyRerankConfig$Outbound = {
613
+ top_k: number;
614
+ rerank_threshold: number;
615
+ rerank_model: string;
616
+ };
617
+
618
+ /** @internal */
619
+ export const CreateKnowledgeRequestBodyRerankConfig$outboundSchema: z.ZodType<
620
+ CreateKnowledgeRequestBodyRerankConfig$Outbound,
621
+ z.ZodTypeDef,
622
+ CreateKnowledgeRequestBodyRerankConfig
623
+ > = z.object({
624
+ topK: z.number().int().default(5),
625
+ rerankThreshold: z.number().default(0.5),
626
+ rerankModel: z.string(),
627
+ }).transform((v) => {
628
+ return remap$(v, {
629
+ topK: "top_k",
630
+ rerankThreshold: "rerank_threshold",
631
+ rerankModel: "rerank_model",
632
+ });
633
+ });
634
+
635
+ /**
636
+ * @internal
637
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
638
+ */
639
+ export namespace CreateKnowledgeRequestBodyRerankConfig$ {
640
+ /** @deprecated use `CreateKnowledgeRequestBodyRerankConfig$inboundSchema` instead. */
641
+ export const inboundSchema =
642
+ CreateKnowledgeRequestBodyRerankConfig$inboundSchema;
643
+ /** @deprecated use `CreateKnowledgeRequestBodyRerankConfig$outboundSchema` instead. */
644
+ export const outboundSchema =
645
+ CreateKnowledgeRequestBodyRerankConfig$outboundSchema;
646
+ /** @deprecated use `CreateKnowledgeRequestBodyRerankConfig$Outbound` instead. */
647
+ export type Outbound = CreateKnowledgeRequestBodyRerankConfig$Outbound;
648
+ }
649
+
650
+ export function createKnowledgeRequestBodyRerankConfigToJSON(
651
+ createKnowledgeRequestBodyRerankConfig:
652
+ CreateKnowledgeRequestBodyRerankConfig,
653
+ ): string {
654
+ return JSON.stringify(
655
+ CreateKnowledgeRequestBodyRerankConfig$outboundSchema.parse(
656
+ createKnowledgeRequestBodyRerankConfig,
657
+ ),
658
+ );
659
+ }
660
+
661
+ export function createKnowledgeRequestBodyRerankConfigFromJSON(
662
+ jsonString: string,
663
+ ): SafeParseResult<CreateKnowledgeRequestBodyRerankConfig, SDKValidationError> {
664
+ return safeParse(
665
+ jsonString,
666
+ (x) =>
667
+ CreateKnowledgeRequestBodyRerankConfig$inboundSchema.parse(JSON.parse(x)),
668
+ `Failed to parse 'CreateKnowledgeRequestBodyRerankConfig' from JSON`,
669
+ );
670
+ }
671
+
672
+ /** @internal */
673
+ export const CreateKnowledgeRequestBodyAgenticRagConfig$inboundSchema:
674
+ z.ZodType<CreateKnowledgeRequestBodyAgenticRagConfig, z.ZodTypeDef, unknown> =
675
+ z.object({
676
+ model: z.string(),
677
+ });
678
+
679
+ /** @internal */
680
+ export type CreateKnowledgeRequestBodyAgenticRagConfig$Outbound = {
681
+ model: string;
682
+ };
683
+
684
+ /** @internal */
685
+ export const CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema:
686
+ z.ZodType<
687
+ CreateKnowledgeRequestBodyAgenticRagConfig$Outbound,
688
+ z.ZodTypeDef,
689
+ CreateKnowledgeRequestBodyAgenticRagConfig
690
+ > = z.object({
691
+ model: z.string(),
692
+ });
693
+
694
+ /**
695
+ * @internal
696
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
697
+ */
698
+ export namespace CreateKnowledgeRequestBodyAgenticRagConfig$ {
699
+ /** @deprecated use `CreateKnowledgeRequestBodyAgenticRagConfig$inboundSchema` instead. */
700
+ export const inboundSchema =
701
+ CreateKnowledgeRequestBodyAgenticRagConfig$inboundSchema;
702
+ /** @deprecated use `CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema` instead. */
703
+ export const outboundSchema =
704
+ CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema;
705
+ /** @deprecated use `CreateKnowledgeRequestBodyAgenticRagConfig$Outbound` instead. */
706
+ export type Outbound = CreateKnowledgeRequestBodyAgenticRagConfig$Outbound;
707
+ }
708
+
709
+ export function createKnowledgeRequestBodyAgenticRagConfigToJSON(
710
+ createKnowledgeRequestBodyAgenticRagConfig:
711
+ CreateKnowledgeRequestBodyAgenticRagConfig,
712
+ ): string {
713
+ return JSON.stringify(
714
+ CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema.parse(
715
+ createKnowledgeRequestBodyAgenticRagConfig,
716
+ ),
717
+ );
718
+ }
719
+
720
+ export function createKnowledgeRequestBodyAgenticRagConfigFromJSON(
721
+ jsonString: string,
722
+ ): SafeParseResult<
723
+ CreateKnowledgeRequestBodyAgenticRagConfig,
724
+ SDKValidationError
725
+ > {
726
+ return safeParse(
727
+ jsonString,
728
+ (x) =>
729
+ CreateKnowledgeRequestBodyAgenticRagConfig$inboundSchema.parse(
730
+ JSON.parse(x),
731
+ ),
732
+ `Failed to parse 'CreateKnowledgeRequestBodyAgenticRagConfig' from JSON`,
733
+ );
734
+ }
735
+
736
+ /** @internal */
737
+ export const RetrievalSettings$inboundSchema: z.ZodType<
738
+ RetrievalSettings,
739
+ z.ZodTypeDef,
740
+ unknown
741
+ > = z.object({
742
+ retrieval_type: RetrievalType$inboundSchema.default("hybrid_search"),
743
+ top_k: z.number().int().default(5),
744
+ threshold: z.number().default(0),
745
+ rerank_config: z.nullable(
746
+ z.lazy(() => CreateKnowledgeRequestBodyRerankConfig$inboundSchema),
747
+ ).optional(),
748
+ agentic_rag_config: z.nullable(
749
+ z.lazy(() => CreateKnowledgeRequestBodyAgenticRagConfig$inboundSchema),
750
+ ).optional(),
751
+ }).transform((v) => {
752
+ return remap$(v, {
753
+ "retrieval_type": "retrievalType",
754
+ "top_k": "topK",
755
+ "rerank_config": "rerankConfig",
756
+ "agentic_rag_config": "agenticRagConfig",
757
+ });
758
+ });
759
+
760
+ /** @internal */
761
+ export type RetrievalSettings$Outbound = {
762
+ retrieval_type: string;
763
+ top_k: number;
764
+ threshold: number;
765
+ rerank_config?:
766
+ | CreateKnowledgeRequestBodyRerankConfig$Outbound
767
+ | null
768
+ | undefined;
769
+ agentic_rag_config?:
770
+ | CreateKnowledgeRequestBodyAgenticRagConfig$Outbound
771
+ | null
772
+ | undefined;
773
+ };
774
+
775
+ /** @internal */
776
+ export const RetrievalSettings$outboundSchema: z.ZodType<
777
+ RetrievalSettings$Outbound,
778
+ z.ZodTypeDef,
779
+ RetrievalSettings
780
+ > = z.object({
781
+ retrievalType: RetrievalType$outboundSchema.default("hybrid_search"),
782
+ topK: z.number().int().default(5),
783
+ threshold: z.number().default(0),
784
+ rerankConfig: z.nullable(
785
+ z.lazy(() => CreateKnowledgeRequestBodyRerankConfig$outboundSchema),
786
+ ).optional(),
787
+ agenticRagConfig: z.nullable(
788
+ z.lazy(() => CreateKnowledgeRequestBodyAgenticRagConfig$outboundSchema),
789
+ ).optional(),
790
+ }).transform((v) => {
791
+ return remap$(v, {
792
+ retrievalType: "retrieval_type",
793
+ topK: "top_k",
794
+ rerankConfig: "rerank_config",
795
+ agenticRagConfig: "agentic_rag_config",
796
+ });
797
+ });
798
+
799
+ /**
800
+ * @internal
801
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
802
+ */
803
+ export namespace RetrievalSettings$ {
804
+ /** @deprecated use `RetrievalSettings$inboundSchema` instead. */
805
+ export const inboundSchema = RetrievalSettings$inboundSchema;
806
+ /** @deprecated use `RetrievalSettings$outboundSchema` instead. */
807
+ export const outboundSchema = RetrievalSettings$outboundSchema;
808
+ /** @deprecated use `RetrievalSettings$Outbound` instead. */
809
+ export type Outbound = RetrievalSettings$Outbound;
810
+ }
811
+
812
+ export function retrievalSettingsToJSON(
813
+ retrievalSettings: RetrievalSettings,
814
+ ): string {
815
+ return JSON.stringify(
816
+ RetrievalSettings$outboundSchema.parse(retrievalSettings),
817
+ );
818
+ }
819
+
820
+ export function retrievalSettingsFromJSON(
821
+ jsonString: string,
822
+ ): SafeParseResult<RetrievalSettings, SDKValidationError> {
823
+ return safeParse(
824
+ jsonString,
825
+ (x) => RetrievalSettings$inboundSchema.parse(JSON.parse(x)),
826
+ `Failed to parse 'RetrievalSettings' from JSON`,
827
+ );
828
+ }
829
+
830
+ /** @internal */
831
+ export const RequestBody1$inboundSchema: z.ZodType<
832
+ RequestBody1,
833
+ z.ZodTypeDef,
834
+ unknown
835
+ > = z.object({
836
+ type: CreateKnowledgeRequestBodyType$inboundSchema.default("internal"),
837
+ key: z.string(),
838
+ description: z.string().optional(),
839
+ embedding_model: z.string(),
840
+ is_private_model: z.boolean().default(false),
841
+ retrieval_settings: z.lazy(() => RetrievalSettings$inboundSchema).optional(),
842
+ path: z.string(),
843
+ }).transform((v) => {
844
+ return remap$(v, {
845
+ "embedding_model": "embeddingModel",
846
+ "is_private_model": "isPrivateModel",
847
+ "retrieval_settings": "retrievalSettings",
848
+ });
849
+ });
850
+
851
+ /** @internal */
852
+ export type RequestBody1$Outbound = {
853
+ type: string;
854
+ key: string;
855
+ description?: string | undefined;
856
+ embedding_model: string;
857
+ is_private_model: boolean;
858
+ retrieval_settings?: RetrievalSettings$Outbound | undefined;
859
+ path: string;
860
+ };
861
+
862
+ /** @internal */
863
+ export const RequestBody1$outboundSchema: z.ZodType<
864
+ RequestBody1$Outbound,
865
+ z.ZodTypeDef,
866
+ RequestBody1
867
+ > = z.object({
868
+ type: CreateKnowledgeRequestBodyType$outboundSchema.default("internal"),
869
+ key: z.string(),
870
+ description: z.string().optional(),
871
+ embeddingModel: z.string(),
872
+ isPrivateModel: z.boolean().default(false),
873
+ retrievalSettings: z.lazy(() => RetrievalSettings$outboundSchema).optional(),
874
+ path: z.string(),
875
+ }).transform((v) => {
876
+ return remap$(v, {
877
+ embeddingModel: "embedding_model",
878
+ isPrivateModel: "is_private_model",
879
+ retrievalSettings: "retrieval_settings",
880
+ });
881
+ });
882
+
883
+ /**
884
+ * @internal
885
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
886
+ */
887
+ export namespace RequestBody1$ {
888
+ /** @deprecated use `RequestBody1$inboundSchema` instead. */
889
+ export const inboundSchema = RequestBody1$inboundSchema;
890
+ /** @deprecated use `RequestBody1$outboundSchema` instead. */
891
+ export const outboundSchema = RequestBody1$outboundSchema;
892
+ /** @deprecated use `RequestBody1$Outbound` instead. */
893
+ export type Outbound = RequestBody1$Outbound;
894
+ }
895
+
896
+ export function requestBody1ToJSON(requestBody1: RequestBody1): string {
897
+ return JSON.stringify(RequestBody1$outboundSchema.parse(requestBody1));
898
+ }
899
+
900
+ export function requestBody1FromJSON(
901
+ jsonString: string,
902
+ ): SafeParseResult<RequestBody1, SDKValidationError> {
903
+ return safeParse(
904
+ jsonString,
905
+ (x) => RequestBody1$inboundSchema.parse(JSON.parse(x)),
906
+ `Failed to parse 'RequestBody1' from JSON`,
907
+ );
908
+ }
909
+
910
+ /** @internal */
911
+ export const CreateKnowledgeRequestBody$inboundSchema: z.ZodType<
912
+ CreateKnowledgeRequestBody,
913
+ z.ZodTypeDef,
914
+ unknown
915
+ > = z.union([
916
+ z.lazy(() => RequestBody1$inboundSchema),
917
+ z.lazy(() => RequestBody2$inboundSchema),
918
+ ]);
919
+
920
+ /** @internal */
921
+ export type CreateKnowledgeRequestBody$Outbound =
922
+ | RequestBody1$Outbound
923
+ | RequestBody2$Outbound;
924
+
925
+ /** @internal */
926
+ export const CreateKnowledgeRequestBody$outboundSchema: z.ZodType<
927
+ CreateKnowledgeRequestBody$Outbound,
928
+ z.ZodTypeDef,
929
+ CreateKnowledgeRequestBody
930
+ > = z.union([
931
+ z.lazy(() => RequestBody1$outboundSchema),
932
+ z.lazy(() => RequestBody2$outboundSchema),
933
+ ]);
934
+
935
+ /**
936
+ * @internal
937
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
938
+ */
939
+ export namespace CreateKnowledgeRequestBody$ {
940
+ /** @deprecated use `CreateKnowledgeRequestBody$inboundSchema` instead. */
941
+ export const inboundSchema = CreateKnowledgeRequestBody$inboundSchema;
942
+ /** @deprecated use `CreateKnowledgeRequestBody$outboundSchema` instead. */
943
+ export const outboundSchema = CreateKnowledgeRequestBody$outboundSchema;
944
+ /** @deprecated use `CreateKnowledgeRequestBody$Outbound` instead. */
945
+ export type Outbound = CreateKnowledgeRequestBody$Outbound;
946
+ }
947
+
948
+ export function createKnowledgeRequestBodyToJSON(
949
+ createKnowledgeRequestBody: CreateKnowledgeRequestBody,
950
+ ): string {
951
+ return JSON.stringify(
952
+ CreateKnowledgeRequestBody$outboundSchema.parse(createKnowledgeRequestBody),
953
+ );
954
+ }
955
+
956
+ export function createKnowledgeRequestBodyFromJSON(
957
+ jsonString: string,
958
+ ): SafeParseResult<CreateKnowledgeRequestBody, SDKValidationError> {
959
+ return safeParse(
960
+ jsonString,
961
+ (x) => CreateKnowledgeRequestBody$inboundSchema.parse(JSON.parse(x)),
962
+ `Failed to parse 'CreateKnowledgeRequestBody' from JSON`,
963
+ );
964
+ }
965
+
966
+ /** @internal */
967
+ export const CreateKnowledgeResponseBodyKnowledgeType$inboundSchema:
968
+ z.ZodNativeEnum<typeof CreateKnowledgeResponseBodyKnowledgeType> = z
969
+ .nativeEnum(CreateKnowledgeResponseBodyKnowledgeType);
970
+
971
+ /** @internal */
972
+ export const CreateKnowledgeResponseBodyKnowledgeType$outboundSchema:
973
+ z.ZodNativeEnum<typeof CreateKnowledgeResponseBodyKnowledgeType> =
974
+ CreateKnowledgeResponseBodyKnowledgeType$inboundSchema;
975
+
976
+ /**
977
+ * @internal
978
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
979
+ */
980
+ export namespace CreateKnowledgeResponseBodyKnowledgeType$ {
981
+ /** @deprecated use `CreateKnowledgeResponseBodyKnowledgeType$inboundSchema` instead. */
982
+ export const inboundSchema =
983
+ CreateKnowledgeResponseBodyKnowledgeType$inboundSchema;
984
+ /** @deprecated use `CreateKnowledgeResponseBodyKnowledgeType$outboundSchema` instead. */
985
+ export const outboundSchema =
986
+ CreateKnowledgeResponseBodyKnowledgeType$outboundSchema;
987
+ }
988
+
989
+ /** @internal */
990
+ export const CreateKnowledgeResponseBodyRerankConfig$inboundSchema: z.ZodType<
991
+ CreateKnowledgeResponseBodyRerankConfig,
992
+ z.ZodTypeDef,
993
+ unknown
994
+ > = z.object({
995
+ top_k: z.number().int().default(5),
996
+ rerank_threshold: z.number().default(0.5),
997
+ rerank_model: z.string(),
998
+ }).transform((v) => {
999
+ return remap$(v, {
1000
+ "top_k": "topK",
1001
+ "rerank_threshold": "rerankThreshold",
1002
+ "rerank_model": "rerankModel",
1003
+ });
1004
+ });
1005
+
1006
+ /** @internal */
1007
+ export type CreateKnowledgeResponseBodyRerankConfig$Outbound = {
1008
+ top_k: number;
1009
+ rerank_threshold: number;
1010
+ rerank_model: string;
1011
+ };
1012
+
1013
+ /** @internal */
1014
+ export const CreateKnowledgeResponseBodyRerankConfig$outboundSchema: z.ZodType<
1015
+ CreateKnowledgeResponseBodyRerankConfig$Outbound,
1016
+ z.ZodTypeDef,
1017
+ CreateKnowledgeResponseBodyRerankConfig
1018
+ > = z.object({
1019
+ topK: z.number().int().default(5),
1020
+ rerankThreshold: z.number().default(0.5),
1021
+ rerankModel: z.string(),
1022
+ }).transform((v) => {
1023
+ return remap$(v, {
1024
+ topK: "top_k",
1025
+ rerankThreshold: "rerank_threshold",
1026
+ rerankModel: "rerank_model",
1027
+ });
1028
+ });
1029
+
1030
+ /**
1031
+ * @internal
1032
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1033
+ */
1034
+ export namespace CreateKnowledgeResponseBodyRerankConfig$ {
1035
+ /** @deprecated use `CreateKnowledgeResponseBodyRerankConfig$inboundSchema` instead. */
1036
+ export const inboundSchema =
1037
+ CreateKnowledgeResponseBodyRerankConfig$inboundSchema;
1038
+ /** @deprecated use `CreateKnowledgeResponseBodyRerankConfig$outboundSchema` instead. */
1039
+ export const outboundSchema =
1040
+ CreateKnowledgeResponseBodyRerankConfig$outboundSchema;
1041
+ /** @deprecated use `CreateKnowledgeResponseBodyRerankConfig$Outbound` instead. */
1042
+ export type Outbound = CreateKnowledgeResponseBodyRerankConfig$Outbound;
1043
+ }
1044
+
1045
+ export function createKnowledgeResponseBodyRerankConfigToJSON(
1046
+ createKnowledgeResponseBodyRerankConfig:
1047
+ CreateKnowledgeResponseBodyRerankConfig,
1048
+ ): string {
1049
+ return JSON.stringify(
1050
+ CreateKnowledgeResponseBodyRerankConfig$outboundSchema.parse(
1051
+ createKnowledgeResponseBodyRerankConfig,
1052
+ ),
1053
+ );
1054
+ }
1055
+
1056
+ export function createKnowledgeResponseBodyRerankConfigFromJSON(
1057
+ jsonString: string,
1058
+ ): SafeParseResult<
1059
+ CreateKnowledgeResponseBodyRerankConfig,
1060
+ SDKValidationError
1061
+ > {
1062
+ return safeParse(
1063
+ jsonString,
1064
+ (x) =>
1065
+ CreateKnowledgeResponseBodyRerankConfig$inboundSchema.parse(
1066
+ JSON.parse(x),
1067
+ ),
1068
+ `Failed to parse 'CreateKnowledgeResponseBodyRerankConfig' from JSON`,
1069
+ );
1070
+ }
1071
+
1072
+ /** @internal */
1073
+ export const CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema:
1074
+ z.ZodType<
1075
+ CreateKnowledgeResponseBodyAgenticRagConfig,
1076
+ z.ZodTypeDef,
1077
+ unknown
1078
+ > = z.object({
1079
+ model: z.string(),
1080
+ });
1081
+
1082
+ /** @internal */
1083
+ export type CreateKnowledgeResponseBodyAgenticRagConfig$Outbound = {
1084
+ model: string;
1085
+ };
1086
+
1087
+ /** @internal */
1088
+ export const CreateKnowledgeResponseBodyAgenticRagConfig$outboundSchema:
1089
+ z.ZodType<
1090
+ CreateKnowledgeResponseBodyAgenticRagConfig$Outbound,
1091
+ z.ZodTypeDef,
1092
+ CreateKnowledgeResponseBodyAgenticRagConfig
1093
+ > = z.object({
1094
+ model: z.string(),
1095
+ });
1096
+
1097
+ /**
1098
+ * @internal
1099
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1100
+ */
1101
+ export namespace CreateKnowledgeResponseBodyAgenticRagConfig$ {
1102
+ /** @deprecated use `CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema` instead. */
1103
+ export const inboundSchema =
1104
+ CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema;
1105
+ /** @deprecated use `CreateKnowledgeResponseBodyAgenticRagConfig$outboundSchema` instead. */
1106
+ export const outboundSchema =
1107
+ CreateKnowledgeResponseBodyAgenticRagConfig$outboundSchema;
1108
+ /** @deprecated use `CreateKnowledgeResponseBodyAgenticRagConfig$Outbound` instead. */
1109
+ export type Outbound = CreateKnowledgeResponseBodyAgenticRagConfig$Outbound;
1110
+ }
1111
+
1112
+ export function createKnowledgeResponseBodyAgenticRagConfigToJSON(
1113
+ createKnowledgeResponseBodyAgenticRagConfig:
1114
+ CreateKnowledgeResponseBodyAgenticRagConfig,
1115
+ ): string {
1116
+ return JSON.stringify(
1117
+ CreateKnowledgeResponseBodyAgenticRagConfig$outboundSchema.parse(
1118
+ createKnowledgeResponseBodyAgenticRagConfig,
1119
+ ),
1120
+ );
1121
+ }
1122
+
1123
+ export function createKnowledgeResponseBodyAgenticRagConfigFromJSON(
1124
+ jsonString: string,
1125
+ ): SafeParseResult<
1126
+ CreateKnowledgeResponseBodyAgenticRagConfig,
1127
+ SDKValidationError
1128
+ > {
1129
+ return safeParse(
1130
+ jsonString,
1131
+ (x) =>
1132
+ CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema.parse(
1133
+ JSON.parse(x),
1134
+ ),
1135
+ `Failed to parse 'CreateKnowledgeResponseBodyAgenticRagConfig' from JSON`,
1136
+ );
1137
+ }
1138
+
1139
+ /** @internal */
1140
+ export const CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema:
1141
+ z.ZodType<
1142
+ CreateKnowledgeResponseBodyRetrievalSettings,
1143
+ z.ZodTypeDef,
1144
+ unknown
1145
+ > = z.object({
1146
+ top_k: z.number().int().default(5),
1147
+ threshold: z.number().default(0),
1148
+ rerank_config: z.nullable(
1149
+ z.lazy(() => CreateKnowledgeResponseBodyRerankConfig$inboundSchema),
1150
+ ).optional(),
1151
+ agentic_rag_config: z.nullable(
1152
+ z.lazy(() => CreateKnowledgeResponseBodyAgenticRagConfig$inboundSchema),
1153
+ ).optional(),
1154
+ }).transform((v) => {
1155
+ return remap$(v, {
1156
+ "top_k": "topK",
1157
+ "rerank_config": "rerankConfig",
1158
+ "agentic_rag_config": "agenticRagConfig",
1159
+ });
1160
+ });
1161
+
1162
+ /** @internal */
1163
+ export type CreateKnowledgeResponseBodyRetrievalSettings$Outbound = {
1164
+ top_k: number;
1165
+ threshold: number;
1166
+ rerank_config?:
1167
+ | CreateKnowledgeResponseBodyRerankConfig$Outbound
1168
+ | null
1169
+ | undefined;
1170
+ agentic_rag_config?:
1171
+ | CreateKnowledgeResponseBodyAgenticRagConfig$Outbound
1172
+ | null
1173
+ | undefined;
1174
+ };
1175
+
1176
+ /** @internal */
1177
+ export const CreateKnowledgeResponseBodyRetrievalSettings$outboundSchema:
1178
+ z.ZodType<
1179
+ CreateKnowledgeResponseBodyRetrievalSettings$Outbound,
1180
+ z.ZodTypeDef,
1181
+ CreateKnowledgeResponseBodyRetrievalSettings
1182
+ > = z.object({
1183
+ topK: z.number().int().default(5),
1184
+ threshold: z.number().default(0),
1185
+ rerankConfig: z.nullable(
1186
+ z.lazy(() => CreateKnowledgeResponseBodyRerankConfig$outboundSchema),
1187
+ ).optional(),
1188
+ agenticRagConfig: z.nullable(
1189
+ z.lazy(() => CreateKnowledgeResponseBodyAgenticRagConfig$outboundSchema),
1190
+ ).optional(),
1191
+ }).transform((v) => {
1192
+ return remap$(v, {
1193
+ topK: "top_k",
1194
+ rerankConfig: "rerank_config",
1195
+ agenticRagConfig: "agentic_rag_config",
1196
+ });
1197
+ });
1198
+
1199
+ /**
1200
+ * @internal
1201
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1202
+ */
1203
+ export namespace CreateKnowledgeResponseBodyRetrievalSettings$ {
1204
+ /** @deprecated use `CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema` instead. */
1205
+ export const inboundSchema =
1206
+ CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema;
1207
+ /** @deprecated use `CreateKnowledgeResponseBodyRetrievalSettings$outboundSchema` instead. */
1208
+ export const outboundSchema =
1209
+ CreateKnowledgeResponseBodyRetrievalSettings$outboundSchema;
1210
+ /** @deprecated use `CreateKnowledgeResponseBodyRetrievalSettings$Outbound` instead. */
1211
+ export type Outbound = CreateKnowledgeResponseBodyRetrievalSettings$Outbound;
1212
+ }
1213
+
1214
+ export function createKnowledgeResponseBodyRetrievalSettingsToJSON(
1215
+ createKnowledgeResponseBodyRetrievalSettings:
1216
+ CreateKnowledgeResponseBodyRetrievalSettings,
1217
+ ): string {
1218
+ return JSON.stringify(
1219
+ CreateKnowledgeResponseBodyRetrievalSettings$outboundSchema.parse(
1220
+ createKnowledgeResponseBodyRetrievalSettings,
1221
+ ),
1222
+ );
1223
+ }
1224
+
1225
+ export function createKnowledgeResponseBodyRetrievalSettingsFromJSON(
1226
+ jsonString: string,
1227
+ ): SafeParseResult<
1228
+ CreateKnowledgeResponseBodyRetrievalSettings,
1229
+ SDKValidationError
1230
+ > {
1231
+ return safeParse(
1232
+ jsonString,
1233
+ (x) =>
1234
+ CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema.parse(
1235
+ JSON.parse(x),
1236
+ ),
1237
+ `Failed to parse 'CreateKnowledgeResponseBodyRetrievalSettings' from JSON`,
1238
+ );
1239
+ }
1240
+
1241
+ /** @internal */
1242
+ export const ResponseBodyExternalConfig$inboundSchema: z.ZodType<
1243
+ ResponseBodyExternalConfig,
1244
+ z.ZodTypeDef,
1245
+ unknown
1246
+ > = z.object({
1247
+ name: z.string(),
1248
+ api_url: z.string(),
1249
+ }).transform((v) => {
1250
+ return remap$(v, {
1251
+ "api_url": "apiUrl",
1252
+ });
1253
+ });
1254
+
1255
+ /** @internal */
1256
+ export type ResponseBodyExternalConfig$Outbound = {
1257
+ name: string;
1258
+ api_url: string;
1259
+ };
1260
+
1261
+ /** @internal */
1262
+ export const ResponseBodyExternalConfig$outboundSchema: z.ZodType<
1263
+ ResponseBodyExternalConfig$Outbound,
1264
+ z.ZodTypeDef,
1265
+ ResponseBodyExternalConfig
1266
+ > = z.object({
1267
+ name: z.string(),
1268
+ apiUrl: z.string(),
1269
+ }).transform((v) => {
1270
+ return remap$(v, {
1271
+ apiUrl: "api_url",
1272
+ });
1273
+ });
1274
+
1275
+ /**
1276
+ * @internal
1277
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1278
+ */
1279
+ export namespace ResponseBodyExternalConfig$ {
1280
+ /** @deprecated use `ResponseBodyExternalConfig$inboundSchema` instead. */
1281
+ export const inboundSchema = ResponseBodyExternalConfig$inboundSchema;
1282
+ /** @deprecated use `ResponseBodyExternalConfig$outboundSchema` instead. */
1283
+ export const outboundSchema = ResponseBodyExternalConfig$outboundSchema;
1284
+ /** @deprecated use `ResponseBodyExternalConfig$Outbound` instead. */
1285
+ export type Outbound = ResponseBodyExternalConfig$Outbound;
1286
+ }
1287
+
1288
+ export function responseBodyExternalConfigToJSON(
1289
+ responseBodyExternalConfig: ResponseBodyExternalConfig,
1290
+ ): string {
1291
+ return JSON.stringify(
1292
+ ResponseBodyExternalConfig$outboundSchema.parse(responseBodyExternalConfig),
1293
+ );
1294
+ }
1295
+
1296
+ export function responseBodyExternalConfigFromJSON(
1297
+ jsonString: string,
1298
+ ): SafeParseResult<ResponseBodyExternalConfig, SDKValidationError> {
1299
+ return safeParse(
1300
+ jsonString,
1301
+ (x) => ResponseBodyExternalConfig$inboundSchema.parse(JSON.parse(x)),
1302
+ `Failed to parse 'ResponseBodyExternalConfig' from JSON`,
1303
+ );
1304
+ }
1305
+
1306
+ /** @internal */
1307
+ export const CreateKnowledgeResponseBody2$inboundSchema: z.ZodType<
1308
+ CreateKnowledgeResponseBody2,
1309
+ z.ZodTypeDef,
1310
+ unknown
1311
+ > = z.object({
1312
+ _id: z.string(),
1313
+ created: z.string(),
1314
+ description: z.string().optional(),
1315
+ key: z.string(),
1316
+ domain_id: z.string(),
1317
+ path: z.string().optional(),
1318
+ created_by_id: z.nullable(z.string()).optional(),
1319
+ updated_by_id: z.nullable(z.string()).optional(),
1320
+ updated: z.string(),
1321
+ type: CreateKnowledgeResponseBodyKnowledgeType$inboundSchema.default(
1322
+ "external",
1323
+ ),
1324
+ retrieval_settings: z.lazy(() =>
1325
+ CreateKnowledgeResponseBodyRetrievalSettings$inboundSchema
1326
+ ).optional(),
1327
+ external_config: z.lazy(() => ResponseBodyExternalConfig$inboundSchema),
1328
+ }).transform((v) => {
1329
+ return remap$(v, {
1330
+ "_id": "id",
1331
+ "domain_id": "domainId",
1332
+ "created_by_id": "createdById",
1333
+ "updated_by_id": "updatedById",
1334
+ "retrieval_settings": "retrievalSettings",
1335
+ "external_config": "externalConfig",
1336
+ });
1337
+ });
1338
+
1339
+ /** @internal */
1340
+ export type CreateKnowledgeResponseBody2$Outbound = {
1341
+ _id: string;
1342
+ created: string;
1343
+ description?: string | undefined;
1344
+ key: string;
1345
+ domain_id: string;
1346
+ path?: string | undefined;
1347
+ created_by_id?: string | null | undefined;
1348
+ updated_by_id?: string | null | undefined;
1349
+ updated: string;
1350
+ type: string;
1351
+ retrieval_settings?:
1352
+ | CreateKnowledgeResponseBodyRetrievalSettings$Outbound
1353
+ | undefined;
1354
+ external_config: ResponseBodyExternalConfig$Outbound;
1355
+ };
1356
+
1357
+ /** @internal */
1358
+ export const CreateKnowledgeResponseBody2$outboundSchema: z.ZodType<
1359
+ CreateKnowledgeResponseBody2$Outbound,
1360
+ z.ZodTypeDef,
1361
+ CreateKnowledgeResponseBody2
1362
+ > = z.object({
1363
+ id: z.string(),
1364
+ created: z.string(),
1365
+ description: z.string().optional(),
1366
+ key: z.string(),
1367
+ domainId: z.string(),
1368
+ path: z.string().optional(),
1369
+ createdById: z.nullable(z.string()).optional(),
1370
+ updatedById: z.nullable(z.string()).optional(),
1371
+ updated: z.string(),
1372
+ type: CreateKnowledgeResponseBodyKnowledgeType$outboundSchema.default(
1373
+ "external",
1374
+ ),
1375
+ retrievalSettings: z.lazy(() =>
1376
+ CreateKnowledgeResponseBodyRetrievalSettings$outboundSchema
1377
+ ).optional(),
1378
+ externalConfig: z.lazy(() => ResponseBodyExternalConfig$outboundSchema),
1379
+ }).transform((v) => {
1380
+ return remap$(v, {
1381
+ id: "_id",
1382
+ domainId: "domain_id",
1383
+ createdById: "created_by_id",
1384
+ updatedById: "updated_by_id",
1385
+ retrievalSettings: "retrieval_settings",
1386
+ externalConfig: "external_config",
1387
+ });
1388
+ });
1389
+
1390
+ /**
1391
+ * @internal
1392
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1393
+ */
1394
+ export namespace CreateKnowledgeResponseBody2$ {
1395
+ /** @deprecated use `CreateKnowledgeResponseBody2$inboundSchema` instead. */
1396
+ export const inboundSchema = CreateKnowledgeResponseBody2$inboundSchema;
1397
+ /** @deprecated use `CreateKnowledgeResponseBody2$outboundSchema` instead. */
1398
+ export const outboundSchema = CreateKnowledgeResponseBody2$outboundSchema;
1399
+ /** @deprecated use `CreateKnowledgeResponseBody2$Outbound` instead. */
1400
+ export type Outbound = CreateKnowledgeResponseBody2$Outbound;
1401
+ }
1402
+
1403
+ export function createKnowledgeResponseBody2ToJSON(
1404
+ createKnowledgeResponseBody2: CreateKnowledgeResponseBody2,
1405
+ ): string {
1406
+ return JSON.stringify(
1407
+ CreateKnowledgeResponseBody2$outboundSchema.parse(
1408
+ createKnowledgeResponseBody2,
1409
+ ),
1410
+ );
1411
+ }
1412
+
1413
+ export function createKnowledgeResponseBody2FromJSON(
1414
+ jsonString: string,
1415
+ ): SafeParseResult<CreateKnowledgeResponseBody2, SDKValidationError> {
1416
+ return safeParse(
1417
+ jsonString,
1418
+ (x) => CreateKnowledgeResponseBody2$inboundSchema.parse(JSON.parse(x)),
1419
+ `Failed to parse 'CreateKnowledgeResponseBody2' from JSON`,
1420
+ );
1421
+ }
1422
+
1423
+ /** @internal */
1424
+ export const CreateKnowledgeResponseBodyType$inboundSchema: z.ZodNativeEnum<
1425
+ typeof CreateKnowledgeResponseBodyType
1426
+ > = z.nativeEnum(CreateKnowledgeResponseBodyType);
1427
+
1428
+ /** @internal */
1429
+ export const CreateKnowledgeResponseBodyType$outboundSchema: z.ZodNativeEnum<
1430
+ typeof CreateKnowledgeResponseBodyType
1431
+ > = CreateKnowledgeResponseBodyType$inboundSchema;
1432
+
1433
+ /**
1434
+ * @internal
1435
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1436
+ */
1437
+ export namespace CreateKnowledgeResponseBodyType$ {
1438
+ /** @deprecated use `CreateKnowledgeResponseBodyType$inboundSchema` instead. */
1439
+ export const inboundSchema = CreateKnowledgeResponseBodyType$inboundSchema;
1440
+ /** @deprecated use `CreateKnowledgeResponseBodyType$outboundSchema` instead. */
1441
+ export const outboundSchema = CreateKnowledgeResponseBodyType$outboundSchema;
1442
+ }
1443
+
1444
+ /** @internal */
1445
+ export const ResponseBodyRetrievalType$inboundSchema: z.ZodNativeEnum<
1446
+ typeof ResponseBodyRetrievalType
1447
+ > = z.nativeEnum(ResponseBodyRetrievalType);
1448
+
1449
+ /** @internal */
1450
+ export const ResponseBodyRetrievalType$outboundSchema: z.ZodNativeEnum<
1451
+ typeof ResponseBodyRetrievalType
1452
+ > = ResponseBodyRetrievalType$inboundSchema;
1453
+
1454
+ /**
1455
+ * @internal
1456
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1457
+ */
1458
+ export namespace ResponseBodyRetrievalType$ {
1459
+ /** @deprecated use `ResponseBodyRetrievalType$inboundSchema` instead. */
1460
+ export const inboundSchema = ResponseBodyRetrievalType$inboundSchema;
1461
+ /** @deprecated use `ResponseBodyRetrievalType$outboundSchema` instead. */
1462
+ export const outboundSchema = ResponseBodyRetrievalType$outboundSchema;
1463
+ }
1464
+
1465
+ /** @internal */
1466
+ export const ResponseBodyRerankConfig$inboundSchema: z.ZodType<
1467
+ ResponseBodyRerankConfig,
1468
+ z.ZodTypeDef,
1469
+ unknown
1470
+ > = z.object({
1471
+ top_k: z.number().int().default(5),
1472
+ rerank_threshold: z.number().default(0.5),
1473
+ rerank_model: z.string(),
1474
+ }).transform((v) => {
1475
+ return remap$(v, {
1476
+ "top_k": "topK",
1477
+ "rerank_threshold": "rerankThreshold",
1478
+ "rerank_model": "rerankModel",
1479
+ });
1480
+ });
1481
+
1482
+ /** @internal */
1483
+ export type ResponseBodyRerankConfig$Outbound = {
1484
+ top_k: number;
1485
+ rerank_threshold: number;
1486
+ rerank_model: string;
1487
+ };
1488
+
1489
+ /** @internal */
1490
+ export const ResponseBodyRerankConfig$outboundSchema: z.ZodType<
1491
+ ResponseBodyRerankConfig$Outbound,
1492
+ z.ZodTypeDef,
1493
+ ResponseBodyRerankConfig
1494
+ > = z.object({
1495
+ topK: z.number().int().default(5),
1496
+ rerankThreshold: z.number().default(0.5),
1497
+ rerankModel: z.string(),
1498
+ }).transform((v) => {
1499
+ return remap$(v, {
1500
+ topK: "top_k",
1501
+ rerankThreshold: "rerank_threshold",
1502
+ rerankModel: "rerank_model",
1503
+ });
1504
+ });
1505
+
1506
+ /**
1507
+ * @internal
1508
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1509
+ */
1510
+ export namespace ResponseBodyRerankConfig$ {
1511
+ /** @deprecated use `ResponseBodyRerankConfig$inboundSchema` instead. */
1512
+ export const inboundSchema = ResponseBodyRerankConfig$inboundSchema;
1513
+ /** @deprecated use `ResponseBodyRerankConfig$outboundSchema` instead. */
1514
+ export const outboundSchema = ResponseBodyRerankConfig$outboundSchema;
1515
+ /** @deprecated use `ResponseBodyRerankConfig$Outbound` instead. */
1516
+ export type Outbound = ResponseBodyRerankConfig$Outbound;
1517
+ }
1518
+
1519
+ export function responseBodyRerankConfigToJSON(
1520
+ responseBodyRerankConfig: ResponseBodyRerankConfig,
1521
+ ): string {
1522
+ return JSON.stringify(
1523
+ ResponseBodyRerankConfig$outboundSchema.parse(responseBodyRerankConfig),
1524
+ );
1525
+ }
1526
+
1527
+ export function responseBodyRerankConfigFromJSON(
1528
+ jsonString: string,
1529
+ ): SafeParseResult<ResponseBodyRerankConfig, SDKValidationError> {
1530
+ return safeParse(
1531
+ jsonString,
1532
+ (x) => ResponseBodyRerankConfig$inboundSchema.parse(JSON.parse(x)),
1533
+ `Failed to parse 'ResponseBodyRerankConfig' from JSON`,
1534
+ );
1535
+ }
1536
+
1537
+ /** @internal */
1538
+ export const ResponseBodyAgenticRagConfig$inboundSchema: z.ZodType<
1539
+ ResponseBodyAgenticRagConfig,
1540
+ z.ZodTypeDef,
1541
+ unknown
1542
+ > = z.object({
1543
+ model: z.string(),
1544
+ });
1545
+
1546
+ /** @internal */
1547
+ export type ResponseBodyAgenticRagConfig$Outbound = {
1548
+ model: string;
1549
+ };
1550
+
1551
+ /** @internal */
1552
+ export const ResponseBodyAgenticRagConfig$outboundSchema: z.ZodType<
1553
+ ResponseBodyAgenticRagConfig$Outbound,
1554
+ z.ZodTypeDef,
1555
+ ResponseBodyAgenticRagConfig
1556
+ > = z.object({
1557
+ model: z.string(),
1558
+ });
1559
+
1560
+ /**
1561
+ * @internal
1562
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1563
+ */
1564
+ export namespace ResponseBodyAgenticRagConfig$ {
1565
+ /** @deprecated use `ResponseBodyAgenticRagConfig$inboundSchema` instead. */
1566
+ export const inboundSchema = ResponseBodyAgenticRagConfig$inboundSchema;
1567
+ /** @deprecated use `ResponseBodyAgenticRagConfig$outboundSchema` instead. */
1568
+ export const outboundSchema = ResponseBodyAgenticRagConfig$outboundSchema;
1569
+ /** @deprecated use `ResponseBodyAgenticRagConfig$Outbound` instead. */
1570
+ export type Outbound = ResponseBodyAgenticRagConfig$Outbound;
1571
+ }
1572
+
1573
+ export function responseBodyAgenticRagConfigToJSON(
1574
+ responseBodyAgenticRagConfig: ResponseBodyAgenticRagConfig,
1575
+ ): string {
1576
+ return JSON.stringify(
1577
+ ResponseBodyAgenticRagConfig$outboundSchema.parse(
1578
+ responseBodyAgenticRagConfig,
1579
+ ),
1580
+ );
1581
+ }
1582
+
1583
+ export function responseBodyAgenticRagConfigFromJSON(
1584
+ jsonString: string,
1585
+ ): SafeParseResult<ResponseBodyAgenticRagConfig, SDKValidationError> {
1586
+ return safeParse(
1587
+ jsonString,
1588
+ (x) => ResponseBodyAgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
1589
+ `Failed to parse 'ResponseBodyAgenticRagConfig' from JSON`,
1590
+ );
1591
+ }
1592
+
1593
+ /** @internal */
1594
+ export const ResponseBodyRetrievalSettings$inboundSchema: z.ZodType<
1595
+ ResponseBodyRetrievalSettings,
1596
+ z.ZodTypeDef,
1597
+ unknown
1598
+ > = z.object({
1599
+ retrieval_type: ResponseBodyRetrievalType$inboundSchema.default(
1600
+ "hybrid_search",
1601
+ ),
1602
+ top_k: z.number().int().default(5),
1603
+ threshold: z.number().default(0),
1604
+ rerank_config: z.nullable(
1605
+ z.lazy(() => ResponseBodyRerankConfig$inboundSchema),
1606
+ ).optional(),
1607
+ agentic_rag_config: z.nullable(
1608
+ z.lazy(() => ResponseBodyAgenticRagConfig$inboundSchema),
1609
+ ).optional(),
1610
+ }).transform((v) => {
1611
+ return remap$(v, {
1612
+ "retrieval_type": "retrievalType",
1613
+ "top_k": "topK",
1614
+ "rerank_config": "rerankConfig",
1615
+ "agentic_rag_config": "agenticRagConfig",
1616
+ });
1617
+ });
1618
+
1619
+ /** @internal */
1620
+ export type ResponseBodyRetrievalSettings$Outbound = {
1621
+ retrieval_type: string;
1622
+ top_k: number;
1623
+ threshold: number;
1624
+ rerank_config?: ResponseBodyRerankConfig$Outbound | null | undefined;
1625
+ agentic_rag_config?: ResponseBodyAgenticRagConfig$Outbound | null | undefined;
1626
+ };
1627
+
1628
+ /** @internal */
1629
+ export const ResponseBodyRetrievalSettings$outboundSchema: z.ZodType<
1630
+ ResponseBodyRetrievalSettings$Outbound,
1631
+ z.ZodTypeDef,
1632
+ ResponseBodyRetrievalSettings
1633
+ > = z.object({
1634
+ retrievalType: ResponseBodyRetrievalType$outboundSchema.default(
1635
+ "hybrid_search",
1636
+ ),
1637
+ topK: z.number().int().default(5),
1638
+ threshold: z.number().default(0),
1639
+ rerankConfig: z.nullable(
1640
+ z.lazy(() => ResponseBodyRerankConfig$outboundSchema),
1641
+ ).optional(),
1642
+ agenticRagConfig: z.nullable(
1643
+ z.lazy(() => ResponseBodyAgenticRagConfig$outboundSchema),
1644
+ ).optional(),
1645
+ }).transform((v) => {
1646
+ return remap$(v, {
1647
+ retrievalType: "retrieval_type",
1648
+ topK: "top_k",
1649
+ rerankConfig: "rerank_config",
1650
+ agenticRagConfig: "agentic_rag_config",
1651
+ });
1652
+ });
1653
+
1654
+ /**
1655
+ * @internal
1656
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1657
+ */
1658
+ export namespace ResponseBodyRetrievalSettings$ {
1659
+ /** @deprecated use `ResponseBodyRetrievalSettings$inboundSchema` instead. */
1660
+ export const inboundSchema = ResponseBodyRetrievalSettings$inboundSchema;
1661
+ /** @deprecated use `ResponseBodyRetrievalSettings$outboundSchema` instead. */
1662
+ export const outboundSchema = ResponseBodyRetrievalSettings$outboundSchema;
1663
+ /** @deprecated use `ResponseBodyRetrievalSettings$Outbound` instead. */
1664
+ export type Outbound = ResponseBodyRetrievalSettings$Outbound;
1665
+ }
1666
+
1667
+ export function responseBodyRetrievalSettingsToJSON(
1668
+ responseBodyRetrievalSettings: ResponseBodyRetrievalSettings,
1669
+ ): string {
1670
+ return JSON.stringify(
1671
+ ResponseBodyRetrievalSettings$outboundSchema.parse(
1672
+ responseBodyRetrievalSettings,
1673
+ ),
1674
+ );
1675
+ }
1676
+
1677
+ export function responseBodyRetrievalSettingsFromJSON(
1678
+ jsonString: string,
1679
+ ): SafeParseResult<ResponseBodyRetrievalSettings, SDKValidationError> {
1680
+ return safeParse(
1681
+ jsonString,
1682
+ (x) => ResponseBodyRetrievalSettings$inboundSchema.parse(JSON.parse(x)),
1683
+ `Failed to parse 'ResponseBodyRetrievalSettings' from JSON`,
1684
+ );
1685
+ }
1686
+
1687
+ /** @internal */
1688
+ export const CreateKnowledgeResponseBody1$inboundSchema: z.ZodType<
1689
+ CreateKnowledgeResponseBody1,
1690
+ z.ZodTypeDef,
1691
+ unknown
1692
+ > = z.object({
1693
+ _id: z.string(),
1694
+ created: z.string(),
1695
+ description: z.string().optional(),
1696
+ key: z.string(),
1697
+ domain_id: z.string(),
1698
+ path: z.string().optional(),
1699
+ created_by_id: z.nullable(z.string()).optional(),
1700
+ updated_by_id: z.nullable(z.string()).optional(),
1701
+ updated: z.string(),
1702
+ type: CreateKnowledgeResponseBodyType$inboundSchema.default("internal"),
1703
+ retrieval_settings: z.lazy(() => ResponseBodyRetrievalSettings$inboundSchema)
1704
+ .optional(),
1705
+ model: z.string(),
1706
+ }).transform((v) => {
1707
+ return remap$(v, {
1708
+ "_id": "id",
1709
+ "domain_id": "domainId",
1710
+ "created_by_id": "createdById",
1711
+ "updated_by_id": "updatedById",
1712
+ "retrieval_settings": "retrievalSettings",
1713
+ });
1714
+ });
1715
+
1716
+ /** @internal */
1717
+ export type CreateKnowledgeResponseBody1$Outbound = {
1718
+ _id: string;
1719
+ created: string;
1720
+ description?: string | undefined;
1721
+ key: string;
1722
+ domain_id: string;
1723
+ path?: string | undefined;
1724
+ created_by_id?: string | null | undefined;
1725
+ updated_by_id?: string | null | undefined;
1726
+ updated: string;
1727
+ type: string;
1728
+ retrieval_settings?: ResponseBodyRetrievalSettings$Outbound | undefined;
1729
+ model: string;
1730
+ };
1731
+
1732
+ /** @internal */
1733
+ export const CreateKnowledgeResponseBody1$outboundSchema: z.ZodType<
1734
+ CreateKnowledgeResponseBody1$Outbound,
1735
+ z.ZodTypeDef,
1736
+ CreateKnowledgeResponseBody1
1737
+ > = z.object({
1738
+ id: z.string(),
1739
+ created: z.string(),
1740
+ description: z.string().optional(),
1741
+ key: z.string(),
1742
+ domainId: z.string(),
1743
+ path: z.string().optional(),
1744
+ createdById: z.nullable(z.string()).optional(),
1745
+ updatedById: z.nullable(z.string()).optional(),
1746
+ updated: z.string(),
1747
+ type: CreateKnowledgeResponseBodyType$outboundSchema.default("internal"),
1748
+ retrievalSettings: z.lazy(() => ResponseBodyRetrievalSettings$outboundSchema)
1749
+ .optional(),
1750
+ model: z.string(),
1751
+ }).transform((v) => {
1752
+ return remap$(v, {
1753
+ id: "_id",
1754
+ domainId: "domain_id",
1755
+ createdById: "created_by_id",
1756
+ updatedById: "updated_by_id",
1757
+ retrievalSettings: "retrieval_settings",
1758
+ });
1759
+ });
1760
+
1761
+ /**
1762
+ * @internal
1763
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1764
+ */
1765
+ export namespace CreateKnowledgeResponseBody1$ {
1766
+ /** @deprecated use `CreateKnowledgeResponseBody1$inboundSchema` instead. */
1767
+ export const inboundSchema = CreateKnowledgeResponseBody1$inboundSchema;
1768
+ /** @deprecated use `CreateKnowledgeResponseBody1$outboundSchema` instead. */
1769
+ export const outboundSchema = CreateKnowledgeResponseBody1$outboundSchema;
1770
+ /** @deprecated use `CreateKnowledgeResponseBody1$Outbound` instead. */
1771
+ export type Outbound = CreateKnowledgeResponseBody1$Outbound;
1772
+ }
1773
+
1774
+ export function createKnowledgeResponseBody1ToJSON(
1775
+ createKnowledgeResponseBody1: CreateKnowledgeResponseBody1,
1776
+ ): string {
1777
+ return JSON.stringify(
1778
+ CreateKnowledgeResponseBody1$outboundSchema.parse(
1779
+ createKnowledgeResponseBody1,
1780
+ ),
1781
+ );
1782
+ }
1783
+
1784
+ export function createKnowledgeResponseBody1FromJSON(
1785
+ jsonString: string,
1786
+ ): SafeParseResult<CreateKnowledgeResponseBody1, SDKValidationError> {
1787
+ return safeParse(
1788
+ jsonString,
1789
+ (x) => CreateKnowledgeResponseBody1$inboundSchema.parse(JSON.parse(x)),
1790
+ `Failed to parse 'CreateKnowledgeResponseBody1' from JSON`,
1791
+ );
1792
+ }
1793
+
1794
+ /** @internal */
1795
+ export const CreateKnowledgeResponseBody$inboundSchema: z.ZodType<
1796
+ CreateKnowledgeResponseBody,
1797
+ z.ZodTypeDef,
1798
+ unknown
1799
+ > = z.union([
1800
+ z.lazy(() => CreateKnowledgeResponseBody1$inboundSchema),
1801
+ z.lazy(() => CreateKnowledgeResponseBody2$inboundSchema),
1802
+ ]);
1803
+
1804
+ /** @internal */
1805
+ export type CreateKnowledgeResponseBody$Outbound =
1806
+ | CreateKnowledgeResponseBody1$Outbound
1807
+ | CreateKnowledgeResponseBody2$Outbound;
1808
+
1809
+ /** @internal */
1810
+ export const CreateKnowledgeResponseBody$outboundSchema: z.ZodType<
1811
+ CreateKnowledgeResponseBody$Outbound,
1812
+ z.ZodTypeDef,
1813
+ CreateKnowledgeResponseBody
1814
+ > = z.union([
1815
+ z.lazy(() => CreateKnowledgeResponseBody1$outboundSchema),
1816
+ z.lazy(() => CreateKnowledgeResponseBody2$outboundSchema),
1817
+ ]);
1818
+
1819
+ /**
1820
+ * @internal
1821
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1822
+ */
1823
+ export namespace CreateKnowledgeResponseBody$ {
1824
+ /** @deprecated use `CreateKnowledgeResponseBody$inboundSchema` instead. */
1825
+ export const inboundSchema = CreateKnowledgeResponseBody$inboundSchema;
1826
+ /** @deprecated use `CreateKnowledgeResponseBody$outboundSchema` instead. */
1827
+ export const outboundSchema = CreateKnowledgeResponseBody$outboundSchema;
1828
+ /** @deprecated use `CreateKnowledgeResponseBody$Outbound` instead. */
1829
+ export type Outbound = CreateKnowledgeResponseBody$Outbound;
1830
+ }
1831
+
1832
+ export function createKnowledgeResponseBodyToJSON(
1833
+ createKnowledgeResponseBody: CreateKnowledgeResponseBody,
1834
+ ): string {
1835
+ return JSON.stringify(
1836
+ CreateKnowledgeResponseBody$outboundSchema.parse(
1837
+ createKnowledgeResponseBody,
1838
+ ),
1839
+ );
1840
+ }
1841
+
1842
+ export function createKnowledgeResponseBodyFromJSON(
1843
+ jsonString: string,
1844
+ ): SafeParseResult<CreateKnowledgeResponseBody, SDKValidationError> {
1845
+ return safeParse(
1846
+ jsonString,
1847
+ (x) => CreateKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
1848
+ `Failed to parse 'CreateKnowledgeResponseBody' from JSON`,
1849
+ );
1850
+ }