@orq-ai/node 3.12.0-rc.50 → 3.12.1

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 (508) hide show
  1. package/bin/mcp-server.js +115 -112
  2. package/bin/mcp-server.js.map +33 -33
  3. package/docs/sdks/budgets/README.md +2 -4
  4. package/examples/package-lock.json +6 -5
  5. package/jsr.json +1 -1
  6. package/lib/config.d.ts +2 -2
  7. package/lib/config.js +2 -2
  8. package/lib/config.js.map +1 -1
  9. package/mcp-server/mcp-server.js +1 -1
  10. package/mcp-server/mcp-server.js.map +1 -1
  11. package/mcp-server/server.js +1 -1
  12. package/mcp-server/server.js.map +1 -1
  13. package/models/operations/createbudget.js +2 -2
  14. package/models/operations/createcontact.js +2 -2
  15. package/models/operations/createdataset.js +2 -2
  16. package/models/operations/createdatasetitem.js +2 -2
  17. package/models/operations/createdatasource.js +2 -2
  18. package/models/operations/createeval.js +16 -16
  19. package/models/operations/fileget.js +2 -2
  20. package/models/operations/filelist.js +2 -2
  21. package/models/operations/fileupload.js +2 -2
  22. package/models/operations/getbudget.js +2 -2
  23. package/models/operations/getevals.js +28 -28
  24. package/models/operations/listbudgets.js +2 -2
  25. package/models/operations/listcontacts.js +2 -2
  26. package/models/operations/listdatasetdatapoints.js +2 -2
  27. package/models/operations/listdatasets.js +2 -2
  28. package/models/operations/listdatasources.js +2 -2
  29. package/models/operations/retrievecontact.js +2 -2
  30. package/models/operations/retrievedatapoint.js +2 -2
  31. package/models/operations/retrievedataset.js +2 -2
  32. package/models/operations/retrievedatasource.js +2 -2
  33. package/models/operations/updatebudget.js +2 -2
  34. package/models/operations/updatecontact.js +2 -2
  35. package/models/operations/updatedatapoint.js +2 -2
  36. package/models/operations/updatedataset.js +2 -2
  37. package/models/operations/updatedatasource.js +2 -2
  38. package/models/operations/updateeval.js +16 -16
  39. package/package.json +4 -4
  40. package/packages/orq-rc/FUNCTIONS.md +103 -0
  41. package/packages/orq-rc/README.md +973 -0
  42. package/packages/orq-rc/RUNTIMES.md +48 -0
  43. package/packages/orq-rc/docs/sdks/budgets/README.md +401 -0
  44. package/packages/orq-rc/docs/sdks/chunking/README.md +95 -0
  45. package/packages/orq-rc/docs/sdks/contacts/README.md +450 -0
  46. package/packages/orq-rc/docs/sdks/datasets/README.md +836 -0
  47. package/packages/orq-rc/docs/sdks/deployments/README.md +314 -0
  48. package/packages/orq-rc/docs/sdks/evals/README.md +3077 -0
  49. package/packages/orq-rc/docs/sdks/feedback/README.md +89 -0
  50. package/packages/orq-rc/docs/sdks/files/README.md +301 -0
  51. package/packages/orq-rc/docs/sdks/knowledge/README.md +1243 -0
  52. package/packages/orq-rc/docs/sdks/metrics/README.md +83 -0
  53. package/packages/orq-rc/docs/sdks/models/README.md +76 -0
  54. package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
  55. package/packages/orq-rc/docs/sdks/prompts/README.md +557 -0
  56. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +77 -0
  57. package/packages/orq-rc/examples/README.md +31 -0
  58. package/packages/orq-rc/examples/contactsCreate.example.ts +42 -0
  59. package/packages/orq-rc/examples/package-lock.json +627 -0
  60. package/packages/orq-rc/examples/package.json +18 -0
  61. package/packages/orq-rc/jsr.json +28 -0
  62. package/packages/orq-rc/package-lock.json +3071 -0
  63. package/packages/orq-rc/package.json +43 -0
  64. package/packages/orq-rc/src/core.ts +13 -0
  65. package/packages/orq-rc/src/funcs/budgetsCreate.ts +160 -0
  66. package/packages/orq-rc/src/funcs/budgetsDelete.ts +167 -0
  67. package/packages/orq-rc/src/funcs/budgetsGet.ts +166 -0
  68. package/packages/orq-rc/src/funcs/budgetsList.ts +170 -0
  69. package/packages/orq-rc/src/funcs/budgetsUpdate.ts +167 -0
  70. package/packages/orq-rc/src/funcs/chunkingParse.ts +160 -0
  71. package/packages/orq-rc/src/funcs/contactsCreate.ts +165 -0
  72. package/packages/orq-rc/src/funcs/contactsDelete.ts +176 -0
  73. package/packages/orq-rc/src/funcs/contactsList.ts +169 -0
  74. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +175 -0
  75. package/packages/orq-rc/src/funcs/contactsUpdate.ts +176 -0
  76. package/packages/orq-rc/src/funcs/datasetsClear.ts +167 -0
  77. package/packages/orq-rc/src/funcs/datasetsCreate.ts +165 -0
  78. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +168 -0
  79. package/packages/orq-rc/src/funcs/datasetsDelete.ts +167 -0
  80. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +182 -0
  81. package/packages/orq-rc/src/funcs/datasetsList.ts +167 -0
  82. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +174 -0
  83. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +175 -0
  84. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +181 -0
  85. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +176 -0
  86. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +179 -0
  87. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +168 -0
  88. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +176 -0
  89. package/packages/orq-rc/src/funcs/deploymentsList.ts +176 -0
  90. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +168 -0
  91. package/packages/orq-rc/src/funcs/deploymentsStream.ts +183 -0
  92. package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +175 -0
  93. package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
  94. package/packages/orq-rc/src/funcs/evalsBertScore.ts +175 -0
  95. package/packages/orq-rc/src/funcs/evalsBleuScore.ts +175 -0
  96. package/packages/orq-rc/src/funcs/evalsBotDetection.ts +175 -0
  97. package/packages/orq-rc/src/funcs/evalsContains.ts +175 -0
  98. package/packages/orq-rc/src/funcs/evalsContainsAll.ts +175 -0
  99. package/packages/orq-rc/src/funcs/evalsContainsAny.ts +175 -0
  100. package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +175 -0
  101. package/packages/orq-rc/src/funcs/evalsContainsNone.ts +175 -0
  102. package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +175 -0
  103. package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +177 -0
  104. package/packages/orq-rc/src/funcs/evalsCreate.ts +169 -0
  105. package/packages/orq-rc/src/funcs/evalsDelete.ts +173 -0
  106. package/packages/orq-rc/src/funcs/evalsEndsWith.ts +175 -0
  107. package/packages/orq-rc/src/funcs/evalsExactMatch.ts +175 -0
  108. package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +183 -0
  109. package/packages/orq-rc/src/funcs/evalsGrammar.ts +173 -0
  110. package/packages/orq-rc/src/funcs/evalsInvoke.ts +177 -0
  111. package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +175 -0
  112. package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +177 -0
  113. package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +175 -0
  114. package/packages/orq-rc/src/funcs/evalsLocalization.ts +175 -0
  115. package/packages/orq-rc/src/funcs/evalsPii.ts +173 -0
  116. package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +175 -0
  117. package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +174 -0
  118. package/packages/orq-rc/src/funcs/evalsRagasContextEntitiesRecall.ts +183 -0
  119. package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +180 -0
  120. package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +177 -0
  121. package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +174 -0
  122. package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +177 -0
  123. package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +174 -0
  124. package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +177 -0
  125. package/packages/orq-rc/src/funcs/evalsRagasNoiseSensitivity.ts +180 -0
  126. package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +183 -0
  127. package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +177 -0
  128. package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +183 -0
  129. package/packages/orq-rc/src/funcs/evalsSummarization.ts +175 -0
  130. package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +175 -0
  131. package/packages/orq-rc/src/funcs/evalsTranslation.ts +175 -0
  132. package/packages/orq-rc/src/funcs/evalsUpdate.ts +173 -0
  133. package/packages/orq-rc/src/funcs/evalsValidJson.ts +175 -0
  134. package/packages/orq-rc/src/funcs/feedbackCreate.ts +160 -0
  135. package/packages/orq-rc/src/funcs/filesCreate.ts +187 -0
  136. package/packages/orq-rc/src/funcs/filesDelete.ts +164 -0
  137. package/packages/orq-rc/src/funcs/filesGet.ts +166 -0
  138. package/packages/orq-rc/src/funcs/filesList.ts +167 -0
  139. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
  140. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +171 -0
  141. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +166 -0
  142. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +167 -0
  143. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +174 -0
  144. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +173 -0
  145. package/packages/orq-rc/src/funcs/knowledgeList.ts +169 -0
  146. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +178 -0
  147. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +174 -0
  148. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +166 -0
  149. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +173 -0
  150. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +169 -0
  151. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +167 -0
  152. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +164 -0
  153. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +174 -0
  154. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +170 -0
  155. package/packages/orq-rc/src/funcs/modelsList.ts +142 -0
  156. package/packages/orq-rc/src/funcs/promptsCreate.ts +160 -0
  157. package/packages/orq-rc/src/funcs/promptsDelete.ts +164 -0
  158. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +181 -0
  159. package/packages/orq-rc/src/funcs/promptsList.ts +167 -0
  160. package/packages/orq-rc/src/funcs/promptsListVersions.ts +173 -0
  161. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +166 -0
  162. package/packages/orq-rc/src/funcs/promptsUpdate.ts +173 -0
  163. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +161 -0
  164. package/packages/orq-rc/src/hooks/global.ts +44 -0
  165. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  166. package/packages/orq-rc/src/hooks/index.ts +6 -0
  167. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  168. package/packages/orq-rc/src/hooks/types.ts +112 -0
  169. package/packages/orq-rc/src/index.ts +9 -0
  170. package/packages/orq-rc/src/lib/base64.ts +37 -0
  171. package/packages/orq-rc/src/lib/config.ts +74 -0
  172. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  173. package/packages/orq-rc/src/lib/encodings.ts +483 -0
  174. package/packages/orq-rc/src/lib/env.ts +73 -0
  175. package/packages/orq-rc/src/lib/event-streams.ts +137 -0
  176. package/packages/orq-rc/src/lib/files.ts +82 -0
  177. package/packages/orq-rc/src/lib/http.ts +323 -0
  178. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  179. package/packages/orq-rc/src/lib/logger.ts +9 -0
  180. package/packages/orq-rc/src/lib/matchers.ts +345 -0
  181. package/packages/orq-rc/src/lib/primitives.ts +150 -0
  182. package/packages/orq-rc/src/lib/retries.ts +218 -0
  183. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  184. package/packages/orq-rc/src/lib/sdks.ts +407 -0
  185. package/packages/orq-rc/src/lib/security.ts +264 -0
  186. package/packages/orq-rc/src/lib/url.ts +33 -0
  187. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +112 -0
  188. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +136 -0
  189. package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
  190. package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
  191. package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
  192. package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
  193. package/packages/orq-rc/src/mcp-server/prompts.ts +117 -0
  194. package/packages/orq-rc/src/mcp-server/resources.ts +172 -0
  195. package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
  196. package/packages/orq-rc/src/mcp-server/server.ts +261 -0
  197. package/packages/orq-rc/src/mcp-server/shared.ts +75 -0
  198. package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +37 -0
  199. package/packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts +35 -0
  200. package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +37 -0
  201. package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +37 -0
  202. package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +37 -0
  203. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +37 -0
  204. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
  205. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
  206. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
  207. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
  208. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
  209. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
  210. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
  211. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
  212. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
  213. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
  214. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
  215. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
  216. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
  217. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
  218. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
  219. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
  220. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
  221. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
  222. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
  223. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
  224. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
  225. package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +35 -0
  226. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +35 -0
  227. package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +35 -0
  228. package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +35 -0
  229. package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +35 -0
  230. package/packages/orq-rc/src/mcp-server/tools/evalsContains.ts +35 -0
  231. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +35 -0
  232. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +35 -0
  233. package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +35 -0
  234. package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +35 -0
  235. package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +35 -0
  236. package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +36 -0
  237. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +35 -0
  238. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +33 -0
  239. package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +35 -0
  240. package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +35 -0
  241. package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +37 -0
  242. package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +35 -0
  243. package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +35 -0
  244. package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +35 -0
  245. package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +36 -0
  246. package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +35 -0
  247. package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +35 -0
  248. package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +35 -0
  249. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +35 -0
  250. package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +35 -0
  251. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +37 -0
  252. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +36 -0
  253. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextRecall.ts +36 -0
  254. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +35 -0
  255. package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +36 -0
  256. package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +35 -0
  257. package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +36 -0
  258. package/packages/orq-rc/src/mcp-server/tools/evalsRagasNoiseSensitivity.ts +36 -0
  259. package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +36 -0
  260. package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +36 -0
  261. package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +36 -0
  262. package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +35 -0
  263. package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +35 -0
  264. package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +35 -0
  265. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +35 -0
  266. package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +35 -0
  267. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
  268. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
  269. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
  270. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
  271. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
  272. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
  273. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
  274. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
  275. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +35 -0
  276. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
  277. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
  278. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +37 -0
  279. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
  280. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
  281. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
  282. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
  283. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
  284. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +37 -0
  285. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
  286. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
  287. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
  288. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +30 -0
  289. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
  290. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
  291. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
  292. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
  293. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
  294. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
  295. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
  296. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
  297. package/packages/orq-rc/src/mcp-server/tools.ts +129 -0
  298. package/packages/orq-rc/src/models/components/deployments.ts +8107 -0
  299. package/packages/orq-rc/src/models/components/index.ts +6 -0
  300. package/packages/orq-rc/src/models/components/security.ts +71 -0
  301. package/packages/orq-rc/src/models/errors/apierror.ts +40 -0
  302. package/packages/orq-rc/src/models/errors/createeval.ts +80 -0
  303. package/packages/orq-rc/src/models/errors/deletecontact.ts +91 -0
  304. package/packages/orq-rc/src/models/errors/deleteeval.ts +80 -0
  305. package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +156 -0
  306. package/packages/orq-rc/src/models/errors/evalsbertscore.ts +154 -0
  307. package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +154 -0
  308. package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +155 -0
  309. package/packages/orq-rc/src/models/errors/evalscontains.ts +154 -0
  310. package/packages/orq-rc/src/models/errors/evalscontainsall.ts +155 -0
  311. package/packages/orq-rc/src/models/errors/evalscontainsany.ts +155 -0
  312. package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +156 -0
  313. package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +155 -0
  314. package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +155 -0
  315. package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +157 -0
  316. package/packages/orq-rc/src/models/errors/evalsendswith.ts +154 -0
  317. package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +154 -0
  318. package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +160 -0
  319. package/packages/orq-rc/src/models/errors/evalsgrammar.ts +154 -0
  320. package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +156 -0
  321. package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +157 -0
  322. package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +156 -0
  323. package/packages/orq-rc/src/models/errors/evalslocalization.ts +155 -0
  324. package/packages/orq-rc/src/models/errors/evalspii.ts +154 -0
  325. package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +156 -0
  326. package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +157 -0
  327. package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +163 -0
  328. package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +160 -0
  329. package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +158 -0
  330. package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +157 -0
  331. package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +157 -0
  332. package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +157 -0
  333. package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +158 -0
  334. package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +160 -0
  335. package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +160 -0
  336. package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +158 -0
  337. package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +160 -0
  338. package/packages/orq-rc/src/models/errors/evalssummarization.ts +156 -0
  339. package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +155 -0
  340. package/packages/orq-rc/src/models/errors/evalstranslation.ts +155 -0
  341. package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +154 -0
  342. package/packages/orq-rc/src/models/errors/getevals.ts +80 -0
  343. package/packages/orq-rc/src/models/errors/getpromptversion.ts +80 -0
  344. package/packages/orq-rc/src/models/errors/honoapierror.ts +90 -0
  345. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  346. package/packages/orq-rc/src/models/errors/index.ts +56 -0
  347. package/packages/orq-rc/src/models/errors/invokeeval.ts +154 -0
  348. package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
  349. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
  350. package/packages/orq-rc/src/models/errors/retrievecontact.ts +91 -0
  351. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +109 -0
  352. package/packages/orq-rc/src/models/errors/updatecontact.ts +83 -0
  353. package/packages/orq-rc/src/models/errors/updateeval.ts +80 -0
  354. package/packages/orq-rc/src/models/errors/updateprompt.ts +80 -0
  355. package/packages/orq-rc/src/models/operations/cleardataset.ts +75 -0
  356. package/packages/orq-rc/src/models/operations/createbudget.ts +736 -0
  357. package/packages/orq-rc/src/models/operations/createchunk.ts +438 -0
  358. package/packages/orq-rc/src/models/operations/createcontact.ts +267 -0
  359. package/packages/orq-rc/src/models/operations/createdataset.ts +296 -0
  360. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +6186 -0
  361. package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -0
  362. package/packages/orq-rc/src/models/operations/createeval.ts +3830 -0
  363. package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
  364. package/packages/orq-rc/src/models/operations/createknowledge.ts +846 -0
  365. package/packages/orq-rc/src/models/operations/createprompt.ts +4375 -0
  366. package/packages/orq-rc/src/models/operations/deletebudget.ts +66 -0
  367. package/packages/orq-rc/src/models/operations/deletechunk.ts +96 -0
  368. package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
  369. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +81 -0
  370. package/packages/orq-rc/src/models/operations/deletedataset.ts +75 -0
  371. package/packages/orq-rc/src/models/operations/deletedatasource.ts +87 -0
  372. package/packages/orq-rc/src/models/operations/deleteeval.ts +66 -0
  373. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +78 -0
  374. package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
  375. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +6507 -0
  376. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +10352 -0
  377. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1259 -0
  378. package/packages/orq-rc/src/models/operations/deployments.ts +2468 -0
  379. package/packages/orq-rc/src/models/operations/deploymentstream.ts +10615 -0
  380. package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +253 -0
  381. package/packages/orq-rc/src/models/operations/evalsbertscore.ts +197 -0
  382. package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +131 -0
  383. package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +249 -0
  384. package/packages/orq-rc/src/models/operations/evalscontains.ts +250 -0
  385. package/packages/orq-rc/src/models/operations/evalscontainsall.ts +248 -0
  386. package/packages/orq-rc/src/models/operations/evalscontainsany.ts +254 -0
  387. package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +181 -0
  388. package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +254 -0
  389. package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +181 -0
  390. package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +186 -0
  391. package/packages/orq-rc/src/models/operations/evalsendswith.ts +250 -0
  392. package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +183 -0
  393. package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +299 -0
  394. package/packages/orq-rc/src/models/operations/evalsgrammar.ts +243 -0
  395. package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +268 -0
  396. package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +266 -0
  397. package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +259 -0
  398. package/packages/orq-rc/src/models/operations/evalslocalization.ts +253 -0
  399. package/packages/orq-rc/src/models/operations/evalspii.ts +243 -0
  400. package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +152 -0
  401. package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +153 -0
  402. package/packages/orq-rc/src/models/operations/evalsragascontextentitiesrecall.ts +164 -0
  403. package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +166 -0
  404. package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +164 -0
  405. package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +153 -0
  406. package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +155 -0
  407. package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +146 -0
  408. package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +157 -0
  409. package/packages/orq-rc/src/models/operations/evalsragasnoisesensitivity.ts +166 -0
  410. package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +165 -0
  411. package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +150 -0
  412. package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +285 -0
  413. package/packages/orq-rc/src/models/operations/evalssummarization.ts +253 -0
  414. package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +251 -0
  415. package/packages/orq-rc/src/models/operations/evalstranslation.ts +251 -0
  416. package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +177 -0
  417. package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
  418. package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
  419. package/packages/orq-rc/src/models/operations/filelist.ts +337 -0
  420. package/packages/orq-rc/src/models/operations/fileupload.ts +327 -0
  421. package/packages/orq-rc/src/models/operations/getallprompts.ts +2438 -0
  422. package/packages/orq-rc/src/models/operations/getbudget.ts +437 -0
  423. package/packages/orq-rc/src/models/operations/getevals.ts +7290 -0
  424. package/packages/orq-rc/src/models/operations/getonechunk.ts +315 -0
  425. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +537 -0
  426. package/packages/orq-rc/src/models/operations/getoneprompt.ts +2299 -0
  427. package/packages/orq-rc/src/models/operations/getpromptversion.ts +2306 -0
  428. package/packages/orq-rc/src/models/operations/index.ts +103 -0
  429. package/packages/orq-rc/src/models/operations/invokeeval.ts +2520 -0
  430. package/packages/orq-rc/src/models/operations/listbudgets.ts +617 -0
  431. package/packages/orq-rc/src/models/operations/listchunks.ts +494 -0
  432. package/packages/orq-rc/src/models/operations/listcontacts.ts +490 -0
  433. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +3280 -0
  434. package/packages/orq-rc/src/models/operations/listdatasets.ts +406 -0
  435. package/packages/orq-rc/src/models/operations/listdatasources.ts +447 -0
  436. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +663 -0
  437. package/packages/orq-rc/src/models/operations/listmodels.ts +273 -0
  438. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2439 -0
  439. package/packages/orq-rc/src/models/operations/parse.ts +1610 -0
  440. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
  441. package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
  442. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +3062 -0
  443. package/packages/orq-rc/src/models/operations/retrievedataset.ts +288 -0
  444. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +273 -0
  445. package/packages/orq-rc/src/models/operations/searchknowledge.ts +3816 -0
  446. package/packages/orq-rc/src/models/operations/updatebudget.ts +624 -0
  447. package/packages/orq-rc/src/models/operations/updatechunk.ts +448 -0
  448. package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
  449. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +6127 -0
  450. package/packages/orq-rc/src/models/operations/updatedataset.ts +393 -0
  451. package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
  452. package/packages/orq-rc/src/models/operations/updateeval.ts +4131 -0
  453. package/packages/orq-rc/src/models/operations/updateknowledge.ts +980 -0
  454. package/packages/orq-rc/src/models/operations/updateprompt.ts +4516 -0
  455. package/packages/orq-rc/src/sdk/budgets.ts +99 -0
  456. package/packages/orq-rc/src/sdk/chunking.ts +27 -0
  457. package/packages/orq-rc/src/sdk/contacts.ts +99 -0
  458. package/packages/orq-rc/src/sdk/datasets.ts +204 -0
  459. package/packages/orq-rc/src/sdk/deployments.ts +89 -0
  460. package/packages/orq-rc/src/sdk/evals.ts +639 -0
  461. package/packages/orq-rc/src/sdk/feedback.ts +27 -0
  462. package/packages/orq-rc/src/sdk/files.ts +78 -0
  463. package/packages/orq-rc/src/sdk/index.ts +5 -0
  464. package/packages/orq-rc/src/sdk/knowledge.ts +264 -0
  465. package/packages/orq-rc/src/sdk/metrics.ts +27 -0
  466. package/packages/orq-rc/src/sdk/models.ts +25 -0
  467. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  468. package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
  469. package/packages/orq-rc/src/sdk/sdk.ts +79 -0
  470. package/packages/orq-rc/src/types/async.ts +68 -0
  471. package/packages/orq-rc/src/types/blobs.ts +31 -0
  472. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  473. package/packages/orq-rc/src/types/enums.ts +16 -0
  474. package/packages/orq-rc/src/types/fp.ts +50 -0
  475. package/packages/orq-rc/src/types/index.ts +11 -0
  476. package/packages/orq-rc/src/types/operations.ts +105 -0
  477. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  478. package/packages/orq-rc/src/types/streams.ts +21 -0
  479. package/packages/orq-rc/tsconfig.json +41 -0
  480. package/src/lib/config.ts +2 -2
  481. package/src/mcp-server/mcp-server.ts +1 -1
  482. package/src/mcp-server/server.ts +1 -1
  483. package/src/models/operations/createbudget.ts +2 -2
  484. package/src/models/operations/createcontact.ts +2 -2
  485. package/src/models/operations/createdataset.ts +2 -2
  486. package/src/models/operations/createdatasetitem.ts +2 -2
  487. package/src/models/operations/createdatasource.ts +2 -2
  488. package/src/models/operations/createeval.ts +16 -16
  489. package/src/models/operations/fileget.ts +2 -2
  490. package/src/models/operations/filelist.ts +2 -2
  491. package/src/models/operations/fileupload.ts +2 -2
  492. package/src/models/operations/getbudget.ts +2 -2
  493. package/src/models/operations/getevals.ts +28 -28
  494. package/src/models/operations/listbudgets.ts +2 -2
  495. package/src/models/operations/listcontacts.ts +2 -2
  496. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  497. package/src/models/operations/listdatasets.ts +2 -2
  498. package/src/models/operations/listdatasources.ts +2 -2
  499. package/src/models/operations/retrievecontact.ts +2 -2
  500. package/src/models/operations/retrievedatapoint.ts +2 -2
  501. package/src/models/operations/retrievedataset.ts +2 -2
  502. package/src/models/operations/retrievedatasource.ts +2 -2
  503. package/src/models/operations/updatebudget.ts +2 -2
  504. package/src/models/operations/updatecontact.ts +2 -2
  505. package/src/models/operations/updatedatapoint.ts +2 -2
  506. package/src/models/operations/updatedataset.ts +2 -2
  507. package/src/models/operations/updatedatasource.ts +2 -2
  508. package/src/models/operations/updateeval.ts +16 -16
@@ -0,0 +1,557 @@
1
+ # Prompts
2
+ (*prompts*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [list](#list) - List all prompts
9
+ * [create](#create) - Create a prompt
10
+ * [retrieve](#retrieve) - Retrieve a prompt
11
+ * [update](#update) - Update a prompt
12
+ * [delete](#delete) - Delete a prompt
13
+ * [listVersions](#listversions) - List all prompt versions
14
+ * [getVersion](#getversion) - Retrieve a prompt version
15
+
16
+ ## list
17
+
18
+ Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first
19
+
20
+ ### Example Usage
21
+
22
+ <!-- UsageSnippet language="typescript" operationID="GetAllPrompts" method="get" path="/v2/prompts" -->
23
+ ```typescript
24
+ import { Orq } from "@orq-ai/node";
25
+
26
+ const orq = new Orq({
27
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
28
+ });
29
+
30
+ async function run() {
31
+ const result = await orq.prompts.list({});
32
+
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 { promptsList } from "@orq-ai/node/funcs/promptsList.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 promptsList(orq, {});
55
+ if (res.ok) {
56
+ const { value: result } = res;
57
+ console.log(result);
58
+ } else {
59
+ console.log("promptsList failed:", res.error);
60
+ }
61
+ }
62
+
63
+ run();
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ | Parameter | Type | Required | Description |
69
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
70
+ | `request` | [operations.GetAllPromptsRequest](../../models/operations/getallpromptsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
71
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
72
+ | `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. |
73
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
74
+
75
+ ### Response
76
+
77
+ **Promise\<[operations.GetAllPromptsResponseBody](../../models/operations/getallpromptsresponsebody.md)\>**
78
+
79
+ ### Errors
80
+
81
+ | Error Type | Status Code | Content Type |
82
+ | --------------- | --------------- | --------------- |
83
+ | errors.APIError | 4XX, 5XX | \*/\* |
84
+
85
+ ## create
86
+
87
+ Create a prompt
88
+
89
+ ### Example Usage
90
+
91
+ <!-- UsageSnippet language="typescript" operationID="CreatePrompt" method="post" path="/v2/prompts" -->
92
+ ```typescript
93
+ import { Orq } from "@orq-ai/node";
94
+
95
+ const orq = new Orq({
96
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
97
+ });
98
+
99
+ async function run() {
100
+ const result = await orq.prompts.create({
101
+ displayName: "Raymundo83",
102
+ promptConfig: {
103
+ messages: [
104
+ {
105
+ role: "assistant",
106
+ content: "<value>",
107
+ },
108
+ {
109
+ role: "assistant",
110
+ content: "<value>",
111
+ },
112
+ ],
113
+ },
114
+ path: "Default",
115
+ });
116
+
117
+ console.log(result);
118
+ }
119
+
120
+ run();
121
+ ```
122
+
123
+ ### Standalone function
124
+
125
+ The standalone function version of this method:
126
+
127
+ ```typescript
128
+ import { OrqCore } from "@orq-ai/node/core.js";
129
+ import { promptsCreate } from "@orq-ai/node/funcs/promptsCreate.js";
130
+
131
+ // Use `OrqCore` for best tree-shaking performance.
132
+ // You can create one instance of it to use across an application.
133
+ const orq = new OrqCore({
134
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
135
+ });
136
+
137
+ async function run() {
138
+ const res = await promptsCreate(orq, {
139
+ displayName: "Raymundo83",
140
+ promptConfig: {
141
+ messages: [
142
+ {
143
+ role: "assistant",
144
+ content: "<value>",
145
+ },
146
+ {
147
+ role: "assistant",
148
+ content: "<value>",
149
+ },
150
+ ],
151
+ },
152
+ path: "Default",
153
+ });
154
+ if (res.ok) {
155
+ const { value: result } = res;
156
+ console.log(result);
157
+ } else {
158
+ console.log("promptsCreate failed:", res.error);
159
+ }
160
+ }
161
+
162
+ run();
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+ | Parameter | Type | Required | Description |
168
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
169
+ | `request` | [operations.CreatePromptRequestBody](../../models/operations/createpromptrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
170
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
171
+ | `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. |
172
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
173
+
174
+ ### Response
175
+
176
+ **Promise\<[operations.CreatePromptResponseBody](../../models/operations/createpromptresponsebody.md)\>**
177
+
178
+ ### Errors
179
+
180
+ | Error Type | Status Code | Content Type |
181
+ | --------------- | --------------- | --------------- |
182
+ | errors.APIError | 4XX, 5XX | \*/\* |
183
+
184
+ ## retrieve
185
+
186
+ Retrieves a prompt object
187
+
188
+ ### Example Usage
189
+
190
+ <!-- UsageSnippet language="typescript" operationID="GetOnePrompt" method="get" path="/v2/prompts/{id}" -->
191
+ ```typescript
192
+ import { Orq } from "@orq-ai/node";
193
+
194
+ const orq = new Orq({
195
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
196
+ });
197
+
198
+ async function run() {
199
+ const result = await orq.prompts.retrieve({
200
+ id: "<id>",
201
+ });
202
+
203
+ console.log(result);
204
+ }
205
+
206
+ run();
207
+ ```
208
+
209
+ ### Standalone function
210
+
211
+ The standalone function version of this method:
212
+
213
+ ```typescript
214
+ import { OrqCore } from "@orq-ai/node/core.js";
215
+ import { promptsRetrieve } from "@orq-ai/node/funcs/promptsRetrieve.js";
216
+
217
+ // Use `OrqCore` for best tree-shaking performance.
218
+ // You can create one instance of it to use across an application.
219
+ const orq = new OrqCore({
220
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
221
+ });
222
+
223
+ async function run() {
224
+ const res = await promptsRetrieve(orq, {
225
+ id: "<id>",
226
+ });
227
+ if (res.ok) {
228
+ const { value: result } = res;
229
+ console.log(result);
230
+ } else {
231
+ console.log("promptsRetrieve failed:", res.error);
232
+ }
233
+ }
234
+
235
+ run();
236
+ ```
237
+
238
+ ### Parameters
239
+
240
+ | Parameter | Type | Required | Description |
241
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
242
+ | `request` | [operations.GetOnePromptRequest](../../models/operations/getonepromptrequest.md) | :heavy_check_mark: | The request object to use for the request. |
243
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
244
+ | `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. |
245
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
246
+
247
+ ### Response
248
+
249
+ **Promise\<[operations.GetOnePromptResponseBody](../../models/operations/getonepromptresponsebody.md)\>**
250
+
251
+ ### Errors
252
+
253
+ | Error Type | Status Code | Content Type |
254
+ | --------------- | --------------- | --------------- |
255
+ | errors.APIError | 4XX, 5XX | \*/\* |
256
+
257
+ ## update
258
+
259
+ Update a prompt
260
+
261
+ ### Example Usage
262
+
263
+ <!-- UsageSnippet language="typescript" operationID="UpdatePrompt" method="patch" path="/v2/prompts/{id}" -->
264
+ ```typescript
265
+ import { Orq } from "@orq-ai/node";
266
+
267
+ const orq = new Orq({
268
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
269
+ });
270
+
271
+ async function run() {
272
+ const result = await orq.prompts.update({
273
+ id: "<id>",
274
+ requestBody: {
275
+ path: "Default",
276
+ },
277
+ });
278
+
279
+ console.log(result);
280
+ }
281
+
282
+ run();
283
+ ```
284
+
285
+ ### Standalone function
286
+
287
+ The standalone function version of this method:
288
+
289
+ ```typescript
290
+ import { OrqCore } from "@orq-ai/node/core.js";
291
+ import { promptsUpdate } from "@orq-ai/node/funcs/promptsUpdate.js";
292
+
293
+ // Use `OrqCore` for best tree-shaking performance.
294
+ // You can create one instance of it to use across an application.
295
+ const orq = new OrqCore({
296
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
297
+ });
298
+
299
+ async function run() {
300
+ const res = await promptsUpdate(orq, {
301
+ id: "<id>",
302
+ requestBody: {
303
+ path: "Default",
304
+ },
305
+ });
306
+ if (res.ok) {
307
+ const { value: result } = res;
308
+ console.log(result);
309
+ } else {
310
+ console.log("promptsUpdate failed:", res.error);
311
+ }
312
+ }
313
+
314
+ run();
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+ | Parameter | Type | Required | Description |
320
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
321
+ | `request` | [operations.UpdatePromptRequest](../../models/operations/updatepromptrequest.md) | :heavy_check_mark: | The request object to use for the request. |
322
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
323
+ | `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. |
324
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
325
+
326
+ ### Response
327
+
328
+ **Promise\<[operations.UpdatePromptResponseBody](../../models/operations/updatepromptresponsebody.md)\>**
329
+
330
+ ### Errors
331
+
332
+ | Error Type | Status Code | Content Type |
333
+ | ------------------------------- | ------------------------------- | ------------------------------- |
334
+ | errors.UpdatePromptResponseBody | 404 | application/json |
335
+ | errors.APIError | 4XX, 5XX | \*/\* |
336
+
337
+ ## delete
338
+
339
+ Delete a prompt
340
+
341
+ ### Example Usage
342
+
343
+ <!-- UsageSnippet language="typescript" operationID="DeletePrompt" method="delete" path="/v2/prompts/{id}" -->
344
+ ```typescript
345
+ import { Orq } from "@orq-ai/node";
346
+
347
+ const orq = new Orq({
348
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
349
+ });
350
+
351
+ async function run() {
352
+ await orq.prompts.delete({
353
+ id: "<id>",
354
+ });
355
+
356
+
357
+ }
358
+
359
+ run();
360
+ ```
361
+
362
+ ### Standalone function
363
+
364
+ The standalone function version of this method:
365
+
366
+ ```typescript
367
+ import { OrqCore } from "@orq-ai/node/core.js";
368
+ import { promptsDelete } from "@orq-ai/node/funcs/promptsDelete.js";
369
+
370
+ // Use `OrqCore` for best tree-shaking performance.
371
+ // You can create one instance of it to use across an application.
372
+ const orq = new OrqCore({
373
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
374
+ });
375
+
376
+ async function run() {
377
+ const res = await promptsDelete(orq, {
378
+ id: "<id>",
379
+ });
380
+ if (res.ok) {
381
+ const { value: result } = res;
382
+
383
+ } else {
384
+ console.log("promptsDelete failed:", res.error);
385
+ }
386
+ }
387
+
388
+ run();
389
+ ```
390
+
391
+ ### Parameters
392
+
393
+ | Parameter | Type | Required | Description |
394
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
395
+ | `request` | [operations.DeletePromptRequest](../../models/operations/deletepromptrequest.md) | :heavy_check_mark: | The request object to use for the request. |
396
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
397
+ | `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. |
398
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
399
+
400
+ ### Response
401
+
402
+ **Promise\<void\>**
403
+
404
+ ### Errors
405
+
406
+ | Error Type | Status Code | Content Type |
407
+ | --------------- | --------------- | --------------- |
408
+ | errors.APIError | 4XX, 5XX | \*/\* |
409
+
410
+ ## listVersions
411
+
412
+ Returns a list of your prompt versions. The prompt versions are returned sorted by creation date, with the most recent prompt versions appearing first
413
+
414
+ ### Example Usage
415
+
416
+ <!-- UsageSnippet language="typescript" operationID="ListPromptVersions" method="get" path="/v2/prompts/{prompt_id}/versions" -->
417
+ ```typescript
418
+ import { Orq } from "@orq-ai/node";
419
+
420
+ const orq = new Orq({
421
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
422
+ });
423
+
424
+ async function run() {
425
+ const result = await orq.prompts.listVersions({
426
+ promptId: "<id>",
427
+ });
428
+
429
+ console.log(result);
430
+ }
431
+
432
+ run();
433
+ ```
434
+
435
+ ### Standalone function
436
+
437
+ The standalone function version of this method:
438
+
439
+ ```typescript
440
+ import { OrqCore } from "@orq-ai/node/core.js";
441
+ import { promptsListVersions } from "@orq-ai/node/funcs/promptsListVersions.js";
442
+
443
+ // Use `OrqCore` for best tree-shaking performance.
444
+ // You can create one instance of it to use across an application.
445
+ const orq = new OrqCore({
446
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
447
+ });
448
+
449
+ async function run() {
450
+ const res = await promptsListVersions(orq, {
451
+ promptId: "<id>",
452
+ });
453
+ if (res.ok) {
454
+ const { value: result } = res;
455
+ console.log(result);
456
+ } else {
457
+ console.log("promptsListVersions failed:", res.error);
458
+ }
459
+ }
460
+
461
+ run();
462
+ ```
463
+
464
+ ### Parameters
465
+
466
+ | Parameter | Type | Required | Description |
467
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
468
+ | `request` | [operations.ListPromptVersionsRequest](../../models/operations/listpromptversionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
469
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
470
+ | `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. |
471
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
472
+
473
+ ### Response
474
+
475
+ **Promise\<[operations.ListPromptVersionsResponseBody](../../models/operations/listpromptversionsresponsebody.md)\>**
476
+
477
+ ### Errors
478
+
479
+ | Error Type | Status Code | Content Type |
480
+ | --------------- | --------------- | --------------- |
481
+ | errors.APIError | 4XX, 5XX | \*/\* |
482
+
483
+ ## getVersion
484
+
485
+ Retrieves a specific version of a prompt by its ID and version ID.
486
+
487
+ ### Example Usage
488
+
489
+ <!-- UsageSnippet language="typescript" operationID="GetPromptVersion" method="get" path="/v2/prompts/{prompt_id}/versions/{version_id}" -->
490
+ ```typescript
491
+ import { Orq } from "@orq-ai/node";
492
+
493
+ const orq = new Orq({
494
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
495
+ });
496
+
497
+ async function run() {
498
+ const result = await orq.prompts.getVersion({
499
+ promptId: "<id>",
500
+ versionId: "<id>",
501
+ });
502
+
503
+ console.log(result);
504
+ }
505
+
506
+ run();
507
+ ```
508
+
509
+ ### Standalone function
510
+
511
+ The standalone function version of this method:
512
+
513
+ ```typescript
514
+ import { OrqCore } from "@orq-ai/node/core.js";
515
+ import { promptsGetVersion } from "@orq-ai/node/funcs/promptsGetVersion.js";
516
+
517
+ // Use `OrqCore` for best tree-shaking performance.
518
+ // You can create one instance of it to use across an application.
519
+ const orq = new OrqCore({
520
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
521
+ });
522
+
523
+ async function run() {
524
+ const res = await promptsGetVersion(orq, {
525
+ promptId: "<id>",
526
+ versionId: "<id>",
527
+ });
528
+ if (res.ok) {
529
+ const { value: result } = res;
530
+ console.log(result);
531
+ } else {
532
+ console.log("promptsGetVersion failed:", res.error);
533
+ }
534
+ }
535
+
536
+ run();
537
+ ```
538
+
539
+ ### Parameters
540
+
541
+ | Parameter | Type | Required | Description |
542
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
543
+ | `request` | [operations.GetPromptVersionRequest](../../models/operations/getpromptversionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
544
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
545
+ | `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. |
546
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
547
+
548
+ ### Response
549
+
550
+ **Promise\<[operations.GetPromptVersionResponseBody](../../models/operations/getpromptversionresponsebody.md)\>**
551
+
552
+ ### Errors
553
+
554
+ | Error Type | Status Code | Content Type |
555
+ | ----------------------------------- | ----------------------------------- | ----------------------------------- |
556
+ | errors.GetPromptVersionResponseBody | 404 | application/json |
557
+ | errors.APIError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,77 @@
1
+ # Remoteconfigs
2
+ (*remoteconfigs*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [retrieve](#retrieve) - Retrieve a remote config
9
+
10
+ ## retrieve
11
+
12
+ Retrieve a remote config
13
+
14
+ ### Example Usage
15
+
16
+ <!-- UsageSnippet language="typescript" operationID="RemoteConfigsGetConfig" method="post" path="/v2/remoteconfigs" -->
17
+ ```typescript
18
+ import { Orq } from "@orq-ai/node";
19
+
20
+ const orq = new Orq({
21
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
22
+ });
23
+
24
+ async function run() {
25
+ const result = await orq.remoteconfigs.retrieve();
26
+
27
+ console.log(result);
28
+ }
29
+
30
+ run();
31
+ ```
32
+
33
+ ### Standalone function
34
+
35
+ The standalone function version of this method:
36
+
37
+ ```typescript
38
+ import { OrqCore } from "@orq-ai/node/core.js";
39
+ import { remoteconfigsRetrieve } from "@orq-ai/node/funcs/remoteconfigsRetrieve.js";
40
+
41
+ // Use `OrqCore` for best tree-shaking performance.
42
+ // You can create one instance of it to use across an application.
43
+ const orq = new OrqCore({
44
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
45
+ });
46
+
47
+ async function run() {
48
+ const res = await remoteconfigsRetrieve(orq);
49
+ if (res.ok) {
50
+ const { value: result } = res;
51
+ console.log(result);
52
+ } else {
53
+ console.log("remoteconfigsRetrieve failed:", res.error);
54
+ }
55
+ }
56
+
57
+ run();
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Parameter | Type | Required | Description |
63
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
64
+ | `request` | [operations.RemoteConfigsGetConfigRequestBody](../../models/operations/remoteconfigsgetconfigrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
65
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
66
+ | `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. |
67
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
68
+
69
+ ### Response
70
+
71
+ **Promise\<[operations.RemoteConfigsGetConfigResponseBody](../../models/operations/remoteconfigsgetconfigresponsebody.md)\>**
72
+
73
+ ### Errors
74
+
75
+ | Error Type | Status Code | Content Type |
76
+ | --------------- | --------------- | --------------- |
77
+ | errors.APIError | 4XX, 5XX | \*/\* |