@orq-ai/node 3.14.4 → 3.14.5

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