@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
@@ -74,11 +74,11 @@ export type GetOneChunkResponseBody = {
74
74
  /**
75
75
  * The unique identifier of the user who created the chunk
76
76
  */
77
- createdById?: string | undefined;
77
+ createdById?: string | null | undefined;
78
78
  /**
79
79
  * The unique identifier of the user who updated the chunk
80
80
  */
81
- updateById?: string | undefined;
81
+ updateById?: string | null | undefined;
82
82
  };
83
83
 
84
84
  /** @internal */
@@ -187,8 +187,8 @@ export const GetOneChunkResponseBody$inboundSchema: z.ZodType<
187
187
  status: GetOneChunkStatus$inboundSchema,
188
188
  created: z.string(),
189
189
  updated: z.string(),
190
- created_by_id: z.string().optional(),
191
- update_by_id: z.string().optional(),
190
+ created_by_id: z.nullable(z.string()).optional(),
191
+ update_by_id: z.nullable(z.string()).optional(),
192
192
  }).transform((v) => {
193
193
  return remap$(v, {
194
194
  "_id": "id",
@@ -206,8 +206,8 @@ export type GetOneChunkResponseBody$Outbound = {
206
206
  status: string;
207
207
  created: string;
208
208
  updated: string;
209
- created_by_id?: string | undefined;
210
- update_by_id?: string | undefined;
209
+ created_by_id?: string | null | undefined;
210
+ update_by_id?: string | null | undefined;
211
211
  };
212
212
 
213
213
  /** @internal */
@@ -223,8 +223,8 @@ export const GetOneChunkResponseBody$outboundSchema: z.ZodType<
223
223
  status: GetOneChunkStatus$outboundSchema,
224
224
  created: z.string(),
225
225
  updated: z.string(),
226
- createdById: z.string().optional(),
227
- updateById: z.string().optional(),
226
+ createdById: z.nullable(z.string()).optional(),
227
+ updateById: z.nullable(z.string()).optional(),
228
228
  }).transform((v) => {
229
229
  return remap$(v, {
230
230
  id: "_id",
@@ -45,6 +45,16 @@ export type GetOneKnowledgeRerankConfig = {
45
45
  rerankModel: string;
46
46
  };
47
47
 
48
+ /**
49
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
50
+ */
51
+ export type GetOneKnowledgeAgenticRagConfig = {
52
+ /**
53
+ * The model to use for the Agentic RAG
54
+ */
55
+ model: string;
56
+ };
57
+
48
58
  /**
49
59
  * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
50
60
  */
@@ -64,7 +74,11 @@ export type GetOneKnowledgeRetrievalSettings = {
64
74
  /**
65
75
  * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
66
76
  */
67
- rerankConfig?: GetOneKnowledgeRerankConfig | undefined;
77
+ rerankConfig?: GetOneKnowledgeRerankConfig | null | undefined;
78
+ /**
79
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
80
+ */
81
+ agenticRagConfig?: GetOneKnowledgeAgenticRagConfig | null | undefined;
68
82
  };
69
83
 
70
84
  /**
@@ -196,7 +210,7 @@ export const GetOneKnowledgeRerankConfig$inboundSchema: z.ZodType<
196
210
  z.ZodTypeDef,
197
211
  unknown
198
212
  > = z.object({
199
- rerank_threshold: z.number().default(0.5),
213
+ rerank_threshold: z.number().int().default(0.5),
200
214
  rerank_model: z.string(),
201
215
  }).transform((v) => {
202
216
  return remap$(v, {
@@ -217,7 +231,7 @@ export const GetOneKnowledgeRerankConfig$outboundSchema: z.ZodType<
217
231
  z.ZodTypeDef,
218
232
  GetOneKnowledgeRerankConfig
219
233
  > = z.object({
220
- rerankThreshold: z.number().default(0.5),
234
+ rerankThreshold: z.number().int().default(0.5),
221
235
  rerankModel: z.string(),
222
236
  }).transform((v) => {
223
237
  return remap$(v, {
@@ -259,6 +273,62 @@ export function getOneKnowledgeRerankConfigFromJSON(
259
273
  );
260
274
  }
261
275
 
276
+ /** @internal */
277
+ export const GetOneKnowledgeAgenticRagConfig$inboundSchema: z.ZodType<
278
+ GetOneKnowledgeAgenticRagConfig,
279
+ z.ZodTypeDef,
280
+ unknown
281
+ > = z.object({
282
+ model: z.string(),
283
+ });
284
+
285
+ /** @internal */
286
+ export type GetOneKnowledgeAgenticRagConfig$Outbound = {
287
+ model: string;
288
+ };
289
+
290
+ /** @internal */
291
+ export const GetOneKnowledgeAgenticRagConfig$outboundSchema: z.ZodType<
292
+ GetOneKnowledgeAgenticRagConfig$Outbound,
293
+ z.ZodTypeDef,
294
+ GetOneKnowledgeAgenticRagConfig
295
+ > = z.object({
296
+ model: z.string(),
297
+ });
298
+
299
+ /**
300
+ * @internal
301
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
302
+ */
303
+ export namespace GetOneKnowledgeAgenticRagConfig$ {
304
+ /** @deprecated use `GetOneKnowledgeAgenticRagConfig$inboundSchema` instead. */
305
+ export const inboundSchema = GetOneKnowledgeAgenticRagConfig$inboundSchema;
306
+ /** @deprecated use `GetOneKnowledgeAgenticRagConfig$outboundSchema` instead. */
307
+ export const outboundSchema = GetOneKnowledgeAgenticRagConfig$outboundSchema;
308
+ /** @deprecated use `GetOneKnowledgeAgenticRagConfig$Outbound` instead. */
309
+ export type Outbound = GetOneKnowledgeAgenticRagConfig$Outbound;
310
+ }
311
+
312
+ export function getOneKnowledgeAgenticRagConfigToJSON(
313
+ getOneKnowledgeAgenticRagConfig: GetOneKnowledgeAgenticRagConfig,
314
+ ): string {
315
+ return JSON.stringify(
316
+ GetOneKnowledgeAgenticRagConfig$outboundSchema.parse(
317
+ getOneKnowledgeAgenticRagConfig,
318
+ ),
319
+ );
320
+ }
321
+
322
+ export function getOneKnowledgeAgenticRagConfigFromJSON(
323
+ jsonString: string,
324
+ ): SafeParseResult<GetOneKnowledgeAgenticRagConfig, SDKValidationError> {
325
+ return safeParse(
326
+ jsonString,
327
+ (x) => GetOneKnowledgeAgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
328
+ `Failed to parse 'GetOneKnowledgeAgenticRagConfig' from JSON`,
329
+ );
330
+ }
331
+
262
332
  /** @internal */
263
333
  export const GetOneKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
264
334
  GetOneKnowledgeRetrievalSettings,
@@ -270,13 +340,18 @@ export const GetOneKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
270
340
  ),
271
341
  top_k: z.number().int().default(5),
272
342
  threshold: z.number().default(0),
273
- rerank_config: z.lazy(() => GetOneKnowledgeRerankConfig$inboundSchema)
274
- .optional(),
343
+ rerank_config: z.nullable(
344
+ z.lazy(() => GetOneKnowledgeRerankConfig$inboundSchema),
345
+ ).optional(),
346
+ agentic_rag_config: z.nullable(
347
+ z.lazy(() => GetOneKnowledgeAgenticRagConfig$inboundSchema),
348
+ ).optional(),
275
349
  }).transform((v) => {
276
350
  return remap$(v, {
277
351
  "retrieval_type": "retrievalType",
278
352
  "top_k": "topK",
279
353
  "rerank_config": "rerankConfig",
354
+ "agentic_rag_config": "agenticRagConfig",
280
355
  });
281
356
  });
282
357
 
@@ -285,7 +360,11 @@ export type GetOneKnowledgeRetrievalSettings$Outbound = {
285
360
  retrieval_type: string;
286
361
  top_k: number;
287
362
  threshold: number;
288
- rerank_config?: GetOneKnowledgeRerankConfig$Outbound | undefined;
363
+ rerank_config?: GetOneKnowledgeRerankConfig$Outbound | null | undefined;
364
+ agentic_rag_config?:
365
+ | GetOneKnowledgeAgenticRagConfig$Outbound
366
+ | null
367
+ | undefined;
289
368
  };
290
369
 
291
370
  /** @internal */
@@ -299,13 +378,18 @@ export const GetOneKnowledgeRetrievalSettings$outboundSchema: z.ZodType<
299
378
  ),
300
379
  topK: z.number().int().default(5),
301
380
  threshold: z.number().default(0),
302
- rerankConfig: z.lazy(() => GetOneKnowledgeRerankConfig$outboundSchema)
303
- .optional(),
381
+ rerankConfig: z.nullable(
382
+ z.lazy(() => GetOneKnowledgeRerankConfig$outboundSchema),
383
+ ).optional(),
384
+ agenticRagConfig: z.nullable(
385
+ z.lazy(() => GetOneKnowledgeAgenticRagConfig$outboundSchema),
386
+ ).optional(),
304
387
  }).transform((v) => {
305
388
  return remap$(v, {
306
389
  retrievalType: "retrieval_type",
307
390
  topK: "top_k",
308
391
  rerankConfig: "rerank_config",
392
+ agenticRagConfig: "agentic_rag_config",
309
393
  });
310
394
  });
311
395
 
@@ -22,7 +22,7 @@ export const GetOnePromptType = {
22
22
  export type GetOnePromptType = ClosedEnum<typeof GetOnePromptType>;
23
23
 
24
24
  /**
25
- * The type of the model
25
+ * The modality of the model
26
26
  */
27
27
  export const GetOnePromptModelType = {
28
28
  Chat: "chat",
@@ -36,7 +36,7 @@ export const GetOnePromptModelType = {
36
36
  Moderations: "moderations",
37
37
  } as const;
38
38
  /**
39
- * The type of the model
39
+ * The modality of the model
40
40
  */
41
41
  export type GetOnePromptModelType = ClosedEnum<typeof GetOnePromptModelType>;
42
42
 
@@ -376,7 +376,7 @@ export type GetOnePromptPromptConfig = {
376
376
  */
377
377
  modelDbId?: string | undefined;
378
378
  /**
379
- * The type of the model
379
+ * The modality of the model
380
380
  */
381
381
  modelType?: GetOnePromptModelType | undefined;
382
382
  /**
@@ -21,7 +21,7 @@ export type GetPromptVersionRequest = {
21
21
  };
22
22
 
23
23
  /**
24
- * The type of the model
24
+ * The modality of the model
25
25
  */
26
26
  export const GetPromptVersionModelType = {
27
27
  Chat: "chat",
@@ -35,7 +35,7 @@ export const GetPromptVersionModelType = {
35
35
  Moderations: "moderations",
36
36
  } as const;
37
37
  /**
38
- * The type of the model
38
+ * The modality of the model
39
39
  */
40
40
  export type GetPromptVersionModelType = ClosedEnum<
41
41
  typeof GetPromptVersionModelType
@@ -379,7 +379,7 @@ export type GetPromptVersionPromptConfig = {
379
379
  */
380
380
  modelDbId?: string | undefined;
381
381
  /**
382
- * The type of the model
382
+ * The modality of the model
383
383
  */
384
384
  modelType?: GetPromptVersionModelType | undefined;
385
385
  /**
@@ -0,0 +1,400 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+
11
+ export type GetSessionRequest = {
12
+ /**
13
+ * Unique identifier of the session
14
+ */
15
+ sessionId: string;
16
+ };
17
+
18
+ export type GetSessionBilling = {
19
+ /**
20
+ * Total cost of the session
21
+ */
22
+ inputCost: number;
23
+ /**
24
+ * Total cost of the session
25
+ */
26
+ outputCost: number;
27
+ /**
28
+ * Total usage of the session
29
+ */
30
+ totalCost: number;
31
+ };
32
+
33
+ export type GetSessionUsage = {
34
+ /**
35
+ * Total input tokens of the session
36
+ */
37
+ promptTokens: number;
38
+ /**
39
+ * Total output tokens of the session
40
+ */
41
+ completionTokens: number;
42
+ /**
43
+ * Total tokens of the session
44
+ */
45
+ totalTokens: number;
46
+ };
47
+
48
+ /**
49
+ * Session
50
+ */
51
+ export type GetSessionResponseBody = {
52
+ id: string;
53
+ externalId: string;
54
+ /**
55
+ * Duration of the session in ms
56
+ */
57
+ duration: number;
58
+ /**
59
+ * List of contact ids
60
+ */
61
+ contactIds: Array<string>;
62
+ billing: GetSessionBilling;
63
+ usage: GetSessionUsage;
64
+ /**
65
+ * Total traces of the session
66
+ */
67
+ tracesCount: number;
68
+ tags: Array<string>;
69
+ /**
70
+ * The workspace id
71
+ */
72
+ workspaceId: string;
73
+ /**
74
+ * The project id
75
+ */
76
+ projectId?: string | null | undefined;
77
+ /**
78
+ * The time when the session was created
79
+ */
80
+ startedAt?: Date | undefined;
81
+ /**
82
+ * The time when the session was updated
83
+ */
84
+ updatedAt?: Date | undefined;
85
+ };
86
+
87
+ /** @internal */
88
+ export const GetSessionRequest$inboundSchema: z.ZodType<
89
+ GetSessionRequest,
90
+ z.ZodTypeDef,
91
+ unknown
92
+ > = z.object({
93
+ session_id: z.string(),
94
+ }).transform((v) => {
95
+ return remap$(v, {
96
+ "session_id": "sessionId",
97
+ });
98
+ });
99
+
100
+ /** @internal */
101
+ export type GetSessionRequest$Outbound = {
102
+ session_id: string;
103
+ };
104
+
105
+ /** @internal */
106
+ export const GetSessionRequest$outboundSchema: z.ZodType<
107
+ GetSessionRequest$Outbound,
108
+ z.ZodTypeDef,
109
+ GetSessionRequest
110
+ > = z.object({
111
+ sessionId: z.string(),
112
+ }).transform((v) => {
113
+ return remap$(v, {
114
+ sessionId: "session_id",
115
+ });
116
+ });
117
+
118
+ /**
119
+ * @internal
120
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
121
+ */
122
+ export namespace GetSessionRequest$ {
123
+ /** @deprecated use `GetSessionRequest$inboundSchema` instead. */
124
+ export const inboundSchema = GetSessionRequest$inboundSchema;
125
+ /** @deprecated use `GetSessionRequest$outboundSchema` instead. */
126
+ export const outboundSchema = GetSessionRequest$outboundSchema;
127
+ /** @deprecated use `GetSessionRequest$Outbound` instead. */
128
+ export type Outbound = GetSessionRequest$Outbound;
129
+ }
130
+
131
+ export function getSessionRequestToJSON(
132
+ getSessionRequest: GetSessionRequest,
133
+ ): string {
134
+ return JSON.stringify(
135
+ GetSessionRequest$outboundSchema.parse(getSessionRequest),
136
+ );
137
+ }
138
+
139
+ export function getSessionRequestFromJSON(
140
+ jsonString: string,
141
+ ): SafeParseResult<GetSessionRequest, SDKValidationError> {
142
+ return safeParse(
143
+ jsonString,
144
+ (x) => GetSessionRequest$inboundSchema.parse(JSON.parse(x)),
145
+ `Failed to parse 'GetSessionRequest' from JSON`,
146
+ );
147
+ }
148
+
149
+ /** @internal */
150
+ export const GetSessionBilling$inboundSchema: z.ZodType<
151
+ GetSessionBilling,
152
+ z.ZodTypeDef,
153
+ unknown
154
+ > = z.object({
155
+ input_cost: z.number(),
156
+ output_cost: z.number(),
157
+ total_cost: z.number(),
158
+ }).transform((v) => {
159
+ return remap$(v, {
160
+ "input_cost": "inputCost",
161
+ "output_cost": "outputCost",
162
+ "total_cost": "totalCost",
163
+ });
164
+ });
165
+
166
+ /** @internal */
167
+ export type GetSessionBilling$Outbound = {
168
+ input_cost: number;
169
+ output_cost: number;
170
+ total_cost: number;
171
+ };
172
+
173
+ /** @internal */
174
+ export const GetSessionBilling$outboundSchema: z.ZodType<
175
+ GetSessionBilling$Outbound,
176
+ z.ZodTypeDef,
177
+ GetSessionBilling
178
+ > = z.object({
179
+ inputCost: z.number(),
180
+ outputCost: z.number(),
181
+ totalCost: z.number(),
182
+ }).transform((v) => {
183
+ return remap$(v, {
184
+ inputCost: "input_cost",
185
+ outputCost: "output_cost",
186
+ totalCost: "total_cost",
187
+ });
188
+ });
189
+
190
+ /**
191
+ * @internal
192
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
193
+ */
194
+ export namespace GetSessionBilling$ {
195
+ /** @deprecated use `GetSessionBilling$inboundSchema` instead. */
196
+ export const inboundSchema = GetSessionBilling$inboundSchema;
197
+ /** @deprecated use `GetSessionBilling$outboundSchema` instead. */
198
+ export const outboundSchema = GetSessionBilling$outboundSchema;
199
+ /** @deprecated use `GetSessionBilling$Outbound` instead. */
200
+ export type Outbound = GetSessionBilling$Outbound;
201
+ }
202
+
203
+ export function getSessionBillingToJSON(
204
+ getSessionBilling: GetSessionBilling,
205
+ ): string {
206
+ return JSON.stringify(
207
+ GetSessionBilling$outboundSchema.parse(getSessionBilling),
208
+ );
209
+ }
210
+
211
+ export function getSessionBillingFromJSON(
212
+ jsonString: string,
213
+ ): SafeParseResult<GetSessionBilling, SDKValidationError> {
214
+ return safeParse(
215
+ jsonString,
216
+ (x) => GetSessionBilling$inboundSchema.parse(JSON.parse(x)),
217
+ `Failed to parse 'GetSessionBilling' from JSON`,
218
+ );
219
+ }
220
+
221
+ /** @internal */
222
+ export const GetSessionUsage$inboundSchema: z.ZodType<
223
+ GetSessionUsage,
224
+ z.ZodTypeDef,
225
+ unknown
226
+ > = z.object({
227
+ prompt_tokens: z.number(),
228
+ completion_tokens: z.number(),
229
+ total_tokens: z.number(),
230
+ }).transform((v) => {
231
+ return remap$(v, {
232
+ "prompt_tokens": "promptTokens",
233
+ "completion_tokens": "completionTokens",
234
+ "total_tokens": "totalTokens",
235
+ });
236
+ });
237
+
238
+ /** @internal */
239
+ export type GetSessionUsage$Outbound = {
240
+ prompt_tokens: number;
241
+ completion_tokens: number;
242
+ total_tokens: number;
243
+ };
244
+
245
+ /** @internal */
246
+ export const GetSessionUsage$outboundSchema: z.ZodType<
247
+ GetSessionUsage$Outbound,
248
+ z.ZodTypeDef,
249
+ GetSessionUsage
250
+ > = z.object({
251
+ promptTokens: z.number(),
252
+ completionTokens: z.number(),
253
+ totalTokens: z.number(),
254
+ }).transform((v) => {
255
+ return remap$(v, {
256
+ promptTokens: "prompt_tokens",
257
+ completionTokens: "completion_tokens",
258
+ totalTokens: "total_tokens",
259
+ });
260
+ });
261
+
262
+ /**
263
+ * @internal
264
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
265
+ */
266
+ export namespace GetSessionUsage$ {
267
+ /** @deprecated use `GetSessionUsage$inboundSchema` instead. */
268
+ export const inboundSchema = GetSessionUsage$inboundSchema;
269
+ /** @deprecated use `GetSessionUsage$outboundSchema` instead. */
270
+ export const outboundSchema = GetSessionUsage$outboundSchema;
271
+ /** @deprecated use `GetSessionUsage$Outbound` instead. */
272
+ export type Outbound = GetSessionUsage$Outbound;
273
+ }
274
+
275
+ export function getSessionUsageToJSON(
276
+ getSessionUsage: GetSessionUsage,
277
+ ): string {
278
+ return JSON.stringify(GetSessionUsage$outboundSchema.parse(getSessionUsage));
279
+ }
280
+
281
+ export function getSessionUsageFromJSON(
282
+ jsonString: string,
283
+ ): SafeParseResult<GetSessionUsage, SDKValidationError> {
284
+ return safeParse(
285
+ jsonString,
286
+ (x) => GetSessionUsage$inboundSchema.parse(JSON.parse(x)),
287
+ `Failed to parse 'GetSessionUsage' from JSON`,
288
+ );
289
+ }
290
+
291
+ /** @internal */
292
+ export const GetSessionResponseBody$inboundSchema: z.ZodType<
293
+ GetSessionResponseBody,
294
+ z.ZodTypeDef,
295
+ unknown
296
+ > = z.object({
297
+ _id: z.string(),
298
+ external_id: z.string(),
299
+ duration: z.number(),
300
+ contact_ids: z.array(z.string()),
301
+ billing: z.lazy(() => GetSessionBilling$inboundSchema),
302
+ usage: z.lazy(() => GetSessionUsage$inboundSchema),
303
+ traces_count: z.number(),
304
+ tags: z.array(z.string()),
305
+ workspace_id: z.string(),
306
+ project_id: z.nullable(z.string()).optional(),
307
+ started_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
308
+ .optional(),
309
+ updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
310
+ .optional(),
311
+ }).transform((v) => {
312
+ return remap$(v, {
313
+ "_id": "id",
314
+ "external_id": "externalId",
315
+ "contact_ids": "contactIds",
316
+ "traces_count": "tracesCount",
317
+ "workspace_id": "workspaceId",
318
+ "project_id": "projectId",
319
+ "started_at": "startedAt",
320
+ "updated_at": "updatedAt",
321
+ });
322
+ });
323
+
324
+ /** @internal */
325
+ export type GetSessionResponseBody$Outbound = {
326
+ _id: string;
327
+ external_id: string;
328
+ duration: number;
329
+ contact_ids: Array<string>;
330
+ billing: GetSessionBilling$Outbound;
331
+ usage: GetSessionUsage$Outbound;
332
+ traces_count: number;
333
+ tags: Array<string>;
334
+ workspace_id: string;
335
+ project_id?: string | null | undefined;
336
+ started_at?: string | undefined;
337
+ updated_at?: string | undefined;
338
+ };
339
+
340
+ /** @internal */
341
+ export const GetSessionResponseBody$outboundSchema: z.ZodType<
342
+ GetSessionResponseBody$Outbound,
343
+ z.ZodTypeDef,
344
+ GetSessionResponseBody
345
+ > = z.object({
346
+ id: z.string(),
347
+ externalId: z.string(),
348
+ duration: z.number(),
349
+ contactIds: z.array(z.string()),
350
+ billing: z.lazy(() => GetSessionBilling$outboundSchema),
351
+ usage: z.lazy(() => GetSessionUsage$outboundSchema),
352
+ tracesCount: z.number(),
353
+ tags: z.array(z.string()),
354
+ workspaceId: z.string(),
355
+ projectId: z.nullable(z.string()).optional(),
356
+ startedAt: z.date().transform(v => v.toISOString()).optional(),
357
+ updatedAt: z.date().transform(v => v.toISOString()).optional(),
358
+ }).transform((v) => {
359
+ return remap$(v, {
360
+ id: "_id",
361
+ externalId: "external_id",
362
+ contactIds: "contact_ids",
363
+ tracesCount: "traces_count",
364
+ workspaceId: "workspace_id",
365
+ projectId: "project_id",
366
+ startedAt: "started_at",
367
+ updatedAt: "updated_at",
368
+ });
369
+ });
370
+
371
+ /**
372
+ * @internal
373
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
374
+ */
375
+ export namespace GetSessionResponseBody$ {
376
+ /** @deprecated use `GetSessionResponseBody$inboundSchema` instead. */
377
+ export const inboundSchema = GetSessionResponseBody$inboundSchema;
378
+ /** @deprecated use `GetSessionResponseBody$outboundSchema` instead. */
379
+ export const outboundSchema = GetSessionResponseBody$outboundSchema;
380
+ /** @deprecated use `GetSessionResponseBody$Outbound` instead. */
381
+ export type Outbound = GetSessionResponseBody$Outbound;
382
+ }
383
+
384
+ export function getSessionResponseBodyToJSON(
385
+ getSessionResponseBody: GetSessionResponseBody,
386
+ ): string {
387
+ return JSON.stringify(
388
+ GetSessionResponseBody$outboundSchema.parse(getSessionResponseBody),
389
+ );
390
+ }
391
+
392
+ export function getSessionResponseBodyFromJSON(
393
+ jsonString: string,
394
+ ): SafeParseResult<GetSessionResponseBody, SDKValidationError> {
395
+ return safeParse(
396
+ jsonString,
397
+ (x) => GetSessionResponseBody$inboundSchema.parse(JSON.parse(x)),
398
+ `Failed to parse 'GetSessionResponseBody' from JSON`,
399
+ );
400
+ }