@orq-ai/node 3.14.8 → 4.0.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (494) hide show
  1. package/bin/mcp-server.js +210 -213
  2. package/bin/mcp-server.js.map +38 -38
  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 +4 -2
  6. package/examples/package-lock.json +5 -6
  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 +10 -10
  22. package/models/operations/duplicatetool.js +10 -10
  23. package/models/operations/fileget.js +2 -2
  24. package/models/operations/filelist.js +2 -2
  25. package/models/operations/fileupload.js +2 -2
  26. package/models/operations/getalltools.js +10 -10
  27. package/models/operations/getbudget.js +2 -2
  28. package/models/operations/getevals.js +28 -28
  29. package/models/operations/listbudgets.js +2 -2
  30. package/models/operations/listcontacts.js +2 -2
  31. package/models/operations/listdatasetdatapoints.js +8 -8
  32. package/models/operations/listdatasets.js +2 -2
  33. package/models/operations/listdatasources.js +2 -2
  34. package/models/operations/retrievecontact.js +2 -2
  35. package/models/operations/retrievedatapoint.js +8 -8
  36. package/models/operations/retrievedataset.js +2 -2
  37. package/models/operations/retrievedatasource.js +2 -2
  38. package/models/operations/retrievetool.js +10 -10
  39. package/models/operations/updatebudget.js +2 -2
  40. package/models/operations/updatecontact.js +2 -2
  41. package/models/operations/updatedatapoint.js +8 -8
  42. package/models/operations/updatedataset.js +2 -2
  43. package/models/operations/updatedatasource.js +2 -2
  44. package/models/operations/updateeval.js +28 -28
  45. package/models/operations/updatetool.js +10 -10
  46. package/package.json +4 -4
  47. package/src/lib/config.ts +2 -2
  48. package/src/mcp-server/mcp-server.ts +1 -1
  49. package/src/mcp-server/server.ts +1 -1
  50. package/src/models/operations/createbudget.ts +2 -2
  51. package/src/models/operations/createcontact.ts +2 -2
  52. package/src/models/operations/createdataset.ts +2 -2
  53. package/src/models/operations/createdatasetitem.ts +8 -8
  54. package/src/models/operations/createdatasource.ts +2 -2
  55. package/src/models/operations/createeval.ts +28 -28
  56. package/src/models/operations/createtool.ts +10 -10
  57. package/src/models/operations/duplicatetool.ts +10 -10
  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 +10 -10
  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 +10 -10
  74. package/src/models/operations/updatebudget.ts +2 -2
  75. package/src/models/operations/updatecontact.ts +2 -2
  76. package/src/models/operations/updatedatapoint.ts +8 -8
  77. package/src/models/operations/updatedataset.ts +2 -2
  78. package/src/models/operations/updatedatasource.ts +2 -2
  79. package/src/models/operations/updateeval.ts +28 -28
  80. package/src/models/operations/updatetool.ts +10 -10
  81. package/packages/orq-rc/FUNCTIONS.md +0 -103
  82. package/packages/orq-rc/README.md +0 -909
  83. package/packages/orq-rc/RUNTIMES.md +0 -48
  84. package/packages/orq-rc/docs/sdks/agents/README.md +0 -1319
  85. package/packages/orq-rc/docs/sdks/budgets/README.md +0 -401
  86. package/packages/orq-rc/docs/sdks/chunking/README.md +0 -95
  87. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -450
  88. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -836
  89. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -312
  90. package/packages/orq-rc/docs/sdks/evals/README.md +0 -339
  91. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -89
  92. package/packages/orq-rc/docs/sdks/files/README.md +0 -301
  93. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1489
  94. package/packages/orq-rc/docs/sdks/memorystores/README.md +0 -1172
  95. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -83
  96. package/packages/orq-rc/docs/sdks/models/README.md +0 -76
  97. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -591
  98. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -77
  99. package/packages/orq-rc/docs/sdks/tools/README.md +0 -490
  100. package/packages/orq-rc/examples/README.md +0 -31
  101. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
  102. package/packages/orq-rc/examples/package-lock.json +0 -627
  103. package/packages/orq-rc/examples/package.json +0 -18
  104. package/packages/orq-rc/jsr.json +0 -28
  105. package/packages/orq-rc/package-lock.json +0 -3071
  106. package/packages/orq-rc/package.json +0 -43
  107. package/packages/orq-rc/src/core.ts +0 -13
  108. package/packages/orq-rc/src/funcs/agentsCreate.ts +0 -172
  109. package/packages/orq-rc/src/funcs/agentsDelete.ts +0 -176
  110. package/packages/orq-rc/src/funcs/agentsInvoke.ts +0 -167
  111. package/packages/orq-rc/src/funcs/agentsList.ts +0 -167
  112. package/packages/orq-rc/src/funcs/agentsListActions.ts +0 -169
  113. package/packages/orq-rc/src/funcs/agentsListTasks.ts +0 -183
  114. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +0 -175
  115. package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +0 -173
  116. package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +0 -179
  117. package/packages/orq-rc/src/funcs/agentsRun.ts +0 -163
  118. package/packages/orq-rc/src/funcs/agentsStream.ts +0 -190
  119. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +0 -188
  120. package/packages/orq-rc/src/funcs/agentsUpdate.ts +0 -176
  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 -171
  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 -163
  201. package/packages/orq-rc/src/funcs/toolsDelete.ts +0 -167
  202. package/packages/orq-rc/src/funcs/toolsDuplicate.ts +0 -175
  203. package/packages/orq-rc/src/funcs/toolsList.ts +0 -176
  204. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +0 -166
  205. package/packages/orq-rc/src/funcs/toolsUpdate.ts +0 -176
  206. package/packages/orq-rc/src/hooks/global.ts +0 -44
  207. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  208. package/packages/orq-rc/src/hooks/index.ts +0 -6
  209. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  210. package/packages/orq-rc/src/hooks/types.ts +0 -112
  211. package/packages/orq-rc/src/index.ts +0 -9
  212. package/packages/orq-rc/src/lib/base64.ts +0 -37
  213. package/packages/orq-rc/src/lib/config.ts +0 -74
  214. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  215. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  216. package/packages/orq-rc/src/lib/env.ts +0 -89
  217. package/packages/orq-rc/src/lib/event-streams.ts +0 -135
  218. package/packages/orq-rc/src/lib/files.ts +0 -82
  219. package/packages/orq-rc/src/lib/http.ts +0 -323
  220. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  221. package/packages/orq-rc/src/lib/logger.ts +0 -9
  222. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  223. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  224. package/packages/orq-rc/src/lib/retries.ts +0 -218
  225. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  226. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  227. package/packages/orq-rc/src/lib/security.ts +0 -264
  228. package/packages/orq-rc/src/lib/url.ts +0 -33
  229. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -111
  230. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
  231. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  232. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  233. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  234. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  235. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  236. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  237. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  238. package/packages/orq-rc/src/mcp-server/server.ts +0 -259
  239. package/packages/orq-rc/src/mcp-server/shared.ts +0 -74
  240. package/packages/orq-rc/src/mcp-server/tools/agentsCreate.ts +0 -37
  241. package/packages/orq-rc/src/mcp-server/tools/agentsDelete.ts +0 -35
  242. package/packages/orq-rc/src/mcp-server/tools/agentsInvoke.ts +0 -37
  243. package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +0 -37
  244. package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +0 -35
  245. package/packages/orq-rc/src/mcp-server/tools/agentsListTasks.ts +0 -37
  246. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +0 -37
  247. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +0 -35
  248. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +0 -37
  249. package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +0 -37
  250. package/packages/orq-rc/src/mcp-server/tools/agentsStream.ts +0 -37
  251. package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +0 -37
  252. package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +0 -37
  253. package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +0 -37
  254. package/packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts +0 -35
  255. package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +0 -37
  256. package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +0 -37
  257. package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +0 -37
  258. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +0 -37
  259. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  260. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
  261. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
  262. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
  263. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
  264. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  265. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  266. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  267. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  268. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  269. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  270. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  271. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  272. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  273. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  274. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  275. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  276. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  277. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  278. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  279. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  280. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
  281. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
  282. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
  283. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
  284. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  285. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  286. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  287. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  288. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  289. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  290. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  291. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  292. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  293. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  294. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunks.ts +0 -35
  295. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  296. package/packages/orq-rc/src/mcp-server/tools/knowledgeGetChunksCount.ts +0 -35
  297. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  298. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  299. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunksPaginated.ts +0 -35
  300. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  301. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  302. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  303. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  304. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  305. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  306. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  307. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  308. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +0 -35
  309. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +0 -37
  310. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +0 -37
  311. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +0 -35
  312. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +0 -40
  313. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +0 -40
  314. package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +0 -37
  315. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +0 -37
  316. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +0 -37
  317. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +0 -37
  318. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +0 -37
  319. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +0 -37
  320. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +0 -37
  321. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +0 -37
  322. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +0 -37
  323. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  324. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  325. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  326. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  327. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  328. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  329. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  330. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  331. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  332. package/packages/orq-rc/src/mcp-server/tools/toolsCreate.ts +0 -37
  333. package/packages/orq-rc/src/mcp-server/tools/toolsDelete.ts +0 -35
  334. package/packages/orq-rc/src/mcp-server/tools/toolsDuplicate.ts +0 -37
  335. package/packages/orq-rc/src/mcp-server/tools/toolsList.ts +0 -37
  336. package/packages/orq-rc/src/mcp-server/tools/toolsRetrieve.ts +0 -37
  337. package/packages/orq-rc/src/mcp-server/tools/toolsUpdate.ts +0 -37
  338. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  339. package/packages/orq-rc/src/models/components/deployments.ts +0 -8147
  340. package/packages/orq-rc/src/models/components/index.ts +0 -6
  341. package/packages/orq-rc/src/models/components/security.ts +0 -71
  342. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  343. package/packages/orq-rc/src/models/errors/createagent.ts +0 -80
  344. package/packages/orq-rc/src/models/errors/createeval.ts +0 -80
  345. package/packages/orq-rc/src/models/errors/deleteagent.ts +0 -80
  346. package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -91
  347. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -80
  348. package/packages/orq-rc/src/models/errors/duplicatetool.ts +0 -91
  349. package/packages/orq-rc/src/models/errors/getagent.ts +0 -80
  350. package/packages/orq-rc/src/models/errors/getagenttask.ts +0 -80
  351. package/packages/orq-rc/src/models/errors/getevals.ts +0 -80
  352. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -80
  353. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -90
  354. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  355. package/packages/orq-rc/src/models/errors/index.ts +0 -29
  356. package/packages/orq-rc/src/models/errors/listagenttasks.ts +0 -80
  357. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  358. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  359. package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -91
  360. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  361. package/packages/orq-rc/src/models/errors/streamagent.ts +0 -80
  362. package/packages/orq-rc/src/models/errors/streamrunagent.ts +0 -80
  363. package/packages/orq-rc/src/models/errors/updateagent.ts +0 -80
  364. package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -83
  365. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -80
  366. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -80
  367. package/packages/orq-rc/src/models/errors/updatetool.ts +0 -91
  368. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -78
  369. package/packages/orq-rc/src/models/operations/createagent.ts +0 -3104
  370. package/packages/orq-rc/src/models/operations/createbudget.ts +0 -745
  371. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -428
  372. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -267
  373. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -302
  374. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -6943
  375. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  376. package/packages/orq-rc/src/models/operations/createeval.ts +0 -9341
  377. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  378. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -1850
  379. package/packages/orq-rc/src/models/operations/creatememory.ts +0 -274
  380. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +0 -287
  381. package/packages/orq-rc/src/models/operations/creatememorystore.ts +0 -2032
  382. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -7812
  383. package/packages/orq-rc/src/models/operations/createtool.ts +0 -4077
  384. package/packages/orq-rc/src/models/operations/deleteagent.ts +0 -78
  385. package/packages/orq-rc/src/models/operations/deletebudget.ts +0 -69
  386. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  387. package/packages/orq-rc/src/models/operations/deletechunks.ts +0 -243
  388. package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -69
  389. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -87
  390. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -78
  391. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  392. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -66
  393. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  394. package/packages/orq-rc/src/models/operations/deletememory.ts +0 -87
  395. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +0 -98
  396. package/packages/orq-rc/src/models/operations/deletememorystore.ts +0 -78
  397. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  398. package/packages/orq-rc/src/models/operations/deletetool.ts +0 -75
  399. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -6547
  400. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -10532
  401. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1266
  402. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2606
  403. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -10655
  404. package/packages/orq-rc/src/models/operations/duplicatetool.ts +0 -2349
  405. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  406. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  407. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  408. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  409. package/packages/orq-rc/src/models/operations/getagent.ts +0 -957
  410. package/packages/orq-rc/src/models/operations/getagenttask.ts +0 -259
  411. package/packages/orq-rc/src/models/operations/getallmemories.ts +0 -318
  412. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +0 -338
  413. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +0 -1277
  414. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2572
  415. package/packages/orq-rc/src/models/operations/getalltools.ts +0 -2308
  416. package/packages/orq-rc/src/models/operations/getbudget.ts +0 -441
  417. package/packages/orq-rc/src/models/operations/getchunkscount.ts +0 -230
  418. package/packages/orq-rc/src/models/operations/getevals.ts +0 -7486
  419. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  420. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -1292
  421. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2437
  422. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2444
  423. package/packages/orq-rc/src/models/operations/index.ts +0 -102
  424. package/packages/orq-rc/src/models/operations/invokeagent.ts +0 -1569
  425. package/packages/orq-rc/src/models/operations/listactions.ts +0 -526
  426. package/packages/orq-rc/src/models/operations/listagents.ts +0 -1077
  427. package/packages/orq-rc/src/models/operations/listagenttasks.ts +0 -1106
  428. package/packages/orq-rc/src/models/operations/listbudgets.ts +0 -617
  429. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  430. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +0 -507
  431. package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -500
  432. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -4086
  433. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  434. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -454
  435. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -1303
  436. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  437. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2580
  438. package/packages/orq-rc/src/models/operations/parse.ts +0 -1295
  439. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  440. package/packages/orq-rc/src/models/operations/retrieveaction.ts +0 -426
  441. package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -210
  442. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -3853
  443. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -291
  444. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  445. package/packages/orq-rc/src/models/operations/retrievememory.ts +0 -201
  446. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +0 -220
  447. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +0 -1160
  448. package/packages/orq-rc/src/models/operations/retrievetool.ts +0 -2333
  449. package/packages/orq-rc/src/models/operations/runagent.ts +0 -4342
  450. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3573
  451. package/packages/orq-rc/src/models/operations/streamagent.ts +0 -1367
  452. package/packages/orq-rc/src/models/operations/streamrunagent.ts +0 -4355
  453. package/packages/orq-rc/src/models/operations/updateagent.ts +0 -3321
  454. package/packages/orq-rc/src/models/operations/updatebudget.ts +0 -628
  455. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  456. package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -325
  457. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -6934
  458. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -386
  459. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  460. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -9704
  461. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -2341
  462. package/packages/orq-rc/src/models/operations/updatememory.ts +0 -283
  463. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +0 -296
  464. package/packages/orq-rc/src/models/operations/updatememorystore.ts +0 -1363
  465. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -8176
  466. package/packages/orq-rc/src/models/operations/updatetool.ts +0 -4288
  467. package/packages/orq-rc/src/sdk/agents.ts +0 -238
  468. package/packages/orq-rc/src/sdk/budgets.ts +0 -99
  469. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  470. package/packages/orq-rc/src/sdk/contacts.ts +0 -99
  471. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  472. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  473. package/packages/orq-rc/src/sdk/evals.ts +0 -69
  474. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  475. package/packages/orq-rc/src/sdk/files.ts +0 -78
  476. package/packages/orq-rc/src/sdk/index.ts +0 -5
  477. package/packages/orq-rc/src/sdk/knowledge.ts +0 -309
  478. package/packages/orq-rc/src/sdk/memorystores.ts +0 -286
  479. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  480. package/packages/orq-rc/src/sdk/models.ts +0 -25
  481. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  482. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  483. package/packages/orq-rc/src/sdk/sdk.ts +0 -97
  484. package/packages/orq-rc/src/sdk/tools.ts +0 -117
  485. package/packages/orq-rc/src/types/async.ts +0 -68
  486. package/packages/orq-rc/src/types/blobs.ts +0 -32
  487. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  488. package/packages/orq-rc/src/types/enums.ts +0 -16
  489. package/packages/orq-rc/src/types/fp.ts +0 -50
  490. package/packages/orq-rc/src/types/index.ts +0 -11
  491. package/packages/orq-rc/src/types/operations.ts +0 -105
  492. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  493. package/packages/orq-rc/src/types/streams.ts +0 -21
  494. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,1172 +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
- <!-- UsageSnippet language="typescript" operationID="GetAllMemoryStores" method="get" path="/v2/memory-stores" -->
31
- ```typescript
32
- import { Orq } from "@orq-ai/node";
33
-
34
- const orq = new Orq({
35
- apiKey: process.env["ORQ_API_KEY"] ?? "",
36
- });
37
-
38
- async function run() {
39
- const result = await orq.memoryStores.list({});
40
-
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
- if (res.ok) {
64
- const { value: result } = res;
65
- console.log(result);
66
- } else {
67
- console.log("memoryStoresList failed:", res.error);
68
- }
69
- }
70
-
71
- run();
72
- ```
73
-
74
- ### Parameters
75
-
76
- | Parameter | Type | Required | Description |
77
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
78
- | `request` | [operations.GetAllMemoryStoresRequest](../../models/operations/getallmemorystoresrequest.md) | :heavy_check_mark: | The request object to use for the request. |
79
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
80
- | `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. |
81
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
82
-
83
- ### Response
84
-
85
- **Promise\<[operations.GetAllMemoryStoresResponseBody](../../models/operations/getallmemorystoresresponsebody.md)\>**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | ------------------- | ------------------- | ------------------- |
91
- | errors.HonoApiError | 401 | application/json |
92
- | errors.APIError | 4XX, 5XX | \*/\* |
93
-
94
- ## create
95
-
96
- Create memory store
97
-
98
- ### Example Usage
99
-
100
- <!-- UsageSnippet language="typescript" operationID="CreateMemoryStore" method="post" path="/v2/memory-stores" -->
101
- ```typescript
102
- import { Orq } from "@orq-ai/node";
103
-
104
- const orq = new Orq({
105
- apiKey: process.env["ORQ_API_KEY"] ?? "",
106
- });
107
-
108
- async function run() {
109
- const result = await orq.memoryStores.create({
110
- key: "<key>",
111
- embeddingConfig: {
112
- model: "cohere/embed-multilingual-light-v3.0",
113
- },
114
- description: "unlike excluding soulful quirkily hmph baseboard whereas gee deserted",
115
- path: "Default",
116
- });
117
-
118
- console.log(result);
119
- }
120
-
121
- run();
122
- ```
123
-
124
- ### Standalone function
125
-
126
- The standalone function version of this method:
127
-
128
- ```typescript
129
- import { OrqCore } from "@orq-ai/node/core.js";
130
- import { memoryStoresCreate } from "@orq-ai/node/funcs/memoryStoresCreate.js";
131
-
132
- // Use `OrqCore` for best tree-shaking performance.
133
- // You can create one instance of it to use across an application.
134
- const orq = new OrqCore({
135
- apiKey: process.env["ORQ_API_KEY"] ?? "",
136
- });
137
-
138
- async function run() {
139
- const res = await memoryStoresCreate(orq, {
140
- key: "<key>",
141
- embeddingConfig: {
142
- model: "cohere/embed-multilingual-light-v3.0",
143
- },
144
- description: "unlike excluding soulful quirkily hmph baseboard whereas gee deserted",
145
- path: "Default",
146
- });
147
- if (res.ok) {
148
- const { value: result } = res;
149
- console.log(result);
150
- } else {
151
- console.log("memoryStoresCreate failed:", res.error);
152
- }
153
- }
154
-
155
- run();
156
- ```
157
-
158
- ### Parameters
159
-
160
- | Parameter | Type | Required | Description |
161
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
162
- | `request` | [operations.CreateMemoryStoreRequestBody](../../models/operations/creatememorystorerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
163
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
164
- | `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. |
165
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
166
-
167
- ### Response
168
-
169
- **Promise\<[operations.CreateMemoryStoreResponseBody](../../models/operations/creatememorystoreresponsebody.md)\>**
170
-
171
- ### Errors
172
-
173
- | Error Type | Status Code | Content Type |
174
- | ------------------- | ------------------- | ------------------- |
175
- | errors.HonoApiError | 400 | application/json |
176
- | errors.APIError | 4XX, 5XX | \*/\* |
177
-
178
- ## retrieve
179
-
180
- Retrieves detailed information about a specific memory store, including its configuration and metadata.
181
-
182
- ### Example Usage
183
-
184
- <!-- UsageSnippet language="typescript" operationID="RetrieveMemoryStore" method="get" path="/v2/memory-stores/{memory_store_key}" -->
185
- ```typescript
186
- import { Orq } from "@orq-ai/node";
187
-
188
- const orq = new Orq({
189
- apiKey: process.env["ORQ_API_KEY"] ?? "",
190
- });
191
-
192
- async function run() {
193
- const result = await orq.memoryStores.retrieve({
194
- memoryStoreKey: "<value>",
195
- });
196
-
197
- console.log(result);
198
- }
199
-
200
- run();
201
- ```
202
-
203
- ### Standalone function
204
-
205
- The standalone function version of this method:
206
-
207
- ```typescript
208
- import { OrqCore } from "@orq-ai/node/core.js";
209
- import { memoryStoresRetrieve } from "@orq-ai/node/funcs/memoryStoresRetrieve.js";
210
-
211
- // Use `OrqCore` for best tree-shaking performance.
212
- // You can create one instance of it to use across an application.
213
- const orq = new OrqCore({
214
- apiKey: process.env["ORQ_API_KEY"] ?? "",
215
- });
216
-
217
- async function run() {
218
- const res = await memoryStoresRetrieve(orq, {
219
- memoryStoreKey: "<value>",
220
- });
221
- if (res.ok) {
222
- const { value: result } = res;
223
- console.log(result);
224
- } else {
225
- console.log("memoryStoresRetrieve failed:", res.error);
226
- }
227
- }
228
-
229
- run();
230
- ```
231
-
232
- ### Parameters
233
-
234
- | Parameter | Type | Required | Description |
235
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
236
- | `request` | [operations.RetrieveMemoryStoreRequest](../../models/operations/retrievememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
237
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
238
- | `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. |
239
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
240
-
241
- ### Response
242
-
243
- **Promise\<[operations.RetrieveMemoryStoreResponseBody](../../models/operations/retrievememorystoreresponsebody.md)\>**
244
-
245
- ### Errors
246
-
247
- | Error Type | Status Code | Content Type |
248
- | ------------------- | ------------------- | ------------------- |
249
- | errors.HonoApiError | 401, 403, 404 | application/json |
250
- | errors.APIError | 4XX, 5XX | \*/\* |
251
-
252
- ## update
253
-
254
- Update the memory store configuration
255
-
256
- ### Example Usage
257
-
258
- <!-- UsageSnippet language="typescript" operationID="UpdateMemoryStore" method="patch" path="/v2/memory-stores/{memory_store_key}" -->
259
- ```typescript
260
- import { Orq } from "@orq-ai/node";
261
-
262
- const orq = new Orq({
263
- apiKey: process.env["ORQ_API_KEY"] ?? "",
264
- });
265
-
266
- async function run() {
267
- const result = await orq.memoryStores.update({
268
- memoryStoreKey: "<value>",
269
- requestBody: {
270
- embeddingConfig: {
271
- model: "google/text-multilingual-embedding-002",
272
- },
273
- description: "wherever cash since now exempt proliferate aha tabulate ack",
274
- path: "Default",
275
- },
276
- });
277
-
278
- console.log(result);
279
- }
280
-
281
- run();
282
- ```
283
-
284
- ### Standalone function
285
-
286
- The standalone function version of this method:
287
-
288
- ```typescript
289
- import { OrqCore } from "@orq-ai/node/core.js";
290
- import { memoryStoresUpdate } from "@orq-ai/node/funcs/memoryStoresUpdate.js";
291
-
292
- // Use `OrqCore` for best tree-shaking performance.
293
- // You can create one instance of it to use across an application.
294
- const orq = new OrqCore({
295
- apiKey: process.env["ORQ_API_KEY"] ?? "",
296
- });
297
-
298
- async function run() {
299
- const res = await memoryStoresUpdate(orq, {
300
- memoryStoreKey: "<value>",
301
- requestBody: {
302
- embeddingConfig: {
303
- model: "google/text-multilingual-embedding-002",
304
- },
305
- description: "wherever cash since now exempt proliferate aha tabulate ack",
306
- path: "Default",
307
- },
308
- });
309
- if (res.ok) {
310
- const { value: result } = res;
311
- console.log(result);
312
- } else {
313
- console.log("memoryStoresUpdate failed:", res.error);
314
- }
315
- }
316
-
317
- run();
318
- ```
319
-
320
- ### Parameters
321
-
322
- | Parameter | Type | Required | Description |
323
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
324
- | `request` | [operations.UpdateMemoryStoreRequest](../../models/operations/updatememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
325
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
326
- | `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. |
327
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
328
-
329
- ### Response
330
-
331
- **Promise\<[operations.UpdateMemoryStoreResponseBody](../../models/operations/updatememorystoreresponsebody.md)\>**
332
-
333
- ### Errors
334
-
335
- | Error Type | Status Code | Content Type |
336
- | --------------- | --------------- | --------------- |
337
- | errors.APIError | 4XX, 5XX | \*/\* |
338
-
339
- ## delete
340
-
341
- Permanently delete a memory store, including memories and documents.
342
-
343
- ### Example Usage
344
-
345
- <!-- UsageSnippet language="typescript" operationID="DeleteMemoryStore" method="delete" path="/v2/memory-stores/{memory_store_key}" -->
346
- ```typescript
347
- import { Orq } from "@orq-ai/node";
348
-
349
- const orq = new Orq({
350
- apiKey: process.env["ORQ_API_KEY"] ?? "",
351
- });
352
-
353
- async function run() {
354
- await orq.memoryStores.delete({
355
- memoryStoreKey: "<value>",
356
- });
357
-
358
-
359
- }
360
-
361
- run();
362
- ```
363
-
364
- ### Standalone function
365
-
366
- The standalone function version of this method:
367
-
368
- ```typescript
369
- import { OrqCore } from "@orq-ai/node/core.js";
370
- import { memoryStoresDelete } from "@orq-ai/node/funcs/memoryStoresDelete.js";
371
-
372
- // Use `OrqCore` for best tree-shaking performance.
373
- // You can create one instance of it to use across an application.
374
- const orq = new OrqCore({
375
- apiKey: process.env["ORQ_API_KEY"] ?? "",
376
- });
377
-
378
- async function run() {
379
- const res = await memoryStoresDelete(orq, {
380
- memoryStoreKey: "<value>",
381
- });
382
- if (res.ok) {
383
- const { value: result } = res;
384
-
385
- } else {
386
- console.log("memoryStoresDelete failed:", res.error);
387
- }
388
- }
389
-
390
- run();
391
- ```
392
-
393
- ### Parameters
394
-
395
- | Parameter | Type | Required | Description |
396
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
397
- | `request` | [operations.DeleteMemoryStoreRequest](../../models/operations/deletememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
398
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
399
- | `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. |
400
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
401
-
402
- ### Response
403
-
404
- **Promise\<void\>**
405
-
406
- ### Errors
407
-
408
- | Error Type | Status Code | Content Type |
409
- | --------------- | --------------- | --------------- |
410
- | errors.APIError | 4XX, 5XX | \*/\* |
411
-
412
- ## listMemories
413
-
414
- Retrieves a paginated list of memories for the memory store
415
-
416
- ### Example Usage
417
-
418
- <!-- UsageSnippet language="typescript" operationID="GetAllMemories" method="get" path="/v2/memory-stores/{memory_store_key}/memories" -->
419
- ```typescript
420
- import { Orq } from "@orq-ai/node";
421
-
422
- const orq = new Orq({
423
- apiKey: process.env["ORQ_API_KEY"] ?? "",
424
- });
425
-
426
- async function run() {
427
- const result = await orq.memoryStores.listMemories({
428
- memoryStoreKey: "<value>",
429
- });
430
-
431
- console.log(result);
432
- }
433
-
434
- run();
435
- ```
436
-
437
- ### Standalone function
438
-
439
- The standalone function version of this method:
440
-
441
- ```typescript
442
- import { OrqCore } from "@orq-ai/node/core.js";
443
- import { memoryStoresListMemories } from "@orq-ai/node/funcs/memoryStoresListMemories.js";
444
-
445
- // Use `OrqCore` for best tree-shaking performance.
446
- // You can create one instance of it to use across an application.
447
- const orq = new OrqCore({
448
- apiKey: process.env["ORQ_API_KEY"] ?? "",
449
- });
450
-
451
- async function run() {
452
- const res = await memoryStoresListMemories(orq, {
453
- memoryStoreKey: "<value>",
454
- });
455
- if (res.ok) {
456
- const { value: result } = res;
457
- console.log(result);
458
- } else {
459
- console.log("memoryStoresListMemories failed:", res.error);
460
- }
461
- }
462
-
463
- run();
464
- ```
465
-
466
- ### Parameters
467
-
468
- | Parameter | Type | Required | Description |
469
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
470
- | `request` | [operations.GetAllMemoriesRequest](../../models/operations/getallmemoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
471
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
472
- | `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. |
473
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
474
-
475
- ### Response
476
-
477
- **Promise\<[operations.GetAllMemoriesResponseBody](../../models/operations/getallmemoriesresponsebody.md)\>**
478
-
479
- ### Errors
480
-
481
- | Error Type | Status Code | Content Type |
482
- | --------------- | --------------- | --------------- |
483
- | errors.APIError | 4XX, 5XX | \*/\* |
484
-
485
- ## createMemory
486
-
487
- Creates a new memory in the specified memory store.
488
-
489
- ### Example Usage
490
-
491
- <!-- UsageSnippet language="typescript" operationID="CreateMemory" method="post" path="/v2/memory-stores/{memory_store_key}/memories" -->
492
- ```typescript
493
- import { Orq } from "@orq-ai/node";
494
-
495
- const orq = new Orq({
496
- apiKey: process.env["ORQ_API_KEY"] ?? "",
497
- });
498
-
499
- async function run() {
500
- const result = await orq.memoryStores.createMemory({
501
- memoryStoreKey: "<value>",
502
- });
503
-
504
- console.log(result);
505
- }
506
-
507
- run();
508
- ```
509
-
510
- ### Standalone function
511
-
512
- The standalone function version of this method:
513
-
514
- ```typescript
515
- import { OrqCore } from "@orq-ai/node/core.js";
516
- import { memoryStoresCreateMemory } from "@orq-ai/node/funcs/memoryStoresCreateMemory.js";
517
-
518
- // Use `OrqCore` for best tree-shaking performance.
519
- // You can create one instance of it to use across an application.
520
- const orq = new OrqCore({
521
- apiKey: process.env["ORQ_API_KEY"] ?? "",
522
- });
523
-
524
- async function run() {
525
- const res = await memoryStoresCreateMemory(orq, {
526
- memoryStoreKey: "<value>",
527
- });
528
- if (res.ok) {
529
- const { value: result } = res;
530
- console.log(result);
531
- } else {
532
- console.log("memoryStoresCreateMemory failed:", res.error);
533
- }
534
- }
535
-
536
- run();
537
- ```
538
-
539
- ### Parameters
540
-
541
- | Parameter | Type | Required | Description |
542
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
543
- | `request` | [operations.CreateMemoryRequest](../../models/operations/creatememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
544
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
545
- | `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. |
546
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
547
-
548
- ### Response
549
-
550
- **Promise\<[operations.CreateMemoryResponseBody](../../models/operations/creatememoryresponsebody.md)\>**
551
-
552
- ### Errors
553
-
554
- | Error Type | Status Code | Content Type |
555
- | --------------- | --------------- | --------------- |
556
- | errors.APIError | 4XX, 5XX | \*/\* |
557
-
558
- ## retrieveMemory
559
-
560
- Retrieves details of a specific memory by its ID
561
-
562
- ### Example Usage
563
-
564
- <!-- UsageSnippet language="typescript" operationID="RetrieveMemory" method="get" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}" -->
565
- ```typescript
566
- import { Orq } from "@orq-ai/node";
567
-
568
- const orq = new Orq({
569
- apiKey: process.env["ORQ_API_KEY"] ?? "",
570
- });
571
-
572
- async function run() {
573
- const result = await orq.memoryStores.retrieveMemory({
574
- memoryStoreKey: "<value>",
575
- memoryId: "<id>",
576
- });
577
-
578
- console.log(result);
579
- }
580
-
581
- run();
582
- ```
583
-
584
- ### Standalone function
585
-
586
- The standalone function version of this method:
587
-
588
- ```typescript
589
- import { OrqCore } from "@orq-ai/node/core.js";
590
- import { memoryStoresRetrieveMemory } from "@orq-ai/node/funcs/memoryStoresRetrieveMemory.js";
591
-
592
- // Use `OrqCore` for best tree-shaking performance.
593
- // You can create one instance of it to use across an application.
594
- const orq = new OrqCore({
595
- apiKey: process.env["ORQ_API_KEY"] ?? "",
596
- });
597
-
598
- async function run() {
599
- const res = await memoryStoresRetrieveMemory(orq, {
600
- memoryStoreKey: "<value>",
601
- memoryId: "<id>",
602
- });
603
- if (res.ok) {
604
- const { value: result } = res;
605
- console.log(result);
606
- } else {
607
- console.log("memoryStoresRetrieveMemory failed:", res.error);
608
- }
609
- }
610
-
611
- run();
612
- ```
613
-
614
- ### Parameters
615
-
616
- | Parameter | Type | Required | Description |
617
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
618
- | `request` | [operations.RetrieveMemoryRequest](../../models/operations/retrievememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
619
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
620
- | `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. |
621
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
622
-
623
- ### Response
624
-
625
- **Promise\<[operations.RetrieveMemoryResponseBody](../../models/operations/retrievememoryresponsebody.md)\>**
626
-
627
- ### Errors
628
-
629
- | Error Type | Status Code | Content Type |
630
- | --------------- | --------------- | --------------- |
631
- | errors.APIError | 4XX, 5XX | \*/\* |
632
-
633
- ## updateMemory
634
-
635
- Updates the details of a specific memory.
636
-
637
- ### Example Usage
638
-
639
- <!-- UsageSnippet language="typescript" operationID="UpdateMemory" method="patch" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}" -->
640
- ```typescript
641
- import { Orq } from "@orq-ai/node";
642
-
643
- const orq = new Orq({
644
- apiKey: process.env["ORQ_API_KEY"] ?? "",
645
- });
646
-
647
- async function run() {
648
- const result = await orq.memoryStores.updateMemory({
649
- memoryStoreKey: "<value>",
650
- memoryId: "<id>",
651
- });
652
-
653
- console.log(result);
654
- }
655
-
656
- run();
657
- ```
658
-
659
- ### Standalone function
660
-
661
- The standalone function version of this method:
662
-
663
- ```typescript
664
- import { OrqCore } from "@orq-ai/node/core.js";
665
- import { memoryStoresUpdateMemory } from "@orq-ai/node/funcs/memoryStoresUpdateMemory.js";
666
-
667
- // Use `OrqCore` for best tree-shaking performance.
668
- // You can create one instance of it to use across an application.
669
- const orq = new OrqCore({
670
- apiKey: process.env["ORQ_API_KEY"] ?? "",
671
- });
672
-
673
- async function run() {
674
- const res = await memoryStoresUpdateMemory(orq, {
675
- memoryStoreKey: "<value>",
676
- memoryId: "<id>",
677
- });
678
- if (res.ok) {
679
- const { value: result } = res;
680
- console.log(result);
681
- } else {
682
- console.log("memoryStoresUpdateMemory failed:", res.error);
683
- }
684
- }
685
-
686
- run();
687
- ```
688
-
689
- ### Parameters
690
-
691
- | Parameter | Type | Required | Description |
692
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
693
- | `request` | [operations.UpdateMemoryRequest](../../models/operations/updatememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
694
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
695
- | `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. |
696
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
697
-
698
- ### Response
699
-
700
- **Promise\<[operations.UpdateMemoryResponseBody](../../models/operations/updatememoryresponsebody.md)\>**
701
-
702
- ### Errors
703
-
704
- | Error Type | Status Code | Content Type |
705
- | --------------- | --------------- | --------------- |
706
- | errors.APIError | 4XX, 5XX | \*/\* |
707
-
708
- ## deleteMemory
709
-
710
- Permanently deletes a specific memory.
711
-
712
- Use this endpoint to:
713
- - Remove a memory from the store
714
- - Clean up unused memories
715
- - Manage memory storage space
716
-
717
- ### Example Usage
718
-
719
- <!-- UsageSnippet language="typescript" operationID="DeleteMemory" method="delete" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}" -->
720
- ```typescript
721
- import { Orq } from "@orq-ai/node";
722
-
723
- const orq = new Orq({
724
- apiKey: process.env["ORQ_API_KEY"] ?? "",
725
- });
726
-
727
- async function run() {
728
- await orq.memoryStores.deleteMemory({
729
- memoryStoreKey: "<value>",
730
- memoryId: "<id>",
731
- });
732
-
733
-
734
- }
735
-
736
- run();
737
- ```
738
-
739
- ### Standalone function
740
-
741
- The standalone function version of this method:
742
-
743
- ```typescript
744
- import { OrqCore } from "@orq-ai/node/core.js";
745
- import { memoryStoresDeleteMemory } from "@orq-ai/node/funcs/memoryStoresDeleteMemory.js";
746
-
747
- // Use `OrqCore` for best tree-shaking performance.
748
- // You can create one instance of it to use across an application.
749
- const orq = new OrqCore({
750
- apiKey: process.env["ORQ_API_KEY"] ?? "",
751
- });
752
-
753
- async function run() {
754
- const res = await memoryStoresDeleteMemory(orq, {
755
- memoryStoreKey: "<value>",
756
- memoryId: "<id>",
757
- });
758
- if (res.ok) {
759
- const { value: result } = res;
760
-
761
- } else {
762
- console.log("memoryStoresDeleteMemory failed:", res.error);
763
- }
764
- }
765
-
766
- run();
767
- ```
768
-
769
- ### Parameters
770
-
771
- | Parameter | Type | Required | Description |
772
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
773
- | `request` | [operations.DeleteMemoryRequest](../../models/operations/deletememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
774
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
775
- | `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. |
776
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
777
-
778
- ### Response
779
-
780
- **Promise\<void\>**
781
-
782
- ### Errors
783
-
784
- | Error Type | Status Code | Content Type |
785
- | --------------- | --------------- | --------------- |
786
- | errors.APIError | 4XX, 5XX | \*/\* |
787
-
788
- ## listDocuments
789
-
790
- Retrieves a paginated list of documents associated with a specific memory.
791
-
792
- ### Example Usage
793
-
794
- <!-- UsageSnippet language="typescript" operationID="GetAllMemoryDocuments" method="get" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents" -->
795
- ```typescript
796
- import { Orq } from "@orq-ai/node";
797
-
798
- const orq = new Orq({
799
- apiKey: process.env["ORQ_API_KEY"] ?? "",
800
- });
801
-
802
- async function run() {
803
- const result = await orq.memoryStores.listDocuments({
804
- memoryStoreKey: "<value>",
805
- memoryId: "<id>",
806
- });
807
-
808
- console.log(result);
809
- }
810
-
811
- run();
812
- ```
813
-
814
- ### Standalone function
815
-
816
- The standalone function version of this method:
817
-
818
- ```typescript
819
- import { OrqCore } from "@orq-ai/node/core.js";
820
- import { memoryStoresListDocuments } from "@orq-ai/node/funcs/memoryStoresListDocuments.js";
821
-
822
- // Use `OrqCore` for best tree-shaking performance.
823
- // You can create one instance of it to use across an application.
824
- const orq = new OrqCore({
825
- apiKey: process.env["ORQ_API_KEY"] ?? "",
826
- });
827
-
828
- async function run() {
829
- const res = await memoryStoresListDocuments(orq, {
830
- memoryStoreKey: "<value>",
831
- memoryId: "<id>",
832
- });
833
- if (res.ok) {
834
- const { value: result } = res;
835
- console.log(result);
836
- } else {
837
- console.log("memoryStoresListDocuments failed:", res.error);
838
- }
839
- }
840
-
841
- run();
842
- ```
843
-
844
- ### Parameters
845
-
846
- | Parameter | Type | Required | Description |
847
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
848
- | `request` | [operations.GetAllMemoryDocumentsRequest](../../models/operations/getallmemorydocumentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
849
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
850
- | `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. |
851
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
852
-
853
- ### Response
854
-
855
- **Promise\<[operations.GetAllMemoryDocumentsResponseBody](../../models/operations/getallmemorydocumentsresponsebody.md)\>**
856
-
857
- ### Errors
858
-
859
- | Error Type | Status Code | Content Type |
860
- | --------------- | --------------- | --------------- |
861
- | errors.APIError | 4XX, 5XX | \*/\* |
862
-
863
- ## createDocument
864
-
865
- Creates a new document in the specified memory.
866
-
867
- ### Example Usage
868
-
869
- <!-- UsageSnippet language="typescript" operationID="CreateMemoryDocument" method="post" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents" -->
870
- ```typescript
871
- import { Orq } from "@orq-ai/node";
872
-
873
- const orq = new Orq({
874
- apiKey: process.env["ORQ_API_KEY"] ?? "",
875
- });
876
-
877
- async function run() {
878
- const result = await orq.memoryStores.createDocument({
879
- memoryStoreKey: "<value>",
880
- memoryId: "<id>",
881
- });
882
-
883
- console.log(result);
884
- }
885
-
886
- run();
887
- ```
888
-
889
- ### Standalone function
890
-
891
- The standalone function version of this method:
892
-
893
- ```typescript
894
- import { OrqCore } from "@orq-ai/node/core.js";
895
- import { memoryStoresCreateDocument } from "@orq-ai/node/funcs/memoryStoresCreateDocument.js";
896
-
897
- // Use `OrqCore` for best tree-shaking performance.
898
- // You can create one instance of it to use across an application.
899
- const orq = new OrqCore({
900
- apiKey: process.env["ORQ_API_KEY"] ?? "",
901
- });
902
-
903
- async function run() {
904
- const res = await memoryStoresCreateDocument(orq, {
905
- memoryStoreKey: "<value>",
906
- memoryId: "<id>",
907
- });
908
- if (res.ok) {
909
- const { value: result } = res;
910
- console.log(result);
911
- } else {
912
- console.log("memoryStoresCreateDocument failed:", res.error);
913
- }
914
- }
915
-
916
- run();
917
- ```
918
-
919
- ### Parameters
920
-
921
- | Parameter | Type | Required | Description |
922
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
923
- | `request` | [operations.CreateMemoryDocumentRequest](../../models/operations/creatememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
924
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
925
- | `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. |
926
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
927
-
928
- ### Response
929
-
930
- **Promise\<[operations.CreateMemoryDocumentResponseBody](../../models/operations/creatememorydocumentresponsebody.md)\>**
931
-
932
- ### Errors
933
-
934
- | Error Type | Status Code | Content Type |
935
- | --------------- | --------------- | --------------- |
936
- | errors.APIError | 4XX, 5XX | \*/\* |
937
-
938
- ## retrieveDocument
939
-
940
- Retrieves details of a specific memory document by its ID.
941
-
942
- ### Example Usage
943
-
944
- <!-- UsageSnippet language="typescript" operationID="RetrieveMemoryDocument" method="get" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents/{document_id}" -->
945
- ```typescript
946
- import { Orq } from "@orq-ai/node";
947
-
948
- const orq = new Orq({
949
- apiKey: process.env["ORQ_API_KEY"] ?? "",
950
- });
951
-
952
- async function run() {
953
- const result = await orq.memoryStores.retrieveDocument({
954
- memoryStoreKey: "<value>",
955
- memoryId: "<id>",
956
- documentId: "<id>",
957
- });
958
-
959
- console.log(result);
960
- }
961
-
962
- run();
963
- ```
964
-
965
- ### Standalone function
966
-
967
- The standalone function version of this method:
968
-
969
- ```typescript
970
- import { OrqCore } from "@orq-ai/node/core.js";
971
- import { memoryStoresRetrieveDocument } from "@orq-ai/node/funcs/memoryStoresRetrieveDocument.js";
972
-
973
- // Use `OrqCore` for best tree-shaking performance.
974
- // You can create one instance of it to use across an application.
975
- const orq = new OrqCore({
976
- apiKey: process.env["ORQ_API_KEY"] ?? "",
977
- });
978
-
979
- async function run() {
980
- const res = await memoryStoresRetrieveDocument(orq, {
981
- memoryStoreKey: "<value>",
982
- memoryId: "<id>",
983
- documentId: "<id>",
984
- });
985
- if (res.ok) {
986
- const { value: result } = res;
987
- console.log(result);
988
- } else {
989
- console.log("memoryStoresRetrieveDocument failed:", res.error);
990
- }
991
- }
992
-
993
- run();
994
- ```
995
-
996
- ### Parameters
997
-
998
- | Parameter | Type | Required | Description |
999
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1000
- | `request` | [operations.RetrieveMemoryDocumentRequest](../../models/operations/retrievememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1001
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1002
- | `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. |
1003
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1004
-
1005
- ### Response
1006
-
1007
- **Promise\<[operations.RetrieveMemoryDocumentResponseBody](../../models/operations/retrievememorydocumentresponsebody.md)\>**
1008
-
1009
- ### Errors
1010
-
1011
- | Error Type | Status Code | Content Type |
1012
- | --------------- | --------------- | --------------- |
1013
- | errors.APIError | 4XX, 5XX | \*/\* |
1014
-
1015
- ## updateDocument
1016
-
1017
- Updates the details of a specific memory document.
1018
-
1019
- ### Example Usage
1020
-
1021
- <!-- UsageSnippet language="typescript" operationID="UpdateMemoryDocument" method="patch" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents/{document_id}" -->
1022
- ```typescript
1023
- import { Orq } from "@orq-ai/node";
1024
-
1025
- const orq = new Orq({
1026
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1027
- });
1028
-
1029
- async function run() {
1030
- const result = await orq.memoryStores.updateDocument({
1031
- memoryStoreKey: "<value>",
1032
- memoryId: "<id>",
1033
- documentId: "<id>",
1034
- });
1035
-
1036
- console.log(result);
1037
- }
1038
-
1039
- run();
1040
- ```
1041
-
1042
- ### Standalone function
1043
-
1044
- The standalone function version of this method:
1045
-
1046
- ```typescript
1047
- import { OrqCore } from "@orq-ai/node/core.js";
1048
- import { memoryStoresUpdateDocument } from "@orq-ai/node/funcs/memoryStoresUpdateDocument.js";
1049
-
1050
- // Use `OrqCore` for best tree-shaking performance.
1051
- // You can create one instance of it to use across an application.
1052
- const orq = new OrqCore({
1053
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1054
- });
1055
-
1056
- async function run() {
1057
- const res = await memoryStoresUpdateDocument(orq, {
1058
- memoryStoreKey: "<value>",
1059
- memoryId: "<id>",
1060
- documentId: "<id>",
1061
- });
1062
- if (res.ok) {
1063
- const { value: result } = res;
1064
- console.log(result);
1065
- } else {
1066
- console.log("memoryStoresUpdateDocument failed:", res.error);
1067
- }
1068
- }
1069
-
1070
- run();
1071
- ```
1072
-
1073
- ### Parameters
1074
-
1075
- | Parameter | Type | Required | Description |
1076
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1077
- | `request` | [operations.UpdateMemoryDocumentRequest](../../models/operations/updatememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1078
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1079
- | `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. |
1080
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1081
-
1082
- ### Response
1083
-
1084
- **Promise\<[operations.UpdateMemoryDocumentResponseBody](../../models/operations/updatememorydocumentresponsebody.md)\>**
1085
-
1086
- ### Errors
1087
-
1088
- | Error Type | Status Code | Content Type |
1089
- | --------------- | --------------- | --------------- |
1090
- | errors.APIError | 4XX, 5XX | \*/\* |
1091
-
1092
- ## deleteDocument
1093
-
1094
- Permanently deletes a specific memory document.
1095
-
1096
- Use this endpoint to:
1097
- - Remove a document from a memory
1098
- - Clean up unused documents
1099
- - Manage document storage space
1100
-
1101
- ### Example Usage
1102
-
1103
- <!-- UsageSnippet language="typescript" operationID="DeleteMemoryDocument" method="delete" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents/{document_id}" -->
1104
- ```typescript
1105
- import { Orq } from "@orq-ai/node";
1106
-
1107
- const orq = new Orq({
1108
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1109
- });
1110
-
1111
- async function run() {
1112
- await orq.memoryStores.deleteDocument({
1113
- memoryStoreKey: "<value>",
1114
- memoryId: "<id>",
1115
- documentId: "<id>",
1116
- });
1117
-
1118
-
1119
- }
1120
-
1121
- run();
1122
- ```
1123
-
1124
- ### Standalone function
1125
-
1126
- The standalone function version of this method:
1127
-
1128
- ```typescript
1129
- import { OrqCore } from "@orq-ai/node/core.js";
1130
- import { memoryStoresDeleteDocument } from "@orq-ai/node/funcs/memoryStoresDeleteDocument.js";
1131
-
1132
- // Use `OrqCore` for best tree-shaking performance.
1133
- // You can create one instance of it to use across an application.
1134
- const orq = new OrqCore({
1135
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1136
- });
1137
-
1138
- async function run() {
1139
- const res = await memoryStoresDeleteDocument(orq, {
1140
- memoryStoreKey: "<value>",
1141
- memoryId: "<id>",
1142
- documentId: "<id>",
1143
- });
1144
- if (res.ok) {
1145
- const { value: result } = res;
1146
-
1147
- } else {
1148
- console.log("memoryStoresDeleteDocument failed:", res.error);
1149
- }
1150
- }
1151
-
1152
- run();
1153
- ```
1154
-
1155
- ### Parameters
1156
-
1157
- | Parameter | Type | Required | Description |
1158
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1159
- | `request` | [operations.DeleteMemoryDocumentRequest](../../models/operations/deletememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1160
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1161
- | `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. |
1162
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1163
-
1164
- ### Response
1165
-
1166
- **Promise\<void\>**
1167
-
1168
- ### Errors
1169
-
1170
- | Error Type | Status Code | Content Type |
1171
- | --------------- | --------------- | --------------- |
1172
- | errors.APIError | 4XX, 5XX | \*/\* |