@orq-ai/node 3.8.0-rc.8 → 3.8.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 (675) hide show
  1. package/FUNCTIONS.md +19 -3
  2. package/README.md +165 -91
  3. package/bin/mcp-server.js +930 -2272
  4. package/bin/mcp-server.js.map +67 -73
  5. package/docs/sdks/contacts/README.md +30 -2
  6. package/docs/sdks/knowledge/README.md +1 -1
  7. package/docs/sdks/orq/README.md +0 -138
  8. package/funcs/filesCreate.d.ts.map +1 -1
  9. package/funcs/filesCreate.js +7 -3
  10. package/funcs/filesCreate.js.map +1 -1
  11. package/funcs/knowledgeCreateChunks.d.ts +1 -1
  12. package/funcs/knowledgeCreateChunks.d.ts.map +1 -1
  13. package/funcs/knowledgeCreateChunks.js +1 -1
  14. package/funcs/knowledgeCreateChunks.js.map +1 -1
  15. package/jsr.json +1 -1
  16. package/lib/config.d.ts +3 -3
  17. package/lib/config.js +3 -3
  18. package/lib/config.js.map +1 -1
  19. package/lib/files.d.ts +5 -0
  20. package/lib/files.d.ts.map +1 -1
  21. package/lib/files.js +41 -0
  22. package/lib/files.js.map +1 -1
  23. package/lib/security.d.ts +2 -2
  24. package/lib/security.d.ts.map +1 -1
  25. package/mcp-server/mcp-server.js +1 -1
  26. package/mcp-server/mcp-server.js.map +1 -1
  27. package/mcp-server/server.d.ts.map +1 -1
  28. package/mcp-server/server.js +1 -5
  29. package/mcp-server/server.js.map +1 -1
  30. package/models/components/deployments.d.ts +12 -12
  31. package/models/components/deployments.d.ts.map +1 -1
  32. package/models/components/deployments.js +12 -12
  33. package/models/components/deployments.js.map +1 -1
  34. package/models/operations/createchunk.d.ts +28 -28
  35. package/models/operations/createchunk.d.ts.map +1 -1
  36. package/models/operations/createchunk.js +33 -35
  37. package/models/operations/createchunk.js.map +1 -1
  38. package/models/operations/createcontact.js +2 -2
  39. package/models/operations/createdataset.js +2 -2
  40. package/models/operations/createdatasetitem.d.ts +12 -12
  41. package/models/operations/createdatasetitem.d.ts.map +1 -1
  42. package/models/operations/createdatasetitem.js +14 -14
  43. package/models/operations/createdatasetitem.js.map +1 -1
  44. package/models/operations/createdatasource.js +2 -2
  45. package/models/operations/createeval.d.ts +36 -36
  46. package/models/operations/createeval.d.ts.map +1 -1
  47. package/models/operations/createeval.js +56 -56
  48. package/models/operations/createeval.js.map +1 -1
  49. package/models/operations/createfeedback.d.ts +8 -8
  50. package/models/operations/createfeedback.d.ts.map +1 -1
  51. package/models/operations/createfeedback.js +8 -8
  52. package/models/operations/createfeedback.js.map +1 -1
  53. package/models/operations/createprompt.d.ts +18 -18
  54. package/models/operations/createprompt.d.ts.map +1 -1
  55. package/models/operations/createprompt.js +18 -18
  56. package/models/operations/createprompt.js.map +1 -1
  57. package/models/operations/deploymentcreatemetric.d.ts +12 -12
  58. package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
  59. package/models/operations/deploymentcreatemetric.js +12 -12
  60. package/models/operations/deploymentcreatemetric.js.map +1 -1
  61. package/models/operations/deploymentgetconfig.d.ts +33 -33
  62. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  63. package/models/operations/deploymentgetconfig.js +36 -36
  64. package/models/operations/deploymentgetconfig.js.map +1 -1
  65. package/models/operations/deploymentinvoke.d.ts +4 -4
  66. package/models/operations/deploymentinvoke.js +8 -8
  67. package/models/operations/deployments.d.ts +6 -6
  68. package/models/operations/deployments.d.ts.map +1 -1
  69. package/models/operations/deployments.js +6 -6
  70. package/models/operations/deployments.js.map +1 -1
  71. package/models/operations/deploymentstream.d.ts +16 -16
  72. package/models/operations/deploymentstream.d.ts.map +1 -1
  73. package/models/operations/deploymentstream.js +16 -16
  74. package/models/operations/deploymentstream.js.map +1 -1
  75. package/models/operations/evalsageappropriate.d.ts +2 -2
  76. package/models/operations/evalsageappropriate.js +2 -2
  77. package/models/operations/evalsfactcheckingknowledgebase.d.ts +2 -2
  78. package/models/operations/evalsfactcheckingknowledgebase.js +2 -2
  79. package/models/operations/evalsgrammar.d.ts +2 -2
  80. package/models/operations/evalsgrammar.js +2 -2
  81. package/models/operations/evalslocalization.d.ts +2 -2
  82. package/models/operations/evalslocalization.js +2 -2
  83. package/models/operations/evalspii.d.ts +2 -2
  84. package/models/operations/evalspii.js +2 -2
  85. package/models/operations/evalsragascoherence.d.ts +2 -2
  86. package/models/operations/evalsragascoherence.js +2 -2
  87. package/models/operations/evalsragasconciseness.d.ts +2 -2
  88. package/models/operations/evalsragasconciseness.js +2 -2
  89. package/models/operations/evalsragascontextprecision.d.ts +2 -2
  90. package/models/operations/evalsragascontextprecision.js +2 -2
  91. package/models/operations/evalsragascorrectness.d.ts +2 -2
  92. package/models/operations/evalsragascorrectness.js +2 -2
  93. package/models/operations/evalsragasfaithfulness.d.ts +2 -2
  94. package/models/operations/evalsragasfaithfulness.js +2 -2
  95. package/models/operations/evalsragasharmfulness.d.ts +2 -2
  96. package/models/operations/evalsragasharmfulness.js +2 -2
  97. package/models/operations/evalsragasmaliciousness.d.ts +2 -2
  98. package/models/operations/evalsragasmaliciousness.js +2 -2
  99. package/models/operations/evalsragasresponserelevancy.d.ts +2 -2
  100. package/models/operations/evalsragasresponserelevancy.js +2 -2
  101. package/models/operations/evalssentimentclassification.d.ts +2 -2
  102. package/models/operations/evalssentimentclassification.js +2 -2
  103. package/models/operations/evalssummarization.d.ts +2 -2
  104. package/models/operations/evalssummarization.js +2 -2
  105. package/models/operations/evalstoneofvoice.d.ts +2 -2
  106. package/models/operations/evalstoneofvoice.js +2 -2
  107. package/models/operations/evalstranslation.d.ts +2 -2
  108. package/models/operations/evalstranslation.js +2 -2
  109. package/models/operations/fileget.js +2 -2
  110. package/models/operations/filelist.js +2 -2
  111. package/models/operations/fileupload.js +2 -2
  112. package/models/operations/getallprompts.d.ts +10 -10
  113. package/models/operations/getallprompts.d.ts.map +1 -1
  114. package/models/operations/getallprompts.js +10 -10
  115. package/models/operations/getallprompts.js.map +1 -1
  116. package/models/operations/getevals.d.ts +88 -88
  117. package/models/operations/getevals.d.ts.map +1 -1
  118. package/models/operations/getevals.js +187 -182
  119. package/models/operations/getevals.js.map +1 -1
  120. package/models/operations/getoneprompt.d.ts +10 -10
  121. package/models/operations/getoneprompt.d.ts.map +1 -1
  122. package/models/operations/getoneprompt.js +10 -10
  123. package/models/operations/getoneprompt.js.map +1 -1
  124. package/models/operations/getpromptversion.d.ts +10 -10
  125. package/models/operations/getpromptversion.d.ts.map +1 -1
  126. package/models/operations/getpromptversion.js +10 -10
  127. package/models/operations/getpromptversion.js.map +1 -1
  128. package/models/operations/index.d.ts +0 -2
  129. package/models/operations/index.d.ts.map +1 -1
  130. package/models/operations/index.js +0 -2
  131. package/models/operations/index.js.map +1 -1
  132. package/models/operations/invokeeval.d.ts +108 -108
  133. package/models/operations/invokeeval.d.ts.map +1 -1
  134. package/models/operations/invokeeval.js +141 -144
  135. package/models/operations/invokeeval.js.map +1 -1
  136. package/models/operations/listcontacts.js +2 -2
  137. package/models/operations/listdatasetdatapoints.d.ts +6 -6
  138. package/models/operations/listdatasetdatapoints.d.ts.map +1 -1
  139. package/models/operations/listdatasetdatapoints.js +8 -8
  140. package/models/operations/listdatasetdatapoints.js.map +1 -1
  141. package/models/operations/listdatasets.js +2 -2
  142. package/models/operations/listdatasources.js +2 -2
  143. package/models/operations/listpromptversions.d.ts +10 -10
  144. package/models/operations/listpromptversions.d.ts.map +1 -1
  145. package/models/operations/listpromptversions.js +10 -10
  146. package/models/operations/listpromptversions.js.map +1 -1
  147. package/models/operations/retrievecontact.js +2 -2
  148. package/models/operations/retrievedatapoint.d.ts +6 -6
  149. package/models/operations/retrievedatapoint.d.ts.map +1 -1
  150. package/models/operations/retrievedatapoint.js +8 -8
  151. package/models/operations/retrievedatapoint.js.map +1 -1
  152. package/models/operations/retrievedataset.js +2 -2
  153. package/models/operations/retrievedatasource.js +2 -2
  154. package/models/operations/updatecontact.js +2 -2
  155. package/models/operations/updatedatapoint.d.ts +12 -12
  156. package/models/operations/updatedatapoint.d.ts.map +1 -1
  157. package/models/operations/updatedatapoint.js +14 -14
  158. package/models/operations/updatedatapoint.js.map +1 -1
  159. package/models/operations/updatedataset.js +2 -2
  160. package/models/operations/updatedatasource.js +2 -2
  161. package/models/operations/updateeval.d.ts +38 -38
  162. package/models/operations/updateeval.d.ts.map +1 -1
  163. package/models/operations/updateeval.js +60 -60
  164. package/models/operations/updateeval.js.map +1 -1
  165. package/models/operations/updateprompt.d.ts +27 -86
  166. package/models/operations/updateprompt.d.ts.map +1 -1
  167. package/models/operations/updateprompt.js +39 -64
  168. package/models/operations/updateprompt.js.map +1 -1
  169. package/package.json +2 -3
  170. package/packages/orq-rc/FUNCTIONS.md +103 -0
  171. package/packages/orq-rc/README.md +947 -0
  172. package/packages/orq-rc/RUNTIMES.md +48 -0
  173. package/packages/orq-rc/docs/sdks/contacts/README.md +445 -0
  174. package/packages/orq-rc/docs/sdks/datasets/README.md +908 -0
  175. package/packages/orq-rc/docs/sdks/deployments/README.md +395 -0
  176. package/packages/orq-rc/docs/sdks/evals/README.md +2822 -0
  177. package/packages/orq-rc/docs/sdks/feedback/README.md +88 -0
  178. package/packages/orq-rc/docs/sdks/files/README.md +297 -0
  179. package/packages/orq-rc/docs/sdks/knowledge/README.md +1227 -0
  180. package/packages/orq-rc/docs/sdks/metrics/README.md +82 -0
  181. package/packages/orq-rc/docs/sdks/models/README.md +75 -0
  182. package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
  183. package/packages/orq-rc/docs/sdks/prompts/README.md +550 -0
  184. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +76 -0
  185. package/packages/orq-rc/jsr.json +28 -0
  186. package/packages/orq-rc/package-lock.json +3217 -0
  187. package/packages/orq-rc/package.json +45 -0
  188. package/packages/orq-rc/src/core.ts +13 -0
  189. package/{src/funcs/postV2ModelsLitellmImport.ts → packages/orq-rc/src/funcs/contactsCreate.ts} +14 -16
  190. package/packages/orq-rc/src/funcs/contactsDelete.ts +176 -0
  191. package/packages/orq-rc/src/funcs/contactsList.ts +169 -0
  192. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +175 -0
  193. package/packages/orq-rc/src/funcs/contactsUpdate.ts +176 -0
  194. package/packages/orq-rc/src/funcs/datasetsClear.ts +167 -0
  195. package/packages/orq-rc/src/funcs/datasetsCreate.ts +165 -0
  196. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +167 -0
  197. package/packages/orq-rc/src/funcs/datasetsCreateExperiment.ts +168 -0
  198. package/packages/orq-rc/src/funcs/datasetsDelete.ts +167 -0
  199. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +182 -0
  200. package/packages/orq-rc/src/funcs/datasetsList.ts +167 -0
  201. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +174 -0
  202. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +175 -0
  203. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +181 -0
  204. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +176 -0
  205. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +179 -0
  206. package/packages/orq-rc/src/funcs/deploymentsCreateExperiment.ts +173 -0
  207. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +168 -0
  208. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +176 -0
  209. package/packages/orq-rc/src/funcs/deploymentsList.ts +176 -0
  210. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +168 -0
  211. package/packages/orq-rc/src/funcs/deploymentsStream.ts +184 -0
  212. package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +175 -0
  213. package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
  214. package/packages/orq-rc/src/funcs/evalsBertScore.ts +175 -0
  215. package/packages/orq-rc/src/funcs/evalsBleuScore.ts +175 -0
  216. package/packages/orq-rc/src/funcs/evalsBotDetection.ts +175 -0
  217. package/packages/orq-rc/src/funcs/evalsContains.ts +175 -0
  218. package/packages/orq-rc/src/funcs/evalsContainsAll.ts +175 -0
  219. package/packages/orq-rc/src/funcs/evalsContainsAny.ts +175 -0
  220. package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +175 -0
  221. package/packages/orq-rc/src/funcs/evalsContainsNone.ts +175 -0
  222. package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +175 -0
  223. package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +177 -0
  224. package/packages/orq-rc/src/funcs/evalsCreate.ts +169 -0
  225. package/packages/orq-rc/src/funcs/evalsDelete.ts +173 -0
  226. package/packages/orq-rc/src/funcs/evalsEndsWith.ts +175 -0
  227. package/packages/orq-rc/src/funcs/evalsExactMatch.ts +175 -0
  228. package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +183 -0
  229. package/packages/orq-rc/src/funcs/evalsGrammar.ts +173 -0
  230. package/packages/orq-rc/src/funcs/evalsInvoke.ts +177 -0
  231. package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +175 -0
  232. package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +177 -0
  233. package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +175 -0
  234. package/packages/orq-rc/src/funcs/evalsLocalization.ts +175 -0
  235. package/packages/orq-rc/src/funcs/evalsPii.ts +173 -0
  236. package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +175 -0
  237. package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +174 -0
  238. package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +180 -0
  239. package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +174 -0
  240. package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +177 -0
  241. package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +174 -0
  242. package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +177 -0
  243. package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +183 -0
  244. package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +177 -0
  245. package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +183 -0
  246. package/packages/orq-rc/src/funcs/evalsSummarization.ts +175 -0
  247. package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +175 -0
  248. package/packages/orq-rc/src/funcs/evalsTranslation.ts +175 -0
  249. package/packages/orq-rc/src/funcs/evalsUpdate.ts +173 -0
  250. package/packages/orq-rc/src/funcs/evalsValidJson.ts +175 -0
  251. package/packages/orq-rc/src/funcs/feedbackCreate.ts +160 -0
  252. package/packages/orq-rc/src/funcs/filesCreate.ts +187 -0
  253. package/packages/orq-rc/src/funcs/filesDelete.ts +164 -0
  254. package/packages/orq-rc/src/funcs/filesGet.ts +166 -0
  255. package/packages/orq-rc/src/funcs/filesList.ts +167 -0
  256. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
  257. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +171 -0
  258. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +166 -0
  259. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +167 -0
  260. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +174 -0
  261. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +173 -0
  262. package/packages/orq-rc/src/funcs/knowledgeList.ts +169 -0
  263. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +178 -0
  264. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +174 -0
  265. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +166 -0
  266. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +173 -0
  267. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +169 -0
  268. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +167 -0
  269. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +164 -0
  270. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +174 -0
  271. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +170 -0
  272. package/{src/funcs/getV2ModelsLitellmModels.ts → packages/orq-rc/src/funcs/modelsList.ts} +9 -10
  273. package/packages/orq-rc/src/funcs/promptsCreate.ts +160 -0
  274. package/packages/orq-rc/src/funcs/promptsDelete.ts +164 -0
  275. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +181 -0
  276. package/packages/orq-rc/src/funcs/promptsList.ts +167 -0
  277. package/packages/orq-rc/src/funcs/promptsListVersions.ts +173 -0
  278. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +166 -0
  279. package/packages/orq-rc/src/funcs/promptsUpdate.ts +173 -0
  280. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +161 -0
  281. package/packages/orq-rc/src/hooks/global.ts +44 -0
  282. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  283. package/packages/orq-rc/src/hooks/index.ts +6 -0
  284. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  285. package/packages/orq-rc/src/hooks/types.ts +112 -0
  286. package/packages/orq-rc/src/index.ts +9 -0
  287. package/packages/orq-rc/src/lib/base64.ts +37 -0
  288. package/packages/orq-rc/src/lib/config.ts +74 -0
  289. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  290. package/packages/orq-rc/src/lib/encodings.ts +483 -0
  291. package/packages/orq-rc/src/lib/env.ts +73 -0
  292. package/packages/orq-rc/src/lib/event-streams.ts +264 -0
  293. package/packages/orq-rc/src/lib/files.ts +82 -0
  294. package/packages/orq-rc/src/lib/http.ts +323 -0
  295. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  296. package/packages/orq-rc/src/lib/logger.ts +9 -0
  297. package/packages/orq-rc/src/lib/matchers.ts +348 -0
  298. package/packages/orq-rc/src/lib/primitives.ts +150 -0
  299. package/packages/orq-rc/src/lib/retries.ts +218 -0
  300. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  301. package/packages/orq-rc/src/lib/sdks.ts +407 -0
  302. package/packages/orq-rc/src/lib/security.ts +261 -0
  303. package/packages/orq-rc/src/lib/url.ts +33 -0
  304. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +125 -0
  305. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +140 -0
  306. package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
  307. package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
  308. package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
  309. package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
  310. package/packages/orq-rc/src/mcp-server/prompts.ts +117 -0
  311. package/packages/orq-rc/src/mcp-server/resources.ts +172 -0
  312. package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
  313. package/packages/orq-rc/src/mcp-server/server.ts +247 -0
  314. package/packages/orq-rc/src/mcp-server/shared.ts +75 -0
  315. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
  316. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
  317. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
  318. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
  319. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
  320. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
  321. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
  322. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
  323. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateExperiment.ts +37 -0
  324. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
  325. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
  326. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
  327. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
  328. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
  329. package/{src/mcp-server/tools/postV2ModelsLitellmImport.ts → packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts} +7 -8
  330. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
  331. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
  332. package/packages/orq-rc/src/mcp-server/tools/deploymentsCreateExperiment.ts +37 -0
  333. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
  334. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
  335. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
  336. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
  337. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
  338. package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +35 -0
  339. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +35 -0
  340. package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +35 -0
  341. package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +35 -0
  342. package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +35 -0
  343. package/packages/orq-rc/src/mcp-server/tools/evalsContains.ts +35 -0
  344. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +35 -0
  345. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +35 -0
  346. package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +35 -0
  347. package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +35 -0
  348. package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +35 -0
  349. package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +36 -0
  350. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +35 -0
  351. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +33 -0
  352. package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +35 -0
  353. package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +35 -0
  354. package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +37 -0
  355. package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +35 -0
  356. package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +35 -0
  357. package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +35 -0
  358. package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +36 -0
  359. package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +35 -0
  360. package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +35 -0
  361. package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +35 -0
  362. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +35 -0
  363. package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +35 -0
  364. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +36 -0
  365. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +35 -0
  366. package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +36 -0
  367. package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +35 -0
  368. package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +36 -0
  369. package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +36 -0
  370. package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +36 -0
  371. package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +36 -0
  372. package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +35 -0
  373. package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +35 -0
  374. package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +35 -0
  375. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +35 -0
  376. package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +35 -0
  377. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
  378. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
  379. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
  380. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
  381. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
  382. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
  383. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
  384. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
  385. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +35 -0
  386. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
  387. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
  388. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +37 -0
  389. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
  390. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
  391. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
  392. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
  393. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
  394. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +37 -0
  395. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
  396. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
  397. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
  398. package/{src/mcp-server/tools/getV2ModelsLitellmModels.ts → packages/orq-rc/src/mcp-server/tools/modelsList.ts} +6 -6
  399. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
  400. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
  401. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
  402. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
  403. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
  404. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
  405. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
  406. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
  407. package/packages/orq-rc/src/mcp-server/tools.ts +129 -0
  408. package/packages/orq-rc/src/models/components/deployments.ts +7289 -0
  409. package/packages/orq-rc/src/models/components/index.ts +6 -0
  410. package/packages/orq-rc/src/models/components/security.ts +71 -0
  411. package/packages/orq-rc/src/models/errors/apierror.ts +34 -0
  412. package/packages/orq-rc/src/models/errors/createeval.ts +82 -0
  413. package/packages/orq-rc/src/models/errors/deletecontact.ts +91 -0
  414. package/packages/orq-rc/src/models/errors/deleteeval.ts +82 -0
  415. package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +160 -0
  416. package/packages/orq-rc/src/models/errors/evalsbertscore.ts +158 -0
  417. package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +158 -0
  418. package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +159 -0
  419. package/packages/orq-rc/src/models/errors/evalscontains.ts +158 -0
  420. package/packages/orq-rc/src/models/errors/evalscontainsall.ts +159 -0
  421. package/packages/orq-rc/src/models/errors/evalscontainsany.ts +159 -0
  422. package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +160 -0
  423. package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +159 -0
  424. package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +159 -0
  425. package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +161 -0
  426. package/packages/orq-rc/src/models/errors/evalsendswith.ts +158 -0
  427. package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +158 -0
  428. package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +164 -0
  429. package/packages/orq-rc/src/models/errors/evalsgrammar.ts +158 -0
  430. package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +160 -0
  431. package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +161 -0
  432. package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +160 -0
  433. package/packages/orq-rc/src/models/errors/evalslocalization.ts +159 -0
  434. package/packages/orq-rc/src/models/errors/evalspii.ts +158 -0
  435. package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +160 -0
  436. package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +161 -0
  437. package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +164 -0
  438. package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +161 -0
  439. package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +161 -0
  440. package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +161 -0
  441. package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +162 -0
  442. package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +164 -0
  443. package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +162 -0
  444. package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +164 -0
  445. package/packages/orq-rc/src/models/errors/evalssummarization.ts +160 -0
  446. package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +159 -0
  447. package/packages/orq-rc/src/models/errors/evalstranslation.ts +159 -0
  448. package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +158 -0
  449. package/packages/orq-rc/src/models/errors/getevals.ts +82 -0
  450. package/packages/orq-rc/src/models/errors/getpromptversion.ts +82 -0
  451. package/packages/orq-rc/src/models/errors/honoapierror.ts +92 -0
  452. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  453. package/packages/orq-rc/src/models/errors/index.ts +53 -0
  454. package/packages/orq-rc/src/models/errors/invokeeval.ts +158 -0
  455. package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
  456. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
  457. package/packages/orq-rc/src/models/errors/retrievecontact.ts +91 -0
  458. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +109 -0
  459. package/packages/orq-rc/src/models/errors/updatecontact.ts +85 -0
  460. package/packages/orq-rc/src/models/errors/updateeval.ts +82 -0
  461. package/packages/orq-rc/src/models/errors/updateprompt.ts +82 -0
  462. package/packages/orq-rc/src/models/operations/cleardataset.ts +75 -0
  463. package/packages/orq-rc/src/models/operations/createchunk.ts +428 -0
  464. package/packages/orq-rc/src/models/operations/createcontact.ts +267 -0
  465. package/packages/orq-rc/src/models/operations/createdataset.ts +296 -0
  466. package/packages/orq-rc/src/models/operations/createdatasetexperiment.ts +307 -0
  467. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +5222 -0
  468. package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -0
  469. package/packages/orq-rc/src/models/operations/createdeploymentexperiment.ts +321 -0
  470. package/packages/orq-rc/src/models/operations/createeval.ts +3830 -0
  471. package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
  472. package/packages/orq-rc/src/models/operations/createknowledge.ts +846 -0
  473. package/packages/orq-rc/src/models/operations/createprompt.ts +4081 -0
  474. package/packages/orq-rc/src/models/operations/deletechunk.ts +96 -0
  475. package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
  476. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +81 -0
  477. package/packages/orq-rc/src/models/operations/deletedataset.ts +75 -0
  478. package/packages/orq-rc/src/models/operations/deletedatasource.ts +87 -0
  479. package/packages/orq-rc/src/models/operations/deleteeval.ts +66 -0
  480. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +78 -0
  481. package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
  482. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +5439 -0
  483. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +9378 -0
  484. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1256 -0
  485. package/packages/orq-rc/src/models/operations/deployments.ts +2327 -0
  486. package/packages/orq-rc/src/models/operations/deploymentstream.ts +9499 -0
  487. package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +253 -0
  488. package/packages/orq-rc/src/models/operations/evalsbertscore.ts +197 -0
  489. package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +131 -0
  490. package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +249 -0
  491. package/packages/orq-rc/src/models/operations/evalscontains.ts +250 -0
  492. package/packages/orq-rc/src/models/operations/evalscontainsall.ts +248 -0
  493. package/packages/orq-rc/src/models/operations/evalscontainsany.ts +254 -0
  494. package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +181 -0
  495. package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +254 -0
  496. package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +181 -0
  497. package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +186 -0
  498. package/packages/orq-rc/src/models/operations/evalsendswith.ts +250 -0
  499. package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +183 -0
  500. package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +299 -0
  501. package/packages/orq-rc/src/models/operations/evalsgrammar.ts +243 -0
  502. package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +268 -0
  503. package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +266 -0
  504. package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +259 -0
  505. package/packages/orq-rc/src/models/operations/evalslocalization.ts +253 -0
  506. package/packages/orq-rc/src/models/operations/evalspii.ts +243 -0
  507. package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +152 -0
  508. package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +153 -0
  509. package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +166 -0
  510. package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +153 -0
  511. package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +155 -0
  512. package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +146 -0
  513. package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +157 -0
  514. package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +165 -0
  515. package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +150 -0
  516. package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +285 -0
  517. package/packages/orq-rc/src/models/operations/evalssummarization.ts +253 -0
  518. package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +251 -0
  519. package/packages/orq-rc/src/models/operations/evalstranslation.ts +251 -0
  520. package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +177 -0
  521. package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
  522. package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
  523. package/packages/orq-rc/src/models/operations/filelist.ts +337 -0
  524. package/packages/orq-rc/src/models/operations/fileupload.ts +327 -0
  525. package/packages/orq-rc/src/models/operations/getallprompts.ts +2295 -0
  526. package/packages/orq-rc/src/models/operations/getevals.ts +6162 -0
  527. package/packages/orq-rc/src/models/operations/getonechunk.ts +315 -0
  528. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +537 -0
  529. package/packages/orq-rc/src/models/operations/getoneprompt.ts +2156 -0
  530. package/packages/orq-rc/src/models/operations/getpromptversion.ts +2161 -0
  531. package/packages/orq-rc/src/models/operations/index.ts +96 -0
  532. package/packages/orq-rc/src/models/operations/invokeeval.ts +2520 -0
  533. package/packages/orq-rc/src/models/operations/listchunks.ts +494 -0
  534. package/packages/orq-rc/src/models/operations/listcontacts.ts +490 -0
  535. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2784 -0
  536. package/packages/orq-rc/src/models/operations/listdatasets.ts +406 -0
  537. package/packages/orq-rc/src/models/operations/listdatasources.ts +447 -0
  538. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +663 -0
  539. package/packages/orq-rc/src/models/operations/listmodels.ts +273 -0
  540. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2293 -0
  541. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
  542. package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
  543. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2586 -0
  544. package/packages/orq-rc/src/models/operations/retrievedataset.ts +288 -0
  545. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +273 -0
  546. package/packages/orq-rc/src/models/operations/searchknowledge.ts +3367 -0
  547. package/packages/orq-rc/src/models/operations/updatechunk.ts +448 -0
  548. package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
  549. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +5155 -0
  550. package/packages/orq-rc/src/models/operations/updatedataset.ts +393 -0
  551. package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
  552. package/packages/orq-rc/src/models/operations/updateeval.ts +4131 -0
  553. package/packages/orq-rc/src/models/operations/updateknowledge.ts +980 -0
  554. package/packages/orq-rc/src/models/operations/updateprompt.ts +4218 -0
  555. package/packages/orq-rc/src/sdk/contacts.ts +99 -0
  556. package/packages/orq-rc/src/sdk/datasets.ts +222 -0
  557. package/packages/orq-rc/src/sdk/deployments.ts +107 -0
  558. package/packages/orq-rc/src/sdk/evals.ts +594 -0
  559. package/packages/orq-rc/src/sdk/feedback.ts +27 -0
  560. package/packages/orq-rc/src/sdk/files.ts +78 -0
  561. package/packages/orq-rc/src/sdk/index.ts +5 -0
  562. package/packages/orq-rc/src/sdk/knowledge.ts +264 -0
  563. package/packages/orq-rc/src/sdk/metrics.ts +27 -0
  564. package/packages/orq-rc/src/sdk/models.ts +25 -0
  565. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  566. package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
  567. package/packages/orq-rc/src/sdk/sdk.ts +67 -0
  568. package/packages/orq-rc/src/types/async.ts +68 -0
  569. package/packages/orq-rc/src/types/blobs.ts +31 -0
  570. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  571. package/packages/orq-rc/src/types/enums.ts +16 -0
  572. package/packages/orq-rc/src/types/fp.ts +50 -0
  573. package/packages/orq-rc/src/types/index.ts +11 -0
  574. package/packages/orq-rc/src/types/operations.ts +105 -0
  575. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  576. package/packages/orq-rc/src/types/streams.ts +21 -0
  577. package/packages/orq-rc/tsconfig.json +41 -0
  578. package/sdk/knowledge.d.ts +1 -1
  579. package/sdk/knowledge.d.ts.map +1 -1
  580. package/sdk/sdk.d.ts +1 -16
  581. package/sdk/sdk.d.ts.map +1 -1
  582. package/sdk/sdk.js +0 -21
  583. package/sdk/sdk.js.map +1 -1
  584. package/src/funcs/filesCreate.ts +11 -4
  585. package/src/funcs/knowledgeCreateChunks.ts +4 -4
  586. package/src/lib/config.ts +3 -3
  587. package/src/lib/files.ts +42 -0
  588. package/src/lib/security.ts +2 -2
  589. package/src/mcp-server/mcp-server.ts +1 -1
  590. package/src/mcp-server/server.ts +1 -5
  591. package/src/models/components/deployments.ts +24 -24
  592. package/src/models/operations/createchunk.ts +44 -54
  593. package/src/models/operations/createcontact.ts +2 -2
  594. package/src/models/operations/createdataset.ts +2 -2
  595. package/src/models/operations/createdatasetitem.ts +26 -26
  596. package/src/models/operations/createdatasource.ts +2 -2
  597. package/src/models/operations/createeval.ts +121 -121
  598. package/src/models/operations/createfeedback.ts +16 -16
  599. package/src/models/operations/createprompt.ts +39 -39
  600. package/src/models/operations/deploymentcreatemetric.ts +30 -26
  601. package/src/models/operations/deploymentgetconfig.ts +62 -68
  602. package/src/models/operations/deploymentinvoke.ts +13 -13
  603. package/src/models/operations/deployments.ts +14 -14
  604. package/src/models/operations/deploymentstream.ts +34 -34
  605. package/src/models/operations/evalsageappropriate.ts +4 -4
  606. package/src/models/operations/evalsfactcheckingknowledgebase.ts +4 -4
  607. package/src/models/operations/evalsgrammar.ts +4 -4
  608. package/src/models/operations/evalslocalization.ts +4 -4
  609. package/src/models/operations/evalspii.ts +4 -4
  610. package/src/models/operations/evalsragascoherence.ts +4 -4
  611. package/src/models/operations/evalsragasconciseness.ts +4 -4
  612. package/src/models/operations/evalsragascontextprecision.ts +4 -4
  613. package/src/models/operations/evalsragascorrectness.ts +4 -4
  614. package/src/models/operations/evalsragasfaithfulness.ts +4 -4
  615. package/src/models/operations/evalsragasharmfulness.ts +4 -4
  616. package/src/models/operations/evalsragasmaliciousness.ts +4 -4
  617. package/src/models/operations/evalsragasresponserelevancy.ts +4 -4
  618. package/src/models/operations/evalssentimentclassification.ts +4 -4
  619. package/src/models/operations/evalssummarization.ts +4 -4
  620. package/src/models/operations/evalstoneofvoice.ts +4 -4
  621. package/src/models/operations/evalstranslation.ts +4 -4
  622. package/src/models/operations/fileget.ts +2 -2
  623. package/src/models/operations/filelist.ts +2 -2
  624. package/src/models/operations/fileupload.ts +2 -2
  625. package/src/models/operations/getallprompts.ts +22 -22
  626. package/src/models/operations/getevals.ts +339 -364
  627. package/src/models/operations/getoneprompt.ts +22 -22
  628. package/src/models/operations/getpromptversion.ts +22 -22
  629. package/src/models/operations/index.ts +0 -2
  630. package/src/models/operations/invokeeval.ts +251 -223
  631. package/src/models/operations/listcontacts.ts +2 -2
  632. package/src/models/operations/listdatasetdatapoints.ts +20 -16
  633. package/src/models/operations/listdatasets.ts +2 -2
  634. package/src/models/operations/listdatasources.ts +2 -2
  635. package/src/models/operations/listpromptversions.ts +22 -22
  636. package/src/models/operations/retrievecontact.ts +2 -2
  637. package/src/models/operations/retrievedatapoint.ts +14 -14
  638. package/src/models/operations/retrievedataset.ts +2 -2
  639. package/src/models/operations/retrievedatasource.ts +2 -2
  640. package/src/models/operations/updatecontact.ts +2 -2
  641. package/src/models/operations/updatedatapoint.ts +29 -27
  642. package/src/models/operations/updatedataset.ts +2 -2
  643. package/src/models/operations/updatedatasource.ts +2 -2
  644. package/src/models/operations/updateeval.ts +139 -139
  645. package/src/models/operations/updateprompt.ts +61 -106
  646. package/src/sdk/knowledge.ts +1 -1
  647. package/src/sdk/sdk.ts +1 -37
  648. package/src/types/constdatetime.ts +1 -1
  649. package/types/constdatetime.js +1 -1
  650. package/funcs/getV2ModelsLitellmModels.d.ts +0 -17
  651. package/funcs/getV2ModelsLitellmModels.d.ts.map +0 -1
  652. package/funcs/getV2ModelsLitellmModels.js +0 -105
  653. package/funcs/getV2ModelsLitellmModels.js.map +0 -1
  654. package/funcs/postV2ModelsLitellmImport.d.ts +0 -17
  655. package/funcs/postV2ModelsLitellmImport.d.ts.map +0 -1
  656. package/funcs/postV2ModelsLitellmImport.js +0 -117
  657. package/funcs/postV2ModelsLitellmImport.js.map +0 -1
  658. package/mcp-server/tools/getV2ModelsLitellmModels.d.ts +0 -3
  659. package/mcp-server/tools/getV2ModelsLitellmModels.d.ts.map +0 -1
  660. package/mcp-server/tools/getV2ModelsLitellmModels.js +0 -26
  661. package/mcp-server/tools/getV2ModelsLitellmModels.js.map +0 -1
  662. package/mcp-server/tools/postV2ModelsLitellmImport.d.ts +0 -9
  663. package/mcp-server/tools/postV2ModelsLitellmImport.d.ts.map +0 -1
  664. package/mcp-server/tools/postV2ModelsLitellmImport.js +0 -65
  665. package/mcp-server/tools/postV2ModelsLitellmImport.js.map +0 -1
  666. package/models/operations/getv2modelslitellmmodels.d.ts +0 -185
  667. package/models/operations/getv2modelslitellmmodels.d.ts.map +0 -1
  668. package/models/operations/getv2modelslitellmmodels.js +0 -349
  669. package/models/operations/getv2modelslitellmmodels.js.map +0 -1
  670. package/models/operations/postv2modelslitellmimport.d.ts +0 -1333
  671. package/models/operations/postv2modelslitellmimport.d.ts.map +0 -1
  672. package/models/operations/postv2modelslitellmimport.js +0 -1400
  673. package/models/operations/postv2modelslitellmimport.js.map +0 -1
  674. package/src/models/operations/getv2modelslitellmmodels.ts +0 -530
  675. package/src/models/operations/postv2modelslitellmimport.ts +0 -2408
@@ -0,0 +1,2822 @@
1
+ # Evals
2
+ (*evals*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [all](#all) - Get all Evaluators
9
+ * [create](#create) - Create an Evaluator
10
+ * [update](#update) - Update an Evaluator
11
+ * [delete](#delete) - Delete an Evaluator
12
+ * [bertScore](#bertscore) - Run BertScore Evaluator
13
+ * [bleuScore](#bleuscore) - Run BLEU Score Evaluator
14
+ * [containsAll](#containsall) - Run Contains All Evaluator
15
+ * [containsAny](#containsany) - Run Contains Any Evaluator
16
+ * [containsEmail](#containsemail) - Run Contains Email Evaluator
17
+ * [containsNone](#containsnone) - Run Contains None Evaluator
18
+ * [containsUrl](#containsurl) - Run Contains URL Evaluator
19
+ * [containsValidLink](#containsvalidlink) - Run Contains Valid Link Evaluator
20
+ * [contains](#contains) - Run Contains Evaluator
21
+ * [endsWith](#endswith) - Run Ends With Evaluator
22
+ * [exactMatch](#exactmatch) - Run Exact Match Evaluator
23
+ * [lengthBetween](#lengthbetween) - Run Length Between Evaluator
24
+ * [lengthGreaterThan](#lengthgreaterthan) - Run Length Greater Than Evaluator
25
+ * [lengthLessThan](#lengthlessthan) - Run Length Less Than Evaluator
26
+ * [validJson](#validjson) - Run JSON Validation Evaluator
27
+ * [ageAppropriate](#ageappropriate) - Run Age Appropriate Evaluator
28
+ * [botDetection](#botdetection) - Run Bot Detection Evaluator
29
+ * [factCheckingKnowledgeBase](#factcheckingknowledgebase) - Run Fact Checking Knowledge Base Evaluator
30
+ * [grammar](#grammar) - Run Grammar Evaluator
31
+ * [localization](#localization) - Run Localization Evaluator
32
+ * [pii](#pii) - Run PII Evaluator
33
+ * [sentimentClassification](#sentimentclassification) - Run Sentiment Classification Evaluator
34
+ * [summarization](#summarization) - Run Summarization Evaluator
35
+ * [toneOfVoice](#toneofvoice) - Run Tone of Voice Evaluator
36
+ * [translation](#translation) - Run Translation Evaluator
37
+ * [ragasCoherence](#ragascoherence) - Run Coherence Evaluator
38
+ * [ragasConciseness](#ragasconciseness) - Run Conciseness Evaluator
39
+ * [ragasContextPrecision](#ragascontextprecision) - Run Context Precision Evaluator
40
+ * [ragasCorrectness](#ragascorrectness) - Run Correctness Evaluator
41
+ * [ragasFaithfulness](#ragasfaithfulness) - Run Faithfulness Evaluator
42
+ * [ragasHarmfulness](#ragasharmfulness) - Run Harmfulness Evaluator
43
+ * [ragasMaliciousness](#ragasmaliciousness) - Run Maliciousness Evaluator
44
+ * [ragasResponseRelevancy](#ragasresponserelevancy) - Run Response Relevancy Evaluator
45
+ * [ragasSummarization](#ragassummarization) - Run Summarization Evaluator
46
+ * [invoke](#invoke) - Invoke a Custom Evaluator
47
+
48
+ ## all
49
+
50
+ Get all Evaluators
51
+
52
+ ### Example Usage
53
+
54
+ ```typescript
55
+ import { Orq } from "@orq-ai/node";
56
+
57
+ const orq = new Orq({
58
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
59
+ });
60
+
61
+ async function run() {
62
+ const result = await orq.evals.all({});
63
+
64
+ console.log(result);
65
+ }
66
+
67
+ run();
68
+ ```
69
+
70
+ ### Standalone function
71
+
72
+ The standalone function version of this method:
73
+
74
+ ```typescript
75
+ import { OrqCore } from "@orq-ai/node/core.js";
76
+ import { evalsAll } from "@orq-ai/node/funcs/evalsAll.js";
77
+
78
+ // Use `OrqCore` for best tree-shaking performance.
79
+ // You can create one instance of it to use across an application.
80
+ const orq = new OrqCore({
81
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
82
+ });
83
+
84
+ async function run() {
85
+ const res = await evalsAll(orq, {});
86
+ if (res.ok) {
87
+ const { value: result } = res;
88
+ console.log(result);
89
+ } else {
90
+ console.log("evalsAll failed:", res.error);
91
+ }
92
+ }
93
+
94
+ run();
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ | Parameter | Type | Required | Description |
100
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
101
+ | `request` | [operations.GetEvalsRequest](../../models/operations/getevalsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
102
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
103
+ | `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. |
104
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
105
+
106
+ ### Response
107
+
108
+ **Promise\<[operations.GetEvalsResponseBody](../../models/operations/getevalsresponsebody.md)\>**
109
+
110
+ ### Errors
111
+
112
+ | Error Type | Status Code | Content Type |
113
+ | --------------------------- | --------------------------- | --------------------------- |
114
+ | errors.GetEvalsResponseBody | 404 | application/json |
115
+ | errors.APIError | 4XX, 5XX | \*/\* |
116
+
117
+ ## create
118
+
119
+ Create an Evaluator
120
+
121
+ ### Example Usage
122
+
123
+ ```typescript
124
+ import { Orq } from "@orq-ai/node";
125
+
126
+ const orq = new Orq({
127
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
128
+ });
129
+
130
+ async function run() {
131
+ const result = await orq.evals.create({
132
+ type: "http_eval",
133
+ url: "https://total-unit.name",
134
+ method: "GET",
135
+ headers: {
136
+ "key": "<value>",
137
+ "key1": "<value>",
138
+ "key2": "<value>",
139
+ },
140
+ payload: {
141
+ "key": "<value>",
142
+ },
143
+ path: "Default",
144
+ description: "",
145
+ key: "<key>",
146
+ });
147
+
148
+ console.log(result);
149
+ }
150
+
151
+ run();
152
+ ```
153
+
154
+ ### Standalone function
155
+
156
+ The standalone function version of this method:
157
+
158
+ ```typescript
159
+ import { OrqCore } from "@orq-ai/node/core.js";
160
+ import { evalsCreate } from "@orq-ai/node/funcs/evalsCreate.js";
161
+
162
+ // Use `OrqCore` for best tree-shaking performance.
163
+ // You can create one instance of it to use across an application.
164
+ const orq = new OrqCore({
165
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
166
+ });
167
+
168
+ async function run() {
169
+ const res = await evalsCreate(orq, {
170
+ type: "http_eval",
171
+ url: "https://total-unit.name",
172
+ method: "GET",
173
+ headers: {
174
+ "key": "<value>",
175
+ "key1": "<value>",
176
+ "key2": "<value>",
177
+ },
178
+ payload: {
179
+ "key": "<value>",
180
+ },
181
+ path: "Default",
182
+ description: "",
183
+ key: "<key>",
184
+ });
185
+ if (res.ok) {
186
+ const { value: result } = res;
187
+ console.log(result);
188
+ } else {
189
+ console.log("evalsCreate failed:", res.error);
190
+ }
191
+ }
192
+
193
+ run();
194
+ ```
195
+
196
+ ### Parameters
197
+
198
+ | Parameter | Type | Required | Description |
199
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
200
+ | `request` | [operations.CreateEvalRequestBody](../../models/operations/createevalrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
201
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
202
+ | `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. |
203
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
204
+
205
+ ### Response
206
+
207
+ **Promise\<[operations.CreateEvalResponseBody](../../models/operations/createevalresponsebody.md)\>**
208
+
209
+ ### Errors
210
+
211
+ | Error Type | Status Code | Content Type |
212
+ | ----------------------------- | ----------------------------- | ----------------------------- |
213
+ | errors.CreateEvalResponseBody | 404 | application/json |
214
+ | errors.APIError | 4XX, 5XX | \*/\* |
215
+
216
+ ## update
217
+
218
+ Update an Evaluator
219
+
220
+ ### Example Usage
221
+
222
+ ```typescript
223
+ import { Orq } from "@orq-ai/node";
224
+
225
+ const orq = new Orq({
226
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
227
+ });
228
+
229
+ async function run() {
230
+ const result = await orq.evals.update({
231
+ id: "<id>",
232
+ requestBody: {
233
+ type: "llm_eval",
234
+ path: "Default",
235
+ },
236
+ });
237
+
238
+ console.log(result);
239
+ }
240
+
241
+ run();
242
+ ```
243
+
244
+ ### Standalone function
245
+
246
+ The standalone function version of this method:
247
+
248
+ ```typescript
249
+ import { OrqCore } from "@orq-ai/node/core.js";
250
+ import { evalsUpdate } from "@orq-ai/node/funcs/evalsUpdate.js";
251
+
252
+ // Use `OrqCore` for best tree-shaking performance.
253
+ // You can create one instance of it to use across an application.
254
+ const orq = new OrqCore({
255
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
256
+ });
257
+
258
+ async function run() {
259
+ const res = await evalsUpdate(orq, {
260
+ id: "<id>",
261
+ requestBody: {
262
+ type: "llm_eval",
263
+ path: "Default",
264
+ },
265
+ });
266
+ if (res.ok) {
267
+ const { value: result } = res;
268
+ console.log(result);
269
+ } else {
270
+ console.log("evalsUpdate failed:", res.error);
271
+ }
272
+ }
273
+
274
+ run();
275
+ ```
276
+
277
+ ### Parameters
278
+
279
+ | Parameter | Type | Required | Description |
280
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
281
+ | `request` | [operations.UpdateEvalRequest](../../models/operations/updateevalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
282
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
283
+ | `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. |
284
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
285
+
286
+ ### Response
287
+
288
+ **Promise\<[operations.UpdateEvalResponseBody](../../models/operations/updateevalresponsebody.md)\>**
289
+
290
+ ### Errors
291
+
292
+ | Error Type | Status Code | Content Type |
293
+ | ----------------------------- | ----------------------------- | ----------------------------- |
294
+ | errors.UpdateEvalResponseBody | 404 | application/json |
295
+ | errors.APIError | 4XX, 5XX | \*/\* |
296
+
297
+ ## delete
298
+
299
+ Delete an Evaluator
300
+
301
+ ### Example Usage
302
+
303
+ ```typescript
304
+ import { Orq } from "@orq-ai/node";
305
+
306
+ const orq = new Orq({
307
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
308
+ });
309
+
310
+ async function run() {
311
+ await orq.evals.delete({
312
+ id: "<id>",
313
+ });
314
+
315
+
316
+ }
317
+
318
+ run();
319
+ ```
320
+
321
+ ### Standalone function
322
+
323
+ The standalone function version of this method:
324
+
325
+ ```typescript
326
+ import { OrqCore } from "@orq-ai/node/core.js";
327
+ import { evalsDelete } from "@orq-ai/node/funcs/evalsDelete.js";
328
+
329
+ // Use `OrqCore` for best tree-shaking performance.
330
+ // You can create one instance of it to use across an application.
331
+ const orq = new OrqCore({
332
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
333
+ });
334
+
335
+ async function run() {
336
+ const res = await evalsDelete(orq, {
337
+ id: "<id>",
338
+ });
339
+ if (res.ok) {
340
+ const { value: result } = res;
341
+
342
+ } else {
343
+ console.log("evalsDelete failed:", res.error);
344
+ }
345
+ }
346
+
347
+ run();
348
+ ```
349
+
350
+ ### Parameters
351
+
352
+ | Parameter | Type | Required | Description |
353
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
354
+ | `request` | [operations.DeleteEvalRequest](../../models/operations/deleteevalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
355
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
356
+ | `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. |
357
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
358
+
359
+ ### Response
360
+
361
+ **Promise\<void\>**
362
+
363
+ ### Errors
364
+
365
+ | Error Type | Status Code | Content Type |
366
+ | ----------------------------- | ----------------------------- | ----------------------------- |
367
+ | errors.DeleteEvalResponseBody | 404 | application/json |
368
+ | errors.APIError | 4XX, 5XX | \*/\* |
369
+
370
+ ## bertScore
371
+
372
+ Run BertScore Evaluator
373
+
374
+ ### Example Usage
375
+
376
+ ```typescript
377
+ import { Orq } from "@orq-ai/node";
378
+
379
+ const orq = new Orq({
380
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
381
+ });
382
+
383
+ async function run() {
384
+ const result = await orq.evals.bertScore();
385
+
386
+ console.log(result);
387
+ }
388
+
389
+ run();
390
+ ```
391
+
392
+ ### Standalone function
393
+
394
+ The standalone function version of this method:
395
+
396
+ ```typescript
397
+ import { OrqCore } from "@orq-ai/node/core.js";
398
+ import { evalsBertScore } from "@orq-ai/node/funcs/evalsBertScore.js";
399
+
400
+ // Use `OrqCore` for best tree-shaking performance.
401
+ // You can create one instance of it to use across an application.
402
+ const orq = new OrqCore({
403
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
404
+ });
405
+
406
+ async function run() {
407
+ const res = await evalsBertScore(orq);
408
+ if (res.ok) {
409
+ const { value: result } = res;
410
+ console.log(result);
411
+ } else {
412
+ console.log("evalsBertScore failed:", res.error);
413
+ }
414
+ }
415
+
416
+ run();
417
+ ```
418
+
419
+ ### Parameters
420
+
421
+ | Parameter | Type | Required | Description |
422
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
423
+ | `request` | [operations.EvalsBertScoreRequestBody](../../models/operations/evalsbertscorerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
424
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
425
+ | `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. |
426
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
427
+
428
+ ### Response
429
+
430
+ **Promise\<[operations.EvalsBertScoreResponseBody](../../models/operations/evalsbertscoreresponsebody.md)\>**
431
+
432
+ ### Errors
433
+
434
+ | Error Type | Status Code | Content Type |
435
+ | -------------------------------------- | -------------------------------------- | -------------------------------------- |
436
+ | errors.EvalsBertScoreResponseBody | 404 | application/json |
437
+ | errors.EvalsBertScoreEvalsResponseBody | 500 | application/json |
438
+ | errors.APIError | 4XX, 5XX | \*/\* |
439
+
440
+ ## bleuScore
441
+
442
+ Run BLEU Score Evaluator
443
+
444
+ ### Example Usage
445
+
446
+ ```typescript
447
+ import { Orq } from "@orq-ai/node";
448
+
449
+ const orq = new Orq({
450
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
451
+ });
452
+
453
+ async function run() {
454
+ const result = await orq.evals.bleuScore();
455
+
456
+ console.log(result);
457
+ }
458
+
459
+ run();
460
+ ```
461
+
462
+ ### Standalone function
463
+
464
+ The standalone function version of this method:
465
+
466
+ ```typescript
467
+ import { OrqCore } from "@orq-ai/node/core.js";
468
+ import { evalsBleuScore } from "@orq-ai/node/funcs/evalsBleuScore.js";
469
+
470
+ // Use `OrqCore` for best tree-shaking performance.
471
+ // You can create one instance of it to use across an application.
472
+ const orq = new OrqCore({
473
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
474
+ });
475
+
476
+ async function run() {
477
+ const res = await evalsBleuScore(orq);
478
+ if (res.ok) {
479
+ const { value: result } = res;
480
+ console.log(result);
481
+ } else {
482
+ console.log("evalsBleuScore failed:", res.error);
483
+ }
484
+ }
485
+
486
+ run();
487
+ ```
488
+
489
+ ### Parameters
490
+
491
+ | Parameter | Type | Required | Description |
492
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
493
+ | `request` | [operations.EvalsBleuScoreRequestBody](../../models/operations/evalsbleuscorerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
494
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
495
+ | `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. |
496
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
497
+
498
+ ### Response
499
+
500
+ **Promise\<[operations.EvalsBleuScoreResponseBody](../../models/operations/evalsbleuscoreresponsebody.md)\>**
501
+
502
+ ### Errors
503
+
504
+ | Error Type | Status Code | Content Type |
505
+ | -------------------------------------- | -------------------------------------- | -------------------------------------- |
506
+ | errors.EvalsBleuScoreResponseBody | 404 | application/json |
507
+ | errors.EvalsBleuScoreEvalsResponseBody | 500 | application/json |
508
+ | errors.APIError | 4XX, 5XX | \*/\* |
509
+
510
+ ## containsAll
511
+
512
+ Run Contains All Evaluator
513
+
514
+ ### Example Usage
515
+
516
+ ```typescript
517
+ import { Orq } from "@orq-ai/node";
518
+
519
+ const orq = new Orq({
520
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
521
+ });
522
+
523
+ async function run() {
524
+ const result = await orq.evals.containsAll();
525
+
526
+ console.log(result);
527
+ }
528
+
529
+ run();
530
+ ```
531
+
532
+ ### Standalone function
533
+
534
+ The standalone function version of this method:
535
+
536
+ ```typescript
537
+ import { OrqCore } from "@orq-ai/node/core.js";
538
+ import { evalsContainsAll } from "@orq-ai/node/funcs/evalsContainsAll.js";
539
+
540
+ // Use `OrqCore` for best tree-shaking performance.
541
+ // You can create one instance of it to use across an application.
542
+ const orq = new OrqCore({
543
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
544
+ });
545
+
546
+ async function run() {
547
+ const res = await evalsContainsAll(orq);
548
+ if (res.ok) {
549
+ const { value: result } = res;
550
+ console.log(result);
551
+ } else {
552
+ console.log("evalsContainsAll failed:", res.error);
553
+ }
554
+ }
555
+
556
+ run();
557
+ ```
558
+
559
+ ### Parameters
560
+
561
+ | Parameter | Type | Required | Description |
562
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
563
+ | `request` | [operations.EvalsContainsAllRequestBody](../../models/operations/evalscontainsallrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
564
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
565
+ | `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. |
566
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
567
+
568
+ ### Response
569
+
570
+ **Promise\<[operations.EvalsContainsAllResponseBody](../../models/operations/evalscontainsallresponsebody.md)\>**
571
+
572
+ ### Errors
573
+
574
+ | Error Type | Status Code | Content Type |
575
+ | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
576
+ | errors.EvalsContainsAllResponseBody | 404 | application/json |
577
+ | errors.EvalsContainsAllEvalsResponseBody | 500 | application/json |
578
+ | errors.APIError | 4XX, 5XX | \*/\* |
579
+
580
+ ## containsAny
581
+
582
+ Run Contains Any Evaluator
583
+
584
+ ### Example Usage
585
+
586
+ ```typescript
587
+ import { Orq } from "@orq-ai/node";
588
+
589
+ const orq = new Orq({
590
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
591
+ });
592
+
593
+ async function run() {
594
+ const result = await orq.evals.containsAny();
595
+
596
+ console.log(result);
597
+ }
598
+
599
+ run();
600
+ ```
601
+
602
+ ### Standalone function
603
+
604
+ The standalone function version of this method:
605
+
606
+ ```typescript
607
+ import { OrqCore } from "@orq-ai/node/core.js";
608
+ import { evalsContainsAny } from "@orq-ai/node/funcs/evalsContainsAny.js";
609
+
610
+ // Use `OrqCore` for best tree-shaking performance.
611
+ // You can create one instance of it to use across an application.
612
+ const orq = new OrqCore({
613
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
614
+ });
615
+
616
+ async function run() {
617
+ const res = await evalsContainsAny(orq);
618
+ if (res.ok) {
619
+ const { value: result } = res;
620
+ console.log(result);
621
+ } else {
622
+ console.log("evalsContainsAny failed:", res.error);
623
+ }
624
+ }
625
+
626
+ run();
627
+ ```
628
+
629
+ ### Parameters
630
+
631
+ | Parameter | Type | Required | Description |
632
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
633
+ | `request` | [operations.EvalsContainsAnyRequestBody](../../models/operations/evalscontainsanyrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
634
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
635
+ | `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. |
636
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
637
+
638
+ ### Response
639
+
640
+ **Promise\<[operations.EvalsContainsAnyResponseBody](../../models/operations/evalscontainsanyresponsebody.md)\>**
641
+
642
+ ### Errors
643
+
644
+ | Error Type | Status Code | Content Type |
645
+ | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
646
+ | errors.EvalsContainsAnyResponseBody | 404 | application/json |
647
+ | errors.EvalsContainsAnyEvalsResponseBody | 500 | application/json |
648
+ | errors.APIError | 4XX, 5XX | \*/\* |
649
+
650
+ ## containsEmail
651
+
652
+ Run Contains Email Evaluator
653
+
654
+ ### Example Usage
655
+
656
+ ```typescript
657
+ import { Orq } from "@orq-ai/node";
658
+
659
+ const orq = new Orq({
660
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
661
+ });
662
+
663
+ async function run() {
664
+ const result = await orq.evals.containsEmail();
665
+
666
+ console.log(result);
667
+ }
668
+
669
+ run();
670
+ ```
671
+
672
+ ### Standalone function
673
+
674
+ The standalone function version of this method:
675
+
676
+ ```typescript
677
+ import { OrqCore } from "@orq-ai/node/core.js";
678
+ import { evalsContainsEmail } from "@orq-ai/node/funcs/evalsContainsEmail.js";
679
+
680
+ // Use `OrqCore` for best tree-shaking performance.
681
+ // You can create one instance of it to use across an application.
682
+ const orq = new OrqCore({
683
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
684
+ });
685
+
686
+ async function run() {
687
+ const res = await evalsContainsEmail(orq);
688
+ if (res.ok) {
689
+ const { value: result } = res;
690
+ console.log(result);
691
+ } else {
692
+ console.log("evalsContainsEmail failed:", res.error);
693
+ }
694
+ }
695
+
696
+ run();
697
+ ```
698
+
699
+ ### Parameters
700
+
701
+ | Parameter | Type | Required | Description |
702
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
703
+ | `request` | [operations.EvalsContainsEmailRequestBody](../../models/operations/evalscontainsemailrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
704
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
705
+ | `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. |
706
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
707
+
708
+ ### Response
709
+
710
+ **Promise\<[operations.EvalsContainsEmailResponseBody](../../models/operations/evalscontainsemailresponsebody.md)\>**
711
+
712
+ ### Errors
713
+
714
+ | Error Type | Status Code | Content Type |
715
+ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
716
+ | errors.EvalsContainsEmailResponseBody | 404 | application/json |
717
+ | errors.EvalsContainsEmailEvalsResponseBody | 500 | application/json |
718
+ | errors.APIError | 4XX, 5XX | \*/\* |
719
+
720
+ ## containsNone
721
+
722
+ Run Contains None Evaluator
723
+
724
+ ### Example Usage
725
+
726
+ ```typescript
727
+ import { Orq } from "@orq-ai/node";
728
+
729
+ const orq = new Orq({
730
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
731
+ });
732
+
733
+ async function run() {
734
+ const result = await orq.evals.containsNone();
735
+
736
+ console.log(result);
737
+ }
738
+
739
+ run();
740
+ ```
741
+
742
+ ### Standalone function
743
+
744
+ The standalone function version of this method:
745
+
746
+ ```typescript
747
+ import { OrqCore } from "@orq-ai/node/core.js";
748
+ import { evalsContainsNone } from "@orq-ai/node/funcs/evalsContainsNone.js";
749
+
750
+ // Use `OrqCore` for best tree-shaking performance.
751
+ // You can create one instance of it to use across an application.
752
+ const orq = new OrqCore({
753
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
754
+ });
755
+
756
+ async function run() {
757
+ const res = await evalsContainsNone(orq);
758
+ if (res.ok) {
759
+ const { value: result } = res;
760
+ console.log(result);
761
+ } else {
762
+ console.log("evalsContainsNone failed:", res.error);
763
+ }
764
+ }
765
+
766
+ run();
767
+ ```
768
+
769
+ ### Parameters
770
+
771
+ | Parameter | Type | Required | Description |
772
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
773
+ | `request` | [operations.EvalsContainsNoneRequestBody](../../models/operations/evalscontainsnonerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
774
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
775
+ | `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. |
776
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
777
+
778
+ ### Response
779
+
780
+ **Promise\<[operations.EvalsContainsNoneResponseBody](../../models/operations/evalscontainsnoneresponsebody.md)\>**
781
+
782
+ ### Errors
783
+
784
+ | Error Type | Status Code | Content Type |
785
+ | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
786
+ | errors.EvalsContainsNoneResponseBody | 404 | application/json |
787
+ | errors.EvalsContainsNoneEvalsResponseBody | 500 | application/json |
788
+ | errors.APIError | 4XX, 5XX | \*/\* |
789
+
790
+ ## containsUrl
791
+
792
+ Run Contains URL Evaluator
793
+
794
+ ### Example Usage
795
+
796
+ ```typescript
797
+ import { Orq } from "@orq-ai/node";
798
+
799
+ const orq = new Orq({
800
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
801
+ });
802
+
803
+ async function run() {
804
+ const result = await orq.evals.containsUrl();
805
+
806
+ console.log(result);
807
+ }
808
+
809
+ run();
810
+ ```
811
+
812
+ ### Standalone function
813
+
814
+ The standalone function version of this method:
815
+
816
+ ```typescript
817
+ import { OrqCore } from "@orq-ai/node/core.js";
818
+ import { evalsContainsUrl } from "@orq-ai/node/funcs/evalsContainsUrl.js";
819
+
820
+ // Use `OrqCore` for best tree-shaking performance.
821
+ // You can create one instance of it to use across an application.
822
+ const orq = new OrqCore({
823
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
824
+ });
825
+
826
+ async function run() {
827
+ const res = await evalsContainsUrl(orq);
828
+ if (res.ok) {
829
+ const { value: result } = res;
830
+ console.log(result);
831
+ } else {
832
+ console.log("evalsContainsUrl failed:", res.error);
833
+ }
834
+ }
835
+
836
+ run();
837
+ ```
838
+
839
+ ### Parameters
840
+
841
+ | Parameter | Type | Required | Description |
842
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
843
+ | `request` | [operations.EvalsContainsUrlRequestBody](../../models/operations/evalscontainsurlrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
844
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
845
+ | `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. |
846
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
847
+
848
+ ### Response
849
+
850
+ **Promise\<[operations.EvalsContainsUrlResponseBody](../../models/operations/evalscontainsurlresponsebody.md)\>**
851
+
852
+ ### Errors
853
+
854
+ | Error Type | Status Code | Content Type |
855
+ | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
856
+ | errors.EvalsContainsUrlResponseBody | 404 | application/json |
857
+ | errors.EvalsContainsUrlEvalsResponseBody | 500 | application/json |
858
+ | errors.APIError | 4XX, 5XX | \*/\* |
859
+
860
+ ## containsValidLink
861
+
862
+ Run Contains Valid Link Evaluator
863
+
864
+ ### Example Usage
865
+
866
+ ```typescript
867
+ import { Orq } from "@orq-ai/node";
868
+
869
+ const orq = new Orq({
870
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
871
+ });
872
+
873
+ async function run() {
874
+ const result = await orq.evals.containsValidLink();
875
+
876
+ console.log(result);
877
+ }
878
+
879
+ run();
880
+ ```
881
+
882
+ ### Standalone function
883
+
884
+ The standalone function version of this method:
885
+
886
+ ```typescript
887
+ import { OrqCore } from "@orq-ai/node/core.js";
888
+ import { evalsContainsValidLink } from "@orq-ai/node/funcs/evalsContainsValidLink.js";
889
+
890
+ // Use `OrqCore` for best tree-shaking performance.
891
+ // You can create one instance of it to use across an application.
892
+ const orq = new OrqCore({
893
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
894
+ });
895
+
896
+ async function run() {
897
+ const res = await evalsContainsValidLink(orq);
898
+ if (res.ok) {
899
+ const { value: result } = res;
900
+ console.log(result);
901
+ } else {
902
+ console.log("evalsContainsValidLink failed:", res.error);
903
+ }
904
+ }
905
+
906
+ run();
907
+ ```
908
+
909
+ ### Parameters
910
+
911
+ | Parameter | Type | Required | Description |
912
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
913
+ | `request` | [operations.EvalsContainsValidLinkRequestBody](../../models/operations/evalscontainsvalidlinkrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
914
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
915
+ | `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. |
916
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
917
+
918
+ ### Response
919
+
920
+ **Promise\<[operations.EvalsContainsValidLinkResponseBody](../../models/operations/evalscontainsvalidlinkresponsebody.md)\>**
921
+
922
+ ### Errors
923
+
924
+ | Error Type | Status Code | Content Type |
925
+ | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
926
+ | errors.EvalsContainsValidLinkResponseBody | 404 | application/json |
927
+ | errors.EvalsContainsValidLinkEvalsResponseBody | 500 | application/json |
928
+ | errors.APIError | 4XX, 5XX | \*/\* |
929
+
930
+ ## contains
931
+
932
+ Run Contains Evaluator
933
+
934
+ ### Example Usage
935
+
936
+ ```typescript
937
+ import { Orq } from "@orq-ai/node";
938
+
939
+ const orq = new Orq({
940
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
941
+ });
942
+
943
+ async function run() {
944
+ const result = await orq.evals.contains();
945
+
946
+ console.log(result);
947
+ }
948
+
949
+ run();
950
+ ```
951
+
952
+ ### Standalone function
953
+
954
+ The standalone function version of this method:
955
+
956
+ ```typescript
957
+ import { OrqCore } from "@orq-ai/node/core.js";
958
+ import { evalsContains } from "@orq-ai/node/funcs/evalsContains.js";
959
+
960
+ // Use `OrqCore` for best tree-shaking performance.
961
+ // You can create one instance of it to use across an application.
962
+ const orq = new OrqCore({
963
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
964
+ });
965
+
966
+ async function run() {
967
+ const res = await evalsContains(orq);
968
+ if (res.ok) {
969
+ const { value: result } = res;
970
+ console.log(result);
971
+ } else {
972
+ console.log("evalsContains failed:", res.error);
973
+ }
974
+ }
975
+
976
+ run();
977
+ ```
978
+
979
+ ### Parameters
980
+
981
+ | Parameter | Type | Required | Description |
982
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
983
+ | `request` | [operations.EvalsContainsRequestBody](../../models/operations/evalscontainsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
984
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
985
+ | `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. |
986
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
987
+
988
+ ### Response
989
+
990
+ **Promise\<[operations.EvalsContainsResponseBody](../../models/operations/evalscontainsresponsebody.md)\>**
991
+
992
+ ### Errors
993
+
994
+ | Error Type | Status Code | Content Type |
995
+ | ------------------------------------- | ------------------------------------- | ------------------------------------- |
996
+ | errors.EvalsContainsResponseBody | 404 | application/json |
997
+ | errors.EvalsContainsEvalsResponseBody | 500 | application/json |
998
+ | errors.APIError | 4XX, 5XX | \*/\* |
999
+
1000
+ ## endsWith
1001
+
1002
+ Run Ends With Evaluator
1003
+
1004
+ ### Example Usage
1005
+
1006
+ ```typescript
1007
+ import { Orq } from "@orq-ai/node";
1008
+
1009
+ const orq = new Orq({
1010
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1011
+ });
1012
+
1013
+ async function run() {
1014
+ const result = await orq.evals.endsWith();
1015
+
1016
+ console.log(result);
1017
+ }
1018
+
1019
+ run();
1020
+ ```
1021
+
1022
+ ### Standalone function
1023
+
1024
+ The standalone function version of this method:
1025
+
1026
+ ```typescript
1027
+ import { OrqCore } from "@orq-ai/node/core.js";
1028
+ import { evalsEndsWith } from "@orq-ai/node/funcs/evalsEndsWith.js";
1029
+
1030
+ // Use `OrqCore` for best tree-shaking performance.
1031
+ // You can create one instance of it to use across an application.
1032
+ const orq = new OrqCore({
1033
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1034
+ });
1035
+
1036
+ async function run() {
1037
+ const res = await evalsEndsWith(orq);
1038
+ if (res.ok) {
1039
+ const { value: result } = res;
1040
+ console.log(result);
1041
+ } else {
1042
+ console.log("evalsEndsWith failed:", res.error);
1043
+ }
1044
+ }
1045
+
1046
+ run();
1047
+ ```
1048
+
1049
+ ### Parameters
1050
+
1051
+ | Parameter | Type | Required | Description |
1052
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1053
+ | `request` | [operations.EvalsEndsWithRequestBody](../../models/operations/evalsendswithrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1054
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1055
+ | `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. |
1056
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1057
+
1058
+ ### Response
1059
+
1060
+ **Promise\<[operations.EvalsEndsWithResponseBody](../../models/operations/evalsendswithresponsebody.md)\>**
1061
+
1062
+ ### Errors
1063
+
1064
+ | Error Type | Status Code | Content Type |
1065
+ | ------------------------------------- | ------------------------------------- | ------------------------------------- |
1066
+ | errors.EvalsEndsWithResponseBody | 404 | application/json |
1067
+ | errors.EvalsEndsWithEvalsResponseBody | 500 | application/json |
1068
+ | errors.APIError | 4XX, 5XX | \*/\* |
1069
+
1070
+ ## exactMatch
1071
+
1072
+ Run Exact Match Evaluator
1073
+
1074
+ ### Example Usage
1075
+
1076
+ ```typescript
1077
+ import { Orq } from "@orq-ai/node";
1078
+
1079
+ const orq = new Orq({
1080
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1081
+ });
1082
+
1083
+ async function run() {
1084
+ const result = await orq.evals.exactMatch();
1085
+
1086
+ console.log(result);
1087
+ }
1088
+
1089
+ run();
1090
+ ```
1091
+
1092
+ ### Standalone function
1093
+
1094
+ The standalone function version of this method:
1095
+
1096
+ ```typescript
1097
+ import { OrqCore } from "@orq-ai/node/core.js";
1098
+ import { evalsExactMatch } from "@orq-ai/node/funcs/evalsExactMatch.js";
1099
+
1100
+ // Use `OrqCore` for best tree-shaking performance.
1101
+ // You can create one instance of it to use across an application.
1102
+ const orq = new OrqCore({
1103
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1104
+ });
1105
+
1106
+ async function run() {
1107
+ const res = await evalsExactMatch(orq);
1108
+ if (res.ok) {
1109
+ const { value: result } = res;
1110
+ console.log(result);
1111
+ } else {
1112
+ console.log("evalsExactMatch failed:", res.error);
1113
+ }
1114
+ }
1115
+
1116
+ run();
1117
+ ```
1118
+
1119
+ ### Parameters
1120
+
1121
+ | Parameter | Type | Required | Description |
1122
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1123
+ | `request` | [operations.EvalsExactMatchRequestBody](../../models/operations/evalsexactmatchrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1124
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1125
+ | `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. |
1126
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1127
+
1128
+ ### Response
1129
+
1130
+ **Promise\<[operations.EvalsExactMatchResponseBody](../../models/operations/evalsexactmatchresponsebody.md)\>**
1131
+
1132
+ ### Errors
1133
+
1134
+ | Error Type | Status Code | Content Type |
1135
+ | --------------------------------------- | --------------------------------------- | --------------------------------------- |
1136
+ | errors.EvalsExactMatchResponseBody | 404 | application/json |
1137
+ | errors.EvalsExactMatchEvalsResponseBody | 500 | application/json |
1138
+ | errors.APIError | 4XX, 5XX | \*/\* |
1139
+
1140
+ ## lengthBetween
1141
+
1142
+ Run Length Between Evaluator
1143
+
1144
+ ### Example Usage
1145
+
1146
+ ```typescript
1147
+ import { Orq } from "@orq-ai/node";
1148
+
1149
+ const orq = new Orq({
1150
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1151
+ });
1152
+
1153
+ async function run() {
1154
+ const result = await orq.evals.lengthBetween();
1155
+
1156
+ console.log(result);
1157
+ }
1158
+
1159
+ run();
1160
+ ```
1161
+
1162
+ ### Standalone function
1163
+
1164
+ The standalone function version of this method:
1165
+
1166
+ ```typescript
1167
+ import { OrqCore } from "@orq-ai/node/core.js";
1168
+ import { evalsLengthBetween } from "@orq-ai/node/funcs/evalsLengthBetween.js";
1169
+
1170
+ // Use `OrqCore` for best tree-shaking performance.
1171
+ // You can create one instance of it to use across an application.
1172
+ const orq = new OrqCore({
1173
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1174
+ });
1175
+
1176
+ async function run() {
1177
+ const res = await evalsLengthBetween(orq);
1178
+ if (res.ok) {
1179
+ const { value: result } = res;
1180
+ console.log(result);
1181
+ } else {
1182
+ console.log("evalsLengthBetween failed:", res.error);
1183
+ }
1184
+ }
1185
+
1186
+ run();
1187
+ ```
1188
+
1189
+ ### Parameters
1190
+
1191
+ | Parameter | Type | Required | Description |
1192
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1193
+ | `request` | [operations.EvalsLengthBetweenRequestBody](../../models/operations/evalslengthbetweenrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1194
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1195
+ | `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. |
1196
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1197
+
1198
+ ### Response
1199
+
1200
+ **Promise\<[operations.EvalsLengthBetweenResponseBody](../../models/operations/evalslengthbetweenresponsebody.md)\>**
1201
+
1202
+ ### Errors
1203
+
1204
+ | Error Type | Status Code | Content Type |
1205
+ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
1206
+ | errors.EvalsLengthBetweenResponseBody | 404 | application/json |
1207
+ | errors.EvalsLengthBetweenEvalsResponseBody | 500 | application/json |
1208
+ | errors.APIError | 4XX, 5XX | \*/\* |
1209
+
1210
+ ## lengthGreaterThan
1211
+
1212
+ Run Length Greater Than Evaluator
1213
+
1214
+ ### Example Usage
1215
+
1216
+ ```typescript
1217
+ import { Orq } from "@orq-ai/node";
1218
+
1219
+ const orq = new Orq({
1220
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1221
+ });
1222
+
1223
+ async function run() {
1224
+ const result = await orq.evals.lengthGreaterThan();
1225
+
1226
+ console.log(result);
1227
+ }
1228
+
1229
+ run();
1230
+ ```
1231
+
1232
+ ### Standalone function
1233
+
1234
+ The standalone function version of this method:
1235
+
1236
+ ```typescript
1237
+ import { OrqCore } from "@orq-ai/node/core.js";
1238
+ import { evalsLengthGreaterThan } from "@orq-ai/node/funcs/evalsLengthGreaterThan.js";
1239
+
1240
+ // Use `OrqCore` for best tree-shaking performance.
1241
+ // You can create one instance of it to use across an application.
1242
+ const orq = new OrqCore({
1243
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1244
+ });
1245
+
1246
+ async function run() {
1247
+ const res = await evalsLengthGreaterThan(orq);
1248
+ if (res.ok) {
1249
+ const { value: result } = res;
1250
+ console.log(result);
1251
+ } else {
1252
+ console.log("evalsLengthGreaterThan failed:", res.error);
1253
+ }
1254
+ }
1255
+
1256
+ run();
1257
+ ```
1258
+
1259
+ ### Parameters
1260
+
1261
+ | Parameter | Type | Required | Description |
1262
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1263
+ | `request` | [operations.EvalsLengthGreaterThanRequestBody](../../models/operations/evalslengthgreaterthanrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1264
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1265
+ | `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. |
1266
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1267
+
1268
+ ### Response
1269
+
1270
+ **Promise\<[operations.EvalsLengthGreaterThanResponseBody](../../models/operations/evalslengthgreaterthanresponsebody.md)\>**
1271
+
1272
+ ### Errors
1273
+
1274
+ | Error Type | Status Code | Content Type |
1275
+ | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
1276
+ | errors.EvalsLengthGreaterThanResponseBody | 404 | application/json |
1277
+ | errors.EvalsLengthGreaterThanEvalsResponseBody | 500 | application/json |
1278
+ | errors.APIError | 4XX, 5XX | \*/\* |
1279
+
1280
+ ## lengthLessThan
1281
+
1282
+ Run Length Less Than Evaluator
1283
+
1284
+ ### Example Usage
1285
+
1286
+ ```typescript
1287
+ import { Orq } from "@orq-ai/node";
1288
+
1289
+ const orq = new Orq({
1290
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1291
+ });
1292
+
1293
+ async function run() {
1294
+ const result = await orq.evals.lengthLessThan();
1295
+
1296
+ console.log(result);
1297
+ }
1298
+
1299
+ run();
1300
+ ```
1301
+
1302
+ ### Standalone function
1303
+
1304
+ The standalone function version of this method:
1305
+
1306
+ ```typescript
1307
+ import { OrqCore } from "@orq-ai/node/core.js";
1308
+ import { evalsLengthLessThan } from "@orq-ai/node/funcs/evalsLengthLessThan.js";
1309
+
1310
+ // Use `OrqCore` for best tree-shaking performance.
1311
+ // You can create one instance of it to use across an application.
1312
+ const orq = new OrqCore({
1313
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1314
+ });
1315
+
1316
+ async function run() {
1317
+ const res = await evalsLengthLessThan(orq);
1318
+ if (res.ok) {
1319
+ const { value: result } = res;
1320
+ console.log(result);
1321
+ } else {
1322
+ console.log("evalsLengthLessThan failed:", res.error);
1323
+ }
1324
+ }
1325
+
1326
+ run();
1327
+ ```
1328
+
1329
+ ### Parameters
1330
+
1331
+ | Parameter | Type | Required | Description |
1332
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1333
+ | `request` | [operations.EvalsLengthLessThanRequestBody](../../models/operations/evalslengthlessthanrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1334
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1335
+ | `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. |
1336
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1337
+
1338
+ ### Response
1339
+
1340
+ **Promise\<[operations.EvalsLengthLessThanResponseBody](../../models/operations/evalslengthlessthanresponsebody.md)\>**
1341
+
1342
+ ### Errors
1343
+
1344
+ | Error Type | Status Code | Content Type |
1345
+ | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
1346
+ | errors.EvalsLengthLessThanResponseBody | 404 | application/json |
1347
+ | errors.EvalsLengthLessThanEvalsResponseBody | 500 | application/json |
1348
+ | errors.APIError | 4XX, 5XX | \*/\* |
1349
+
1350
+ ## validJson
1351
+
1352
+ Run JSON Validation Evaluator
1353
+
1354
+ ### Example Usage
1355
+
1356
+ ```typescript
1357
+ import { Orq } from "@orq-ai/node";
1358
+
1359
+ const orq = new Orq({
1360
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1361
+ });
1362
+
1363
+ async function run() {
1364
+ const result = await orq.evals.validJson();
1365
+
1366
+ console.log(result);
1367
+ }
1368
+
1369
+ run();
1370
+ ```
1371
+
1372
+ ### Standalone function
1373
+
1374
+ The standalone function version of this method:
1375
+
1376
+ ```typescript
1377
+ import { OrqCore } from "@orq-ai/node/core.js";
1378
+ import { evalsValidJson } from "@orq-ai/node/funcs/evalsValidJson.js";
1379
+
1380
+ // Use `OrqCore` for best tree-shaking performance.
1381
+ // You can create one instance of it to use across an application.
1382
+ const orq = new OrqCore({
1383
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1384
+ });
1385
+
1386
+ async function run() {
1387
+ const res = await evalsValidJson(orq);
1388
+ if (res.ok) {
1389
+ const { value: result } = res;
1390
+ console.log(result);
1391
+ } else {
1392
+ console.log("evalsValidJson failed:", res.error);
1393
+ }
1394
+ }
1395
+
1396
+ run();
1397
+ ```
1398
+
1399
+ ### Parameters
1400
+
1401
+ | Parameter | Type | Required | Description |
1402
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1403
+ | `request` | [operations.EvalsValidJsonRequestBody](../../models/operations/evalsvalidjsonrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1404
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1405
+ | `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. |
1406
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1407
+
1408
+ ### Response
1409
+
1410
+ **Promise\<[operations.EvalsValidJsonResponseBody](../../models/operations/evalsvalidjsonresponsebody.md)\>**
1411
+
1412
+ ### Errors
1413
+
1414
+ | Error Type | Status Code | Content Type |
1415
+ | -------------------------------------- | -------------------------------------- | -------------------------------------- |
1416
+ | errors.EvalsValidJsonResponseBody | 404 | application/json |
1417
+ | errors.EvalsValidJsonEvalsResponseBody | 500 | application/json |
1418
+ | errors.APIError | 4XX, 5XX | \*/\* |
1419
+
1420
+ ## ageAppropriate
1421
+
1422
+ Run Age Appropriate Evaluator
1423
+
1424
+ ### Example Usage
1425
+
1426
+ ```typescript
1427
+ import { Orq } from "@orq-ai/node";
1428
+
1429
+ const orq = new Orq({
1430
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1431
+ });
1432
+
1433
+ async function run() {
1434
+ const result = await orq.evals.ageAppropriate();
1435
+
1436
+ console.log(result);
1437
+ }
1438
+
1439
+ run();
1440
+ ```
1441
+
1442
+ ### Standalone function
1443
+
1444
+ The standalone function version of this method:
1445
+
1446
+ ```typescript
1447
+ import { OrqCore } from "@orq-ai/node/core.js";
1448
+ import { evalsAgeAppropriate } from "@orq-ai/node/funcs/evalsAgeAppropriate.js";
1449
+
1450
+ // Use `OrqCore` for best tree-shaking performance.
1451
+ // You can create one instance of it to use across an application.
1452
+ const orq = new OrqCore({
1453
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1454
+ });
1455
+
1456
+ async function run() {
1457
+ const res = await evalsAgeAppropriate(orq);
1458
+ if (res.ok) {
1459
+ const { value: result } = res;
1460
+ console.log(result);
1461
+ } else {
1462
+ console.log("evalsAgeAppropriate failed:", res.error);
1463
+ }
1464
+ }
1465
+
1466
+ run();
1467
+ ```
1468
+
1469
+ ### Parameters
1470
+
1471
+ | Parameter | Type | Required | Description |
1472
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1473
+ | `request` | [operations.EvalsAgeAppropriateRequestBody](../../models/operations/evalsageappropriaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1474
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1475
+ | `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. |
1476
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1477
+
1478
+ ### Response
1479
+
1480
+ **Promise\<[operations.EvalsAgeAppropriateResponseBody](../../models/operations/evalsageappropriateresponsebody.md)\>**
1481
+
1482
+ ### Errors
1483
+
1484
+ | Error Type | Status Code | Content Type |
1485
+ | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
1486
+ | errors.EvalsAgeAppropriateResponseBody | 404 | application/json |
1487
+ | errors.EvalsAgeAppropriateEvalsResponseBody | 500 | application/json |
1488
+ | errors.APIError | 4XX, 5XX | \*/\* |
1489
+
1490
+ ## botDetection
1491
+
1492
+ Run Bot Detection Evaluator
1493
+
1494
+ ### Example Usage
1495
+
1496
+ ```typescript
1497
+ import { Orq } from "@orq-ai/node";
1498
+
1499
+ const orq = new Orq({
1500
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1501
+ });
1502
+
1503
+ async function run() {
1504
+ const result = await orq.evals.botDetection();
1505
+
1506
+ console.log(result);
1507
+ }
1508
+
1509
+ run();
1510
+ ```
1511
+
1512
+ ### Standalone function
1513
+
1514
+ The standalone function version of this method:
1515
+
1516
+ ```typescript
1517
+ import { OrqCore } from "@orq-ai/node/core.js";
1518
+ import { evalsBotDetection } from "@orq-ai/node/funcs/evalsBotDetection.js";
1519
+
1520
+ // Use `OrqCore` for best tree-shaking performance.
1521
+ // You can create one instance of it to use across an application.
1522
+ const orq = new OrqCore({
1523
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1524
+ });
1525
+
1526
+ async function run() {
1527
+ const res = await evalsBotDetection(orq);
1528
+ if (res.ok) {
1529
+ const { value: result } = res;
1530
+ console.log(result);
1531
+ } else {
1532
+ console.log("evalsBotDetection failed:", res.error);
1533
+ }
1534
+ }
1535
+
1536
+ run();
1537
+ ```
1538
+
1539
+ ### Parameters
1540
+
1541
+ | Parameter | Type | Required | Description |
1542
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1543
+ | `request` | [operations.EvalsBotDetectionRequestBody](../../models/operations/evalsbotdetectionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1544
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1545
+ | `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. |
1546
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1547
+
1548
+ ### Response
1549
+
1550
+ **Promise\<[operations.EvalsBotDetectionResponseBody](../../models/operations/evalsbotdetectionresponsebody.md)\>**
1551
+
1552
+ ### Errors
1553
+
1554
+ | Error Type | Status Code | Content Type |
1555
+ | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
1556
+ | errors.EvalsBotDetectionResponseBody | 404 | application/json |
1557
+ | errors.EvalsBotDetectionEvalsResponseBody | 500 | application/json |
1558
+ | errors.APIError | 4XX, 5XX | \*/\* |
1559
+
1560
+ ## factCheckingKnowledgeBase
1561
+
1562
+ Run Fact Checking Knowledge Base Evaluator
1563
+
1564
+ ### Example Usage
1565
+
1566
+ ```typescript
1567
+ import { Orq } from "@orq-ai/node";
1568
+
1569
+ const orq = new Orq({
1570
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1571
+ });
1572
+
1573
+ async function run() {
1574
+ const result = await orq.evals.factCheckingKnowledgeBase();
1575
+
1576
+ console.log(result);
1577
+ }
1578
+
1579
+ run();
1580
+ ```
1581
+
1582
+ ### Standalone function
1583
+
1584
+ The standalone function version of this method:
1585
+
1586
+ ```typescript
1587
+ import { OrqCore } from "@orq-ai/node/core.js";
1588
+ import { evalsFactCheckingKnowledgeBase } from "@orq-ai/node/funcs/evalsFactCheckingKnowledgeBase.js";
1589
+
1590
+ // Use `OrqCore` for best tree-shaking performance.
1591
+ // You can create one instance of it to use across an application.
1592
+ const orq = new OrqCore({
1593
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1594
+ });
1595
+
1596
+ async function run() {
1597
+ const res = await evalsFactCheckingKnowledgeBase(orq);
1598
+ if (res.ok) {
1599
+ const { value: result } = res;
1600
+ console.log(result);
1601
+ } else {
1602
+ console.log("evalsFactCheckingKnowledgeBase failed:", res.error);
1603
+ }
1604
+ }
1605
+
1606
+ run();
1607
+ ```
1608
+
1609
+ ### Parameters
1610
+
1611
+ | Parameter | Type | Required | Description |
1612
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1613
+ | `request` | [operations.EvalsFactCheckingKnowledgeBaseRequestBody](../../models/operations/evalsfactcheckingknowledgebaserequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1614
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1615
+ | `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. |
1616
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1617
+
1618
+ ### Response
1619
+
1620
+ **Promise\<[operations.EvalsFactCheckingKnowledgeBaseResponseBody](../../models/operations/evalsfactcheckingknowledgebaseresponsebody.md)\>**
1621
+
1622
+ ### Errors
1623
+
1624
+ | Error Type | Status Code | Content Type |
1625
+ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
1626
+ | errors.EvalsFactCheckingKnowledgeBaseResponseBody | 404 | application/json |
1627
+ | errors.EvalsFactCheckingKnowledgeBaseEvalsResponseBody | 500 | application/json |
1628
+ | errors.APIError | 4XX, 5XX | \*/\* |
1629
+
1630
+ ## grammar
1631
+
1632
+ Run Grammar Evaluator
1633
+
1634
+ ### Example Usage
1635
+
1636
+ ```typescript
1637
+ import { Orq } from "@orq-ai/node";
1638
+
1639
+ const orq = new Orq({
1640
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1641
+ });
1642
+
1643
+ async function run() {
1644
+ const result = await orq.evals.grammar();
1645
+
1646
+ console.log(result);
1647
+ }
1648
+
1649
+ run();
1650
+ ```
1651
+
1652
+ ### Standalone function
1653
+
1654
+ The standalone function version of this method:
1655
+
1656
+ ```typescript
1657
+ import { OrqCore } from "@orq-ai/node/core.js";
1658
+ import { evalsGrammar } from "@orq-ai/node/funcs/evalsGrammar.js";
1659
+
1660
+ // Use `OrqCore` for best tree-shaking performance.
1661
+ // You can create one instance of it to use across an application.
1662
+ const orq = new OrqCore({
1663
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1664
+ });
1665
+
1666
+ async function run() {
1667
+ const res = await evalsGrammar(orq);
1668
+ if (res.ok) {
1669
+ const { value: result } = res;
1670
+ console.log(result);
1671
+ } else {
1672
+ console.log("evalsGrammar failed:", res.error);
1673
+ }
1674
+ }
1675
+
1676
+ run();
1677
+ ```
1678
+
1679
+ ### Parameters
1680
+
1681
+ | Parameter | Type | Required | Description |
1682
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1683
+ | `request` | [operations.EvalsGrammarRequestBody](../../models/operations/evalsgrammarrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1684
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1685
+ | `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. |
1686
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1687
+
1688
+ ### Response
1689
+
1690
+ **Promise\<[operations.EvalsGrammarResponseBody](../../models/operations/evalsgrammarresponsebody.md)\>**
1691
+
1692
+ ### Errors
1693
+
1694
+ | Error Type | Status Code | Content Type |
1695
+ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
1696
+ | errors.EvalsGrammarResponseBody | 404 | application/json |
1697
+ | errors.EvalsGrammarEvalsResponseBody | 500 | application/json |
1698
+ | errors.APIError | 4XX, 5XX | \*/\* |
1699
+
1700
+ ## localization
1701
+
1702
+ Run Localization Evaluator
1703
+
1704
+ ### Example Usage
1705
+
1706
+ ```typescript
1707
+ import { Orq } from "@orq-ai/node";
1708
+
1709
+ const orq = new Orq({
1710
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1711
+ });
1712
+
1713
+ async function run() {
1714
+ const result = await orq.evals.localization();
1715
+
1716
+ console.log(result);
1717
+ }
1718
+
1719
+ run();
1720
+ ```
1721
+
1722
+ ### Standalone function
1723
+
1724
+ The standalone function version of this method:
1725
+
1726
+ ```typescript
1727
+ import { OrqCore } from "@orq-ai/node/core.js";
1728
+ import { evalsLocalization } from "@orq-ai/node/funcs/evalsLocalization.js";
1729
+
1730
+ // Use `OrqCore` for best tree-shaking performance.
1731
+ // You can create one instance of it to use across an application.
1732
+ const orq = new OrqCore({
1733
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1734
+ });
1735
+
1736
+ async function run() {
1737
+ const res = await evalsLocalization(orq);
1738
+ if (res.ok) {
1739
+ const { value: result } = res;
1740
+ console.log(result);
1741
+ } else {
1742
+ console.log("evalsLocalization failed:", res.error);
1743
+ }
1744
+ }
1745
+
1746
+ run();
1747
+ ```
1748
+
1749
+ ### Parameters
1750
+
1751
+ | Parameter | Type | Required | Description |
1752
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1753
+ | `request` | [operations.EvalsLocalizationRequestBody](../../models/operations/evalslocalizationrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1754
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1755
+ | `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. |
1756
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1757
+
1758
+ ### Response
1759
+
1760
+ **Promise\<[operations.EvalsLocalizationResponseBody](../../models/operations/evalslocalizationresponsebody.md)\>**
1761
+
1762
+ ### Errors
1763
+
1764
+ | Error Type | Status Code | Content Type |
1765
+ | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
1766
+ | errors.EvalsLocalizationResponseBody | 404 | application/json |
1767
+ | errors.EvalsLocalizationEvalsResponseBody | 500 | application/json |
1768
+ | errors.APIError | 4XX, 5XX | \*/\* |
1769
+
1770
+ ## pii
1771
+
1772
+ Run PII Evaluator
1773
+
1774
+ ### Example Usage
1775
+
1776
+ ```typescript
1777
+ import { Orq } from "@orq-ai/node";
1778
+
1779
+ const orq = new Orq({
1780
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1781
+ });
1782
+
1783
+ async function run() {
1784
+ const result = await orq.evals.pii();
1785
+
1786
+ console.log(result);
1787
+ }
1788
+
1789
+ run();
1790
+ ```
1791
+
1792
+ ### Standalone function
1793
+
1794
+ The standalone function version of this method:
1795
+
1796
+ ```typescript
1797
+ import { OrqCore } from "@orq-ai/node/core.js";
1798
+ import { evalsPii } from "@orq-ai/node/funcs/evalsPii.js";
1799
+
1800
+ // Use `OrqCore` for best tree-shaking performance.
1801
+ // You can create one instance of it to use across an application.
1802
+ const orq = new OrqCore({
1803
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1804
+ });
1805
+
1806
+ async function run() {
1807
+ const res = await evalsPii(orq);
1808
+ if (res.ok) {
1809
+ const { value: result } = res;
1810
+ console.log(result);
1811
+ } else {
1812
+ console.log("evalsPii failed:", res.error);
1813
+ }
1814
+ }
1815
+
1816
+ run();
1817
+ ```
1818
+
1819
+ ### Parameters
1820
+
1821
+ | Parameter | Type | Required | Description |
1822
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1823
+ | `request` | [operations.EvalsPiiRequestBody](../../models/operations/evalspiirequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1824
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1825
+ | `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. |
1826
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1827
+
1828
+ ### Response
1829
+
1830
+ **Promise\<[operations.EvalsPiiResponseBody](../../models/operations/evalspiiresponsebody.md)\>**
1831
+
1832
+ ### Errors
1833
+
1834
+ | Error Type | Status Code | Content Type |
1835
+ | -------------------------------- | -------------------------------- | -------------------------------- |
1836
+ | errors.EvalsPiiResponseBody | 404 | application/json |
1837
+ | errors.EvalsPiiEvalsResponseBody | 500 | application/json |
1838
+ | errors.APIError | 4XX, 5XX | \*/\* |
1839
+
1840
+ ## sentimentClassification
1841
+
1842
+ Run Sentiment Classification Evaluator
1843
+
1844
+ ### Example Usage
1845
+
1846
+ ```typescript
1847
+ import { Orq } from "@orq-ai/node";
1848
+
1849
+ const orq = new Orq({
1850
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1851
+ });
1852
+
1853
+ async function run() {
1854
+ const result = await orq.evals.sentimentClassification();
1855
+
1856
+ console.log(result);
1857
+ }
1858
+
1859
+ run();
1860
+ ```
1861
+
1862
+ ### Standalone function
1863
+
1864
+ The standalone function version of this method:
1865
+
1866
+ ```typescript
1867
+ import { OrqCore } from "@orq-ai/node/core.js";
1868
+ import { evalsSentimentClassification } from "@orq-ai/node/funcs/evalsSentimentClassification.js";
1869
+
1870
+ // Use `OrqCore` for best tree-shaking performance.
1871
+ // You can create one instance of it to use across an application.
1872
+ const orq = new OrqCore({
1873
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1874
+ });
1875
+
1876
+ async function run() {
1877
+ const res = await evalsSentimentClassification(orq);
1878
+ if (res.ok) {
1879
+ const { value: result } = res;
1880
+ console.log(result);
1881
+ } else {
1882
+ console.log("evalsSentimentClassification failed:", res.error);
1883
+ }
1884
+ }
1885
+
1886
+ run();
1887
+ ```
1888
+
1889
+ ### Parameters
1890
+
1891
+ | Parameter | Type | Required | Description |
1892
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1893
+ | `request` | [operations.EvalsSentimentClassificationRequestBody](../../models/operations/evalssentimentclassificationrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1894
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1895
+ | `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. |
1896
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1897
+
1898
+ ### Response
1899
+
1900
+ **Promise\<[operations.EvalsSentimentClassificationResponseBody](../../models/operations/evalssentimentclassificationresponsebody.md)\>**
1901
+
1902
+ ### Errors
1903
+
1904
+ | Error Type | Status Code | Content Type |
1905
+ | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
1906
+ | errors.EvalsSentimentClassificationResponseBody | 404 | application/json |
1907
+ | errors.EvalsSentimentClassificationEvalsResponseBody | 500 | application/json |
1908
+ | errors.APIError | 4XX, 5XX | \*/\* |
1909
+
1910
+ ## summarization
1911
+
1912
+ Run Summarization Evaluator
1913
+
1914
+ ### Example Usage
1915
+
1916
+ ```typescript
1917
+ import { Orq } from "@orq-ai/node";
1918
+
1919
+ const orq = new Orq({
1920
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1921
+ });
1922
+
1923
+ async function run() {
1924
+ const result = await orq.evals.summarization();
1925
+
1926
+ console.log(result);
1927
+ }
1928
+
1929
+ run();
1930
+ ```
1931
+
1932
+ ### Standalone function
1933
+
1934
+ The standalone function version of this method:
1935
+
1936
+ ```typescript
1937
+ import { OrqCore } from "@orq-ai/node/core.js";
1938
+ import { evalsSummarization } from "@orq-ai/node/funcs/evalsSummarization.js";
1939
+
1940
+ // Use `OrqCore` for best tree-shaking performance.
1941
+ // You can create one instance of it to use across an application.
1942
+ const orq = new OrqCore({
1943
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1944
+ });
1945
+
1946
+ async function run() {
1947
+ const res = await evalsSummarization(orq);
1948
+ if (res.ok) {
1949
+ const { value: result } = res;
1950
+ console.log(result);
1951
+ } else {
1952
+ console.log("evalsSummarization failed:", res.error);
1953
+ }
1954
+ }
1955
+
1956
+ run();
1957
+ ```
1958
+
1959
+ ### Parameters
1960
+
1961
+ | Parameter | Type | Required | Description |
1962
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1963
+ | `request` | [operations.EvalsSummarizationRequestBody](../../models/operations/evalssummarizationrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1964
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1965
+ | `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. |
1966
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1967
+
1968
+ ### Response
1969
+
1970
+ **Promise\<[operations.EvalsSummarizationResponseBody](../../models/operations/evalssummarizationresponsebody.md)\>**
1971
+
1972
+ ### Errors
1973
+
1974
+ | Error Type | Status Code | Content Type |
1975
+ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
1976
+ | errors.EvalsSummarizationResponseBody | 404 | application/json |
1977
+ | errors.EvalsSummarizationEvalsResponseBody | 500 | application/json |
1978
+ | errors.APIError | 4XX, 5XX | \*/\* |
1979
+
1980
+ ## toneOfVoice
1981
+
1982
+ Run Tone of Voice Evaluator
1983
+
1984
+ ### Example Usage
1985
+
1986
+ ```typescript
1987
+ import { Orq } from "@orq-ai/node";
1988
+
1989
+ const orq = new Orq({
1990
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1991
+ });
1992
+
1993
+ async function run() {
1994
+ const result = await orq.evals.toneOfVoice();
1995
+
1996
+ console.log(result);
1997
+ }
1998
+
1999
+ run();
2000
+ ```
2001
+
2002
+ ### Standalone function
2003
+
2004
+ The standalone function version of this method:
2005
+
2006
+ ```typescript
2007
+ import { OrqCore } from "@orq-ai/node/core.js";
2008
+ import { evalsToneOfVoice } from "@orq-ai/node/funcs/evalsToneOfVoice.js";
2009
+
2010
+ // Use `OrqCore` for best tree-shaking performance.
2011
+ // You can create one instance of it to use across an application.
2012
+ const orq = new OrqCore({
2013
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2014
+ });
2015
+
2016
+ async function run() {
2017
+ const res = await evalsToneOfVoice(orq);
2018
+ if (res.ok) {
2019
+ const { value: result } = res;
2020
+ console.log(result);
2021
+ } else {
2022
+ console.log("evalsToneOfVoice failed:", res.error);
2023
+ }
2024
+ }
2025
+
2026
+ run();
2027
+ ```
2028
+
2029
+ ### Parameters
2030
+
2031
+ | Parameter | Type | Required | Description |
2032
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2033
+ | `request` | [operations.EvalsToneOfVoiceRequestBody](../../models/operations/evalstoneofvoicerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2034
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2035
+ | `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. |
2036
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2037
+
2038
+ ### Response
2039
+
2040
+ **Promise\<[operations.EvalsToneOfVoiceResponseBody](../../models/operations/evalstoneofvoiceresponsebody.md)\>**
2041
+
2042
+ ### Errors
2043
+
2044
+ | Error Type | Status Code | Content Type |
2045
+ | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
2046
+ | errors.EvalsToneOfVoiceResponseBody | 404 | application/json |
2047
+ | errors.EvalsToneOfVoiceEvalsResponseBody | 500 | application/json |
2048
+ | errors.APIError | 4XX, 5XX | \*/\* |
2049
+
2050
+ ## translation
2051
+
2052
+ Run Translation Evaluator
2053
+
2054
+ ### Example Usage
2055
+
2056
+ ```typescript
2057
+ import { Orq } from "@orq-ai/node";
2058
+
2059
+ const orq = new Orq({
2060
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2061
+ });
2062
+
2063
+ async function run() {
2064
+ const result = await orq.evals.translation();
2065
+
2066
+ console.log(result);
2067
+ }
2068
+
2069
+ run();
2070
+ ```
2071
+
2072
+ ### Standalone function
2073
+
2074
+ The standalone function version of this method:
2075
+
2076
+ ```typescript
2077
+ import { OrqCore } from "@orq-ai/node/core.js";
2078
+ import { evalsTranslation } from "@orq-ai/node/funcs/evalsTranslation.js";
2079
+
2080
+ // Use `OrqCore` for best tree-shaking performance.
2081
+ // You can create one instance of it to use across an application.
2082
+ const orq = new OrqCore({
2083
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2084
+ });
2085
+
2086
+ async function run() {
2087
+ const res = await evalsTranslation(orq);
2088
+ if (res.ok) {
2089
+ const { value: result } = res;
2090
+ console.log(result);
2091
+ } else {
2092
+ console.log("evalsTranslation failed:", res.error);
2093
+ }
2094
+ }
2095
+
2096
+ run();
2097
+ ```
2098
+
2099
+ ### Parameters
2100
+
2101
+ | Parameter | Type | Required | Description |
2102
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2103
+ | `request` | [operations.EvalsTranslationRequestBody](../../models/operations/evalstranslationrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2104
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2105
+ | `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. |
2106
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2107
+
2108
+ ### Response
2109
+
2110
+ **Promise\<[operations.EvalsTranslationResponseBody](../../models/operations/evalstranslationresponsebody.md)\>**
2111
+
2112
+ ### Errors
2113
+
2114
+ | Error Type | Status Code | Content Type |
2115
+ | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
2116
+ | errors.EvalsTranslationResponseBody | 404 | application/json |
2117
+ | errors.EvalsTranslationEvalsResponseBody | 500 | application/json |
2118
+ | errors.APIError | 4XX, 5XX | \*/\* |
2119
+
2120
+ ## ragasCoherence
2121
+
2122
+ Run Coherence Evaluator
2123
+
2124
+ ### Example Usage
2125
+
2126
+ ```typescript
2127
+ import { Orq } from "@orq-ai/node";
2128
+
2129
+ const orq = new Orq({
2130
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2131
+ });
2132
+
2133
+ async function run() {
2134
+ const result = await orq.evals.ragasCoherence();
2135
+
2136
+ console.log(result);
2137
+ }
2138
+
2139
+ run();
2140
+ ```
2141
+
2142
+ ### Standalone function
2143
+
2144
+ The standalone function version of this method:
2145
+
2146
+ ```typescript
2147
+ import { OrqCore } from "@orq-ai/node/core.js";
2148
+ import { evalsRagasCoherence } from "@orq-ai/node/funcs/evalsRagasCoherence.js";
2149
+
2150
+ // Use `OrqCore` for best tree-shaking performance.
2151
+ // You can create one instance of it to use across an application.
2152
+ const orq = new OrqCore({
2153
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2154
+ });
2155
+
2156
+ async function run() {
2157
+ const res = await evalsRagasCoherence(orq);
2158
+ if (res.ok) {
2159
+ const { value: result } = res;
2160
+ console.log(result);
2161
+ } else {
2162
+ console.log("evalsRagasCoherence failed:", res.error);
2163
+ }
2164
+ }
2165
+
2166
+ run();
2167
+ ```
2168
+
2169
+ ### Parameters
2170
+
2171
+ | Parameter | Type | Required | Description |
2172
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2173
+ | `request` | [operations.EvalsRagasCoherenceRequestBody](../../models/operations/evalsragascoherencerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2174
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2175
+ | `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. |
2176
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2177
+
2178
+ ### Response
2179
+
2180
+ **Promise\<[operations.EvalsRagasCoherenceResponseBody](../../models/operations/evalsragascoherenceresponsebody.md)\>**
2181
+
2182
+ ### Errors
2183
+
2184
+ | Error Type | Status Code | Content Type |
2185
+ | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
2186
+ | errors.EvalsRagasCoherenceResponseBody | 404 | application/json |
2187
+ | errors.EvalsRagasCoherenceEvalsResponseBody | 500 | application/json |
2188
+ | errors.APIError | 4XX, 5XX | \*/\* |
2189
+
2190
+ ## ragasConciseness
2191
+
2192
+ Run Conciseness Evaluator
2193
+
2194
+ ### Example Usage
2195
+
2196
+ ```typescript
2197
+ import { Orq } from "@orq-ai/node";
2198
+
2199
+ const orq = new Orq({
2200
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2201
+ });
2202
+
2203
+ async function run() {
2204
+ const result = await orq.evals.ragasConciseness();
2205
+
2206
+ console.log(result);
2207
+ }
2208
+
2209
+ run();
2210
+ ```
2211
+
2212
+ ### Standalone function
2213
+
2214
+ The standalone function version of this method:
2215
+
2216
+ ```typescript
2217
+ import { OrqCore } from "@orq-ai/node/core.js";
2218
+ import { evalsRagasConciseness } from "@orq-ai/node/funcs/evalsRagasConciseness.js";
2219
+
2220
+ // Use `OrqCore` for best tree-shaking performance.
2221
+ // You can create one instance of it to use across an application.
2222
+ const orq = new OrqCore({
2223
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2224
+ });
2225
+
2226
+ async function run() {
2227
+ const res = await evalsRagasConciseness(orq);
2228
+ if (res.ok) {
2229
+ const { value: result } = res;
2230
+ console.log(result);
2231
+ } else {
2232
+ console.log("evalsRagasConciseness failed:", res.error);
2233
+ }
2234
+ }
2235
+
2236
+ run();
2237
+ ```
2238
+
2239
+ ### Parameters
2240
+
2241
+ | Parameter | Type | Required | Description |
2242
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2243
+ | `request` | [operations.EvalsRagasConcisenessRequestBody](../../models/operations/evalsragasconcisenessrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2244
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2245
+ | `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. |
2246
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2247
+
2248
+ ### Response
2249
+
2250
+ **Promise\<[operations.EvalsRagasConcisenessResponseBody](../../models/operations/evalsragasconcisenessresponsebody.md)\>**
2251
+
2252
+ ### Errors
2253
+
2254
+ | Error Type | Status Code | Content Type |
2255
+ | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
2256
+ | errors.EvalsRagasConcisenessResponseBody | 404 | application/json |
2257
+ | errors.EvalsRagasConcisenessEvalsResponseBody | 500 | application/json |
2258
+ | errors.APIError | 4XX, 5XX | \*/\* |
2259
+
2260
+ ## ragasContextPrecision
2261
+
2262
+ Run Context Precision Evaluator
2263
+
2264
+ ### Example Usage
2265
+
2266
+ ```typescript
2267
+ import { Orq } from "@orq-ai/node";
2268
+
2269
+ const orq = new Orq({
2270
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2271
+ });
2272
+
2273
+ async function run() {
2274
+ const result = await orq.evals.ragasContextPrecision();
2275
+
2276
+ console.log(result);
2277
+ }
2278
+
2279
+ run();
2280
+ ```
2281
+
2282
+ ### Standalone function
2283
+
2284
+ The standalone function version of this method:
2285
+
2286
+ ```typescript
2287
+ import { OrqCore } from "@orq-ai/node/core.js";
2288
+ import { evalsRagasContextPrecision } from "@orq-ai/node/funcs/evalsRagasContextPrecision.js";
2289
+
2290
+ // Use `OrqCore` for best tree-shaking performance.
2291
+ // You can create one instance of it to use across an application.
2292
+ const orq = new OrqCore({
2293
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2294
+ });
2295
+
2296
+ async function run() {
2297
+ const res = await evalsRagasContextPrecision(orq);
2298
+ if (res.ok) {
2299
+ const { value: result } = res;
2300
+ console.log(result);
2301
+ } else {
2302
+ console.log("evalsRagasContextPrecision failed:", res.error);
2303
+ }
2304
+ }
2305
+
2306
+ run();
2307
+ ```
2308
+
2309
+ ### Parameters
2310
+
2311
+ | Parameter | Type | Required | Description |
2312
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2313
+ | `request` | [operations.EvalsRagasContextPrecisionRequestBody](../../models/operations/evalsragascontextprecisionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2314
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2315
+ | `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. |
2316
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2317
+
2318
+ ### Response
2319
+
2320
+ **Promise\<[operations.EvalsRagasContextPrecisionResponseBody](../../models/operations/evalsragascontextprecisionresponsebody.md)\>**
2321
+
2322
+ ### Errors
2323
+
2324
+ | Error Type | Status Code | Content Type |
2325
+ | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
2326
+ | errors.EvalsRagasContextPrecisionResponseBody | 404 | application/json |
2327
+ | errors.EvalsRagasContextPrecisionEvalsResponseBody | 500 | application/json |
2328
+ | errors.APIError | 4XX, 5XX | \*/\* |
2329
+
2330
+ ## ragasCorrectness
2331
+
2332
+ Run Correctness Evaluator
2333
+
2334
+ ### Example Usage
2335
+
2336
+ ```typescript
2337
+ import { Orq } from "@orq-ai/node";
2338
+
2339
+ const orq = new Orq({
2340
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2341
+ });
2342
+
2343
+ async function run() {
2344
+ const result = await orq.evals.ragasCorrectness();
2345
+
2346
+ console.log(result);
2347
+ }
2348
+
2349
+ run();
2350
+ ```
2351
+
2352
+ ### Standalone function
2353
+
2354
+ The standalone function version of this method:
2355
+
2356
+ ```typescript
2357
+ import { OrqCore } from "@orq-ai/node/core.js";
2358
+ import { evalsRagasCorrectness } from "@orq-ai/node/funcs/evalsRagasCorrectness.js";
2359
+
2360
+ // Use `OrqCore` for best tree-shaking performance.
2361
+ // You can create one instance of it to use across an application.
2362
+ const orq = new OrqCore({
2363
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2364
+ });
2365
+
2366
+ async function run() {
2367
+ const res = await evalsRagasCorrectness(orq);
2368
+ if (res.ok) {
2369
+ const { value: result } = res;
2370
+ console.log(result);
2371
+ } else {
2372
+ console.log("evalsRagasCorrectness failed:", res.error);
2373
+ }
2374
+ }
2375
+
2376
+ run();
2377
+ ```
2378
+
2379
+ ### Parameters
2380
+
2381
+ | Parameter | Type | Required | Description |
2382
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2383
+ | `request` | [operations.EvalsRagasCorrectnessRequestBody](../../models/operations/evalsragascorrectnessrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2384
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2385
+ | `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. |
2386
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2387
+
2388
+ ### Response
2389
+
2390
+ **Promise\<[operations.EvalsRagasCorrectnessResponseBody](../../models/operations/evalsragascorrectnessresponsebody.md)\>**
2391
+
2392
+ ### Errors
2393
+
2394
+ | Error Type | Status Code | Content Type |
2395
+ | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
2396
+ | errors.EvalsRagasCorrectnessResponseBody | 404 | application/json |
2397
+ | errors.EvalsRagasCorrectnessEvalsResponseBody | 500 | application/json |
2398
+ | errors.APIError | 4XX, 5XX | \*/\* |
2399
+
2400
+ ## ragasFaithfulness
2401
+
2402
+ Run Faithfulness Evaluator
2403
+
2404
+ ### Example Usage
2405
+
2406
+ ```typescript
2407
+ import { Orq } from "@orq-ai/node";
2408
+
2409
+ const orq = new Orq({
2410
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2411
+ });
2412
+
2413
+ async function run() {
2414
+ const result = await orq.evals.ragasFaithfulness();
2415
+
2416
+ console.log(result);
2417
+ }
2418
+
2419
+ run();
2420
+ ```
2421
+
2422
+ ### Standalone function
2423
+
2424
+ The standalone function version of this method:
2425
+
2426
+ ```typescript
2427
+ import { OrqCore } from "@orq-ai/node/core.js";
2428
+ import { evalsRagasFaithfulness } from "@orq-ai/node/funcs/evalsRagasFaithfulness.js";
2429
+
2430
+ // Use `OrqCore` for best tree-shaking performance.
2431
+ // You can create one instance of it to use across an application.
2432
+ const orq = new OrqCore({
2433
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2434
+ });
2435
+
2436
+ async function run() {
2437
+ const res = await evalsRagasFaithfulness(orq);
2438
+ if (res.ok) {
2439
+ const { value: result } = res;
2440
+ console.log(result);
2441
+ } else {
2442
+ console.log("evalsRagasFaithfulness failed:", res.error);
2443
+ }
2444
+ }
2445
+
2446
+ run();
2447
+ ```
2448
+
2449
+ ### Parameters
2450
+
2451
+ | Parameter | Type | Required | Description |
2452
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2453
+ | `request` | [operations.EvalsRagasFaithfulnessRequestBody](../../models/operations/evalsragasfaithfulnessrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2454
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2455
+ | `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. |
2456
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2457
+
2458
+ ### Response
2459
+
2460
+ **Promise\<[operations.EvalsRagasFaithfulnessResponseBody](../../models/operations/evalsragasfaithfulnessresponsebody.md)\>**
2461
+
2462
+ ### Errors
2463
+
2464
+ | Error Type | Status Code | Content Type |
2465
+ | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
2466
+ | errors.EvalsRagasFaithfulnessResponseBody | 404 | application/json |
2467
+ | errors.EvalsRagasFaithfulnessEvalsResponseBody | 500 | application/json |
2468
+ | errors.APIError | 4XX, 5XX | \*/\* |
2469
+
2470
+ ## ragasHarmfulness
2471
+
2472
+ Run Harmfulness Evaluator
2473
+
2474
+ ### Example Usage
2475
+
2476
+ ```typescript
2477
+ import { Orq } from "@orq-ai/node";
2478
+
2479
+ const orq = new Orq({
2480
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2481
+ });
2482
+
2483
+ async function run() {
2484
+ const result = await orq.evals.ragasHarmfulness();
2485
+
2486
+ console.log(result);
2487
+ }
2488
+
2489
+ run();
2490
+ ```
2491
+
2492
+ ### Standalone function
2493
+
2494
+ The standalone function version of this method:
2495
+
2496
+ ```typescript
2497
+ import { OrqCore } from "@orq-ai/node/core.js";
2498
+ import { evalsRagasHarmfulness } from "@orq-ai/node/funcs/evalsRagasHarmfulness.js";
2499
+
2500
+ // Use `OrqCore` for best tree-shaking performance.
2501
+ // You can create one instance of it to use across an application.
2502
+ const orq = new OrqCore({
2503
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2504
+ });
2505
+
2506
+ async function run() {
2507
+ const res = await evalsRagasHarmfulness(orq);
2508
+ if (res.ok) {
2509
+ const { value: result } = res;
2510
+ console.log(result);
2511
+ } else {
2512
+ console.log("evalsRagasHarmfulness failed:", res.error);
2513
+ }
2514
+ }
2515
+
2516
+ run();
2517
+ ```
2518
+
2519
+ ### Parameters
2520
+
2521
+ | Parameter | Type | Required | Description |
2522
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2523
+ | `request` | [operations.EvalsRagasHarmfulnessRequestBody](../../models/operations/evalsragasharmfulnessrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2524
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2525
+ | `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. |
2526
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2527
+
2528
+ ### Response
2529
+
2530
+ **Promise\<[operations.EvalsRagasHarmfulnessResponseBody](../../models/operations/evalsragasharmfulnessresponsebody.md)\>**
2531
+
2532
+ ### Errors
2533
+
2534
+ | Error Type | Status Code | Content Type |
2535
+ | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
2536
+ | errors.EvalsRagasHarmfulnessResponseBody | 404 | application/json |
2537
+ | errors.EvalsRagasHarmfulnessEvalsResponseBody | 500 | application/json |
2538
+ | errors.APIError | 4XX, 5XX | \*/\* |
2539
+
2540
+ ## ragasMaliciousness
2541
+
2542
+ Run Maliciousness Evaluator
2543
+
2544
+ ### Example Usage
2545
+
2546
+ ```typescript
2547
+ import { Orq } from "@orq-ai/node";
2548
+
2549
+ const orq = new Orq({
2550
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2551
+ });
2552
+
2553
+ async function run() {
2554
+ const result = await orq.evals.ragasMaliciousness();
2555
+
2556
+ console.log(result);
2557
+ }
2558
+
2559
+ run();
2560
+ ```
2561
+
2562
+ ### Standalone function
2563
+
2564
+ The standalone function version of this method:
2565
+
2566
+ ```typescript
2567
+ import { OrqCore } from "@orq-ai/node/core.js";
2568
+ import { evalsRagasMaliciousness } from "@orq-ai/node/funcs/evalsRagasMaliciousness.js";
2569
+
2570
+ // Use `OrqCore` for best tree-shaking performance.
2571
+ // You can create one instance of it to use across an application.
2572
+ const orq = new OrqCore({
2573
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2574
+ });
2575
+
2576
+ async function run() {
2577
+ const res = await evalsRagasMaliciousness(orq);
2578
+ if (res.ok) {
2579
+ const { value: result } = res;
2580
+ console.log(result);
2581
+ } else {
2582
+ console.log("evalsRagasMaliciousness failed:", res.error);
2583
+ }
2584
+ }
2585
+
2586
+ run();
2587
+ ```
2588
+
2589
+ ### Parameters
2590
+
2591
+ | Parameter | Type | Required | Description |
2592
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2593
+ | `request` | [operations.EvalsRagasMaliciousnessRequestBody](../../models/operations/evalsragasmaliciousnessrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2594
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2595
+ | `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. |
2596
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2597
+
2598
+ ### Response
2599
+
2600
+ **Promise\<[operations.EvalsRagasMaliciousnessResponseBody](../../models/operations/evalsragasmaliciousnessresponsebody.md)\>**
2601
+
2602
+ ### Errors
2603
+
2604
+ | Error Type | Status Code | Content Type |
2605
+ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
2606
+ | errors.EvalsRagasMaliciousnessResponseBody | 404 | application/json |
2607
+ | errors.EvalsRagasMaliciousnessEvalsResponseBody | 500 | application/json |
2608
+ | errors.APIError | 4XX, 5XX | \*/\* |
2609
+
2610
+ ## ragasResponseRelevancy
2611
+
2612
+ Run Response Relevancy Evaluator
2613
+
2614
+ ### Example Usage
2615
+
2616
+ ```typescript
2617
+ import { Orq } from "@orq-ai/node";
2618
+
2619
+ const orq = new Orq({
2620
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2621
+ });
2622
+
2623
+ async function run() {
2624
+ const result = await orq.evals.ragasResponseRelevancy();
2625
+
2626
+ console.log(result);
2627
+ }
2628
+
2629
+ run();
2630
+ ```
2631
+
2632
+ ### Standalone function
2633
+
2634
+ The standalone function version of this method:
2635
+
2636
+ ```typescript
2637
+ import { OrqCore } from "@orq-ai/node/core.js";
2638
+ import { evalsRagasResponseRelevancy } from "@orq-ai/node/funcs/evalsRagasResponseRelevancy.js";
2639
+
2640
+ // Use `OrqCore` for best tree-shaking performance.
2641
+ // You can create one instance of it to use across an application.
2642
+ const orq = new OrqCore({
2643
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2644
+ });
2645
+
2646
+ async function run() {
2647
+ const res = await evalsRagasResponseRelevancy(orq);
2648
+ if (res.ok) {
2649
+ const { value: result } = res;
2650
+ console.log(result);
2651
+ } else {
2652
+ console.log("evalsRagasResponseRelevancy failed:", res.error);
2653
+ }
2654
+ }
2655
+
2656
+ run();
2657
+ ```
2658
+
2659
+ ### Parameters
2660
+
2661
+ | Parameter | Type | Required | Description |
2662
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2663
+ | `request` | [operations.EvalsRagasResponseRelevancyRequestBody](../../models/operations/evalsragasresponserelevancyrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2664
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2665
+ | `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. |
2666
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2667
+
2668
+ ### Response
2669
+
2670
+ **Promise\<[operations.EvalsRagasResponseRelevancyResponseBody](../../models/operations/evalsragasresponserelevancyresponsebody.md)\>**
2671
+
2672
+ ### Errors
2673
+
2674
+ | Error Type | Status Code | Content Type |
2675
+ | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
2676
+ | errors.EvalsRagasResponseRelevancyResponseBody | 404 | application/json |
2677
+ | errors.EvalsRagasResponseRelevancyEvalsResponseBody | 500 | application/json |
2678
+ | errors.APIError | 4XX, 5XX | \*/\* |
2679
+
2680
+ ## ragasSummarization
2681
+
2682
+ Run Summarization Evaluator
2683
+
2684
+ ### Example Usage
2685
+
2686
+ ```typescript
2687
+ import { Orq } from "@orq-ai/node";
2688
+
2689
+ const orq = new Orq({
2690
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2691
+ });
2692
+
2693
+ async function run() {
2694
+ const result = await orq.evals.ragasSummarization();
2695
+
2696
+ console.log(result);
2697
+ }
2698
+
2699
+ run();
2700
+ ```
2701
+
2702
+ ### Standalone function
2703
+
2704
+ The standalone function version of this method:
2705
+
2706
+ ```typescript
2707
+ import { OrqCore } from "@orq-ai/node/core.js";
2708
+ import { evalsRagasSummarization } from "@orq-ai/node/funcs/evalsRagasSummarization.js";
2709
+
2710
+ // Use `OrqCore` for best tree-shaking performance.
2711
+ // You can create one instance of it to use across an application.
2712
+ const orq = new OrqCore({
2713
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2714
+ });
2715
+
2716
+ async function run() {
2717
+ const res = await evalsRagasSummarization(orq);
2718
+ if (res.ok) {
2719
+ const { value: result } = res;
2720
+ console.log(result);
2721
+ } else {
2722
+ console.log("evalsRagasSummarization failed:", res.error);
2723
+ }
2724
+ }
2725
+
2726
+ run();
2727
+ ```
2728
+
2729
+ ### Parameters
2730
+
2731
+ | Parameter | Type | Required | Description |
2732
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2733
+ | `request` | [operations.EvalsRagasSummarizationRequestBody](../../models/operations/evalsragassummarizationrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2734
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2735
+ | `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. |
2736
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2737
+
2738
+ ### Response
2739
+
2740
+ **Promise\<[operations.EvalsRagasSummarizationResponseBody](../../models/operations/evalsragassummarizationresponsebody.md)\>**
2741
+
2742
+ ### Errors
2743
+
2744
+ | Error Type | Status Code | Content Type |
2745
+ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
2746
+ | errors.EvalsRagasSummarizationResponseBody | 404 | application/json |
2747
+ | errors.EvalsRagasSummarizationEvalsResponseBody | 500 | application/json |
2748
+ | errors.APIError | 4XX, 5XX | \*/\* |
2749
+
2750
+ ## invoke
2751
+
2752
+ Invoke a Custom Evaluator
2753
+
2754
+ ### Example Usage
2755
+
2756
+ ```typescript
2757
+ import { Orq } from "@orq-ai/node";
2758
+
2759
+ const orq = new Orq({
2760
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2761
+ });
2762
+
2763
+ async function run() {
2764
+ const result = await orq.evals.invoke({
2765
+ id: "<id>",
2766
+ });
2767
+
2768
+ console.log(result);
2769
+ }
2770
+
2771
+ run();
2772
+ ```
2773
+
2774
+ ### Standalone function
2775
+
2776
+ The standalone function version of this method:
2777
+
2778
+ ```typescript
2779
+ import { OrqCore } from "@orq-ai/node/core.js";
2780
+ import { evalsInvoke } from "@orq-ai/node/funcs/evalsInvoke.js";
2781
+
2782
+ // Use `OrqCore` for best tree-shaking performance.
2783
+ // You can create one instance of it to use across an application.
2784
+ const orq = new OrqCore({
2785
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2786
+ });
2787
+
2788
+ async function run() {
2789
+ const res = await evalsInvoke(orq, {
2790
+ id: "<id>",
2791
+ });
2792
+ if (res.ok) {
2793
+ const { value: result } = res;
2794
+ console.log(result);
2795
+ } else {
2796
+ console.log("evalsInvoke failed:", res.error);
2797
+ }
2798
+ }
2799
+
2800
+ run();
2801
+ ```
2802
+
2803
+ ### Parameters
2804
+
2805
+ | Parameter | Type | Required | Description |
2806
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2807
+ | `request` | [operations.InvokeEvalRequest](../../models/operations/invokeevalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2808
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2809
+ | `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. |
2810
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2811
+
2812
+ ### Response
2813
+
2814
+ **Promise\<[operations.InvokeEvalResponseBody](../../models/operations/invokeevalresponsebody.md)\>**
2815
+
2816
+ ### Errors
2817
+
2818
+ | Error Type | Status Code | Content Type |
2819
+ | ---------------------------------- | ---------------------------------- | ---------------------------------- |
2820
+ | errors.InvokeEvalResponseBody | 404 | application/json |
2821
+ | errors.InvokeEvalEvalsResponseBody | 500 | application/json |
2822
+ | errors.APIError | 4XX, 5XX | \*/\* |