@orq-ai/node 3.10.19 → 3.11.0-rc.10

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 (492) hide show
  1. package/bin/mcp-server.js +105 -108
  2. package/bin/mcp-server.js.map +31 -31
  3. package/docs/sdks/contacts/README.md +1 -1
  4. package/examples/package-lock.json +5 -6
  5. package/funcs/contactsCreate.d.ts +1 -1
  6. package/funcs/contactsCreate.js +1 -1
  7. package/jsr.json +1 -1
  8. package/lib/config.d.ts +2 -2
  9. package/lib/config.js +2 -2
  10. package/lib/config.js.map +1 -1
  11. package/mcp-server/mcp-server.js +1 -1
  12. package/mcp-server/mcp-server.js.map +1 -1
  13. package/mcp-server/server.js +1 -1
  14. package/mcp-server/server.js.map +1 -1
  15. package/mcp-server/tools/contactsCreate.js +1 -1
  16. package/mcp-server/tools/contactsCreate.js.map +1 -1
  17. package/models/operations/createcontact.js +2 -2
  18. package/models/operations/createdataset.js +2 -2
  19. package/models/operations/createdatasetitem.js +2 -2
  20. package/models/operations/createdatasource.js +2 -2
  21. package/models/operations/createeval.js +16 -16
  22. package/models/operations/fileget.js +2 -2
  23. package/models/operations/filelist.js +2 -2
  24. package/models/operations/fileupload.js +2 -2
  25. package/models/operations/getevals.js +28 -28
  26. package/models/operations/listcontacts.js +2 -2
  27. package/models/operations/listdatasetdatapoints.js +2 -2
  28. package/models/operations/listdatasets.js +2 -2
  29. package/models/operations/listdatasources.js +2 -2
  30. package/models/operations/retrievecontact.js +2 -2
  31. package/models/operations/retrievedatapoint.js +2 -2
  32. package/models/operations/retrievedataset.js +2 -2
  33. package/models/operations/retrievedatasource.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/sdk/contacts.d.ts +1 -1
  41. package/sdk/contacts.js +1 -1
  42. package/src/funcs/contactsCreate.ts +1 -1
  43. package/src/lib/config.ts +2 -2
  44. package/src/mcp-server/mcp-server.ts +1 -1
  45. package/src/mcp-server/server.ts +1 -1
  46. package/src/mcp-server/tools/contactsCreate.ts +1 -1
  47. package/src/models/operations/createcontact.ts +2 -2
  48. package/src/models/operations/createdataset.ts +2 -2
  49. package/src/models/operations/createdatasetitem.ts +2 -2
  50. package/src/models/operations/createdatasource.ts +2 -2
  51. package/src/models/operations/createeval.ts +16 -16
  52. package/src/models/operations/fileget.ts +2 -2
  53. package/src/models/operations/filelist.ts +2 -2
  54. package/src/models/operations/fileupload.ts +2 -2
  55. package/src/models/operations/getevals.ts +28 -28
  56. package/src/models/operations/listcontacts.ts +2 -2
  57. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  58. package/src/models/operations/listdatasets.ts +2 -2
  59. package/src/models/operations/listdatasources.ts +2 -2
  60. package/src/models/operations/retrievecontact.ts +2 -2
  61. package/src/models/operations/retrievedatapoint.ts +2 -2
  62. package/src/models/operations/retrievedataset.ts +2 -2
  63. package/src/models/operations/retrievedatasource.ts +2 -2
  64. package/src/models/operations/updatecontact.ts +2 -2
  65. package/src/models/operations/updatedatapoint.ts +2 -2
  66. package/src/models/operations/updatedataset.ts +2 -2
  67. package/src/models/operations/updatedatasource.ts +2 -2
  68. package/src/models/operations/updateeval.ts +16 -16
  69. package/src/sdk/contacts.ts +1 -1
  70. package/packages/orq-rc/FUNCTIONS.md +0 -103
  71. package/packages/orq-rc/README.md +0 -960
  72. package/packages/orq-rc/RUNTIMES.md +0 -48
  73. package/packages/orq-rc/docs/sdks/chunking/README.md +0 -95
  74. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -450
  75. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -836
  76. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -314
  77. package/packages/orq-rc/docs/sdks/evals/README.md +0 -3077
  78. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -89
  79. package/packages/orq-rc/docs/sdks/files/README.md +0 -301
  80. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1243
  81. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -83
  82. package/packages/orq-rc/docs/sdks/models/README.md +0 -76
  83. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  84. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -557
  85. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -77
  86. package/packages/orq-rc/examples/README.md +0 -31
  87. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
  88. package/packages/orq-rc/examples/package-lock.json +0 -627
  89. package/packages/orq-rc/examples/package.json +0 -18
  90. package/packages/orq-rc/jsr.json +0 -28
  91. package/packages/orq-rc/package-lock.json +0 -3071
  92. package/packages/orq-rc/package.json +0 -43
  93. package/packages/orq-rc/src/core.ts +0 -13
  94. package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
  95. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -165
  96. package/packages/orq-rc/src/funcs/contactsDelete.ts +0 -176
  97. package/packages/orq-rc/src/funcs/contactsList.ts +0 -169
  98. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +0 -175
  99. package/packages/orq-rc/src/funcs/contactsUpdate.ts +0 -176
  100. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
  101. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  102. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -168
  103. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
  104. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
  105. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  106. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
  107. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
  108. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
  109. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
  110. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
  111. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  112. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  113. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  114. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
  115. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -183
  116. package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +0 -175
  117. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  118. package/packages/orq-rc/src/funcs/evalsBertScore.ts +0 -175
  119. package/packages/orq-rc/src/funcs/evalsBleuScore.ts +0 -175
  120. package/packages/orq-rc/src/funcs/evalsBotDetection.ts +0 -175
  121. package/packages/orq-rc/src/funcs/evalsContains.ts +0 -175
  122. package/packages/orq-rc/src/funcs/evalsContainsAll.ts +0 -175
  123. package/packages/orq-rc/src/funcs/evalsContainsAny.ts +0 -175
  124. package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +0 -175
  125. package/packages/orq-rc/src/funcs/evalsContainsNone.ts +0 -175
  126. package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +0 -175
  127. package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +0 -177
  128. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  129. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
  130. package/packages/orq-rc/src/funcs/evalsEndsWith.ts +0 -175
  131. package/packages/orq-rc/src/funcs/evalsExactMatch.ts +0 -175
  132. package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +0 -183
  133. package/packages/orq-rc/src/funcs/evalsGrammar.ts +0 -173
  134. package/packages/orq-rc/src/funcs/evalsInvoke.ts +0 -177
  135. package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +0 -175
  136. package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +0 -177
  137. package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +0 -175
  138. package/packages/orq-rc/src/funcs/evalsLocalization.ts +0 -175
  139. package/packages/orq-rc/src/funcs/evalsPii.ts +0 -173
  140. package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +0 -175
  141. package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +0 -174
  142. package/packages/orq-rc/src/funcs/evalsRagasContextEntitiesRecall.ts +0 -183
  143. package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +0 -180
  144. package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +0 -177
  145. package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +0 -174
  146. package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +0 -177
  147. package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +0 -174
  148. package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +0 -177
  149. package/packages/orq-rc/src/funcs/evalsRagasNoiseSensitivity.ts +0 -180
  150. package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +0 -183
  151. package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +0 -177
  152. package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +0 -183
  153. package/packages/orq-rc/src/funcs/evalsSummarization.ts +0 -175
  154. package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +0 -175
  155. package/packages/orq-rc/src/funcs/evalsTranslation.ts +0 -175
  156. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
  157. package/packages/orq-rc/src/funcs/evalsValidJson.ts +0 -175
  158. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -160
  159. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
  160. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
  161. package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
  162. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  163. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
  164. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
  165. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
  166. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
  167. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
  168. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
  169. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  170. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
  171. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
  172. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
  173. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
  174. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
  175. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
  176. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -164
  177. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
  178. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
  179. package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
  180. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  181. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -164
  182. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
  183. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  184. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
  185. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -166
  186. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
  187. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  188. package/packages/orq-rc/src/hooks/global.ts +0 -44
  189. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  190. package/packages/orq-rc/src/hooks/index.ts +0 -6
  191. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  192. package/packages/orq-rc/src/hooks/types.ts +0 -112
  193. package/packages/orq-rc/src/index.ts +0 -9
  194. package/packages/orq-rc/src/lib/base64.ts +0 -37
  195. package/packages/orq-rc/src/lib/config.ts +0 -74
  196. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  197. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  198. package/packages/orq-rc/src/lib/env.ts +0 -73
  199. package/packages/orq-rc/src/lib/event-streams.ts +0 -137
  200. package/packages/orq-rc/src/lib/files.ts +0 -82
  201. package/packages/orq-rc/src/lib/http.ts +0 -323
  202. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  203. package/packages/orq-rc/src/lib/logger.ts +0 -9
  204. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  205. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  206. package/packages/orq-rc/src/lib/retries.ts +0 -218
  207. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  208. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  209. package/packages/orq-rc/src/lib/security.ts +0 -261
  210. package/packages/orq-rc/src/lib/url.ts +0 -33
  211. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -112
  212. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
  213. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  214. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  215. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  216. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  217. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  218. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  219. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  220. package/packages/orq-rc/src/mcp-server/server.ts +0 -251
  221. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  222. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +0 -37
  223. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  224. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
  225. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
  226. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
  227. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
  228. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  229. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  230. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  231. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  232. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  233. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  234. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  235. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  236. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  237. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  238. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  239. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  240. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  241. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  242. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  243. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  244. package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +0 -35
  245. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
  246. package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +0 -35
  247. package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +0 -35
  248. package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +0 -35
  249. package/packages/orq-rc/src/mcp-server/tools/evalsContains.ts +0 -35
  250. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +0 -35
  251. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +0 -35
  252. package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +0 -35
  253. package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +0 -35
  254. package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +0 -35
  255. package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +0 -36
  256. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
  257. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
  258. package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +0 -35
  259. package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +0 -35
  260. package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +0 -37
  261. package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +0 -35
  262. package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +0 -35
  263. package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +0 -35
  264. package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +0 -36
  265. package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +0 -35
  266. package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +0 -35
  267. package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +0 -35
  268. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +0 -35
  269. package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +0 -35
  270. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +0 -37
  271. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +0 -36
  272. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextRecall.ts +0 -36
  273. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +0 -35
  274. package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +0 -36
  275. package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +0 -35
  276. package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +0 -36
  277. package/packages/orq-rc/src/mcp-server/tools/evalsRagasNoiseSensitivity.ts +0 -36
  278. package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +0 -36
  279. package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +0 -36
  280. package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +0 -36
  281. package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +0 -35
  282. package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +0 -35
  283. package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +0 -35
  284. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
  285. package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +0 -35
  286. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  287. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  288. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  289. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  290. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  291. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  292. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  293. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  294. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  295. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  296. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  297. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  298. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  299. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  300. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  301. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  302. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  303. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  304. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  305. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  306. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  307. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  308. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  309. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  310. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  311. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  312. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  313. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  314. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  315. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  316. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  317. package/packages/orq-rc/src/models/components/deployments.ts +0 -7246
  318. package/packages/orq-rc/src/models/components/index.ts +0 -6
  319. package/packages/orq-rc/src/models/components/security.ts +0 -71
  320. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  321. package/packages/orq-rc/src/models/errors/createeval.ts +0 -80
  322. package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -91
  323. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -80
  324. package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +0 -156
  325. package/packages/orq-rc/src/models/errors/evalsbertscore.ts +0 -154
  326. package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +0 -154
  327. package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +0 -155
  328. package/packages/orq-rc/src/models/errors/evalscontains.ts +0 -154
  329. package/packages/orq-rc/src/models/errors/evalscontainsall.ts +0 -155
  330. package/packages/orq-rc/src/models/errors/evalscontainsany.ts +0 -155
  331. package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +0 -156
  332. package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +0 -155
  333. package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +0 -155
  334. package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +0 -157
  335. package/packages/orq-rc/src/models/errors/evalsendswith.ts +0 -154
  336. package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +0 -154
  337. package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +0 -160
  338. package/packages/orq-rc/src/models/errors/evalsgrammar.ts +0 -154
  339. package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +0 -156
  340. package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +0 -157
  341. package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +0 -156
  342. package/packages/orq-rc/src/models/errors/evalslocalization.ts +0 -155
  343. package/packages/orq-rc/src/models/errors/evalspii.ts +0 -154
  344. package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +0 -156
  345. package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +0 -157
  346. package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +0 -163
  347. package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +0 -160
  348. package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +0 -158
  349. package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +0 -157
  350. package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +0 -157
  351. package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +0 -157
  352. package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +0 -158
  353. package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +0 -160
  354. package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +0 -160
  355. package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +0 -158
  356. package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +0 -160
  357. package/packages/orq-rc/src/models/errors/evalssummarization.ts +0 -156
  358. package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +0 -155
  359. package/packages/orq-rc/src/models/errors/evalstranslation.ts +0 -155
  360. package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +0 -154
  361. package/packages/orq-rc/src/models/errors/getevals.ts +0 -80
  362. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -80
  363. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -90
  364. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  365. package/packages/orq-rc/src/models/errors/index.ts +0 -56
  366. package/packages/orq-rc/src/models/errors/invokeeval.ts +0 -154
  367. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  368. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  369. package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -91
  370. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  371. package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -83
  372. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -80
  373. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -80
  374. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  375. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -438
  376. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -267
  377. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  378. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -5205
  379. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  380. package/packages/orq-rc/src/models/operations/createeval.ts +0 -3830
  381. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  382. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -846
  383. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -4373
  384. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  385. package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -69
  386. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  387. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  388. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  389. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -66
  390. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  391. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  392. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5439
  393. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -9480
  394. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1258
  395. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2467
  396. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -9449
  397. package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +0 -253
  398. package/packages/orq-rc/src/models/operations/evalsbertscore.ts +0 -197
  399. package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +0 -131
  400. package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +0 -249
  401. package/packages/orq-rc/src/models/operations/evalscontains.ts +0 -250
  402. package/packages/orq-rc/src/models/operations/evalscontainsall.ts +0 -248
  403. package/packages/orq-rc/src/models/operations/evalscontainsany.ts +0 -254
  404. package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +0 -181
  405. package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +0 -254
  406. package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +0 -181
  407. package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +0 -186
  408. package/packages/orq-rc/src/models/operations/evalsendswith.ts +0 -250
  409. package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +0 -183
  410. package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +0 -299
  411. package/packages/orq-rc/src/models/operations/evalsgrammar.ts +0 -243
  412. package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +0 -268
  413. package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +0 -266
  414. package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +0 -259
  415. package/packages/orq-rc/src/models/operations/evalslocalization.ts +0 -253
  416. package/packages/orq-rc/src/models/operations/evalspii.ts +0 -243
  417. package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +0 -152
  418. package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +0 -153
  419. package/packages/orq-rc/src/models/operations/evalsragascontextentitiesrecall.ts +0 -164
  420. package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +0 -166
  421. package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +0 -164
  422. package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +0 -153
  423. package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +0 -155
  424. package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +0 -146
  425. package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +0 -157
  426. package/packages/orq-rc/src/models/operations/evalsragasnoisesensitivity.ts +0 -166
  427. package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +0 -165
  428. package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +0 -150
  429. package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +0 -285
  430. package/packages/orq-rc/src/models/operations/evalssummarization.ts +0 -253
  431. package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +0 -251
  432. package/packages/orq-rc/src/models/operations/evalstranslation.ts +0 -251
  433. package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +0 -177
  434. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  435. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  436. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  437. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  438. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2437
  439. package/packages/orq-rc/src/models/operations/getevals.ts +0 -7290
  440. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  441. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -537
  442. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2298
  443. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2305
  444. package/packages/orq-rc/src/models/operations/index.ts +0 -98
  445. package/packages/orq-rc/src/models/operations/invokeeval.ts +0 -2520
  446. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  447. package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -490
  448. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -2784
  449. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  450. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  451. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -663
  452. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  453. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2438
  454. package/packages/orq-rc/src/models/operations/parse.ts +0 -1610
  455. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  456. package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -210
  457. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -2586
  458. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  459. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  460. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3409
  461. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  462. package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -325
  463. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -5155
  464. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  465. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  466. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -4131
  467. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -980
  468. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -4514
  469. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  470. package/packages/orq-rc/src/sdk/contacts.ts +0 -99
  471. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  472. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  473. package/packages/orq-rc/src/sdk/evals.ts +0 -639
  474. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  475. package/packages/orq-rc/src/sdk/files.ts +0 -78
  476. package/packages/orq-rc/src/sdk/index.ts +0 -5
  477. package/packages/orq-rc/src/sdk/knowledge.ts +0 -264
  478. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  479. package/packages/orq-rc/src/sdk/models.ts +0 -25
  480. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  481. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  482. package/packages/orq-rc/src/sdk/sdk.ts +0 -73
  483. package/packages/orq-rc/src/types/async.ts +0 -68
  484. package/packages/orq-rc/src/types/blobs.ts +0 -31
  485. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  486. package/packages/orq-rc/src/types/enums.ts +0 -16
  487. package/packages/orq-rc/src/types/fp.ts +0 -50
  488. package/packages/orq-rc/src/types/index.ts +0 -11
  489. package/packages/orq-rc/src/types/operations.ts +0 -105
  490. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  491. package/packages/orq-rc/src/types/streams.ts +0 -21
  492. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,557 +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
- <!-- 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 | \*/\* |
@@ -1,77 +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
- <!-- 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 | \*/\* |