@orq-ai/node 3.6.0 → 3.7.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 (284) hide show
  1. package/bin/mcp-server.js +40 -43
  2. package/bin/mcp-server.js.map +24 -24
  3. package/jsr.json +1 -1
  4. package/lib/config.d.ts +2 -2
  5. package/lib/config.js +2 -2
  6. package/lib/config.js.map +1 -1
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/mcp-server.js.map +1 -1
  9. package/mcp-server/server.js +1 -1
  10. package/mcp-server/server.js.map +1 -1
  11. package/models/operations/bulkcreatedatapoints.js +2 -2
  12. package/models/operations/createcontact.js +2 -2
  13. package/models/operations/createdataset.js +2 -2
  14. package/models/operations/createdatasetitem.js +2 -2
  15. package/models/operations/createdatasource.js +2 -2
  16. package/models/operations/fileget.js +2 -2
  17. package/models/operations/filelist.js +2 -2
  18. package/models/operations/fileupload.js +2 -2
  19. package/models/operations/listdatasetdatapoints.js +2 -2
  20. package/models/operations/listdatasets.js +2 -2
  21. package/models/operations/listdatasources.js +2 -2
  22. package/models/operations/retrievedatapoint.js +2 -2
  23. package/models/operations/retrievedataset.js +2 -2
  24. package/models/operations/retrievedatasource.js +2 -2
  25. package/models/operations/updatedatapoint.js +2 -2
  26. package/models/operations/updatedataset.js +2 -2
  27. package/models/operations/updatedatasource.js +2 -2
  28. package/package.json +3 -2
  29. package/src/lib/config.ts +2 -2
  30. package/src/mcp-server/mcp-server.ts +1 -1
  31. package/src/mcp-server/server.ts +1 -1
  32. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  33. package/src/models/operations/createcontact.ts +2 -2
  34. package/src/models/operations/createdataset.ts +2 -2
  35. package/src/models/operations/createdatasetitem.ts +2 -2
  36. package/src/models/operations/createdatasource.ts +2 -2
  37. package/src/models/operations/fileget.ts +2 -2
  38. package/src/models/operations/filelist.ts +2 -2
  39. package/src/models/operations/fileupload.ts +2 -2
  40. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  41. package/src/models/operations/listdatasets.ts +2 -2
  42. package/src/models/operations/listdatasources.ts +2 -2
  43. package/src/models/operations/retrievedatapoint.ts +2 -2
  44. package/src/models/operations/retrievedataset.ts +2 -2
  45. package/src/models/operations/retrievedatasource.ts +2 -2
  46. package/src/models/operations/updatedatapoint.ts +2 -2
  47. package/src/models/operations/updatedataset.ts +2 -2
  48. package/src/models/operations/updatedatasource.ts +2 -2
  49. package/packages/orq-rc/FUNCTIONS.md +0 -106
  50. package/packages/orq-rc/README.md +0 -707
  51. package/packages/orq-rc/RUNTIMES.md +0 -48
  52. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  53. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -1027
  54. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -405
  55. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  56. package/packages/orq-rc/docs/sdks/files/README.md +0 -311
  57. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1285
  58. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  59. package/packages/orq-rc/docs/sdks/models/README.md +0 -79
  60. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  61. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -576
  62. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
  63. package/packages/orq-rc/jsr.json +0 -28
  64. package/packages/orq-rc/package-lock.json +0 -3217
  65. package/packages/orq-rc/package.json +0 -45
  66. package/packages/orq-rc/src/core.ts +0 -13
  67. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -154
  68. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -161
  69. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -159
  70. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -161
  71. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +0 -165
  72. package/packages/orq-rc/src/funcs/datasetsCreateExperiment.ts +0 -162
  73. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -161
  74. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -176
  75. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -161
  76. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -168
  77. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -169
  78. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -175
  79. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -170
  80. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -173
  81. package/packages/orq-rc/src/funcs/deploymentsCreateExperiment.ts +0 -167
  82. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -162
  83. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -170
  84. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -170
  85. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -162
  86. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -178
  87. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -154
  88. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -174
  89. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -158
  90. package/packages/orq-rc/src/funcs/filesGet.ts +0 -160
  91. package/packages/orq-rc/src/funcs/filesList.ts +0 -161
  92. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -152
  93. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -165
  94. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -160
  95. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -161
  96. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -168
  97. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -167
  98. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -163
  99. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -172
  100. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -168
  101. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -160
  102. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -167
  103. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -163
  104. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -161
  105. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -158
  106. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -168
  107. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -164
  108. package/packages/orq-rc/src/funcs/modelsList.ts +0 -136
  109. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -154
  110. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -158
  111. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -175
  112. package/packages/orq-rc/src/funcs/promptsList.ts +0 -161
  113. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -167
  114. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -160
  115. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -167
  116. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -155
  117. package/packages/orq-rc/src/hooks/global.ts +0 -44
  118. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  119. package/packages/orq-rc/src/hooks/index.ts +0 -6
  120. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  121. package/packages/orq-rc/src/hooks/types.ts +0 -110
  122. package/packages/orq-rc/src/index.ts +0 -7
  123. package/packages/orq-rc/src/lib/base64.ts +0 -37
  124. package/packages/orq-rc/src/lib/config.ts +0 -70
  125. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  126. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  127. package/packages/orq-rc/src/lib/env.ts +0 -73
  128. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  129. package/packages/orq-rc/src/lib/files.ts +0 -40
  130. package/packages/orq-rc/src/lib/http.ts +0 -323
  131. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  132. package/packages/orq-rc/src/lib/logger.ts +0 -9
  133. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  134. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  135. package/packages/orq-rc/src/lib/retries.ts +0 -218
  136. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  137. package/packages/orq-rc/src/lib/sdks.ts +0 -401
  138. package/packages/orq-rc/src/lib/security.ts +0 -261
  139. package/packages/orq-rc/src/lib/url.ts +0 -33
  140. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -125
  141. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -140
  142. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  143. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  144. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  145. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  146. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  147. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  148. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  149. package/packages/orq-rc/src/mcp-server/server.ts +0 -163
  150. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  151. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  152. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  153. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  154. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  155. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +0 -37
  156. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateExperiment.ts +0 -37
  157. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  158. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  159. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  160. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  161. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  162. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  163. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  164. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  165. package/packages/orq-rc/src/mcp-server/tools/deploymentsCreateExperiment.ts +0 -37
  166. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  167. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  168. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  169. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  170. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  171. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  172. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  173. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  174. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  175. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  176. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  177. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  178. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  179. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  180. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  181. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  182. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  183. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  184. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  185. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  186. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  187. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  188. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  189. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  190. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  191. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  192. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  193. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  194. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  195. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  196. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  197. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  198. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  199. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  200. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  201. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  202. package/packages/orq-rc/src/models/components/deployments.ts +0 -7289
  203. package/packages/orq-rc/src/models/components/index.ts +0 -6
  204. package/packages/orq-rc/src/models/components/security.ts +0 -71
  205. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  206. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
  207. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  208. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  209. package/packages/orq-rc/src/models/errors/index.ts +0 -10
  210. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  211. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
  212. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +0 -2232
  213. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  214. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -432
  215. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  216. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  217. package/packages/orq-rc/src/models/operations/createdatasetexperiment.ts +0 -307
  218. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -2149
  219. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  220. package/packages/orq-rc/src/models/operations/createdeploymentexperiment.ts +0 -321
  221. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  222. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -846
  223. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -4079
  224. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  225. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  226. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  227. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  228. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  229. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  230. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5435
  231. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -9378
  232. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1255
  233. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2316
  234. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -9499
  235. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  236. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  237. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  238. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  239. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2294
  240. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  241. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -537
  242. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2155
  243. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2160
  244. package/packages/orq-rc/src/models/operations/index.ts +0 -54
  245. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  246. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1276
  247. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  248. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  249. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -663
  250. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  251. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2292
  252. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  253. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -1126
  254. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  255. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  256. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3367
  257. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  258. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -2139
  259. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  260. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  261. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -980
  262. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -4261
  263. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  264. package/packages/orq-rc/src/sdk/datasets.ts +0 -240
  265. package/packages/orq-rc/src/sdk/deployments.ts +0 -107
  266. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  267. package/packages/orq-rc/src/sdk/files.ts +0 -78
  268. package/packages/orq-rc/src/sdk/index.ts +0 -5
  269. package/packages/orq-rc/src/sdk/knowledge.ts +0 -264
  270. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  271. package/packages/orq-rc/src/sdk/models.ts +0 -25
  272. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  273. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  274. package/packages/orq-rc/src/sdk/sdk.ts +0 -61
  275. package/packages/orq-rc/src/types/async.ts +0 -68
  276. package/packages/orq-rc/src/types/blobs.ts +0 -31
  277. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  278. package/packages/orq-rc/src/types/enums.ts +0 -16
  279. package/packages/orq-rc/src/types/fp.ts +0 -50
  280. package/packages/orq-rc/src/types/index.ts +0 -11
  281. package/packages/orq-rc/src/types/operations.ts +0 -105
  282. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  283. package/packages/orq-rc/src/types/streams.ts +0 -21
  284. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,846 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
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 RetrievalType = {
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 RetrievalType = ClosedEnum<typeof RetrievalType>;
24
-
25
- /**
26
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
27
- */
28
- export type RerankConfig = {
29
- /**
30
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
31
- */
32
- rerankThreshold?: number | undefined;
33
- /**
34
- * The rerank model to use for the knowledge base.
35
- */
36
- rerankModel: string;
37
- };
38
-
39
- /**
40
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
41
- */
42
- export type AgenticRagConfig = {
43
- /**
44
- * The model to use for the Agentic RAG
45
- */
46
- model: string;
47
- };
48
-
49
- /**
50
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
51
- */
52
- export type RetrievalSettings = {
53
- /**
54
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
55
- */
56
- retrievalType?: RetrievalType | undefined;
57
- /**
58
- * The number of results to return from the search.
59
- */
60
- topK?: number | undefined;
61
- /**
62
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
63
- */
64
- threshold?: number | undefined;
65
- /**
66
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
67
- */
68
- rerankConfig?: RerankConfig | null | undefined;
69
- /**
70
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
71
- */
72
- agenticRagConfig?: AgenticRagConfig | null | undefined;
73
- };
74
-
75
- export type CreateKnowledgeRequestBody = {
76
- key: string;
77
- description?: string | undefined;
78
- /**
79
- * The embeddings model to use for the knowledge base. This model will be used to embed the chunks when they are added to the knowledge base.
80
- */
81
- embeddingModel: string;
82
- /**
83
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
84
- */
85
- retrievalSettings?: RetrievalSettings | undefined;
86
- /**
87
- * The path where the entity is stored in the project structure. The first element of the path always represents the project name. Any subsequent path element after the project will be created as a folder in the project if it does not exists.
88
- */
89
- path: string;
90
- };
91
-
92
- /**
93
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
94
- */
95
- export const CreateKnowledgeRetrievalType = {
96
- VectorSearch: "vector_search",
97
- KeywordSearch: "keyword_search",
98
- HybridSearch: "hybrid_search",
99
- } as const;
100
- /**
101
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
102
- */
103
- export type CreateKnowledgeRetrievalType = ClosedEnum<
104
- typeof CreateKnowledgeRetrievalType
105
- >;
106
-
107
- /**
108
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
109
- */
110
- export type CreateKnowledgeRerankConfig = {
111
- /**
112
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
113
- */
114
- rerankThreshold?: number | undefined;
115
- /**
116
- * The rerank model to use for the knowledge base.
117
- */
118
- rerankModel: string;
119
- };
120
-
121
- /**
122
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
123
- */
124
- export type CreateKnowledgeAgenticRagConfig = {
125
- /**
126
- * The model to use for the Agentic RAG
127
- */
128
- model: string;
129
- };
130
-
131
- /**
132
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
133
- */
134
- export type CreateKnowledgeRetrievalSettings = {
135
- /**
136
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
137
- */
138
- retrievalType?: CreateKnowledgeRetrievalType | undefined;
139
- /**
140
- * The number of results to return from the search.
141
- */
142
- topK?: number | undefined;
143
- /**
144
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
145
- */
146
- threshold?: number | undefined;
147
- /**
148
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
149
- */
150
- rerankConfig?: CreateKnowledgeRerankConfig | null | undefined;
151
- /**
152
- * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
153
- */
154
- agenticRagConfig?: CreateKnowledgeAgenticRagConfig | null | undefined;
155
- };
156
-
157
- /**
158
- * Knowledge Base object
159
- */
160
- export type CreateKnowledgeResponseBody = {
161
- /**
162
- * The unique identifier of the knowledge base.
163
- */
164
- id: string;
165
- /**
166
- * The creation date of the knowledge base.
167
- */
168
- created: string;
169
- /**
170
- * The description of the knowledge base.
171
- */
172
- description?: string | undefined;
173
- /**
174
- * The unique key of the knowledge base.
175
- */
176
- key: string;
177
- /**
178
- * The embeddings model used for the knowledge base.
179
- */
180
- model: string;
181
- /**
182
- * The project/domain ID of the knowledge base.
183
- */
184
- domainId: string;
185
- /**
186
- * The path where the entity is stored in the project structure. The first element of the path always represents the project name. Any subsequent path element after the project will be created as a folder in the project if it does not exists.
187
- */
188
- path?: string | undefined;
189
- /**
190
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
191
- */
192
- retrievalSettings?: CreateKnowledgeRetrievalSettings | undefined;
193
- createdById?: string | null | undefined;
194
- updatedById?: string | null | undefined;
195
- /**
196
- * The last update date of the knowledge base.
197
- */
198
- updated: string;
199
- };
200
-
201
- /** @internal */
202
- export const RetrievalType$inboundSchema: z.ZodNativeEnum<
203
- typeof RetrievalType
204
- > = z.nativeEnum(RetrievalType);
205
-
206
- /** @internal */
207
- export const RetrievalType$outboundSchema: z.ZodNativeEnum<
208
- typeof RetrievalType
209
- > = RetrievalType$inboundSchema;
210
-
211
- /**
212
- * @internal
213
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
214
- */
215
- export namespace RetrievalType$ {
216
- /** @deprecated use `RetrievalType$inboundSchema` instead. */
217
- export const inboundSchema = RetrievalType$inboundSchema;
218
- /** @deprecated use `RetrievalType$outboundSchema` instead. */
219
- export const outboundSchema = RetrievalType$outboundSchema;
220
- }
221
-
222
- /** @internal */
223
- export const RerankConfig$inboundSchema: z.ZodType<
224
- RerankConfig,
225
- z.ZodTypeDef,
226
- unknown
227
- > = z.object({
228
- rerank_threshold: z.number().default(0.5),
229
- rerank_model: z.string(),
230
- }).transform((v) => {
231
- return remap$(v, {
232
- "rerank_threshold": "rerankThreshold",
233
- "rerank_model": "rerankModel",
234
- });
235
- });
236
-
237
- /** @internal */
238
- export type RerankConfig$Outbound = {
239
- rerank_threshold: number;
240
- rerank_model: string;
241
- };
242
-
243
- /** @internal */
244
- export const RerankConfig$outboundSchema: z.ZodType<
245
- RerankConfig$Outbound,
246
- z.ZodTypeDef,
247
- RerankConfig
248
- > = z.object({
249
- rerankThreshold: z.number().default(0.5),
250
- rerankModel: z.string(),
251
- }).transform((v) => {
252
- return remap$(v, {
253
- rerankThreshold: "rerank_threshold",
254
- rerankModel: "rerank_model",
255
- });
256
- });
257
-
258
- /**
259
- * @internal
260
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
261
- */
262
- export namespace RerankConfig$ {
263
- /** @deprecated use `RerankConfig$inboundSchema` instead. */
264
- export const inboundSchema = RerankConfig$inboundSchema;
265
- /** @deprecated use `RerankConfig$outboundSchema` instead. */
266
- export const outboundSchema = RerankConfig$outboundSchema;
267
- /** @deprecated use `RerankConfig$Outbound` instead. */
268
- export type Outbound = RerankConfig$Outbound;
269
- }
270
-
271
- export function rerankConfigToJSON(rerankConfig: RerankConfig): string {
272
- return JSON.stringify(RerankConfig$outboundSchema.parse(rerankConfig));
273
- }
274
-
275
- export function rerankConfigFromJSON(
276
- jsonString: string,
277
- ): SafeParseResult<RerankConfig, SDKValidationError> {
278
- return safeParse(
279
- jsonString,
280
- (x) => RerankConfig$inboundSchema.parse(JSON.parse(x)),
281
- `Failed to parse 'RerankConfig' from JSON`,
282
- );
283
- }
284
-
285
- /** @internal */
286
- export const AgenticRagConfig$inboundSchema: z.ZodType<
287
- AgenticRagConfig,
288
- z.ZodTypeDef,
289
- unknown
290
- > = z.object({
291
- model: z.string(),
292
- });
293
-
294
- /** @internal */
295
- export type AgenticRagConfig$Outbound = {
296
- model: string;
297
- };
298
-
299
- /** @internal */
300
- export const AgenticRagConfig$outboundSchema: z.ZodType<
301
- AgenticRagConfig$Outbound,
302
- z.ZodTypeDef,
303
- AgenticRagConfig
304
- > = z.object({
305
- model: z.string(),
306
- });
307
-
308
- /**
309
- * @internal
310
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
311
- */
312
- export namespace AgenticRagConfig$ {
313
- /** @deprecated use `AgenticRagConfig$inboundSchema` instead. */
314
- export const inboundSchema = AgenticRagConfig$inboundSchema;
315
- /** @deprecated use `AgenticRagConfig$outboundSchema` instead. */
316
- export const outboundSchema = AgenticRagConfig$outboundSchema;
317
- /** @deprecated use `AgenticRagConfig$Outbound` instead. */
318
- export type Outbound = AgenticRagConfig$Outbound;
319
- }
320
-
321
- export function agenticRagConfigToJSON(
322
- agenticRagConfig: AgenticRagConfig,
323
- ): string {
324
- return JSON.stringify(
325
- AgenticRagConfig$outboundSchema.parse(agenticRagConfig),
326
- );
327
- }
328
-
329
- export function agenticRagConfigFromJSON(
330
- jsonString: string,
331
- ): SafeParseResult<AgenticRagConfig, SDKValidationError> {
332
- return safeParse(
333
- jsonString,
334
- (x) => AgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
335
- `Failed to parse 'AgenticRagConfig' from JSON`,
336
- );
337
- }
338
-
339
- /** @internal */
340
- export const RetrievalSettings$inboundSchema: z.ZodType<
341
- RetrievalSettings,
342
- z.ZodTypeDef,
343
- unknown
344
- > = z.object({
345
- retrieval_type: RetrievalType$inboundSchema.default("hybrid_search"),
346
- top_k: z.number().int().default(5),
347
- threshold: z.number().default(0),
348
- rerank_config: z.nullable(z.lazy(() => RerankConfig$inboundSchema))
349
- .optional(),
350
- agentic_rag_config: z.nullable(z.lazy(() => AgenticRagConfig$inboundSchema))
351
- .optional(),
352
- }).transform((v) => {
353
- return remap$(v, {
354
- "retrieval_type": "retrievalType",
355
- "top_k": "topK",
356
- "rerank_config": "rerankConfig",
357
- "agentic_rag_config": "agenticRagConfig",
358
- });
359
- });
360
-
361
- /** @internal */
362
- export type RetrievalSettings$Outbound = {
363
- retrieval_type: string;
364
- top_k: number;
365
- threshold: number;
366
- rerank_config?: RerankConfig$Outbound | null | undefined;
367
- agentic_rag_config?: AgenticRagConfig$Outbound | null | undefined;
368
- };
369
-
370
- /** @internal */
371
- export const RetrievalSettings$outboundSchema: z.ZodType<
372
- RetrievalSettings$Outbound,
373
- z.ZodTypeDef,
374
- RetrievalSettings
375
- > = z.object({
376
- retrievalType: RetrievalType$outboundSchema.default("hybrid_search"),
377
- topK: z.number().int().default(5),
378
- threshold: z.number().default(0),
379
- rerankConfig: z.nullable(z.lazy(() => RerankConfig$outboundSchema))
380
- .optional(),
381
- agenticRagConfig: z.nullable(z.lazy(() => AgenticRagConfig$outboundSchema))
382
- .optional(),
383
- }).transform((v) => {
384
- return remap$(v, {
385
- retrievalType: "retrieval_type",
386
- topK: "top_k",
387
- rerankConfig: "rerank_config",
388
- agenticRagConfig: "agentic_rag_config",
389
- });
390
- });
391
-
392
- /**
393
- * @internal
394
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
395
- */
396
- export namespace RetrievalSettings$ {
397
- /** @deprecated use `RetrievalSettings$inboundSchema` instead. */
398
- export const inboundSchema = RetrievalSettings$inboundSchema;
399
- /** @deprecated use `RetrievalSettings$outboundSchema` instead. */
400
- export const outboundSchema = RetrievalSettings$outboundSchema;
401
- /** @deprecated use `RetrievalSettings$Outbound` instead. */
402
- export type Outbound = RetrievalSettings$Outbound;
403
- }
404
-
405
- export function retrievalSettingsToJSON(
406
- retrievalSettings: RetrievalSettings,
407
- ): string {
408
- return JSON.stringify(
409
- RetrievalSettings$outboundSchema.parse(retrievalSettings),
410
- );
411
- }
412
-
413
- export function retrievalSettingsFromJSON(
414
- jsonString: string,
415
- ): SafeParseResult<RetrievalSettings, SDKValidationError> {
416
- return safeParse(
417
- jsonString,
418
- (x) => RetrievalSettings$inboundSchema.parse(JSON.parse(x)),
419
- `Failed to parse 'RetrievalSettings' from JSON`,
420
- );
421
- }
422
-
423
- /** @internal */
424
- export const CreateKnowledgeRequestBody$inboundSchema: z.ZodType<
425
- CreateKnowledgeRequestBody,
426
- z.ZodTypeDef,
427
- unknown
428
- > = z.object({
429
- key: z.string(),
430
- description: z.string().optional(),
431
- embedding_model: z.string(),
432
- retrieval_settings: z.lazy(() => RetrievalSettings$inboundSchema).optional(),
433
- path: z.string(),
434
- }).transform((v) => {
435
- return remap$(v, {
436
- "embedding_model": "embeddingModel",
437
- "retrieval_settings": "retrievalSettings",
438
- });
439
- });
440
-
441
- /** @internal */
442
- export type CreateKnowledgeRequestBody$Outbound = {
443
- key: string;
444
- description?: string | undefined;
445
- embedding_model: string;
446
- retrieval_settings?: RetrievalSettings$Outbound | undefined;
447
- path: string;
448
- };
449
-
450
- /** @internal */
451
- export const CreateKnowledgeRequestBody$outboundSchema: z.ZodType<
452
- CreateKnowledgeRequestBody$Outbound,
453
- z.ZodTypeDef,
454
- CreateKnowledgeRequestBody
455
- > = z.object({
456
- key: z.string(),
457
- description: z.string().optional(),
458
- embeddingModel: z.string(),
459
- retrievalSettings: z.lazy(() => RetrievalSettings$outboundSchema).optional(),
460
- path: z.string(),
461
- }).transform((v) => {
462
- return remap$(v, {
463
- embeddingModel: "embedding_model",
464
- retrievalSettings: "retrieval_settings",
465
- });
466
- });
467
-
468
- /**
469
- * @internal
470
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
471
- */
472
- export namespace CreateKnowledgeRequestBody$ {
473
- /** @deprecated use `CreateKnowledgeRequestBody$inboundSchema` instead. */
474
- export const inboundSchema = CreateKnowledgeRequestBody$inboundSchema;
475
- /** @deprecated use `CreateKnowledgeRequestBody$outboundSchema` instead. */
476
- export const outboundSchema = CreateKnowledgeRequestBody$outboundSchema;
477
- /** @deprecated use `CreateKnowledgeRequestBody$Outbound` instead. */
478
- export type Outbound = CreateKnowledgeRequestBody$Outbound;
479
- }
480
-
481
- export function createKnowledgeRequestBodyToJSON(
482
- createKnowledgeRequestBody: CreateKnowledgeRequestBody,
483
- ): string {
484
- return JSON.stringify(
485
- CreateKnowledgeRequestBody$outboundSchema.parse(createKnowledgeRequestBody),
486
- );
487
- }
488
-
489
- export function createKnowledgeRequestBodyFromJSON(
490
- jsonString: string,
491
- ): SafeParseResult<CreateKnowledgeRequestBody, SDKValidationError> {
492
- return safeParse(
493
- jsonString,
494
- (x) => CreateKnowledgeRequestBody$inboundSchema.parse(JSON.parse(x)),
495
- `Failed to parse 'CreateKnowledgeRequestBody' from JSON`,
496
- );
497
- }
498
-
499
- /** @internal */
500
- export const CreateKnowledgeRetrievalType$inboundSchema: z.ZodNativeEnum<
501
- typeof CreateKnowledgeRetrievalType
502
- > = z.nativeEnum(CreateKnowledgeRetrievalType);
503
-
504
- /** @internal */
505
- export const CreateKnowledgeRetrievalType$outboundSchema: z.ZodNativeEnum<
506
- typeof CreateKnowledgeRetrievalType
507
- > = CreateKnowledgeRetrievalType$inboundSchema;
508
-
509
- /**
510
- * @internal
511
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
512
- */
513
- export namespace CreateKnowledgeRetrievalType$ {
514
- /** @deprecated use `CreateKnowledgeRetrievalType$inboundSchema` instead. */
515
- export const inboundSchema = CreateKnowledgeRetrievalType$inboundSchema;
516
- /** @deprecated use `CreateKnowledgeRetrievalType$outboundSchema` instead. */
517
- export const outboundSchema = CreateKnowledgeRetrievalType$outboundSchema;
518
- }
519
-
520
- /** @internal */
521
- export const CreateKnowledgeRerankConfig$inboundSchema: z.ZodType<
522
- CreateKnowledgeRerankConfig,
523
- z.ZodTypeDef,
524
- unknown
525
- > = z.object({
526
- rerank_threshold: z.number().default(0.5),
527
- rerank_model: z.string(),
528
- }).transform((v) => {
529
- return remap$(v, {
530
- "rerank_threshold": "rerankThreshold",
531
- "rerank_model": "rerankModel",
532
- });
533
- });
534
-
535
- /** @internal */
536
- export type CreateKnowledgeRerankConfig$Outbound = {
537
- rerank_threshold: number;
538
- rerank_model: string;
539
- };
540
-
541
- /** @internal */
542
- export const CreateKnowledgeRerankConfig$outboundSchema: z.ZodType<
543
- CreateKnowledgeRerankConfig$Outbound,
544
- z.ZodTypeDef,
545
- CreateKnowledgeRerankConfig
546
- > = z.object({
547
- rerankThreshold: z.number().default(0.5),
548
- rerankModel: z.string(),
549
- }).transform((v) => {
550
- return remap$(v, {
551
- rerankThreshold: "rerank_threshold",
552
- rerankModel: "rerank_model",
553
- });
554
- });
555
-
556
- /**
557
- * @internal
558
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
559
- */
560
- export namespace CreateKnowledgeRerankConfig$ {
561
- /** @deprecated use `CreateKnowledgeRerankConfig$inboundSchema` instead. */
562
- export const inboundSchema = CreateKnowledgeRerankConfig$inboundSchema;
563
- /** @deprecated use `CreateKnowledgeRerankConfig$outboundSchema` instead. */
564
- export const outboundSchema = CreateKnowledgeRerankConfig$outboundSchema;
565
- /** @deprecated use `CreateKnowledgeRerankConfig$Outbound` instead. */
566
- export type Outbound = CreateKnowledgeRerankConfig$Outbound;
567
- }
568
-
569
- export function createKnowledgeRerankConfigToJSON(
570
- createKnowledgeRerankConfig: CreateKnowledgeRerankConfig,
571
- ): string {
572
- return JSON.stringify(
573
- CreateKnowledgeRerankConfig$outboundSchema.parse(
574
- createKnowledgeRerankConfig,
575
- ),
576
- );
577
- }
578
-
579
- export function createKnowledgeRerankConfigFromJSON(
580
- jsonString: string,
581
- ): SafeParseResult<CreateKnowledgeRerankConfig, SDKValidationError> {
582
- return safeParse(
583
- jsonString,
584
- (x) => CreateKnowledgeRerankConfig$inboundSchema.parse(JSON.parse(x)),
585
- `Failed to parse 'CreateKnowledgeRerankConfig' from JSON`,
586
- );
587
- }
588
-
589
- /** @internal */
590
- export const CreateKnowledgeAgenticRagConfig$inboundSchema: z.ZodType<
591
- CreateKnowledgeAgenticRagConfig,
592
- z.ZodTypeDef,
593
- unknown
594
- > = z.object({
595
- model: z.string(),
596
- });
597
-
598
- /** @internal */
599
- export type CreateKnowledgeAgenticRagConfig$Outbound = {
600
- model: string;
601
- };
602
-
603
- /** @internal */
604
- export const CreateKnowledgeAgenticRagConfig$outboundSchema: z.ZodType<
605
- CreateKnowledgeAgenticRagConfig$Outbound,
606
- z.ZodTypeDef,
607
- CreateKnowledgeAgenticRagConfig
608
- > = z.object({
609
- model: z.string(),
610
- });
611
-
612
- /**
613
- * @internal
614
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
615
- */
616
- export namespace CreateKnowledgeAgenticRagConfig$ {
617
- /** @deprecated use `CreateKnowledgeAgenticRagConfig$inboundSchema` instead. */
618
- export const inboundSchema = CreateKnowledgeAgenticRagConfig$inboundSchema;
619
- /** @deprecated use `CreateKnowledgeAgenticRagConfig$outboundSchema` instead. */
620
- export const outboundSchema = CreateKnowledgeAgenticRagConfig$outboundSchema;
621
- /** @deprecated use `CreateKnowledgeAgenticRagConfig$Outbound` instead. */
622
- export type Outbound = CreateKnowledgeAgenticRagConfig$Outbound;
623
- }
624
-
625
- export function createKnowledgeAgenticRagConfigToJSON(
626
- createKnowledgeAgenticRagConfig: CreateKnowledgeAgenticRagConfig,
627
- ): string {
628
- return JSON.stringify(
629
- CreateKnowledgeAgenticRagConfig$outboundSchema.parse(
630
- createKnowledgeAgenticRagConfig,
631
- ),
632
- );
633
- }
634
-
635
- export function createKnowledgeAgenticRagConfigFromJSON(
636
- jsonString: string,
637
- ): SafeParseResult<CreateKnowledgeAgenticRagConfig, SDKValidationError> {
638
- return safeParse(
639
- jsonString,
640
- (x) => CreateKnowledgeAgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
641
- `Failed to parse 'CreateKnowledgeAgenticRagConfig' from JSON`,
642
- );
643
- }
644
-
645
- /** @internal */
646
- export const CreateKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
647
- CreateKnowledgeRetrievalSettings,
648
- z.ZodTypeDef,
649
- unknown
650
- > = z.object({
651
- retrieval_type: CreateKnowledgeRetrievalType$inboundSchema.default(
652
- "hybrid_search",
653
- ),
654
- top_k: z.number().int().default(5),
655
- threshold: z.number().default(0),
656
- rerank_config: z.nullable(
657
- z.lazy(() => CreateKnowledgeRerankConfig$inboundSchema),
658
- ).optional(),
659
- agentic_rag_config: z.nullable(
660
- z.lazy(() => CreateKnowledgeAgenticRagConfig$inboundSchema),
661
- ).optional(),
662
- }).transform((v) => {
663
- return remap$(v, {
664
- "retrieval_type": "retrievalType",
665
- "top_k": "topK",
666
- "rerank_config": "rerankConfig",
667
- "agentic_rag_config": "agenticRagConfig",
668
- });
669
- });
670
-
671
- /** @internal */
672
- export type CreateKnowledgeRetrievalSettings$Outbound = {
673
- retrieval_type: string;
674
- top_k: number;
675
- threshold: number;
676
- rerank_config?: CreateKnowledgeRerankConfig$Outbound | null | undefined;
677
- agentic_rag_config?:
678
- | CreateKnowledgeAgenticRagConfig$Outbound
679
- | null
680
- | undefined;
681
- };
682
-
683
- /** @internal */
684
- export const CreateKnowledgeRetrievalSettings$outboundSchema: z.ZodType<
685
- CreateKnowledgeRetrievalSettings$Outbound,
686
- z.ZodTypeDef,
687
- CreateKnowledgeRetrievalSettings
688
- > = z.object({
689
- retrievalType: CreateKnowledgeRetrievalType$outboundSchema.default(
690
- "hybrid_search",
691
- ),
692
- topK: z.number().int().default(5),
693
- threshold: z.number().default(0),
694
- rerankConfig: z.nullable(
695
- z.lazy(() => CreateKnowledgeRerankConfig$outboundSchema),
696
- ).optional(),
697
- agenticRagConfig: z.nullable(
698
- z.lazy(() => CreateKnowledgeAgenticRagConfig$outboundSchema),
699
- ).optional(),
700
- }).transform((v) => {
701
- return remap$(v, {
702
- retrievalType: "retrieval_type",
703
- topK: "top_k",
704
- rerankConfig: "rerank_config",
705
- agenticRagConfig: "agentic_rag_config",
706
- });
707
- });
708
-
709
- /**
710
- * @internal
711
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
712
- */
713
- export namespace CreateKnowledgeRetrievalSettings$ {
714
- /** @deprecated use `CreateKnowledgeRetrievalSettings$inboundSchema` instead. */
715
- export const inboundSchema = CreateKnowledgeRetrievalSettings$inboundSchema;
716
- /** @deprecated use `CreateKnowledgeRetrievalSettings$outboundSchema` instead. */
717
- export const outboundSchema = CreateKnowledgeRetrievalSettings$outboundSchema;
718
- /** @deprecated use `CreateKnowledgeRetrievalSettings$Outbound` instead. */
719
- export type Outbound = CreateKnowledgeRetrievalSettings$Outbound;
720
- }
721
-
722
- export function createKnowledgeRetrievalSettingsToJSON(
723
- createKnowledgeRetrievalSettings: CreateKnowledgeRetrievalSettings,
724
- ): string {
725
- return JSON.stringify(
726
- CreateKnowledgeRetrievalSettings$outboundSchema.parse(
727
- createKnowledgeRetrievalSettings,
728
- ),
729
- );
730
- }
731
-
732
- export function createKnowledgeRetrievalSettingsFromJSON(
733
- jsonString: string,
734
- ): SafeParseResult<CreateKnowledgeRetrievalSettings, SDKValidationError> {
735
- return safeParse(
736
- jsonString,
737
- (x) => CreateKnowledgeRetrievalSettings$inboundSchema.parse(JSON.parse(x)),
738
- `Failed to parse 'CreateKnowledgeRetrievalSettings' from JSON`,
739
- );
740
- }
741
-
742
- /** @internal */
743
- export const CreateKnowledgeResponseBody$inboundSchema: z.ZodType<
744
- CreateKnowledgeResponseBody,
745
- z.ZodTypeDef,
746
- unknown
747
- > = z.object({
748
- _id: z.string(),
749
- created: z.string(),
750
- description: z.string().optional(),
751
- key: z.string(),
752
- model: z.string(),
753
- domain_id: z.string(),
754
- path: z.string().optional(),
755
- retrieval_settings: z.lazy(() =>
756
- CreateKnowledgeRetrievalSettings$inboundSchema
757
- ).optional(),
758
- created_by_id: z.nullable(z.string()).optional(),
759
- updated_by_id: z.nullable(z.string()).optional(),
760
- updated: z.string(),
761
- }).transform((v) => {
762
- return remap$(v, {
763
- "_id": "id",
764
- "domain_id": "domainId",
765
- "retrieval_settings": "retrievalSettings",
766
- "created_by_id": "createdById",
767
- "updated_by_id": "updatedById",
768
- });
769
- });
770
-
771
- /** @internal */
772
- export type CreateKnowledgeResponseBody$Outbound = {
773
- _id: string;
774
- created: string;
775
- description?: string | undefined;
776
- key: string;
777
- model: string;
778
- domain_id: string;
779
- path?: string | undefined;
780
- retrieval_settings?: CreateKnowledgeRetrievalSettings$Outbound | undefined;
781
- created_by_id?: string | null | undefined;
782
- updated_by_id?: string | null | undefined;
783
- updated: string;
784
- };
785
-
786
- /** @internal */
787
- export const CreateKnowledgeResponseBody$outboundSchema: z.ZodType<
788
- CreateKnowledgeResponseBody$Outbound,
789
- z.ZodTypeDef,
790
- CreateKnowledgeResponseBody
791
- > = z.object({
792
- id: z.string(),
793
- created: z.string(),
794
- description: z.string().optional(),
795
- key: z.string(),
796
- model: z.string(),
797
- domainId: z.string(),
798
- path: z.string().optional(),
799
- retrievalSettings: z.lazy(() =>
800
- CreateKnowledgeRetrievalSettings$outboundSchema
801
- ).optional(),
802
- createdById: z.nullable(z.string()).optional(),
803
- updatedById: z.nullable(z.string()).optional(),
804
- updated: z.string(),
805
- }).transform((v) => {
806
- return remap$(v, {
807
- id: "_id",
808
- domainId: "domain_id",
809
- retrievalSettings: "retrieval_settings",
810
- createdById: "created_by_id",
811
- updatedById: "updated_by_id",
812
- });
813
- });
814
-
815
- /**
816
- * @internal
817
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
818
- */
819
- export namespace CreateKnowledgeResponseBody$ {
820
- /** @deprecated use `CreateKnowledgeResponseBody$inboundSchema` instead. */
821
- export const inboundSchema = CreateKnowledgeResponseBody$inboundSchema;
822
- /** @deprecated use `CreateKnowledgeResponseBody$outboundSchema` instead. */
823
- export const outboundSchema = CreateKnowledgeResponseBody$outboundSchema;
824
- /** @deprecated use `CreateKnowledgeResponseBody$Outbound` instead. */
825
- export type Outbound = CreateKnowledgeResponseBody$Outbound;
826
- }
827
-
828
- export function createKnowledgeResponseBodyToJSON(
829
- createKnowledgeResponseBody: CreateKnowledgeResponseBody,
830
- ): string {
831
- return JSON.stringify(
832
- CreateKnowledgeResponseBody$outboundSchema.parse(
833
- createKnowledgeResponseBody,
834
- ),
835
- );
836
- }
837
-
838
- export function createKnowledgeResponseBodyFromJSON(
839
- jsonString: string,
840
- ): SafeParseResult<CreateKnowledgeResponseBody, SDKValidationError> {
841
- return safeParse(
842
- jsonString,
843
- (x) => CreateKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
844
- `Failed to parse 'CreateKnowledgeResponseBody' from JSON`,
845
- );
846
- }