@orq-ai/node 3.9.4 → 3.10.0-rc.2

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