@orq-ai/node 3.14.3 → 3.14.5-rc.1

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