@orq-ai/node 3.11.1 → 3.12.0-rc.0

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 (564) hide show
  1. package/README.md +99 -86
  2. package/bin/mcp-server.js +1950 -760
  3. package/bin/mcp-server.js.map +46 -31
  4. package/{packages/orq-rc/docs/sdks/contacts → docs/sdks/budgets}/README.md +86 -135
  5. package/examples/package-lock.json +5 -6
  6. package/funcs/budgetsCreate.d.ts +17 -0
  7. package/funcs/budgetsCreate.d.ts.map +1 -0
  8. package/funcs/budgetsCreate.js +114 -0
  9. package/funcs/budgetsCreate.js.map +1 -0
  10. package/funcs/budgetsDelete.d.ts +17 -0
  11. package/funcs/budgetsDelete.d.ts.map +1 -0
  12. package/funcs/budgetsDelete.js +120 -0
  13. package/funcs/budgetsDelete.js.map +1 -0
  14. package/funcs/budgetsGet.d.ts +17 -0
  15. package/funcs/budgetsGet.d.ts.map +1 -0
  16. package/funcs/budgetsGet.js +119 -0
  17. package/funcs/budgetsGet.js.map +1 -0
  18. package/funcs/budgetsList.d.ts +17 -0
  19. package/funcs/budgetsList.d.ts.map +1 -0
  20. package/funcs/budgetsList.js +122 -0
  21. package/funcs/budgetsList.js.map +1 -0
  22. package/funcs/budgetsUpdate.d.ts +17 -0
  23. package/funcs/budgetsUpdate.d.ts.map +1 -0
  24. package/funcs/budgetsUpdate.js +120 -0
  25. package/funcs/budgetsUpdate.js.map +1 -0
  26. package/jsr.json +1 -1
  27. package/lib/config.d.ts +2 -2
  28. package/lib/config.js +2 -2
  29. package/lib/config.js.map +1 -1
  30. package/mcp-server/mcp-server.js +1 -1
  31. package/mcp-server/mcp-server.js.map +1 -1
  32. package/mcp-server/server.d.ts.map +1 -1
  33. package/mcp-server/server.js +11 -1
  34. package/mcp-server/server.js.map +1 -1
  35. package/mcp-server/tools/budgetsCreate.d.ts +8 -0
  36. package/mcp-server/tools/budgetsCreate.d.ts.map +1 -0
  37. package/mcp-server/tools/budgetsCreate.js +64 -0
  38. package/mcp-server/tools/budgetsCreate.js.map +1 -0
  39. package/mcp-server/tools/budgetsDelete.d.ts +8 -0
  40. package/mcp-server/tools/budgetsDelete.d.ts.map +1 -0
  41. package/mcp-server/tools/budgetsDelete.js +63 -0
  42. package/mcp-server/tools/budgetsDelete.js.map +1 -0
  43. package/mcp-server/tools/budgetsGet.d.ts +8 -0
  44. package/mcp-server/tools/budgetsGet.d.ts.map +1 -0
  45. package/mcp-server/tools/budgetsGet.js +64 -0
  46. package/mcp-server/tools/budgetsGet.js.map +1 -0
  47. package/mcp-server/tools/budgetsList.d.ts +8 -0
  48. package/mcp-server/tools/budgetsList.d.ts.map +1 -0
  49. package/mcp-server/tools/budgetsList.js +64 -0
  50. package/mcp-server/tools/budgetsList.js.map +1 -0
  51. package/mcp-server/tools/budgetsUpdate.d.ts +8 -0
  52. package/mcp-server/tools/budgetsUpdate.d.ts.map +1 -0
  53. package/mcp-server/tools/budgetsUpdate.js +64 -0
  54. package/mcp-server/tools/budgetsUpdate.js.map +1 -0
  55. package/models/operations/createbudget.d.ts +331 -0
  56. package/models/operations/createbudget.d.ts.map +1 -0
  57. package/models/operations/createbudget.js +312 -0
  58. package/models/operations/createbudget.js.map +1 -0
  59. package/models/operations/createcontact.js +2 -2
  60. package/models/operations/createdataset.js +2 -2
  61. package/models/operations/createdatasetitem.js +2 -2
  62. package/models/operations/createdatasource.js +2 -2
  63. package/models/operations/createeval.js +16 -16
  64. package/models/operations/deletebudget.d.ts +29 -0
  65. package/models/operations/deletebudget.d.ts.map +1 -0
  66. package/models/operations/deletebudget.js +69 -0
  67. package/models/operations/deletebudget.js.map +1 -0
  68. package/models/operations/fileget.js +2 -2
  69. package/models/operations/filelist.js +2 -2
  70. package/models/operations/fileupload.js +2 -2
  71. package/models/operations/getbudget.d.ts +248 -0
  72. package/models/operations/getbudget.d.ts.map +1 -0
  73. package/models/operations/getbudget.js +252 -0
  74. package/models/operations/getbudget.js.map +1 -0
  75. package/models/operations/getevals.js +28 -28
  76. package/models/operations/index.d.ts +5 -0
  77. package/models/operations/index.d.ts.map +1 -1
  78. package/models/operations/index.js +5 -0
  79. package/models/operations/index.js.map +1 -1
  80. package/models/operations/listbudgets.d.ts +355 -0
  81. package/models/operations/listbudgets.d.ts.map +1 -0
  82. package/models/operations/listbudgets.js +356 -0
  83. package/models/operations/listbudgets.js.map +1 -0
  84. package/models/operations/listcontacts.js +2 -2
  85. package/models/operations/listdatasetdatapoints.js +2 -2
  86. package/models/operations/listdatasets.js +2 -2
  87. package/models/operations/listdatasources.js +2 -2
  88. package/models/operations/retrievecontact.js +2 -2
  89. package/models/operations/retrievedatapoint.js +2 -2
  90. package/models/operations/retrievedataset.js +2 -2
  91. package/models/operations/retrievedatasource.js +2 -2
  92. package/models/operations/updatebudget.d.ts +356 -0
  93. package/models/operations/updatebudget.d.ts.map +1 -0
  94. package/models/operations/updatebudget.js +353 -0
  95. package/models/operations/updatebudget.js.map +1 -0
  96. package/models/operations/updatecontact.js +2 -2
  97. package/models/operations/updatedatapoint.js +2 -2
  98. package/models/operations/updatedataset.js +2 -2
  99. package/models/operations/updatedatasource.js +2 -2
  100. package/models/operations/updateeval.js +16 -16
  101. package/package.json +4 -4
  102. package/sdk/budgets.d.ts +40 -0
  103. package/sdk/budgets.d.ts.map +1 -0
  104. package/sdk/budgets.js +62 -0
  105. package/sdk/budgets.js.map +1 -0
  106. package/sdk/sdk.d.ts +3 -0
  107. package/sdk/sdk.d.ts.map +1 -1
  108. package/sdk/sdk.js +4 -0
  109. package/sdk/sdk.js.map +1 -1
  110. package/{packages/orq-rc/src/funcs/feedbackCreate.ts → src/funcs/budgetsCreate.ts} +14 -14
  111. package/{packages/orq-rc/src/funcs/promptsDelete.ts → src/funcs/budgetsDelete.ts} +13 -10
  112. package/{packages/orq-rc/src/funcs/promptsRetrieve.ts → src/funcs/budgetsGet.ts} +14 -14
  113. package/{packages/orq-rc/src/funcs/contactsList.ts → src/funcs/budgetsList.ts} +15 -14
  114. package/{packages/orq-rc/src/funcs/knowledgeUpdate.ts → src/funcs/budgetsUpdate.ts} +17 -14
  115. package/src/lib/config.ts +2 -2
  116. package/src/mcp-server/mcp-server.ts +1 -1
  117. package/src/mcp-server/server.ts +11 -1
  118. package/{packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts → src/mcp-server/tools/budgetsCreate.ts} +7 -7
  119. package/{packages/orq-rc/src/mcp-server/tools/promptsDelete.ts → src/mcp-server/tools/budgetsDelete.ts} +8 -6
  120. package/{packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts → src/mcp-server/tools/budgetsGet.ts} +7 -7
  121. package/{packages/orq-rc/src/mcp-server/tools/deploymentsList.ts → src/mcp-server/tools/budgetsList.ts} +7 -7
  122. package/{packages/orq-rc/src/mcp-server/tools/evalsContains.ts → src/mcp-server/tools/budgetsUpdate.ts} +8 -6
  123. package/src/models/operations/createbudget.ts +534 -0
  124. package/src/models/operations/createcontact.ts +2 -2
  125. package/src/models/operations/createdataset.ts +2 -2
  126. package/src/models/operations/createdatasetitem.ts +2 -2
  127. package/src/models/operations/createdatasource.ts +2 -2
  128. package/src/models/operations/createeval.ts +16 -16
  129. package/src/models/operations/deletebudget.ts +66 -0
  130. package/src/models/operations/fileget.ts +2 -2
  131. package/src/models/operations/filelist.ts +2 -2
  132. package/src/models/operations/fileupload.ts +2 -2
  133. package/src/models/operations/getbudget.ts +437 -0
  134. package/src/models/operations/getevals.ts +28 -28
  135. package/src/models/operations/index.ts +5 -0
  136. package/src/models/operations/listbudgets.ts +617 -0
  137. package/src/models/operations/listcontacts.ts +2 -2
  138. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  139. package/src/models/operations/listdatasets.ts +2 -2
  140. package/src/models/operations/listdatasources.ts +2 -2
  141. package/src/models/operations/retrievecontact.ts +2 -2
  142. package/src/models/operations/retrievedatapoint.ts +2 -2
  143. package/src/models/operations/retrievedataset.ts +2 -2
  144. package/src/models/operations/retrievedatasource.ts +2 -2
  145. package/src/models/operations/updatebudget.ts +628 -0
  146. package/src/models/operations/updatecontact.ts +2 -2
  147. package/src/models/operations/updatedatapoint.ts +2 -2
  148. package/src/models/operations/updatedataset.ts +2 -2
  149. package/src/models/operations/updatedatasource.ts +2 -2
  150. package/src/models/operations/updateeval.ts +16 -16
  151. package/src/sdk/budgets.ts +99 -0
  152. package/src/sdk/sdk.ts +6 -0
  153. package/packages/orq-rc/FUNCTIONS.md +0 -103
  154. package/packages/orq-rc/README.md +0 -960
  155. package/packages/orq-rc/RUNTIMES.md +0 -48
  156. package/packages/orq-rc/docs/sdks/chunking/README.md +0 -95
  157. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -836
  158. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -314
  159. package/packages/orq-rc/docs/sdks/evals/README.md +0 -3077
  160. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -89
  161. package/packages/orq-rc/docs/sdks/files/README.md +0 -301
  162. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1243
  163. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -83
  164. package/packages/orq-rc/docs/sdks/models/README.md +0 -76
  165. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  166. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -557
  167. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -77
  168. package/packages/orq-rc/examples/README.md +0 -31
  169. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
  170. package/packages/orq-rc/examples/package-lock.json +0 -627
  171. package/packages/orq-rc/examples/package.json +0 -18
  172. package/packages/orq-rc/jsr.json +0 -28
  173. package/packages/orq-rc/package-lock.json +0 -3071
  174. package/packages/orq-rc/package.json +0 -43
  175. package/packages/orq-rc/src/core.ts +0 -13
  176. package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
  177. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -165
  178. package/packages/orq-rc/src/funcs/contactsDelete.ts +0 -176
  179. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +0 -175
  180. package/packages/orq-rc/src/funcs/contactsUpdate.ts +0 -176
  181. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
  182. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  183. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -168
  184. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
  185. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
  186. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  187. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
  188. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
  189. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
  190. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
  191. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
  192. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  193. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  194. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  195. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
  196. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -183
  197. package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +0 -175
  198. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  199. package/packages/orq-rc/src/funcs/evalsBertScore.ts +0 -175
  200. package/packages/orq-rc/src/funcs/evalsBleuScore.ts +0 -175
  201. package/packages/orq-rc/src/funcs/evalsBotDetection.ts +0 -175
  202. package/packages/orq-rc/src/funcs/evalsContains.ts +0 -175
  203. package/packages/orq-rc/src/funcs/evalsContainsAll.ts +0 -175
  204. package/packages/orq-rc/src/funcs/evalsContainsAny.ts +0 -175
  205. package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +0 -175
  206. package/packages/orq-rc/src/funcs/evalsContainsNone.ts +0 -175
  207. package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +0 -175
  208. package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +0 -177
  209. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  210. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
  211. package/packages/orq-rc/src/funcs/evalsEndsWith.ts +0 -175
  212. package/packages/orq-rc/src/funcs/evalsExactMatch.ts +0 -175
  213. package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +0 -183
  214. package/packages/orq-rc/src/funcs/evalsGrammar.ts +0 -173
  215. package/packages/orq-rc/src/funcs/evalsInvoke.ts +0 -177
  216. package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +0 -175
  217. package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +0 -177
  218. package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +0 -175
  219. package/packages/orq-rc/src/funcs/evalsLocalization.ts +0 -175
  220. package/packages/orq-rc/src/funcs/evalsPii.ts +0 -173
  221. package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +0 -175
  222. package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +0 -174
  223. package/packages/orq-rc/src/funcs/evalsRagasContextEntitiesRecall.ts +0 -183
  224. package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +0 -180
  225. package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +0 -177
  226. package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +0 -174
  227. package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +0 -177
  228. package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +0 -174
  229. package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +0 -177
  230. package/packages/orq-rc/src/funcs/evalsRagasNoiseSensitivity.ts +0 -180
  231. package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +0 -183
  232. package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +0 -177
  233. package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +0 -183
  234. package/packages/orq-rc/src/funcs/evalsSummarization.ts +0 -175
  235. package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +0 -175
  236. package/packages/orq-rc/src/funcs/evalsTranslation.ts +0 -175
  237. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
  238. package/packages/orq-rc/src/funcs/evalsValidJson.ts +0 -175
  239. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
  240. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
  241. package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
  242. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  243. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
  244. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
  245. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
  246. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
  247. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
  248. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
  249. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  250. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
  251. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
  252. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
  253. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
  254. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
  255. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
  256. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
  257. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
  258. package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
  259. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  260. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
  261. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  262. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
  263. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
  264. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  265. package/packages/orq-rc/src/hooks/global.ts +0 -44
  266. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  267. package/packages/orq-rc/src/hooks/index.ts +0 -6
  268. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  269. package/packages/orq-rc/src/hooks/types.ts +0 -112
  270. package/packages/orq-rc/src/index.ts +0 -9
  271. package/packages/orq-rc/src/lib/base64.ts +0 -37
  272. package/packages/orq-rc/src/lib/config.ts +0 -74
  273. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  274. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  275. package/packages/orq-rc/src/lib/env.ts +0 -73
  276. package/packages/orq-rc/src/lib/event-streams.ts +0 -137
  277. package/packages/orq-rc/src/lib/files.ts +0 -82
  278. package/packages/orq-rc/src/lib/http.ts +0 -323
  279. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  280. package/packages/orq-rc/src/lib/logger.ts +0 -9
  281. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  282. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  283. package/packages/orq-rc/src/lib/retries.ts +0 -218
  284. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  285. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  286. package/packages/orq-rc/src/lib/security.ts +0 -264
  287. package/packages/orq-rc/src/lib/url.ts +0 -33
  288. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -112
  289. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
  290. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  291. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  292. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  293. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  294. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  295. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  296. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  297. package/packages/orq-rc/src/mcp-server/server.ts +0 -251
  298. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  299. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +0 -37
  300. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  301. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
  302. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
  303. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
  304. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
  305. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  306. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  307. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  308. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  309. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  310. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  311. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  312. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  313. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  314. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  315. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  316. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  317. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  318. package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +0 -35
  319. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
  320. package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +0 -35
  321. package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +0 -35
  322. package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +0 -35
  323. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +0 -35
  324. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +0 -35
  325. package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +0 -35
  326. package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +0 -35
  327. package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +0 -35
  328. package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +0 -36
  329. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
  330. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
  331. package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +0 -35
  332. package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +0 -35
  333. package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +0 -37
  334. package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +0 -35
  335. package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +0 -35
  336. package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +0 -35
  337. package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +0 -36
  338. package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +0 -35
  339. package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +0 -35
  340. package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +0 -35
  341. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +0 -35
  342. package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +0 -35
  343. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +0 -37
  344. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +0 -36
  345. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextRecall.ts +0 -36
  346. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +0 -35
  347. package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +0 -36
  348. package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +0 -35
  349. package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +0 -36
  350. package/packages/orq-rc/src/mcp-server/tools/evalsRagasNoiseSensitivity.ts +0 -36
  351. package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +0 -36
  352. package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +0 -36
  353. package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +0 -36
  354. package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +0 -35
  355. package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +0 -35
  356. package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +0 -35
  357. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
  358. package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +0 -35
  359. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  360. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  361. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  362. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  363. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  364. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  365. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  366. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  367. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  368. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  369. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  370. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  371. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  372. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  373. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  374. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  375. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  376. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  377. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  378. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  379. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  380. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  381. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  382. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  383. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  384. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  385. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  386. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  387. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  388. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  389. package/packages/orq-rc/src/models/components/deployments.ts +0 -7246
  390. package/packages/orq-rc/src/models/components/index.ts +0 -6
  391. package/packages/orq-rc/src/models/components/security.ts +0 -71
  392. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  393. package/packages/orq-rc/src/models/errors/createeval.ts +0 -80
  394. package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -91
  395. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -80
  396. package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +0 -156
  397. package/packages/orq-rc/src/models/errors/evalsbertscore.ts +0 -154
  398. package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +0 -154
  399. package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +0 -155
  400. package/packages/orq-rc/src/models/errors/evalscontains.ts +0 -154
  401. package/packages/orq-rc/src/models/errors/evalscontainsall.ts +0 -155
  402. package/packages/orq-rc/src/models/errors/evalscontainsany.ts +0 -155
  403. package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +0 -156
  404. package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +0 -155
  405. package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +0 -155
  406. package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +0 -157
  407. package/packages/orq-rc/src/models/errors/evalsendswith.ts +0 -154
  408. package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +0 -154
  409. package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +0 -160
  410. package/packages/orq-rc/src/models/errors/evalsgrammar.ts +0 -154
  411. package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +0 -156
  412. package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +0 -157
  413. package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +0 -156
  414. package/packages/orq-rc/src/models/errors/evalslocalization.ts +0 -155
  415. package/packages/orq-rc/src/models/errors/evalspii.ts +0 -154
  416. package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +0 -156
  417. package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +0 -157
  418. package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +0 -163
  419. package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +0 -160
  420. package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +0 -158
  421. package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +0 -157
  422. package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +0 -157
  423. package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +0 -157
  424. package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +0 -158
  425. package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +0 -160
  426. package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +0 -160
  427. package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +0 -158
  428. package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +0 -160
  429. package/packages/orq-rc/src/models/errors/evalssummarization.ts +0 -156
  430. package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +0 -155
  431. package/packages/orq-rc/src/models/errors/evalstranslation.ts +0 -155
  432. package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +0 -154
  433. package/packages/orq-rc/src/models/errors/getevals.ts +0 -80
  434. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -80
  435. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -90
  436. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  437. package/packages/orq-rc/src/models/errors/index.ts +0 -56
  438. package/packages/orq-rc/src/models/errors/invokeeval.ts +0 -154
  439. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  440. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  441. package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -91
  442. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  443. package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -83
  444. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -80
  445. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -80
  446. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  447. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -438
  448. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -267
  449. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  450. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -5205
  451. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  452. package/packages/orq-rc/src/models/operations/createeval.ts +0 -3830
  453. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  454. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -846
  455. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -4373
  456. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  457. package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -69
  458. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  459. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  460. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  461. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -66
  462. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  463. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  464. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5439
  465. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -9480
  466. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1258
  467. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2467
  468. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -9449
  469. package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +0 -253
  470. package/packages/orq-rc/src/models/operations/evalsbertscore.ts +0 -197
  471. package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +0 -131
  472. package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +0 -249
  473. package/packages/orq-rc/src/models/operations/evalscontains.ts +0 -250
  474. package/packages/orq-rc/src/models/operations/evalscontainsall.ts +0 -248
  475. package/packages/orq-rc/src/models/operations/evalscontainsany.ts +0 -254
  476. package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +0 -181
  477. package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +0 -254
  478. package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +0 -181
  479. package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +0 -186
  480. package/packages/orq-rc/src/models/operations/evalsendswith.ts +0 -250
  481. package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +0 -183
  482. package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +0 -299
  483. package/packages/orq-rc/src/models/operations/evalsgrammar.ts +0 -243
  484. package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +0 -268
  485. package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +0 -266
  486. package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +0 -259
  487. package/packages/orq-rc/src/models/operations/evalslocalization.ts +0 -253
  488. package/packages/orq-rc/src/models/operations/evalspii.ts +0 -243
  489. package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +0 -152
  490. package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +0 -153
  491. package/packages/orq-rc/src/models/operations/evalsragascontextentitiesrecall.ts +0 -164
  492. package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +0 -166
  493. package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +0 -164
  494. package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +0 -153
  495. package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +0 -155
  496. package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +0 -146
  497. package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +0 -157
  498. package/packages/orq-rc/src/models/operations/evalsragasnoisesensitivity.ts +0 -166
  499. package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +0 -165
  500. package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +0 -150
  501. package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +0 -285
  502. package/packages/orq-rc/src/models/operations/evalssummarization.ts +0 -253
  503. package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +0 -251
  504. package/packages/orq-rc/src/models/operations/evalstranslation.ts +0 -251
  505. package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +0 -177
  506. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  507. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  508. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  509. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  510. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2437
  511. package/packages/orq-rc/src/models/operations/getevals.ts +0 -7290
  512. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  513. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -537
  514. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2298
  515. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2305
  516. package/packages/orq-rc/src/models/operations/index.ts +0 -98
  517. package/packages/orq-rc/src/models/operations/invokeeval.ts +0 -2520
  518. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  519. package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -490
  520. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -2784
  521. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  522. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  523. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -663
  524. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  525. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2438
  526. package/packages/orq-rc/src/models/operations/parse.ts +0 -1610
  527. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  528. package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -210
  529. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -2586
  530. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  531. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  532. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3814
  533. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  534. package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -325
  535. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -5155
  536. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  537. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  538. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -4131
  539. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -980
  540. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -4514
  541. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  542. package/packages/orq-rc/src/sdk/contacts.ts +0 -99
  543. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  544. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  545. package/packages/orq-rc/src/sdk/evals.ts +0 -639
  546. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  547. package/packages/orq-rc/src/sdk/files.ts +0 -78
  548. package/packages/orq-rc/src/sdk/index.ts +0 -5
  549. package/packages/orq-rc/src/sdk/knowledge.ts +0 -264
  550. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  551. package/packages/orq-rc/src/sdk/models.ts +0 -25
  552. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  553. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  554. package/packages/orq-rc/src/sdk/sdk.ts +0 -73
  555. package/packages/orq-rc/src/types/async.ts +0 -68
  556. package/packages/orq-rc/src/types/blobs.ts +0 -31
  557. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  558. package/packages/orq-rc/src/types/enums.ts +0 -16
  559. package/packages/orq-rc/src/types/fp.ts +0 -50
  560. package/packages/orq-rc/src/types/index.ts +0 -11
  561. package/packages/orq-rc/src/types/operations.ts +0 -105
  562. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  563. package/packages/orq-rc/src/types/streams.ts +0 -21
  564. 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
- }