@orq-ai/node 3.9.3 → 3.10.0-rc.0

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