@orq-ai/node 3.1.0-rc.7 → 3.1.0

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 (437) hide show
  1. package/README.md +31 -38
  2. package/docs/sdks/deployments/README.md +25 -138
  3. package/docs/sdks/files/README.md +2 -174
  4. package/docs/sdks/orq/README.md +1 -1
  5. package/docs/sdks/prompts/README.md +154 -79
  6. package/docs/sdks/promptsnippets/README.md +488 -0
  7. package/funcs/deploymentsInvoke.d.ts +1 -7
  8. package/funcs/deploymentsInvoke.d.ts.map +1 -1
  9. package/funcs/deploymentsInvoke.js +10 -11
  10. package/funcs/deploymentsInvoke.js.map +1 -1
  11. package/funcs/deploymentsStream.d.ts +16 -0
  12. package/funcs/deploymentsStream.d.ts.map +1 -0
  13. package/funcs/{deploymentsGetLogs.js → deploymentsStream.js} +30 -18
  14. package/funcs/deploymentsStream.js.map +1 -0
  15. package/funcs/{promptSnippetsFindOne.d.ts → promptSnippetsCreate.d.ts} +3 -3
  16. package/funcs/promptSnippetsCreate.d.ts.map +1 -0
  17. package/funcs/{promptsGetAll.js → promptSnippetsCreate.js} +8 -8
  18. package/funcs/promptSnippetsCreate.js.map +1 -0
  19. package/funcs/{promptsGetOne.d.ts → promptSnippetsDelete.d.ts} +3 -3
  20. package/funcs/{promptsCreateVersion.d.ts.map → promptSnippetsDelete.d.ts.map} +1 -1
  21. package/funcs/{promptsGetOne.js → promptSnippetsDelete.js} +8 -8
  22. package/funcs/promptSnippetsDelete.js.map +1 -0
  23. package/funcs/{promptsGetAll.d.ts → promptSnippetsGet.d.ts} +3 -3
  24. package/funcs/promptSnippetsGet.d.ts.map +1 -0
  25. package/funcs/{promptSnippetsFindOne.js → promptSnippetsGet.js} +6 -6
  26. package/funcs/promptSnippetsGet.js.map +1 -0
  27. package/funcs/{filesUpdate.d.ts → promptSnippetsGetByKey.d.ts} +3 -3
  28. package/funcs/promptSnippetsGetByKey.d.ts.map +1 -0
  29. package/funcs/promptSnippetsGetByKey.js +109 -0
  30. package/funcs/promptSnippetsGetByKey.js.map +1 -0
  31. package/funcs/{promptsCreateVersion.d.ts → promptSnippetsList.d.ts} +3 -3
  32. package/funcs/promptSnippetsList.d.ts.map +1 -0
  33. package/funcs/{promptTemplatesGetAll.js → promptSnippetsList.js} +13 -13
  34. package/funcs/promptSnippetsList.js.map +1 -0
  35. package/funcs/promptSnippetsUpdate.d.ts +13 -0
  36. package/funcs/promptSnippetsUpdate.d.ts.map +1 -0
  37. package/funcs/{promptsCreateVersion.js → promptSnippetsUpdate.js} +14 -10
  38. package/funcs/promptSnippetsUpdate.js.map +1 -0
  39. package/funcs/promptsCreate.d.ts +1 -1
  40. package/funcs/promptsCreate.js +2 -2
  41. package/funcs/promptsCreate.js.map +1 -1
  42. package/funcs/promptsDelete.js +1 -1
  43. package/funcs/promptsDelete.js.map +1 -1
  44. package/funcs/promptsGetVersion.d.ts +16 -0
  45. package/funcs/promptsGetVersion.d.ts.map +1 -0
  46. package/funcs/{filesUpdate.js → promptsGetVersion.js} +22 -12
  47. package/funcs/promptsGetVersion.js.map +1 -0
  48. package/funcs/promptsList.d.ts +15 -0
  49. package/funcs/promptsList.d.ts.map +1 -0
  50. package/funcs/promptsList.js +112 -0
  51. package/funcs/promptsList.js.map +1 -0
  52. package/funcs/promptsListVersions.d.ts +15 -0
  53. package/funcs/promptsListVersions.d.ts.map +1 -0
  54. package/funcs/{deploymentsInvalidate.js → promptsListVersions.js} +18 -13
  55. package/funcs/promptsListVersions.js.map +1 -0
  56. package/funcs/{deploymentsInvalidate.d.ts → promptsRetrieve.d.ts} +4 -4
  57. package/funcs/promptsRetrieve.d.ts.map +1 -0
  58. package/funcs/{promptsDuplicate.js → promptsRetrieve.js} +12 -10
  59. package/funcs/promptsRetrieve.js.map +1 -0
  60. package/funcs/promptsUpdate.js +1 -1
  61. package/funcs/promptsUpdate.js.map +1 -1
  62. package/hooks/global.d.ts +5 -0
  63. package/hooks/global.d.ts.map +1 -0
  64. package/hooks/global.js +41 -0
  65. package/hooks/global.js.map +1 -0
  66. package/hooks/registration.d.ts.map +1 -1
  67. package/hooks/registration.js +2 -1
  68. package/hooks/registration.js.map +1 -1
  69. package/jsr.json +1 -1
  70. package/lib/config.d.ts +11 -3
  71. package/lib/config.d.ts.map +1 -1
  72. package/lib/config.js +3 -3
  73. package/lib/config.js.map +1 -1
  74. package/lib/env.d.ts +13 -0
  75. package/lib/env.d.ts.map +1 -1
  76. package/lib/env.js +17 -0
  77. package/lib/env.js.map +1 -1
  78. package/lib/retries.js +0 -1
  79. package/lib/retries.js.map +1 -1
  80. package/lib/sdks.js +1 -1
  81. package/lib/sdks.js.map +1 -1
  82. package/models/components/deployments.d.ts +0 -5
  83. package/models/components/deployments.d.ts.map +1 -1
  84. package/models/components/deployments.js +0 -2
  85. package/models/components/deployments.js.map +1 -1
  86. package/models/errors/getpromptversion.d.ts +36 -0
  87. package/models/errors/getpromptversion.d.ts.map +1 -0
  88. package/models/errors/getpromptversion.js +79 -0
  89. package/models/errors/getpromptversion.js.map +1 -0
  90. package/models/errors/index.d.ts +2 -0
  91. package/models/errors/index.d.ts.map +1 -1
  92. package/models/errors/index.js +2 -0
  93. package/models/errors/index.js.map +1 -1
  94. package/models/errors/updatepromptsnippet.d.ts +36 -0
  95. package/models/errors/updatepromptsnippet.d.ts.map +1 -0
  96. package/models/errors/updatepromptsnippet.js +79 -0
  97. package/models/errors/updatepromptsnippet.js.map +1 -0
  98. package/models/operations/createcontact.js +2 -2
  99. package/models/operations/createprompt.d.ts +690 -381
  100. package/models/operations/createprompt.d.ts.map +1 -1
  101. package/models/operations/createprompt.js +638 -482
  102. package/models/operations/createprompt.js.map +1 -1
  103. package/models/operations/createpromptsnippet.d.ts +3567 -0
  104. package/models/operations/createpromptsnippet.d.ts.map +1 -0
  105. package/models/operations/createpromptsnippet.js +3056 -0
  106. package/models/operations/createpromptsnippet.js.map +1 -0
  107. package/models/operations/deleteprompt.d.ts +1 -1
  108. package/models/operations/deletepromptsnippet.d.ts +32 -0
  109. package/models/operations/deletepromptsnippet.d.ts.map +1 -0
  110. package/models/operations/{duplicateprompt.js → deletepromptsnippet.js} +17 -17
  111. package/models/operations/deletepromptsnippet.js.map +1 -0
  112. package/models/operations/deploymentgetconfig.d.ts +39 -0
  113. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  114. package/models/operations/deploymentgetconfig.js +29 -4
  115. package/models/operations/deploymentgetconfig.js.map +1 -1
  116. package/models/operations/deploymentinvoke.d.ts +17 -683
  117. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  118. package/models/operations/deploymentinvoke.js +21 -614
  119. package/models/operations/deploymentinvoke.js.map +1 -1
  120. package/models/operations/deployments.d.ts +39 -0
  121. package/models/operations/deployments.d.ts.map +1 -1
  122. package/models/operations/deployments.js +28 -3
  123. package/models/operations/deployments.js.map +1 -1
  124. package/models/operations/deploymentstream.d.ts +1622 -0
  125. package/models/operations/deploymentstream.d.ts.map +1 -0
  126. package/models/operations/deploymentstream.js +1571 -0
  127. package/models/operations/deploymentstream.js.map +1 -0
  128. package/models/operations/fileget.js +2 -2
  129. package/models/operations/filelist.js +2 -2
  130. package/models/operations/fileupload.js +2 -2
  131. package/models/operations/findonebykeypromptsnippet.d.ts +2448 -0
  132. package/models/operations/findonebykeypromptsnippet.d.ts.map +1 -0
  133. package/models/operations/findonebykeypromptsnippet.js +2133 -0
  134. package/models/operations/findonebykeypromptsnippet.js.map +1 -0
  135. package/models/operations/findonepromptsnippet.d.ts +926 -4792
  136. package/models/operations/findonepromptsnippet.d.ts.map +1 -1
  137. package/models/operations/findonepromptsnippet.js +971 -4750
  138. package/models/operations/findonepromptsnippet.js.map +1 -1
  139. package/models/operations/getallprompts.d.ts +558 -9970
  140. package/models/operations/getallprompts.d.ts.map +1 -1
  141. package/models/operations/getallprompts.js +554 -8812
  142. package/models/operations/getallprompts.js.map +1 -1
  143. package/models/operations/getallpromptsnippets.d.ts +2512 -0
  144. package/models/operations/getallpromptsnippets.d.ts.map +1 -0
  145. package/models/operations/getallpromptsnippets.js +2195 -0
  146. package/models/operations/getallpromptsnippets.js.map +1 -0
  147. package/models/operations/getoneprompt.d.ts +1203 -1
  148. package/models/operations/getoneprompt.d.ts.map +1 -1
  149. package/models/operations/getoneprompt.js +1011 -1
  150. package/models/operations/getoneprompt.js.map +1 -1
  151. package/models/operations/getpromptversion.d.ts +1228 -0
  152. package/models/operations/getpromptversion.d.ts.map +1 -0
  153. package/models/operations/getpromptversion.js +1080 -0
  154. package/models/operations/getpromptversion.js.map +1 -0
  155. package/models/operations/index.d.ts +8 -7
  156. package/models/operations/index.d.ts.map +1 -1
  157. package/models/operations/index.js +8 -7
  158. package/models/operations/index.js.map +1 -1
  159. package/models/operations/listpromptversions.d.ts +1286 -0
  160. package/models/operations/listpromptversions.d.ts.map +1 -0
  161. package/models/operations/listpromptversions.js +1142 -0
  162. package/models/operations/listpromptversions.js.map +1 -0
  163. package/models/operations/updateprompt.d.ts +1101 -6001
  164. package/models/operations/updateprompt.d.ts.map +1 -1
  165. package/models/operations/updateprompt.js +1115 -5739
  166. package/models/operations/updateprompt.js.map +1 -1
  167. package/models/operations/updatepromptsnippet.d.ts +3595 -0
  168. package/models/operations/updatepromptsnippet.d.ts.map +1 -0
  169. package/models/operations/updatepromptsnippet.js +3116 -0
  170. package/models/operations/updatepromptsnippet.js.map +1 -0
  171. package/package.json +7 -9
  172. package/packages/orq-rc/FUNCTIONS.md +106 -0
  173. package/packages/orq-rc/README.md +559 -0
  174. package/packages/orq-rc/RUNTIMES.md +48 -0
  175. package/{docs/sdks/snippets → packages/orq-rc/docs/sdks/contacts}/README.md +12 -12
  176. package/packages/orq-rc/docs/sdks/deployments/README.md +316 -0
  177. package/packages/orq-rc/docs/sdks/feedback/README.md +92 -0
  178. package/packages/orq-rc/docs/sdks/files/README.md +305 -0
  179. package/packages/orq-rc/docs/sdks/metrics/README.md +86 -0
  180. package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
  181. package/packages/orq-rc/docs/sdks/prompts/README.md +608 -0
  182. package/packages/orq-rc/docs/sdks/promptsnippets/README.md +534 -0
  183. package/{docs/sdks/templates → packages/orq-rc/docs/sdks/remoteconfig}/README.md +10 -10
  184. package/packages/orq-rc/jsr.json +28 -0
  185. package/packages/orq-rc/package-lock.json +1861 -0
  186. package/packages/orq-rc/package.json +31 -0
  187. package/packages/orq-rc/src/core.ts +13 -0
  188. package/packages/orq-rc/src/funcs/contactsCreate.ts +126 -0
  189. package/{src/funcs/deploymentsGetLogs.ts → packages/orq-rc/src/funcs/deploymentsGetConfig.ts} +20 -19
  190. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +142 -0
  191. package/packages/orq-rc/src/funcs/deploymentsList.ts +141 -0
  192. package/{src/funcs/promptsCreateVersion.ts → packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts} +14 -11
  193. package/packages/orq-rc/src/funcs/deploymentsStream.ts +150 -0
  194. package/packages/orq-rc/src/funcs/feedbackCreate.ts +126 -0
  195. package/packages/orq-rc/src/funcs/filesDelete.ts +130 -0
  196. package/{src/funcs/filesUpdate.ts → packages/orq-rc/src/funcs/filesGet.ts} +11 -12
  197. package/packages/orq-rc/src/funcs/filesList.ts +131 -0
  198. package/{src/funcs/filesBulkUpload.ts → packages/orq-rc/src/funcs/filesUpload.ts} +32 -12
  199. package/packages/orq-rc/src/funcs/promptSnippetsCreate.ts +128 -0
  200. package/{src/funcs/promptsDuplicate.ts → packages/orq-rc/src/funcs/promptSnippetsDelete.ts} +8 -7
  201. package/{src/funcs/promptSnippetsFindOne.ts → packages/orq-rc/src/funcs/promptSnippetsGet.ts} +4 -4
  202. package/packages/orq-rc/src/funcs/promptSnippetsGetByKey.ts +132 -0
  203. package/{src/funcs/promptTemplatesGetAll.ts → packages/orq-rc/src/funcs/promptSnippetsList.ts} +16 -16
  204. package/packages/orq-rc/src/funcs/promptSnippetsUpdate.ts +139 -0
  205. package/{src/funcs/promptsGetAll.ts → packages/orq-rc/src/funcs/promptsCreate.ts} +9 -11
  206. package/{src/funcs/promptsGetOne.ts → packages/orq-rc/src/funcs/promptsDelete.ts} +7 -7
  207. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +146 -0
  208. package/packages/orq-rc/src/funcs/promptsList.ts +133 -0
  209. package/packages/orq-rc/src/funcs/promptsListVersions.ts +139 -0
  210. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +132 -0
  211. package/packages/orq-rc/src/funcs/promptsUpdate.ts +138 -0
  212. package/packages/orq-rc/src/funcs/remoteconfigGetConfig.ts +127 -0
  213. package/packages/orq-rc/src/hooks/global.ts +44 -0
  214. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  215. package/packages/orq-rc/src/hooks/index.ts +6 -0
  216. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  217. package/packages/orq-rc/src/hooks/types.ts +109 -0
  218. package/packages/orq-rc/src/index.ts +7 -0
  219. package/packages/orq-rc/src/lib/base64.ts +37 -0
  220. package/packages/orq-rc/src/lib/config.ts +70 -0
  221. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  222. package/packages/orq-rc/src/lib/encodings.ts +483 -0
  223. package/packages/orq-rc/src/lib/env.ts +73 -0
  224. package/packages/orq-rc/src/lib/event-streams.ts +264 -0
  225. package/packages/orq-rc/src/lib/files.ts +40 -0
  226. package/packages/orq-rc/src/lib/http.ts +323 -0
  227. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  228. package/packages/orq-rc/src/lib/logger.ts +9 -0
  229. package/packages/orq-rc/src/lib/matchers.ts +325 -0
  230. package/packages/orq-rc/src/lib/primitives.ts +136 -0
  231. package/packages/orq-rc/src/lib/retries.ts +218 -0
  232. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  233. package/packages/orq-rc/src/lib/sdks.ts +400 -0
  234. package/packages/orq-rc/src/lib/security.ts +254 -0
  235. package/packages/orq-rc/src/lib/url.ts +33 -0
  236. package/packages/orq-rc/src/models/components/deployments.ts +1666 -0
  237. package/packages/orq-rc/src/models/components/index.ts +6 -0
  238. package/packages/orq-rc/src/models/components/security.ts +71 -0
  239. package/packages/orq-rc/src/models/errors/apierror.ts +27 -0
  240. package/packages/orq-rc/src/models/errors/getpromptversion.ts +71 -0
  241. package/packages/orq-rc/src/models/errors/honoapierror.ts +82 -0
  242. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  243. package/packages/orq-rc/src/models/errors/index.ts +11 -0
  244. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +97 -0
  245. package/packages/orq-rc/src/models/errors/updateprompt.ts +71 -0
  246. package/packages/orq-rc/src/models/errors/updatepromptsnippet.ts +71 -0
  247. package/packages/orq-rc/src/models/operations/createcontact.ts +256 -0
  248. package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
  249. package/packages/orq-rc/src/models/operations/createprompt.ts +3819 -0
  250. package/packages/orq-rc/src/models/operations/createpromptsnippet.ts +6239 -0
  251. package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
  252. package/packages/orq-rc/src/models/operations/deletepromptsnippet.ts +69 -0
  253. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +1790 -0
  254. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +3527 -0
  255. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1144 -0
  256. package/packages/orq-rc/src/models/operations/deployments.ts +2148 -0
  257. package/packages/orq-rc/src/models/operations/deploymentstream.ts +3062 -0
  258. package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
  259. package/packages/orq-rc/src/models/operations/fileget.ts +222 -0
  260. package/packages/orq-rc/src/models/operations/filelist.ts +321 -0
  261. package/packages/orq-rc/src/models/operations/fileupload.ts +322 -0
  262. package/packages/orq-rc/src/models/operations/findonebykeypromptsnippet.ts +4483 -0
  263. package/packages/orq-rc/src/models/operations/findonepromptsnippet.ts +4343 -0
  264. package/packages/orq-rc/src/models/operations/getallprompts.ts +2116 -0
  265. package/packages/orq-rc/src/models/operations/getallpromptsnippets.ts +4472 -0
  266. package/packages/orq-rc/src/models/operations/getoneprompt.ts +1982 -0
  267. package/packages/orq-rc/src/models/operations/getpromptversion.ts +2012 -0
  268. package/packages/orq-rc/src/models/operations/index.ts +29 -0
  269. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2146 -0
  270. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
  271. package/packages/orq-rc/src/models/operations/updateprompt.ts +3917 -0
  272. package/packages/orq-rc/src/models/operations/updatepromptsnippet.ts +6544 -0
  273. package/packages/orq-rc/src/sdk/contacts.ts +27 -0
  274. package/packages/orq-rc/src/sdk/deployments.ts +89 -0
  275. package/packages/orq-rc/src/sdk/feedback.ts +27 -0
  276. package/packages/orq-rc/src/sdk/files.ts +72 -0
  277. package/packages/orq-rc/src/sdk/index.ts +5 -0
  278. package/packages/orq-rc/src/sdk/metrics.ts +27 -0
  279. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  280. package/packages/orq-rc/src/sdk/promptsnippets.ts +99 -0
  281. package/packages/orq-rc/src/sdk/remoteconfig.ts +24 -0
  282. package/packages/orq-rc/src/sdk/sdk.ts +49 -0
  283. package/packages/orq-rc/src/types/blobs.ts +31 -0
  284. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  285. package/packages/orq-rc/src/types/enums.ts +16 -0
  286. package/packages/orq-rc/src/types/fp.ts +50 -0
  287. package/packages/orq-rc/src/types/index.ts +11 -0
  288. package/packages/orq-rc/src/types/operations.ts +105 -0
  289. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  290. package/packages/orq-rc/src/types/streams.ts +21 -0
  291. package/packages/orq-rc/tsconfig.json +41 -0
  292. package/sdk/deployments.d.ts +5 -15
  293. package/sdk/deployments.d.ts.map +1 -1
  294. package/sdk/deployments.js +6 -18
  295. package/sdk/deployments.js.map +1 -1
  296. package/sdk/files.d.ts +0 -11
  297. package/sdk/files.d.ts.map +1 -1
  298. package/sdk/files.js +0 -17
  299. package/sdk/files.js.map +1 -1
  300. package/sdk/prompts.d.ts +26 -14
  301. package/sdk/prompts.d.ts.map +1 -1
  302. package/sdk/prompts.js +37 -25
  303. package/sdk/prompts.js.map +1 -1
  304. package/sdk/promptsnippets.d.ts +29 -0
  305. package/sdk/promptsnippets.d.ts.map +1 -0
  306. package/sdk/promptsnippets.js +54 -0
  307. package/sdk/promptsnippets.js.map +1 -0
  308. package/sdk/sdk.d.ts +3 -3
  309. package/sdk/sdk.d.ts.map +1 -1
  310. package/sdk/sdk.js +3 -3
  311. package/sdk/sdk.js.map +1 -1
  312. package/src/funcs/deploymentsInvoke.ts +21 -16
  313. package/src/funcs/deploymentsStream.ts +150 -0
  314. package/src/funcs/promptSnippetsCreate.ts +128 -0
  315. package/src/funcs/{deploymentsInvalidate.ts → promptSnippetsDelete.ts} +9 -13
  316. package/src/funcs/promptSnippetsGet.ts +130 -0
  317. package/src/funcs/promptSnippetsGetByKey.ts +132 -0
  318. package/src/funcs/promptSnippetsList.ts +132 -0
  319. package/src/funcs/promptSnippetsUpdate.ts +139 -0
  320. package/src/funcs/promptsCreate.ts +2 -2
  321. package/src/funcs/promptsDelete.ts +1 -1
  322. package/src/funcs/promptsGetVersion.ts +146 -0
  323. package/src/funcs/promptsList.ts +133 -0
  324. package/src/funcs/promptsListVersions.ts +139 -0
  325. package/src/funcs/promptsRetrieve.ts +132 -0
  326. package/src/funcs/promptsUpdate.ts +1 -1
  327. package/src/hooks/global.ts +44 -0
  328. package/src/hooks/registration.ts +2 -1
  329. package/src/lib/config.ts +13 -3
  330. package/src/lib/env.ts +32 -0
  331. package/src/lib/retries.ts +0 -1
  332. package/src/lib/sdks.ts +2 -2
  333. package/src/models/components/deployments.ts +0 -7
  334. package/src/models/errors/getpromptversion.ts +71 -0
  335. package/src/models/errors/index.ts +2 -0
  336. package/src/models/errors/updatepromptsnippet.ts +71 -0
  337. package/src/models/operations/createcontact.ts +2 -2
  338. package/src/models/operations/createprompt.ts +1045 -691
  339. package/src/models/operations/createpromptsnippet.ts +6239 -0
  340. package/src/models/operations/deleteprompt.ts +1 -1
  341. package/src/models/operations/deletepromptsnippet.ts +69 -0
  342. package/src/models/operations/deploymentgetconfig.ts +44 -0
  343. package/src/models/operations/deploymentinvoke.ts +180 -1423
  344. package/src/models/operations/deployments.ts +43 -0
  345. package/src/models/operations/deploymentstream.ts +3062 -0
  346. package/src/models/operations/fileget.ts +2 -2
  347. package/src/models/operations/filelist.ts +2 -2
  348. package/src/models/operations/fileupload.ts +2 -2
  349. package/src/models/operations/findonebykeypromptsnippet.ts +4483 -0
  350. package/src/models/operations/findonepromptsnippet.ts +1811 -11109
  351. package/src/models/operations/getallprompts.ts +1294 -18123
  352. package/src/models/operations/getallpromptsnippets.ts +4472 -0
  353. package/src/models/operations/getoneprompt.ts +1914 -1
  354. package/src/models/operations/getpromptversion.ts +2012 -0
  355. package/src/models/operations/index.ts +8 -7
  356. package/src/models/operations/listpromptversions.ts +2146 -0
  357. package/src/models/operations/updateprompt.ts +1999 -12503
  358. package/src/models/operations/updatepromptsnippet.ts +6544 -0
  359. package/src/sdk/deployments.ts +11 -33
  360. package/src/sdk/files.ts +0 -33
  361. package/src/sdk/prompts.ts +51 -39
  362. package/src/sdk/promptsnippets.ts +99 -0
  363. package/src/sdk/sdk.ts +4 -4
  364. package/docs/sdks/prompt/README.md +0 -6
  365. package/funcs/deploymentsGetLogs.d.ts +0 -15
  366. package/funcs/deploymentsGetLogs.d.ts.map +0 -1
  367. package/funcs/deploymentsGetLogs.js.map +0 -1
  368. package/funcs/deploymentsInvalidate.d.ts.map +0 -1
  369. package/funcs/deploymentsInvalidate.js.map +0 -1
  370. package/funcs/filesBulkUpload.d.ts +0 -15
  371. package/funcs/filesBulkUpload.d.ts.map +0 -1
  372. package/funcs/filesBulkUpload.js +0 -109
  373. package/funcs/filesBulkUpload.js.map +0 -1
  374. package/funcs/filesUpdate.d.ts.map +0 -1
  375. package/funcs/filesUpdate.js.map +0 -1
  376. package/funcs/promptSnippetsFindOne.d.ts.map +0 -1
  377. package/funcs/promptSnippetsFindOne.js.map +0 -1
  378. package/funcs/promptTemplatesGetAll.d.ts +0 -12
  379. package/funcs/promptTemplatesGetAll.d.ts.map +0 -1
  380. package/funcs/promptTemplatesGetAll.js.map +0 -1
  381. package/funcs/promptsCreateVersion.js.map +0 -1
  382. package/funcs/promptsDuplicate.d.ts +0 -12
  383. package/funcs/promptsDuplicate.d.ts.map +0 -1
  384. package/funcs/promptsDuplicate.js.map +0 -1
  385. package/funcs/promptsGetAll.d.ts.map +0 -1
  386. package/funcs/promptsGetAll.js.map +0 -1
  387. package/funcs/promptsGetOne.d.ts.map +0 -1
  388. package/funcs/promptsGetOne.js.map +0 -1
  389. package/models/operations/bulkfileupload.d.ts +0 -173
  390. package/models/operations/bulkfileupload.d.ts.map +0 -1
  391. package/models/operations/bulkfileupload.js +0 -210
  392. package/models/operations/bulkfileupload.js.map +0 -1
  393. package/models/operations/createpromptversion.d.ts +0 -2015
  394. package/models/operations/createpromptversion.d.ts.map +0 -1
  395. package/models/operations/createpromptversion.js +0 -1856
  396. package/models/operations/createpromptversion.js.map +0 -1
  397. package/models/operations/deploymentgetlogs.d.ts +0 -52406
  398. package/models/operations/deploymentgetlogs.d.ts.map +0 -1
  399. package/models/operations/deploymentgetlogs.js +0 -53803
  400. package/models/operations/deploymentgetlogs.js.map +0 -1
  401. package/models/operations/duplicateprompt.d.ts +0 -32
  402. package/models/operations/duplicateprompt.d.ts.map +0 -1
  403. package/models/operations/duplicateprompt.js.map +0 -1
  404. package/models/operations/fileupdate.d.ts +0 -143
  405. package/models/operations/fileupdate.d.ts.map +0 -1
  406. package/models/operations/fileupdate.js +0 -193
  407. package/models/operations/fileupdate.js.map +0 -1
  408. package/models/operations/getallprompttemplates.d.ts +0 -6643
  409. package/models/operations/getallprompttemplates.d.ts.map +0 -1
  410. package/models/operations/getallprompttemplates.js +0 -6234
  411. package/models/operations/getallprompttemplates.js.map +0 -1
  412. package/models/operations/invaliddeployment.d.ts +0 -29
  413. package/models/operations/invaliddeployment.d.ts.map +0 -1
  414. package/models/operations/invaliddeployment.js +0 -78
  415. package/models/operations/invaliddeployment.js.map +0 -1
  416. package/sdk/prompt.d.ts +0 -10
  417. package/sdk/prompt.d.ts.map +0 -1
  418. package/sdk/prompt.js +0 -19
  419. package/sdk/prompt.js.map +0 -1
  420. package/sdk/snippets.d.ts +0 -9
  421. package/sdk/snippets.d.ts.map +0 -1
  422. package/sdk/snippets.js +0 -19
  423. package/sdk/snippets.js.map +0 -1
  424. package/sdk/templates.d.ts +0 -9
  425. package/sdk/templates.d.ts.map +0 -1
  426. package/sdk/templates.js +0 -19
  427. package/sdk/templates.js.map +0 -1
  428. package/src/models/operations/bulkfileupload.ts +0 -315
  429. package/src/models/operations/createpromptversion.ts +0 -3707
  430. package/src/models/operations/deploymentgetlogs.ts +0 -119430
  431. package/src/models/operations/duplicateprompt.ts +0 -69
  432. package/src/models/operations/fileupdate.ts +0 -298
  433. package/src/models/operations/getallprompttemplates.ts +0 -13779
  434. package/src/models/operations/invaliddeployment.ts +0 -75
  435. package/src/sdk/prompt.ts +0 -19
  436. package/src/sdk/snippets.ts +0 -24
  437. package/src/sdk/templates.ts +0 -24
package/README.md CHANGED
@@ -12,7 +12,7 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
12
12
  <!-- Start Summary [summary] -->
13
13
  ## Summary
14
14
 
15
- [Dev] orq.ai API: The Orquesta API
15
+ [Dev] orq.ai API: orq.ai API documentation
16
16
 
17
17
  For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
18
18
  <!-- End Summary [summary] -->
@@ -151,10 +151,9 @@ run();
151
151
  ### [deployments](docs/sdks/deployments/README.md)
152
152
 
153
153
  * [list](docs/sdks/deployments/README.md#list) - List all deployments
154
- * [invalidate](docs/sdks/deployments/README.md#invalidate) - Invalidates cache
155
154
  * [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
156
155
  * [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
157
- * [getLogs](docs/sdks/deployments/README.md#getlogs) - Get Logs
156
+ * [stream](docs/sdks/deployments/README.md#stream) - Stream
158
157
 
159
158
  #### [deployments.metrics](docs/sdks/metrics/README.md)
160
159
 
@@ -169,31 +168,27 @@ run();
169
168
  * [upload](docs/sdks/files/README.md#upload) - Upload file
170
169
  * [list](docs/sdks/files/README.md#list) - List all files
171
170
  * [get](docs/sdks/files/README.md#get) - Get file by ID
172
- * [update](docs/sdks/files/README.md#update) - Update file name
173
171
  * [delete](docs/sdks/files/README.md#delete) - Delete file
174
- * [bulkUpload](docs/sdks/files/README.md#bulkupload) - Bulk upload file
175
172
 
176
173
 
177
- ### [prompt](docs/sdks/prompt/README.md)
178
-
179
-
180
- #### [prompt.snippets](docs/sdks/snippets/README.md)
181
-
182
- * [findOne](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
183
-
184
- #### [prompt.templates](docs/sdks/templates/README.md)
185
-
186
- * [getAll](docs/sdks/templates/README.md#getall) - Get all prompt templates
187
-
188
174
  ### [prompts](docs/sdks/prompts/README.md)
189
175
 
190
- * [create](docs/sdks/prompts/README.md#create) - Create a new prompt
191
- * [createVersion](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
192
- * [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
193
- * [getOne](docs/sdks/prompts/README.md#getone) - Get one prompt
176
+ * [list](docs/sdks/prompts/README.md#list) - List all prompts
177
+ * [create](docs/sdks/prompts/README.md#create) - Create a prompt
178
+ * [retrieve](docs/sdks/prompts/README.md#retrieve) - Retrieve a prompt
194
179
  * [update](docs/sdks/prompts/README.md#update) - Update a prompt
195
- * [duplicate](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
196
- * [getAll](docs/sdks/prompts/README.md#getall) - Get all prompts
180
+ * [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
181
+ * [listVersions](docs/sdks/prompts/README.md#listversions) - List all prompt versions
182
+ * [getVersion](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
183
+
184
+ ### [promptSnippets](docs/sdks/promptsnippets/README.md)
185
+
186
+ * [list](docs/sdks/promptsnippets/README.md#list) - List all prompts snippets
187
+ * [create](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
188
+ * [update](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
189
+ * [delete](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
190
+ * [get](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
191
+ * [getByKey](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
197
192
 
198
193
  ### [remoteconfig](docs/sdks/remoteconfig/README.md)
199
194
 
@@ -219,27 +214,28 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
219
214
 
220
215
  - [`contactsCreate`](docs/sdks/contacts/README.md#create) - Update user information
221
216
  - [`deploymentsGetConfig`](docs/sdks/deployments/README.md#getconfig) - Get config
222
- - [`deploymentsGetLogs`](docs/sdks/deployments/README.md#getlogs) - Get Logs
223
- - [`deploymentsInvalidate`](docs/sdks/deployments/README.md#invalidate) - Invalidates cache
224
217
  - [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
225
218
  - [`deploymentsList`](docs/sdks/deployments/README.md#list) - List all deployments
226
219
  - [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
220
+ - [`deploymentsStream`](docs/sdks/deployments/README.md#stream) - Stream
227
221
  - [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
228
- - [`filesBulkUpload`](docs/sdks/files/README.md#bulkupload) - Bulk upload file
229
222
  - [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
230
223
  - [`filesGet`](docs/sdks/files/README.md#get) - Get file by ID
231
224
  - [`filesList`](docs/sdks/files/README.md#list) - List all files
232
- - [`filesUpdate`](docs/sdks/files/README.md#update) - Update file name
233
225
  - [`filesUpload`](docs/sdks/files/README.md#upload) - Upload file
234
- - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a new prompt
235
- - [`promptsCreateVersion`](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
226
+ - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
236
227
  - [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
237
- - [`promptsDuplicate`](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
238
- - [`promptsGetAll`](docs/sdks/prompts/README.md#getall) - Get all prompts
239
- - [`promptsGetOne`](docs/sdks/prompts/README.md#getone) - Get one prompt
240
- - [`promptSnippetsFindOne`](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
228
+ - [`promptsGetVersion`](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
229
+ - [`promptsList`](docs/sdks/prompts/README.md#list) - List all prompts
230
+ - [`promptsListVersions`](docs/sdks/prompts/README.md#listversions) - List all prompt versions
231
+ - [`promptSnippetsCreate`](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
232
+ - [`promptSnippetsDelete`](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
233
+ - [`promptSnippetsGet`](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
234
+ - [`promptSnippetsGetByKey`](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
235
+ - [`promptSnippetsList`](docs/sdks/promptsnippets/README.md#list) - List all prompts snippets
236
+ - [`promptSnippetsUpdate`](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
237
+ - [`promptsRetrieve`](docs/sdks/prompts/README.md#retrieve) - Retrieve a prompt
241
238
  - [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
242
- - [`promptTemplatesGetAll`](docs/sdks/templates/README.md#getall) - Get all prompt templates
243
239
  - [`remoteconfigGetConfig`](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
244
240
 
245
241
  </details>
@@ -262,9 +258,8 @@ const orq = new Orq({
262
258
  });
263
259
 
264
260
  async function run() {
265
- const result = await orq.deployments.invoke({
261
+ const result = await orq.deployments.stream({
266
262
  key: "<key>",
267
- stream: false,
268
263
  });
269
264
 
270
265
  for await (const event of result) {
@@ -406,9 +401,7 @@ const orq = new Orq({
406
401
  async function run() {
407
402
  let result;
408
403
  try {
409
- result = await orq.deployments.list({
410
- limit: 10,
411
- });
404
+ result = await orq.deployments.list({});
412
405
 
413
406
  // Handle the result
414
407
  console.log(result);
@@ -6,10 +6,9 @@
6
6
  ### Available Operations
7
7
 
8
8
  * [list](#list) - List all deployments
9
- * [invalidate](#invalidate) - Invalidates cache
10
9
  * [getConfig](#getconfig) - Get config
11
10
  * [invoke](#invoke) - Invoke
12
- * [getLogs](#getlogs) - Get Logs
11
+ * [stream](#stream) - Stream
13
12
 
14
13
  ## list
15
14
 
@@ -25,9 +24,7 @@ const orq = new Orq({
25
24
  });
26
25
 
27
26
  async function run() {
28
- const result = await orq.deployments.list({
29
- limit: 10,
30
- });
27
+ const result = await orq.deployments.list({});
31
28
 
32
29
  // Handle the result
33
30
  console.log(result);
@@ -51,9 +48,7 @@ const orq = new OrqCore({
51
48
  });
52
49
 
53
50
  async function run() {
54
- const res = await deploymentsList(orq, {
55
- limit: 10,
56
- });
51
+ const res = await deploymentsList(orq, {});
57
52
 
58
53
  if (!res.ok) {
59
54
  throw res.error;
@@ -88,80 +83,6 @@ run();
88
83
  | errors.HonoApiError | 500 | application/json |
89
84
  | errors.APIError | 4XX, 5XX | \*/\* |
90
85
 
91
- ## invalidate
92
-
93
- Explicitly invalidate a cache of a deployment
94
-
95
- ### Example Usage
96
-
97
- ```typescript
98
- import { Orq } from "@orq-ai/node";
99
-
100
- const orq = new Orq({
101
- apiKey: process.env["ORQ_API_KEY"] ?? "",
102
- });
103
-
104
- async function run() {
105
- await orq.deployments.invalidate({
106
- deploymentId: "e1106c66-dcfb-4003-a0e1-3c49405187d4",
107
- });
108
-
109
-
110
- }
111
-
112
- run();
113
- ```
114
-
115
- ### Standalone function
116
-
117
- The standalone function version of this method:
118
-
119
- ```typescript
120
- import { OrqCore } from "@orq-ai/node/core.js";
121
- import { deploymentsInvalidate } from "@orq-ai/node/funcs/deploymentsInvalidate.js";
122
-
123
- // Use `OrqCore` for best tree-shaking performance.
124
- // You can create one instance of it to use across an application.
125
- const orq = new OrqCore({
126
- apiKey: process.env["ORQ_API_KEY"] ?? "",
127
- });
128
-
129
- async function run() {
130
- const res = await deploymentsInvalidate(orq, {
131
- deploymentId: "e1106c66-dcfb-4003-a0e1-3c49405187d4",
132
- });
133
-
134
- if (!res.ok) {
135
- throw res.error;
136
- }
137
-
138
- const { value: result } = res;
139
-
140
-
141
- }
142
-
143
- run();
144
- ```
145
-
146
- ### Parameters
147
-
148
- | Parameter | Type | Required | Description |
149
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
150
- | `request` | [operations.InvalidDeploymentRequest](../../models/operations/invaliddeploymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
151
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
152
- | `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. |
153
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
154
-
155
- ### Response
156
-
157
- **Promise\<void\>**
158
-
159
- ### Errors
160
-
161
- | Error Type | Status Code | Content Type |
162
- | --------------- | --------------- | --------------- |
163
- | errors.APIError | 4XX, 5XX | \*/\* |
164
-
165
86
  ## getConfig
166
87
 
167
88
  Retrieve the deployment configuration
@@ -254,13 +175,10 @@ const orq = new Orq({
254
175
  async function run() {
255
176
  const result = await orq.deployments.invoke({
256
177
  key: "<key>",
257
- stream: false,
258
178
  });
259
179
 
260
- for await (const event of result) {
261
- // Handle the event
262
- console.log(event);
263
- }
180
+ // Handle the result
181
+ console.log(result);
264
182
  }
265
183
 
266
184
  run();
@@ -283,7 +201,6 @@ const orq = new OrqCore({
283
201
  async function run() {
284
202
  const res = await deploymentsInvoke(orq, {
285
203
  key: "<key>",
286
- stream: false,
287
204
  });
288
205
 
289
206
  if (!res.ok) {
@@ -292,10 +209,8 @@ async function run() {
292
209
 
293
210
  const { value: result } = res;
294
211
 
295
- for await (const event of result) {
296
- // Handle the event
297
- console.log(event);
298
- }
212
+ // Handle the result
213
+ console.log(result);
299
214
  }
300
215
 
301
216
  run();
@@ -312,7 +227,7 @@ run();
312
227
 
313
228
  ### Response
314
229
 
315
- **Promise\<[operations.DeploymentInvokeResponse](../../models/operations/deploymentinvokeresponse.md)\>**
230
+ **Promise\<[operations.DeploymentInvokeResponseBody](../../models/operations/deploymentinvokeresponsebody.md)\>**
316
231
 
317
232
  ### Errors
318
233
 
@@ -320,9 +235,9 @@ run();
320
235
  | --------------- | --------------- | --------------- |
321
236
  | errors.APIError | 4XX, 5XX | \*/\* |
322
237
 
323
- ## getLogs
238
+ ## stream
324
239
 
325
- Retrieve the logs based on deployment key
240
+ Stream deployment generation. Only supported for completions and chat completions.
326
241
 
327
242
  ### Example Usage
328
243
 
@@ -334,28 +249,14 @@ const orq = new Orq({
334
249
  });
335
250
 
336
251
  async function run() {
337
- const result = await orq.deployments.getLogs({
338
- deploymentKey: "<value>",
339
- requestBody: {
340
- filters: [
341
- {
342
- type: "id",
343
- id: "<id>",
344
- path: "/usr/include",
345
- },
346
- {
347
- type: "search",
348
- value: "<value>",
349
- searchPaths: [
350
- "<value>",
351
- ],
352
- },
353
- ],
354
- },
252
+ const result = await orq.deployments.stream({
253
+ key: "<key>",
355
254
  });
356
255
 
357
- // Handle the result
358
- console.log(result);
256
+ for await (const event of result) {
257
+ // Handle the event
258
+ console.log(event);
259
+ }
359
260
  }
360
261
 
361
262
  run();
@@ -367,7 +268,7 @@ The standalone function version of this method:
367
268
 
368
269
  ```typescript
369
270
  import { OrqCore } from "@orq-ai/node/core.js";
370
- import { deploymentsGetLogs } from "@orq-ai/node/funcs/deploymentsGetLogs.js";
271
+ import { deploymentsStream } from "@orq-ai/node/funcs/deploymentsStream.js";
371
272
 
372
273
  // Use `OrqCore` for best tree-shaking performance.
373
274
  // You can create one instance of it to use across an application.
@@ -376,24 +277,8 @@ const orq = new OrqCore({
376
277
  });
377
278
 
378
279
  async function run() {
379
- const res = await deploymentsGetLogs(orq, {
380
- deploymentKey: "<value>",
381
- requestBody: {
382
- filters: [
383
- {
384
- type: "id",
385
- id: "<id>",
386
- path: "/usr/include",
387
- },
388
- {
389
- type: "search",
390
- value: "<value>",
391
- searchPaths: [
392
- "<value>",
393
- ],
394
- },
395
- ],
396
- },
280
+ const res = await deploymentsStream(orq, {
281
+ key: "<key>",
397
282
  });
398
283
 
399
284
  if (!res.ok) {
@@ -402,8 +287,10 @@ async function run() {
402
287
 
403
288
  const { value: result } = res;
404
289
 
405
- // Handle the result
406
- console.log(result);
290
+ for await (const event of result) {
291
+ // Handle the event
292
+ console.log(event);
293
+ }
407
294
  }
408
295
 
409
296
  run();
@@ -413,14 +300,14 @@ run();
413
300
 
414
301
  | Parameter | Type | Required | Description |
415
302
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
416
- | `request` | [operations.DeploymentGetLogsRequest](../../models/operations/deploymentgetlogsrequest.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. |
417
304
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
418
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. |
419
306
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
420
307
 
421
308
  ### Response
422
309
 
423
- **Promise\<[operations.DeploymentGetLogsResponseBody](../../models/operations/deploymentgetlogsresponsebody.md)\>**
310
+ **Promise\<[EventStream<operations.DeploymentStreamResponseBody>](../../models/.md)\>**
424
311
 
425
312
  ### Errors
426
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,9 +96,7 @@ const orq = new Orq({
98
96
  });
99
97
 
100
98
  async function run() {
101
- const result = await orq.files.list({
102
- limit: 50,
103
- });
99
+ const result = await orq.files.list({});
104
100
 
105
101
  // Handle the result
106
102
  console.log(result);
@@ -124,9 +120,7 @@ const orq = new OrqCore({
124
120
  });
125
121
 
126
122
  async function run() {
127
- const res = await filesList(orq, {
128
- limit: 50,
129
- });
123
+ const res = await filesList(orq, {});
130
124
 
131
125
  if (!res.ok) {
132
126
  throw res.error;
@@ -236,82 +230,6 @@ run();
236
230
  | --------------- | --------------- | --------------- |
237
231
  | errors.APIError | 4XX, 5XX | \*/\* |
238
232
 
239
- ## update
240
-
241
- Update file name
242
-
243
- ### Example Usage
244
-
245
- ```typescript
246
- import { Orq } from "@orq-ai/node";
247
-
248
- const orq = new Orq({
249
- apiKey: process.env["ORQ_API_KEY"] ?? "",
250
- });
251
-
252
- async function run() {
253
- const result = await orq.files.update({
254
- fileId: "<id>",
255
- });
256
-
257
- // Handle the result
258
- console.log(result);
259
- }
260
-
261
- run();
262
- ```
263
-
264
- ### Standalone function
265
-
266
- The standalone function version of this method:
267
-
268
- ```typescript
269
- import { OrqCore } from "@orq-ai/node/core.js";
270
- import { filesUpdate } from "@orq-ai/node/funcs/filesUpdate.js";
271
-
272
- // Use `OrqCore` for best tree-shaking performance.
273
- // You can create one instance of it to use across an application.
274
- const orq = new OrqCore({
275
- apiKey: process.env["ORQ_API_KEY"] ?? "",
276
- });
277
-
278
- async function run() {
279
- const res = await filesUpdate(orq, {
280
- fileId: "<id>",
281
- });
282
-
283
- if (!res.ok) {
284
- throw res.error;
285
- }
286
-
287
- const { value: result } = res;
288
-
289
- // Handle the result
290
- console.log(result);
291
- }
292
-
293
- run();
294
- ```
295
-
296
- ### Parameters
297
-
298
- | Parameter | Type | Required | Description |
299
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
300
- | `request` | [operations.FileUpdateRequest](../../models/operations/fileupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
301
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
302
- | `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. |
303
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
304
-
305
- ### Response
306
-
307
- **Promise\<[operations.FileUpdateResponseBody](../../models/operations/fileupdateresponsebody.md)\>**
308
-
309
- ### Errors
310
-
311
- | Error Type | Status Code | Content Type |
312
- | --------------- | --------------- | --------------- |
313
- | errors.APIError | 4XX, 5XX | \*/\* |
314
-
315
233
  ## delete
316
234
 
317
235
  Delete file
@@ -382,96 +300,6 @@ run();
382
300
 
383
301
  ### Errors
384
302
 
385
- | Error Type | Status Code | Content Type |
386
- | --------------- | --------------- | --------------- |
387
- | errors.APIError | 4XX, 5XX | \*/\* |
388
-
389
- ## bulkUpload
390
-
391
- Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
392
-
393
- ### Example Usage
394
-
395
- ```typescript
396
- import { Orq } from "@orq-ai/node";
397
- import { openAsBlob } from "node:fs";
398
-
399
- const orq = new Orq({
400
- apiKey: process.env["ORQ_API_KEY"] ?? "",
401
- });
402
-
403
- async function run() {
404
- const result = await orq.files.bulkUpload({
405
- files: [
406
- {
407
- fileName: "example.file",
408
- content: await openAsBlob("example.file"),
409
- },
410
- ],
411
- purpose: "knowledge_datasource",
412
- });
413
-
414
- // Handle the result
415
- console.log(result);
416
- }
417
-
418
- run();
419
- ```
420
-
421
- ### Standalone function
422
-
423
- The standalone function version of this method:
424
-
425
- ```typescript
426
- import { OrqCore } from "@orq-ai/node/core.js";
427
- import { filesBulkUpload } from "@orq-ai/node/funcs/filesBulkUpload.js";
428
- import { openAsBlob } from "node:fs";
429
-
430
- // Use `OrqCore` for best tree-shaking performance.
431
- // You can create one instance of it to use across an application.
432
- const orq = new OrqCore({
433
- apiKey: process.env["ORQ_API_KEY"] ?? "",
434
- });
435
-
436
- async function run() {
437
- const res = await filesBulkUpload(orq, {
438
- files: [
439
- {
440
- fileName: "example.file",
441
- content: await openAsBlob("example.file"),
442
- },
443
- ],
444
- purpose: "knowledge_datasource",
445
- });
446
-
447
- if (!res.ok) {
448
- throw res.error;
449
- }
450
-
451
- const { value: result } = res;
452
-
453
- // Handle the result
454
- console.log(result);
455
- }
456
-
457
- run();
458
- ```
459
-
460
- ### Parameters
461
-
462
- | Parameter | Type | Required | Description |
463
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
464
- | `request` | [operations.BulkFileUploadRequestBody](../../models/operations/bulkfileuploadrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
465
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
466
- | `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. |
467
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
468
-
469
- ### Response
470
-
471
- **Promise\<[operations.ResponseBody[]](../../models/.md)\>**
472
-
473
- ### Errors
474
-
475
303
  | Error Type | Status Code | Content Type |
476
304
  | --------------- | --------------- | --------------- |
477
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>