@orq-ai/node 4.0.5 → 4.1.0-rc.1

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