@orq-ai/node 3.12.9 → 3.13.0-rc.10

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