@orq-ai/node 3.6.3 → 3.6.5

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