@orq-ai/node 3.0.0-rc.19 → 3.1.0-rc.26

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 (379) hide show
  1. package/README.md +29 -40
  2. package/RUNTIMES.md +27 -1
  3. package/docs/sdks/deployments/README.md +86 -9
  4. package/docs/sdks/files/README.md +2 -170
  5. package/docs/sdks/orq/README.md +1 -1
  6. package/docs/sdks/prompts/README.md +97 -181
  7. package/docs/sdks/promptsnippets/README.md +463 -0
  8. package/funcs/contactsCreate.d.ts.map +1 -1
  9. package/funcs/contactsCreate.js +12 -7
  10. package/funcs/contactsCreate.js.map +1 -1
  11. package/funcs/deploymentsGetConfig.d.ts.map +1 -1
  12. package/funcs/deploymentsGetConfig.js +12 -7
  13. package/funcs/deploymentsGetConfig.js.map +1 -1
  14. package/funcs/deploymentsInvoke.d.ts +1 -7
  15. package/funcs/deploymentsInvoke.d.ts.map +1 -1
  16. package/funcs/deploymentsInvoke.js +17 -17
  17. package/funcs/deploymentsInvoke.js.map +1 -1
  18. package/funcs/{deploymentsAll.d.ts → deploymentsList.d.ts} +2 -2
  19. package/funcs/deploymentsList.d.ts.map +1 -0
  20. package/funcs/{deploymentsAll.js → deploymentsList.js} +18 -12
  21. package/funcs/deploymentsList.js.map +1 -0
  22. package/funcs/deploymentsMetricsCreate.d.ts.map +1 -1
  23. package/funcs/deploymentsMetricsCreate.js +12 -7
  24. package/funcs/deploymentsMetricsCreate.js.map +1 -1
  25. package/funcs/deploymentsStream.d.ts +16 -0
  26. package/funcs/deploymentsStream.d.ts.map +1 -0
  27. package/funcs/deploymentsStream.js +125 -0
  28. package/funcs/deploymentsStream.js.map +1 -0
  29. package/funcs/feedbackCreate.d.ts.map +1 -1
  30. package/funcs/feedbackCreate.js +12 -7
  31. package/funcs/feedbackCreate.js.map +1 -1
  32. package/funcs/filesDelete.d.ts.map +1 -1
  33. package/funcs/filesDelete.js +12 -7
  34. package/funcs/filesDelete.js.map +1 -1
  35. package/funcs/filesGet.d.ts.map +1 -1
  36. package/funcs/filesGet.js +12 -7
  37. package/funcs/filesGet.js.map +1 -1
  38. package/funcs/filesList.d.ts.map +1 -1
  39. package/funcs/filesList.js +16 -11
  40. package/funcs/filesList.js.map +1 -1
  41. package/funcs/filesUpload.d.ts.map +1 -1
  42. package/funcs/filesUpload.js +22 -16
  43. package/funcs/filesUpload.js.map +1 -1
  44. package/funcs/{promptsCreateVersion.d.ts → promptSnippetsCreate.d.ts} +3 -3
  45. package/funcs/promptSnippetsCreate.d.ts.map +1 -0
  46. package/funcs/{promptsGetAll.js → promptSnippetsCreate.js} +19 -14
  47. package/funcs/promptSnippetsCreate.js.map +1 -0
  48. package/funcs/{filesUpdate.d.ts → promptSnippetsDelete.d.ts} +3 -3
  49. package/funcs/{promptsCreateVersion.d.ts.map → promptSnippetsDelete.d.ts.map} +1 -1
  50. package/funcs/{promptsDuplicate.js → promptSnippetsDelete.js} +20 -15
  51. package/funcs/promptSnippetsDelete.js.map +1 -0
  52. package/funcs/{promptsGetAll.d.ts → promptSnippetsGet.d.ts} +3 -3
  53. package/funcs/promptSnippetsGet.d.ts.map +1 -0
  54. package/funcs/{promptSnippetsFindOne.js → promptSnippetsGet.js} +18 -13
  55. package/funcs/promptSnippetsGet.js.map +1 -0
  56. package/funcs/{promptSnippetsFindOne.d.ts → promptSnippetsGetByKey.d.ts} +3 -3
  57. package/funcs/promptSnippetsGetByKey.d.ts.map +1 -0
  58. package/funcs/promptSnippetsGetByKey.js +113 -0
  59. package/funcs/promptSnippetsGetByKey.js.map +1 -0
  60. package/funcs/promptSnippetsUpdate.d.ts +13 -0
  61. package/funcs/promptSnippetsUpdate.d.ts.map +1 -0
  62. package/funcs/{promptsCreateVersion.js → promptSnippetsUpdate.js} +25 -16
  63. package/funcs/promptSnippetsUpdate.js.map +1 -0
  64. package/funcs/promptsCreate.d.ts +1 -1
  65. package/funcs/promptsCreate.d.ts.map +1 -1
  66. package/funcs/promptsCreate.js +14 -9
  67. package/funcs/promptsCreate.js.map +1 -1
  68. package/funcs/promptsDelete.d.ts.map +1 -1
  69. package/funcs/promptsDelete.js +13 -8
  70. package/funcs/promptsDelete.js.map +1 -1
  71. package/funcs/{promptsGetOne.d.ts → promptsGet.d.ts} +3 -3
  72. package/funcs/promptsGet.d.ts.map +1 -0
  73. package/funcs/{promptsGetOne.js → promptsGet.js} +17 -12
  74. package/funcs/promptsGet.js.map +1 -0
  75. package/funcs/{promptsDuplicate.d.ts → promptsList.d.ts} +3 -3
  76. package/funcs/promptsList.d.ts.map +1 -0
  77. package/funcs/promptsList.js +113 -0
  78. package/funcs/promptsList.js.map +1 -0
  79. package/funcs/promptsUpdate.d.ts.map +1 -1
  80. package/funcs/promptsUpdate.js +13 -8
  81. package/funcs/promptsUpdate.js.map +1 -1
  82. package/funcs/remoteconfigGetConfig.d.ts.map +1 -1
  83. package/funcs/remoteconfigGetConfig.js +12 -7
  84. package/funcs/remoteconfigGetConfig.js.map +1 -1
  85. package/hooks/global.d.ts +5 -0
  86. package/hooks/global.d.ts.map +1 -0
  87. package/hooks/global.js +35 -0
  88. package/hooks/global.js.map +1 -0
  89. package/hooks/registration.d.ts.map +1 -1
  90. package/hooks/registration.js +2 -1
  91. package/hooks/registration.js.map +1 -1
  92. package/jsr.json +28 -0
  93. package/lib/config.d.ts +12 -4
  94. package/lib/config.d.ts.map +1 -1
  95. package/lib/config.js +5 -6
  96. package/lib/config.js.map +1 -1
  97. package/lib/encodings.d.ts +10 -9
  98. package/lib/encodings.d.ts.map +1 -1
  99. package/lib/encodings.js +91 -66
  100. package/lib/encodings.js.map +1 -1
  101. package/lib/env.d.ts +13 -0
  102. package/lib/env.d.ts.map +1 -1
  103. package/lib/env.js +18 -2
  104. package/lib/env.js.map +1 -1
  105. package/lib/event-streams.js +2 -3
  106. package/lib/event-streams.js.map +1 -1
  107. package/lib/http.js +1 -2
  108. package/lib/http.js.map +1 -1
  109. package/lib/matchers.js +5 -6
  110. package/lib/matchers.js.map +1 -1
  111. package/lib/primitives.d.ts +1 -0
  112. package/lib/primitives.d.ts.map +1 -1
  113. package/lib/primitives.js +11 -1
  114. package/lib/primitives.js.map +1 -1
  115. package/lib/retries.js +3 -5
  116. package/lib/retries.js.map +1 -1
  117. package/lib/schemas.d.ts +1 -1
  118. package/lib/schemas.d.ts.map +1 -1
  119. package/lib/schemas.js +4 -1
  120. package/lib/schemas.js.map +1 -1
  121. package/lib/sdks.d.ts.map +1 -1
  122. package/lib/sdks.js +20 -18
  123. package/lib/sdks.js.map +1 -1
  124. package/lib/security.js +2 -3
  125. package/lib/security.js.map +1 -1
  126. package/lib/url.js +1 -1
  127. package/lib/url.js.map +1 -1
  128. package/models/errors/httpclienterrors.js +2 -2
  129. package/models/errors/httpclienterrors.js.map +1 -1
  130. package/models/errors/index.d.ts +1 -0
  131. package/models/errors/index.d.ts.map +1 -1
  132. package/models/errors/index.js +1 -0
  133. package/models/errors/index.js.map +1 -1
  134. package/models/errors/updatepromptsnippet.d.ts +36 -0
  135. package/models/errors/updatepromptsnippet.d.ts.map +1 -0
  136. package/models/{operations/duplicateprompt.js → errors/updatepromptsnippet.js} +33 -23
  137. package/models/errors/updatepromptsnippet.js.map +1 -0
  138. package/models/operations/createcontact.d.ts +25 -0
  139. package/models/operations/createcontact.d.ts.map +1 -1
  140. package/models/operations/createcontact.js +30 -3
  141. package/models/operations/createcontact.js.map +1 -1
  142. package/models/operations/createfeedback.d.ts +25 -0
  143. package/models/operations/createfeedback.d.ts.map +1 -1
  144. package/models/operations/createfeedback.js +28 -1
  145. package/models/operations/createfeedback.js.map +1 -1
  146. package/models/operations/createprompt.d.ts +2199 -748
  147. package/models/operations/createprompt.d.ts.map +1 -1
  148. package/models/operations/createprompt.js +1628 -486
  149. package/models/operations/createprompt.js.map +1 -1
  150. package/models/operations/createpromptsnippet.d.ts +3490 -0
  151. package/models/operations/createpromptsnippet.d.ts.map +1 -0
  152. package/models/operations/createpromptsnippet.js +3018 -0
  153. package/models/operations/createpromptsnippet.js.map +1 -0
  154. package/models/operations/deleteprompt.d.ts +25 -0
  155. package/models/operations/deleteprompt.d.ts.map +1 -1
  156. package/models/operations/deleteprompt.js +28 -1
  157. package/models/operations/deleteprompt.js.map +1 -1
  158. package/models/operations/deletepromptsnippet.d.ts +57 -0
  159. package/models/operations/deletepromptsnippet.d.ts.map +1 -0
  160. package/models/operations/deletepromptsnippet.js +96 -0
  161. package/models/operations/deletepromptsnippet.js.map +1 -0
  162. package/models/operations/deploymentcreatemetric.d.ts +25 -0
  163. package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
  164. package/models/operations/deploymentcreatemetric.js +29 -2
  165. package/models/operations/deploymentcreatemetric.js.map +1 -1
  166. package/models/operations/deploymentgetconfig.d.ts +25 -0
  167. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  168. package/models/operations/deploymentgetconfig.js +31 -4
  169. package/models/operations/deploymentgetconfig.js.map +1 -1
  170. package/models/operations/deploymentinvoke.d.ts +23 -683
  171. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  172. package/models/operations/deploymentinvoke.js +23 -614
  173. package/models/operations/deploymentinvoke.js.map +1 -1
  174. package/models/operations/deployments.d.ts +40 -8
  175. package/models/operations/deployments.d.ts.map +1 -1
  176. package/models/operations/deployments.js +46 -13
  177. package/models/operations/deployments.js.map +1 -1
  178. package/models/operations/deploymentstream.d.ts +1622 -0
  179. package/models/operations/deploymentstream.d.ts.map +1 -0
  180. package/models/operations/deploymentstream.js +1571 -0
  181. package/models/operations/deploymentstream.js.map +1 -0
  182. package/models/operations/filedelete.d.ts +25 -0
  183. package/models/operations/filedelete.d.ts.map +1 -1
  184. package/models/operations/filedelete.js +28 -1
  185. package/models/operations/filedelete.js.map +1 -1
  186. package/models/operations/fileget.d.ts +25 -0
  187. package/models/operations/fileget.d.ts.map +1 -1
  188. package/models/operations/fileget.js +30 -3
  189. package/models/operations/fileget.js.map +1 -1
  190. package/models/operations/filelist.d.ts +26 -5
  191. package/models/operations/filelist.d.ts.map +1 -1
  192. package/models/operations/filelist.js +32 -13
  193. package/models/operations/filelist.js.map +1 -1
  194. package/models/operations/fileupload.d.ts +25 -0
  195. package/models/operations/fileupload.d.ts.map +1 -1
  196. package/models/operations/fileupload.js +30 -3
  197. package/models/operations/fileupload.js.map +1 -1
  198. package/models/operations/findonebykeypromptsnippet.d.ts +2405 -0
  199. package/models/operations/findonebykeypromptsnippet.d.ts.map +1 -0
  200. package/models/operations/findonebykeypromptsnippet.js +2113 -0
  201. package/models/operations/findonebykeypromptsnippet.js.map +1 -0
  202. package/models/operations/findonepromptsnippet.d.ts +891 -4764
  203. package/models/operations/findonepromptsnippet.d.ts.map +1 -1
  204. package/models/operations/findonepromptsnippet.js +966 -4752
  205. package/models/operations/findonepromptsnippet.js.map +1 -1
  206. package/models/operations/getallprompts.d.ts +907 -9115
  207. package/models/operations/getallprompts.d.ts.map +1 -1
  208. package/models/operations/getallprompts.js +923 -8166
  209. package/models/operations/getallprompts.js.map +1 -1
  210. package/models/operations/getoneprompt.d.ts +25 -0
  211. package/models/operations/getoneprompt.d.ts.map +1 -1
  212. package/models/operations/getoneprompt.js +28 -1
  213. package/models/operations/getoneprompt.js.map +1 -1
  214. package/models/operations/index.d.ts +5 -5
  215. package/models/operations/index.d.ts.map +1 -1
  216. package/models/operations/index.js +5 -5
  217. package/models/operations/index.js.map +1 -1
  218. package/models/operations/remoteconfigsgetconfig.d.ts +25 -0
  219. package/models/operations/remoteconfigsgetconfig.d.ts.map +1 -1
  220. package/models/operations/remoteconfigsgetconfig.js +28 -1
  221. package/models/operations/remoteconfigsgetconfig.js.map +1 -1
  222. package/models/operations/updateprompt.d.ts +1363 -5103
  223. package/models/operations/updateprompt.d.ts.map +1 -1
  224. package/models/operations/updateprompt.js +1020 -4666
  225. package/models/operations/updateprompt.js.map +1 -1
  226. package/models/operations/updatepromptsnippet.d.ts +3518 -0
  227. package/models/operations/updatepromptsnippet.d.ts.map +1 -0
  228. package/models/operations/updatepromptsnippet.js +3076 -0
  229. package/models/operations/updatepromptsnippet.js.map +1 -0
  230. package/package.json +6 -7
  231. package/sdk/deployments.d.ts +10 -6
  232. package/sdk/deployments.d.ts.map +1 -1
  233. package/sdk/deployments.js +15 -8
  234. package/sdk/deployments.js.map +1 -1
  235. package/sdk/files.d.ts +0 -11
  236. package/sdk/files.d.ts.map +1 -1
  237. package/sdk/files.js +0 -17
  238. package/sdk/files.js.map +1 -1
  239. package/sdk/prompts.d.ts +7 -15
  240. package/sdk/prompts.d.ts.map +1 -1
  241. package/sdk/prompts.js +12 -26
  242. package/sdk/prompts.js.map +1 -1
  243. package/sdk/promptsnippets.d.ts +25 -0
  244. package/sdk/promptsnippets.d.ts.map +1 -0
  245. package/sdk/promptsnippets.js +47 -0
  246. package/sdk/promptsnippets.js.map +1 -0
  247. package/sdk/sdk.d.ts +3 -3
  248. package/sdk/sdk.d.ts.map +1 -1
  249. package/sdk/sdk.js +9 -16
  250. package/sdk/sdk.js.map +1 -1
  251. package/src/funcs/contactsCreate.ts +10 -4
  252. package/src/funcs/deploymentsGetConfig.ts +10 -4
  253. package/src/funcs/deploymentsInvoke.ts +26 -19
  254. package/src/funcs/{deploymentsAll.ts → deploymentsList.ts} +13 -6
  255. package/src/funcs/deploymentsMetricsCreate.ts +9 -3
  256. package/src/funcs/deploymentsStream.ts +150 -0
  257. package/src/funcs/feedbackCreate.ts +10 -4
  258. package/src/funcs/filesDelete.ts +9 -3
  259. package/src/funcs/filesGet.ts +9 -3
  260. package/src/funcs/filesList.ts +10 -4
  261. package/src/funcs/filesUpload.ts +15 -7
  262. package/src/funcs/{promptsCreateVersion.ts → promptSnippetsCreate.ts} +23 -20
  263. package/src/funcs/{promptsDuplicate.ts → promptSnippetsDelete.ts} +17 -10
  264. package/src/funcs/{promptSnippetsFindOne.ts → promptSnippetsGet.ts} +13 -7
  265. package/src/funcs/promptSnippetsGetByKey.ts +136 -0
  266. package/src/funcs/{filesUpdate.ts → promptSnippetsUpdate.ts} +29 -14
  267. package/src/funcs/promptsCreate.ts +12 -6
  268. package/src/funcs/promptsDelete.ts +10 -4
  269. package/src/funcs/{promptsGetOne.ts → promptsGet.ts} +12 -6
  270. package/src/funcs/{promptsGetAll.ts → promptsList.ts} +24 -16
  271. package/src/funcs/promptsUpdate.ts +10 -4
  272. package/src/funcs/remoteconfigGetConfig.ts +10 -4
  273. package/src/hooks/global.ts +38 -0
  274. package/src/hooks/registration.ts +2 -1
  275. package/src/lib/config.ts +14 -4
  276. package/src/lib/encodings.ts +95 -61
  277. package/src/lib/env.ts +32 -0
  278. package/src/lib/primitives.ts +14 -0
  279. package/src/lib/retries.ts +0 -1
  280. package/src/lib/schemas.ts +5 -0
  281. package/src/lib/sdks.ts +6 -3
  282. package/src/lib/security.ts +1 -1
  283. package/src/models/errors/index.ts +1 -0
  284. package/src/models/errors/updatepromptsnippet.ts +71 -0
  285. package/src/models/operations/createcontact.ts +60 -2
  286. package/src/models/operations/createfeedback.ts +58 -0
  287. package/src/models/operations/createprompt.ts +3795 -1345
  288. package/src/models/operations/createpromptsnippet.ts +6189 -0
  289. package/src/models/operations/deleteprompt.ts +58 -0
  290. package/src/models/operations/deletepromptsnippet.ts +127 -0
  291. package/src/models/operations/deploymentcreatemetric.ts +60 -0
  292. package/src/models/operations/deploymentgetconfig.ts +58 -0
  293. package/src/models/operations/deploymentinvoke.ts +182 -1423
  294. package/src/models/operations/deployments.ts +83 -18
  295. package/src/models/operations/deploymentstream.ts +3062 -0
  296. package/src/models/operations/filedelete.ts +58 -0
  297. package/src/models/operations/fileget.ts +56 -2
  298. package/src/models/operations/filelist.ts +61 -17
  299. package/src/models/operations/fileupload.ts +60 -2
  300. package/src/models/operations/findonebykeypromptsnippet.ts +4461 -0
  301. package/src/models/operations/findonepromptsnippet.ts +1779 -11084
  302. package/src/models/operations/getallprompts.ts +1595 -16105
  303. package/src/models/operations/getoneprompt.ts +58 -0
  304. package/src/models/operations/index.ts +5 -5
  305. package/src/models/operations/remoteconfigsgetconfig.ts +60 -0
  306. package/src/models/operations/updateprompt.ts +2571 -10999
  307. package/src/models/operations/updatepromptsnippet.ts +6483 -0
  308. package/src/sdk/deployments.ts +25 -11
  309. package/src/sdk/files.ts +0 -33
  310. package/src/sdk/prompts.ts +15 -45
  311. package/src/sdk/promptsnippets.ts +84 -0
  312. package/src/sdk/sdk.ts +4 -4
  313. package/tsconfig.json +41 -0
  314. package/docs/sdks/prompt/README.md +0 -6
  315. package/docs/sdks/snippets/README.md +0 -84
  316. package/docs/sdks/templates/README.md +0 -80
  317. package/funcs/deploymentsAll.d.ts.map +0 -1
  318. package/funcs/deploymentsAll.js.map +0 -1
  319. package/funcs/filesBulkUpload.d.ts +0 -15
  320. package/funcs/filesBulkUpload.d.ts.map +0 -1
  321. package/funcs/filesBulkUpload.js +0 -107
  322. package/funcs/filesBulkUpload.js.map +0 -1
  323. package/funcs/filesUpdate.d.ts.map +0 -1
  324. package/funcs/filesUpdate.js +0 -109
  325. package/funcs/filesUpdate.js.map +0 -1
  326. package/funcs/promptSnippetsFindOne.d.ts.map +0 -1
  327. package/funcs/promptSnippetsFindOne.js.map +0 -1
  328. package/funcs/promptTemplatesGetAll.d.ts +0 -12
  329. package/funcs/promptTemplatesGetAll.d.ts.map +0 -1
  330. package/funcs/promptTemplatesGetAll.js +0 -108
  331. package/funcs/promptTemplatesGetAll.js.map +0 -1
  332. package/funcs/promptsCreateVersion.js.map +0 -1
  333. package/funcs/promptsDuplicate.d.ts.map +0 -1
  334. package/funcs/promptsDuplicate.js.map +0 -1
  335. package/funcs/promptsGetAll.d.ts.map +0 -1
  336. package/funcs/promptsGetAll.js.map +0 -1
  337. package/funcs/promptsGetOne.d.ts.map +0 -1
  338. package/funcs/promptsGetOne.js.map +0 -1
  339. package/models/operations/bulkfileupload.d.ts +0 -173
  340. package/models/operations/bulkfileupload.d.ts.map +0 -1
  341. package/models/operations/bulkfileupload.js +0 -210
  342. package/models/operations/bulkfileupload.js.map +0 -1
  343. package/models/operations/createpromptversion.d.ts +0 -2003
  344. package/models/operations/createpromptversion.d.ts.map +0 -1
  345. package/models/operations/createpromptversion.js +0 -1852
  346. package/models/operations/createpromptversion.js.map +0 -1
  347. package/models/operations/duplicateprompt.d.ts +0 -32
  348. package/models/operations/duplicateprompt.d.ts.map +0 -1
  349. package/models/operations/duplicateprompt.js.map +0 -1
  350. package/models/operations/fileupdate.d.ts +0 -143
  351. package/models/operations/fileupdate.d.ts.map +0 -1
  352. package/models/operations/fileupdate.js +0 -193
  353. package/models/operations/fileupdate.js.map +0 -1
  354. package/models/operations/getallprompttemplates.d.ts +0 -6607
  355. package/models/operations/getallprompttemplates.d.ts.map +0 -1
  356. package/models/operations/getallprompttemplates.js +0 -6225
  357. package/models/operations/getallprompttemplates.js.map +0 -1
  358. package/sdk/prompt.d.ts +0 -10
  359. package/sdk/prompt.d.ts.map +0 -1
  360. package/sdk/prompt.js +0 -21
  361. package/sdk/prompt.js.map +0 -1
  362. package/sdk/snippets.d.ts +0 -9
  363. package/sdk/snippets.d.ts.map +0 -1
  364. package/sdk/snippets.js +0 -19
  365. package/sdk/snippets.js.map +0 -1
  366. package/sdk/templates.d.ts +0 -9
  367. package/sdk/templates.d.ts.map +0 -1
  368. package/sdk/templates.js +0 -19
  369. package/sdk/templates.js.map +0 -1
  370. package/src/funcs/filesBulkUpload.ts +0 -126
  371. package/src/funcs/promptTemplatesGetAll.ts +0 -130
  372. package/src/models/operations/bulkfileupload.ts +0 -315
  373. package/src/models/operations/createpromptversion.ts +0 -3703
  374. package/src/models/operations/duplicateprompt.ts +0 -69
  375. package/src/models/operations/fileupdate.ts +0 -298
  376. package/src/models/operations/getallprompttemplates.ts +0 -13690
  377. package/src/sdk/prompt.ts +0 -19
  378. package/src/sdk/snippets.ts +0 -24
  379. package/src/sdk/templates.ts +0 -24
package/README.md CHANGED
@@ -9,15 +9,10 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
9
9
  </a>
10
10
  </div>
11
11
 
12
-
13
- <br /><br />
14
- > [!IMPORTANT]
15
- > This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/orq/orq). Delete this section before > publishing to a package manager.
16
-
17
12
  <!-- Start Summary [summary] -->
18
13
  ## Summary
19
14
 
20
- [Dev] orq.ai API: The Orquesta API
15
+ [Dev] orq.ai API: orq.ai API documentation
21
16
 
22
17
  For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
23
18
  <!-- End Summary [summary] -->
@@ -155,9 +150,10 @@ run();
155
150
 
156
151
  ### [deployments](docs/sdks/deployments/README.md)
157
152
 
158
- * [all](docs/sdks/deployments/README.md#all) - List all deployments
153
+ * [list](docs/sdks/deployments/README.md#list) - List all deployments
159
154
  * [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
160
155
  * [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
156
+ * [stream](docs/sdks/deployments/README.md#stream) - Stream
161
157
 
162
158
  #### [deployments.metrics](docs/sdks/metrics/README.md)
163
159
 
@@ -172,31 +168,24 @@ run();
172
168
  * [upload](docs/sdks/files/README.md#upload) - Upload file
173
169
  * [list](docs/sdks/files/README.md#list) - List all files
174
170
  * [get](docs/sdks/files/README.md#get) - Get file by ID
175
- * [update](docs/sdks/files/README.md#update) - Update file name
176
171
  * [delete](docs/sdks/files/README.md#delete) - Delete file
177
- * [bulkUpload](docs/sdks/files/README.md#bulkupload) - Bulk upload file
178
-
179
-
180
- ### [prompt](docs/sdks/prompt/README.md)
181
-
182
-
183
- #### [prompt.snippets](docs/sdks/snippets/README.md)
184
172
 
185
- * [findOne](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
186
-
187
- #### [prompt.templates](docs/sdks/templates/README.md)
188
-
189
- * [getAll](docs/sdks/templates/README.md#getall) - Get all prompt templates
190
173
 
191
174
  ### [prompts](docs/sdks/prompts/README.md)
192
175
 
193
- * [create](docs/sdks/prompts/README.md#create) - Create a new prompt
194
- * [createVersion](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
195
- * [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
196
- * [getOne](docs/sdks/prompts/README.md#getone) - Get one prompt
176
+ * [create](docs/sdks/prompts/README.md#create) - Create a prompt
197
177
  * [update](docs/sdks/prompts/README.md#update) - Update a prompt
198
- * [duplicate](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
199
- * [getAll](docs/sdks/prompts/README.md#getall) - Get all prompts
178
+ * [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
179
+ * [get](docs/sdks/prompts/README.md#get) - Retrieve a prompt
180
+ * [list](docs/sdks/prompts/README.md#list) - List all prompts
181
+
182
+ ### [promptSnippets](docs/sdks/promptsnippets/README.md)
183
+
184
+ * [create](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
185
+ * [update](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
186
+ * [delete](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
187
+ * [get](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
188
+ * [getByKey](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
200
189
 
201
190
  ### [remoteconfig](docs/sdks/remoteconfig/README.md)
202
191
 
@@ -221,26 +210,26 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
221
210
  <summary>Available standalone functions</summary>
222
211
 
223
212
  - [`contactsCreate`](docs/sdks/contacts/README.md#create) - Update user information
224
- - [`deploymentsAll`](docs/sdks/deployments/README.md#all) - List all deployments
225
213
  - [`deploymentsGetConfig`](docs/sdks/deployments/README.md#getconfig) - Get config
226
214
  - [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
215
+ - [`deploymentsList`](docs/sdks/deployments/README.md#list) - List all deployments
227
216
  - [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
217
+ - [`deploymentsStream`](docs/sdks/deployments/README.md#stream) - Stream
228
218
  - [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
229
- - [`filesBulkUpload`](docs/sdks/files/README.md#bulkupload) - Bulk upload file
230
219
  - [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
231
220
  - [`filesGet`](docs/sdks/files/README.md#get) - Get file by ID
232
221
  - [`filesList`](docs/sdks/files/README.md#list) - List all files
233
- - [`filesUpdate`](docs/sdks/files/README.md#update) - Update file name
234
222
  - [`filesUpload`](docs/sdks/files/README.md#upload) - Upload file
235
- - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a new prompt
236
- - [`promptsCreateVersion`](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
223
+ - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
237
224
  - [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
238
- - [`promptsDuplicate`](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
239
- - [`promptsGetAll`](docs/sdks/prompts/README.md#getall) - Get all prompts
240
- - [`promptsGetOne`](docs/sdks/prompts/README.md#getone) - Get one prompt
241
- - [`promptSnippetsFindOne`](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
225
+ - [`promptsGet`](docs/sdks/prompts/README.md#get) - Retrieve a prompt
226
+ - [`promptsList`](docs/sdks/prompts/README.md#list) - List all prompts
227
+ - [`promptSnippetsCreate`](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
228
+ - [`promptSnippetsDelete`](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
229
+ - [`promptSnippetsGet`](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
230
+ - [`promptSnippetsGetByKey`](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
231
+ - [`promptSnippetsUpdate`](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
242
232
  - [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
243
- - [`promptTemplatesGetAll`](docs/sdks/templates/README.md#getall) - Get all prompt templates
244
233
  - [`remoteconfigGetConfig`](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
245
234
 
246
235
  </details>
@@ -263,7 +252,7 @@ const orq = new Orq({
263
252
  });
264
253
 
265
254
  async function run() {
266
- const result = await orq.deployments.invoke({
255
+ const result = await orq.deployments.stream({
267
256
  key: "<key>",
268
257
  });
269
258
 
@@ -386,7 +375,7 @@ run();
386
375
  <!-- Start Error Handling [errors] -->
387
376
  ## Error Handling
388
377
 
389
- Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `all` method may throw the following errors:
378
+ Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `list` method may throw the following errors:
390
379
 
391
380
  | Error Type | Status Code | Content Type |
392
381
  | ------------------- | ----------- | ---------------- |
@@ -406,7 +395,7 @@ const orq = new Orq({
406
395
  async function run() {
407
396
  let result;
408
397
  try {
409
- result = await orq.deployments.all();
398
+ result = await orq.deployments.list({});
410
399
 
411
400
  // Handle the result
412
401
  console.log(result);
@@ -460,7 +449,7 @@ The default server can also be overridden globally by passing a URL to the `serv
460
449
  import { Orq } from "@orq-ai/node";
461
450
 
462
451
  const orq = new Orq({
463
- serverURL: "https://my.staging.orq.ai",
452
+ serverURL: "https://my.orq.ai",
464
453
  apiKey: process.env["ORQ_API_KEY"] ?? "",
465
454
  });
466
455
 
package/RUNTIMES.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Supported JavaScript runtimes
2
2
 
3
- This SDK is intended to be used in JavaScript runtimes that support the following features:
3
+ This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
4
4
 
5
5
  * [Web Fetch API][web-fetch]
6
6
  * [Web Streams API][web-streams] and in particular `ReadableStream`
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
20
20
  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
21
21
 
22
22
  [deno-file-streaming]: https://github.com/denoland/deno/issues/11018
23
+
24
+ ## Recommended TypeScript compiler options
25
+
26
+ The following `tsconfig.json` options are recommended for projects using this
27
+ SDK in order to get static type support for features like async iterables,
28
+ streams and `fetch`-related APIs ([`for await...of`][for-await-of],
29
+ [`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
30
+ so on):
31
+
32
+ [for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
33
+ [abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
34
+ [request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
35
+ [response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
36
+
37
+ ```jsonc
38
+ {
39
+ "compilerOptions": {
40
+ "target": "es2020", // or higher
41
+ "lib": ["es2020", "dom", "dom.iterable"],
42
+ }
43
+ }
44
+ ```
45
+
46
+ While `target` can be set to older ECMAScript versions, it may result in extra,
47
+ unnecessary compatibility code being generated if you are not targeting old
48
+ runtimes.
@@ -5,11 +5,12 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
- * [all](#all) - List all deployments
8
+ * [list](#list) - List all deployments
9
9
  * [getConfig](#getconfig) - Get config
10
10
  * [invoke](#invoke) - Invoke
11
+ * [stream](#stream) - Stream
11
12
 
12
- ## all
13
+ ## list
13
14
 
14
15
  Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
15
16
 
@@ -23,7 +24,7 @@ const orq = new Orq({
23
24
  });
24
25
 
25
26
  async function run() {
26
- const result = await orq.deployments.all();
27
+ const result = await orq.deployments.list({});
27
28
 
28
29
  // Handle the result
29
30
  console.log(result);
@@ -38,7 +39,7 @@ The standalone function version of this method:
38
39
 
39
40
  ```typescript
40
41
  import { OrqCore } from "@orq-ai/node/core.js";
41
- import { deploymentsAll } from "@orq-ai/node/funcs/deploymentsAll.js";
42
+ import { deploymentsList } from "@orq-ai/node/funcs/deploymentsList.js";
42
43
 
43
44
  // Use `OrqCore` for best tree-shaking performance.
44
45
  // You can create one instance of it to use across an application.
@@ -47,7 +48,7 @@ const orq = new OrqCore({
47
48
  });
48
49
 
49
50
  async function run() {
50
- const res = await deploymentsAll(orq);
51
+ const res = await deploymentsList(orq, {});
51
52
 
52
53
  if (!res.ok) {
53
54
  throw res.error;
@@ -176,6 +177,82 @@ async function run() {
176
177
  key: "<key>",
177
178
  });
178
179
 
180
+ // Handle the result
181
+ console.log(result);
182
+ }
183
+
184
+ run();
185
+ ```
186
+
187
+ ### Standalone function
188
+
189
+ The standalone function version of this method:
190
+
191
+ ```typescript
192
+ import { OrqCore } from "@orq-ai/node/core.js";
193
+ import { deploymentsInvoke } from "@orq-ai/node/funcs/deploymentsInvoke.js";
194
+
195
+ // Use `OrqCore` for best tree-shaking performance.
196
+ // You can create one instance of it to use across an application.
197
+ const orq = new OrqCore({
198
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
199
+ });
200
+
201
+ async function run() {
202
+ const res = await deploymentsInvoke(orq, {
203
+ key: "<key>",
204
+ });
205
+
206
+ if (!res.ok) {
207
+ throw res.error;
208
+ }
209
+
210
+ const { value: result } = res;
211
+
212
+ // Handle the result
213
+ console.log(result);
214
+ }
215
+
216
+ run();
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ | Parameter | Type | Required | Description |
222
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
223
+ | `request` | [components.Deployments](../../models/components/deployments.md) | :heavy_check_mark: | The request object to use for the request. |
224
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
225
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
226
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
227
+
228
+ ### Response
229
+
230
+ **Promise\<[operations.DeploymentInvokeResponseBody](../../models/operations/deploymentinvokeresponsebody.md)\>**
231
+
232
+ ### Errors
233
+
234
+ | Error Type | Status Code | Content Type |
235
+ | --------------- | --------------- | --------------- |
236
+ | errors.APIError | 4XX, 5XX | \*/\* |
237
+
238
+ ## stream
239
+
240
+ Stream deployment generation. Only supported for completions and chat completions.
241
+
242
+ ### Example Usage
243
+
244
+ ```typescript
245
+ import { Orq } from "@orq-ai/node";
246
+
247
+ const orq = new Orq({
248
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
249
+ });
250
+
251
+ async function run() {
252
+ const result = await orq.deployments.stream({
253
+ key: "<key>",
254
+ });
255
+
179
256
  for await (const event of result) {
180
257
  // Handle the event
181
258
  console.log(event);
@@ -191,7 +268,7 @@ The standalone function version of this method:
191
268
 
192
269
  ```typescript
193
270
  import { OrqCore } from "@orq-ai/node/core.js";
194
- import { deploymentsInvoke } from "@orq-ai/node/funcs/deploymentsInvoke.js";
271
+ import { deploymentsStream } from "@orq-ai/node/funcs/deploymentsStream.js";
195
272
 
196
273
  // Use `OrqCore` for best tree-shaking performance.
197
274
  // You can create one instance of it to use across an application.
@@ -200,7 +277,7 @@ const orq = new OrqCore({
200
277
  });
201
278
 
202
279
  async function run() {
203
- const res = await deploymentsInvoke(orq, {
280
+ const res = await deploymentsStream(orq, {
204
281
  key: "<key>",
205
282
  });
206
283
 
@@ -223,14 +300,14 @@ run();
223
300
 
224
301
  | Parameter | Type | Required | Description |
225
302
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
226
- | `request` | [components.Deployments](../../models/components/deployments.md) | :heavy_check_mark: | The request object to use for the request. |
303
+ | `request` | [operations.DeploymentStreamRequestBody](../../models/operations/deploymentstreamrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
227
304
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
228
305
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
229
306
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
230
307
 
231
308
  ### Response
232
309
 
233
- **Promise\<[operations.DeploymentInvokeResponse](../../models/operations/deploymentinvokeresponse.md)\>**
310
+ **Promise\<[EventStream<operations.DeploymentStreamResponseBody>](../../models/.md)\>**
234
311
 
235
312
  ### Errors
236
313
 
@@ -8,9 +8,7 @@
8
8
  * [upload](#upload) - Upload file
9
9
  * [list](#list) - List all files
10
10
  * [get](#get) - Get file by ID
11
- * [update](#update) - Update file name
12
11
  * [delete](#delete) - Delete file
13
- * [bulkUpload](#bulkupload) - Bulk upload file
14
12
 
15
13
  ## upload
16
14
 
@@ -98,7 +96,7 @@ const orq = new Orq({
98
96
  });
99
97
 
100
98
  async function run() {
101
- const result = await orq.files.list();
99
+ const result = await orq.files.list({});
102
100
 
103
101
  // Handle the result
104
102
  console.log(result);
@@ -122,7 +120,7 @@ const orq = new OrqCore({
122
120
  });
123
121
 
124
122
  async function run() {
125
- const res = await filesList(orq);
123
+ const res = await filesList(orq, {});
126
124
 
127
125
  if (!res.ok) {
128
126
  throw res.error;
@@ -232,82 +230,6 @@ run();
232
230
  | --------------- | --------------- | --------------- |
233
231
  | errors.APIError | 4XX, 5XX | \*/\* |
234
232
 
235
- ## update
236
-
237
- Update file name
238
-
239
- ### Example Usage
240
-
241
- ```typescript
242
- import { Orq } from "@orq-ai/node";
243
-
244
- const orq = new Orq({
245
- apiKey: process.env["ORQ_API_KEY"] ?? "",
246
- });
247
-
248
- async function run() {
249
- const result = await orq.files.update({
250
- fileId: "<id>",
251
- });
252
-
253
- // Handle the result
254
- console.log(result);
255
- }
256
-
257
- run();
258
- ```
259
-
260
- ### Standalone function
261
-
262
- The standalone function version of this method:
263
-
264
- ```typescript
265
- import { OrqCore } from "@orq-ai/node/core.js";
266
- import { filesUpdate } from "@orq-ai/node/funcs/filesUpdate.js";
267
-
268
- // Use `OrqCore` for best tree-shaking performance.
269
- // You can create one instance of it to use across an application.
270
- const orq = new OrqCore({
271
- apiKey: process.env["ORQ_API_KEY"] ?? "",
272
- });
273
-
274
- async function run() {
275
- const res = await filesUpdate(orq, {
276
- fileId: "<id>",
277
- });
278
-
279
- if (!res.ok) {
280
- throw res.error;
281
- }
282
-
283
- const { value: result } = res;
284
-
285
- // Handle the result
286
- console.log(result);
287
- }
288
-
289
- run();
290
- ```
291
-
292
- ### Parameters
293
-
294
- | Parameter | Type | Required | Description |
295
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
296
- | `request` | [operations.FileUpdateRequest](../../models/operations/fileupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
297
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
298
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
299
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
300
-
301
- ### Response
302
-
303
- **Promise\<[operations.FileUpdateResponseBody](../../models/operations/fileupdateresponsebody.md)\>**
304
-
305
- ### Errors
306
-
307
- | Error Type | Status Code | Content Type |
308
- | --------------- | --------------- | --------------- |
309
- | errors.APIError | 4XX, 5XX | \*/\* |
310
-
311
233
  ## delete
312
234
 
313
235
  Delete file
@@ -378,96 +300,6 @@ run();
378
300
 
379
301
  ### Errors
380
302
 
381
- | Error Type | Status Code | Content Type |
382
- | --------------- | --------------- | --------------- |
383
- | errors.APIError | 4XX, 5XX | \*/\* |
384
-
385
- ## bulkUpload
386
-
387
- Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
388
-
389
- ### Example Usage
390
-
391
- ```typescript
392
- import { Orq } from "@orq-ai/node";
393
- import { openAsBlob } from "node:fs";
394
-
395
- const orq = new Orq({
396
- apiKey: process.env["ORQ_API_KEY"] ?? "",
397
- });
398
-
399
- async function run() {
400
- const result = await orq.files.bulkUpload({
401
- files: [
402
- {
403
- fileName: "example.file",
404
- content: await openAsBlob("example.file"),
405
- },
406
- ],
407
- purpose: "retrieval",
408
- });
409
-
410
- // Handle the result
411
- console.log(result);
412
- }
413
-
414
- run();
415
- ```
416
-
417
- ### Standalone function
418
-
419
- The standalone function version of this method:
420
-
421
- ```typescript
422
- import { OrqCore } from "@orq-ai/node/core.js";
423
- import { filesBulkUpload } from "@orq-ai/node/funcs/filesBulkUpload.js";
424
- import { openAsBlob } from "node:fs";
425
-
426
- // Use `OrqCore` for best tree-shaking performance.
427
- // You can create one instance of it to use across an application.
428
- const orq = new OrqCore({
429
- apiKey: process.env["ORQ_API_KEY"] ?? "",
430
- });
431
-
432
- async function run() {
433
- const res = await filesBulkUpload(orq, {
434
- files: [
435
- {
436
- fileName: "example.file",
437
- content: await openAsBlob("example.file"),
438
- },
439
- ],
440
- purpose: "retrieval",
441
- });
442
-
443
- if (!res.ok) {
444
- throw res.error;
445
- }
446
-
447
- const { value: result } = res;
448
-
449
- // Handle the result
450
- console.log(result);
451
- }
452
-
453
- run();
454
- ```
455
-
456
- ### Parameters
457
-
458
- | Parameter | Type | Required | Description |
459
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
460
- | `request` | [operations.BulkFileUploadRequestBody](../../models/operations/bulkfileuploadrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
461
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
462
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
463
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
464
-
465
- ### Response
466
-
467
- **Promise\<[operations.ResponseBody[]](../../models/.md)\>**
468
-
469
- ### Errors
470
-
471
303
  | Error Type | Status Code | Content Type |
472
304
  | --------------- | --------------- | --------------- |
473
305
  | errors.APIError | 4XX, 5XX | \*/\* |
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Overview
4
4
 
5
- [Dev] orq.ai API: The Orquesta API
5
+ [Dev] orq.ai API: orq.ai API documentation
6
6
 
7
7
  orq.ai Documentation
8
8
  <https://docs.orq.ai>