@orq-ai/node 3.4.0-rc.36 → 3.6.0-rc.7

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 (628) hide show
  1. package/FUNCTIONS.md +4 -2
  2. package/README.md +23 -67
  3. package/bin/mcp-server.js +11171 -22379
  4. package/bin/mcp-server.js.map +51 -120
  5. package/docs/sdks/datasets/README.md +91 -4
  6. package/docs/sdks/deployments/README.md +89 -0
  7. package/docs/sdks/knowledge/README.md +4 -4
  8. package/docs/sdks/models/README.md +79 -0
  9. package/docs/sdks/orq/README.md +1 -75
  10. package/docs/sdks/prompts/README.md +4 -4
  11. package/funcs/{memoryStoresRetrieveMemory.d.ts → datasetsCreateExperiment.d.ts} +4 -4
  12. package/funcs/{memoryStoresCreateMemory.d.ts.map → datasetsCreateExperiment.d.ts.map} +1 -1
  13. package/funcs/{toolsUpdate.js → datasetsCreateExperiment.js} +11 -11
  14. package/funcs/datasetsCreateExperiment.js.map +1 -0
  15. package/funcs/{memoryStoresCreateDocument.d.ts → deploymentsCreateExperiment.d.ts} +4 -4
  16. package/funcs/deploymentsCreateExperiment.d.ts.map +1 -0
  17. package/funcs/{memoryStoresCreateMemory.js → deploymentsCreateExperiment.js} +14 -11
  18. package/funcs/deploymentsCreateExperiment.js.map +1 -0
  19. package/funcs/{memoryStoresUpdate.d.ts → modelsList.d.ts} +4 -4
  20. package/funcs/modelsList.d.ts.map +1 -0
  21. package/funcs/{toolsCreate.js → modelsList.js} +11 -23
  22. package/funcs/modelsList.js.map +1 -0
  23. package/jsr.json +1 -1
  24. package/lib/config.d.ts +3 -3
  25. package/lib/config.js +3 -3
  26. package/lib/config.js.map +1 -1
  27. package/lib/sdks.d.ts +3 -1
  28. package/lib/sdks.d.ts.map +1 -1
  29. package/lib/sdks.js +6 -11
  30. package/lib/sdks.js.map +1 -1
  31. package/mcp-server/mcp-server.js +1 -1
  32. package/mcp-server/mcp-server.js.map +1 -1
  33. package/mcp-server/server.d.ts.map +1 -1
  34. package/mcp-server/server.js +7 -53
  35. package/mcp-server/server.js.map +1 -1
  36. package/mcp-server/tools/datasetsCreateExperiment.d.ts +8 -0
  37. package/mcp-server/tools/datasetsCreateExperiment.d.ts.map +1 -0
  38. package/mcp-server/tools/{memoryStoresUpdateMemory.js → datasetsCreateExperiment.js} +9 -9
  39. package/mcp-server/tools/{memoryStoresCreateMemory.js.map → datasetsCreateExperiment.js.map} +1 -1
  40. package/mcp-server/tools/deploymentsCreateExperiment.d.ts +8 -0
  41. package/mcp-server/tools/deploymentsCreateExperiment.d.ts.map +1 -0
  42. package/mcp-server/tools/{memoryStoresListMemories.js → deploymentsCreateExperiment.js} +9 -9
  43. package/mcp-server/tools/deploymentsCreateExperiment.js.map +1 -0
  44. package/mcp-server/tools/modelsList.d.ts +3 -0
  45. package/mcp-server/tools/modelsList.d.ts.map +1 -0
  46. package/mcp-server/tools/modelsList.js +26 -0
  47. package/mcp-server/tools/modelsList.js.map +1 -0
  48. package/models/components/deployments.d.ts +241 -29
  49. package/models/components/deployments.d.ts.map +1 -1
  50. package/models/components/deployments.js +239 -29
  51. package/models/components/deployments.js.map +1 -1
  52. package/models/operations/bulkcreatedatapoints.d.ts +4 -0
  53. package/models/operations/bulkcreatedatapoints.d.ts.map +1 -1
  54. package/models/operations/bulkcreatedatapoints.js +10 -2
  55. package/models/operations/bulkcreatedatapoints.js.map +1 -1
  56. package/models/operations/createchunk.d.ts +2 -2
  57. package/models/operations/createchunk.d.ts.map +1 -1
  58. package/models/operations/createchunk.js +2 -2
  59. package/models/operations/createchunk.js.map +1 -1
  60. package/models/operations/createcontact.js +2 -2
  61. package/models/operations/createdataset.js +2 -2
  62. package/models/operations/createdatasetexperiment.d.ts +140 -0
  63. package/models/operations/createdatasetexperiment.d.ts.map +1 -0
  64. package/models/operations/createdatasetexperiment.js +188 -0
  65. package/models/operations/createdatasetexperiment.js.map +1 -0
  66. package/models/operations/createdatasetitem.d.ts +4 -0
  67. package/models/operations/createdatasetitem.d.ts.map +1 -1
  68. package/models/operations/createdatasetitem.js +10 -2
  69. package/models/operations/createdatasetitem.js.map +1 -1
  70. package/models/operations/createdatasource.js +2 -2
  71. package/models/operations/createdeploymentexperiment.d.ts +152 -0
  72. package/models/operations/createdeploymentexperiment.d.ts.map +1 -0
  73. package/models/operations/createdeploymentexperiment.js +189 -0
  74. package/models/operations/createdeploymentexperiment.js.map +1 -0
  75. package/models/operations/createknowledge.d.ts +5 -0
  76. package/models/operations/createknowledge.d.ts.map +1 -1
  77. package/models/operations/createknowledge.js +8 -4
  78. package/models/operations/createknowledge.js.map +1 -1
  79. package/models/operations/createprompt.d.ts +6 -64
  80. package/models/operations/createprompt.d.ts.map +1 -1
  81. package/models/operations/createprompt.js +17 -54
  82. package/models/operations/createprompt.js.map +1 -1
  83. package/models/operations/deploymentcreatemetric.d.ts +240 -28
  84. package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
  85. package/models/operations/deploymentcreatemetric.js +236 -29
  86. package/models/operations/deploymentcreatemetric.js.map +1 -1
  87. package/models/operations/deploymentgetconfig.d.ts +268 -85
  88. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  89. package/models/operations/deploymentgetconfig.js +284 -92
  90. package/models/operations/deploymentgetconfig.js.map +1 -1
  91. package/models/operations/deploymentinvoke.d.ts +34 -4
  92. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  93. package/models/operations/deploymentinvoke.js +30 -4
  94. package/models/operations/deploymentinvoke.js.map +1 -1
  95. package/models/operations/deployments.d.ts +3 -32
  96. package/models/operations/deployments.d.ts.map +1 -1
  97. package/models/operations/deployments.js +9 -27
  98. package/models/operations/deployments.js.map +1 -1
  99. package/models/operations/deploymentstream.d.ts +241 -29
  100. package/models/operations/deploymentstream.d.ts.map +1 -1
  101. package/models/operations/deploymentstream.js +238 -32
  102. package/models/operations/deploymentstream.js.map +1 -1
  103. package/models/operations/fileget.js +2 -2
  104. package/models/operations/filelist.js +2 -2
  105. package/models/operations/fileupload.d.ts +15 -15
  106. package/models/operations/fileupload.d.ts.map +1 -1
  107. package/models/operations/fileupload.js +20 -21
  108. package/models/operations/fileupload.js.map +1 -1
  109. package/models/operations/getallprompts.d.ts +3 -32
  110. package/models/operations/getallprompts.d.ts.map +1 -1
  111. package/models/operations/getallprompts.js +9 -27
  112. package/models/operations/getallprompts.js.map +1 -1
  113. package/models/operations/getoneknowledge.d.ts +5 -0
  114. package/models/operations/getoneknowledge.d.ts.map +1 -1
  115. package/models/operations/getoneknowledge.js +6 -2
  116. package/models/operations/getoneknowledge.js.map +1 -1
  117. package/models/operations/getoneprompt.d.ts +3 -32
  118. package/models/operations/getoneprompt.d.ts.map +1 -1
  119. package/models/operations/getoneprompt.js +9 -27
  120. package/models/operations/getoneprompt.js.map +1 -1
  121. package/models/operations/getpromptversion.d.ts +3 -32
  122. package/models/operations/getpromptversion.d.ts.map +1 -1
  123. package/models/operations/getpromptversion.js +9 -27
  124. package/models/operations/getpromptversion.js.map +1 -1
  125. package/models/operations/index.d.ts +3 -26
  126. package/models/operations/index.d.ts.map +1 -1
  127. package/models/operations/index.js +3 -26
  128. package/models/operations/index.js.map +1 -1
  129. package/models/operations/listdatasetdatapoints.d.ts +2 -0
  130. package/models/operations/listdatasetdatapoints.d.ts.map +1 -1
  131. package/models/operations/listdatasetdatapoints.js +6 -2
  132. package/models/operations/listdatasetdatapoints.js.map +1 -1
  133. package/models/operations/listdatasets.js +2 -2
  134. package/models/operations/listdatasources.js +2 -2
  135. package/models/operations/listknowledgebases.d.ts +5 -0
  136. package/models/operations/listknowledgebases.d.ts.map +1 -1
  137. package/models/operations/listknowledgebases.js +6 -2
  138. package/models/operations/listknowledgebases.js.map +1 -1
  139. package/models/operations/listmodels.d.ts +188 -0
  140. package/models/operations/listmodels.d.ts.map +1 -0
  141. package/models/operations/listmodels.js +193 -0
  142. package/models/operations/listmodels.js.map +1 -0
  143. package/models/operations/listpromptversions.d.ts +3 -32
  144. package/models/operations/listpromptversions.d.ts.map +1 -1
  145. package/models/operations/listpromptversions.js +9 -27
  146. package/models/operations/listpromptversions.js.map +1 -1
  147. package/models/operations/retrievedatapoint.d.ts +2 -0
  148. package/models/operations/retrievedatapoint.d.ts.map +1 -1
  149. package/models/operations/retrievedatapoint.js +6 -2
  150. package/models/operations/retrievedatapoint.js.map +1 -1
  151. package/models/operations/retrievedataset.js +2 -2
  152. package/models/operations/retrievedatasource.js +2 -2
  153. package/models/operations/updatedatapoint.d.ts +4 -0
  154. package/models/operations/updatedatapoint.d.ts.map +1 -1
  155. package/models/operations/updatedatapoint.js +10 -2
  156. package/models/operations/updatedatapoint.js.map +1 -1
  157. package/models/operations/updatedataset.js +2 -2
  158. package/models/operations/updatedatasource.js +2 -2
  159. package/models/operations/updateknowledge.d.ts +5 -0
  160. package/models/operations/updateknowledge.d.ts.map +1 -1
  161. package/models/operations/updateknowledge.js +8 -4
  162. package/models/operations/updateknowledge.js.map +1 -1
  163. package/models/operations/updateprompt.d.ts +6 -64
  164. package/models/operations/updateprompt.d.ts.map +1 -1
  165. package/models/operations/updateprompt.js +17 -53
  166. package/models/operations/updateprompt.js.map +1 -1
  167. package/package.json +3 -3
  168. package/sdk/datasets.d.ts +7 -0
  169. package/sdk/datasets.d.ts.map +1 -1
  170. package/sdk/datasets.js +10 -0
  171. package/sdk/datasets.js.map +1 -1
  172. package/sdk/deployments.d.ts +7 -0
  173. package/sdk/deployments.d.ts.map +1 -1
  174. package/sdk/deployments.js +10 -0
  175. package/sdk/deployments.js.map +1 -1
  176. package/sdk/models.d.ts +12 -0
  177. package/sdk/models.d.ts.map +1 -0
  178. package/sdk/models.js +22 -0
  179. package/sdk/models.js.map +1 -0
  180. package/sdk/sdk.d.ts +4 -15
  181. package/sdk/sdk.d.ts.map +1 -1
  182. package/sdk/sdk.js +3 -19
  183. package/sdk/sdk.js.map +1 -1
  184. package/src/funcs/{toolsUpdate.ts → datasetsCreateExperiment.ts} +15 -14
  185. package/src/funcs/{memoryStoresCreateMemory.ts → deploymentsCreateExperiment.ts} +22 -19
  186. package/src/funcs/{toolsDelete.ts → modelsList.ts} +11 -36
  187. package/src/lib/config.ts +3 -3
  188. package/src/lib/sdks.ts +11 -11
  189. package/src/mcp-server/mcp-server.ts +1 -1
  190. package/src/mcp-server/server.ts +7 -53
  191. package/src/mcp-server/tools/{memoryStoresUpdateMemory.ts → datasetsCreateExperiment.ts} +7 -7
  192. package/src/mcp-server/tools/{memoryStoresUpdateDocument.ts → deploymentsCreateExperiment.ts} +7 -7
  193. package/src/mcp-server/tools/modelsList.ts +30 -0
  194. package/src/models/components/deployments.ts +442 -47
  195. package/src/models/operations/bulkcreatedatapoints.ts +14 -2
  196. package/src/models/operations/createchunk.ts +4 -4
  197. package/src/models/operations/createcontact.ts +2 -2
  198. package/src/models/operations/createdataset.ts +2 -2
  199. package/src/models/operations/createdatasetexperiment.ts +307 -0
  200. package/src/models/operations/createdatasetitem.ts +14 -2
  201. package/src/models/operations/createdatasource.ts +2 -2
  202. package/src/models/operations/createdeploymentexperiment.ts +321 -0
  203. package/src/models/operations/createknowledge.ts +13 -4
  204. package/src/models/operations/createprompt.ts +18 -70
  205. package/src/models/operations/deploymentcreatemetric.ts +517 -40
  206. package/src/models/operations/deploymentgetconfig.ts +531 -139
  207. package/src/models/operations/deploymentinvoke.ts +64 -8
  208. package/src/models/operations/deployments.ts +9 -36
  209. package/src/models/operations/deploymentstream.ts +502 -44
  210. package/src/models/operations/fileget.ts +2 -2
  211. package/src/models/operations/filelist.ts +2 -2
  212. package/src/models/operations/fileupload.ts +37 -34
  213. package/src/models/operations/getallprompts.ts +9 -36
  214. package/src/models/operations/getoneknowledge.ts +11 -2
  215. package/src/models/operations/getoneprompt.ts +9 -36
  216. package/src/models/operations/getpromptversion.ts +9 -38
  217. package/src/models/operations/index.ts +3 -26
  218. package/src/models/operations/listdatasetdatapoints.ts +8 -2
  219. package/src/models/operations/listdatasets.ts +2 -2
  220. package/src/models/operations/listdatasources.ts +2 -2
  221. package/src/models/operations/listknowledgebases.ts +11 -2
  222. package/src/models/operations/listmodels.ts +273 -0
  223. package/src/models/operations/listpromptversions.ts +9 -38
  224. package/src/models/operations/retrievedatapoint.ts +8 -2
  225. package/src/models/operations/retrievedataset.ts +2 -2
  226. package/src/models/operations/retrievedatasource.ts +2 -2
  227. package/src/models/operations/updatedatapoint.ts +14 -2
  228. package/src/models/operations/updatedataset.ts +2 -2
  229. package/src/models/operations/updatedatasource.ts +2 -2
  230. package/src/models/operations/updateknowledge.ts +13 -4
  231. package/src/models/operations/updateprompt.ts +18 -74
  232. package/src/sdk/datasets.ts +18 -0
  233. package/src/sdk/deployments.ts +18 -0
  234. package/src/sdk/models.ts +25 -0
  235. package/src/sdk/sdk.ts +5 -34
  236. package/docs/sdks/memorystores/README.md +0 -1211
  237. package/docs/sdks/sessions/README.md +0 -385
  238. package/docs/sdks/tools/README.md +0 -425
  239. package/funcs/memoryStoresCreate.d.ts +0 -14
  240. package/funcs/memoryStoresCreate.d.ts.map +0 -1
  241. package/funcs/memoryStoresCreate.js +0 -115
  242. package/funcs/memoryStoresCreate.js.map +0 -1
  243. package/funcs/memoryStoresCreateDocument.d.ts.map +0 -1
  244. package/funcs/memoryStoresCreateDocument.js +0 -119
  245. package/funcs/memoryStoresCreateDocument.js.map +0 -1
  246. package/funcs/memoryStoresCreateMemory.d.ts +0 -16
  247. package/funcs/memoryStoresCreateMemory.js.map +0 -1
  248. package/funcs/memoryStoresDelete.d.ts +0 -16
  249. package/funcs/memoryStoresDelete.d.ts.map +0 -1
  250. package/funcs/memoryStoresDelete.js +0 -115
  251. package/funcs/memoryStoresDelete.js.map +0 -1
  252. package/funcs/memoryStoresDeleteDocument.d.ts +0 -21
  253. package/funcs/memoryStoresDeleteDocument.d.ts.map +0 -1
  254. package/funcs/memoryStoresDeleteDocument.js +0 -128
  255. package/funcs/memoryStoresDeleteDocument.js.map +0 -1
  256. package/funcs/memoryStoresDeleteMemory.d.ts +0 -21
  257. package/funcs/memoryStoresDeleteMemory.d.ts.map +0 -1
  258. package/funcs/memoryStoresDeleteMemory.js +0 -124
  259. package/funcs/memoryStoresDeleteMemory.js.map +0 -1
  260. package/funcs/memoryStoresList.d.ts +0 -17
  261. package/funcs/memoryStoresList.d.ts.map +0 -1
  262. package/funcs/memoryStoresList.js +0 -121
  263. package/funcs/memoryStoresList.js.map +0 -1
  264. package/funcs/memoryStoresListDocuments.d.ts +0 -16
  265. package/funcs/memoryStoresListDocuments.d.ts.map +0 -1
  266. package/funcs/memoryStoresListDocuments.js +0 -124
  267. package/funcs/memoryStoresListDocuments.js.map +0 -1
  268. package/funcs/memoryStoresListMemories.d.ts +0 -16
  269. package/funcs/memoryStoresListMemories.d.ts.map +0 -1
  270. package/funcs/memoryStoresListMemories.js +0 -120
  271. package/funcs/memoryStoresListMemories.js.map +0 -1
  272. package/funcs/memoryStoresRetrieve.d.ts +0 -17
  273. package/funcs/memoryStoresRetrieve.d.ts.map +0 -1
  274. package/funcs/memoryStoresRetrieve.js +0 -118
  275. package/funcs/memoryStoresRetrieve.js.map +0 -1
  276. package/funcs/memoryStoresRetrieveDocument.d.ts +0 -16
  277. package/funcs/memoryStoresRetrieveDocument.d.ts.map +0 -1
  278. package/funcs/memoryStoresRetrieveDocument.js +0 -122
  279. package/funcs/memoryStoresRetrieveDocument.js.map +0 -1
  280. package/funcs/memoryStoresRetrieveMemory.d.ts.map +0 -1
  281. package/funcs/memoryStoresRetrieveMemory.js +0 -118
  282. package/funcs/memoryStoresRetrieveMemory.js.map +0 -1
  283. package/funcs/memoryStoresUpdate.d.ts.map +0 -1
  284. package/funcs/memoryStoresUpdate.js +0 -115
  285. package/funcs/memoryStoresUpdate.js.map +0 -1
  286. package/funcs/memoryStoresUpdateDocument.d.ts +0 -16
  287. package/funcs/memoryStoresUpdateDocument.d.ts.map +0 -1
  288. package/funcs/memoryStoresUpdateDocument.js +0 -123
  289. package/funcs/memoryStoresUpdateDocument.js.map +0 -1
  290. package/funcs/memoryStoresUpdateMemory.d.ts +0 -16
  291. package/funcs/memoryStoresUpdateMemory.d.ts.map +0 -1
  292. package/funcs/memoryStoresUpdateMemory.js +0 -119
  293. package/funcs/memoryStoresUpdateMemory.js.map +0 -1
  294. package/funcs/postV2TracesSessionsCount.d.ts +0 -13
  295. package/funcs/postV2TracesSessionsCount.d.ts.map +0 -1
  296. package/funcs/postV2TracesSessionsCount.js +0 -112
  297. package/funcs/postV2TracesSessionsCount.js.map +0 -1
  298. package/funcs/sessionsCreate.d.ts +0 -16
  299. package/funcs/sessionsCreate.d.ts.map +0 -1
  300. package/funcs/sessionsCreate.js +0 -114
  301. package/funcs/sessionsCreate.js.map +0 -1
  302. package/funcs/sessionsDelete.d.ts +0 -17
  303. package/funcs/sessionsDelete.d.ts.map +0 -1
  304. package/funcs/sessionsDelete.js +0 -122
  305. package/funcs/sessionsDelete.js.map +0 -1
  306. package/funcs/sessionsGet.d.ts +0 -17
  307. package/funcs/sessionsGet.d.ts.map +0 -1
  308. package/funcs/sessionsGet.js +0 -121
  309. package/funcs/sessionsGet.js.map +0 -1
  310. package/funcs/sessionsList.d.ts +0 -16
  311. package/funcs/sessionsList.d.ts.map +0 -1
  312. package/funcs/sessionsList.js +0 -114
  313. package/funcs/sessionsList.js.map +0 -1
  314. package/funcs/sessionsUpdate.d.ts +0 -17
  315. package/funcs/sessionsUpdate.d.ts.map +0 -1
  316. package/funcs/sessionsUpdate.js +0 -122
  317. package/funcs/sessionsUpdate.js.map +0 -1
  318. package/funcs/toolsCreate.d.ts +0 -16
  319. package/funcs/toolsCreate.d.ts.map +0 -1
  320. package/funcs/toolsCreate.js.map +0 -1
  321. package/funcs/toolsDelete.d.ts +0 -16
  322. package/funcs/toolsDelete.d.ts.map +0 -1
  323. package/funcs/toolsDelete.js +0 -118
  324. package/funcs/toolsDelete.js.map +0 -1
  325. package/funcs/toolsList.d.ts +0 -17
  326. package/funcs/toolsList.d.ts.map +0 -1
  327. package/funcs/toolsList.js +0 -121
  328. package/funcs/toolsList.js.map +0 -1
  329. package/funcs/toolsRetrieve.d.ts +0 -16
  330. package/funcs/toolsRetrieve.d.ts.map +0 -1
  331. package/funcs/toolsRetrieve.js +0 -117
  332. package/funcs/toolsRetrieve.js.map +0 -1
  333. package/funcs/toolsUpdate.d.ts +0 -16
  334. package/funcs/toolsUpdate.d.ts.map +0 -1
  335. package/funcs/toolsUpdate.js.map +0 -1
  336. package/mcp-server/tools/memoryStoresCreate.d.ts +0 -8
  337. package/mcp-server/tools/memoryStoresCreate.d.ts.map +0 -1
  338. package/mcp-server/tools/memoryStoresCreate.js +0 -62
  339. package/mcp-server/tools/memoryStoresCreate.js.map +0 -1
  340. package/mcp-server/tools/memoryStoresCreateDocument.d.ts +0 -8
  341. package/mcp-server/tools/memoryStoresCreateDocument.d.ts.map +0 -1
  342. package/mcp-server/tools/memoryStoresCreateDocument.js +0 -64
  343. package/mcp-server/tools/memoryStoresCreateDocument.js.map +0 -1
  344. package/mcp-server/tools/memoryStoresCreateMemory.d.ts +0 -8
  345. package/mcp-server/tools/memoryStoresCreateMemory.d.ts.map +0 -1
  346. package/mcp-server/tools/memoryStoresCreateMemory.js +0 -64
  347. package/mcp-server/tools/memoryStoresDelete.d.ts +0 -8
  348. package/mcp-server/tools/memoryStoresDelete.d.ts.map +0 -1
  349. package/mcp-server/tools/memoryStoresDelete.js +0 -63
  350. package/mcp-server/tools/memoryStoresDelete.js.map +0 -1
  351. package/mcp-server/tools/memoryStoresDeleteDocument.d.ts +0 -8
  352. package/mcp-server/tools/memoryStoresDeleteDocument.d.ts.map +0 -1
  353. package/mcp-server/tools/memoryStoresDeleteDocument.js +0 -68
  354. package/mcp-server/tools/memoryStoresDeleteDocument.js.map +0 -1
  355. package/mcp-server/tools/memoryStoresDeleteMemory.d.ts +0 -8
  356. package/mcp-server/tools/memoryStoresDeleteMemory.d.ts.map +0 -1
  357. package/mcp-server/tools/memoryStoresDeleteMemory.js +0 -68
  358. package/mcp-server/tools/memoryStoresDeleteMemory.js.map +0 -1
  359. package/mcp-server/tools/memoryStoresList.d.ts +0 -8
  360. package/mcp-server/tools/memoryStoresList.d.ts.map +0 -1
  361. package/mcp-server/tools/memoryStoresList.js +0 -64
  362. package/mcp-server/tools/memoryStoresList.js.map +0 -1
  363. package/mcp-server/tools/memoryStoresListDocuments.d.ts +0 -8
  364. package/mcp-server/tools/memoryStoresListDocuments.d.ts.map +0 -1
  365. package/mcp-server/tools/memoryStoresListDocuments.js +0 -64
  366. package/mcp-server/tools/memoryStoresListDocuments.js.map +0 -1
  367. package/mcp-server/tools/memoryStoresListMemories.d.ts +0 -8
  368. package/mcp-server/tools/memoryStoresListMemories.d.ts.map +0 -1
  369. package/mcp-server/tools/memoryStoresListMemories.js.map +0 -1
  370. package/mcp-server/tools/memoryStoresRetrieve.d.ts +0 -8
  371. package/mcp-server/tools/memoryStoresRetrieve.d.ts.map +0 -1
  372. package/mcp-server/tools/memoryStoresRetrieve.js +0 -64
  373. package/mcp-server/tools/memoryStoresRetrieve.js.map +0 -1
  374. package/mcp-server/tools/memoryStoresRetrieveDocument.d.ts +0 -8
  375. package/mcp-server/tools/memoryStoresRetrieveDocument.d.ts.map +0 -1
  376. package/mcp-server/tools/memoryStoresRetrieveDocument.js +0 -64
  377. package/mcp-server/tools/memoryStoresRetrieveDocument.js.map +0 -1
  378. package/mcp-server/tools/memoryStoresRetrieveMemory.d.ts +0 -8
  379. package/mcp-server/tools/memoryStoresRetrieveMemory.d.ts.map +0 -1
  380. package/mcp-server/tools/memoryStoresRetrieveMemory.js +0 -64
  381. package/mcp-server/tools/memoryStoresRetrieveMemory.js.map +0 -1
  382. package/mcp-server/tools/memoryStoresUpdate.d.ts +0 -8
  383. package/mcp-server/tools/memoryStoresUpdate.d.ts.map +0 -1
  384. package/mcp-server/tools/memoryStoresUpdate.js +0 -64
  385. package/mcp-server/tools/memoryStoresUpdate.js.map +0 -1
  386. package/mcp-server/tools/memoryStoresUpdateDocument.d.ts +0 -8
  387. package/mcp-server/tools/memoryStoresUpdateDocument.d.ts.map +0 -1
  388. package/mcp-server/tools/memoryStoresUpdateDocument.js +0 -64
  389. package/mcp-server/tools/memoryStoresUpdateDocument.js.map +0 -1
  390. package/mcp-server/tools/memoryStoresUpdateMemory.d.ts +0 -8
  391. package/mcp-server/tools/memoryStoresUpdateMemory.d.ts.map +0 -1
  392. package/mcp-server/tools/memoryStoresUpdateMemory.js.map +0 -1
  393. package/mcp-server/tools/postV2TracesSessionsCount.d.ts +0 -8
  394. package/mcp-server/tools/postV2TracesSessionsCount.d.ts.map +0 -1
  395. package/mcp-server/tools/postV2TracesSessionsCount.js +0 -63
  396. package/mcp-server/tools/postV2TracesSessionsCount.js.map +0 -1
  397. package/mcp-server/tools/sessionsCreate.d.ts +0 -8
  398. package/mcp-server/tools/sessionsCreate.d.ts.map +0 -1
  399. package/mcp-server/tools/sessionsCreate.js +0 -64
  400. package/mcp-server/tools/sessionsCreate.js.map +0 -1
  401. package/mcp-server/tools/sessionsDelete.d.ts +0 -8
  402. package/mcp-server/tools/sessionsDelete.d.ts.map +0 -1
  403. package/mcp-server/tools/sessionsDelete.js +0 -63
  404. package/mcp-server/tools/sessionsDelete.js.map +0 -1
  405. package/mcp-server/tools/sessionsGet.d.ts +0 -8
  406. package/mcp-server/tools/sessionsGet.d.ts.map +0 -1
  407. package/mcp-server/tools/sessionsGet.js +0 -64
  408. package/mcp-server/tools/sessionsGet.js.map +0 -1
  409. package/mcp-server/tools/sessionsList.d.ts +0 -8
  410. package/mcp-server/tools/sessionsList.d.ts.map +0 -1
  411. package/mcp-server/tools/sessionsList.js +0 -64
  412. package/mcp-server/tools/sessionsList.js.map +0 -1
  413. package/mcp-server/tools/sessionsUpdate.d.ts +0 -8
  414. package/mcp-server/tools/sessionsUpdate.d.ts.map +0 -1
  415. package/mcp-server/tools/sessionsUpdate.js +0 -64
  416. package/mcp-server/tools/sessionsUpdate.js.map +0 -1
  417. package/mcp-server/tools/toolsCreate.d.ts +0 -8
  418. package/mcp-server/tools/toolsCreate.d.ts.map +0 -1
  419. package/mcp-server/tools/toolsCreate.js +0 -64
  420. package/mcp-server/tools/toolsCreate.js.map +0 -1
  421. package/mcp-server/tools/toolsDelete.d.ts +0 -8
  422. package/mcp-server/tools/toolsDelete.d.ts.map +0 -1
  423. package/mcp-server/tools/toolsDelete.js +0 -63
  424. package/mcp-server/tools/toolsDelete.js.map +0 -1
  425. package/mcp-server/tools/toolsList.d.ts +0 -8
  426. package/mcp-server/tools/toolsList.d.ts.map +0 -1
  427. package/mcp-server/tools/toolsList.js +0 -64
  428. package/mcp-server/tools/toolsList.js.map +0 -1
  429. package/mcp-server/tools/toolsRetrieve.d.ts +0 -8
  430. package/mcp-server/tools/toolsRetrieve.d.ts.map +0 -1
  431. package/mcp-server/tools/toolsRetrieve.js +0 -64
  432. package/mcp-server/tools/toolsRetrieve.js.map +0 -1
  433. package/mcp-server/tools/toolsUpdate.d.ts +0 -8
  434. package/mcp-server/tools/toolsUpdate.d.ts.map +0 -1
  435. package/mcp-server/tools/toolsUpdate.js +0 -64
  436. package/mcp-server/tools/toolsUpdate.js.map +0 -1
  437. package/models/operations/creatememory.d.ts +0 -113
  438. package/models/operations/creatememory.d.ts.map +0 -1
  439. package/models/operations/creatememory.js +0 -180
  440. package/models/operations/creatememory.js.map +0 -1
  441. package/models/operations/creatememorydocument.d.ts +0 -126
  442. package/models/operations/creatememorydocument.d.ts.map +0 -1
  443. package/models/operations/creatememorydocument.js +0 -180
  444. package/models/operations/creatememorydocument.js.map +0 -1
  445. package/models/operations/creatememorystore.d.ts +0 -958
  446. package/models/operations/creatememorystore.d.ts.map +0 -1
  447. package/models/operations/creatememorystore.js +0 -1013
  448. package/models/operations/creatememorystore.js.map +0 -1
  449. package/models/operations/createsession.d.ts +0 -288
  450. package/models/operations/createsession.d.ts.map +0 -1
  451. package/models/operations/createsession.js +0 -353
  452. package/models/operations/createsession.js.map +0 -1
  453. package/models/operations/createtool.d.ts +0 -1407
  454. package/models/operations/createtool.d.ts.map +0 -1
  455. package/models/operations/createtool.js +0 -1204
  456. package/models/operations/createtool.js.map +0 -1
  457. package/models/operations/deletememory.d.ts +0 -37
  458. package/models/operations/deletememory.d.ts.map +0 -1
  459. package/models/operations/deletememory.js +0 -82
  460. package/models/operations/deletememory.js.map +0 -1
  461. package/models/operations/deletememorydocument.d.ts +0 -42
  462. package/models/operations/deletememorydocument.d.ts.map +0 -1
  463. package/models/operations/deletememorydocument.js +0 -86
  464. package/models/operations/deletememorydocument.js.map +0 -1
  465. package/models/operations/deletememorystore.d.ts +0 -32
  466. package/models/operations/deletememorystore.d.ts.map +0 -1
  467. package/models/operations/deletememorystore.js +0 -78
  468. package/models/operations/deletememorystore.js.map +0 -1
  469. package/models/operations/deletesession.d.ts +0 -32
  470. package/models/operations/deletesession.d.ts.map +0 -1
  471. package/models/operations/deletesession.js +0 -78
  472. package/models/operations/deletesession.js.map +0 -1
  473. package/models/operations/deletetool.d.ts +0 -29
  474. package/models/operations/deletetool.d.ts.map +0 -1
  475. package/models/operations/deletetool.js +0 -78
  476. package/models/operations/deletetool.js.map +0 -1
  477. package/models/operations/getallmemories.d.ts +0 -147
  478. package/models/operations/getallmemories.d.ts.map +0 -1
  479. package/models/operations/getallmemories.js +0 -206
  480. package/models/operations/getallmemories.js.map +0 -1
  481. package/models/operations/getallmemorydocuments.d.ts +0 -154
  482. package/models/operations/getallmemorydocuments.d.ts.map +0 -1
  483. package/models/operations/getallmemorydocuments.js +0 -212
  484. package/models/operations/getallmemorydocuments.js.map +0 -1
  485. package/models/operations/getallmemorystores.d.ts +0 -582
  486. package/models/operations/getallmemorystores.d.ts.map +0 -1
  487. package/models/operations/getallmemorystores.js +0 -627
  488. package/models/operations/getallmemorystores.js.map +0 -1
  489. package/models/operations/getalltools.d.ts +0 -825
  490. package/models/operations/getalltools.d.ts.map +0 -1
  491. package/models/operations/getalltools.js +0 -769
  492. package/models/operations/getalltools.js.map +0 -1
  493. package/models/operations/getsession.d.ts +0 -179
  494. package/models/operations/getsession.d.ts.map +0 -1
  495. package/models/operations/getsession.js +0 -237
  496. package/models/operations/getsession.js.map +0 -1
  497. package/models/operations/listsessions.d.ts +0 -4575
  498. package/models/operations/listsessions.d.ts.map +0 -1
  499. package/models/operations/listsessions.js +0 -3838
  500. package/models/operations/listsessions.js.map +0 -1
  501. package/models/operations/postv2tracessessionscount.d.ts +0 -4405
  502. package/models/operations/postv2tracessessionscount.d.ts.map +0 -1
  503. package/models/operations/postv2tracessessionscount.js +0 -3669
  504. package/models/operations/postv2tracessessionscount.js.map +0 -1
  505. package/models/operations/retrievememory.d.ts +0 -85
  506. package/models/operations/retrievememory.d.ts.map +0 -1
  507. package/models/operations/retrievememory.js +0 -143
  508. package/models/operations/retrievememory.js.map +0 -1
  509. package/models/operations/retrievememorydocument.d.ts +0 -92
  510. package/models/operations/retrievememorydocument.d.ts.map +0 -1
  511. package/models/operations/retrievememorydocument.js +0 -149
  512. package/models/operations/retrievememorydocument.js.map +0 -1
  513. package/models/operations/retrievememorystore.d.ts +0 -521
  514. package/models/operations/retrievememorystore.d.ts.map +0 -1
  515. package/models/operations/retrievememorystore.js +0 -564
  516. package/models/operations/retrievememorystore.js.map +0 -1
  517. package/models/operations/retrievetool.d.ts +0 -761
  518. package/models/operations/retrievetool.d.ts.map +0 -1
  519. package/models/operations/retrievetool.js +0 -695
  520. package/models/operations/retrievetool.js.map +0 -1
  521. package/models/operations/updatememory.d.ts +0 -118
  522. package/models/operations/updatememory.d.ts.map +0 -1
  523. package/models/operations/updatememory.js +0 -184
  524. package/models/operations/updatememory.js.map +0 -1
  525. package/models/operations/updatememorydocument.d.ts +0 -131
  526. package/models/operations/updatememorydocument.d.ts.map +0 -1
  527. package/models/operations/updatememorydocument.js +0 -184
  528. package/models/operations/updatememorydocument.js.map +0 -1
  529. package/models/operations/updatememorystore.d.ts +0 -684
  530. package/models/operations/updatememorystore.d.ts.map +0 -1
  531. package/models/operations/updatememorystore.js +0 -712
  532. package/models/operations/updatememorystore.js.map +0 -1
  533. package/models/operations/updatesession.d.ts +0 -325
  534. package/models/operations/updatesession.d.ts.map +0 -1
  535. package/models/operations/updatesession.js +0 -400
  536. package/models/operations/updatesession.js.map +0 -1
  537. package/models/operations/updatetool.d.ts +0 -1422
  538. package/models/operations/updatetool.d.ts.map +0 -1
  539. package/models/operations/updatetool.js +0 -1250
  540. package/models/operations/updatetool.js.map +0 -1
  541. package/sdk/memorystores.d.ts +0 -117
  542. package/sdk/memorystores.d.ts.map +0 -1
  543. package/sdk/memorystores.js +0 -169
  544. package/sdk/memorystores.js.map +0 -1
  545. package/sdk/sessions.d.ts +0 -40
  546. package/sdk/sessions.d.ts.map +0 -1
  547. package/sdk/sessions.js +0 -62
  548. package/sdk/sessions.js.map +0 -1
  549. package/sdk/tools.d.ts +0 -40
  550. package/sdk/tools.d.ts.map +0 -1
  551. package/sdk/tools.js +0 -62
  552. package/sdk/tools.js.map +0 -1
  553. package/src/funcs/memoryStoresCreate.ts +0 -165
  554. package/src/funcs/memoryStoresCreateDocument.ts +0 -169
  555. package/src/funcs/memoryStoresDelete.ts +0 -162
  556. package/src/funcs/memoryStoresDeleteDocument.ts +0 -178
  557. package/src/funcs/memoryStoresDeleteMemory.ts +0 -173
  558. package/src/funcs/memoryStoresList.ts +0 -172
  559. package/src/funcs/memoryStoresListDocuments.ts +0 -175
  560. package/src/funcs/memoryStoresListMemories.ts +0 -170
  561. package/src/funcs/memoryStoresRetrieve.ts +0 -171
  562. package/src/funcs/memoryStoresRetrieveDocument.ts +0 -172
  563. package/src/funcs/memoryStoresRetrieveMemory.ts +0 -167
  564. package/src/funcs/memoryStoresUpdate.ts +0 -162
  565. package/src/funcs/memoryStoresUpdateDocument.ts +0 -173
  566. package/src/funcs/memoryStoresUpdateMemory.ts +0 -168
  567. package/src/funcs/postV2TracesSessionsCount.ts +0 -155
  568. package/src/funcs/sessionsCreate.ts +0 -159
  569. package/src/funcs/sessionsDelete.ts +0 -170
  570. package/src/funcs/sessionsGet.ts +0 -169
  571. package/src/funcs/sessionsList.ts +0 -157
  572. package/src/funcs/sessionsUpdate.ts +0 -170
  573. package/src/funcs/toolsCreate.ts +0 -157
  574. package/src/funcs/toolsList.ts +0 -170
  575. package/src/funcs/toolsRetrieve.ts +0 -160
  576. package/src/mcp-server/tools/memoryStoresCreate.ts +0 -35
  577. package/src/mcp-server/tools/memoryStoresCreateDocument.ts +0 -37
  578. package/src/mcp-server/tools/memoryStoresCreateMemory.ts +0 -37
  579. package/src/mcp-server/tools/memoryStoresDelete.ts +0 -35
  580. package/src/mcp-server/tools/memoryStoresDeleteDocument.ts +0 -40
  581. package/src/mcp-server/tools/memoryStoresDeleteMemory.ts +0 -40
  582. package/src/mcp-server/tools/memoryStoresList.ts +0 -37
  583. package/src/mcp-server/tools/memoryStoresListDocuments.ts +0 -37
  584. package/src/mcp-server/tools/memoryStoresListMemories.ts +0 -37
  585. package/src/mcp-server/tools/memoryStoresRetrieve.ts +0 -37
  586. package/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +0 -37
  587. package/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +0 -37
  588. package/src/mcp-server/tools/memoryStoresUpdate.ts +0 -37
  589. package/src/mcp-server/tools/postV2TracesSessionsCount.ts +0 -36
  590. package/src/mcp-server/tools/sessionsCreate.ts +0 -37
  591. package/src/mcp-server/tools/sessionsDelete.ts +0 -35
  592. package/src/mcp-server/tools/sessionsGet.ts +0 -37
  593. package/src/mcp-server/tools/sessionsList.ts +0 -37
  594. package/src/mcp-server/tools/sessionsUpdate.ts +0 -37
  595. package/src/mcp-server/tools/toolsCreate.ts +0 -37
  596. package/src/mcp-server/tools/toolsDelete.ts +0 -35
  597. package/src/mcp-server/tools/toolsList.ts +0 -37
  598. package/src/mcp-server/tools/toolsRetrieve.ts +0 -37
  599. package/src/mcp-server/tools/toolsUpdate.ts +0 -37
  600. package/src/models/operations/creatememory.ts +0 -265
  601. package/src/models/operations/creatememorydocument.ts +0 -284
  602. package/src/models/operations/creatememorystore.ts +0 -1619
  603. package/src/models/operations/createsession.ts +0 -632
  604. package/src/models/operations/createtool.ts +0 -2297
  605. package/src/models/operations/deletememory.ts +0 -87
  606. package/src/models/operations/deletememorydocument.ts +0 -98
  607. package/src/models/operations/deletememorystore.ts +0 -78
  608. package/src/models/operations/deletesession.ts +0 -78
  609. package/src/models/operations/deletetool.ts +0 -75
  610. package/src/models/operations/getallmemories.ts +0 -315
  611. package/src/models/operations/getallmemorydocuments.ts +0 -335
  612. package/src/models/operations/getallmemorystores.ts +0 -1061
  613. package/src/models/operations/getalltools.ts +0 -1382
  614. package/src/models/operations/getsession.ts +0 -400
  615. package/src/models/operations/listsessions.ts +0 -6732
  616. package/src/models/operations/postv2tracessessionscount.ts +0 -7043
  617. package/src/models/operations/retrievememory.ts +0 -198
  618. package/src/models/operations/retrievememorydocument.ts +0 -217
  619. package/src/models/operations/retrievememorystore.ts +0 -944
  620. package/src/models/operations/retrievetool.ts +0 -1350
  621. package/src/models/operations/updatememory.ts +0 -274
  622. package/src/models/operations/updatememorydocument.ts +0 -293
  623. package/src/models/operations/updatememorystore.ts +0 -1148
  624. package/src/models/operations/updatesession.ts +0 -731
  625. package/src/models/operations/updatetool.ts +0 -2464
  626. package/src/sdk/memorystores.ts +0 -286
  627. package/src/sdk/sessions.ts +0 -99
  628. package/src/sdk/tools.ts +0 -99
@@ -1,1211 +0,0 @@
1
- # MemoryStores
2
- (*memoryStores*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List memory stores
9
- * [create](#create) - Create memory store
10
- * [retrieve](#retrieve) - Retrieve memory store
11
- * [update](#update) - Update memory store
12
- * [delete](#delete) - Delete memory store
13
- * [listMemories](#listmemories) - List all memories
14
- * [createMemory](#creatememory) - Create a new memory
15
- * [retrieveMemory](#retrievememory) - Retrieve a specific memory
16
- * [updateMemory](#updatememory) - Update a specific memory
17
- * [deleteMemory](#deletememory) - Delete a specific memory
18
- * [listDocuments](#listdocuments) - List all documents for a memory
19
- * [createDocument](#createdocument) - Create a new memory document
20
- * [retrieveDocument](#retrievedocument) - Retrieve a specific memory document
21
- * [updateDocument](#updatedocument) - Update a specific memory document
22
- * [deleteDocument](#deletedocument) - Delete a specific memory document
23
-
24
- ## list
25
-
26
- Retrieves a paginated list of memory stores in the workspace. Use cursor-based pagination parameters to navigate through the results.
27
-
28
- ### Example Usage
29
-
30
- ```typescript
31
- import { Orq } from "@orq-ai/node";
32
-
33
- const orq = new Orq({
34
- apiKey: process.env["ORQ_API_KEY"] ?? "",
35
- });
36
-
37
- async function run() {
38
- const result = await orq.memoryStores.list({});
39
-
40
- // Handle the result
41
- console.log(result);
42
- }
43
-
44
- run();
45
- ```
46
-
47
- ### Standalone function
48
-
49
- The standalone function version of this method:
50
-
51
- ```typescript
52
- import { OrqCore } from "@orq-ai/node/core.js";
53
- import { memoryStoresList } from "@orq-ai/node/funcs/memoryStoresList.js";
54
-
55
- // Use `OrqCore` for best tree-shaking performance.
56
- // You can create one instance of it to use across an application.
57
- const orq = new OrqCore({
58
- apiKey: process.env["ORQ_API_KEY"] ?? "",
59
- });
60
-
61
- async function run() {
62
- const res = await memoryStoresList(orq, {});
63
-
64
- if (!res.ok) {
65
- throw res.error;
66
- }
67
-
68
- const { value: result } = res;
69
-
70
- // Handle the result
71
- console.log(result);
72
- }
73
-
74
- run();
75
- ```
76
-
77
- ### Parameters
78
-
79
- | Parameter | Type | Required | Description |
80
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81
- | `request` | [operations.GetAllMemoryStoresRequest](../../models/operations/getallmemorystoresrequest.md) | :heavy_check_mark: | The request object to use for the request. |
82
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
83
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
84
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
85
-
86
- ### Response
87
-
88
- **Promise\<[operations.GetAllMemoryStoresResponseBody](../../models/operations/getallmemorystoresresponsebody.md)\>**
89
-
90
- ### Errors
91
-
92
- | Error Type | Status Code | Content Type |
93
- | ------------------- | ------------------- | ------------------- |
94
- | errors.HonoApiError | 401 | application/json |
95
- | errors.APIError | 4XX, 5XX | \*/\* |
96
-
97
- ## create
98
-
99
- Create memory store
100
-
101
- ### Example Usage
102
-
103
- ```typescript
104
- import { Orq } from "@orq-ai/node";
105
-
106
- const orq = new Orq({
107
- apiKey: process.env["ORQ_API_KEY"] ?? "",
108
- });
109
-
110
- async function run() {
111
- const result = await orq.memoryStores.create({
112
- key: "<key>",
113
- embeddingConfig: {
114
- model: "google-ai/text-embedding-004",
115
- },
116
- description: "delightfully fumigate convection though zowie up bulky electronics",
117
- path: "Customer Service/Billing/Refund",
118
- });
119
-
120
- // Handle the result
121
- console.log(result);
122
- }
123
-
124
- run();
125
- ```
126
-
127
- ### Standalone function
128
-
129
- The standalone function version of this method:
130
-
131
- ```typescript
132
- import { OrqCore } from "@orq-ai/node/core.js";
133
- import { memoryStoresCreate } from "@orq-ai/node/funcs/memoryStoresCreate.js";
134
-
135
- // Use `OrqCore` for best tree-shaking performance.
136
- // You can create one instance of it to use across an application.
137
- const orq = new OrqCore({
138
- apiKey: process.env["ORQ_API_KEY"] ?? "",
139
- });
140
-
141
- async function run() {
142
- const res = await memoryStoresCreate(orq, {
143
- key: "<key>",
144
- embeddingConfig: {
145
- model: "google-ai/text-embedding-004",
146
- },
147
- description: "delightfully fumigate convection though zowie up bulky electronics",
148
- path: "Customer Service/Billing/Refund",
149
- });
150
-
151
- if (!res.ok) {
152
- throw res.error;
153
- }
154
-
155
- const { value: result } = res;
156
-
157
- // Handle the result
158
- console.log(result);
159
- }
160
-
161
- run();
162
- ```
163
-
164
- ### Parameters
165
-
166
- | Parameter | Type | Required | Description |
167
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
168
- | `request` | [operations.CreateMemoryStoreRequestBody](../../models/operations/creatememorystorerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
169
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
170
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
171
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
172
-
173
- ### Response
174
-
175
- **Promise\<[operations.CreateMemoryStoreResponseBody](../../models/operations/creatememorystoreresponsebody.md)\>**
176
-
177
- ### Errors
178
-
179
- | Error Type | Status Code | Content Type |
180
- | ------------------- | ------------------- | ------------------- |
181
- | errors.HonoApiError | 400 | application/json |
182
- | errors.APIError | 4XX, 5XX | \*/\* |
183
-
184
- ## retrieve
185
-
186
- Retrieves detailed information about a specific memory store, including its configuration and metadata.
187
-
188
- ### Example Usage
189
-
190
- ```typescript
191
- import { Orq } from "@orq-ai/node";
192
-
193
- const orq = new Orq({
194
- apiKey: process.env["ORQ_API_KEY"] ?? "",
195
- });
196
-
197
- async function run() {
198
- const result = await orq.memoryStores.retrieve({
199
- memoryStoreKey: "<value>",
200
- });
201
-
202
- // Handle the result
203
- console.log(result);
204
- }
205
-
206
- run();
207
- ```
208
-
209
- ### Standalone function
210
-
211
- The standalone function version of this method:
212
-
213
- ```typescript
214
- import { OrqCore } from "@orq-ai/node/core.js";
215
- import { memoryStoresRetrieve } from "@orq-ai/node/funcs/memoryStoresRetrieve.js";
216
-
217
- // Use `OrqCore` for best tree-shaking performance.
218
- // You can create one instance of it to use across an application.
219
- const orq = new OrqCore({
220
- apiKey: process.env["ORQ_API_KEY"] ?? "",
221
- });
222
-
223
- async function run() {
224
- const res = await memoryStoresRetrieve(orq, {
225
- memoryStoreKey: "<value>",
226
- });
227
-
228
- if (!res.ok) {
229
- throw res.error;
230
- }
231
-
232
- const { value: result } = res;
233
-
234
- // Handle the result
235
- console.log(result);
236
- }
237
-
238
- run();
239
- ```
240
-
241
- ### Parameters
242
-
243
- | Parameter | Type | Required | Description |
244
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
245
- | `request` | [operations.RetrieveMemoryStoreRequest](../../models/operations/retrievememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
246
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
247
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
248
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
249
-
250
- ### Response
251
-
252
- **Promise\<[operations.RetrieveMemoryStoreResponseBody](../../models/operations/retrievememorystoreresponsebody.md)\>**
253
-
254
- ### Errors
255
-
256
- | Error Type | Status Code | Content Type |
257
- | ------------------- | ------------------- | ------------------- |
258
- | errors.HonoApiError | 401, 403, 404 | application/json |
259
- | errors.APIError | 4XX, 5XX | \*/\* |
260
-
261
- ## update
262
-
263
- Update the memory store configuration
264
-
265
- ### Example Usage
266
-
267
- ```typescript
268
- import { Orq } from "@orq-ai/node";
269
-
270
- const orq = new Orq({
271
- apiKey: process.env["ORQ_API_KEY"] ?? "",
272
- });
273
-
274
- async function run() {
275
- const result = await orq.memoryStores.update({
276
- memoryStoreKey: "<value>",
277
- requestBody: {
278
- embeddingConfig: {
279
- model: "jina/jina-embeddings-v2-base-de",
280
- },
281
- description: "technician eulogise whereas till mild than during",
282
- path: "Customer Service/Billing/Refund",
283
- },
284
- });
285
-
286
- // Handle the result
287
- console.log(result);
288
- }
289
-
290
- run();
291
- ```
292
-
293
- ### Standalone function
294
-
295
- The standalone function version of this method:
296
-
297
- ```typescript
298
- import { OrqCore } from "@orq-ai/node/core.js";
299
- import { memoryStoresUpdate } from "@orq-ai/node/funcs/memoryStoresUpdate.js";
300
-
301
- // Use `OrqCore` for best tree-shaking performance.
302
- // You can create one instance of it to use across an application.
303
- const orq = new OrqCore({
304
- apiKey: process.env["ORQ_API_KEY"] ?? "",
305
- });
306
-
307
- async function run() {
308
- const res = await memoryStoresUpdate(orq, {
309
- memoryStoreKey: "<value>",
310
- requestBody: {
311
- embeddingConfig: {
312
- model: "jina/jina-embeddings-v2-base-de",
313
- },
314
- description: "technician eulogise whereas till mild than during",
315
- path: "Customer Service/Billing/Refund",
316
- },
317
- });
318
-
319
- if (!res.ok) {
320
- throw res.error;
321
- }
322
-
323
- const { value: result } = res;
324
-
325
- // Handle the result
326
- console.log(result);
327
- }
328
-
329
- run();
330
- ```
331
-
332
- ### Parameters
333
-
334
- | Parameter | Type | Required | Description |
335
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
336
- | `request` | [operations.UpdateMemoryStoreRequest](../../models/operations/updatememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
337
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
338
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
339
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
340
-
341
- ### Response
342
-
343
- **Promise\<[operations.UpdateMemoryStoreResponseBody](../../models/operations/updatememorystoreresponsebody.md)\>**
344
-
345
- ### Errors
346
-
347
- | Error Type | Status Code | Content Type |
348
- | --------------- | --------------- | --------------- |
349
- | errors.APIError | 4XX, 5XX | \*/\* |
350
-
351
- ## delete
352
-
353
- Permanently delete a memory store, including memories and documents.
354
-
355
- ### Example Usage
356
-
357
- ```typescript
358
- import { Orq } from "@orq-ai/node";
359
-
360
- const orq = new Orq({
361
- apiKey: process.env["ORQ_API_KEY"] ?? "",
362
- });
363
-
364
- async function run() {
365
- await orq.memoryStores.delete({
366
- memoryStoreKey: "<value>",
367
- });
368
-
369
-
370
- }
371
-
372
- run();
373
- ```
374
-
375
- ### Standalone function
376
-
377
- The standalone function version of this method:
378
-
379
- ```typescript
380
- import { OrqCore } from "@orq-ai/node/core.js";
381
- import { memoryStoresDelete } from "@orq-ai/node/funcs/memoryStoresDelete.js";
382
-
383
- // Use `OrqCore` for best tree-shaking performance.
384
- // You can create one instance of it to use across an application.
385
- const orq = new OrqCore({
386
- apiKey: process.env["ORQ_API_KEY"] ?? "",
387
- });
388
-
389
- async function run() {
390
- const res = await memoryStoresDelete(orq, {
391
- memoryStoreKey: "<value>",
392
- });
393
-
394
- if (!res.ok) {
395
- throw res.error;
396
- }
397
-
398
- const { value: result } = res;
399
-
400
-
401
- }
402
-
403
- run();
404
- ```
405
-
406
- ### Parameters
407
-
408
- | Parameter | Type | Required | Description |
409
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
410
- | `request` | [operations.DeleteMemoryStoreRequest](../../models/operations/deletememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
411
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
412
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
413
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
414
-
415
- ### Response
416
-
417
- **Promise\<void\>**
418
-
419
- ### Errors
420
-
421
- | Error Type | Status Code | Content Type |
422
- | --------------- | --------------- | --------------- |
423
- | errors.APIError | 4XX, 5XX | \*/\* |
424
-
425
- ## listMemories
426
-
427
- Retrieves a paginated list of memories for the memory store
428
-
429
- ### Example Usage
430
-
431
- ```typescript
432
- import { Orq } from "@orq-ai/node";
433
-
434
- const orq = new Orq({
435
- apiKey: process.env["ORQ_API_KEY"] ?? "",
436
- });
437
-
438
- async function run() {
439
- const result = await orq.memoryStores.listMemories({
440
- memoryStoreKey: "<value>",
441
- });
442
-
443
- // Handle the result
444
- console.log(result);
445
- }
446
-
447
- run();
448
- ```
449
-
450
- ### Standalone function
451
-
452
- The standalone function version of this method:
453
-
454
- ```typescript
455
- import { OrqCore } from "@orq-ai/node/core.js";
456
- import { memoryStoresListMemories } from "@orq-ai/node/funcs/memoryStoresListMemories.js";
457
-
458
- // Use `OrqCore` for best tree-shaking performance.
459
- // You can create one instance of it to use across an application.
460
- const orq = new OrqCore({
461
- apiKey: process.env["ORQ_API_KEY"] ?? "",
462
- });
463
-
464
- async function run() {
465
- const res = await memoryStoresListMemories(orq, {
466
- memoryStoreKey: "<value>",
467
- });
468
-
469
- if (!res.ok) {
470
- throw res.error;
471
- }
472
-
473
- const { value: result } = res;
474
-
475
- // Handle the result
476
- console.log(result);
477
- }
478
-
479
- run();
480
- ```
481
-
482
- ### Parameters
483
-
484
- | Parameter | Type | Required | Description |
485
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
486
- | `request` | [operations.GetAllMemoriesRequest](../../models/operations/getallmemoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
487
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
488
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
489
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
490
-
491
- ### Response
492
-
493
- **Promise\<[operations.GetAllMemoriesResponseBody](../../models/operations/getallmemoriesresponsebody.md)\>**
494
-
495
- ### Errors
496
-
497
- | Error Type | Status Code | Content Type |
498
- | --------------- | --------------- | --------------- |
499
- | errors.APIError | 4XX, 5XX | \*/\* |
500
-
501
- ## createMemory
502
-
503
- Creates a new memory in the specified memory store.
504
-
505
- ### Example Usage
506
-
507
- ```typescript
508
- import { Orq } from "@orq-ai/node";
509
-
510
- const orq = new Orq({
511
- apiKey: process.env["ORQ_API_KEY"] ?? "",
512
- });
513
-
514
- async function run() {
515
- const result = await orq.memoryStores.createMemory({
516
- memoryStoreKey: "<value>",
517
- });
518
-
519
- // Handle the result
520
- console.log(result);
521
- }
522
-
523
- run();
524
- ```
525
-
526
- ### Standalone function
527
-
528
- The standalone function version of this method:
529
-
530
- ```typescript
531
- import { OrqCore } from "@orq-ai/node/core.js";
532
- import { memoryStoresCreateMemory } from "@orq-ai/node/funcs/memoryStoresCreateMemory.js";
533
-
534
- // Use `OrqCore` for best tree-shaking performance.
535
- // You can create one instance of it to use across an application.
536
- const orq = new OrqCore({
537
- apiKey: process.env["ORQ_API_KEY"] ?? "",
538
- });
539
-
540
- async function run() {
541
- const res = await memoryStoresCreateMemory(orq, {
542
- memoryStoreKey: "<value>",
543
- });
544
-
545
- if (!res.ok) {
546
- throw res.error;
547
- }
548
-
549
- const { value: result } = res;
550
-
551
- // Handle the result
552
- console.log(result);
553
- }
554
-
555
- run();
556
- ```
557
-
558
- ### Parameters
559
-
560
- | Parameter | Type | Required | Description |
561
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
562
- | `request` | [operations.CreateMemoryRequest](../../models/operations/creatememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
563
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
564
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
565
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
566
-
567
- ### Response
568
-
569
- **Promise\<[operations.CreateMemoryResponseBody](../../models/operations/creatememoryresponsebody.md)\>**
570
-
571
- ### Errors
572
-
573
- | Error Type | Status Code | Content Type |
574
- | --------------- | --------------- | --------------- |
575
- | errors.APIError | 4XX, 5XX | \*/\* |
576
-
577
- ## retrieveMemory
578
-
579
- Retrieves details of a specific memory by its ID
580
-
581
- ### Example Usage
582
-
583
- ```typescript
584
- import { Orq } from "@orq-ai/node";
585
-
586
- const orq = new Orq({
587
- apiKey: process.env["ORQ_API_KEY"] ?? "",
588
- });
589
-
590
- async function run() {
591
- const result = await orq.memoryStores.retrieveMemory({
592
- memoryStoreKey: "<value>",
593
- memoryId: "<id>",
594
- });
595
-
596
- // Handle the result
597
- console.log(result);
598
- }
599
-
600
- run();
601
- ```
602
-
603
- ### Standalone function
604
-
605
- The standalone function version of this method:
606
-
607
- ```typescript
608
- import { OrqCore } from "@orq-ai/node/core.js";
609
- import { memoryStoresRetrieveMemory } from "@orq-ai/node/funcs/memoryStoresRetrieveMemory.js";
610
-
611
- // Use `OrqCore` for best tree-shaking performance.
612
- // You can create one instance of it to use across an application.
613
- const orq = new OrqCore({
614
- apiKey: process.env["ORQ_API_KEY"] ?? "",
615
- });
616
-
617
- async function run() {
618
- const res = await memoryStoresRetrieveMemory(orq, {
619
- memoryStoreKey: "<value>",
620
- memoryId: "<id>",
621
- });
622
-
623
- if (!res.ok) {
624
- throw res.error;
625
- }
626
-
627
- const { value: result } = res;
628
-
629
- // Handle the result
630
- console.log(result);
631
- }
632
-
633
- run();
634
- ```
635
-
636
- ### Parameters
637
-
638
- | Parameter | Type | Required | Description |
639
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
640
- | `request` | [operations.RetrieveMemoryRequest](../../models/operations/retrievememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
641
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
642
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
643
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
644
-
645
- ### Response
646
-
647
- **Promise\<[operations.RetrieveMemoryResponseBody](../../models/operations/retrievememoryresponsebody.md)\>**
648
-
649
- ### Errors
650
-
651
- | Error Type | Status Code | Content Type |
652
- | --------------- | --------------- | --------------- |
653
- | errors.APIError | 4XX, 5XX | \*/\* |
654
-
655
- ## updateMemory
656
-
657
- Updates the details of a specific memory.
658
-
659
- ### Example Usage
660
-
661
- ```typescript
662
- import { Orq } from "@orq-ai/node";
663
-
664
- const orq = new Orq({
665
- apiKey: process.env["ORQ_API_KEY"] ?? "",
666
- });
667
-
668
- async function run() {
669
- const result = await orq.memoryStores.updateMemory({
670
- memoryStoreKey: "<value>",
671
- memoryId: "<id>",
672
- });
673
-
674
- // Handle the result
675
- console.log(result);
676
- }
677
-
678
- run();
679
- ```
680
-
681
- ### Standalone function
682
-
683
- The standalone function version of this method:
684
-
685
- ```typescript
686
- import { OrqCore } from "@orq-ai/node/core.js";
687
- import { memoryStoresUpdateMemory } from "@orq-ai/node/funcs/memoryStoresUpdateMemory.js";
688
-
689
- // Use `OrqCore` for best tree-shaking performance.
690
- // You can create one instance of it to use across an application.
691
- const orq = new OrqCore({
692
- apiKey: process.env["ORQ_API_KEY"] ?? "",
693
- });
694
-
695
- async function run() {
696
- const res = await memoryStoresUpdateMemory(orq, {
697
- memoryStoreKey: "<value>",
698
- memoryId: "<id>",
699
- });
700
-
701
- if (!res.ok) {
702
- throw res.error;
703
- }
704
-
705
- const { value: result } = res;
706
-
707
- // Handle the result
708
- console.log(result);
709
- }
710
-
711
- run();
712
- ```
713
-
714
- ### Parameters
715
-
716
- | Parameter | Type | Required | Description |
717
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
718
- | `request` | [operations.UpdateMemoryRequest](../../models/operations/updatememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
719
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
720
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
721
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
722
-
723
- ### Response
724
-
725
- **Promise\<[operations.UpdateMemoryResponseBody](../../models/operations/updatememoryresponsebody.md)\>**
726
-
727
- ### Errors
728
-
729
- | Error Type | Status Code | Content Type |
730
- | --------------- | --------------- | --------------- |
731
- | errors.APIError | 4XX, 5XX | \*/\* |
732
-
733
- ## deleteMemory
734
-
735
- Permanently deletes a specific memory.
736
-
737
- Use this endpoint to:
738
- - Remove a memory from the store
739
- - Clean up unused memories
740
- - Manage memory storage space
741
-
742
- ### Example Usage
743
-
744
- ```typescript
745
- import { Orq } from "@orq-ai/node";
746
-
747
- const orq = new Orq({
748
- apiKey: process.env["ORQ_API_KEY"] ?? "",
749
- });
750
-
751
- async function run() {
752
- await orq.memoryStores.deleteMemory({
753
- memoryStoreKey: "<value>",
754
- memoryId: "<id>",
755
- });
756
-
757
-
758
- }
759
-
760
- run();
761
- ```
762
-
763
- ### Standalone function
764
-
765
- The standalone function version of this method:
766
-
767
- ```typescript
768
- import { OrqCore } from "@orq-ai/node/core.js";
769
- import { memoryStoresDeleteMemory } from "@orq-ai/node/funcs/memoryStoresDeleteMemory.js";
770
-
771
- // Use `OrqCore` for best tree-shaking performance.
772
- // You can create one instance of it to use across an application.
773
- const orq = new OrqCore({
774
- apiKey: process.env["ORQ_API_KEY"] ?? "",
775
- });
776
-
777
- async function run() {
778
- const res = await memoryStoresDeleteMemory(orq, {
779
- memoryStoreKey: "<value>",
780
- memoryId: "<id>",
781
- });
782
-
783
- if (!res.ok) {
784
- throw res.error;
785
- }
786
-
787
- const { value: result } = res;
788
-
789
-
790
- }
791
-
792
- run();
793
- ```
794
-
795
- ### Parameters
796
-
797
- | Parameter | Type | Required | Description |
798
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
799
- | `request` | [operations.DeleteMemoryRequest](../../models/operations/deletememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
800
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
801
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
802
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
803
-
804
- ### Response
805
-
806
- **Promise\<void\>**
807
-
808
- ### Errors
809
-
810
- | Error Type | Status Code | Content Type |
811
- | --------------- | --------------- | --------------- |
812
- | errors.APIError | 4XX, 5XX | \*/\* |
813
-
814
- ## listDocuments
815
-
816
- Retrieves a paginated list of documents associated with a specific memory.
817
-
818
- ### Example Usage
819
-
820
- ```typescript
821
- import { Orq } from "@orq-ai/node";
822
-
823
- const orq = new Orq({
824
- apiKey: process.env["ORQ_API_KEY"] ?? "",
825
- });
826
-
827
- async function run() {
828
- const result = await orq.memoryStores.listDocuments({
829
- memoryStoreKey: "<value>",
830
- memoryId: "<id>",
831
- });
832
-
833
- // Handle the result
834
- console.log(result);
835
- }
836
-
837
- run();
838
- ```
839
-
840
- ### Standalone function
841
-
842
- The standalone function version of this method:
843
-
844
- ```typescript
845
- import { OrqCore } from "@orq-ai/node/core.js";
846
- import { memoryStoresListDocuments } from "@orq-ai/node/funcs/memoryStoresListDocuments.js";
847
-
848
- // Use `OrqCore` for best tree-shaking performance.
849
- // You can create one instance of it to use across an application.
850
- const orq = new OrqCore({
851
- apiKey: process.env["ORQ_API_KEY"] ?? "",
852
- });
853
-
854
- async function run() {
855
- const res = await memoryStoresListDocuments(orq, {
856
- memoryStoreKey: "<value>",
857
- memoryId: "<id>",
858
- });
859
-
860
- if (!res.ok) {
861
- throw res.error;
862
- }
863
-
864
- const { value: result } = res;
865
-
866
- // Handle the result
867
- console.log(result);
868
- }
869
-
870
- run();
871
- ```
872
-
873
- ### Parameters
874
-
875
- | Parameter | Type | Required | Description |
876
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
877
- | `request` | [operations.GetAllMemoryDocumentsRequest](../../models/operations/getallmemorydocumentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
878
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
879
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
880
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
881
-
882
- ### Response
883
-
884
- **Promise\<[operations.GetAllMemoryDocumentsResponseBody](../../models/operations/getallmemorydocumentsresponsebody.md)\>**
885
-
886
- ### Errors
887
-
888
- | Error Type | Status Code | Content Type |
889
- | --------------- | --------------- | --------------- |
890
- | errors.APIError | 4XX, 5XX | \*/\* |
891
-
892
- ## createDocument
893
-
894
- Creates a new document in the specified memory.
895
-
896
- ### Example Usage
897
-
898
- ```typescript
899
- import { Orq } from "@orq-ai/node";
900
-
901
- const orq = new Orq({
902
- apiKey: process.env["ORQ_API_KEY"] ?? "",
903
- });
904
-
905
- async function run() {
906
- const result = await orq.memoryStores.createDocument({
907
- memoryStoreKey: "<value>",
908
- memoryId: "<id>",
909
- });
910
-
911
- // Handle the result
912
- console.log(result);
913
- }
914
-
915
- run();
916
- ```
917
-
918
- ### Standalone function
919
-
920
- The standalone function version of this method:
921
-
922
- ```typescript
923
- import { OrqCore } from "@orq-ai/node/core.js";
924
- import { memoryStoresCreateDocument } from "@orq-ai/node/funcs/memoryStoresCreateDocument.js";
925
-
926
- // Use `OrqCore` for best tree-shaking performance.
927
- // You can create one instance of it to use across an application.
928
- const orq = new OrqCore({
929
- apiKey: process.env["ORQ_API_KEY"] ?? "",
930
- });
931
-
932
- async function run() {
933
- const res = await memoryStoresCreateDocument(orq, {
934
- memoryStoreKey: "<value>",
935
- memoryId: "<id>",
936
- });
937
-
938
- if (!res.ok) {
939
- throw res.error;
940
- }
941
-
942
- const { value: result } = res;
943
-
944
- // Handle the result
945
- console.log(result);
946
- }
947
-
948
- run();
949
- ```
950
-
951
- ### Parameters
952
-
953
- | Parameter | Type | Required | Description |
954
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
955
- | `request` | [operations.CreateMemoryDocumentRequest](../../models/operations/creatememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
956
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
957
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
958
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
959
-
960
- ### Response
961
-
962
- **Promise\<[operations.CreateMemoryDocumentResponseBody](../../models/operations/creatememorydocumentresponsebody.md)\>**
963
-
964
- ### Errors
965
-
966
- | Error Type | Status Code | Content Type |
967
- | --------------- | --------------- | --------------- |
968
- | errors.APIError | 4XX, 5XX | \*/\* |
969
-
970
- ## retrieveDocument
971
-
972
- Retrieves details of a specific memory document by its ID.
973
-
974
- ### Example Usage
975
-
976
- ```typescript
977
- import { Orq } from "@orq-ai/node";
978
-
979
- const orq = new Orq({
980
- apiKey: process.env["ORQ_API_KEY"] ?? "",
981
- });
982
-
983
- async function run() {
984
- const result = await orq.memoryStores.retrieveDocument({
985
- memoryStoreKey: "<value>",
986
- memoryId: "<id>",
987
- documentId: "<id>",
988
- });
989
-
990
- // Handle the result
991
- console.log(result);
992
- }
993
-
994
- run();
995
- ```
996
-
997
- ### Standalone function
998
-
999
- The standalone function version of this method:
1000
-
1001
- ```typescript
1002
- import { OrqCore } from "@orq-ai/node/core.js";
1003
- import { memoryStoresRetrieveDocument } from "@orq-ai/node/funcs/memoryStoresRetrieveDocument.js";
1004
-
1005
- // Use `OrqCore` for best tree-shaking performance.
1006
- // You can create one instance of it to use across an application.
1007
- const orq = new OrqCore({
1008
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1009
- });
1010
-
1011
- async function run() {
1012
- const res = await memoryStoresRetrieveDocument(orq, {
1013
- memoryStoreKey: "<value>",
1014
- memoryId: "<id>",
1015
- documentId: "<id>",
1016
- });
1017
-
1018
- if (!res.ok) {
1019
- throw res.error;
1020
- }
1021
-
1022
- const { value: result } = res;
1023
-
1024
- // Handle the result
1025
- console.log(result);
1026
- }
1027
-
1028
- run();
1029
- ```
1030
-
1031
- ### Parameters
1032
-
1033
- | Parameter | Type | Required | Description |
1034
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1035
- | `request` | [operations.RetrieveMemoryDocumentRequest](../../models/operations/retrievememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1036
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1037
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1038
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1039
-
1040
- ### Response
1041
-
1042
- **Promise\<[operations.RetrieveMemoryDocumentResponseBody](../../models/operations/retrievememorydocumentresponsebody.md)\>**
1043
-
1044
- ### Errors
1045
-
1046
- | Error Type | Status Code | Content Type |
1047
- | --------------- | --------------- | --------------- |
1048
- | errors.APIError | 4XX, 5XX | \*/\* |
1049
-
1050
- ## updateDocument
1051
-
1052
- Updates the details of a specific memory document.
1053
-
1054
- ### Example Usage
1055
-
1056
- ```typescript
1057
- import { Orq } from "@orq-ai/node";
1058
-
1059
- const orq = new Orq({
1060
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1061
- });
1062
-
1063
- async function run() {
1064
- const result = await orq.memoryStores.updateDocument({
1065
- memoryStoreKey: "<value>",
1066
- memoryId: "<id>",
1067
- documentId: "<id>",
1068
- });
1069
-
1070
- // Handle the result
1071
- console.log(result);
1072
- }
1073
-
1074
- run();
1075
- ```
1076
-
1077
- ### Standalone function
1078
-
1079
- The standalone function version of this method:
1080
-
1081
- ```typescript
1082
- import { OrqCore } from "@orq-ai/node/core.js";
1083
- import { memoryStoresUpdateDocument } from "@orq-ai/node/funcs/memoryStoresUpdateDocument.js";
1084
-
1085
- // Use `OrqCore` for best tree-shaking performance.
1086
- // You can create one instance of it to use across an application.
1087
- const orq = new OrqCore({
1088
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1089
- });
1090
-
1091
- async function run() {
1092
- const res = await memoryStoresUpdateDocument(orq, {
1093
- memoryStoreKey: "<value>",
1094
- memoryId: "<id>",
1095
- documentId: "<id>",
1096
- });
1097
-
1098
- if (!res.ok) {
1099
- throw res.error;
1100
- }
1101
-
1102
- const { value: result } = res;
1103
-
1104
- // Handle the result
1105
- console.log(result);
1106
- }
1107
-
1108
- run();
1109
- ```
1110
-
1111
- ### Parameters
1112
-
1113
- | Parameter | Type | Required | Description |
1114
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1115
- | `request` | [operations.UpdateMemoryDocumentRequest](../../models/operations/updatememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1116
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1117
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1118
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1119
-
1120
- ### Response
1121
-
1122
- **Promise\<[operations.UpdateMemoryDocumentResponseBody](../../models/operations/updatememorydocumentresponsebody.md)\>**
1123
-
1124
- ### Errors
1125
-
1126
- | Error Type | Status Code | Content Type |
1127
- | --------------- | --------------- | --------------- |
1128
- | errors.APIError | 4XX, 5XX | \*/\* |
1129
-
1130
- ## deleteDocument
1131
-
1132
- Permanently deletes a specific memory document.
1133
-
1134
- Use this endpoint to:
1135
- - Remove a document from a memory
1136
- - Clean up unused documents
1137
- - Manage document storage space
1138
-
1139
- ### Example Usage
1140
-
1141
- ```typescript
1142
- import { Orq } from "@orq-ai/node";
1143
-
1144
- const orq = new Orq({
1145
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1146
- });
1147
-
1148
- async function run() {
1149
- await orq.memoryStores.deleteDocument({
1150
- memoryStoreKey: "<value>",
1151
- memoryId: "<id>",
1152
- documentId: "<id>",
1153
- });
1154
-
1155
-
1156
- }
1157
-
1158
- run();
1159
- ```
1160
-
1161
- ### Standalone function
1162
-
1163
- The standalone function version of this method:
1164
-
1165
- ```typescript
1166
- import { OrqCore } from "@orq-ai/node/core.js";
1167
- import { memoryStoresDeleteDocument } from "@orq-ai/node/funcs/memoryStoresDeleteDocument.js";
1168
-
1169
- // Use `OrqCore` for best tree-shaking performance.
1170
- // You can create one instance of it to use across an application.
1171
- const orq = new OrqCore({
1172
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1173
- });
1174
-
1175
- async function run() {
1176
- const res = await memoryStoresDeleteDocument(orq, {
1177
- memoryStoreKey: "<value>",
1178
- memoryId: "<id>",
1179
- documentId: "<id>",
1180
- });
1181
-
1182
- if (!res.ok) {
1183
- throw res.error;
1184
- }
1185
-
1186
- const { value: result } = res;
1187
-
1188
-
1189
- }
1190
-
1191
- run();
1192
- ```
1193
-
1194
- ### Parameters
1195
-
1196
- | Parameter | Type | Required | Description |
1197
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1198
- | `request` | [operations.DeleteMemoryDocumentRequest](../../models/operations/deletememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1199
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1200
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1201
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1202
-
1203
- ### Response
1204
-
1205
- **Promise\<void\>**
1206
-
1207
- ### Errors
1208
-
1209
- | Error Type | Status Code | Content Type |
1210
- | --------------- | --------------- | --------------- |
1211
- | errors.APIError | 4XX, 5XX | \*/\* |