@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
@@ -161,7 +161,11 @@ export type AssistantMessage = {
161
161
  /**
162
162
  * The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
163
163
  */
164
- content?: string | Array<TextContentPart | RefusalContentPart> | undefined;
164
+ content?:
165
+ | string
166
+ | Array<TextContentPart | RefusalContentPart>
167
+ | null
168
+ | undefined;
165
169
  /**
166
170
  * The refusal message by the assistant.
167
171
  */
@@ -519,6 +523,7 @@ export type MessagesAssistantMessage = {
519
523
  content?:
520
524
  | string
521
525
  | Array<TwoTextContentPart | TwoRefusalContentPart>
526
+ | null
522
527
  | undefined;
523
528
  /**
524
529
  * The refusal message by the assistant.
@@ -759,6 +764,21 @@ export type InvokeOptions = {
759
764
  * Whether to include the retrieved knowledge chunks in the response.
760
765
  */
761
766
  includeRetrievals?: boolean | undefined;
767
+ /**
768
+ * A mock response to use instead of calling the LLM API. This is useful for testing purposes. When provided, the system will return a response object with this content as the completion, without making an actual API call to the LLM provider. This works for both streaming and non-streaming requests. Mock responses will not generate logs, traces or be counted for your plan usage.
769
+ */
770
+ mockResponse?: string | undefined;
771
+ };
772
+
773
+ export type Thread = {
774
+ /**
775
+ * Unique thread identifier to group related invocations.
776
+ */
777
+ id: string;
778
+ /**
779
+ * Optional tags to differentiate or categorize threads
780
+ */
781
+ tags?: Array<string> | undefined;
762
782
  };
763
783
 
764
784
  export type DeploymentGetConfigRequestBody = {
@@ -815,6 +835,7 @@ export type DeploymentGetConfigRequestBody = {
815
835
  */
816
836
  documents?: Array<Documents> | undefined;
817
837
  invokeOptions?: InvokeOptions | undefined;
838
+ thread?: Thread | undefined;
818
839
  };
819
840
 
820
841
  /**
@@ -1897,13 +1918,15 @@ export const AssistantMessage$inboundSchema: z.ZodType<
1897
1918
  z.ZodTypeDef,
1898
1919
  unknown
1899
1920
  > = z.object({
1900
- content: z.union([
1901
- z.string(),
1902
- z.array(z.union([
1903
- z.lazy(() => TextContentPart$inboundSchema),
1904
- z.lazy(() => RefusalContentPart$inboundSchema),
1905
- ])),
1906
- ]).optional(),
1921
+ content: z.nullable(
1922
+ z.union([
1923
+ z.string(),
1924
+ z.array(z.union([
1925
+ z.lazy(() => TextContentPart$inboundSchema),
1926
+ z.lazy(() => RefusalContentPart$inboundSchema),
1927
+ ])),
1928
+ ]),
1929
+ ).optional(),
1907
1930
  refusal: z.nullable(z.string()).optional(),
1908
1931
  role: DeploymentGetConfigPrefixMessagesDeploymentsRole$inboundSchema,
1909
1932
  name: z.string().optional(),
@@ -1920,6 +1943,7 @@ export type AssistantMessage$Outbound = {
1920
1943
  content?:
1921
1944
  | string
1922
1945
  | Array<TextContentPart$Outbound | RefusalContentPart$Outbound>
1946
+ | null
1923
1947
  | undefined;
1924
1948
  refusal?: string | null | undefined;
1925
1949
  role: string;
@@ -1934,13 +1958,17 @@ export const AssistantMessage$outboundSchema: z.ZodType<
1934
1958
  z.ZodTypeDef,
1935
1959
  AssistantMessage
1936
1960
  > = z.object({
1937
- content: z.union([
1938
- z.string(),
1939
- z.array(z.union([
1940
- z.lazy(() => TextContentPart$outboundSchema),
1941
- z.lazy(() => RefusalContentPart$outboundSchema),
1942
- ])),
1943
- ]).optional(),
1961
+ content: z.nullable(
1962
+ z.union([
1963
+ z.string(),
1964
+ z.array(
1965
+ z.union([
1966
+ z.lazy(() => TextContentPart$outboundSchema),
1967
+ z.lazy(() => RefusalContentPart$outboundSchema),
1968
+ ]),
1969
+ ),
1970
+ ]),
1971
+ ).optional(),
1944
1972
  refusal: z.nullable(z.string()).optional(),
1945
1973
  role: DeploymentGetConfigPrefixMessagesDeploymentsRole$outboundSchema,
1946
1974
  name: z.string().optional(),
@@ -3441,13 +3469,17 @@ export const MessagesAssistantMessage$inboundSchema: z.ZodType<
3441
3469
  z.ZodTypeDef,
3442
3470
  unknown
3443
3471
  > = z.object({
3444
- content: z.union([
3445
- z.string(),
3446
- z.array(z.union([
3447
- z.lazy(() => TwoTextContentPart$inboundSchema),
3448
- z.lazy(() => TwoRefusalContentPart$inboundSchema),
3449
- ])),
3450
- ]).optional(),
3472
+ content: z.nullable(
3473
+ z.union([
3474
+ z.string(),
3475
+ z.array(
3476
+ z.union([
3477
+ z.lazy(() => TwoTextContentPart$inboundSchema),
3478
+ z.lazy(() => TwoRefusalContentPart$inboundSchema),
3479
+ ]),
3480
+ ),
3481
+ ]),
3482
+ ).optional(),
3451
3483
  refusal: z.nullable(z.string()).optional(),
3452
3484
  role: DeploymentGetConfigMessagesDeploymentsRequestRole$inboundSchema,
3453
3485
  name: z.string().optional(),
@@ -3464,6 +3496,7 @@ export type MessagesAssistantMessage$Outbound = {
3464
3496
  content?:
3465
3497
  | string
3466
3498
  | Array<TwoTextContentPart$Outbound | TwoRefusalContentPart$Outbound>
3499
+ | null
3467
3500
  | undefined;
3468
3501
  refusal?: string | null | undefined;
3469
3502
  role: string;
@@ -3478,13 +3511,17 @@ export const MessagesAssistantMessage$outboundSchema: z.ZodType<
3478
3511
  z.ZodTypeDef,
3479
3512
  MessagesAssistantMessage
3480
3513
  > = z.object({
3481
- content: z.union([
3482
- z.string(),
3483
- z.array(z.union([
3484
- z.lazy(() => TwoTextContentPart$outboundSchema),
3485
- z.lazy(() => TwoRefusalContentPart$outboundSchema),
3486
- ])),
3487
- ]).optional(),
3514
+ content: z.nullable(
3515
+ z.union([
3516
+ z.string(),
3517
+ z.array(
3518
+ z.union([
3519
+ z.lazy(() => TwoTextContentPart$outboundSchema),
3520
+ z.lazy(() => TwoRefusalContentPart$outboundSchema),
3521
+ ]),
3522
+ ),
3523
+ ]),
3524
+ ).optional(),
3488
3525
  refusal: z.nullable(z.string()).optional(),
3489
3526
  role: DeploymentGetConfigMessagesDeploymentsRequestRole$outboundSchema,
3490
3527
  name: z.string().optional(),
@@ -4494,15 +4531,18 @@ export const InvokeOptions$inboundSchema: z.ZodType<
4494
4531
  unknown
4495
4532
  > = z.object({
4496
4533
  include_retrievals: z.boolean().default(false),
4534
+ mock_response: z.string().optional(),
4497
4535
  }).transform((v) => {
4498
4536
  return remap$(v, {
4499
4537
  "include_retrievals": "includeRetrievals",
4538
+ "mock_response": "mockResponse",
4500
4539
  });
4501
4540
  });
4502
4541
 
4503
4542
  /** @internal */
4504
4543
  export type InvokeOptions$Outbound = {
4505
4544
  include_retrievals: boolean;
4545
+ mock_response?: string | undefined;
4506
4546
  };
4507
4547
 
4508
4548
  /** @internal */
@@ -4512,9 +4552,11 @@ export const InvokeOptions$outboundSchema: z.ZodType<
4512
4552
  InvokeOptions
4513
4553
  > = z.object({
4514
4554
  includeRetrievals: z.boolean().default(false),
4555
+ mockResponse: z.string().optional(),
4515
4556
  }).transform((v) => {
4516
4557
  return remap$(v, {
4517
4558
  includeRetrievals: "include_retrievals",
4559
+ mockResponse: "mock_response",
4518
4560
  });
4519
4561
  });
4520
4562
 
@@ -4545,6 +4587,56 @@ export function invokeOptionsFromJSON(
4545
4587
  );
4546
4588
  }
4547
4589
 
4590
+ /** @internal */
4591
+ export const Thread$inboundSchema: z.ZodType<Thread, z.ZodTypeDef, unknown> = z
4592
+ .object({
4593
+ id: z.string(),
4594
+ tags: z.array(z.string()).optional(),
4595
+ });
4596
+
4597
+ /** @internal */
4598
+ export type Thread$Outbound = {
4599
+ id: string;
4600
+ tags?: Array<string> | undefined;
4601
+ };
4602
+
4603
+ /** @internal */
4604
+ export const Thread$outboundSchema: z.ZodType<
4605
+ Thread$Outbound,
4606
+ z.ZodTypeDef,
4607
+ Thread
4608
+ > = z.object({
4609
+ id: z.string(),
4610
+ tags: z.array(z.string()).optional(),
4611
+ });
4612
+
4613
+ /**
4614
+ * @internal
4615
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
4616
+ */
4617
+ export namespace Thread$ {
4618
+ /** @deprecated use `Thread$inboundSchema` instead. */
4619
+ export const inboundSchema = Thread$inboundSchema;
4620
+ /** @deprecated use `Thread$outboundSchema` instead. */
4621
+ export const outboundSchema = Thread$outboundSchema;
4622
+ /** @deprecated use `Thread$Outbound` instead. */
4623
+ export type Outbound = Thread$Outbound;
4624
+ }
4625
+
4626
+ export function threadToJSON(thread: Thread): string {
4627
+ return JSON.stringify(Thread$outboundSchema.parse(thread));
4628
+ }
4629
+
4630
+ export function threadFromJSON(
4631
+ jsonString: string,
4632
+ ): SafeParseResult<Thread, SDKValidationError> {
4633
+ return safeParse(
4634
+ jsonString,
4635
+ (x) => Thread$inboundSchema.parse(JSON.parse(x)),
4636
+ `Failed to parse 'Thread' from JSON`,
4637
+ );
4638
+ }
4639
+
4548
4640
  /** @internal */
4549
4641
  export const DeploymentGetConfigRequestBody$inboundSchema: z.ZodType<
4550
4642
  DeploymentGetConfigRequestBody,
@@ -4577,6 +4669,7 @@ export const DeploymentGetConfigRequestBody$inboundSchema: z.ZodType<
4577
4669
  extra_params: z.record(z.any()).optional(),
4578
4670
  documents: z.array(z.lazy(() => Documents$inboundSchema)).optional(),
4579
4671
  invoke_options: z.lazy(() => InvokeOptions$inboundSchema).optional(),
4672
+ thread: z.lazy(() => Thread$inboundSchema).optional(),
4580
4673
  }).transform((v) => {
4581
4674
  return remap$(v, {
4582
4675
  "prefix_messages": "prefixMessages",
@@ -4614,6 +4707,7 @@ export type DeploymentGetConfigRequestBody$Outbound = {
4614
4707
  extra_params?: { [k: string]: any } | undefined;
4615
4708
  documents?: Array<Documents$Outbound> | undefined;
4616
4709
  invoke_options?: InvokeOptions$Outbound | undefined;
4710
+ thread?: Thread$Outbound | undefined;
4617
4711
  };
4618
4712
 
4619
4713
  /** @internal */
@@ -4648,6 +4742,7 @@ export const DeploymentGetConfigRequestBody$outboundSchema: z.ZodType<
4648
4742
  extraParams: z.record(z.any()).optional(),
4649
4743
  documents: z.array(z.lazy(() => Documents$outboundSchema)).optional(),
4650
4744
  invokeOptions: z.lazy(() => InvokeOptions$outboundSchema).optional(),
4745
+ thread: z.lazy(() => Thread$outboundSchema).optional(),
4651
4746
  }).transform((v) => {
4652
4747
  return remap$(v, {
4653
4748
  prefixMessages: "prefix_messages",
@@ -91,7 +91,7 @@ export type DeploymentsTools = {
91
91
  };
92
92
 
93
93
  /**
94
- * The type of the model
94
+ * The modality of the model
95
95
  */
96
96
  export const DeploymentsModelType = {
97
97
  Chat: "chat",
@@ -105,7 +105,7 @@ export const DeploymentsModelType = {
105
105
  Moderations: "moderations",
106
106
  } as const;
107
107
  /**
108
- * The type of the model
108
+ * The modality of the model
109
109
  */
110
110
  export type DeploymentsModelType = ClosedEnum<typeof DeploymentsModelType>;
111
111
 
@@ -436,7 +436,7 @@ export type DeploymentsPromptConfig = {
436
436
  tools: Array<DeploymentsTools>;
437
437
  model: string;
438
438
  /**
439
- * The type of the model
439
+ * The modality of the model
440
440
  */
441
441
  modelType: DeploymentsModelType;
442
442
  /**
@@ -185,6 +185,7 @@ export type PrefixMessagesAssistantMessage = {
185
185
  | Array<
186
186
  DeploymentStream2TextContentPart | DeploymentStream2RefusalContentPart
187
187
  >
188
+ | null
188
189
  | undefined;
189
190
  /**
190
191
  * The refusal message by the assistant.
@@ -565,6 +566,7 @@ export type DeploymentStreamMessagesAssistantMessage = {
565
566
  | DeploymentStream2DeploymentsTextContentPart
566
567
  | DeploymentStream2DeploymentsRefusalContentPart
567
568
  >
569
+ | null
568
570
  | undefined;
569
571
  /**
570
572
  * The refusal message by the assistant.
@@ -824,6 +826,21 @@ export type DeploymentStreamInvokeOptions = {
824
826
  * Whether to include the retrieved knowledge chunks in the response.
825
827
  */
826
828
  includeRetrievals?: boolean | undefined;
829
+ /**
830
+ * A mock response to use instead of calling the LLM API. This is useful for testing purposes. When provided, the system will return a response object with this content as the completion, without making an actual API call to the LLM provider. This works for both streaming and non-streaming requests. Mock responses will not generate logs, traces or be counted for your plan usage.
831
+ */
832
+ mockResponse?: string | undefined;
833
+ };
834
+
835
+ export type DeploymentStreamThread = {
836
+ /**
837
+ * Unique thread identifier to group related invocations.
838
+ */
839
+ id: string;
840
+ /**
841
+ * Optional tags to differentiate or categorize threads
842
+ */
843
+ tags?: Array<string> | undefined;
827
844
  };
828
845
 
829
846
  export type DeploymentStreamRequestBody = {
@@ -880,6 +897,7 @@ export type DeploymentStreamRequestBody = {
880
897
  */
881
898
  documents?: Array<DeploymentStreamDocuments> | undefined;
882
899
  invokeOptions?: DeploymentStreamInvokeOptions | undefined;
900
+ thread?: DeploymentStreamThread | undefined;
883
901
  };
884
902
 
885
903
  /**
@@ -1949,13 +1967,17 @@ export const PrefixMessagesAssistantMessage$inboundSchema: z.ZodType<
1949
1967
  z.ZodTypeDef,
1950
1968
  unknown
1951
1969
  > = z.object({
1952
- content: z.union([
1953
- z.string(),
1954
- z.array(z.union([
1955
- z.lazy(() => DeploymentStream2TextContentPart$inboundSchema),
1956
- z.lazy(() => DeploymentStream2RefusalContentPart$inboundSchema),
1957
- ])),
1958
- ]).optional(),
1970
+ content: z.nullable(
1971
+ z.union([
1972
+ z.string(),
1973
+ z.array(
1974
+ z.union([
1975
+ z.lazy(() => DeploymentStream2TextContentPart$inboundSchema),
1976
+ z.lazy(() => DeploymentStream2RefusalContentPart$inboundSchema),
1977
+ ]),
1978
+ ),
1979
+ ]),
1980
+ ).optional(),
1959
1981
  refusal: z.nullable(z.string()).optional(),
1960
1982
  role:
1961
1983
  DeploymentStreamPrefixMessagesDeploymentsRequestRequestBodyRole$inboundSchema,
@@ -1977,6 +1999,7 @@ export type PrefixMessagesAssistantMessage$Outbound = {
1977
1999
  | DeploymentStream2TextContentPart$Outbound
1978
2000
  | DeploymentStream2RefusalContentPart$Outbound
1979
2001
  >
2002
+ | null
1980
2003
  | undefined;
1981
2004
  refusal?: string | null | undefined;
1982
2005
  role: string;
@@ -1991,13 +2014,17 @@ export const PrefixMessagesAssistantMessage$outboundSchema: z.ZodType<
1991
2014
  z.ZodTypeDef,
1992
2015
  PrefixMessagesAssistantMessage
1993
2016
  > = z.object({
1994
- content: z.union([
1995
- z.string(),
1996
- z.array(z.union([
1997
- z.lazy(() => DeploymentStream2TextContentPart$outboundSchema),
1998
- z.lazy(() => DeploymentStream2RefusalContentPart$outboundSchema),
1999
- ])),
2000
- ]).optional(),
2017
+ content: z.nullable(
2018
+ z.union([
2019
+ z.string(),
2020
+ z.array(
2021
+ z.union([
2022
+ z.lazy(() => DeploymentStream2TextContentPart$outboundSchema),
2023
+ z.lazy(() => DeploymentStream2RefusalContentPart$outboundSchema),
2024
+ ]),
2025
+ ),
2026
+ ]),
2027
+ ).optional(),
2001
2028
  refusal: z.nullable(z.string()).optional(),
2002
2029
  role:
2003
2030
  DeploymentStreamPrefixMessagesDeploymentsRequestRequestBodyRole$outboundSchema,
@@ -3667,15 +3694,21 @@ export const DeploymentStreamMessagesAssistantMessage$inboundSchema: z.ZodType<
3667
3694
  z.ZodTypeDef,
3668
3695
  unknown
3669
3696
  > = z.object({
3670
- content: z.union([
3671
- z.string(),
3672
- z.array(z.union([
3673
- z.lazy(() => DeploymentStream2DeploymentsTextContentPart$inboundSchema),
3674
- z.lazy(() =>
3675
- DeploymentStream2DeploymentsRefusalContentPart$inboundSchema
3697
+ content: z.nullable(
3698
+ z.union([
3699
+ z.string(),
3700
+ z.array(
3701
+ z.union([
3702
+ z.lazy(() =>
3703
+ DeploymentStream2DeploymentsTextContentPart$inboundSchema
3704
+ ),
3705
+ z.lazy(() =>
3706
+ DeploymentStream2DeploymentsRefusalContentPart$inboundSchema
3707
+ ),
3708
+ ]),
3676
3709
  ),
3677
- ])),
3678
- ]).optional(),
3710
+ ]),
3711
+ ).optional(),
3679
3712
  refusal: z.nullable(z.string()).optional(),
3680
3713
  role: DeploymentStreamMessagesDeploymentsRequestRequestBodyRole$inboundSchema,
3681
3714
  name: z.string().optional(),
@@ -3698,6 +3731,7 @@ export type DeploymentStreamMessagesAssistantMessage$Outbound = {
3698
3731
  | DeploymentStream2DeploymentsTextContentPart$Outbound
3699
3732
  | DeploymentStream2DeploymentsRefusalContentPart$Outbound
3700
3733
  >
3734
+ | null
3701
3735
  | undefined;
3702
3736
  refusal?: string | null | undefined;
3703
3737
  role: string;
@@ -3712,15 +3746,21 @@ export const DeploymentStreamMessagesAssistantMessage$outboundSchema: z.ZodType<
3712
3746
  z.ZodTypeDef,
3713
3747
  DeploymentStreamMessagesAssistantMessage
3714
3748
  > = z.object({
3715
- content: z.union([
3716
- z.string(),
3717
- z.array(z.union([
3718
- z.lazy(() => DeploymentStream2DeploymentsTextContentPart$outboundSchema),
3719
- z.lazy(() =>
3720
- DeploymentStream2DeploymentsRefusalContentPart$outboundSchema
3749
+ content: z.nullable(
3750
+ z.union([
3751
+ z.string(),
3752
+ z.array(
3753
+ z.union([
3754
+ z.lazy(() =>
3755
+ DeploymentStream2DeploymentsTextContentPart$outboundSchema
3756
+ ),
3757
+ z.lazy(() =>
3758
+ DeploymentStream2DeploymentsRefusalContentPart$outboundSchema
3759
+ ),
3760
+ ]),
3721
3761
  ),
3722
- ])),
3723
- ]).optional(),
3762
+ ]),
3763
+ ).optional(),
3724
3764
  refusal: z.nullable(z.string()).optional(),
3725
3765
  role:
3726
3766
  DeploymentStreamMessagesDeploymentsRequestRequestBodyRole$outboundSchema,
@@ -4856,15 +4896,18 @@ export const DeploymentStreamInvokeOptions$inboundSchema: z.ZodType<
4856
4896
  unknown
4857
4897
  > = z.object({
4858
4898
  include_retrievals: z.boolean().default(false),
4899
+ mock_response: z.string().optional(),
4859
4900
  }).transform((v) => {
4860
4901
  return remap$(v, {
4861
4902
  "include_retrievals": "includeRetrievals",
4903
+ "mock_response": "mockResponse",
4862
4904
  });
4863
4905
  });
4864
4906
 
4865
4907
  /** @internal */
4866
4908
  export type DeploymentStreamInvokeOptions$Outbound = {
4867
4909
  include_retrievals: boolean;
4910
+ mock_response?: string | undefined;
4868
4911
  };
4869
4912
 
4870
4913
  /** @internal */
@@ -4874,9 +4917,11 @@ export const DeploymentStreamInvokeOptions$outboundSchema: z.ZodType<
4874
4917
  DeploymentStreamInvokeOptions
4875
4918
  > = z.object({
4876
4919
  includeRetrievals: z.boolean().default(false),
4920
+ mockResponse: z.string().optional(),
4877
4921
  }).transform((v) => {
4878
4922
  return remap$(v, {
4879
4923
  includeRetrievals: "include_retrievals",
4924
+ mockResponse: "mock_response",
4880
4925
  });
4881
4926
  });
4882
4927
 
@@ -4913,6 +4958,63 @@ export function deploymentStreamInvokeOptionsFromJSON(
4913
4958
  );
4914
4959
  }
4915
4960
 
4961
+ /** @internal */
4962
+ export const DeploymentStreamThread$inboundSchema: z.ZodType<
4963
+ DeploymentStreamThread,
4964
+ z.ZodTypeDef,
4965
+ unknown
4966
+ > = z.object({
4967
+ id: z.string(),
4968
+ tags: z.array(z.string()).optional(),
4969
+ });
4970
+
4971
+ /** @internal */
4972
+ export type DeploymentStreamThread$Outbound = {
4973
+ id: string;
4974
+ tags?: Array<string> | undefined;
4975
+ };
4976
+
4977
+ /** @internal */
4978
+ export const DeploymentStreamThread$outboundSchema: z.ZodType<
4979
+ DeploymentStreamThread$Outbound,
4980
+ z.ZodTypeDef,
4981
+ DeploymentStreamThread
4982
+ > = z.object({
4983
+ id: z.string(),
4984
+ tags: z.array(z.string()).optional(),
4985
+ });
4986
+
4987
+ /**
4988
+ * @internal
4989
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
4990
+ */
4991
+ export namespace DeploymentStreamThread$ {
4992
+ /** @deprecated use `DeploymentStreamThread$inboundSchema` instead. */
4993
+ export const inboundSchema = DeploymentStreamThread$inboundSchema;
4994
+ /** @deprecated use `DeploymentStreamThread$outboundSchema` instead. */
4995
+ export const outboundSchema = DeploymentStreamThread$outboundSchema;
4996
+ /** @deprecated use `DeploymentStreamThread$Outbound` instead. */
4997
+ export type Outbound = DeploymentStreamThread$Outbound;
4998
+ }
4999
+
5000
+ export function deploymentStreamThreadToJSON(
5001
+ deploymentStreamThread: DeploymentStreamThread,
5002
+ ): string {
5003
+ return JSON.stringify(
5004
+ DeploymentStreamThread$outboundSchema.parse(deploymentStreamThread),
5005
+ );
5006
+ }
5007
+
5008
+ export function deploymentStreamThreadFromJSON(
5009
+ jsonString: string,
5010
+ ): SafeParseResult<DeploymentStreamThread, SDKValidationError> {
5011
+ return safeParse(
5012
+ jsonString,
5013
+ (x) => DeploymentStreamThread$inboundSchema.parse(JSON.parse(x)),
5014
+ `Failed to parse 'DeploymentStreamThread' from JSON`,
5015
+ );
5016
+ }
5017
+
4916
5018
  /** @internal */
4917
5019
  export const DeploymentStreamRequestBody$inboundSchema: z.ZodType<
4918
5020
  DeploymentStreamRequestBody,
@@ -4947,6 +5049,7 @@ export const DeploymentStreamRequestBody$inboundSchema: z.ZodType<
4947
5049
  .optional(),
4948
5050
  invoke_options: z.lazy(() => DeploymentStreamInvokeOptions$inboundSchema)
4949
5051
  .optional(),
5052
+ thread: z.lazy(() => DeploymentStreamThread$inboundSchema).optional(),
4950
5053
  }).transform((v) => {
4951
5054
  return remap$(v, {
4952
5055
  "prefix_messages": "prefixMessages",
@@ -4984,6 +5087,7 @@ export type DeploymentStreamRequestBody$Outbound = {
4984
5087
  extra_params?: { [k: string]: any } | undefined;
4985
5088
  documents?: Array<DeploymentStreamDocuments$Outbound> | undefined;
4986
5089
  invoke_options?: DeploymentStreamInvokeOptions$Outbound | undefined;
5090
+ thread?: DeploymentStreamThread$Outbound | undefined;
4987
5091
  };
4988
5092
 
4989
5093
  /** @internal */
@@ -5020,6 +5124,7 @@ export const DeploymentStreamRequestBody$outboundSchema: z.ZodType<
5020
5124
  .optional(),
5021
5125
  invokeOptions: z.lazy(() => DeploymentStreamInvokeOptions$outboundSchema)
5022
5126
  .optional(),
5127
+ thread: z.lazy(() => DeploymentStreamThread$outboundSchema).optional(),
5023
5128
  }).transform((v) => {
5024
5129
  return remap$(v, {
5025
5130
  prefixMessages: "prefix_messages",
@@ -146,7 +146,7 @@ export const FileGetResponseBody$inboundSchema: z.ZodType<
146
146
  file_name: z.string(),
147
147
  workspace_id: z.string(),
148
148
  created: z.string().datetime({ offset: true }).default(
149
- "2025-04-03T20:49:22.217Z",
149
+ "2025-04-14T11:15:19.068Z",
150
150
  ).transform(v => new Date(v)),
151
151
  }).transform((v) => {
152
152
  return remap$(v, {
@@ -180,7 +180,7 @@ export const FileGetResponseBody$outboundSchema: z.ZodType<
180
180
  bytes: z.number(),
181
181
  fileName: z.string(),
182
182
  workspaceId: z.string(),
183
- created: z.date().default(() => new Date("2025-04-03T20:49:22.217Z"))
183
+ created: z.date().default(() => new Date("2025-04-14T11:15:19.068Z"))
184
184
  .transform(v => v.toISOString()),
185
185
  }).transform((v) => {
186
186
  return remap$(v, {
@@ -196,7 +196,7 @@ export const FileListData$inboundSchema: z.ZodType<
196
196
  file_name: z.string(),
197
197
  workspace_id: z.string(),
198
198
  created: z.string().datetime({ offset: true }).default(
199
- "2025-04-03T20:49:22.217Z",
199
+ "2025-04-14T11:15:19.068Z",
200
200
  ).transform(v => new Date(v)),
201
201
  }).transform((v) => {
202
202
  return remap$(v, {
@@ -230,7 +230,7 @@ export const FileListData$outboundSchema: z.ZodType<
230
230
  bytes: z.number(),
231
231
  fileName: z.string(),
232
232
  workspaceId: z.string(),
233
- created: z.date().default(() => new Date("2025-04-03T20:49:22.217Z"))
233
+ created: z.date().default(() => new Date("2025-04-14T11:15:19.068Z"))
234
234
  .transform(v => v.toISOString()),
235
235
  }).transform((v) => {
236
236
  return remap$(v, {
@@ -247,7 +247,7 @@ export const FileUploadResponseBody$inboundSchema: z.ZodType<
247
247
  file_name: z.string(),
248
248
  workspace_id: z.string(),
249
249
  created: z.string().datetime({ offset: true }).default(
250
- "2025-04-03T20:49:22.217Z",
250
+ "2025-04-14T11:15:19.068Z",
251
251
  ).transform(v => new Date(v)),
252
252
  }).transform((v) => {
253
253
  return remap$(v, {
@@ -281,7 +281,7 @@ export const FileUploadResponseBody$outboundSchema: z.ZodType<
281
281
  bytes: z.number(),
282
282
  fileName: z.string(),
283
283
  workspaceId: z.string(),
284
- created: z.date().default(() => new Date("2025-04-03T20:49:22.217Z"))
284
+ created: z.date().default(() => new Date("2025-04-14T11:15:19.068Z"))
285
285
  .transform(v => v.toISOString()),
286
286
  }).transform((v) => {
287
287
  return remap$(v, {