@orq-ai/node 3.3.12 → 3.3.14

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