@orq-ai/node 3.1.0 → 3.1.2

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 (304) hide show
  1. package/README.md +34 -34
  2. package/docs/sdks/deployments/README.md +9 -86
  3. package/docs/sdks/files/README.md +174 -2
  4. package/docs/sdks/orq/README.md +1 -1
  5. package/docs/sdks/prompt/README.md +6 -0
  6. package/docs/sdks/prompts/README.md +128 -135
  7. package/docs/sdks/snippets/README.md +84 -0
  8. package/docs/sdks/templates/README.md +80 -0
  9. package/funcs/{deploymentsList.d.ts → deploymentsAll.d.ts} +2 -2
  10. package/funcs/deploymentsAll.d.ts.map +1 -0
  11. package/funcs/{deploymentsList.js → deploymentsAll.js} +4 -5
  12. package/funcs/deploymentsAll.js.map +1 -0
  13. package/funcs/deploymentsInvoke.d.ts +7 -1
  14. package/funcs/deploymentsInvoke.d.ts.map +1 -1
  15. package/funcs/deploymentsInvoke.js +11 -10
  16. package/funcs/deploymentsInvoke.js.map +1 -1
  17. package/funcs/filesBulkUpload.d.ts +15 -0
  18. package/funcs/filesBulkUpload.d.ts.map +1 -0
  19. package/funcs/{promptsList.js → filesBulkUpload.js} +15 -18
  20. package/funcs/filesBulkUpload.js.map +1 -0
  21. package/funcs/{promptSnippetsDelete.d.ts → filesUpdate.d.ts} +3 -3
  22. package/funcs/filesUpdate.d.ts.map +1 -0
  23. package/funcs/{promptSnippetsGetByKey.js → filesUpdate.js} +13 -12
  24. package/funcs/filesUpdate.js.map +1 -0
  25. package/funcs/{promptSnippetsList.d.ts → promptSnippetsFindOne.d.ts} +3 -3
  26. package/funcs/promptSnippetsFindOne.d.ts.map +1 -0
  27. package/funcs/{promptSnippetsGet.js → promptSnippetsFindOne.js} +6 -6
  28. package/funcs/promptSnippetsFindOne.js.map +1 -0
  29. package/funcs/{promptSnippetsCreate.d.ts → promptTemplatesGetAll.d.ts} +3 -3
  30. package/funcs/promptTemplatesGetAll.d.ts.map +1 -0
  31. package/funcs/{promptSnippetsList.js → promptTemplatesGetAll.js} +13 -13
  32. package/funcs/promptTemplatesGetAll.js.map +1 -0
  33. package/funcs/promptsCreate.d.ts +1 -1
  34. package/funcs/promptsCreate.js +2 -2
  35. package/funcs/promptsCreate.js.map +1 -1
  36. package/funcs/{promptsRetrieve.d.ts → promptsCreateVersion.d.ts} +3 -6
  37. package/funcs/{promptSnippetsDelete.d.ts.map → promptsCreateVersion.d.ts.map} +1 -1
  38. package/funcs/promptsCreateVersion.js +110 -0
  39. package/funcs/promptsCreateVersion.js.map +1 -0
  40. package/funcs/promptsDelete.js +1 -1
  41. package/funcs/promptsDelete.js.map +1 -1
  42. package/funcs/{promptSnippetsGet.d.ts → promptsDuplicate.d.ts} +3 -3
  43. package/funcs/promptsDuplicate.d.ts.map +1 -0
  44. package/funcs/{promptSnippetsDelete.js → promptsDuplicate.js} +8 -8
  45. package/funcs/promptsDuplicate.js.map +1 -0
  46. package/funcs/promptsGetAll.d.ts +12 -0
  47. package/funcs/promptsGetAll.d.ts.map +1 -0
  48. package/funcs/{promptSnippetsCreate.js → promptsGetAll.js} +8 -8
  49. package/funcs/promptsGetAll.js.map +1 -0
  50. package/funcs/promptsGetOne.d.ts +12 -0
  51. package/funcs/promptsGetOne.d.ts.map +1 -0
  52. package/funcs/{promptsRetrieve.js → promptsGetOne.js} +8 -10
  53. package/funcs/promptsGetOne.js.map +1 -0
  54. package/funcs/promptsUpdate.js +1 -1
  55. package/funcs/promptsUpdate.js.map +1 -1
  56. package/jsr.json +1 -1
  57. package/lib/config.d.ts +2 -10
  58. package/lib/config.d.ts.map +1 -1
  59. package/lib/config.js +2 -2
  60. package/lib/config.js.map +1 -1
  61. package/lib/env.d.ts +0 -13
  62. package/lib/env.d.ts.map +1 -1
  63. package/lib/env.js +0 -17
  64. package/lib/env.js.map +1 -1
  65. package/lib/sdks.js +1 -1
  66. package/lib/sdks.js.map +1 -1
  67. package/models/components/deployments.d.ts +5 -0
  68. package/models/components/deployments.d.ts.map +1 -1
  69. package/models/components/deployments.js +2 -0
  70. package/models/components/deployments.js.map +1 -1
  71. package/models/errors/index.d.ts +0 -2
  72. package/models/errors/index.d.ts.map +1 -1
  73. package/models/errors/index.js +0 -2
  74. package/models/errors/index.js.map +1 -1
  75. package/models/operations/bulkfileupload.d.ts +173 -0
  76. package/models/operations/bulkfileupload.d.ts.map +1 -0
  77. package/models/operations/bulkfileupload.js +210 -0
  78. package/models/operations/bulkfileupload.js.map +1 -0
  79. package/models/operations/createcontact.js +2 -2
  80. package/models/operations/createprompt.d.ts +381 -702
  81. package/models/operations/createprompt.d.ts.map +1 -1
  82. package/models/operations/createprompt.js +481 -641
  83. package/models/operations/createprompt.js.map +1 -1
  84. package/models/operations/createpromptversion.d.ts +2003 -0
  85. package/models/operations/createpromptversion.d.ts.map +1 -0
  86. package/models/operations/createpromptversion.js +1852 -0
  87. package/models/operations/createpromptversion.js.map +1 -0
  88. package/models/operations/deleteprompt.d.ts +1 -1
  89. package/models/operations/deploymentgetconfig.d.ts +0 -39
  90. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  91. package/models/operations/deploymentgetconfig.js +4 -29
  92. package/models/operations/deploymentgetconfig.js.map +1 -1
  93. package/models/operations/deploymentinvoke.d.ts +683 -23
  94. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  95. package/models/operations/deploymentinvoke.js +614 -23
  96. package/models/operations/deploymentinvoke.js.map +1 -1
  97. package/models/operations/deployments.d.ts +8 -54
  98. package/models/operations/deployments.d.ts.map +1 -1
  99. package/models/operations/deployments.js +13 -44
  100. package/models/operations/deployments.js.map +1 -1
  101. package/models/operations/duplicateprompt.d.ts +32 -0
  102. package/models/operations/duplicateprompt.d.ts.map +1 -0
  103. package/models/operations/{deletepromptsnippet.js → duplicateprompt.js} +17 -17
  104. package/models/operations/duplicateprompt.js.map +1 -0
  105. package/models/operations/fileget.js +2 -2
  106. package/models/operations/filelist.d.ts +5 -1
  107. package/models/operations/filelist.d.ts.map +1 -1
  108. package/models/operations/filelist.js +12 -4
  109. package/models/operations/filelist.js.map +1 -1
  110. package/models/operations/fileupdate.d.ts +143 -0
  111. package/models/operations/fileupdate.d.ts.map +1 -0
  112. package/models/operations/fileupdate.js +193 -0
  113. package/models/operations/fileupdate.js.map +1 -0
  114. package/models/operations/fileupload.js +2 -2
  115. package/models/operations/findonepromptsnippet.d.ts +4768 -938
  116. package/models/operations/findonepromptsnippet.d.ts.map +1 -1
  117. package/models/operations/findonepromptsnippet.js +4751 -984
  118. package/models/operations/findonepromptsnippet.js.map +1 -1
  119. package/models/operations/getallprompts.d.ts +9926 -546
  120. package/models/operations/getallprompts.d.ts.map +1 -1
  121. package/models/operations/getallprompts.js +8805 -557
  122. package/models/operations/getallprompts.js.map +1 -1
  123. package/models/operations/getallprompttemplates.d.ts +6607 -0
  124. package/models/operations/getallprompttemplates.d.ts.map +1 -0
  125. package/models/operations/getallprompttemplates.js +6225 -0
  126. package/models/operations/getallprompttemplates.js.map +1 -0
  127. package/models/operations/getoneprompt.d.ts +1 -1203
  128. package/models/operations/getoneprompt.d.ts.map +1 -1
  129. package/models/operations/getoneprompt.js +1 -1011
  130. package/models/operations/getoneprompt.js.map +1 -1
  131. package/models/operations/index.d.ts +5 -8
  132. package/models/operations/index.d.ts.map +1 -1
  133. package/models/operations/index.js +5 -8
  134. package/models/operations/index.js.map +1 -1
  135. package/models/operations/updateprompt.d.ts +5979 -1121
  136. package/models/operations/updateprompt.d.ts.map +1 -1
  137. package/models/operations/updateprompt.js +5729 -1119
  138. package/models/operations/updateprompt.js.map +1 -1
  139. package/package.json +1 -1
  140. package/sdk/deployments.d.ts +6 -10
  141. package/sdk/deployments.d.ts.map +1 -1
  142. package/sdk/deployments.js +6 -14
  143. package/sdk/deployments.js.map +1 -1
  144. package/sdk/files.d.ts +11 -0
  145. package/sdk/files.d.ts.map +1 -1
  146. package/sdk/files.js +17 -0
  147. package/sdk/files.js.map +1 -1
  148. package/sdk/prompt.d.ts +10 -0
  149. package/sdk/prompt.d.ts.map +1 -0
  150. package/sdk/prompt.js +19 -0
  151. package/sdk/prompt.js.map +1 -0
  152. package/sdk/prompts.d.ts +14 -26
  153. package/sdk/prompts.d.ts.map +1 -1
  154. package/sdk/prompts.js +25 -37
  155. package/sdk/prompts.js.map +1 -1
  156. package/sdk/sdk.d.ts +3 -3
  157. package/sdk/sdk.d.ts.map +1 -1
  158. package/sdk/sdk.js +3 -3
  159. package/sdk/sdk.js.map +1 -1
  160. package/sdk/snippets.d.ts +9 -0
  161. package/sdk/snippets.d.ts.map +1 -0
  162. package/sdk/snippets.js +19 -0
  163. package/sdk/snippets.js.map +1 -0
  164. package/sdk/templates.d.ts +9 -0
  165. package/sdk/templates.d.ts.map +1 -0
  166. package/sdk/templates.js +19 -0
  167. package/sdk/templates.js.map +1 -0
  168. package/src/funcs/{deploymentsList.ts → deploymentsAll.ts} +2 -3
  169. package/src/funcs/deploymentsInvoke.ts +16 -21
  170. package/src/funcs/filesBulkUpload.ts +129 -0
  171. package/src/funcs/{promptSnippetsGetByKey.ts → filesUpdate.ts} +16 -18
  172. package/src/funcs/{promptSnippetsGet.ts → promptSnippetsFindOne.ts} +4 -4
  173. package/src/funcs/{promptSnippetsList.ts → promptTemplatesGetAll.ts} +16 -16
  174. package/src/funcs/promptsCreate.ts +2 -2
  175. package/src/funcs/promptsCreateVersion.ts +131 -0
  176. package/src/funcs/promptsDelete.ts +1 -1
  177. package/src/funcs/{promptSnippetsDelete.ts → promptsDuplicate.ts} +7 -8
  178. package/src/funcs/{promptSnippetsCreate.ts → promptsGetAll.ts} +9 -9
  179. package/src/funcs/{promptsRetrieve.ts → promptsGetOne.ts} +8 -10
  180. package/src/funcs/promptsUpdate.ts +1 -1
  181. package/src/lib/config.ts +2 -12
  182. package/src/lib/env.ts +0 -32
  183. package/src/lib/sdks.ts +2 -2
  184. package/src/models/components/deployments.ts +7 -0
  185. package/src/models/errors/index.ts +0 -2
  186. package/src/models/operations/bulkfileupload.ts +315 -0
  187. package/src/models/operations/createcontact.ts +2 -2
  188. package/src/models/operations/createprompt.ts +690 -1048
  189. package/src/models/operations/createpromptversion.ts +3703 -0
  190. package/src/models/operations/deleteprompt.ts +1 -1
  191. package/src/models/operations/deploymentgetconfig.ts +0 -44
  192. package/src/models/operations/deploymentinvoke.ts +1415 -174
  193. package/src/models/operations/deployments.ts +18 -68
  194. package/src/models/operations/duplicateprompt.ts +69 -0
  195. package/src/models/operations/fileget.ts +2 -2
  196. package/src/models/operations/filelist.ts +17 -5
  197. package/src/models/operations/fileupdate.ts +298 -0
  198. package/src/models/operations/fileupload.ts +2 -2
  199. package/src/models/operations/findonepromptsnippet.ts +11104 -1818
  200. package/src/models/operations/getallprompts.ts +17860 -1336
  201. package/src/models/operations/getallprompttemplates.ts +13690 -0
  202. package/src/models/operations/getoneprompt.ts +1 -1914
  203. package/src/models/operations/index.ts +5 -8
  204. package/src/models/operations/updateprompt.ts +12561 -2071
  205. package/src/sdk/deployments.ts +11 -25
  206. package/src/sdk/files.ts +33 -0
  207. package/src/sdk/prompt.ts +19 -0
  208. package/src/sdk/prompts.ts +39 -51
  209. package/src/sdk/sdk.ts +4 -4
  210. package/src/sdk/snippets.ts +24 -0
  211. package/src/sdk/templates.ts +24 -0
  212. package/docs/sdks/promptsnippets/README.md +0 -488
  213. package/funcs/deploymentsList.d.ts.map +0 -1
  214. package/funcs/deploymentsList.js.map +0 -1
  215. package/funcs/deploymentsStream.d.ts +0 -16
  216. package/funcs/deploymentsStream.d.ts.map +0 -1
  217. package/funcs/deploymentsStream.js +0 -125
  218. package/funcs/deploymentsStream.js.map +0 -1
  219. package/funcs/promptSnippetsCreate.d.ts.map +0 -1
  220. package/funcs/promptSnippetsCreate.js.map +0 -1
  221. package/funcs/promptSnippetsDelete.js.map +0 -1
  222. package/funcs/promptSnippetsGet.d.ts.map +0 -1
  223. package/funcs/promptSnippetsGet.js.map +0 -1
  224. package/funcs/promptSnippetsGetByKey.d.ts +0 -12
  225. package/funcs/promptSnippetsGetByKey.d.ts.map +0 -1
  226. package/funcs/promptSnippetsGetByKey.js.map +0 -1
  227. package/funcs/promptSnippetsList.d.ts.map +0 -1
  228. package/funcs/promptSnippetsList.js.map +0 -1
  229. package/funcs/promptSnippetsUpdate.d.ts +0 -13
  230. package/funcs/promptSnippetsUpdate.d.ts.map +0 -1
  231. package/funcs/promptSnippetsUpdate.js +0 -114
  232. package/funcs/promptSnippetsUpdate.js.map +0 -1
  233. package/funcs/promptsGetVersion.d.ts +0 -16
  234. package/funcs/promptsGetVersion.d.ts.map +0 -1
  235. package/funcs/promptsGetVersion.js +0 -120
  236. package/funcs/promptsGetVersion.js.map +0 -1
  237. package/funcs/promptsList.d.ts +0 -15
  238. package/funcs/promptsList.d.ts.map +0 -1
  239. package/funcs/promptsList.js.map +0 -1
  240. package/funcs/promptsListVersions.d.ts +0 -15
  241. package/funcs/promptsListVersions.d.ts.map +0 -1
  242. package/funcs/promptsListVersions.js +0 -118
  243. package/funcs/promptsListVersions.js.map +0 -1
  244. package/funcs/promptsRetrieve.d.ts.map +0 -1
  245. package/funcs/promptsRetrieve.js.map +0 -1
  246. package/models/errors/getpromptversion.d.ts +0 -36
  247. package/models/errors/getpromptversion.d.ts.map +0 -1
  248. package/models/errors/getpromptversion.js +0 -79
  249. package/models/errors/getpromptversion.js.map +0 -1
  250. package/models/errors/updatepromptsnippet.d.ts +0 -36
  251. package/models/errors/updatepromptsnippet.d.ts.map +0 -1
  252. package/models/errors/updatepromptsnippet.js +0 -79
  253. package/models/errors/updatepromptsnippet.js.map +0 -1
  254. package/models/operations/createpromptsnippet.d.ts +0 -3567
  255. package/models/operations/createpromptsnippet.d.ts.map +0 -1
  256. package/models/operations/createpromptsnippet.js +0 -3056
  257. package/models/operations/createpromptsnippet.js.map +0 -1
  258. package/models/operations/deletepromptsnippet.d.ts +0 -32
  259. package/models/operations/deletepromptsnippet.d.ts.map +0 -1
  260. package/models/operations/deletepromptsnippet.js.map +0 -1
  261. package/models/operations/deploymentstream.d.ts +0 -1622
  262. package/models/operations/deploymentstream.d.ts.map +0 -1
  263. package/models/operations/deploymentstream.js +0 -1571
  264. package/models/operations/deploymentstream.js.map +0 -1
  265. package/models/operations/findonebykeypromptsnippet.d.ts +0 -2448
  266. package/models/operations/findonebykeypromptsnippet.d.ts.map +0 -1
  267. package/models/operations/findonebykeypromptsnippet.js +0 -2133
  268. package/models/operations/findonebykeypromptsnippet.js.map +0 -1
  269. package/models/operations/getallpromptsnippets.d.ts +0 -2512
  270. package/models/operations/getallpromptsnippets.d.ts.map +0 -1
  271. package/models/operations/getallpromptsnippets.js +0 -2195
  272. package/models/operations/getallpromptsnippets.js.map +0 -1
  273. package/models/operations/getpromptversion.d.ts +0 -1228
  274. package/models/operations/getpromptversion.d.ts.map +0 -1
  275. package/models/operations/getpromptversion.js +0 -1080
  276. package/models/operations/getpromptversion.js.map +0 -1
  277. package/models/operations/listpromptversions.d.ts +0 -1286
  278. package/models/operations/listpromptversions.d.ts.map +0 -1
  279. package/models/operations/listpromptversions.js +0 -1142
  280. package/models/operations/listpromptversions.js.map +0 -1
  281. package/models/operations/updatepromptsnippet.d.ts +0 -3595
  282. package/models/operations/updatepromptsnippet.d.ts.map +0 -1
  283. package/models/operations/updatepromptsnippet.js +0 -3116
  284. package/models/operations/updatepromptsnippet.js.map +0 -1
  285. package/sdk/promptsnippets.d.ts +0 -29
  286. package/sdk/promptsnippets.d.ts.map +0 -1
  287. package/sdk/promptsnippets.js +0 -54
  288. package/sdk/promptsnippets.js.map +0 -1
  289. package/src/funcs/deploymentsStream.ts +0 -150
  290. package/src/funcs/promptSnippetsUpdate.ts +0 -139
  291. package/src/funcs/promptsGetVersion.ts +0 -146
  292. package/src/funcs/promptsList.ts +0 -133
  293. package/src/funcs/promptsListVersions.ts +0 -139
  294. package/src/models/errors/getpromptversion.ts +0 -71
  295. package/src/models/errors/updatepromptsnippet.ts +0 -71
  296. package/src/models/operations/createpromptsnippet.ts +0 -6239
  297. package/src/models/operations/deletepromptsnippet.ts +0 -69
  298. package/src/models/operations/deploymentstream.ts +0 -3062
  299. package/src/models/operations/findonebykeypromptsnippet.ts +0 -4483
  300. package/src/models/operations/getallpromptsnippets.ts +0 -4472
  301. package/src/models/operations/getpromptversion.ts +0 -2012
  302. package/src/models/operations/listpromptversions.ts +0 -2146
  303. package/src/models/operations/updatepromptsnippet.ts +0 -6544
  304. package/src/sdk/promptsnippets.ts +0 -99
@@ -3,15 +3,275 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { EventStream } from "../../lib/event-streams.js";
6
7
  import { remap as remap$ } from "../../lib/primitives.js";
7
8
  import { safeParse } from "../../lib/schemas.js";
8
9
  import { ClosedEnum } from "../../types/enums.js";
9
10
  import { Result as SafeParseResult } from "../../types/fp.js";
10
11
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
12
 
12
- export type DeploymentInvokeGlobals = {
13
- environment?: string | undefined;
14
- contactId?: string | undefined;
13
+ /**
14
+ * Indicates the type of model used to generate the response
15
+ */
16
+ export const DeploymentInvokeDeploymentsObject = {
17
+ Chat: "chat",
18
+ Completion: "completion",
19
+ Image: "image",
20
+ } as const;
21
+ /**
22
+ * Indicates the type of model used to generate the response
23
+ */
24
+ export type DeploymentInvokeDeploymentsObject = ClosedEnum<
25
+ typeof DeploymentInvokeDeploymentsObject
26
+ >;
27
+
28
+ /**
29
+ * The provider used to generate the response
30
+ */
31
+ export const DeploymentInvokeDeploymentsProvider = {
32
+ Cohere: "cohere",
33
+ Openai: "openai",
34
+ Anthropic: "anthropic",
35
+ Huggingface: "huggingface",
36
+ Replicate: "replicate",
37
+ Google: "google",
38
+ GoogleAi: "google-ai",
39
+ Azure: "azure",
40
+ Aws: "aws",
41
+ Anyscale: "anyscale",
42
+ Perplexity: "perplexity",
43
+ Groq: "groq",
44
+ Fal: "fal",
45
+ Leonardoai: "leonardoai",
46
+ Nvidia: "nvidia",
47
+ } as const;
48
+ /**
49
+ * The provider used to generate the response
50
+ */
51
+ export type DeploymentInvokeDeploymentsProvider = ClosedEnum<
52
+ typeof DeploymentInvokeDeploymentsProvider
53
+ >;
54
+
55
+ /**
56
+ * The role of the prompt message
57
+ */
58
+ export const DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole =
59
+ {
60
+ System: "system",
61
+ Assistant: "assistant",
62
+ User: "user",
63
+ Exception: "exception",
64
+ Tool: "tool",
65
+ Prompt: "prompt",
66
+ Correction: "correction",
67
+ ExpectedOutput: "expected_output",
68
+ } as const;
69
+ /**
70
+ * The role of the prompt message
71
+ */
72
+ export type DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole =
73
+ ClosedEnum<
74
+ typeof DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole
75
+ >;
76
+
77
+ export type DeploymentInvokeMessage3 = {
78
+ /**
79
+ * The role of the prompt message
80
+ */
81
+ role: DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole;
82
+ url: string;
83
+ };
84
+
85
+ /**
86
+ * The role of the prompt message
87
+ */
88
+ export const DeploymentInvokeMessageDeploymentsResponse200Role = {
89
+ System: "system",
90
+ Assistant: "assistant",
91
+ User: "user",
92
+ Exception: "exception",
93
+ Tool: "tool",
94
+ Prompt: "prompt",
95
+ Correction: "correction",
96
+ ExpectedOutput: "expected_output",
97
+ } as const;
98
+ /**
99
+ * The role of the prompt message
100
+ */
101
+ export type DeploymentInvokeMessageDeploymentsResponse200Role = ClosedEnum<
102
+ typeof DeploymentInvokeMessageDeploymentsResponse200Role
103
+ >;
104
+
105
+ export type DeploymentInvokeMessageDeployments2 = {
106
+ /**
107
+ * The role of the prompt message
108
+ */
109
+ role: DeploymentInvokeMessageDeploymentsResponse200Role;
110
+ content: string | null;
111
+ };
112
+
113
+ /**
114
+ * The role of the prompt message
115
+ */
116
+ export const DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole =
117
+ {
118
+ System: "system",
119
+ Assistant: "assistant",
120
+ User: "user",
121
+ Exception: "exception",
122
+ Tool: "tool",
123
+ Prompt: "prompt",
124
+ Correction: "correction",
125
+ ExpectedOutput: "expected_output",
126
+ } as const;
127
+ /**
128
+ * The role of the prompt message
129
+ */
130
+ export type DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole =
131
+ ClosedEnum<
132
+ typeof DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole
133
+ >;
134
+
135
+ export const DeploymentInvokeMessageDeploymentsType = {
136
+ Function: "function",
137
+ } as const;
138
+ export type DeploymentInvokeMessageDeploymentsType = ClosedEnum<
139
+ typeof DeploymentInvokeMessageDeploymentsType
140
+ >;
141
+
142
+ export type DeploymentInvokeMessageDeploymentsFunction = {
143
+ name: string;
144
+ /**
145
+ * JSON string arguments for the functions
146
+ */
147
+ arguments: string;
148
+ };
149
+
150
+ export type DeploymentInvokeMessageDeploymentsToolCalls = {
151
+ id?: string | undefined;
152
+ index?: number | undefined;
153
+ type: DeploymentInvokeMessageDeploymentsType;
154
+ function: DeploymentInvokeMessageDeploymentsFunction;
155
+ };
156
+
157
+ export type DeploymentInvokeMessageDeployments1 = {
158
+ /**
159
+ * The role of the prompt message
160
+ */
161
+ role:
162
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole;
163
+ content?: string | null | undefined;
164
+ toolCalls: Array<DeploymentInvokeMessageDeploymentsToolCalls>;
165
+ };
166
+
167
+ export type DeploymentInvokeDeploymentsMessage =
168
+ | DeploymentInvokeMessageDeployments2
169
+ | DeploymentInvokeMessage3
170
+ | DeploymentInvokeMessageDeployments1;
171
+
172
+ export type DeploymentInvokeDeploymentsChoices = {
173
+ index: number;
174
+ message?:
175
+ | DeploymentInvokeMessageDeployments2
176
+ | DeploymentInvokeMessage3
177
+ | DeploymentInvokeMessageDeployments1
178
+ | undefined;
179
+ finishReason?: string | null | undefined;
180
+ };
181
+
182
+ /**
183
+ * Metadata of the retrieved chunk from the knowledge base
184
+ */
185
+ export type DeploymentInvokeDeploymentsMetadata = {
186
+ /**
187
+ * Name of the file
188
+ */
189
+ fileName: string;
190
+ /**
191
+ * Page number of the chunk
192
+ */
193
+ pageNumber: number | null;
194
+ /**
195
+ * Type of the file
196
+ */
197
+ fileType: string;
198
+ /**
199
+ * Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45
200
+ */
201
+ rerankScore?: number | undefined;
202
+ /**
203
+ * Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query.
204
+ */
205
+ searchScore: number;
206
+ };
207
+
208
+ export type DeploymentInvokeRetrievals = {
209
+ /**
210
+ * Content of the retrieved chunk from the knowledge base
211
+ */
212
+ document: string;
213
+ /**
214
+ * Metadata of the retrieved chunk from the knowledge base
215
+ */
216
+ metadata: DeploymentInvokeDeploymentsMetadata;
217
+ };
218
+
219
+ export type DeploymentInvokeData = {
220
+ /**
221
+ * A unique identifier for the response. Can be used to add metrics to the transaction.
222
+ */
223
+ id?: string | undefined;
224
+ /**
225
+ * A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601
226
+ */
227
+ created?: Date | undefined;
228
+ /**
229
+ * Indicates the type of model used to generate the response
230
+ */
231
+ object?: DeploymentInvokeDeploymentsObject | undefined;
232
+ /**
233
+ * The model used to generate the response
234
+ */
235
+ model?: string | undefined;
236
+ /**
237
+ * The provider used to generate the response
238
+ */
239
+ provider?: DeploymentInvokeDeploymentsProvider | undefined;
240
+ /**
241
+ * Indicates if the response is the final response
242
+ */
243
+ isFinal?: boolean | undefined;
244
+ /**
245
+ * Indicates integration id used to generate the response
246
+ */
247
+ integrationId?: string | undefined;
248
+ /**
249
+ * A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601
250
+ */
251
+ finalized?: Date | undefined;
252
+ /**
253
+ * Provider backed system fingerprint.
254
+ */
255
+ systemFingerprint?: string | null | undefined;
256
+ /**
257
+ * A list of choices generated by the model
258
+ */
259
+ choices?: Array<DeploymentInvokeDeploymentsChoices> | undefined;
260
+ /**
261
+ * List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`.
262
+ */
263
+ retrievals?: Array<DeploymentInvokeRetrievals> | undefined;
264
+ /**
265
+ * Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`.
266
+ */
267
+ providerResponse?: any | undefined;
268
+ };
269
+
270
+ /**
271
+ * Response from the gateway
272
+ */
273
+ export type DeploymentInvokeDeploymentsResponseBody = {
274
+ data?: DeploymentInvokeData | undefined;
15
275
  };
16
276
 
17
277
  /**
@@ -48,8 +308,6 @@ export const DeploymentInvokeProvider = {
48
308
  Leonardoai: "leonardoai",
49
309
  Nvidia: "nvidia",
50
310
  Jina: "jina",
51
- Togetherai: "togetherai",
52
- Elevenlabs: "elevenlabs",
53
311
  } as const;
54
312
  /**
55
313
  * The provider used to generate the response
@@ -115,216 +373,1133 @@ export type DeploymentInvokeMessage2 = {
115
373
  };
116
374
 
117
375
  /**
118
- * The role of the prompt message
119
- */
120
- export const DeploymentInvokeMessageDeploymentsResponseRole = {
121
- System: "system",
122
- Assistant: "assistant",
123
- User: "user",
124
- Exception: "exception",
125
- Tool: "tool",
126
- Prompt: "prompt",
127
- Correction: "correction",
128
- ExpectedOutput: "expected_output",
129
- } as const;
130
- /**
131
- * The role of the prompt message
376
+ * The role of the prompt message
377
+ */
378
+ export const DeploymentInvokeMessageDeploymentsResponseRole = {
379
+ System: "system",
380
+ Assistant: "assistant",
381
+ User: "user",
382
+ Exception: "exception",
383
+ Tool: "tool",
384
+ Prompt: "prompt",
385
+ Correction: "correction",
386
+ ExpectedOutput: "expected_output",
387
+ } as const;
388
+ /**
389
+ * The role of the prompt message
390
+ */
391
+ export type DeploymentInvokeMessageDeploymentsResponseRole = ClosedEnum<
392
+ typeof DeploymentInvokeMessageDeploymentsResponseRole
393
+ >;
394
+
395
+ export const DeploymentInvokeMessageType = {
396
+ Function: "function",
397
+ } as const;
398
+ export type DeploymentInvokeMessageType = ClosedEnum<
399
+ typeof DeploymentInvokeMessageType
400
+ >;
401
+
402
+ export type DeploymentInvokeMessageFunction = {
403
+ name: string;
404
+ /**
405
+ * JSON string arguments for the functions
406
+ */
407
+ arguments: string;
408
+ };
409
+
410
+ export type DeploymentInvokeMessageToolCalls = {
411
+ id?: string | undefined;
412
+ index?: number | undefined;
413
+ type: DeploymentInvokeMessageType;
414
+ function: DeploymentInvokeMessageFunction;
415
+ };
416
+
417
+ export type DeploymentInvokeMessage1 = {
418
+ /**
419
+ * The role of the prompt message
420
+ */
421
+ role: DeploymentInvokeMessageDeploymentsResponseRole;
422
+ content?: string | null | undefined;
423
+ toolCalls: Array<DeploymentInvokeMessageToolCalls>;
424
+ };
425
+
426
+ export type DeploymentInvokeMessage =
427
+ | DeploymentInvokeMessage2
428
+ | Message3
429
+ | DeploymentInvokeMessage1;
430
+
431
+ export type DeploymentInvokeChoices = {
432
+ index: number;
433
+ message?:
434
+ | DeploymentInvokeMessage2
435
+ | Message3
436
+ | DeploymentInvokeMessage1
437
+ | undefined;
438
+ finishReason?: string | null | undefined;
439
+ };
440
+
441
+ /**
442
+ * Metadata of the retrieved chunk from the knowledge base
443
+ */
444
+ export type DeploymentInvokeMetadata = {
445
+ /**
446
+ * Name of the file
447
+ */
448
+ fileName: string;
449
+ /**
450
+ * Page number of the chunk
451
+ */
452
+ pageNumber: number | null;
453
+ /**
454
+ * Type of the file
455
+ */
456
+ fileType: string;
457
+ /**
458
+ * Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45
459
+ */
460
+ rerankScore?: number | undefined;
461
+ /**
462
+ * Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query.
463
+ */
464
+ searchScore: number;
465
+ };
466
+
467
+ export type Retrievals = {
468
+ /**
469
+ * Content of the retrieved chunk from the knowledge base
470
+ */
471
+ document: string;
472
+ /**
473
+ * Metadata of the retrieved chunk from the knowledge base
474
+ */
475
+ metadata: DeploymentInvokeMetadata;
476
+ };
477
+
478
+ /**
479
+ * Response from the gateway
480
+ */
481
+ export type DeploymentInvokeResponseBody = {
482
+ /**
483
+ * A unique identifier for the response. Can be used to add metrics to the transaction.
484
+ */
485
+ id: string;
486
+ /**
487
+ * A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601
488
+ */
489
+ created: Date;
490
+ /**
491
+ * Indicates the type of model used to generate the response
492
+ */
493
+ object: DeploymentInvokeObject;
494
+ /**
495
+ * The model used to generate the response
496
+ */
497
+ model: string;
498
+ /**
499
+ * The provider used to generate the response
500
+ */
501
+ provider: DeploymentInvokeProvider;
502
+ /**
503
+ * Indicates if the response is the final response
504
+ */
505
+ isFinal: boolean;
506
+ /**
507
+ * Indicates integration id used to generate the response
508
+ */
509
+ integrationId?: string | undefined;
510
+ /**
511
+ * A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601
512
+ */
513
+ finalized?: Date | undefined;
514
+ /**
515
+ * Provider backed system fingerprint.
516
+ */
517
+ systemFingerprint?: string | null | undefined;
518
+ /**
519
+ * A list of choices generated by the model
520
+ */
521
+ choices: Array<DeploymentInvokeChoices>;
522
+ /**
523
+ * List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`.
524
+ */
525
+ retrievals?: Array<Retrievals> | undefined;
526
+ /**
527
+ * Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`.
528
+ */
529
+ providerResponse?: any | undefined;
530
+ };
531
+
532
+ export type DeploymentInvokeResponse =
533
+ | DeploymentInvokeResponseBody
534
+ | EventStream<DeploymentInvokeDeploymentsResponseBody>;
535
+
536
+ /** @internal */
537
+ export const DeploymentInvokeDeploymentsObject$inboundSchema: z.ZodNativeEnum<
538
+ typeof DeploymentInvokeDeploymentsObject
539
+ > = z.nativeEnum(DeploymentInvokeDeploymentsObject);
540
+
541
+ /** @internal */
542
+ export const DeploymentInvokeDeploymentsObject$outboundSchema: z.ZodNativeEnum<
543
+ typeof DeploymentInvokeDeploymentsObject
544
+ > = DeploymentInvokeDeploymentsObject$inboundSchema;
545
+
546
+ /**
547
+ * @internal
548
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
549
+ */
550
+ export namespace DeploymentInvokeDeploymentsObject$ {
551
+ /** @deprecated use `DeploymentInvokeDeploymentsObject$inboundSchema` instead. */
552
+ export const inboundSchema = DeploymentInvokeDeploymentsObject$inboundSchema;
553
+ /** @deprecated use `DeploymentInvokeDeploymentsObject$outboundSchema` instead. */
554
+ export const outboundSchema =
555
+ DeploymentInvokeDeploymentsObject$outboundSchema;
556
+ }
557
+
558
+ /** @internal */
559
+ export const DeploymentInvokeDeploymentsProvider$inboundSchema: z.ZodNativeEnum<
560
+ typeof DeploymentInvokeDeploymentsProvider
561
+ > = z.nativeEnum(DeploymentInvokeDeploymentsProvider);
562
+
563
+ /** @internal */
564
+ export const DeploymentInvokeDeploymentsProvider$outboundSchema:
565
+ z.ZodNativeEnum<typeof DeploymentInvokeDeploymentsProvider> =
566
+ DeploymentInvokeDeploymentsProvider$inboundSchema;
567
+
568
+ /**
569
+ * @internal
570
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
571
+ */
572
+ export namespace DeploymentInvokeDeploymentsProvider$ {
573
+ /** @deprecated use `DeploymentInvokeDeploymentsProvider$inboundSchema` instead. */
574
+ export const inboundSchema =
575
+ DeploymentInvokeDeploymentsProvider$inboundSchema;
576
+ /** @deprecated use `DeploymentInvokeDeploymentsProvider$outboundSchema` instead. */
577
+ export const outboundSchema =
578
+ DeploymentInvokeDeploymentsProvider$outboundSchema;
579
+ }
580
+
581
+ /** @internal */
582
+ export const DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$inboundSchema:
583
+ z.ZodNativeEnum<
584
+ typeof DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole
585
+ > = z.nativeEnum(
586
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole,
587
+ );
588
+
589
+ /** @internal */
590
+ export const DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$outboundSchema:
591
+ z.ZodNativeEnum<
592
+ typeof DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole
593
+ > =
594
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$inboundSchema;
595
+
596
+ /**
597
+ * @internal
598
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
599
+ */
600
+ export namespace DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$ {
601
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$inboundSchema` instead. */
602
+ export const inboundSchema =
603
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$inboundSchema;
604
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$outboundSchema` instead. */
605
+ export const outboundSchema =
606
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$outboundSchema;
607
+ }
608
+
609
+ /** @internal */
610
+ export const DeploymentInvokeMessage3$inboundSchema: z.ZodType<
611
+ DeploymentInvokeMessage3,
612
+ z.ZodTypeDef,
613
+ unknown
614
+ > = z.object({
615
+ role:
616
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$inboundSchema,
617
+ url: z.string(),
618
+ });
619
+
620
+ /** @internal */
621
+ export type DeploymentInvokeMessage3$Outbound = {
622
+ role: string;
623
+ url: string;
624
+ };
625
+
626
+ /** @internal */
627
+ export const DeploymentInvokeMessage3$outboundSchema: z.ZodType<
628
+ DeploymentInvokeMessage3$Outbound,
629
+ z.ZodTypeDef,
630
+ DeploymentInvokeMessage3
631
+ > = z.object({
632
+ role:
633
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamRole$outboundSchema,
634
+ url: z.string(),
635
+ });
636
+
637
+ /**
638
+ * @internal
639
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
640
+ */
641
+ export namespace DeploymentInvokeMessage3$ {
642
+ /** @deprecated use `DeploymentInvokeMessage3$inboundSchema` instead. */
643
+ export const inboundSchema = DeploymentInvokeMessage3$inboundSchema;
644
+ /** @deprecated use `DeploymentInvokeMessage3$outboundSchema` instead. */
645
+ export const outboundSchema = DeploymentInvokeMessage3$outboundSchema;
646
+ /** @deprecated use `DeploymentInvokeMessage3$Outbound` instead. */
647
+ export type Outbound = DeploymentInvokeMessage3$Outbound;
648
+ }
649
+
650
+ export function deploymentInvokeMessage3ToJSON(
651
+ deploymentInvokeMessage3: DeploymentInvokeMessage3,
652
+ ): string {
653
+ return JSON.stringify(
654
+ DeploymentInvokeMessage3$outboundSchema.parse(deploymentInvokeMessage3),
655
+ );
656
+ }
657
+
658
+ export function deploymentInvokeMessage3FromJSON(
659
+ jsonString: string,
660
+ ): SafeParseResult<DeploymentInvokeMessage3, SDKValidationError> {
661
+ return safeParse(
662
+ jsonString,
663
+ (x) => DeploymentInvokeMessage3$inboundSchema.parse(JSON.parse(x)),
664
+ `Failed to parse 'DeploymentInvokeMessage3' from JSON`,
665
+ );
666
+ }
667
+
668
+ /** @internal */
669
+ export const DeploymentInvokeMessageDeploymentsResponse200Role$inboundSchema:
670
+ z.ZodNativeEnum<typeof DeploymentInvokeMessageDeploymentsResponse200Role> = z
671
+ .nativeEnum(DeploymentInvokeMessageDeploymentsResponse200Role);
672
+
673
+ /** @internal */
674
+ export const DeploymentInvokeMessageDeploymentsResponse200Role$outboundSchema:
675
+ z.ZodNativeEnum<typeof DeploymentInvokeMessageDeploymentsResponse200Role> =
676
+ DeploymentInvokeMessageDeploymentsResponse200Role$inboundSchema;
677
+
678
+ /**
679
+ * @internal
680
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
681
+ */
682
+ export namespace DeploymentInvokeMessageDeploymentsResponse200Role$ {
683
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsResponse200Role$inboundSchema` instead. */
684
+ export const inboundSchema =
685
+ DeploymentInvokeMessageDeploymentsResponse200Role$inboundSchema;
686
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsResponse200Role$outboundSchema` instead. */
687
+ export const outboundSchema =
688
+ DeploymentInvokeMessageDeploymentsResponse200Role$outboundSchema;
689
+ }
690
+
691
+ /** @internal */
692
+ export const DeploymentInvokeMessageDeployments2$inboundSchema: z.ZodType<
693
+ DeploymentInvokeMessageDeployments2,
694
+ z.ZodTypeDef,
695
+ unknown
696
+ > = z.object({
697
+ role: DeploymentInvokeMessageDeploymentsResponse200Role$inboundSchema,
698
+ content: z.nullable(z.string()),
699
+ });
700
+
701
+ /** @internal */
702
+ export type DeploymentInvokeMessageDeployments2$Outbound = {
703
+ role: string;
704
+ content: string | null;
705
+ };
706
+
707
+ /** @internal */
708
+ export const DeploymentInvokeMessageDeployments2$outboundSchema: z.ZodType<
709
+ DeploymentInvokeMessageDeployments2$Outbound,
710
+ z.ZodTypeDef,
711
+ DeploymentInvokeMessageDeployments2
712
+ > = z.object({
713
+ role: DeploymentInvokeMessageDeploymentsResponse200Role$outboundSchema,
714
+ content: z.nullable(z.string()),
715
+ });
716
+
717
+ /**
718
+ * @internal
719
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
720
+ */
721
+ export namespace DeploymentInvokeMessageDeployments2$ {
722
+ /** @deprecated use `DeploymentInvokeMessageDeployments2$inboundSchema` instead. */
723
+ export const inboundSchema =
724
+ DeploymentInvokeMessageDeployments2$inboundSchema;
725
+ /** @deprecated use `DeploymentInvokeMessageDeployments2$outboundSchema` instead. */
726
+ export const outboundSchema =
727
+ DeploymentInvokeMessageDeployments2$outboundSchema;
728
+ /** @deprecated use `DeploymentInvokeMessageDeployments2$Outbound` instead. */
729
+ export type Outbound = DeploymentInvokeMessageDeployments2$Outbound;
730
+ }
731
+
732
+ export function deploymentInvokeMessageDeployments2ToJSON(
733
+ deploymentInvokeMessageDeployments2: DeploymentInvokeMessageDeployments2,
734
+ ): string {
735
+ return JSON.stringify(
736
+ DeploymentInvokeMessageDeployments2$outboundSchema.parse(
737
+ deploymentInvokeMessageDeployments2,
738
+ ),
739
+ );
740
+ }
741
+
742
+ export function deploymentInvokeMessageDeployments2FromJSON(
743
+ jsonString: string,
744
+ ): SafeParseResult<DeploymentInvokeMessageDeployments2, SDKValidationError> {
745
+ return safeParse(
746
+ jsonString,
747
+ (x) =>
748
+ DeploymentInvokeMessageDeployments2$inboundSchema.parse(JSON.parse(x)),
749
+ `Failed to parse 'DeploymentInvokeMessageDeployments2' from JSON`,
750
+ );
751
+ }
752
+
753
+ /** @internal */
754
+ export const DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$inboundSchema:
755
+ z.ZodNativeEnum<
756
+ typeof DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole
757
+ > = z.nativeEnum(
758
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole,
759
+ );
760
+
761
+ /** @internal */
762
+ export const DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$outboundSchema:
763
+ z.ZodNativeEnum<
764
+ typeof DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole
765
+ > =
766
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$inboundSchema;
767
+
768
+ /**
769
+ * @internal
770
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
771
+ */
772
+ export namespace DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$ {
773
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$inboundSchema` instead. */
774
+ export const inboundSchema =
775
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$inboundSchema;
776
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$outboundSchema` instead. */
777
+ export const outboundSchema =
778
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$outboundSchema;
779
+ }
780
+
781
+ /** @internal */
782
+ export const DeploymentInvokeMessageDeploymentsType$inboundSchema:
783
+ z.ZodNativeEnum<typeof DeploymentInvokeMessageDeploymentsType> = z.nativeEnum(
784
+ DeploymentInvokeMessageDeploymentsType,
785
+ );
786
+
787
+ /** @internal */
788
+ export const DeploymentInvokeMessageDeploymentsType$outboundSchema:
789
+ z.ZodNativeEnum<typeof DeploymentInvokeMessageDeploymentsType> =
790
+ DeploymentInvokeMessageDeploymentsType$inboundSchema;
791
+
792
+ /**
793
+ * @internal
794
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
795
+ */
796
+ export namespace DeploymentInvokeMessageDeploymentsType$ {
797
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsType$inboundSchema` instead. */
798
+ export const inboundSchema =
799
+ DeploymentInvokeMessageDeploymentsType$inboundSchema;
800
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsType$outboundSchema` instead. */
801
+ export const outboundSchema =
802
+ DeploymentInvokeMessageDeploymentsType$outboundSchema;
803
+ }
804
+
805
+ /** @internal */
806
+ export const DeploymentInvokeMessageDeploymentsFunction$inboundSchema:
807
+ z.ZodType<DeploymentInvokeMessageDeploymentsFunction, z.ZodTypeDef, unknown> =
808
+ z.object({
809
+ name: z.string(),
810
+ arguments: z.string(),
811
+ });
812
+
813
+ /** @internal */
814
+ export type DeploymentInvokeMessageDeploymentsFunction$Outbound = {
815
+ name: string;
816
+ arguments: string;
817
+ };
818
+
819
+ /** @internal */
820
+ export const DeploymentInvokeMessageDeploymentsFunction$outboundSchema:
821
+ z.ZodType<
822
+ DeploymentInvokeMessageDeploymentsFunction$Outbound,
823
+ z.ZodTypeDef,
824
+ DeploymentInvokeMessageDeploymentsFunction
825
+ > = z.object({
826
+ name: z.string(),
827
+ arguments: z.string(),
828
+ });
829
+
830
+ /**
831
+ * @internal
832
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
833
+ */
834
+ export namespace DeploymentInvokeMessageDeploymentsFunction$ {
835
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsFunction$inboundSchema` instead. */
836
+ export const inboundSchema =
837
+ DeploymentInvokeMessageDeploymentsFunction$inboundSchema;
838
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsFunction$outboundSchema` instead. */
839
+ export const outboundSchema =
840
+ DeploymentInvokeMessageDeploymentsFunction$outboundSchema;
841
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsFunction$Outbound` instead. */
842
+ export type Outbound = DeploymentInvokeMessageDeploymentsFunction$Outbound;
843
+ }
844
+
845
+ export function deploymentInvokeMessageDeploymentsFunctionToJSON(
846
+ deploymentInvokeMessageDeploymentsFunction:
847
+ DeploymentInvokeMessageDeploymentsFunction,
848
+ ): string {
849
+ return JSON.stringify(
850
+ DeploymentInvokeMessageDeploymentsFunction$outboundSchema.parse(
851
+ deploymentInvokeMessageDeploymentsFunction,
852
+ ),
853
+ );
854
+ }
855
+
856
+ export function deploymentInvokeMessageDeploymentsFunctionFromJSON(
857
+ jsonString: string,
858
+ ): SafeParseResult<
859
+ DeploymentInvokeMessageDeploymentsFunction,
860
+ SDKValidationError
861
+ > {
862
+ return safeParse(
863
+ jsonString,
864
+ (x) =>
865
+ DeploymentInvokeMessageDeploymentsFunction$inboundSchema.parse(
866
+ JSON.parse(x),
867
+ ),
868
+ `Failed to parse 'DeploymentInvokeMessageDeploymentsFunction' from JSON`,
869
+ );
870
+ }
871
+
872
+ /** @internal */
873
+ export const DeploymentInvokeMessageDeploymentsToolCalls$inboundSchema:
874
+ z.ZodType<
875
+ DeploymentInvokeMessageDeploymentsToolCalls,
876
+ z.ZodTypeDef,
877
+ unknown
878
+ > = z.object({
879
+ id: z.string().optional(),
880
+ index: z.number().optional(),
881
+ type: DeploymentInvokeMessageDeploymentsType$inboundSchema,
882
+ function: z.lazy(() =>
883
+ DeploymentInvokeMessageDeploymentsFunction$inboundSchema
884
+ ),
885
+ });
886
+
887
+ /** @internal */
888
+ export type DeploymentInvokeMessageDeploymentsToolCalls$Outbound = {
889
+ id?: string | undefined;
890
+ index?: number | undefined;
891
+ type: string;
892
+ function: DeploymentInvokeMessageDeploymentsFunction$Outbound;
893
+ };
894
+
895
+ /** @internal */
896
+ export const DeploymentInvokeMessageDeploymentsToolCalls$outboundSchema:
897
+ z.ZodType<
898
+ DeploymentInvokeMessageDeploymentsToolCalls$Outbound,
899
+ z.ZodTypeDef,
900
+ DeploymentInvokeMessageDeploymentsToolCalls
901
+ > = z.object({
902
+ id: z.string().optional(),
903
+ index: z.number().optional(),
904
+ type: DeploymentInvokeMessageDeploymentsType$outboundSchema,
905
+ function: z.lazy(() =>
906
+ DeploymentInvokeMessageDeploymentsFunction$outboundSchema
907
+ ),
908
+ });
909
+
910
+ /**
911
+ * @internal
912
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
913
+ */
914
+ export namespace DeploymentInvokeMessageDeploymentsToolCalls$ {
915
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsToolCalls$inboundSchema` instead. */
916
+ export const inboundSchema =
917
+ DeploymentInvokeMessageDeploymentsToolCalls$inboundSchema;
918
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsToolCalls$outboundSchema` instead. */
919
+ export const outboundSchema =
920
+ DeploymentInvokeMessageDeploymentsToolCalls$outboundSchema;
921
+ /** @deprecated use `DeploymentInvokeMessageDeploymentsToolCalls$Outbound` instead. */
922
+ export type Outbound = DeploymentInvokeMessageDeploymentsToolCalls$Outbound;
923
+ }
924
+
925
+ export function deploymentInvokeMessageDeploymentsToolCallsToJSON(
926
+ deploymentInvokeMessageDeploymentsToolCalls:
927
+ DeploymentInvokeMessageDeploymentsToolCalls,
928
+ ): string {
929
+ return JSON.stringify(
930
+ DeploymentInvokeMessageDeploymentsToolCalls$outboundSchema.parse(
931
+ deploymentInvokeMessageDeploymentsToolCalls,
932
+ ),
933
+ );
934
+ }
935
+
936
+ export function deploymentInvokeMessageDeploymentsToolCallsFromJSON(
937
+ jsonString: string,
938
+ ): SafeParseResult<
939
+ DeploymentInvokeMessageDeploymentsToolCalls,
940
+ SDKValidationError
941
+ > {
942
+ return safeParse(
943
+ jsonString,
944
+ (x) =>
945
+ DeploymentInvokeMessageDeploymentsToolCalls$inboundSchema.parse(
946
+ JSON.parse(x),
947
+ ),
948
+ `Failed to parse 'DeploymentInvokeMessageDeploymentsToolCalls' from JSON`,
949
+ );
950
+ }
951
+
952
+ /** @internal */
953
+ export const DeploymentInvokeMessageDeployments1$inboundSchema: z.ZodType<
954
+ DeploymentInvokeMessageDeployments1,
955
+ z.ZodTypeDef,
956
+ unknown
957
+ > = z.object({
958
+ role:
959
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$inboundSchema,
960
+ content: z.nullable(z.string()).optional(),
961
+ tool_calls: z.array(
962
+ z.lazy(() => DeploymentInvokeMessageDeploymentsToolCalls$inboundSchema),
963
+ ),
964
+ }).transform((v) => {
965
+ return remap$(v, {
966
+ "tool_calls": "toolCalls",
967
+ });
968
+ });
969
+
970
+ /** @internal */
971
+ export type DeploymentInvokeMessageDeployments1$Outbound = {
972
+ role: string;
973
+ content?: string | null | undefined;
974
+ tool_calls: Array<DeploymentInvokeMessageDeploymentsToolCalls$Outbound>;
975
+ };
976
+
977
+ /** @internal */
978
+ export const DeploymentInvokeMessageDeployments1$outboundSchema: z.ZodType<
979
+ DeploymentInvokeMessageDeployments1$Outbound,
980
+ z.ZodTypeDef,
981
+ DeploymentInvokeMessageDeployments1
982
+ > = z.object({
983
+ role:
984
+ DeploymentInvokeMessageDeploymentsResponse200TextEventStreamResponseBodyRole$outboundSchema,
985
+ content: z.nullable(z.string()).optional(),
986
+ toolCalls: z.array(
987
+ z.lazy(() => DeploymentInvokeMessageDeploymentsToolCalls$outboundSchema),
988
+ ),
989
+ }).transform((v) => {
990
+ return remap$(v, {
991
+ toolCalls: "tool_calls",
992
+ });
993
+ });
994
+
995
+ /**
996
+ * @internal
997
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
998
+ */
999
+ export namespace DeploymentInvokeMessageDeployments1$ {
1000
+ /** @deprecated use `DeploymentInvokeMessageDeployments1$inboundSchema` instead. */
1001
+ export const inboundSchema =
1002
+ DeploymentInvokeMessageDeployments1$inboundSchema;
1003
+ /** @deprecated use `DeploymentInvokeMessageDeployments1$outboundSchema` instead. */
1004
+ export const outboundSchema =
1005
+ DeploymentInvokeMessageDeployments1$outboundSchema;
1006
+ /** @deprecated use `DeploymentInvokeMessageDeployments1$Outbound` instead. */
1007
+ export type Outbound = DeploymentInvokeMessageDeployments1$Outbound;
1008
+ }
1009
+
1010
+ export function deploymentInvokeMessageDeployments1ToJSON(
1011
+ deploymentInvokeMessageDeployments1: DeploymentInvokeMessageDeployments1,
1012
+ ): string {
1013
+ return JSON.stringify(
1014
+ DeploymentInvokeMessageDeployments1$outboundSchema.parse(
1015
+ deploymentInvokeMessageDeployments1,
1016
+ ),
1017
+ );
1018
+ }
1019
+
1020
+ export function deploymentInvokeMessageDeployments1FromJSON(
1021
+ jsonString: string,
1022
+ ): SafeParseResult<DeploymentInvokeMessageDeployments1, SDKValidationError> {
1023
+ return safeParse(
1024
+ jsonString,
1025
+ (x) =>
1026
+ DeploymentInvokeMessageDeployments1$inboundSchema.parse(JSON.parse(x)),
1027
+ `Failed to parse 'DeploymentInvokeMessageDeployments1' from JSON`,
1028
+ );
1029
+ }
1030
+
1031
+ /** @internal */
1032
+ export const DeploymentInvokeDeploymentsMessage$inboundSchema: z.ZodType<
1033
+ DeploymentInvokeDeploymentsMessage,
1034
+ z.ZodTypeDef,
1035
+ unknown
1036
+ > = z.union([
1037
+ z.lazy(() => DeploymentInvokeMessageDeployments2$inboundSchema),
1038
+ z.lazy(() => DeploymentInvokeMessage3$inboundSchema),
1039
+ z.lazy(() => DeploymentInvokeMessageDeployments1$inboundSchema),
1040
+ ]);
1041
+
1042
+ /** @internal */
1043
+ export type DeploymentInvokeDeploymentsMessage$Outbound =
1044
+ | DeploymentInvokeMessageDeployments2$Outbound
1045
+ | DeploymentInvokeMessage3$Outbound
1046
+ | DeploymentInvokeMessageDeployments1$Outbound;
1047
+
1048
+ /** @internal */
1049
+ export const DeploymentInvokeDeploymentsMessage$outboundSchema: z.ZodType<
1050
+ DeploymentInvokeDeploymentsMessage$Outbound,
1051
+ z.ZodTypeDef,
1052
+ DeploymentInvokeDeploymentsMessage
1053
+ > = z.union([
1054
+ z.lazy(() => DeploymentInvokeMessageDeployments2$outboundSchema),
1055
+ z.lazy(() => DeploymentInvokeMessage3$outboundSchema),
1056
+ z.lazy(() => DeploymentInvokeMessageDeployments1$outboundSchema),
1057
+ ]);
1058
+
1059
+ /**
1060
+ * @internal
1061
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1062
+ */
1063
+ export namespace DeploymentInvokeDeploymentsMessage$ {
1064
+ /** @deprecated use `DeploymentInvokeDeploymentsMessage$inboundSchema` instead. */
1065
+ export const inboundSchema = DeploymentInvokeDeploymentsMessage$inboundSchema;
1066
+ /** @deprecated use `DeploymentInvokeDeploymentsMessage$outboundSchema` instead. */
1067
+ export const outboundSchema =
1068
+ DeploymentInvokeDeploymentsMessage$outboundSchema;
1069
+ /** @deprecated use `DeploymentInvokeDeploymentsMessage$Outbound` instead. */
1070
+ export type Outbound = DeploymentInvokeDeploymentsMessage$Outbound;
1071
+ }
1072
+
1073
+ export function deploymentInvokeDeploymentsMessageToJSON(
1074
+ deploymentInvokeDeploymentsMessage: DeploymentInvokeDeploymentsMessage,
1075
+ ): string {
1076
+ return JSON.stringify(
1077
+ DeploymentInvokeDeploymentsMessage$outboundSchema.parse(
1078
+ deploymentInvokeDeploymentsMessage,
1079
+ ),
1080
+ );
1081
+ }
1082
+
1083
+ export function deploymentInvokeDeploymentsMessageFromJSON(
1084
+ jsonString: string,
1085
+ ): SafeParseResult<DeploymentInvokeDeploymentsMessage, SDKValidationError> {
1086
+ return safeParse(
1087
+ jsonString,
1088
+ (x) =>
1089
+ DeploymentInvokeDeploymentsMessage$inboundSchema.parse(JSON.parse(x)),
1090
+ `Failed to parse 'DeploymentInvokeDeploymentsMessage' from JSON`,
1091
+ );
1092
+ }
1093
+
1094
+ /** @internal */
1095
+ export const DeploymentInvokeDeploymentsChoices$inboundSchema: z.ZodType<
1096
+ DeploymentInvokeDeploymentsChoices,
1097
+ z.ZodTypeDef,
1098
+ unknown
1099
+ > = z.object({
1100
+ index: z.number(),
1101
+ message: z.union([
1102
+ z.lazy(() => DeploymentInvokeMessageDeployments2$inboundSchema),
1103
+ z.lazy(() => DeploymentInvokeMessage3$inboundSchema),
1104
+ z.lazy(() => DeploymentInvokeMessageDeployments1$inboundSchema),
1105
+ ]).optional(),
1106
+ finish_reason: z.nullable(z.string()).optional(),
1107
+ }).transform((v) => {
1108
+ return remap$(v, {
1109
+ "finish_reason": "finishReason",
1110
+ });
1111
+ });
1112
+
1113
+ /** @internal */
1114
+ export type DeploymentInvokeDeploymentsChoices$Outbound = {
1115
+ index: number;
1116
+ message?:
1117
+ | DeploymentInvokeMessageDeployments2$Outbound
1118
+ | DeploymentInvokeMessage3$Outbound
1119
+ | DeploymentInvokeMessageDeployments1$Outbound
1120
+ | undefined;
1121
+ finish_reason?: string | null | undefined;
1122
+ };
1123
+
1124
+ /** @internal */
1125
+ export const DeploymentInvokeDeploymentsChoices$outboundSchema: z.ZodType<
1126
+ DeploymentInvokeDeploymentsChoices$Outbound,
1127
+ z.ZodTypeDef,
1128
+ DeploymentInvokeDeploymentsChoices
1129
+ > = z.object({
1130
+ index: z.number(),
1131
+ message: z.union([
1132
+ z.lazy(() => DeploymentInvokeMessageDeployments2$outboundSchema),
1133
+ z.lazy(() => DeploymentInvokeMessage3$outboundSchema),
1134
+ z.lazy(() => DeploymentInvokeMessageDeployments1$outboundSchema),
1135
+ ]).optional(),
1136
+ finishReason: z.nullable(z.string()).optional(),
1137
+ }).transform((v) => {
1138
+ return remap$(v, {
1139
+ finishReason: "finish_reason",
1140
+ });
1141
+ });
1142
+
1143
+ /**
1144
+ * @internal
1145
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1146
+ */
1147
+ export namespace DeploymentInvokeDeploymentsChoices$ {
1148
+ /** @deprecated use `DeploymentInvokeDeploymentsChoices$inboundSchema` instead. */
1149
+ export const inboundSchema = DeploymentInvokeDeploymentsChoices$inboundSchema;
1150
+ /** @deprecated use `DeploymentInvokeDeploymentsChoices$outboundSchema` instead. */
1151
+ export const outboundSchema =
1152
+ DeploymentInvokeDeploymentsChoices$outboundSchema;
1153
+ /** @deprecated use `DeploymentInvokeDeploymentsChoices$Outbound` instead. */
1154
+ export type Outbound = DeploymentInvokeDeploymentsChoices$Outbound;
1155
+ }
1156
+
1157
+ export function deploymentInvokeDeploymentsChoicesToJSON(
1158
+ deploymentInvokeDeploymentsChoices: DeploymentInvokeDeploymentsChoices,
1159
+ ): string {
1160
+ return JSON.stringify(
1161
+ DeploymentInvokeDeploymentsChoices$outboundSchema.parse(
1162
+ deploymentInvokeDeploymentsChoices,
1163
+ ),
1164
+ );
1165
+ }
1166
+
1167
+ export function deploymentInvokeDeploymentsChoicesFromJSON(
1168
+ jsonString: string,
1169
+ ): SafeParseResult<DeploymentInvokeDeploymentsChoices, SDKValidationError> {
1170
+ return safeParse(
1171
+ jsonString,
1172
+ (x) =>
1173
+ DeploymentInvokeDeploymentsChoices$inboundSchema.parse(JSON.parse(x)),
1174
+ `Failed to parse 'DeploymentInvokeDeploymentsChoices' from JSON`,
1175
+ );
1176
+ }
1177
+
1178
+ /** @internal */
1179
+ export const DeploymentInvokeDeploymentsMetadata$inboundSchema: z.ZodType<
1180
+ DeploymentInvokeDeploymentsMetadata,
1181
+ z.ZodTypeDef,
1182
+ unknown
1183
+ > = z.object({
1184
+ file_name: z.string(),
1185
+ page_number: z.nullable(z.number()),
1186
+ file_type: z.string(),
1187
+ rerank_score: z.number().optional(),
1188
+ search_score: z.number(),
1189
+ }).transform((v) => {
1190
+ return remap$(v, {
1191
+ "file_name": "fileName",
1192
+ "page_number": "pageNumber",
1193
+ "file_type": "fileType",
1194
+ "rerank_score": "rerankScore",
1195
+ "search_score": "searchScore",
1196
+ });
1197
+ });
1198
+
1199
+ /** @internal */
1200
+ export type DeploymentInvokeDeploymentsMetadata$Outbound = {
1201
+ file_name: string;
1202
+ page_number: number | null;
1203
+ file_type: string;
1204
+ rerank_score?: number | undefined;
1205
+ search_score: number;
1206
+ };
1207
+
1208
+ /** @internal */
1209
+ export const DeploymentInvokeDeploymentsMetadata$outboundSchema: z.ZodType<
1210
+ DeploymentInvokeDeploymentsMetadata$Outbound,
1211
+ z.ZodTypeDef,
1212
+ DeploymentInvokeDeploymentsMetadata
1213
+ > = z.object({
1214
+ fileName: z.string(),
1215
+ pageNumber: z.nullable(z.number()),
1216
+ fileType: z.string(),
1217
+ rerankScore: z.number().optional(),
1218
+ searchScore: z.number(),
1219
+ }).transform((v) => {
1220
+ return remap$(v, {
1221
+ fileName: "file_name",
1222
+ pageNumber: "page_number",
1223
+ fileType: "file_type",
1224
+ rerankScore: "rerank_score",
1225
+ searchScore: "search_score",
1226
+ });
1227
+ });
1228
+
1229
+ /**
1230
+ * @internal
1231
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1232
+ */
1233
+ export namespace DeploymentInvokeDeploymentsMetadata$ {
1234
+ /** @deprecated use `DeploymentInvokeDeploymentsMetadata$inboundSchema` instead. */
1235
+ export const inboundSchema =
1236
+ DeploymentInvokeDeploymentsMetadata$inboundSchema;
1237
+ /** @deprecated use `DeploymentInvokeDeploymentsMetadata$outboundSchema` instead. */
1238
+ export const outboundSchema =
1239
+ DeploymentInvokeDeploymentsMetadata$outboundSchema;
1240
+ /** @deprecated use `DeploymentInvokeDeploymentsMetadata$Outbound` instead. */
1241
+ export type Outbound = DeploymentInvokeDeploymentsMetadata$Outbound;
1242
+ }
1243
+
1244
+ export function deploymentInvokeDeploymentsMetadataToJSON(
1245
+ deploymentInvokeDeploymentsMetadata: DeploymentInvokeDeploymentsMetadata,
1246
+ ): string {
1247
+ return JSON.stringify(
1248
+ DeploymentInvokeDeploymentsMetadata$outboundSchema.parse(
1249
+ deploymentInvokeDeploymentsMetadata,
1250
+ ),
1251
+ );
1252
+ }
1253
+
1254
+ export function deploymentInvokeDeploymentsMetadataFromJSON(
1255
+ jsonString: string,
1256
+ ): SafeParseResult<DeploymentInvokeDeploymentsMetadata, SDKValidationError> {
1257
+ return safeParse(
1258
+ jsonString,
1259
+ (x) =>
1260
+ DeploymentInvokeDeploymentsMetadata$inboundSchema.parse(JSON.parse(x)),
1261
+ `Failed to parse 'DeploymentInvokeDeploymentsMetadata' from JSON`,
1262
+ );
1263
+ }
1264
+
1265
+ /** @internal */
1266
+ export const DeploymentInvokeRetrievals$inboundSchema: z.ZodType<
1267
+ DeploymentInvokeRetrievals,
1268
+ z.ZodTypeDef,
1269
+ unknown
1270
+ > = z.object({
1271
+ document: z.string(),
1272
+ metadata: z.lazy(() => DeploymentInvokeDeploymentsMetadata$inboundSchema),
1273
+ });
1274
+
1275
+ /** @internal */
1276
+ export type DeploymentInvokeRetrievals$Outbound = {
1277
+ document: string;
1278
+ metadata: DeploymentInvokeDeploymentsMetadata$Outbound;
1279
+ };
1280
+
1281
+ /** @internal */
1282
+ export const DeploymentInvokeRetrievals$outboundSchema: z.ZodType<
1283
+ DeploymentInvokeRetrievals$Outbound,
1284
+ z.ZodTypeDef,
1285
+ DeploymentInvokeRetrievals
1286
+ > = z.object({
1287
+ document: z.string(),
1288
+ metadata: z.lazy(() => DeploymentInvokeDeploymentsMetadata$outboundSchema),
1289
+ });
1290
+
1291
+ /**
1292
+ * @internal
1293
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
132
1294
  */
133
- export type DeploymentInvokeMessageDeploymentsResponseRole = ClosedEnum<
134
- typeof DeploymentInvokeMessageDeploymentsResponseRole
135
- >;
1295
+ export namespace DeploymentInvokeRetrievals$ {
1296
+ /** @deprecated use `DeploymentInvokeRetrievals$inboundSchema` instead. */
1297
+ export const inboundSchema = DeploymentInvokeRetrievals$inboundSchema;
1298
+ /** @deprecated use `DeploymentInvokeRetrievals$outboundSchema` instead. */
1299
+ export const outboundSchema = DeploymentInvokeRetrievals$outboundSchema;
1300
+ /** @deprecated use `DeploymentInvokeRetrievals$Outbound` instead. */
1301
+ export type Outbound = DeploymentInvokeRetrievals$Outbound;
1302
+ }
136
1303
 
137
- export const DeploymentInvokeMessageType = {
138
- Function: "function",
139
- } as const;
140
- export type DeploymentInvokeMessageType = ClosedEnum<
141
- typeof DeploymentInvokeMessageType
142
- >;
1304
+ export function deploymentInvokeRetrievalsToJSON(
1305
+ deploymentInvokeRetrievals: DeploymentInvokeRetrievals,
1306
+ ): string {
1307
+ return JSON.stringify(
1308
+ DeploymentInvokeRetrievals$outboundSchema.parse(deploymentInvokeRetrievals),
1309
+ );
1310
+ }
143
1311
 
144
- export type DeploymentInvokeMessageFunction = {
145
- name: string;
146
- /**
147
- * JSON string arguments for the functions
148
- */
149
- arguments: string;
150
- };
1312
+ export function deploymentInvokeRetrievalsFromJSON(
1313
+ jsonString: string,
1314
+ ): SafeParseResult<DeploymentInvokeRetrievals, SDKValidationError> {
1315
+ return safeParse(
1316
+ jsonString,
1317
+ (x) => DeploymentInvokeRetrievals$inboundSchema.parse(JSON.parse(x)),
1318
+ `Failed to parse 'DeploymentInvokeRetrievals' from JSON`,
1319
+ );
1320
+ }
151
1321
 
152
- export type DeploymentInvokeMessageToolCalls = {
153
- id?: string | undefined;
154
- index?: number | undefined;
155
- type: DeploymentInvokeMessageType;
156
- function: DeploymentInvokeMessageFunction;
157
- };
1322
+ /** @internal */
1323
+ export const DeploymentInvokeData$inboundSchema: z.ZodType<
1324
+ DeploymentInvokeData,
1325
+ z.ZodTypeDef,
1326
+ unknown
1327
+ > = z.object({
1328
+ id: z.string().optional(),
1329
+ created: z.string().datetime({ offset: true }).transform(v => new Date(v))
1330
+ .optional(),
1331
+ object: DeploymentInvokeDeploymentsObject$inboundSchema.optional(),
1332
+ model: z.string().optional(),
1333
+ provider: DeploymentInvokeDeploymentsProvider$inboundSchema.optional(),
1334
+ is_final: z.boolean().optional(),
1335
+ integration_id: z.string().optional(),
1336
+ finalized: z.string().datetime({ offset: true }).transform(v => new Date(v))
1337
+ .optional(),
1338
+ system_fingerprint: z.nullable(z.string()).optional(),
1339
+ choices: z.array(
1340
+ z.lazy(() => DeploymentInvokeDeploymentsChoices$inboundSchema),
1341
+ ).optional(),
1342
+ retrievals: z.array(z.lazy(() => DeploymentInvokeRetrievals$inboundSchema))
1343
+ .optional(),
1344
+ provider_response: z.any().optional(),
1345
+ }).transform((v) => {
1346
+ return remap$(v, {
1347
+ "is_final": "isFinal",
1348
+ "integration_id": "integrationId",
1349
+ "system_fingerprint": "systemFingerprint",
1350
+ "provider_response": "providerResponse",
1351
+ });
1352
+ });
158
1353
 
159
- export type DeploymentInvokeMessage1 = {
160
- /**
161
- * The role of the prompt message
162
- */
163
- role: DeploymentInvokeMessageDeploymentsResponseRole;
164
- content?: string | null | undefined;
165
- toolCalls: Array<DeploymentInvokeMessageToolCalls>;
1354
+ /** @internal */
1355
+ export type DeploymentInvokeData$Outbound = {
1356
+ id?: string | undefined;
1357
+ created?: string | undefined;
1358
+ object?: string | undefined;
1359
+ model?: string | undefined;
1360
+ provider?: string | undefined;
1361
+ is_final?: boolean | undefined;
1362
+ integration_id?: string | undefined;
1363
+ finalized?: string | undefined;
1364
+ system_fingerprint?: string | null | undefined;
1365
+ choices?: Array<DeploymentInvokeDeploymentsChoices$Outbound> | undefined;
1366
+ retrievals?: Array<DeploymentInvokeRetrievals$Outbound> | undefined;
1367
+ provider_response?: any | undefined;
166
1368
  };
167
1369
 
168
- export type DeploymentInvokeMessage =
169
- | DeploymentInvokeMessage2
170
- | Message3
171
- | DeploymentInvokeMessage1;
172
-
173
- export type DeploymentInvokeChoices = {
174
- index: number;
175
- message?:
176
- | DeploymentInvokeMessage2
177
- | Message3
178
- | DeploymentInvokeMessage1
179
- | undefined;
180
- finishReason?: string | null | undefined;
181
- };
1370
+ /** @internal */
1371
+ export const DeploymentInvokeData$outboundSchema: z.ZodType<
1372
+ DeploymentInvokeData$Outbound,
1373
+ z.ZodTypeDef,
1374
+ DeploymentInvokeData
1375
+ > = z.object({
1376
+ id: z.string().optional(),
1377
+ created: z.date().transform(v => v.toISOString()).optional(),
1378
+ object: DeploymentInvokeDeploymentsObject$outboundSchema.optional(),
1379
+ model: z.string().optional(),
1380
+ provider: DeploymentInvokeDeploymentsProvider$outboundSchema.optional(),
1381
+ isFinal: z.boolean().optional(),
1382
+ integrationId: z.string().optional(),
1383
+ finalized: z.date().transform(v => v.toISOString()).optional(),
1384
+ systemFingerprint: z.nullable(z.string()).optional(),
1385
+ choices: z.array(
1386
+ z.lazy(() => DeploymentInvokeDeploymentsChoices$outboundSchema),
1387
+ ).optional(),
1388
+ retrievals: z.array(z.lazy(() => DeploymentInvokeRetrievals$outboundSchema))
1389
+ .optional(),
1390
+ providerResponse: z.any().optional(),
1391
+ }).transform((v) => {
1392
+ return remap$(v, {
1393
+ isFinal: "is_final",
1394
+ integrationId: "integration_id",
1395
+ systemFingerprint: "system_fingerprint",
1396
+ providerResponse: "provider_response",
1397
+ });
1398
+ });
182
1399
 
183
1400
  /**
184
- * Metadata of the retrieved chunk from the knowledge base
1401
+ * @internal
1402
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
185
1403
  */
186
- export type DeploymentInvokeMetadata = {
187
- /**
188
- * Name of the file
189
- */
190
- fileName: string;
191
- /**
192
- * Page number of the chunk
193
- */
194
- pageNumber: number | null;
195
- /**
196
- * Type of the file
197
- */
198
- fileType: string;
199
- /**
200
- * Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45
201
- */
202
- rerankScore?: number | undefined;
203
- /**
204
- * Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query.
205
- */
206
- searchScore: number;
207
- };
1404
+ export namespace DeploymentInvokeData$ {
1405
+ /** @deprecated use `DeploymentInvokeData$inboundSchema` instead. */
1406
+ export const inboundSchema = DeploymentInvokeData$inboundSchema;
1407
+ /** @deprecated use `DeploymentInvokeData$outboundSchema` instead. */
1408
+ export const outboundSchema = DeploymentInvokeData$outboundSchema;
1409
+ /** @deprecated use `DeploymentInvokeData$Outbound` instead. */
1410
+ export type Outbound = DeploymentInvokeData$Outbound;
1411
+ }
208
1412
 
209
- export type Retrievals = {
210
- /**
211
- * Content of the retrieved chunk from the knowledge base
212
- */
213
- document: string;
214
- /**
215
- * Metadata of the retrieved chunk from the knowledge base
216
- */
217
- metadata: DeploymentInvokeMetadata;
218
- };
1413
+ export function deploymentInvokeDataToJSON(
1414
+ deploymentInvokeData: DeploymentInvokeData,
1415
+ ): string {
1416
+ return JSON.stringify(
1417
+ DeploymentInvokeData$outboundSchema.parse(deploymentInvokeData),
1418
+ );
1419
+ }
219
1420
 
220
- /**
221
- * Response from the gateway
222
- */
223
- export type DeploymentInvokeResponseBody = {
224
- /**
225
- * A unique identifier for the response. Can be used to add metrics to the transaction.
226
- */
227
- id: string;
228
- /**
229
- * A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601
230
- */
231
- created: Date;
232
- /**
233
- * Indicates the type of model used to generate the response
234
- */
235
- object: DeploymentInvokeObject;
236
- /**
237
- * The model used to generate the response
238
- */
239
- model: string;
240
- /**
241
- * The provider used to generate the response
242
- */
243
- provider: DeploymentInvokeProvider;
244
- /**
245
- * Indicates if the response is the final response
246
- */
247
- isFinal: boolean;
248
- /**
249
- * Indicates integration id used to generate the response
250
- */
251
- integrationId?: string | undefined;
252
- /**
253
- * A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601
254
- */
255
- finalized?: Date | undefined;
256
- /**
257
- * Provider backed system fingerprint.
258
- */
259
- systemFingerprint?: string | null | undefined;
260
- /**
261
- * A list of choices generated by the model
262
- */
263
- choices: Array<DeploymentInvokeChoices>;
264
- /**
265
- * List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`.
266
- */
267
- retrievals?: Array<Retrievals> | undefined;
268
- /**
269
- * Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`.
270
- */
271
- providerResponse?: any | undefined;
272
- };
1421
+ export function deploymentInvokeDataFromJSON(
1422
+ jsonString: string,
1423
+ ): SafeParseResult<DeploymentInvokeData, SDKValidationError> {
1424
+ return safeParse(
1425
+ jsonString,
1426
+ (x) => DeploymentInvokeData$inboundSchema.parse(JSON.parse(x)),
1427
+ `Failed to parse 'DeploymentInvokeData' from JSON`,
1428
+ );
1429
+ }
273
1430
 
274
1431
  /** @internal */
275
- export const DeploymentInvokeGlobals$inboundSchema: z.ZodType<
276
- DeploymentInvokeGlobals,
1432
+ export const DeploymentInvokeDeploymentsResponseBody$inboundSchema: z.ZodType<
1433
+ DeploymentInvokeDeploymentsResponseBody,
277
1434
  z.ZodTypeDef,
278
1435
  unknown
279
1436
  > = z.object({
280
- environment: z.string().optional(),
281
- contactId: z.string().optional(),
1437
+ data: z.string().transform((v, ctx) => {
1438
+ try {
1439
+ return JSON.parse(v);
1440
+ } catch (err) {
1441
+ ctx.addIssue({
1442
+ code: z.ZodIssueCode.custom,
1443
+ message: `malformed json: ${err}`,
1444
+ });
1445
+ return z.NEVER;
1446
+ }
1447
+ }).pipe(z.lazy(() => DeploymentInvokeData$inboundSchema).optional()),
282
1448
  });
283
1449
 
284
1450
  /** @internal */
285
- export type DeploymentInvokeGlobals$Outbound = {
286
- environment?: string | undefined;
287
- contactId?: string | undefined;
1451
+ export type DeploymentInvokeDeploymentsResponseBody$Outbound = {
1452
+ data?: DeploymentInvokeData$Outbound | undefined;
288
1453
  };
289
1454
 
290
1455
  /** @internal */
291
- export const DeploymentInvokeGlobals$outboundSchema: z.ZodType<
292
- DeploymentInvokeGlobals$Outbound,
1456
+ export const DeploymentInvokeDeploymentsResponseBody$outboundSchema: z.ZodType<
1457
+ DeploymentInvokeDeploymentsResponseBody$Outbound,
293
1458
  z.ZodTypeDef,
294
- DeploymentInvokeGlobals
1459
+ DeploymentInvokeDeploymentsResponseBody
295
1460
  > = z.object({
296
- environment: z.string().optional(),
297
- contactId: z.string().optional(),
1461
+ data: z.lazy(() => DeploymentInvokeData$outboundSchema).optional(),
298
1462
  });
299
1463
 
300
1464
  /**
301
1465
  * @internal
302
1466
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
303
1467
  */
304
- export namespace DeploymentInvokeGlobals$ {
305
- /** @deprecated use `DeploymentInvokeGlobals$inboundSchema` instead. */
306
- export const inboundSchema = DeploymentInvokeGlobals$inboundSchema;
307
- /** @deprecated use `DeploymentInvokeGlobals$outboundSchema` instead. */
308
- export const outboundSchema = DeploymentInvokeGlobals$outboundSchema;
309
- /** @deprecated use `DeploymentInvokeGlobals$Outbound` instead. */
310
- export type Outbound = DeploymentInvokeGlobals$Outbound;
1468
+ export namespace DeploymentInvokeDeploymentsResponseBody$ {
1469
+ /** @deprecated use `DeploymentInvokeDeploymentsResponseBody$inboundSchema` instead. */
1470
+ export const inboundSchema =
1471
+ DeploymentInvokeDeploymentsResponseBody$inboundSchema;
1472
+ /** @deprecated use `DeploymentInvokeDeploymentsResponseBody$outboundSchema` instead. */
1473
+ export const outboundSchema =
1474
+ DeploymentInvokeDeploymentsResponseBody$outboundSchema;
1475
+ /** @deprecated use `DeploymentInvokeDeploymentsResponseBody$Outbound` instead. */
1476
+ export type Outbound = DeploymentInvokeDeploymentsResponseBody$Outbound;
311
1477
  }
312
1478
 
313
- export function deploymentInvokeGlobalsToJSON(
314
- deploymentInvokeGlobals: DeploymentInvokeGlobals,
1479
+ export function deploymentInvokeDeploymentsResponseBodyToJSON(
1480
+ deploymentInvokeDeploymentsResponseBody:
1481
+ DeploymentInvokeDeploymentsResponseBody,
315
1482
  ): string {
316
1483
  return JSON.stringify(
317
- DeploymentInvokeGlobals$outboundSchema.parse(deploymentInvokeGlobals),
1484
+ DeploymentInvokeDeploymentsResponseBody$outboundSchema.parse(
1485
+ deploymentInvokeDeploymentsResponseBody,
1486
+ ),
318
1487
  );
319
1488
  }
320
1489
 
321
- export function deploymentInvokeGlobalsFromJSON(
1490
+ export function deploymentInvokeDeploymentsResponseBodyFromJSON(
322
1491
  jsonString: string,
323
- ): SafeParseResult<DeploymentInvokeGlobals, SDKValidationError> {
1492
+ ): SafeParseResult<
1493
+ DeploymentInvokeDeploymentsResponseBody,
1494
+ SDKValidationError
1495
+ > {
324
1496
  return safeParse(
325
1497
  jsonString,
326
- (x) => DeploymentInvokeGlobals$inboundSchema.parse(JSON.parse(x)),
327
- `Failed to parse 'DeploymentInvokeGlobals' from JSON`,
1498
+ (x) =>
1499
+ DeploymentInvokeDeploymentsResponseBody$inboundSchema.parse(
1500
+ JSON.parse(x),
1501
+ ),
1502
+ `Failed to parse 'DeploymentInvokeDeploymentsResponseBody' from JSON`,
328
1503
  );
329
1504
  }
330
1505
 
@@ -1142,3 +2317,69 @@ export function deploymentInvokeResponseBodyFromJSON(
1142
2317
  `Failed to parse 'DeploymentInvokeResponseBody' from JSON`,
1143
2318
  );
1144
2319
  }
2320
+
2321
+ /** @internal */
2322
+ export const DeploymentInvokeResponse$inboundSchema: z.ZodType<
2323
+ DeploymentInvokeResponse,
2324
+ z.ZodTypeDef,
2325
+ unknown
2326
+ > = z.union([
2327
+ z.lazy(() => DeploymentInvokeResponseBody$inboundSchema),
2328
+ z.instanceof(ReadableStream<Uint8Array>).transform(stream => {
2329
+ return new EventStream({
2330
+ stream,
2331
+ decoder(rawEvent) {
2332
+ const schema = z.lazy(() =>
2333
+ DeploymentInvokeDeploymentsResponseBody$inboundSchema
2334
+ );
2335
+ return schema.parse(rawEvent);
2336
+ },
2337
+ });
2338
+ }),
2339
+ ]);
2340
+
2341
+ /** @internal */
2342
+ export type DeploymentInvokeResponse$Outbound =
2343
+ | DeploymentInvokeResponseBody$Outbound
2344
+ | never;
2345
+
2346
+ /** @internal */
2347
+ export const DeploymentInvokeResponse$outboundSchema: z.ZodType<
2348
+ DeploymentInvokeResponse$Outbound,
2349
+ z.ZodTypeDef,
2350
+ DeploymentInvokeResponse
2351
+ > = z.union([
2352
+ z.lazy(() => DeploymentInvokeResponseBody$outboundSchema),
2353
+ z.never(),
2354
+ ]);
2355
+
2356
+ /**
2357
+ * @internal
2358
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2359
+ */
2360
+ export namespace DeploymentInvokeResponse$ {
2361
+ /** @deprecated use `DeploymentInvokeResponse$inboundSchema` instead. */
2362
+ export const inboundSchema = DeploymentInvokeResponse$inboundSchema;
2363
+ /** @deprecated use `DeploymentInvokeResponse$outboundSchema` instead. */
2364
+ export const outboundSchema = DeploymentInvokeResponse$outboundSchema;
2365
+ /** @deprecated use `DeploymentInvokeResponse$Outbound` instead. */
2366
+ export type Outbound = DeploymentInvokeResponse$Outbound;
2367
+ }
2368
+
2369
+ export function deploymentInvokeResponseToJSON(
2370
+ deploymentInvokeResponse: DeploymentInvokeResponse,
2371
+ ): string {
2372
+ return JSON.stringify(
2373
+ DeploymentInvokeResponse$outboundSchema.parse(deploymentInvokeResponse),
2374
+ );
2375
+ }
2376
+
2377
+ export function deploymentInvokeResponseFromJSON(
2378
+ jsonString: string,
2379
+ ): SafeParseResult<DeploymentInvokeResponse, SDKValidationError> {
2380
+ return safeParse(
2381
+ jsonString,
2382
+ (x) => DeploymentInvokeResponse$inboundSchema.parse(JSON.parse(x)),
2383
+ `Failed to parse 'DeploymentInvokeResponse' from JSON`,
2384
+ );
2385
+ }