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

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