@orq-ai/node 1.31.1 → 1.32.0-rc.5

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 (310) hide show
  1. package/README.md +18 -46
  2. package/funcs/contactsCreate.d.ts.map +1 -1
  3. package/funcs/contactsCreate.js +1 -0
  4. package/funcs/contactsCreate.js.map +1 -1
  5. package/funcs/deploymentsAll.d.ts.map +1 -1
  6. package/funcs/deploymentsAll.js +1 -0
  7. package/funcs/deploymentsAll.js.map +1 -1
  8. package/funcs/deploymentsGetConfig.d.ts.map +1 -1
  9. package/funcs/deploymentsGetConfig.js +1 -0
  10. package/funcs/deploymentsGetConfig.js.map +1 -1
  11. package/funcs/deploymentsInvalidate.d.ts.map +1 -1
  12. package/funcs/deploymentsInvalidate.js +1 -0
  13. package/funcs/deploymentsInvalidate.js.map +1 -1
  14. package/funcs/deploymentsInvoke.d.ts.map +1 -1
  15. package/funcs/deploymentsInvoke.js +1 -0
  16. package/funcs/deploymentsInvoke.js.map +1 -1
  17. package/funcs/deploymentsMetricsCreate.d.ts.map +1 -1
  18. package/funcs/deploymentsMetricsCreate.js +1 -0
  19. package/funcs/deploymentsMetricsCreate.js.map +1 -1
  20. package/funcs/feedbackCreate.d.ts.map +1 -1
  21. package/funcs/feedbackCreate.js +1 -0
  22. package/funcs/feedbackCreate.js.map +1 -1
  23. package/funcs/filesBulkUpload.d.ts.map +1 -1
  24. package/funcs/filesBulkUpload.js +1 -0
  25. package/funcs/filesBulkUpload.js.map +1 -1
  26. package/funcs/filesUpload.d.ts.map +1 -1
  27. package/funcs/filesUpload.js +1 -0
  28. package/funcs/filesUpload.js.map +1 -1
  29. package/funcs/remoteconfigGetConfig.d.ts.map +1 -1
  30. package/funcs/remoteconfigGetConfig.js +1 -0
  31. package/funcs/remoteconfigGetConfig.js.map +1 -1
  32. package/lib/config.d.ts +4 -4
  33. package/lib/config.d.ts.map +1 -1
  34. package/lib/config.js +4 -4
  35. package/lib/config.js.map +1 -1
  36. package/lib/sdks.d.ts +5 -1
  37. package/lib/sdks.d.ts.map +1 -1
  38. package/lib/sdks.js +1 -0
  39. package/lib/sdks.js.map +1 -1
  40. package/models/errors/index.d.ts +0 -1
  41. package/models/errors/index.d.ts.map +1 -1
  42. package/models/errors/index.js +0 -1
  43. package/models/errors/index.js.map +1 -1
  44. package/models/operations/bulkfileupload.js +2 -2
  45. package/models/operations/createcontact.js +2 -2
  46. package/models/operations/deploymentgetconfig.d.ts +96 -96
  47. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  48. package/models/operations/deploymentgetconfig.js +135 -136
  49. package/models/operations/deploymentgetconfig.js.map +1 -1
  50. package/models/operations/deploymentinvoke.d.ts +49 -46
  51. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  52. package/models/operations/deploymentinvoke.js +63 -61
  53. package/models/operations/deploymentinvoke.js.map +1 -1
  54. package/models/operations/deployments.d.ts +53 -53
  55. package/models/operations/deployments.d.ts.map +1 -1
  56. package/models/operations/deployments.js +67 -66
  57. package/models/operations/deployments.js.map +1 -1
  58. package/models/operations/fileupload.js +2 -2
  59. package/models/operations/index.d.ts +0 -9
  60. package/models/operations/index.d.ts.map +1 -1
  61. package/models/operations/index.js +0 -9
  62. package/models/operations/index.js.map +1 -1
  63. package/package.json +3 -2
  64. package/sdk/sdk.d.ts +0 -6
  65. package/sdk/sdk.d.ts.map +1 -1
  66. package/sdk/sdk.js +0 -10
  67. package/sdk/sdk.js.map +1 -1
  68. package/src/funcs/contactsCreate.ts +1 -0
  69. package/src/funcs/deploymentsAll.ts +1 -0
  70. package/src/funcs/deploymentsGetConfig.ts +1 -0
  71. package/src/funcs/deploymentsInvalidate.ts +1 -0
  72. package/src/funcs/deploymentsInvoke.ts +1 -0
  73. package/src/funcs/deploymentsMetricsCreate.ts +1 -0
  74. package/src/funcs/feedbackCreate.ts +1 -0
  75. package/src/funcs/filesBulkUpload.ts +1 -0
  76. package/src/funcs/filesUpload.ts +1 -0
  77. package/src/funcs/remoteconfigGetConfig.ts +1 -0
  78. package/src/lib/config.ts +4 -4
  79. package/src/lib/sdks.ts +6 -1
  80. package/src/models/errors/index.ts +0 -1
  81. package/src/models/operations/bulkfileupload.ts +2 -2
  82. package/src/models/operations/createcontact.ts +2 -2
  83. package/src/models/operations/deploymentgetconfig.ts +188 -255
  84. package/src/models/operations/deploymentinvoke.ts +81 -95
  85. package/src/models/operations/deployments.ts +88 -101
  86. package/src/models/operations/fileupload.ts +2 -2
  87. package/src/models/operations/index.ts +0 -9
  88. package/src/sdk/sdk.ts +0 -12
  89. package/docs/sdks/prompt/README.md +0 -6
  90. package/docs/sdks/prompts/README.md +0 -533
  91. package/docs/sdks/snippets/README.md +0 -84
  92. package/docs/sdks/templates/README.md +0 -80
  93. package/funcs/promptSnippetsFindOne.d.ts +0 -12
  94. package/funcs/promptSnippetsFindOne.d.ts.map +0 -1
  95. package/funcs/promptSnippetsFindOne.js +0 -107
  96. package/funcs/promptSnippetsFindOne.js.map +0 -1
  97. package/funcs/promptTemplatesGetAll.d.ts +0 -12
  98. package/funcs/promptTemplatesGetAll.d.ts.map +0 -1
  99. package/funcs/promptTemplatesGetAll.js +0 -107
  100. package/funcs/promptTemplatesGetAll.js.map +0 -1
  101. package/funcs/promptsCreate.d.ts +0 -12
  102. package/funcs/promptsCreate.d.ts.map +0 -1
  103. package/funcs/promptsCreate.js +0 -104
  104. package/funcs/promptsCreate.js.map +0 -1
  105. package/funcs/promptsCreateVersion.d.ts +0 -12
  106. package/funcs/promptsCreateVersion.d.ts.map +0 -1
  107. package/funcs/promptsCreateVersion.js +0 -108
  108. package/funcs/promptsCreateVersion.js.map +0 -1
  109. package/funcs/promptsDelete.d.ts +0 -12
  110. package/funcs/promptsDelete.d.ts.map +0 -1
  111. package/funcs/promptsDelete.js +0 -108
  112. package/funcs/promptsDelete.js.map +0 -1
  113. package/funcs/promptsDuplicate.d.ts +0 -12
  114. package/funcs/promptsDuplicate.d.ts.map +0 -1
  115. package/funcs/promptsDuplicate.js +0 -108
  116. package/funcs/promptsDuplicate.js.map +0 -1
  117. package/funcs/promptsGetAll.d.ts +0 -12
  118. package/funcs/promptsGetAll.d.ts.map +0 -1
  119. package/funcs/promptsGetAll.js +0 -107
  120. package/funcs/promptsGetAll.js.map +0 -1
  121. package/funcs/promptsGetOne.d.ts +0 -12
  122. package/funcs/promptsGetOne.d.ts.map +0 -1
  123. package/funcs/promptsGetOne.js +0 -108
  124. package/funcs/promptsGetOne.js.map +0 -1
  125. package/funcs/promptsUpdate.d.ts +0 -13
  126. package/funcs/promptsUpdate.d.ts.map +0 -1
  127. package/funcs/promptsUpdate.js +0 -112
  128. package/funcs/promptsUpdate.js.map +0 -1
  129. package/models/errors/updateprompt.d.ts +0 -36
  130. package/models/errors/updateprompt.d.ts.map +0 -1
  131. package/models/errors/updateprompt.js +0 -79
  132. package/models/errors/updateprompt.js.map +0 -1
  133. package/models/operations/createprompt.d.ts +0 -2035
  134. package/models/operations/createprompt.d.ts.map +0 -1
  135. package/models/operations/createprompt.js +0 -1853
  136. package/models/operations/createprompt.js.map +0 -1
  137. package/models/operations/createpromptversion.d.ts +0 -2001
  138. package/models/operations/createpromptversion.d.ts.map +0 -1
  139. package/models/operations/createpromptversion.js +0 -1848
  140. package/models/operations/createpromptversion.js.map +0 -1
  141. package/models/operations/deleteprompt.d.ts +0 -32
  142. package/models/operations/deleteprompt.d.ts.map +0 -1
  143. package/models/operations/deleteprompt.js +0 -69
  144. package/models/operations/deleteprompt.js.map +0 -1
  145. package/models/operations/duplicateprompt.d.ts +0 -32
  146. package/models/operations/duplicateprompt.d.ts.map +0 -1
  147. package/models/operations/duplicateprompt.js +0 -69
  148. package/models/operations/duplicateprompt.js.map +0 -1
  149. package/models/operations/findonepromptsnippet.d.ts +0 -6278
  150. package/models/operations/findonepromptsnippet.d.ts.map +0 -1
  151. package/models/operations/findonepromptsnippet.js +0 -5891
  152. package/models/operations/findonepromptsnippet.js.map +0 -1
  153. package/models/operations/getallprompts.d.ts +0 -6613
  154. package/models/operations/getallprompts.d.ts.map +0 -1
  155. package/models/operations/getallprompts.js +0 -6161
  156. package/models/operations/getallprompts.js.map +0 -1
  157. package/models/operations/getallprompttemplates.d.ts +0 -6607
  158. package/models/operations/getallprompttemplates.d.ts.map +0 -1
  159. package/models/operations/getallprompttemplates.js +0 -6225
  160. package/models/operations/getallprompttemplates.js.map +0 -1
  161. package/models/operations/getoneprompt.d.ts +0 -32
  162. package/models/operations/getoneprompt.d.ts.map +0 -1
  163. package/models/operations/getoneprompt.js +0 -69
  164. package/models/operations/getoneprompt.js.map +0 -1
  165. package/models/operations/updateprompt.d.ts +0 -7251
  166. package/models/operations/updateprompt.d.ts.map +0 -1
  167. package/models/operations/updateprompt.js +0 -6678
  168. package/models/operations/updateprompt.js.map +0 -1
  169. package/packages/orq-rc/README.md +0 -556
  170. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  171. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -314
  172. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  173. package/packages/orq-rc/docs/sdks/files/README.md +0 -171
  174. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  175. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  176. package/packages/orq-rc/docs/sdks/prompt/README.md +0 -6
  177. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -533
  178. package/packages/orq-rc/docs/sdks/remoteconfig/README.md +0 -80
  179. package/packages/orq-rc/docs/sdks/snippets/README.md +0 -84
  180. package/packages/orq-rc/docs/sdks/templates/README.md +0 -80
  181. package/packages/orq-rc/src/core.ts +0 -13
  182. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -123
  183. package/packages/orq-rc/src/funcs/deploymentsAll.ts +0 -137
  184. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -131
  185. package/packages/orq-rc/src/funcs/deploymentsInvalidate.ts +0 -132
  186. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -134
  187. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -131
  188. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -123
  189. package/packages/orq-rc/src/funcs/filesBulkUpload.ts +0 -125
  190. package/packages/orq-rc/src/funcs/filesUpload.ts +0 -144
  191. package/packages/orq-rc/src/funcs/promptSnippetsFindOne.ts +0 -127
  192. package/packages/orq-rc/src/funcs/promptTemplatesGetAll.ts +0 -129
  193. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -123
  194. package/packages/orq-rc/src/funcs/promptsCreateVersion.ts +0 -128
  195. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -127
  196. package/packages/orq-rc/src/funcs/promptsDuplicate.ts +0 -127
  197. package/packages/orq-rc/src/funcs/promptsGetAll.ts +0 -127
  198. package/packages/orq-rc/src/funcs/promptsGetOne.ts +0 -127
  199. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -135
  200. package/packages/orq-rc/src/funcs/remoteconfigGetConfig.ts +0 -124
  201. package/packages/orq-rc/src/hooks/hooks.ts +0 -112
  202. package/packages/orq-rc/src/hooks/index.ts +0 -6
  203. package/packages/orq-rc/src/hooks/registration.ts +0 -14
  204. package/packages/orq-rc/src/hooks/types.ts +0 -102
  205. package/packages/orq-rc/src/index.ts +0 -7
  206. package/packages/orq-rc/src/lib/base64.ts +0 -37
  207. package/packages/orq-rc/src/lib/config.ts +0 -60
  208. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  209. package/packages/orq-rc/src/lib/encodings.ts +0 -449
  210. package/packages/orq-rc/src/lib/env.ts +0 -41
  211. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  212. package/packages/orq-rc/src/lib/files.ts +0 -40
  213. package/packages/orq-rc/src/lib/http.ts +0 -323
  214. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  215. package/packages/orq-rc/src/lib/logger.ts +0 -9
  216. package/packages/orq-rc/src/lib/matchers.ts +0 -325
  217. package/packages/orq-rc/src/lib/primitives.ts +0 -122
  218. package/packages/orq-rc/src/lib/retries.ts +0 -219
  219. package/packages/orq-rc/src/lib/schemas.ts +0 -86
  220. package/packages/orq-rc/src/lib/sdks.ts +0 -392
  221. package/packages/orq-rc/src/lib/security.ts +0 -254
  222. package/packages/orq-rc/src/lib/url.ts +0 -33
  223. package/packages/orq-rc/src/models/components/deployments.ts +0 -1607
  224. package/packages/orq-rc/src/models/components/index.ts +0 -6
  225. package/packages/orq-rc/src/models/components/security.ts +0 -71
  226. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  227. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  228. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  229. package/packages/orq-rc/src/models/errors/index.ts +0 -9
  230. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  231. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
  232. package/packages/orq-rc/src/models/operations/bulkfileupload.ts +0 -304
  233. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  234. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  235. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3455
  236. package/packages/orq-rc/src/models/operations/createpromptversion.ts +0 -3697
  237. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  238. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -1790
  239. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -3417
  240. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -2384
  241. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2086
  242. package/packages/orq-rc/src/models/operations/duplicateprompt.ts +0 -69
  243. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -311
  244. package/packages/orq-rc/src/models/operations/findonepromptsnippet.ts +0 -13629
  245. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -13390
  246. package/packages/orq-rc/src/models/operations/getallprompttemplates.ts +0 -13690
  247. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -69
  248. package/packages/orq-rc/src/models/operations/index.ts +0 -23
  249. package/packages/orq-rc/src/models/operations/invaliddeployment.ts +0 -75
  250. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  251. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -14407
  252. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  253. package/packages/orq-rc/src/sdk/deployments.ts +0 -93
  254. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  255. package/packages/orq-rc/src/sdk/files.ts +0 -45
  256. package/packages/orq-rc/src/sdk/index.ts +0 -5
  257. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  258. package/packages/orq-rc/src/sdk/prompt.ts +0 -19
  259. package/packages/orq-rc/src/sdk/prompts.ts +0 -114
  260. package/packages/orq-rc/src/sdk/remoteconfig.ts +0 -24
  261. package/packages/orq-rc/src/sdk/sdk.ts +0 -49
  262. package/packages/orq-rc/src/sdk/snippets.ts +0 -24
  263. package/packages/orq-rc/src/sdk/templates.ts +0 -24
  264. package/packages/orq-rc/src/types/blobs.ts +0 -31
  265. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  266. package/packages/orq-rc/src/types/enums.ts +0 -16
  267. package/packages/orq-rc/src/types/fp.ts +0 -50
  268. package/packages/orq-rc/src/types/index.ts +0 -11
  269. package/packages/orq-rc/src/types/operations.ts +0 -105
  270. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  271. package/packages/orq-rc/src/types/streams.ts +0 -21
  272. package/sdk/prompt.d.ts +0 -10
  273. package/sdk/prompt.d.ts.map +0 -1
  274. package/sdk/prompt.js +0 -21
  275. package/sdk/prompt.js.map +0 -1
  276. package/sdk/prompts.d.ts +0 -33
  277. package/sdk/prompts.d.ts.map +0 -1
  278. package/sdk/prompts.js +0 -61
  279. package/sdk/prompts.js.map +0 -1
  280. package/sdk/snippets.d.ts +0 -9
  281. package/sdk/snippets.d.ts.map +0 -1
  282. package/sdk/snippets.js +0 -19
  283. package/sdk/snippets.js.map +0 -1
  284. package/sdk/templates.d.ts +0 -9
  285. package/sdk/templates.d.ts.map +0 -1
  286. package/sdk/templates.js +0 -19
  287. package/sdk/templates.js.map +0 -1
  288. package/src/funcs/promptSnippetsFindOne.ts +0 -127
  289. package/src/funcs/promptTemplatesGetAll.ts +0 -129
  290. package/src/funcs/promptsCreate.ts +0 -123
  291. package/src/funcs/promptsCreateVersion.ts +0 -128
  292. package/src/funcs/promptsDelete.ts +0 -127
  293. package/src/funcs/promptsDuplicate.ts +0 -127
  294. package/src/funcs/promptsGetAll.ts +0 -127
  295. package/src/funcs/promptsGetOne.ts +0 -127
  296. package/src/funcs/promptsUpdate.ts +0 -135
  297. package/src/models/errors/updateprompt.ts +0 -71
  298. package/src/models/operations/createprompt.ts +0 -3455
  299. package/src/models/operations/createpromptversion.ts +0 -3697
  300. package/src/models/operations/deleteprompt.ts +0 -69
  301. package/src/models/operations/duplicateprompt.ts +0 -69
  302. package/src/models/operations/findonepromptsnippet.ts +0 -13629
  303. package/src/models/operations/getallprompts.ts +0 -13390
  304. package/src/models/operations/getallprompttemplates.ts +0 -13690
  305. package/src/models/operations/getoneprompt.ts +0 -69
  306. package/src/models/operations/updateprompt.ts +0 -14407
  307. package/src/sdk/prompt.ts +0 -19
  308. package/src/sdk/prompts.ts +0 -114
  309. package/src/sdk/snippets.ts +0 -24
  310. package/src/sdk/templates.ts +0 -24
@@ -1,86 +0,0 @@
1
- # Metrics
2
- (*deployments.metrics*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Add metrics
9
-
10
- ## create
11
-
12
- Add metrics to a deployment
13
-
14
- ### Example Usage
15
-
16
- ```typescript
17
- import { Orq } from "@orq-ai/node";
18
-
19
- const orq = new Orq({
20
- apiKey: process.env["ORQ_API_KEY"] ?? "",
21
- });
22
-
23
- async function run() {
24
- const result = await orq.deployments.metrics.create({
25
- id: "<id>",
26
- requestBody: {},
27
- });
28
-
29
- // Handle the result
30
- console.log(result);
31
- }
32
-
33
- run();
34
- ```
35
-
36
- ### Standalone function
37
-
38
- The standalone function version of this method:
39
-
40
- ```typescript
41
- import { OrqCore } from "@orq-ai/node/core.js";
42
- import { deploymentsMetricsCreate } from "@orq-ai/node/funcs/deploymentsMetricsCreate.js";
43
-
44
- // Use `OrqCore` for best tree-shaking performance.
45
- // You can create one instance of it to use across an application.
46
- const orq = new OrqCore({
47
- apiKey: process.env["ORQ_API_KEY"] ?? "",
48
- });
49
-
50
- async function run() {
51
- const res = await deploymentsMetricsCreate(orq, {
52
- id: "<id>",
53
- requestBody: {},
54
- });
55
-
56
- if (!res.ok) {
57
- throw res.error;
58
- }
59
-
60
- const { value: result } = res;
61
-
62
- // Handle the result
63
- console.log(result);
64
- }
65
-
66
- run();
67
- ```
68
-
69
- ### Parameters
70
-
71
- | Parameter | Type | Required | Description |
72
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
73
- | `request` | [operations.DeploymentCreateMetricRequest](../../models/operations/deploymentcreatemetricrequest.md) | :heavy_check_mark: | The request object to use for the request. |
74
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
75
- | `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. |
76
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
77
-
78
- ### Response
79
-
80
- **Promise\<[operations.DeploymentCreateMetricResponseBody](../../models/operations/deploymentcreatemetricresponsebody.md)\>**
81
-
82
- ### Errors
83
-
84
- | Error Type | Status Code | Content Type |
85
- | --------------- | --------------- | --------------- |
86
- | errors.APIError | 4XX, 5XX | \*/\* |
@@ -1,10 +0,0 @@
1
- # Orq SDK
2
-
3
- ## Overview
4
-
5
- [Dev] orq.ai API: The Orquesta API
6
-
7
- orq.ai Documentation
8
- <https://docs.orq.ai>
9
-
10
- ### Available Operations
@@ -1,6 +0,0 @@
1
- # Prompt
2
- (*prompt*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
@@ -1,533 +0,0 @@
1
- # Prompts
2
- (*prompts*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Create a new prompt
9
- * [createVersion](#createversion) - Create a new prompt version
10
- * [delete](#delete) - Delete a prompt
11
- * [getOne](#getone) - Get one prompt
12
- * [update](#update) - Update a prompt
13
- * [duplicate](#duplicate) - Duplicate a prompt
14
- * [getAll](#getall) - Get all prompts
15
-
16
- ## create
17
-
18
- Create a new prompt
19
-
20
- ### Example Usage
21
-
22
- ```typescript
23
- import { Orq } from "@orq-ai/node";
24
-
25
- const orq = new Orq({
26
- apiKey: process.env["ORQ_API_KEY"] ?? "",
27
- });
28
-
29
- async function run() {
30
- const result = await orq.prompts.create();
31
-
32
- // Handle the result
33
- console.log(result);
34
- }
35
-
36
- run();
37
- ```
38
-
39
- ### Standalone function
40
-
41
- The standalone function version of this method:
42
-
43
- ```typescript
44
- import { OrqCore } from "@orq-ai/node/core.js";
45
- import { promptsCreate } from "@orq-ai/node/funcs/promptsCreate.js";
46
-
47
- // Use `OrqCore` for best tree-shaking performance.
48
- // You can create one instance of it to use across an application.
49
- const orq = new OrqCore({
50
- apiKey: process.env["ORQ_API_KEY"] ?? "",
51
- });
52
-
53
- async function run() {
54
- const res = await promptsCreate(orq);
55
-
56
- if (!res.ok) {
57
- throw res.error;
58
- }
59
-
60
- const { value: result } = res;
61
-
62
- // Handle the result
63
- console.log(result);
64
- }
65
-
66
- run();
67
- ```
68
-
69
- ### Parameters
70
-
71
- | Parameter | Type | Required | Description |
72
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
73
- | `request` | [operations.CreatePromptRequestBody](../../models/operations/createpromptrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
74
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
75
- | `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. |
76
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
77
-
78
- ### Response
79
-
80
- **Promise\<[operations.CreatePromptResponseBody](../../models/operations/createpromptresponsebody.md)\>**
81
-
82
- ### Errors
83
-
84
- | Error Type | Status Code | Content Type |
85
- | --------------- | --------------- | --------------- |
86
- | errors.APIError | 4XX, 5XX | \*/\* |
87
-
88
- ## createVersion
89
-
90
- Create a new prompt version
91
-
92
- ### Example Usage
93
-
94
- ```typescript
95
- import { Orq } from "@orq-ai/node";
96
-
97
- const orq = new Orq({
98
- apiKey: process.env["ORQ_API_KEY"] ?? "",
99
- });
100
-
101
- async function run() {
102
- const result = await orq.prompts.createVersion({
103
- id: "<id>",
104
- });
105
-
106
- // Handle the result
107
- console.log(result);
108
- }
109
-
110
- run();
111
- ```
112
-
113
- ### Standalone function
114
-
115
- The standalone function version of this method:
116
-
117
- ```typescript
118
- import { OrqCore } from "@orq-ai/node/core.js";
119
- import { promptsCreateVersion } from "@orq-ai/node/funcs/promptsCreateVersion.js";
120
-
121
- // Use `OrqCore` for best tree-shaking performance.
122
- // You can create one instance of it to use across an application.
123
- const orq = new OrqCore({
124
- apiKey: process.env["ORQ_API_KEY"] ?? "",
125
- });
126
-
127
- async function run() {
128
- const res = await promptsCreateVersion(orq, {
129
- id: "<id>",
130
- });
131
-
132
- if (!res.ok) {
133
- throw res.error;
134
- }
135
-
136
- const { value: result } = res;
137
-
138
- // Handle the result
139
- console.log(result);
140
- }
141
-
142
- run();
143
- ```
144
-
145
- ### Parameters
146
-
147
- | Parameter | Type | Required | Description |
148
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
149
- | `request` | [operations.CreatePromptVersionRequest](../../models/operations/createpromptversionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
150
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
151
- | `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. |
152
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
153
-
154
- ### Response
155
-
156
- **Promise\<[operations.CreatePromptVersionResponseBody](../../models/operations/createpromptversionresponsebody.md)\>**
157
-
158
- ### Errors
159
-
160
- | Error Type | Status Code | Content Type |
161
- | --------------- | --------------- | --------------- |
162
- | errors.APIError | 4XX, 5XX | \*/\* |
163
-
164
- ## delete
165
-
166
- Delete a prompt
167
-
168
- ### Example Usage
169
-
170
- ```typescript
171
- import { Orq } from "@orq-ai/node";
172
-
173
- const orq = new Orq({
174
- apiKey: process.env["ORQ_API_KEY"] ?? "",
175
- });
176
-
177
- async function run() {
178
- await orq.prompts.delete({
179
- id: "<id>",
180
- });
181
-
182
-
183
- }
184
-
185
- run();
186
- ```
187
-
188
- ### Standalone function
189
-
190
- The standalone function version of this method:
191
-
192
- ```typescript
193
- import { OrqCore } from "@orq-ai/node/core.js";
194
- import { promptsDelete } from "@orq-ai/node/funcs/promptsDelete.js";
195
-
196
- // Use `OrqCore` for best tree-shaking performance.
197
- // You can create one instance of it to use across an application.
198
- const orq = new OrqCore({
199
- apiKey: process.env["ORQ_API_KEY"] ?? "",
200
- });
201
-
202
- async function run() {
203
- const res = await promptsDelete(orq, {
204
- id: "<id>",
205
- });
206
-
207
- if (!res.ok) {
208
- throw res.error;
209
- }
210
-
211
- const { value: result } = res;
212
-
213
-
214
- }
215
-
216
- run();
217
- ```
218
-
219
- ### Parameters
220
-
221
- | Parameter | Type | Required | Description |
222
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
223
- | `request` | [operations.DeletePromptRequest](../../models/operations/deletepromptrequest.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\<void\>**
231
-
232
- ### Errors
233
-
234
- | Error Type | Status Code | Content Type |
235
- | --------------- | --------------- | --------------- |
236
- | errors.APIError | 4XX, 5XX | \*/\* |
237
-
238
- ## getOne
239
-
240
- Get one prompt
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
- await orq.prompts.getOne({
253
- id: "<id>",
254
- });
255
-
256
-
257
- }
258
-
259
- run();
260
- ```
261
-
262
- ### Standalone function
263
-
264
- The standalone function version of this method:
265
-
266
- ```typescript
267
- import { OrqCore } from "@orq-ai/node/core.js";
268
- import { promptsGetOne } from "@orq-ai/node/funcs/promptsGetOne.js";
269
-
270
- // Use `OrqCore` for best tree-shaking performance.
271
- // You can create one instance of it to use across an application.
272
- const orq = new OrqCore({
273
- apiKey: process.env["ORQ_API_KEY"] ?? "",
274
- });
275
-
276
- async function run() {
277
- const res = await promptsGetOne(orq, {
278
- id: "<id>",
279
- });
280
-
281
- if (!res.ok) {
282
- throw res.error;
283
- }
284
-
285
- const { value: result } = res;
286
-
287
-
288
- }
289
-
290
- run();
291
- ```
292
-
293
- ### Parameters
294
-
295
- | Parameter | Type | Required | Description |
296
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
297
- | `request` | [operations.GetOnePromptRequest](../../models/operations/getonepromptrequest.md) | :heavy_check_mark: | The request object to use for the request. |
298
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
299
- | `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. |
300
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
301
-
302
- ### Response
303
-
304
- **Promise\<void\>**
305
-
306
- ### Errors
307
-
308
- | Error Type | Status Code | Content Type |
309
- | --------------- | --------------- | --------------- |
310
- | errors.APIError | 4XX, 5XX | \*/\* |
311
-
312
- ## update
313
-
314
- Update a prompt
315
-
316
- ### Example Usage
317
-
318
- ```typescript
319
- import { Orq } from "@orq-ai/node";
320
-
321
- const orq = new Orq({
322
- apiKey: process.env["ORQ_API_KEY"] ?? "",
323
- });
324
-
325
- async function run() {
326
- const result = await orq.prompts.update({
327
- id: "<id>",
328
- });
329
-
330
- // Handle the result
331
- console.log(result);
332
- }
333
-
334
- run();
335
- ```
336
-
337
- ### Standalone function
338
-
339
- The standalone function version of this method:
340
-
341
- ```typescript
342
- import { OrqCore } from "@orq-ai/node/core.js";
343
- import { promptsUpdate } from "@orq-ai/node/funcs/promptsUpdate.js";
344
-
345
- // Use `OrqCore` for best tree-shaking performance.
346
- // You can create one instance of it to use across an application.
347
- const orq = new OrqCore({
348
- apiKey: process.env["ORQ_API_KEY"] ?? "",
349
- });
350
-
351
- async function run() {
352
- const res = await promptsUpdate(orq, {
353
- id: "<id>",
354
- });
355
-
356
- if (!res.ok) {
357
- throw res.error;
358
- }
359
-
360
- const { value: result } = res;
361
-
362
- // Handle the result
363
- console.log(result);
364
- }
365
-
366
- run();
367
- ```
368
-
369
- ### Parameters
370
-
371
- | Parameter | Type | Required | Description |
372
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
373
- | `request` | [operations.UpdatePromptRequest](../../models/operations/updatepromptrequest.md) | :heavy_check_mark: | The request object to use for the request. |
374
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
375
- | `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. |
376
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
377
-
378
- ### Response
379
-
380
- **Promise\<[operations.UpdatePromptResponseBody](../../models/operations/updatepromptresponsebody.md)\>**
381
-
382
- ### Errors
383
-
384
- | Error Type | Status Code | Content Type |
385
- | ------------------------------- | ------------------------------- | ------------------------------- |
386
- | errors.UpdatePromptResponseBody | 404 | application/json |
387
- | errors.APIError | 4XX, 5XX | \*/\* |
388
-
389
- ## duplicate
390
-
391
- Duplicate a prompt
392
-
393
- ### Example Usage
394
-
395
- ```typescript
396
- import { Orq } from "@orq-ai/node";
397
-
398
- const orq = new Orq({
399
- apiKey: process.env["ORQ_API_KEY"] ?? "",
400
- });
401
-
402
- async function run() {
403
- await orq.prompts.duplicate({
404
- id: "<id>",
405
- });
406
-
407
-
408
- }
409
-
410
- run();
411
- ```
412
-
413
- ### Standalone function
414
-
415
- The standalone function version of this method:
416
-
417
- ```typescript
418
- import { OrqCore } from "@orq-ai/node/core.js";
419
- import { promptsDuplicate } from "@orq-ai/node/funcs/promptsDuplicate.js";
420
-
421
- // Use `OrqCore` for best tree-shaking performance.
422
- // You can create one instance of it to use across an application.
423
- const orq = new OrqCore({
424
- apiKey: process.env["ORQ_API_KEY"] ?? "",
425
- });
426
-
427
- async function run() {
428
- const res = await promptsDuplicate(orq, {
429
- id: "<id>",
430
- });
431
-
432
- if (!res.ok) {
433
- throw res.error;
434
- }
435
-
436
- const { value: result } = res;
437
-
438
-
439
- }
440
-
441
- run();
442
- ```
443
-
444
- ### Parameters
445
-
446
- | Parameter | Type | Required | Description |
447
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
448
- | `request` | [operations.DuplicatePromptRequest](../../models/operations/duplicatepromptrequest.md) | :heavy_check_mark: | The request object to use for the request. |
449
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
450
- | `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. |
451
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
452
-
453
- ### Response
454
-
455
- **Promise\<void\>**
456
-
457
- ### Errors
458
-
459
- | Error Type | Status Code | Content Type |
460
- | --------------- | --------------- | --------------- |
461
- | errors.APIError | 4XX, 5XX | \*/\* |
462
-
463
- ## getAll
464
-
465
- Get all prompts
466
-
467
- ### Example Usage
468
-
469
- ```typescript
470
- import { Orq } from "@orq-ai/node";
471
-
472
- const orq = new Orq({
473
- apiKey: process.env["ORQ_API_KEY"] ?? "",
474
- });
475
-
476
- async function run() {
477
- const result = await orq.prompts.getAll();
478
-
479
- // Handle the result
480
- console.log(result);
481
- }
482
-
483
- run();
484
- ```
485
-
486
- ### Standalone function
487
-
488
- The standalone function version of this method:
489
-
490
- ```typescript
491
- import { OrqCore } from "@orq-ai/node/core.js";
492
- import { promptsGetAll } from "@orq-ai/node/funcs/promptsGetAll.js";
493
-
494
- // Use `OrqCore` for best tree-shaking performance.
495
- // You can create one instance of it to use across an application.
496
- const orq = new OrqCore({
497
- apiKey: process.env["ORQ_API_KEY"] ?? "",
498
- });
499
-
500
- async function run() {
501
- const res = await promptsGetAll(orq);
502
-
503
- if (!res.ok) {
504
- throw res.error;
505
- }
506
-
507
- const { value: result } = res;
508
-
509
- // Handle the result
510
- console.log(result);
511
- }
512
-
513
- run();
514
- ```
515
-
516
- ### Parameters
517
-
518
- | Parameter | Type | Required | Description |
519
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
520
- | `request` | [operations.GetAllPromptsRequest](../../models/operations/getallpromptsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
521
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
522
- | `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. |
523
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
524
-
525
- ### Response
526
-
527
- **Promise\<[operations.GetAllPromptsResponseBody](../../models/operations/getallpromptsresponsebody.md)\>**
528
-
529
- ### Errors
530
-
531
- | Error Type | Status Code | Content Type |
532
- | --------------- | --------------- | --------------- |
533
- | errors.APIError | 4XX, 5XX | \*/\* |