@orq-ai/node 3.12.4 → 3.12.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 (205) hide show
  1. package/README.md +0 -1
  2. package/bin/mcp-server.js +112 -112
  3. package/bin/mcp-server.js.map +33 -33
  4. package/docs/sdks/deployments/README.md +0 -2
  5. package/examples/package-lock.json +1 -1
  6. package/funcs/deploymentsStream.js +5 -2
  7. package/funcs/deploymentsStream.js.map +1 -1
  8. package/jsr.json +1 -1
  9. package/lib/config.d.ts +3 -3
  10. package/lib/config.js +3 -3
  11. package/lib/event-streams.d.ts +3 -3
  12. package/lib/event-streams.d.ts.map +1 -1
  13. package/lib/event-streams.js.map +1 -1
  14. package/mcp-server/mcp-server.js +1 -1
  15. package/mcp-server/server.js +1 -1
  16. package/models/operations/createbudget.js +2 -2
  17. package/models/operations/createcontact.js +2 -2
  18. package/models/operations/createdataset.js +2 -2
  19. package/models/operations/createdatasetitem.js +2 -2
  20. package/models/operations/createdatasource.js +2 -2
  21. package/models/operations/createeval.js +16 -16
  22. package/models/operations/fileget.js +2 -2
  23. package/models/operations/filelist.js +2 -2
  24. package/models/operations/fileupload.js +2 -2
  25. package/models/operations/getbudget.js +2 -2
  26. package/models/operations/getevals.js +28 -28
  27. package/models/operations/listbudgets.js +2 -2
  28. package/models/operations/listcontacts.js +2 -2
  29. package/models/operations/listdatasetdatapoints.js +2 -2
  30. package/models/operations/listdatasets.js +2 -2
  31. package/models/operations/listdatasources.js +2 -2
  32. package/models/operations/retrievecontact.js +2 -2
  33. package/models/operations/retrievedatapoint.js +2 -2
  34. package/models/operations/retrievedataset.js +2 -2
  35. package/models/operations/retrievedatasource.js +2 -2
  36. package/models/operations/updatebudget.js +2 -2
  37. package/models/operations/updatecontact.js +2 -2
  38. package/models/operations/updatedatapoint.js +2 -2
  39. package/models/operations/updatedataset.js +2 -2
  40. package/models/operations/updatedatasource.js +2 -2
  41. package/models/operations/updateeval.js +16 -16
  42. package/package.json +1 -1
  43. package/packages/orq-rc/FUNCTIONS.md +9 -19
  44. package/packages/orq-rc/README.md +180 -181
  45. package/packages/orq-rc/docs/sdks/agents/README.md +702 -0
  46. package/packages/orq-rc/docs/sdks/budgets/README.md +5 -5
  47. package/packages/orq-rc/docs/sdks/memorystores/README.md +1172 -0
  48. package/packages/orq-rc/docs/sdks/orq/README.md +81 -0
  49. package/packages/orq-rc/examples/package-lock.json +1 -1
  50. package/packages/orq-rc/examples/postV2AgentsInternal.example.ts +30 -0
  51. package/packages/orq-rc/jsr.json +1 -1
  52. package/packages/orq-rc/package-lock.json +2 -2
  53. package/packages/orq-rc/package.json +1 -1
  54. package/packages/orq-rc/src/funcs/agentsList.ts +167 -0
  55. package/packages/orq-rc/src/funcs/agentsListActions.ts +169 -0
  56. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +175 -0
  57. package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +173 -0
  58. package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +179 -0
  59. package/packages/orq-rc/src/funcs/agentsReviewAction.ts +177 -0
  60. package/packages/orq-rc/src/funcs/agentsRun.ts +163 -0
  61. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +187 -0
  62. package/packages/orq-rc/src/funcs/budgetsCreate.ts +1 -1
  63. package/packages/orq-rc/src/funcs/budgetsGet.ts +2 -2
  64. package/packages/orq-rc/src/funcs/budgetsList.ts +2 -2
  65. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +171 -0
  66. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +175 -0
  67. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +170 -0
  68. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +168 -0
  69. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +184 -0
  70. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +179 -0
  71. package/packages/orq-rc/src/funcs/memoryStoresList.ts +178 -0
  72. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +181 -0
  73. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +176 -0
  74. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +177 -0
  75. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +178 -0
  76. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +173 -0
  77. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +168 -0
  78. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +179 -0
  79. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +174 -0
  80. package/packages/orq-rc/src/funcs/postV2AgentsInternal.ts +159 -0
  81. package/packages/orq-rc/src/lib/config.ts +3 -3
  82. package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
  83. package/packages/orq-rc/src/mcp-server/server.ts +49 -1
  84. package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +37 -0
  85. package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +35 -0
  86. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +37 -0
  87. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +35 -0
  88. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +37 -0
  89. package/packages/orq-rc/src/mcp-server/tools/agentsReviewAction.ts +37 -0
  90. package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +37 -0
  91. package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +37 -0
  92. package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +1 -1
  93. package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +2 -2
  94. package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +2 -2
  95. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +35 -0
  96. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +37 -0
  97. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +37 -0
  98. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +35 -0
  99. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +40 -0
  100. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +40 -0
  101. package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +37 -0
  102. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +37 -0
  103. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +37 -0
  104. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +37 -0
  105. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +37 -0
  106. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +37 -0
  107. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +37 -0
  108. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +37 -0
  109. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +37 -0
  110. package/packages/orq-rc/src/mcp-server/tools/postV2AgentsInternal.ts +33 -0
  111. package/packages/orq-rc/src/models/errors/getagent.ts +80 -0
  112. package/packages/orq-rc/src/models/errors/getagenttask.ts +80 -0
  113. package/packages/orq-rc/src/models/errors/index.ts +3 -0
  114. package/packages/orq-rc/src/models/errors/streamrunagent.ts +80 -0
  115. package/packages/orq-rc/src/models/operations/createbudget.ts +57 -58
  116. package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
  117. package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
  118. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
  119. package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
  120. package/packages/orq-rc/src/models/operations/createeval.ts +6383 -1075
  121. package/packages/orq-rc/src/models/operations/creatememory.ts +265 -0
  122. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +284 -0
  123. package/packages/orq-rc/src/models/operations/creatememorystore.ts +1956 -0
  124. package/packages/orq-rc/src/models/operations/deletememory.ts +87 -0
  125. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +98 -0
  126. package/packages/orq-rc/src/models/operations/deletememorystore.ts +78 -0
  127. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +36 -27
  128. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +31 -24
  129. package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
  130. package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
  131. package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
  132. package/packages/orq-rc/src/models/operations/getagent.ts +1171 -0
  133. package/packages/orq-rc/src/models/operations/getagenttask.ts +257 -0
  134. package/packages/orq-rc/src/models/operations/getallmemories.ts +315 -0
  135. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +335 -0
  136. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +1241 -0
  137. package/packages/orq-rc/src/models/operations/getbudget.ts +2 -11
  138. package/packages/orq-rc/src/models/operations/getevals.ts +1362 -1166
  139. package/packages/orq-rc/src/models/operations/index.ts +24 -0
  140. package/packages/orq-rc/src/models/operations/listactions.ts +517 -0
  141. package/packages/orq-rc/src/models/operations/listagents.ts +1335 -0
  142. package/packages/orq-rc/src/models/operations/listbudgets.ts +5 -15
  143. package/packages/orq-rc/src/models/operations/listchunks.ts +21 -21
  144. package/packages/orq-rc/src/models/operations/listcontacts.ts +44 -37
  145. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
  146. package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
  147. package/packages/orq-rc/src/models/operations/listdatasources.ts +29 -22
  148. package/packages/orq-rc/src/models/operations/postv2agentsinternal.ts +103 -0
  149. package/packages/orq-rc/src/models/operations/retrieveaction.ts +419 -0
  150. package/packages/orq-rc/src/models/operations/retrievecontact.ts +2 -2
  151. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
  152. package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
  153. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
  154. package/packages/orq-rc/src/models/operations/retrievememory.ts +198 -0
  155. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +217 -0
  156. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +1124 -0
  157. package/packages/orq-rc/src/models/operations/reviewaction.ts +258 -0
  158. package/packages/orq-rc/src/models/operations/runagent.ts +3428 -0
  159. package/packages/orq-rc/src/models/operations/streamrunagent.ts +3361 -0
  160. package/packages/orq-rc/src/models/operations/updatebudget.ts +2 -11
  161. package/packages/orq-rc/src/models/operations/updatecontact.ts +2 -2
  162. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
  163. package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
  164. package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
  165. package/packages/orq-rc/src/models/operations/updateeval.ts +6627 -1224
  166. package/packages/orq-rc/src/models/operations/updatememory.ts +274 -0
  167. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +293 -0
  168. package/packages/orq-rc/src/models/operations/updatememorystore.ts +1348 -0
  169. package/packages/orq-rc/src/models/operations/updateprompt.ts +64 -19
  170. package/packages/orq-rc/src/sdk/agents.ts +148 -0
  171. package/packages/orq-rc/src/sdk/budgets.ts +5 -5
  172. package/packages/orq-rc/src/sdk/memorystores.ts +286 -0
  173. package/packages/orq-rc/src/sdk/sdk.ts +27 -1
  174. package/src/funcs/deploymentsStream.ts +11 -10
  175. package/src/lib/config.ts +3 -3
  176. package/src/lib/event-streams.ts +6 -8
  177. package/src/mcp-server/mcp-server.ts +1 -1
  178. package/src/mcp-server/server.ts +1 -1
  179. package/src/models/operations/createbudget.ts +2 -2
  180. package/src/models/operations/createcontact.ts +2 -2
  181. package/src/models/operations/createdataset.ts +2 -2
  182. package/src/models/operations/createdatasetitem.ts +2 -2
  183. package/src/models/operations/createdatasource.ts +2 -2
  184. package/src/models/operations/createeval.ts +16 -16
  185. package/src/models/operations/fileget.ts +2 -2
  186. package/src/models/operations/filelist.ts +2 -2
  187. package/src/models/operations/fileupload.ts +2 -2
  188. package/src/models/operations/getbudget.ts +2 -2
  189. package/src/models/operations/getevals.ts +28 -28
  190. package/src/models/operations/listbudgets.ts +2 -2
  191. package/src/models/operations/listcontacts.ts +2 -2
  192. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  193. package/src/models/operations/listdatasets.ts +2 -2
  194. package/src/models/operations/listdatasources.ts +2 -2
  195. package/src/models/operations/retrievecontact.ts +2 -2
  196. package/src/models/operations/retrievedatapoint.ts +2 -2
  197. package/src/models/operations/retrievedataset.ts +2 -2
  198. package/src/models/operations/retrievedatasource.ts +2 -2
  199. package/src/models/operations/updatebudget.ts +2 -2
  200. package/src/models/operations/updatecontact.ts +2 -2
  201. package/src/models/operations/updatedatapoint.ts +2 -2
  202. package/src/models/operations/updatedataset.ts +2 -2
  203. package/src/models/operations/updatedatasource.ts +2 -2
  204. package/src/models/operations/updateeval.ts +16 -16
  205. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
@@ -0,0 +1,1172 @@
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-embedding-005",
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-embedding-005",
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 | \*/\* |