scorecard-ai 0.5.4 → 0.6.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 (403) hide show
  1. package/Client.d.ts +9 -3
  2. package/Client.js +8 -3
  3. package/README.md +9 -9
  4. package/api/resources/index.d.ts +3 -1
  5. package/api/resources/index.js +4 -2
  6. package/api/resources/prompt/client/Client.d.ts +49 -25
  7. package/api/resources/prompt/client/Client.js +194 -72
  8. package/api/resources/prompt/client/requests/PromptCreateParams.d.ts +8 -2
  9. package/api/resources/prompt/client/requests/PromptGetByNameRequest.d.ts +19 -0
  10. package/api/resources/prompt/client/requests/PromptListPromptsRequest.d.ts +21 -0
  11. package/api/resources/prompt/client/requests/index.d.ts +2 -0
  12. package/api/resources/run/client/Client.d.ts +6 -3
  13. package/api/resources/run/client/Client.js +26 -23
  14. package/api/resources/runMetric/client/Client.d.ts +4 -1
  15. package/api/resources/runMetric/client/Client.js +8 -7
  16. package/api/resources/score/client/Client.d.ts +5 -2
  17. package/api/resources/score/client/Client.js +18 -16
  18. package/api/resources/scoringConfig/client/Client.d.ts +78 -0
  19. package/api/resources/scoringConfig/client/Client.js +336 -0
  20. package/api/resources/scoringConfig/client/index.d.ts +1 -0
  21. package/api/resources/scoringConfig/client/index.js +17 -0
  22. package/api/resources/scoringConfig/client/requests/ScoringConfigCreateParams.d.ts +18 -0
  23. package/api/resources/scoringConfig/client/requests/ScoringConfigCreateParams.js +5 -0
  24. package/api/resources/scoringConfig/client/requests/index.d.ts +1 -0
  25. package/api/resources/testcase/client/Client.d.ts +55 -3
  26. package/api/resources/testcase/client/Client.js +308 -22
  27. package/api/resources/testcase/client/requests/TestcaseBatchCopyParams.d.ts +11 -0
  28. package/api/resources/testcase/client/requests/TestcaseBatchCopyParams.js +5 -0
  29. package/api/resources/testcase/client/requests/TestcaseBatchDeleteParams.d.ts +11 -0
  30. package/api/resources/testcase/client/requests/TestcaseBatchDeleteParams.js +5 -0
  31. package/api/resources/testcase/client/requests/TestcaseUpdateParams.d.ts +18 -0
  32. package/api/resources/testcase/client/requests/TestcaseUpdateParams.js +5 -0
  33. package/api/resources/testcase/client/requests/index.d.ts +3 -0
  34. package/api/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.d.ts +5 -0
  35. package/api/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.js +5 -0
  36. package/api/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.d.ts +5 -0
  37. package/api/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.js +5 -0
  38. package/api/resources/testcase/types/index.d.ts +2 -0
  39. package/api/resources/testcase/types/index.js +2 -0
  40. package/api/resources/testrecord/client/Client.d.ts +5 -2
  41. package/api/resources/testrecord/client/Client.js +17 -15
  42. package/api/resources/testrecord/client/requests/TestrecordCreateParams.d.ts +2 -0
  43. package/api/resources/testset/client/Client.d.ts +27 -8
  44. package/api/resources/testset/client/Client.js +148 -40
  45. package/api/resources/testset/client/requests/TestsetCreateParams.d.ts +8 -0
  46. package/api/resources/testset/client/requests/TestsetGetRequest.d.ts +11 -0
  47. package/api/resources/testset/client/requests/TestsetGetRequest.js +5 -0
  48. package/api/resources/testset/client/requests/TestsetUpdateParams.d.ts +16 -0
  49. package/api/resources/testset/client/requests/TestsetUpdateParams.js +5 -0
  50. package/api/resources/testset/client/requests/index.d.ts +2 -0
  51. package/api/resources/tracing/client/Client.d.ts +72 -0
  52. package/api/resources/tracing/client/Client.js +327 -0
  53. package/api/types/IngestionMethod.d.ts +8 -0
  54. package/api/types/IngestionMethod.js +10 -0
  55. package/api/types/Prompt.d.ts +2 -0
  56. package/api/types/PromptCursorPage.d.ts +17 -0
  57. package/api/types/PromptCursorPage.js +5 -0
  58. package/api/types/ScoringConfig.d.ts +18 -0
  59. package/api/types/ScoringConfig.js +5 -0
  60. package/api/types/TestcaseBatchDeletionResponse.d.ts +9 -0
  61. package/api/types/TestcaseBatchDeletionResponse.js +5 -0
  62. package/api/types/Testrecord.d.ts +2 -0
  63. package/api/types/Testset.d.ts +2 -0
  64. package/api/types/TestsetCursorPage.d.ts +17 -0
  65. package/api/types/TestsetCursorPage.js +5 -0
  66. package/api/types/Trace.d.ts +2 -0
  67. package/api/types/index.d.ts +8 -4
  68. package/api/types/index.js +8 -4
  69. package/core/fetcher/Fetcher.d.ts +4 -1
  70. package/core/fetcher/Fetcher.js +19 -176
  71. package/core/fetcher/createRequestUrl.d.ts +1 -0
  72. package/core/fetcher/createRequestUrl.js +13 -0
  73. package/core/fetcher/getFetchFn.d.ts +4 -0
  74. package/core/fetcher/getFetchFn.js +59 -0
  75. package/core/fetcher/getRequestBody.d.ts +7 -0
  76. package/core/fetcher/getRequestBody.js +23 -0
  77. package/core/fetcher/getResponseBody.d.ts +1 -0
  78. package/core/fetcher/getResponseBody.js +52 -0
  79. package/core/fetcher/makeRequest.d.ts +1 -0
  80. package/core/fetcher/makeRequest.js +42 -0
  81. package/core/fetcher/requestWithRetries.d.ts +1 -0
  82. package/core/fetcher/requestWithRetries.js +32 -0
  83. package/core/fetcher/signals.d.ts +12 -0
  84. package/core/fetcher/signals.js +37 -0
  85. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +31 -0
  86. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +245 -0
  87. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +22 -0
  88. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +124 -0
  89. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  90. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +227 -0
  91. package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  92. package/{serialization/resources/traces/client/get.js → core/fetcher/stream-wrappers/chooseStreamWrapper.js} +16 -6
  93. package/core/runtime/runtime.d.ts +2 -1
  94. package/core/runtime/runtime.js +12 -1
  95. package/core/schemas/Schema.d.ts +7 -4
  96. package/core/schemas/builders/lazy/lazy.d.ts +2 -2
  97. package/core/schemas/builders/lazy/lazy.js +8 -19
  98. package/core/schemas/builders/lazy/lazyObject.js +1 -10
  99. package/core/schemas/builders/list/list.js +31 -44
  100. package/core/schemas/builders/object/object.js +90 -111
  101. package/core/schemas/builders/object/types.d.ts +2 -2
  102. package/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  103. package/core/schemas/builders/record/record.js +49 -60
  104. package/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  105. package/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  106. package/core/schemas/builders/set/set.js +6 -15
  107. package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  108. package/core/schemas/builders/union/union.js +51 -62
  109. package/core/schemas/utils/maybeSkipValidation.js +3 -12
  110. package/dist/Client.d.ts +9 -3
  111. package/dist/Client.js +8 -3
  112. package/dist/api/resources/index.d.ts +3 -1
  113. package/dist/api/resources/index.js +4 -2
  114. package/dist/api/resources/prompt/client/Client.d.ts +49 -25
  115. package/dist/api/resources/prompt/client/Client.js +194 -72
  116. package/dist/api/resources/prompt/client/requests/PromptCreateParams.d.ts +8 -2
  117. package/dist/api/resources/prompt/client/requests/PromptGetByNameRequest.d.ts +19 -0
  118. package/dist/api/resources/prompt/client/requests/PromptGetByNameRequest.js +5 -0
  119. package/dist/api/resources/prompt/client/requests/PromptListPromptsRequest.d.ts +21 -0
  120. package/dist/api/resources/prompt/client/requests/PromptListPromptsRequest.js +5 -0
  121. package/dist/api/resources/prompt/client/requests/index.d.ts +2 -0
  122. package/dist/api/resources/run/client/Client.d.ts +6 -3
  123. package/dist/api/resources/run/client/Client.js +26 -23
  124. package/dist/api/resources/runMetric/client/Client.d.ts +4 -1
  125. package/dist/api/resources/runMetric/client/Client.js +8 -7
  126. package/dist/api/resources/score/client/Client.d.ts +5 -2
  127. package/dist/api/resources/score/client/Client.js +18 -16
  128. package/dist/api/resources/scoringConfig/client/Client.d.ts +78 -0
  129. package/dist/api/resources/scoringConfig/client/Client.js +336 -0
  130. package/dist/api/resources/scoringConfig/client/index.d.ts +1 -0
  131. package/dist/api/resources/scoringConfig/client/index.js +17 -0
  132. package/dist/api/resources/scoringConfig/client/requests/ScoringConfigCreateParams.d.ts +18 -0
  133. package/dist/api/resources/scoringConfig/client/requests/ScoringConfigCreateParams.js +5 -0
  134. package/dist/api/resources/scoringConfig/client/requests/index.d.ts +1 -0
  135. package/dist/api/resources/scoringConfig/client/requests/index.js +2 -0
  136. package/dist/api/resources/testcase/client/Client.d.ts +55 -3
  137. package/dist/api/resources/testcase/client/Client.js +308 -22
  138. package/dist/api/resources/testcase/client/requests/TestcaseBatchCopyParams.d.ts +11 -0
  139. package/dist/api/resources/testcase/client/requests/TestcaseBatchCopyParams.js +5 -0
  140. package/dist/api/resources/testcase/client/requests/TestcaseBatchDeleteParams.d.ts +11 -0
  141. package/dist/api/resources/testcase/client/requests/TestcaseBatchDeleteParams.js +5 -0
  142. package/dist/api/resources/testcase/client/requests/TestcaseUpdateParams.d.ts +18 -0
  143. package/dist/api/resources/testcase/client/requests/TestcaseUpdateParams.js +5 -0
  144. package/dist/api/resources/testcase/client/requests/index.d.ts +3 -0
  145. package/dist/api/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.d.ts +5 -0
  146. package/dist/api/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.js +5 -0
  147. package/dist/api/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.d.ts +5 -0
  148. package/dist/api/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.js +5 -0
  149. package/dist/api/resources/testcase/types/index.d.ts +2 -0
  150. package/dist/api/resources/testcase/types/index.js +2 -0
  151. package/dist/api/resources/testrecord/client/Client.d.ts +5 -2
  152. package/dist/api/resources/testrecord/client/Client.js +17 -15
  153. package/dist/api/resources/testrecord/client/requests/TestrecordCreateParams.d.ts +2 -0
  154. package/dist/api/resources/testset/client/Client.d.ts +27 -8
  155. package/dist/api/resources/testset/client/Client.js +148 -40
  156. package/dist/api/resources/testset/client/requests/TestsetCreateParams.d.ts +8 -0
  157. package/dist/api/resources/testset/client/requests/TestsetGetRequest.d.ts +11 -0
  158. package/dist/api/resources/testset/client/requests/TestsetGetRequest.js +5 -0
  159. package/dist/api/resources/testset/client/requests/TestsetUpdateParams.d.ts +16 -0
  160. package/dist/api/resources/testset/client/requests/TestsetUpdateParams.js +5 -0
  161. package/dist/api/resources/testset/client/requests/index.d.ts +2 -0
  162. package/dist/api/resources/tracing/client/Client.d.ts +72 -0
  163. package/dist/api/resources/tracing/client/Client.js +327 -0
  164. package/dist/api/resources/tracing/client/index.js +2 -0
  165. package/dist/api/types/IngestionMethod.d.ts +8 -0
  166. package/dist/api/types/IngestionMethod.js +10 -0
  167. package/dist/api/types/Prompt.d.ts +2 -0
  168. package/dist/api/types/PromptCursorPage.d.ts +17 -0
  169. package/dist/api/types/PromptCursorPage.js +5 -0
  170. package/dist/api/types/ScoringConfig.d.ts +18 -0
  171. package/dist/api/types/ScoringConfig.js +5 -0
  172. package/dist/api/types/TestcaseBatchDeletionResponse.d.ts +9 -0
  173. package/dist/api/types/TestcaseBatchDeletionResponse.js +5 -0
  174. package/dist/api/types/Testrecord.d.ts +2 -0
  175. package/dist/api/types/Testset.d.ts +2 -0
  176. package/dist/api/types/TestsetCursorPage.d.ts +17 -0
  177. package/dist/api/types/TestsetCursorPage.js +5 -0
  178. package/dist/api/types/Trace.d.ts +2 -0
  179. package/dist/api/types/index.d.ts +8 -4
  180. package/dist/api/types/index.js +8 -4
  181. package/dist/core/fetcher/Fetcher.d.ts +4 -1
  182. package/dist/core/fetcher/Fetcher.js +19 -176
  183. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  184. package/dist/core/fetcher/createRequestUrl.js +13 -0
  185. package/dist/core/fetcher/getFetchFn.d.ts +4 -0
  186. package/dist/core/fetcher/getFetchFn.js +59 -0
  187. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  188. package/dist/core/fetcher/getRequestBody.js +23 -0
  189. package/dist/core/fetcher/getResponseBody.d.ts +1 -0
  190. package/dist/core/fetcher/getResponseBody.js +52 -0
  191. package/dist/core/fetcher/makeRequest.d.ts +1 -0
  192. package/dist/core/fetcher/makeRequest.js +42 -0
  193. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  194. package/dist/core/fetcher/requestWithRetries.js +32 -0
  195. package/dist/core/fetcher/signals.d.ts +12 -0
  196. package/dist/core/fetcher/signals.js +37 -0
  197. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +31 -0
  198. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +245 -0
  199. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +22 -0
  200. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +124 -0
  201. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  202. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +227 -0
  203. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  204. package/dist/{serialization/resources/traces/client/get.js → core/fetcher/stream-wrappers/chooseStreamWrapper.js} +16 -6
  205. package/dist/core/runtime/runtime.d.ts +2 -1
  206. package/dist/core/runtime/runtime.js +12 -1
  207. package/dist/core/schemas/Schema.d.ts +7 -4
  208. package/dist/core/schemas/builders/lazy/lazy.d.ts +2 -2
  209. package/dist/core/schemas/builders/lazy/lazy.js +8 -19
  210. package/dist/core/schemas/builders/lazy/lazyObject.js +1 -10
  211. package/dist/core/schemas/builders/list/list.js +31 -44
  212. package/dist/core/schemas/builders/object/object.js +90 -111
  213. package/dist/core/schemas/builders/object/types.d.ts +2 -2
  214. package/dist/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  215. package/dist/core/schemas/builders/record/record.js +49 -60
  216. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  217. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  218. package/dist/core/schemas/builders/set/set.js +6 -15
  219. package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  220. package/dist/core/schemas/builders/union/union.js +51 -62
  221. package/dist/core/schemas/utils/maybeSkipValidation.js +3 -12
  222. package/dist/serialization/resources/index.d.ts +3 -1
  223. package/dist/serialization/resources/index.js +4 -2
  224. package/dist/serialization/resources/prompt/client/requests/PromptCreateParams.d.ts +2 -0
  225. package/dist/serialization/resources/prompt/client/requests/PromptCreateParams.js +2 -0
  226. package/dist/serialization/resources/scoringConfig/client/index.d.ts +1 -0
  227. package/dist/serialization/resources/scoringConfig/client/index.js +17 -0
  228. package/dist/serialization/resources/scoringConfig/client/requests/ScoringConfigCreateParams.d.ts +15 -0
  229. package/dist/serialization/resources/scoringConfig/client/requests/ScoringConfigCreateParams.js +36 -0
  230. package/dist/serialization/resources/scoringConfig/client/requests/index.d.ts +1 -0
  231. package/dist/serialization/resources/scoringConfig/client/requests/index.js +5 -0
  232. package/dist/serialization/resources/scoringConfig/index.d.ts +1 -0
  233. package/dist/serialization/resources/scoringConfig/index.js +17 -0
  234. package/dist/serialization/resources/testcase/client/batchCopy.d.ts +11 -0
  235. package/dist/serialization/resources/testcase/client/batchCopy.js +32 -0
  236. package/dist/serialization/resources/testcase/client/index.d.ts +1 -0
  237. package/dist/serialization/resources/testcase/client/index.js +14 -0
  238. package/dist/serialization/resources/testcase/client/requests/TestcaseBatchCopyParams.d.ts +12 -0
  239. package/dist/serialization/resources/testcase/client/requests/TestcaseBatchCopyParams.js +33 -0
  240. package/dist/serialization/resources/testcase/client/requests/TestcaseBatchDeleteParams.d.ts +12 -0
  241. package/dist/serialization/resources/testcase/client/requests/TestcaseBatchDeleteParams.js +33 -0
  242. package/dist/serialization/resources/testcase/client/requests/TestcaseUpdateParams.d.ts +18 -0
  243. package/dist/serialization/resources/testcase/client/requests/TestcaseUpdateParams.js +43 -0
  244. package/dist/serialization/resources/testcase/client/requests/index.d.ts +3 -0
  245. package/dist/serialization/resources/testcase/client/requests/index.js +7 -1
  246. package/dist/serialization/resources/testcase/types/TestcaseCreateParamsCustomInputsValue.js +2 -10
  247. package/dist/serialization/resources/testcase/types/TestcaseCreateParamsCustomLabelsValue.js +2 -10
  248. package/dist/serialization/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.d.ts +11 -0
  249. package/dist/serialization/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.js +40 -0
  250. package/dist/serialization/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.d.ts +11 -0
  251. package/dist/serialization/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.js +40 -0
  252. package/dist/serialization/resources/testcase/types/index.d.ts +2 -0
  253. package/dist/serialization/resources/testcase/types/index.js +2 -0
  254. package/dist/serialization/resources/testrecord/client/requests/TestrecordCreateParams.d.ts +1 -0
  255. package/dist/serialization/resources/testrecord/client/requests/TestrecordCreateParams.js +1 -0
  256. package/dist/serialization/resources/testrecord/types/TestrecordCreateParamsCustomInputsValue.js +2 -10
  257. package/dist/serialization/resources/testrecord/types/TestrecordCreateParamsCustomLabelsValue.js +2 -10
  258. package/dist/serialization/resources/testrecord/types/TestrecordCreateParamsCustomOutputsValue.js +2 -10
  259. package/dist/serialization/resources/testset/client/requests/TestsetCreateParams.d.ts +5 -0
  260. package/dist/serialization/resources/testset/client/requests/TestsetCreateParams.js +5 -0
  261. package/dist/serialization/resources/testset/client/requests/TestsetUpdateParams.d.ts +16 -0
  262. package/dist/serialization/resources/testset/client/requests/TestsetUpdateParams.js +37 -0
  263. package/dist/serialization/resources/testset/client/requests/index.d.ts +1 -0
  264. package/dist/serialization/resources/testset/client/requests/index.js +3 -1
  265. package/dist/serialization/resources/tracing/client/index.d.ts +1 -0
  266. package/{serialization/resources/traces → dist/serialization/resources/tracing}/client/index.js +2 -2
  267. package/dist/serialization/resources/{traces/client/get.d.ts → tracing/client/traces.d.ts} +3 -2
  268. package/dist/serialization/resources/tracing/client/traces.js +32 -0
  269. package/dist/serialization/resources/tracing/index.d.ts +1 -0
  270. package/dist/serialization/resources/tracing/index.js +17 -0
  271. package/dist/serialization/types/IngestionMethod.d.ts +10 -0
  272. package/dist/serialization/types/IngestionMethod.js +31 -0
  273. package/dist/serialization/types/JsonObject.js +2 -10
  274. package/dist/serialization/types/JsonObjectInputValue.js +3 -11
  275. package/dist/serialization/types/JsonObjectOutputValue.js +3 -11
  276. package/dist/serialization/types/Prompt.d.ts +1 -0
  277. package/dist/serialization/types/Prompt.js +1 -0
  278. package/dist/serialization/types/PromptCursorPage.d.ts +18 -0
  279. package/dist/serialization/types/PromptCursorPage.js +39 -0
  280. package/dist/serialization/types/ScoringConfig.d.ts +21 -0
  281. package/dist/serialization/types/ScoringConfig.js +42 -0
  282. package/dist/serialization/types/Span.js +2 -10
  283. package/dist/serialization/types/TestCaseCustomInputsValue.js +2 -10
  284. package/dist/serialization/types/TestCaseCustomLabelsValue.js +2 -10
  285. package/dist/serialization/types/TestcaseBatchDeletionResponse.d.ts +13 -0
  286. package/dist/serialization/types/{TestCaseCreate.js → TestcaseBatchDeletionResponse.js} +4 -7
  287. package/dist/serialization/types/Testrecord.d.ts +1 -0
  288. package/dist/serialization/types/Testrecord.js +1 -0
  289. package/dist/serialization/types/TestrecordCustomInputsValue.js +2 -10
  290. package/dist/serialization/types/TestrecordCustomLabelsValue.js +2 -10
  291. package/dist/serialization/types/TestrecordCustomOutputsValue.js +2 -10
  292. package/dist/serialization/types/Testset.d.ts +1 -0
  293. package/dist/serialization/types/Testset.js +1 -0
  294. package/dist/serialization/types/TestsetCursorPage.d.ts +18 -0
  295. package/dist/serialization/types/TestsetCursorPage.js +39 -0
  296. package/dist/serialization/types/Trace.d.ts +1 -0
  297. package/dist/serialization/types/Trace.js +2 -0
  298. package/dist/serialization/types/index.d.ts +8 -4
  299. package/dist/serialization/types/index.js +8 -4
  300. package/package.json +8 -2
  301. package/reference.md +840 -623
  302. package/serialization/resources/index.d.ts +3 -1
  303. package/serialization/resources/index.js +4 -2
  304. package/serialization/resources/prompt/client/requests/PromptCreateParams.d.ts +2 -0
  305. package/serialization/resources/prompt/client/requests/PromptCreateParams.js +2 -0
  306. package/serialization/resources/scoringConfig/client/index.d.ts +1 -0
  307. package/serialization/resources/scoringConfig/client/index.js +17 -0
  308. package/serialization/resources/scoringConfig/client/requests/ScoringConfigCreateParams.d.ts +15 -0
  309. package/serialization/resources/scoringConfig/client/requests/ScoringConfigCreateParams.js +36 -0
  310. package/serialization/resources/scoringConfig/client/requests/index.d.ts +1 -0
  311. package/serialization/resources/scoringConfig/client/requests/index.js +5 -0
  312. package/serialization/resources/scoringConfig/index.d.ts +1 -0
  313. package/serialization/resources/scoringConfig/index.js +17 -0
  314. package/serialization/resources/testcase/client/batchCopy.d.ts +11 -0
  315. package/serialization/resources/testcase/client/batchCopy.js +32 -0
  316. package/serialization/resources/testcase/client/index.d.ts +1 -0
  317. package/serialization/resources/testcase/client/index.js +14 -0
  318. package/serialization/resources/testcase/client/requests/TestcaseBatchCopyParams.d.ts +12 -0
  319. package/serialization/resources/testcase/client/requests/TestcaseBatchCopyParams.js +33 -0
  320. package/serialization/resources/testcase/client/requests/TestcaseBatchDeleteParams.d.ts +12 -0
  321. package/serialization/resources/testcase/client/requests/TestcaseBatchDeleteParams.js +33 -0
  322. package/serialization/resources/testcase/client/requests/TestcaseUpdateParams.d.ts +18 -0
  323. package/serialization/resources/testcase/client/requests/TestcaseUpdateParams.js +43 -0
  324. package/serialization/resources/testcase/client/requests/index.d.ts +3 -0
  325. package/serialization/resources/testcase/client/requests/index.js +7 -1
  326. package/serialization/resources/testcase/types/TestcaseCreateParamsCustomInputsValue.js +2 -10
  327. package/serialization/resources/testcase/types/TestcaseCreateParamsCustomLabelsValue.js +2 -10
  328. package/serialization/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.d.ts +11 -0
  329. package/serialization/resources/testcase/types/TestcaseUpdateParamsCustomInputsValue.js +40 -0
  330. package/serialization/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.d.ts +11 -0
  331. package/serialization/resources/testcase/types/TestcaseUpdateParamsCustomLabelsValue.js +40 -0
  332. package/serialization/resources/testcase/types/index.d.ts +2 -0
  333. package/serialization/resources/testcase/types/index.js +2 -0
  334. package/serialization/resources/testrecord/client/requests/TestrecordCreateParams.d.ts +1 -0
  335. package/serialization/resources/testrecord/client/requests/TestrecordCreateParams.js +1 -0
  336. package/serialization/resources/testrecord/types/TestrecordCreateParamsCustomInputsValue.js +2 -10
  337. package/serialization/resources/testrecord/types/TestrecordCreateParamsCustomLabelsValue.js +2 -10
  338. package/serialization/resources/testrecord/types/TestrecordCreateParamsCustomOutputsValue.js +2 -10
  339. package/serialization/resources/testset/client/requests/TestsetCreateParams.d.ts +5 -0
  340. package/serialization/resources/testset/client/requests/TestsetCreateParams.js +5 -0
  341. package/serialization/resources/testset/client/requests/TestsetUpdateParams.d.ts +16 -0
  342. package/serialization/resources/testset/client/requests/TestsetUpdateParams.js +37 -0
  343. package/serialization/resources/testset/client/requests/index.d.ts +1 -0
  344. package/serialization/resources/testset/client/requests/index.js +3 -1
  345. package/serialization/resources/tracing/client/index.d.ts +1 -0
  346. package/{dist/serialization/resources/traces → serialization/resources/tracing}/client/index.js +2 -2
  347. package/serialization/resources/{traces/client/get.d.ts → tracing/client/traces.d.ts} +3 -2
  348. package/serialization/resources/tracing/client/traces.js +32 -0
  349. package/serialization/resources/tracing/index.d.ts +1 -0
  350. package/serialization/resources/tracing/index.js +17 -0
  351. package/serialization/types/IngestionMethod.d.ts +10 -0
  352. package/serialization/types/IngestionMethod.js +31 -0
  353. package/serialization/types/JsonObject.js +2 -10
  354. package/serialization/types/JsonObjectInputValue.js +3 -11
  355. package/serialization/types/JsonObjectOutputValue.js +3 -11
  356. package/serialization/types/Prompt.d.ts +1 -0
  357. package/serialization/types/Prompt.js +1 -0
  358. package/serialization/types/PromptCursorPage.d.ts +18 -0
  359. package/serialization/types/PromptCursorPage.js +39 -0
  360. package/serialization/types/ScoringConfig.d.ts +21 -0
  361. package/serialization/types/ScoringConfig.js +42 -0
  362. package/serialization/types/Span.js +2 -10
  363. package/serialization/types/TestCaseCustomInputsValue.js +2 -10
  364. package/serialization/types/TestCaseCustomLabelsValue.js +2 -10
  365. package/serialization/types/TestcaseBatchDeletionResponse.d.ts +13 -0
  366. package/serialization/types/{TestCaseCreate.js → TestcaseBatchDeletionResponse.js} +4 -7
  367. package/serialization/types/Testrecord.d.ts +1 -0
  368. package/serialization/types/Testrecord.js +1 -0
  369. package/serialization/types/TestrecordCustomInputsValue.js +2 -10
  370. package/serialization/types/TestrecordCustomLabelsValue.js +2 -10
  371. package/serialization/types/TestrecordCustomOutputsValue.js +2 -10
  372. package/serialization/types/Testset.d.ts +1 -0
  373. package/serialization/types/Testset.js +1 -0
  374. package/serialization/types/TestsetCursorPage.d.ts +18 -0
  375. package/serialization/types/TestsetCursorPage.js +39 -0
  376. package/serialization/types/Trace.d.ts +1 -0
  377. package/serialization/types/Trace.js +2 -0
  378. package/serialization/types/index.d.ts +8 -4
  379. package/serialization/types/index.js +8 -4
  380. package/api/resources/traces/client/Client.d.ts +0 -40
  381. package/api/resources/traces/client/Client.js +0 -151
  382. package/api/types/TestCaseCreate.d.ts +0 -10
  383. package/dist/api/resources/traces/client/Client.d.ts +0 -40
  384. package/dist/api/resources/traces/client/Client.js +0 -151
  385. package/dist/api/types/TestCaseCreate.d.ts +0 -10
  386. package/dist/serialization/resources/traces/client/index.d.ts +0 -1
  387. package/dist/serialization/types/TestCaseCreate.d.ts +0 -16
  388. package/serialization/resources/traces/client/index.d.ts +0 -1
  389. package/serialization/types/TestCaseCreate.d.ts +0 -16
  390. /package/api/{types/TestCaseCreate.js → resources/prompt/client/requests/PromptGetByNameRequest.js} +0 -0
  391. /package/{dist/api/types/TestCaseCreate.js → api/resources/prompt/client/requests/PromptListPromptsRequest.js} +0 -0
  392. /package/api/resources/{traces/client → scoringConfig/client/requests}/index.js +0 -0
  393. /package/api/resources/{traces → scoringConfig}/index.d.ts +0 -0
  394. /package/api/resources/{traces → scoringConfig}/index.js +0 -0
  395. /package/api/resources/{traces → tracing}/client/index.d.ts +0 -0
  396. /package/{dist/api/resources/traces → api/resources/tracing}/client/index.js +0 -0
  397. /package/{dist/api/resources/traces → api/resources/tracing}/index.d.ts +0 -0
  398. /package/{dist/api/resources/traces → api/resources/tracing}/index.js +0 -0
  399. /package/dist/{serialization/resources/traces → api/resources/scoringConfig}/index.d.ts +0 -0
  400. /package/dist/{serialization/resources/traces → api/resources/scoringConfig}/index.js +0 -0
  401. /package/dist/api/resources/{traces → tracing}/client/index.d.ts +0 -0
  402. /package/{serialization/resources/traces → dist/api/resources/tracing}/index.d.ts +0 -0
  403. /package/{serialization/resources/traces → dist/api/resources/tracing}/index.js +0 -0
package/reference.md CHANGED
@@ -1,1994 +1,2211 @@
1
- ## Testset
1
+ # Reference
2
2
 
3
- <details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">get</a>(testsetId) -> Scorecard.Testset</code> </summary>
3
+ ## Testset
4
4
 
5
+ <details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">get</a>({ ...params }) -> Scorecard.TestsetCursorPage</code></summary>
5
6
  <dl>
6
-
7
7
  <dd>
8
8
 
9
9
  #### 📝 Description
10
10
 
11
11
  <dl>
12
-
13
12
  <dd>
14
13
 
15
14
  <dl>
16
-
17
15
  <dd>
18
16
 
19
- Retrieve Testset metadata without Testcase data
17
+ Retrieve all Testsets with cursor-based pagination
20
18
 
21
19
  </dd>
22
-
23
20
  </dl>
24
-
25
21
  </dd>
26
-
27
22
  </dl>
28
23
 
29
24
  #### 🔌 Usage
30
25
 
31
26
  <dl>
32
-
33
27
  <dd>
34
28
 
35
29
  <dl>
36
-
37
30
  <dd>
38
31
 
39
- ```ts
40
- await scorecard.testset.get(1);
32
+ ```typescript
33
+ await client.testset.get();
41
34
  ```
42
35
 
43
36
  </dd>
44
-
45
37
  </dl>
46
-
47
38
  </dd>
48
-
49
39
  </dl>
50
40
 
51
41
  #### ⚙️ Parameters
52
42
 
53
43
  <dl>
54
-
55
44
  <dd>
56
45
 
57
46
  <dl>
58
-
59
47
  <dd>
60
48
 
61
- **testsetId: `number`** — The ID of the Testset to retrieve.
49
+ **request:** `Scorecard.TestsetGetRequest`
62
50
 
63
51
  </dd>
64
-
65
52
  </dl>
66
53
 
67
54
  <dl>
68
-
69
55
  <dd>
70
56
 
71
- **requestOptions: `Testset.RequestOptions`**
57
+ **requestOptions:** `Testset.RequestOptions`
72
58
 
73
59
  </dd>
74
-
75
60
  </dl>
76
-
77
61
  </dd>
78
-
79
62
  </dl>
80
63
 
81
64
  </dd>
82
-
83
65
  </dl>
84
66
  </details>
85
67
 
86
- <details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">delete</a>(testsetId) -> Scorecard.Testset</code> </summary>
87
-
68
+ <details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">delete</a>(testsetId) -> Scorecard.Testset</code></summary>
88
69
  <dl>
89
-
90
70
  <dd>
91
71
 
92
72
  #### 📝 Description
93
73
 
94
74
  <dl>
95
-
96
75
  <dd>
97
76
 
98
77
  <dl>
99
-
100
78
  <dd>
101
79
 
102
80
  Delete a Testset
103
81
 
104
82
  </dd>
105
-
106
83
  </dl>
107
-
108
84
  </dd>
109
-
110
85
  </dl>
111
86
 
112
87
  #### 🔌 Usage
113
88
 
114
89
  <dl>
115
-
116
90
  <dd>
117
91
 
118
92
  <dl>
119
-
120
93
  <dd>
121
94
 
122
- ```ts
123
- await scorecard.testset.delete(1);
95
+ ```typescript
96
+ await client.testset.delete(1);
124
97
  ```
125
98
 
126
99
  </dd>
127
-
128
100
  </dl>
129
-
130
101
  </dd>
131
-
132
102
  </dl>
133
103
 
134
104
  #### ⚙️ Parameters
135
105
 
136
106
  <dl>
137
-
138
107
  <dd>
139
108
 
140
109
  <dl>
141
-
142
110
  <dd>
143
111
 
144
- **testsetId: `number`** — The ID of the Testset to delete.
112
+ **testsetId:** `number` — The ID of the Testset to delete.
145
113
 
146
114
  </dd>
147
-
148
115
  </dl>
149
116
 
150
117
  <dl>
151
-
152
118
  <dd>
153
119
 
154
- **requestOptions: `Testset.RequestOptions`**
120
+ **requestOptions:** `Testset.RequestOptions`
155
121
 
156
122
  </dd>
157
-
158
123
  </dl>
159
-
160
124
  </dd>
161
-
162
125
  </dl>
163
126
 
164
127
  </dd>
165
-
166
128
  </dl>
167
129
  </details>
168
130
 
169
- <details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">create</a>({ ...params }) -> Scorecard.Testset</code> </summary>
170
-
131
+ <details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">update</a>(testsetId, { ...params }) -> Scorecard.Testset</code></summary>
171
132
  <dl>
172
-
173
133
  <dd>
174
134
 
175
135
  #### 📝 Description
176
136
 
177
137
  <dl>
178
-
179
138
  <dd>
180
139
 
181
140
  <dl>
182
-
183
141
  <dd>
184
142
 
185
- Create a new Testset
143
+ Update a Testset.
186
144
 
187
145
  </dd>
188
-
189
146
  </dl>
190
-
191
147
  </dd>
192
-
193
148
  </dl>
194
149
 
195
150
  #### 🔌 Usage
196
151
 
197
152
  <dl>
198
-
199
153
  <dd>
200
154
 
201
155
  <dl>
202
-
203
156
  <dd>
204
157
 
205
- ```ts
206
- await scorecard.testset.create({
207
- name: "name",
208
- });
158
+ ```typescript
159
+ await client.testset.update(1);
209
160
  ```
210
161
 
211
162
  </dd>
212
-
213
163
  </dl>
214
-
215
164
  </dd>
216
-
217
165
  </dl>
218
166
 
219
167
  #### ⚙️ Parameters
220
168
 
221
169
  <dl>
222
-
223
170
  <dd>
224
171
 
225
172
  <dl>
226
-
227
173
  <dd>
228
174
 
229
- **request: `Scorecard.TestsetCreateParams`**
175
+ **testsetId:** `number` — The ID of the Testset to update.
230
176
 
231
177
  </dd>
232
-
233
178
  </dl>
234
179
 
235
180
  <dl>
236
-
237
181
  <dd>
238
182
 
239
- **requestOptions: `Testset.RequestOptions`**
183
+ **request:** `Scorecard.TestsetUpdateParams`
240
184
 
241
185
  </dd>
242
-
243
186
  </dl>
244
187
 
245
- </dd>
188
+ <dl>
189
+ <dd>
246
190
 
247
- </dl>
191
+ **requestOptions:** `Testset.RequestOptions`
248
192
 
249
193
  </dd>
194
+ </dl>
195
+ </dd>
196
+ </dl>
250
197
 
198
+ </dd>
251
199
  </dl>
252
200
  </details>
253
201
 
254
- <details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">readSchema</a>(testsetId) -> Scorecard.CustomSchema</code> </summary>
255
-
202
+ <details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">create</a>({ ...params }) -> Scorecard.Testset</code></summary>
256
203
  <dl>
257
-
258
204
  <dd>
259
205
 
260
206
  #### 📝 Description
261
207
 
262
208
  <dl>
263
-
264
209
  <dd>
265
210
 
266
211
  <dl>
267
-
268
212
  <dd>
269
213
 
270
- Read the schema of a Testset
214
+ Create a new Testset
271
215
 
272
216
  </dd>
273
-
274
217
  </dl>
275
-
276
218
  </dd>
277
-
278
219
  </dl>
279
220
 
280
221
  #### 🔌 Usage
281
222
 
282
223
  <dl>
283
-
284
224
  <dd>
285
225
 
286
226
  <dl>
287
-
288
227
  <dd>
289
228
 
290
- ```ts
291
- await scorecard.testset.readSchema(1);
229
+ ```typescript
230
+ await client.testset.create({
231
+ name: "name",
232
+ });
292
233
  ```
293
234
 
294
235
  </dd>
295
-
296
236
  </dl>
297
-
298
237
  </dd>
299
-
300
238
  </dl>
301
239
 
302
240
  #### ⚙️ Parameters
303
241
 
304
242
  <dl>
305
-
306
243
  <dd>
307
244
 
308
245
  <dl>
309
-
310
246
  <dd>
311
247
 
312
- **testsetId: `number`** — The ID of the Testset to retrieve the schema from.
248
+ **request:** `Scorecard.TestsetCreateParams`
313
249
 
314
250
  </dd>
315
-
316
251
  </dl>
317
252
 
318
253
  <dl>
319
-
320
254
  <dd>
321
255
 
322
- **requestOptions: `Testset.RequestOptions`**
256
+ **requestOptions:** `Testset.RequestOptions`
323
257
 
324
258
  </dd>
325
-
326
259
  </dl>
327
-
328
260
  </dd>
329
-
330
261
  </dl>
331
262
 
332
263
  </dd>
333
-
334
264
  </dl>
335
265
  </details>
336
266
 
337
- <details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">getTestcases</a>(testsetId, { ...params }) -> Scorecard.PaginatedTestcaseResponse</code> </summary>
338
-
267
+ <details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">readSchema</a>(testsetId) -> Scorecard.CustomSchema</code></summary>
339
268
  <dl>
340
-
341
269
  <dd>
342
270
 
343
271
  #### 📝 Description
344
272
 
345
273
  <dl>
346
-
347
274
  <dd>
348
275
 
349
276
  <dl>
350
-
351
277
  <dd>
352
278
 
353
- Retrieve all Testcases from a Testset
279
+ Read the schema of a Testset
354
280
 
355
281
  </dd>
356
-
357
282
  </dl>
358
-
359
283
  </dd>
360
-
361
284
  </dl>
362
285
 
363
286
  #### 🔌 Usage
364
287
 
365
288
  <dl>
366
-
367
289
  <dd>
368
290
 
369
291
  <dl>
370
-
371
292
  <dd>
372
293
 
373
- ```ts
374
- await scorecard.testset.getTestcases(1);
294
+ ```typescript
295
+ await client.testset.readSchema(1);
375
296
  ```
376
297
 
377
298
  </dd>
378
-
379
299
  </dl>
380
-
381
300
  </dd>
382
-
383
301
  </dl>
384
302
 
385
303
  #### ⚙️ Parameters
386
304
 
387
305
  <dl>
388
-
389
- <dd>
390
-
391
- <dl>
392
-
393
306
  <dd>
394
307
 
395
- **testsetId: `number`** — The Testset ID to retrieve testcases from.
396
-
397
- </dd>
398
-
399
- </dl>
400
-
401
308
  <dl>
402
-
403
309
  <dd>
404
310
 
405
- **request: `Scorecard.TestsetGetTestcasesRequest`**
311
+ **testsetId:** `number` — The ID of the Testset to retrieve the schema from.
406
312
 
407
313
  </dd>
408
-
409
314
  </dl>
410
315
 
411
316
  <dl>
412
-
413
317
  <dd>
414
318
 
415
- **requestOptions: `Testset.RequestOptions`**
319
+ **requestOptions:** `Testset.RequestOptions`
416
320
 
417
321
  </dd>
418
-
419
322
  </dl>
420
-
421
323
  </dd>
422
-
423
324
  </dl>
424
325
 
425
326
  </dd>
426
-
427
327
  </dl>
428
328
  </details>
429
329
 
430
- ## Testcase
431
-
432
- <details><summary> <code>scorecard.testcase.<a href="./src/api/resources/testcase/client/Client.ts">create</a>(testsetId, { ...params }) -> Scorecard.TestCase</code> </summary>
433
-
330
+ <details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">getTestcases</a>(testsetId, { ...params }) -> Scorecard.PaginatedTestcaseResponse</code></summary>
434
331
  <dl>
435
-
436
332
  <dd>
437
333
 
438
334
  #### 📝 Description
439
335
 
440
336
  <dl>
441
-
442
337
  <dd>
443
338
 
444
339
  <dl>
445
-
446
340
  <dd>
447
341
 
448
- Create a new Testcase
342
+ Retrieve all Testcases from a Testset
449
343
 
450
344
  </dd>
451
-
452
345
  </dl>
453
-
454
346
  </dd>
455
-
456
347
  </dl>
457
348
 
458
349
  #### 🔌 Usage
459
350
 
460
351
  <dl>
461
-
462
352
  <dd>
463
353
 
464
354
  <dl>
465
-
466
355
  <dd>
467
356
 
468
- ```ts
469
- await scorecard.testcase.create(1);
357
+ ```typescript
358
+ await client.testset.getTestcases(1);
470
359
  ```
471
360
 
472
361
  </dd>
473
-
474
362
  </dl>
475
-
476
363
  </dd>
477
-
478
364
  </dl>
479
365
 
480
366
  #### ⚙️ Parameters
481
367
 
482
368
  <dl>
483
-
484
369
  <dd>
485
370
 
486
371
  <dl>
487
-
488
372
  <dd>
489
373
 
490
- **testsetId: `number`** — The ID of the Testset to create the Testcase in.
374
+ **testsetId:** `number` — The Testset ID to retrieve testcases from.
491
375
 
492
376
  </dd>
493
-
494
377
  </dl>
495
378
 
496
379
  <dl>
497
-
498
380
  <dd>
499
381
 
500
- **request: `Scorecard.TestcaseCreateParams`**
382
+ **request:** `Scorecard.TestsetGetTestcasesRequest`
501
383
 
502
384
  </dd>
503
-
504
385
  </dl>
505
386
 
506
387
  <dl>
507
-
508
388
  <dd>
509
389
 
510
- **requestOptions: `Testcase.RequestOptions`**
390
+ **requestOptions:** `Testset.RequestOptions`
511
391
 
512
392
  </dd>
513
-
514
393
  </dl>
515
-
516
394
  </dd>
517
-
518
395
  </dl>
519
396
 
520
397
  </dd>
521
-
522
398
  </dl>
523
399
  </details>
524
400
 
525
- <details><summary> <code>scorecard.testcase.<a href="./src/api/resources/testcase/client/Client.ts">get</a>(testcaseId, testsetId) -> Scorecard.TestCase</code> </summary>
401
+ ## Testcase
526
402
 
403
+ <details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">create</a>(testsetId, { ...params }) -> Scorecard.TestCase</code></summary>
527
404
  <dl>
528
-
529
405
  <dd>
530
406
 
531
407
  #### 📝 Description
532
408
 
533
409
  <dl>
534
-
535
410
  <dd>
536
411
 
537
412
  <dl>
538
-
539
413
  <dd>
540
414
 
541
- Retrieve Testcase data
415
+ Create a new Testcase
542
416
 
543
417
  </dd>
544
-
545
418
  </dl>
546
-
547
419
  </dd>
548
-
549
420
  </dl>
550
421
 
551
422
  #### 🔌 Usage
552
423
 
553
424
  <dl>
554
-
555
425
  <dd>
556
426
 
557
427
  <dl>
558
-
559
428
  <dd>
560
429
 
561
- ```ts
562
- await scorecard.testcase.get(1, 1);
430
+ ```typescript
431
+ await client.testcase.create(1);
563
432
  ```
564
433
 
565
434
  </dd>
566
-
567
435
  </dl>
568
-
569
436
  </dd>
570
-
571
437
  </dl>
572
438
 
573
439
  #### ⚙️ Parameters
574
440
 
575
441
  <dl>
576
-
577
442
  <dd>
578
443
 
579
444
  <dl>
580
-
581
445
  <dd>
582
446
 
583
- **testcaseId: `number`** — The ID of the Testcase to retrieve.
447
+ **testsetId:** `number` — The ID of the Testset to create the Testcase in.
584
448
 
585
449
  </dd>
586
-
587
450
  </dl>
588
451
 
589
452
  <dl>
590
-
591
453
  <dd>
592
454
 
593
- **testsetId: `number`** — The ID of the Testset to retrieve the Testcase from.
455
+ **request:** `Scorecard.TestcaseCreateParams`
594
456
 
595
457
  </dd>
596
-
597
458
  </dl>
598
459
 
599
460
  <dl>
600
-
601
461
  <dd>
602
462
 
603
- **requestOptions: `Testcase.RequestOptions`**
463
+ **requestOptions:** `Testcase.RequestOptions`
604
464
 
605
465
  </dd>
606
-
607
466
  </dl>
608
-
609
467
  </dd>
610
-
611
468
  </dl>
612
469
 
613
470
  </dd>
614
-
615
471
  </dl>
616
472
  </details>
617
473
 
618
- <details><summary> <code>scorecard.testcase.<a href="./src/api/resources/testcase/client/Client.ts">delete</a>(testcaseId, testsetId) -> Scorecard.TestcaseDeletionResponse</code> </summary>
619
-
474
+ <details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">get</a>(testcaseId, testsetId) -> Scorecard.TestCase</code></summary>
620
475
  <dl>
621
-
622
476
  <dd>
623
477
 
624
478
  #### 📝 Description
625
479
 
626
480
  <dl>
627
-
628
481
  <dd>
629
482
 
630
483
  <dl>
631
-
632
484
  <dd>
633
485
 
634
- Delete a Testcase
486
+ Retrieve Testcase data
635
487
 
636
488
  </dd>
637
-
638
489
  </dl>
639
-
640
490
  </dd>
641
-
642
491
  </dl>
643
492
 
644
493
  #### 🔌 Usage
645
494
 
646
495
  <dl>
647
-
648
496
  <dd>
649
497
 
650
498
  <dl>
651
-
652
499
  <dd>
653
500
 
654
- ```ts
655
- await scorecard.testcase.delete(1, 1);
501
+ ```typescript
502
+ await client.testcase.get(1, 1);
656
503
  ```
657
504
 
658
505
  </dd>
659
-
660
506
  </dl>
661
-
662
507
  </dd>
663
-
664
508
  </dl>
665
509
 
666
510
  #### ⚙️ Parameters
667
511
 
668
512
  <dl>
669
-
670
513
  <dd>
671
514
 
672
515
  <dl>
673
-
674
516
  <dd>
675
517
 
676
- **testcaseId: `number`** — The ID of the Testcase to delete.
518
+ **testcaseId:** `number` — The ID of the Testcase to retrieve.
677
519
 
678
520
  </dd>
679
-
680
521
  </dl>
681
522
 
682
523
  <dl>
683
-
684
524
  <dd>
685
525
 
686
- **testsetId: `number`** — The ID of the Testset to delete the Testcase from.
526
+ **testsetId:** `number` — The ID of the Testset to retrieve the Testcase from.
687
527
 
688
528
  </dd>
689
-
690
529
  </dl>
691
530
 
692
531
  <dl>
693
-
694
532
  <dd>
695
533
 
696
- **requestOptions: `Testcase.RequestOptions`**
534
+ **requestOptions:** `Testcase.RequestOptions`
697
535
 
698
536
  </dd>
699
-
700
537
  </dl>
701
-
702
538
  </dd>
703
-
704
539
  </dl>
705
540
 
706
541
  </dd>
707
-
708
542
  </dl>
709
543
  </details>
710
544
 
711
- ## Testrecord
712
-
713
- <details><summary> <code>scorecard.testrecord.<a href="./src/api/resources/testrecord/client/Client.ts">get</a>(testrecordId, runId) -> Scorecard.Testrecord</code> </summary>
714
-
545
+ <details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">delete</a>(testcaseId, testsetId) -> Scorecard.TestcaseDeletionResponse</code></summary>
715
546
  <dl>
716
-
717
547
  <dd>
718
548
 
719
549
  #### 📝 Description
720
550
 
721
551
  <dl>
722
-
723
552
  <dd>
724
553
 
725
554
  <dl>
726
-
727
555
  <dd>
728
556
 
729
- Retrieve Testrecord metadata
557
+ Delete a Testcase
730
558
 
731
559
  </dd>
732
-
733
560
  </dl>
734
-
735
561
  </dd>
736
-
737
562
  </dl>
738
563
 
739
564
  #### 🔌 Usage
740
565
 
741
566
  <dl>
742
-
743
567
  <dd>
744
568
 
745
569
  <dl>
746
-
747
570
  <dd>
748
571
 
749
- ```ts
750
- await scorecard.testrecord.get(1, 1);
572
+ ```typescript
573
+ await client.testcase.delete(1, 1);
751
574
  ```
752
575
 
753
576
  </dd>
754
-
755
577
  </dl>
756
-
757
578
  </dd>
758
-
759
579
  </dl>
760
580
 
761
581
  #### ⚙️ Parameters
762
582
 
763
583
  <dl>
764
-
765
584
  <dd>
766
585
 
767
586
  <dl>
768
-
769
587
  <dd>
770
588
 
771
- **testrecordId: `number`**
589
+ **testcaseId:** `number` — The ID of the Testcase to delete.
772
590
 
773
591
  </dd>
774
-
775
592
  </dl>
776
593
 
777
594
  <dl>
778
-
779
595
  <dd>
780
596
 
781
- **runId: `number`**
597
+ **testsetId:** `number` — The ID of the Testset to delete the Testcase from.
782
598
 
783
599
  </dd>
784
-
785
600
  </dl>
786
601
 
787
602
  <dl>
788
-
789
603
  <dd>
790
604
 
791
- **requestOptions: `Testrecord.RequestOptions`**
605
+ **requestOptions:** `Testcase.RequestOptions`
792
606
 
793
607
  </dd>
794
-
795
608
  </dl>
796
-
797
609
  </dd>
798
-
799
610
  </dl>
800
611
 
801
612
  </dd>
802
-
803
613
  </dl>
804
614
  </details>
805
615
 
806
- <details><summary> <code>scorecard.testrecord.<a href="./src/api/resources/testrecord/client/Client.ts">create</a>(runId, { ...params }) -> Scorecard.Testrecord</code> </summary>
807
-
616
+ <details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">update</a>(testcaseId, testsetId, { ...params }) -> Scorecard.TestCase</code></summary>
808
617
  <dl>
809
-
810
618
  <dd>
811
619
 
812
620
  #### 📝 Description
813
621
 
814
622
  <dl>
815
-
816
623
  <dd>
817
624
 
818
625
  <dl>
819
-
820
626
  <dd>
821
627
 
822
- Create a new Testrecord
628
+ Update a Testcase.
823
629
 
824
630
  </dd>
825
-
826
631
  </dl>
827
-
828
632
  </dd>
829
-
830
633
  </dl>
831
634
 
832
635
  #### 🔌 Usage
833
636
 
834
637
  <dl>
835
-
836
638
  <dd>
837
639
 
838
640
  <dl>
839
-
840
641
  <dd>
841
642
 
842
- ```ts
843
- await scorecard.testrecord.create(1);
643
+ ```typescript
644
+ await client.testcase.update(1, 1);
844
645
  ```
845
646
 
846
647
  </dd>
847
-
848
648
  </dl>
849
-
850
649
  </dd>
851
-
852
650
  </dl>
853
651
 
854
652
  #### ⚙️ Parameters
855
653
 
856
654
  <dl>
857
-
858
655
  <dd>
859
656
 
860
657
  <dl>
861
-
862
658
  <dd>
863
659
 
864
- **runId: `number`** — The ID of the Run to create the Testrecord in.
660
+ **testcaseId:** `number` — The ID of the Testcase to update.
865
661
 
866
662
  </dd>
867
-
868
663
  </dl>
869
664
 
870
665
  <dl>
871
-
872
666
  <dd>
873
667
 
874
- **request: `Scorecard.TestrecordCreateParams`**
668
+ **testsetId:** `number` — The ID of the Testset to retrieve the Testcase from.
875
669
 
876
670
  </dd>
877
-
878
671
  </dl>
879
672
 
880
673
  <dl>
881
-
882
674
  <dd>
883
675
 
884
- **requestOptions: `Testrecord.RequestOptions`**
676
+ **request:** `Scorecard.TestcaseUpdateParams`
885
677
 
886
678
  </dd>
887
-
888
679
  </dl>
889
680
 
890
- </dd>
681
+ <dl>
682
+ <dd>
891
683
 
892
- </dl>
684
+ **requestOptions:** `Testcase.RequestOptions`
893
685
 
894
686
  </dd>
687
+ </dl>
688
+ </dd>
689
+ </dl>
895
690
 
691
+ </dd>
896
692
  </dl>
897
693
  </details>
898
694
 
899
- ## Run
900
-
901
- <details><summary> <code>scorecard.run.<a href="./src/api/resources/run/client/Client.ts">create</a>({ ...params }) -> Scorecard.Run</code> </summary>
902
-
695
+ <details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">batchCopy</a>(testsetId, { ...params }) -> Scorecard.TestCase[]</code></summary>
903
696
  <dl>
904
-
905
697
  <dd>
906
698
 
907
699
  #### 📝 Description
908
700
 
909
701
  <dl>
702
+ <dd>
703
+
704
+ <dl>
705
+ <dd>
706
+
707
+ Batch copy Testcases
708
+
709
+ </dd>
710
+ </dl>
711
+ </dd>
712
+ </dl>
713
+
714
+ #### 🔌 Usage
715
+
716
+ <dl>
717
+ <dd>
718
+
719
+ <dl>
720
+ <dd>
721
+
722
+ ```typescript
723
+ await client.testcase.batchCopy(1);
724
+ ```
725
+
726
+ </dd>
727
+ </dl>
728
+ </dd>
729
+ </dl>
730
+
731
+ #### ⚙️ Parameters
732
+
733
+ <dl>
734
+ <dd>
735
+
736
+ <dl>
737
+ <dd>
738
+
739
+ **testsetId:** `number` — The ID of the Testset to create the Testcase in.
740
+
741
+ </dd>
742
+ </dl>
743
+
744
+ <dl>
745
+ <dd>
746
+
747
+ **request:** `Scorecard.TestcaseBatchCopyParams`
748
+
749
+ </dd>
750
+ </dl>
751
+
752
+ <dl>
753
+ <dd>
754
+
755
+ **requestOptions:** `Testcase.RequestOptions`
756
+
757
+ </dd>
758
+ </dl>
759
+ </dd>
760
+ </dl>
761
+
762
+ </dd>
763
+ </dl>
764
+ </details>
765
+
766
+ <details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">batchDelete</a>(testsetId, { ...params }) -> Scorecard.TestcaseBatchDeletionResponse</code></summary>
767
+ <dl>
768
+ <dd>
769
+
770
+ #### 📝 Description
771
+
772
+ <dl>
773
+ <dd>
774
+
775
+ <dl>
776
+ <dd>
777
+
778
+ Batch delete Testcases
779
+
780
+ </dd>
781
+ </dl>
782
+ </dd>
783
+ </dl>
784
+
785
+ #### 🔌 Usage
786
+
787
+ <dl>
788
+ <dd>
789
+
790
+ <dl>
791
+ <dd>
792
+
793
+ ```typescript
794
+ await client.testcase.batchDelete(1);
795
+ ```
796
+
797
+ </dd>
798
+ </dl>
799
+ </dd>
800
+ </dl>
801
+
802
+ #### ⚙️ Parameters
803
+
804
+ <dl>
805
+ <dd>
806
+
807
+ <dl>
808
+ <dd>
809
+
810
+ **testsetId:** `number` — The ID of the Testset from which the Testcases will be deleted.
811
+
812
+ </dd>
813
+ </dl>
814
+
815
+ <dl>
816
+ <dd>
817
+
818
+ **request:** `Scorecard.TestcaseBatchDeleteParams`
819
+
820
+ </dd>
821
+ </dl>
822
+
823
+ <dl>
824
+ <dd>
825
+
826
+ **requestOptions:** `Testcase.RequestOptions`
827
+
828
+ </dd>
829
+ </dl>
830
+ </dd>
831
+ </dl>
832
+
833
+ </dd>
834
+ </dl>
835
+ </details>
836
+
837
+ ## Testrecord
838
+
839
+ <details><summary><code>client.testrecord.<a href="/src/api/resources/testrecord/client/Client.ts">get</a>(testrecordId, runId) -> Scorecard.Testrecord</code></summary>
840
+ <dl>
841
+ <dd>
842
+
843
+ #### 📝 Description
844
+
845
+ <dl>
846
+ <dd>
847
+
848
+ <dl>
849
+ <dd>
850
+
851
+ Retrieve Testrecord metadata
852
+
853
+ </dd>
854
+ </dl>
855
+ </dd>
856
+ </dl>
857
+
858
+ #### 🔌 Usage
859
+
860
+ <dl>
861
+ <dd>
862
+
863
+ <dl>
864
+ <dd>
865
+
866
+ ```typescript
867
+ await client.testrecord.get(1, 1);
868
+ ```
869
+
870
+ </dd>
871
+ </dl>
872
+ </dd>
873
+ </dl>
874
+
875
+ #### ⚙️ Parameters
876
+
877
+ <dl>
878
+ <dd>
879
+
880
+ <dl>
881
+ <dd>
882
+
883
+ **testrecordId:** `number`
884
+
885
+ </dd>
886
+ </dl>
887
+
888
+ <dl>
889
+ <dd>
890
+
891
+ **runId:** `number`
892
+
893
+ </dd>
894
+ </dl>
895
+
896
+ <dl>
897
+ <dd>
898
+
899
+ **requestOptions:** `Testrecord.RequestOptions`
900
+
901
+ </dd>
902
+ </dl>
903
+ </dd>
904
+ </dl>
905
+
906
+ </dd>
907
+ </dl>
908
+ </details>
909
+
910
+ <details><summary><code>client.testrecord.<a href="/src/api/resources/testrecord/client/Client.ts">create</a>(runId, { ...params }) -> Scorecard.Testrecord</code></summary>
911
+ <dl>
912
+ <dd>
913
+
914
+ #### 📝 Description
915
+
916
+ <dl>
917
+ <dd>
918
+
919
+ <dl>
920
+ <dd>
921
+
922
+ Create a new Testrecord
923
+
924
+ </dd>
925
+ </dl>
926
+ </dd>
927
+ </dl>
928
+
929
+ #### 🔌 Usage
930
+
931
+ <dl>
932
+ <dd>
933
+
934
+ <dl>
935
+ <dd>
936
+
937
+ ```typescript
938
+ await client.testrecord.create(1);
939
+ ```
940
+
941
+ </dd>
942
+ </dl>
943
+ </dd>
944
+ </dl>
945
+
946
+ #### ⚙️ Parameters
947
+
948
+ <dl>
949
+ <dd>
950
+
951
+ <dl>
952
+ <dd>
953
+
954
+ **runId:** `number` — The ID of the Run to create the Testrecord in.
955
+
956
+ </dd>
957
+ </dl>
958
+
959
+ <dl>
960
+ <dd>
961
+
962
+ **request:** `Scorecard.TestrecordCreateParams`
963
+
964
+ </dd>
965
+ </dl>
966
+
967
+ <dl>
968
+ <dd>
969
+
970
+ **requestOptions:** `Testrecord.RequestOptions`
971
+
972
+ </dd>
973
+ </dl>
974
+ </dd>
975
+ </dl>
976
+
977
+ </dd>
978
+ </dl>
979
+ </details>
980
+
981
+ ## Run
982
+
983
+ <details><summary><code>client.run.<a href="/src/api/resources/run/client/Client.ts">create</a>({ ...params }) -> Scorecard.Run</code></summary>
984
+ <dl>
985
+ <dd>
986
+
987
+ #### 📝 Description
988
+
989
+ <dl>
990
+ <dd>
991
+
992
+ <dl>
993
+ <dd>
994
+
995
+ Create a new Run
996
+
997
+ </dd>
998
+ </dl>
999
+ </dd>
1000
+ </dl>
1001
+
1002
+ #### 🔌 Usage
1003
+
1004
+ <dl>
1005
+ <dd>
1006
+
1007
+ <dl>
1008
+ <dd>
1009
+
1010
+ ```typescript
1011
+ await client.run.create();
1012
+ ```
1013
+
1014
+ </dd>
1015
+ </dl>
1016
+ </dd>
1017
+ </dl>
1018
+
1019
+ #### ⚙️ Parameters
1020
+
1021
+ <dl>
1022
+ <dd>
1023
+
1024
+ <dl>
1025
+ <dd>
1026
+
1027
+ **request:** `Scorecard.RunCreateParams`
1028
+
1029
+ </dd>
1030
+ </dl>
1031
+
1032
+ <dl>
1033
+ <dd>
1034
+
1035
+ **requestOptions:** `Run.RequestOptions`
1036
+
1037
+ </dd>
1038
+ </dl>
1039
+ </dd>
1040
+ </dl>
1041
+
1042
+ </dd>
1043
+ </dl>
1044
+ </details>
1045
+
1046
+ <details><summary><code>client.run.<a href="/src/api/resources/run/client/Client.ts">get</a>(runId) -> Scorecard.Run</code></summary>
1047
+ <dl>
1048
+ <dd>
1049
+
1050
+ #### 📝 Description
1051
+
1052
+ <dl>
1053
+ <dd>
1054
+
1055
+ <dl>
1056
+ <dd>
1057
+
1058
+ Retrieve a Run metadata
1059
+
1060
+ </dd>
1061
+ </dl>
1062
+ </dd>
1063
+ </dl>
1064
+
1065
+ #### 🔌 Usage
1066
+
1067
+ <dl>
1068
+ <dd>
1069
+
1070
+ <dl>
1071
+ <dd>
1072
+
1073
+ ```typescript
1074
+ await client.run.get(1);
1075
+ ```
1076
+
1077
+ </dd>
1078
+ </dl>
1079
+ </dd>
1080
+ </dl>
1081
+
1082
+ #### ⚙️ Parameters
1083
+
1084
+ <dl>
1085
+ <dd>
1086
+
1087
+ <dl>
1088
+ <dd>
1089
+
1090
+ **runId:** `number` — The id of the run to retrieve.
1091
+
1092
+ </dd>
1093
+ </dl>
1094
+
1095
+ <dl>
1096
+ <dd>
1097
+
1098
+ **requestOptions:** `Run.RequestOptions`
910
1099
 
1100
+ </dd>
1101
+ </dl>
1102
+ </dd>
1103
+ </dl>
1104
+
1105
+ </dd>
1106
+ </dl>
1107
+ </details>
1108
+
1109
+ <details><summary><code>client.run.<a href="/src/api/resources/run/client/Client.ts">updateStatus</a>(runId, { ...params }) -> Scorecard.Run</code></summary>
1110
+ <dl>
911
1111
  <dd>
912
1112
 
1113
+ #### 📝 Description
1114
+
913
1115
  <dl>
1116
+ <dd>
914
1117
 
1118
+ <dl>
915
1119
  <dd>
916
1120
 
917
- Create a new Run
1121
+ Update the status of a run.
918
1122
 
919
1123
  </dd>
920
-
921
1124
  </dl>
922
-
923
1125
  </dd>
924
-
925
1126
  </dl>
926
1127
 
927
1128
  #### 🔌 Usage
928
1129
 
929
1130
  <dl>
930
-
931
1131
  <dd>
932
1132
 
933
1133
  <dl>
934
-
935
1134
  <dd>
936
1135
 
937
- ```ts
938
- await scorecard.run.create();
1136
+ ```typescript
1137
+ await client.run.updateStatus(1);
939
1138
  ```
940
1139
 
941
1140
  </dd>
942
-
943
1141
  </dl>
944
-
945
1142
  </dd>
946
-
947
1143
  </dl>
948
1144
 
949
1145
  #### ⚙️ Parameters
950
1146
 
951
1147
  <dl>
952
-
953
1148
  <dd>
954
1149
 
955
1150
  <dl>
956
-
957
1151
  <dd>
958
1152
 
959
- **request: `Scorecard.RunCreateParams`**
1153
+ **runId:** `number` — The id of the run to update.
960
1154
 
961
1155
  </dd>
962
-
963
1156
  </dl>
964
1157
 
965
1158
  <dl>
966
-
967
1159
  <dd>
968
1160
 
969
- **requestOptions: `Run.RequestOptions`**
1161
+ **request:** `Scorecard.UpdateStatusParams`
970
1162
 
971
1163
  </dd>
972
-
973
1164
  </dl>
974
1165
 
975
- </dd>
1166
+ <dl>
1167
+ <dd>
976
1168
 
977
- </dl>
1169
+ **requestOptions:** `Run.RequestOptions`
978
1170
 
979
1171
  </dd>
1172
+ </dl>
1173
+ </dd>
1174
+ </dl>
980
1175
 
1176
+ </dd>
981
1177
  </dl>
982
1178
  </details>
983
1179
 
984
- <details><summary> <code>scorecard.run.<a href="./src/api/resources/run/client/Client.ts">get</a>(runId) -> Scorecard.Run</code> </summary>
1180
+ ## Score
985
1181
 
1182
+ <details><summary><code>client.score.<a href="/src/api/resources/score/client/Client.ts">create</a>(runId, testrecordId, { ...params }) -> Scorecard.Grade</code></summary>
986
1183
  <dl>
987
-
988
1184
  <dd>
989
1185
 
990
1186
  #### 📝 Description
991
1187
 
992
1188
  <dl>
993
-
994
1189
  <dd>
995
1190
 
996
1191
  <dl>
997
-
998
1192
  <dd>
999
1193
 
1000
- Retrieve a Run metadata
1194
+ Create a score
1001
1195
 
1002
1196
  </dd>
1003
-
1004
1197
  </dl>
1005
-
1006
1198
  </dd>
1007
-
1008
1199
  </dl>
1009
1200
 
1010
1201
  #### 🔌 Usage
1011
1202
 
1012
1203
  <dl>
1013
-
1014
1204
  <dd>
1015
1205
 
1016
1206
  <dl>
1017
-
1018
1207
  <dd>
1019
1208
 
1020
- ```ts
1021
- await scorecard.run.get(1);
1209
+ ```typescript
1210
+ await client.score.create(1, 1, {
1211
+ metricId: 1,
1212
+ });
1022
1213
  ```
1023
1214
 
1024
1215
  </dd>
1025
-
1026
1216
  </dl>
1027
-
1028
1217
  </dd>
1029
-
1030
1218
  </dl>
1031
1219
 
1032
1220
  #### ⚙️ Parameters
1033
1221
 
1034
1222
  <dl>
1035
-
1036
1223
  <dd>
1037
1224
 
1038
1225
  <dl>
1039
-
1040
1226
  <dd>
1041
1227
 
1042
- **runId: `number`** — The id of the run to retrieve.
1228
+ **runId:** `number` — The ID of the run that created the testrecord to be scored.
1043
1229
 
1044
1230
  </dd>
1045
-
1046
1231
  </dl>
1047
1232
 
1048
1233
  <dl>
1049
-
1050
1234
  <dd>
1051
1235
 
1052
- **requestOptions: `Run.RequestOptions`**
1236
+ **testrecordId:** `number` — The ID of the testrecord to be scored.
1053
1237
 
1054
1238
  </dd>
1055
-
1056
1239
  </dl>
1057
1240
 
1058
- </dd>
1241
+ <dl>
1242
+ <dd>
1243
+
1244
+ **request:** `Scorecard.ScoreCreateParams`
1059
1245
 
1246
+ </dd>
1060
1247
  </dl>
1061
1248
 
1249
+ <dl>
1250
+ <dd>
1251
+
1252
+ **requestOptions:** `Score.RequestOptions`
1253
+
1254
+ </dd>
1255
+ </dl>
1062
1256
  </dd>
1257
+ </dl>
1063
1258
 
1259
+ </dd>
1064
1260
  </dl>
1065
1261
  </details>
1066
1262
 
1067
- <details><summary> <code>scorecard.run.<a href="./src/api/resources/run/client/Client.ts">updateStatus</a>(runId, { ...params }) -> Scorecard.Run</code> </summary>
1068
-
1263
+ <details><summary><code>client.score.<a href="/src/api/resources/score/client/Client.ts">update</a>(runId, testrecordId, scoreId, { ...params }) -> Scorecard.Grade</code></summary>
1069
1264
  <dl>
1070
-
1071
1265
  <dd>
1072
1266
 
1073
1267
  #### 📝 Description
1074
1268
 
1075
1269
  <dl>
1076
-
1077
1270
  <dd>
1078
1271
 
1079
1272
  <dl>
1080
-
1081
1273
  <dd>
1082
1274
 
1083
- Update the status of a run.
1275
+ Update a score
1084
1276
 
1085
1277
  </dd>
1086
-
1087
1278
  </dl>
1088
-
1089
1279
  </dd>
1090
-
1091
1280
  </dl>
1092
1281
 
1093
1282
  #### 🔌 Usage
1094
1283
 
1095
1284
  <dl>
1096
-
1097
1285
  <dd>
1098
1286
 
1099
1287
  <dl>
1100
-
1101
1288
  <dd>
1102
1289
 
1103
- ```ts
1104
- await scorecard.run.updateStatus(1);
1290
+ ```typescript
1291
+ await client.score.update(1, 1, 1);
1105
1292
  ```
1106
1293
 
1107
1294
  </dd>
1108
-
1109
1295
  </dl>
1110
-
1111
1296
  </dd>
1112
-
1113
1297
  </dl>
1114
1298
 
1115
1299
  #### ⚙️ Parameters
1116
1300
 
1117
1301
  <dl>
1118
-
1119
1302
  <dd>
1120
1303
 
1121
1304
  <dl>
1305
+ <dd>
1306
+
1307
+ **runId:** `number` — The run ID that created the test record to be scored.
1122
1308
 
1309
+ </dd>
1310
+ </dl>
1311
+
1312
+ <dl>
1123
1313
  <dd>
1124
1314
 
1125
- **runId: `number`** — The id of the run to update.
1315
+ **testrecordId:** `number` — The ID of the testrecord whose score will be updated.
1126
1316
 
1127
1317
  </dd>
1318
+ </dl>
1319
+
1320
+ <dl>
1321
+ <dd>
1128
1322
 
1323
+ **scoreId:** `number` — The ID of the score to be updated.
1324
+
1325
+ </dd>
1129
1326
  </dl>
1130
1327
 
1131
1328
  <dl>
1329
+ <dd>
1330
+
1331
+ **request:** `Scorecard.ScoreUpdateParams`
1132
1332
 
1333
+ </dd>
1334
+ </dl>
1335
+
1336
+ <dl>
1133
1337
  <dd>
1134
1338
 
1135
- **request: `Scorecard.UpdateStatusParams`**
1339
+ **requestOptions:** `Score.RequestOptions`
1136
1340
 
1137
1341
  </dd>
1342
+ </dl>
1343
+ </dd>
1344
+ </dl>
1138
1345
 
1346
+ </dd>
1139
1347
  </dl>
1348
+ </details>
1349
+
1350
+ ## RunMetric
1351
+
1352
+ <details><summary><code>client.runMetric.<a href="/src/api/resources/runMetric/client/Client.ts">get</a>(runId) -> Scorecard.RunMetric[]</code></summary>
1353
+ <dl>
1354
+ <dd>
1355
+
1356
+ #### 📝 Description
1140
1357
 
1141
1358
  <dl>
1359
+ <dd>
1142
1360
 
1361
+ <dl>
1143
1362
  <dd>
1144
1363
 
1145
- **requestOptions: `Run.RequestOptions`**
1364
+ Retrieve metrics associated with a run
1146
1365
 
1147
1366
  </dd>
1148
-
1149
1367
  </dl>
1368
+ </dd>
1369
+ </dl>
1370
+
1371
+ #### 🔌 Usage
1372
+
1373
+ <dl>
1374
+ <dd>
1375
+
1376
+ <dl>
1377
+ <dd>
1378
+
1379
+ ```typescript
1380
+ await client.runMetric.get(1);
1381
+ ```
1150
1382
 
1151
1383
  </dd>
1384
+ </dl>
1385
+ </dd>
1386
+ </dl>
1387
+
1388
+ #### ⚙️ Parameters
1389
+
1390
+ <dl>
1391
+ <dd>
1392
+
1393
+ <dl>
1394
+ <dd>
1395
+
1396
+ **runId:** `number` — The id of the run to retrieve.
1152
1397
 
1398
+ </dd>
1153
1399
  </dl>
1154
1400
 
1401
+ <dl>
1402
+ <dd>
1403
+
1404
+ **requestOptions:** `RunMetric.RequestOptions`
1405
+
1406
+ </dd>
1407
+ </dl>
1155
1408
  </dd>
1409
+ </dl>
1156
1410
 
1411
+ </dd>
1157
1412
  </dl>
1158
1413
  </details>
1159
1414
 
1160
- ## Score
1161
-
1162
- <details><summary> <code>scorecard.score.<a href="./src/api/resources/score/client/Client.ts">create</a>(runId, testrecordId, { ...params }) -> Scorecard.Grade</code> </summary>
1415
+ ## Tracing
1163
1416
 
1417
+ <details><summary><code>client.tracing.<a href="/src/api/resources/tracing/client/Client.ts">traces</a>() -> Scorecard.Trace[]</code></summary>
1164
1418
  <dl>
1165
-
1166
1419
  <dd>
1167
1420
 
1168
1421
  #### 📝 Description
1169
1422
 
1170
1423
  <dl>
1424
+ <dd>
1171
1425
 
1426
+ <dl>
1172
1427
  <dd>
1173
1428
 
1429
+ Retrieve traces
1430
+
1431
+ </dd>
1432
+ </dl>
1433
+ </dd>
1434
+ </dl>
1435
+
1436
+ #### 🔌 Usage
1437
+
1174
1438
  <dl>
1439
+ <dd>
1175
1440
 
1441
+ <dl>
1176
1442
  <dd>
1177
1443
 
1178
- Create a score
1444
+ ```typescript
1445
+ await client.tracing.traces();
1446
+ ```
1179
1447
 
1180
1448
  </dd>
1181
-
1182
1449
  </dl>
1450
+ </dd>
1451
+ </dl>
1452
+
1453
+ #### ⚙️ Parameters
1454
+
1455
+ <dl>
1456
+ <dd>
1457
+
1458
+ <dl>
1459
+ <dd>
1460
+
1461
+ **requestOptions:** `Tracing.RequestOptions`
1183
1462
 
1184
1463
  </dd>
1464
+ </dl>
1465
+ </dd>
1466
+ </dl>
1185
1467
 
1468
+ </dd>
1186
1469
  </dl>
1470
+ </details>
1187
1471
 
1188
- #### 🔌 Usage
1472
+ <details><summary><code>client.tracing.<a href="/src/api/resources/tracing/client/Client.ts">trace</a>(traceId) -> Scorecard.Trace</code></summary>
1473
+ <dl>
1474
+ <dd>
1475
+
1476
+ #### 📝 Description
1189
1477
 
1190
1478
  <dl>
1479
+ <dd>
1191
1480
 
1481
+ <dl>
1192
1482
  <dd>
1193
1483
 
1484
+ Retrieve specified trace
1485
+
1486
+ </dd>
1487
+ </dl>
1488
+ </dd>
1489
+ </dl>
1490
+
1491
+ #### 🔌 Usage
1492
+
1194
1493
  <dl>
1494
+ <dd>
1195
1495
 
1496
+ <dl>
1196
1497
  <dd>
1197
1498
 
1198
- ```ts
1199
- await scorecard.score.create(1, 1, {
1200
- metricId: 1,
1201
- });
1499
+ ```typescript
1500
+ await client.tracing.trace("trace_id");
1202
1501
  ```
1203
1502
 
1204
1503
  </dd>
1205
-
1206
1504
  </dl>
1207
-
1208
1505
  </dd>
1209
-
1210
1506
  </dl>
1211
1507
 
1212
1508
  #### ⚙️ Parameters
1213
1509
 
1214
1510
  <dl>
1215
-
1216
1511
  <dd>
1217
1512
 
1218
1513
  <dl>
1514
+ <dd>
1515
+
1516
+ **traceId:** `string` — The ID of the trace to retrieve spans from.
1219
1517
 
1518
+ </dd>
1519
+ </dl>
1520
+
1521
+ <dl>
1220
1522
  <dd>
1221
1523
 
1222
- **runId: `number`** — The ID of the run that created the testrecord to be scored.
1524
+ **requestOptions:** `Tracing.RequestOptions`
1223
1525
 
1224
1526
  </dd>
1527
+ </dl>
1528
+ </dd>
1529
+ </dl>
1225
1530
 
1531
+ </dd>
1226
1532
  </dl>
1533
+ </details>
1534
+
1535
+ <details><summary><code>client.tracing.<a href="/src/api/resources/tracing/client/Client.ts">span</a>(traceId, spanId) -> Scorecard.Span</code></summary>
1536
+ <dl>
1537
+ <dd>
1538
+
1539
+ #### 📝 Description
1227
1540
 
1228
1541
  <dl>
1542
+ <dd>
1229
1543
 
1544
+ <dl>
1230
1545
  <dd>
1231
1546
 
1232
- **testrecordId: `number`** — The ID of the testrecord to be scored.
1547
+ Retrieve specified span
1233
1548
 
1234
1549
  </dd>
1235
-
1236
1550
  </dl>
1551
+ </dd>
1552
+ </dl>
1553
+
1554
+ #### 🔌 Usage
1237
1555
 
1238
1556
  <dl>
1557
+ <dd>
1239
1558
 
1559
+ <dl>
1240
1560
  <dd>
1241
1561
 
1242
- **request: `Scorecard.ScoreCreateParams`**
1562
+ ```typescript
1563
+ await client.tracing.span("trace_id", "span_id");
1564
+ ```
1243
1565
 
1244
1566
  </dd>
1245
-
1246
1567
  </dl>
1568
+ </dd>
1569
+ </dl>
1570
+
1571
+ #### ⚙️ Parameters
1247
1572
 
1248
1573
  <dl>
1574
+ <dd>
1249
1575
 
1576
+ <dl>
1250
1577
  <dd>
1251
1578
 
1252
- **requestOptions: `Score.RequestOptions`**
1579
+ **traceId:** `string` — The ID of the trace which the span is a part of.
1253
1580
 
1254
1581
  </dd>
1255
-
1256
1582
  </dl>
1257
1583
 
1584
+ <dl>
1585
+ <dd>
1586
+
1587
+ **spanId:** `string` — The ID of the span to retrieve.
1588
+
1258
1589
  </dd>
1590
+ </dl>
1591
+
1592
+ <dl>
1593
+ <dd>
1259
1594
 
1595
+ **requestOptions:** `Tracing.RequestOptions`
1596
+
1597
+ </dd>
1598
+ </dl>
1599
+ </dd>
1260
1600
  </dl>
1261
1601
 
1262
1602
  </dd>
1263
-
1264
1603
  </dl>
1265
1604
  </details>
1266
1605
 
1267
- <details><summary> <code>scorecard.score.<a href="./src/api/resources/score/client/Client.ts">update</a>(runId, testrecordId, scoreId, { ...params }) -> Scorecard.Grade</code> </summary>
1606
+ ## Prompt
1268
1607
 
1608
+ <details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">getByName</a>({ ...params }) -> Scorecard.Prompt</code></summary>
1269
1609
  <dl>
1270
-
1271
1610
  <dd>
1272
1611
 
1273
1612
  #### 📝 Description
1274
1613
 
1275
1614
  <dl>
1276
-
1277
1615
  <dd>
1278
1616
 
1279
1617
  <dl>
1280
-
1281
1618
  <dd>
1282
1619
 
1283
- Update a score
1620
+ Retrieve a prompt by name, defaulting to the production prompt, unless a tag to select the prompt by is specified
1284
1621
 
1285
1622
  </dd>
1286
-
1287
1623
  </dl>
1288
-
1289
1624
  </dd>
1290
-
1291
1625
  </dl>
1292
1626
 
1293
1627
  #### 🔌 Usage
1294
1628
 
1295
1629
  <dl>
1296
-
1297
1630
  <dd>
1298
1631
 
1299
1632
  <dl>
1300
-
1301
1633
  <dd>
1302
1634
 
1303
- ```ts
1304
- await scorecard.score.update(1, 1, 1);
1635
+ ```typescript
1636
+ await client.prompt.getByName({
1637
+ name: "name",
1638
+ });
1305
1639
  ```
1306
1640
 
1307
1641
  </dd>
1308
-
1309
1642
  </dl>
1310
-
1311
1643
  </dd>
1312
-
1313
1644
  </dl>
1314
1645
 
1315
1646
  #### ⚙️ Parameters
1316
1647
 
1317
1648
  <dl>
1318
-
1319
1649
  <dd>
1320
1650
 
1321
1651
  <dl>
1322
-
1323
1652
  <dd>
1324
1653
 
1325
- **runId: `number`** — The run ID that created the test record to be scored.
1654
+ **request:** `Scorecard.PromptGetByNameRequest`
1326
1655
 
1327
1656
  </dd>
1328
-
1329
1657
  </dl>
1330
1658
 
1331
1659
  <dl>
1332
-
1333
1660
  <dd>
1334
1661
 
1335
- **testrecordId: `number`** — The ID of the testrecord whose score will be updated.
1662
+ **requestOptions:** `Prompt.RequestOptions`
1336
1663
 
1337
1664
  </dd>
1665
+ </dl>
1666
+ </dd>
1667
+ </dl>
1338
1668
 
1669
+ </dd>
1339
1670
  </dl>
1671
+ </details>
1340
1672
 
1673
+ <details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">create</a>({ ...params }) -> Scorecard.Prompt</code></summary>
1341
1674
  <dl>
1675
+ <dd>
1676
+
1677
+ #### 📝 Description
1342
1678
 
1679
+ <dl>
1343
1680
  <dd>
1344
1681
 
1345
- **scoreId: `number`** — The ID of the score to be updated.
1682
+ <dl>
1683
+ <dd>
1346
1684
 
1347
- </dd>
1685
+ Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in the app).
1348
1686
 
1687
+ A root prompt can be created by providing the `name` param, and it will always be tagged as production.
1688
+
1689
+ A child prompt can be created by providing the `parent_id` param. Note that the `name` param in this case will be ignored as all descendants from a root prompt would share the root's name. `is_prod` can also be provided to configure whether a child should be tagged as production.
1690
+
1691
+ </dd>
1692
+ </dl>
1693
+ </dd>
1349
1694
  </dl>
1350
1695
 
1696
+ #### 🔌 Usage
1697
+
1351
1698
  <dl>
1699
+ <dd>
1352
1700
 
1701
+ <dl>
1353
1702
  <dd>
1354
1703
 
1355
- **request: `Scorecard.ScoreUpdateParams`**
1704
+ ```typescript
1705
+ await client.prompt.create({
1706
+ promptTemplate:
1707
+ "<system>\nYou are a helpful assistant. Use the provided context to answer the user's query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
1708
+ name: "Prompt Name",
1709
+ description: "Description of the prompt",
1710
+ modelParams: {
1711
+ param1: "value1",
1712
+ param2: 0.1,
1713
+ param3: 100,
1714
+ param4: true,
1715
+ },
1716
+ tag: "1.0",
1717
+ projectId: 1,
1718
+ });
1719
+ ```
1356
1720
 
1357
1721
  </dd>
1358
-
1722
+ </dl>
1723
+ </dd>
1359
1724
  </dl>
1360
1725
 
1726
+ #### ⚙️ Parameters
1727
+
1361
1728
  <dl>
1729
+ <dd>
1362
1730
 
1731
+ <dl>
1363
1732
  <dd>
1364
1733
 
1365
- **requestOptions: `Score.RequestOptions`**
1734
+ **request:** `Scorecard.PromptCreateParams`
1366
1735
 
1367
1736
  </dd>
1368
-
1369
1737
  </dl>
1370
1738
 
1371
- </dd>
1739
+ <dl>
1740
+ <dd>
1372
1741
 
1373
- </dl>
1742
+ **requestOptions:** `Prompt.RequestOptions`
1374
1743
 
1375
1744
  </dd>
1745
+ </dl>
1746
+ </dd>
1747
+ </dl>
1376
1748
 
1749
+ </dd>
1377
1750
  </dl>
1378
1751
  </details>
1379
1752
 
1380
- ## RunMetric
1381
-
1382
- <details><summary> <code>scorecard.runMetric.<a href="./src/api/resources/runMetric/client/Client.ts">get</a>(runId) -> Scorecard.RunMetric[]</code> </summary>
1383
-
1753
+ <details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">listPrompts</a>({ ...params }) -> Scorecard.PromptCursorPage</code></summary>
1384
1754
  <dl>
1385
-
1386
1755
  <dd>
1387
1756
 
1388
1757
  #### 📝 Description
1389
1758
 
1390
1759
  <dl>
1391
-
1392
1760
  <dd>
1393
1761
 
1394
1762
  <dl>
1395
-
1396
1763
  <dd>
1397
1764
 
1398
- Retrieve metrics associated with a run
1765
+ List all prompts with cursor-based pagination
1399
1766
 
1400
1767
  </dd>
1401
-
1402
1768
  </dl>
1403
-
1404
1769
  </dd>
1405
-
1406
1770
  </dl>
1407
1771
 
1408
1772
  #### 🔌 Usage
1409
1773
 
1410
1774
  <dl>
1411
-
1412
1775
  <dd>
1413
1776
 
1414
1777
  <dl>
1415
-
1416
1778
  <dd>
1417
1779
 
1418
- ```ts
1419
- await scorecard.runMetric.get(1);
1780
+ ```typescript
1781
+ await client.prompt.listPrompts();
1420
1782
  ```
1421
1783
 
1422
1784
  </dd>
1423
-
1424
1785
  </dl>
1425
-
1426
1786
  </dd>
1427
-
1428
1787
  </dl>
1429
1788
 
1430
1789
  #### ⚙️ Parameters
1431
1790
 
1432
1791
  <dl>
1433
-
1434
1792
  <dd>
1435
1793
 
1436
1794
  <dl>
1437
-
1438
1795
  <dd>
1439
1796
 
1440
- **runId: `number`** — The id of the run to retrieve.
1797
+ **request:** `Scorecard.PromptListPromptsRequest`
1441
1798
 
1442
1799
  </dd>
1443
-
1444
1800
  </dl>
1445
1801
 
1446
1802
  <dl>
1447
-
1448
1803
  <dd>
1449
1804
 
1450
- **requestOptions: `RunMetric.RequestOptions`**
1805
+ **requestOptions:** `Prompt.RequestOptions`
1451
1806
 
1452
1807
  </dd>
1453
-
1454
1808
  </dl>
1455
-
1456
1809
  </dd>
1457
-
1458
1810
  </dl>
1459
1811
 
1460
1812
  </dd>
1461
-
1462
1813
  </dl>
1463
1814
  </details>
1464
1815
 
1465
- ## Traces
1466
-
1467
- <details><summary> <code>scorecard.traces.<a href="./src/api/resources/traces/client/Client.ts">get</a>(traceId) -> Scorecard.Span[]</code> </summary>
1468
-
1816
+ <details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">get</a>(id) -> Scorecard.Prompt</code></summary>
1469
1817
  <dl>
1470
-
1471
1818
  <dd>
1472
1819
 
1473
1820
  #### 📝 Description
1474
1821
 
1475
1822
  <dl>
1476
-
1477
1823
  <dd>
1478
1824
 
1479
1825
  <dl>
1480
-
1481
1826
  <dd>
1482
1827
 
1483
- Retrieve trace spans
1828
+ Retrieve a prompt by id
1484
1829
 
1485
1830
  </dd>
1486
-
1487
1831
  </dl>
1488
-
1489
1832
  </dd>
1490
-
1491
1833
  </dl>
1492
1834
 
1493
1835
  #### 🔌 Usage
1494
1836
 
1495
1837
  <dl>
1496
-
1497
1838
  <dd>
1498
1839
 
1499
1840
  <dl>
1500
-
1501
1841
  <dd>
1502
1842
 
1503
- ```ts
1504
- await scorecard.traces.get("trace_id");
1843
+ ```typescript
1844
+ await client.prompt.get("id");
1505
1845
  ```
1506
1846
 
1507
1847
  </dd>
1508
-
1509
1848
  </dl>
1510
-
1511
1849
  </dd>
1512
-
1513
1850
  </dl>
1514
1851
 
1515
1852
  #### ⚙️ Parameters
1516
1853
 
1517
1854
  <dl>
1518
-
1519
1855
  <dd>
1520
1856
 
1521
1857
  <dl>
1522
-
1523
1858
  <dd>
1524
1859
 
1525
- **traceId: `string`** — The ID of the trace to retrieve spans from.
1860
+ **id:** `string` — The id of the prompt to get.
1526
1861
 
1527
1862
  </dd>
1528
-
1529
1863
  </dl>
1530
1864
 
1531
1865
  <dl>
1532
-
1533
1866
  <dd>
1534
1867
 
1535
- **requestOptions: `Traces.RequestOptions`**
1868
+ **requestOptions:** `Prompt.RequestOptions`
1536
1869
 
1537
1870
  </dd>
1538
-
1539
1871
  </dl>
1540
-
1541
1872
  </dd>
1542
-
1543
1873
  </dl>
1544
1874
 
1545
1875
  </dd>
1546
-
1547
1876
  </dl>
1548
1877
  </details>
1549
1878
 
1550
- ## Prompt
1551
-
1552
- <details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">create</a>({ ...params }) -> Scorecard.Prompt</code> </summary>
1553
-
1879
+ <details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">delete</a>(id) -> unknown</code></summary>
1554
1880
  <dl>
1555
-
1556
1881
  <dd>
1557
1882
 
1558
1883
  #### 📝 Description
1559
1884
 
1560
1885
  <dl>
1561
-
1562
1886
  <dd>
1563
1887
 
1564
1888
  <dl>
1565
-
1566
1889
  <dd>
1567
1890
 
1568
- Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in app).
1569
-
1570
- A root prompt can be created by providing the `name` param, and it will always be tagged as prod.
1571
-
1572
- A child prompt can be created by providing the `parent_id` param. Note that the `name` param in this case will be ignored as all descendents from a root prompt would share the root's name. `is_prod` can also be provided to configure whether a child should be tagged as prod.
1891
+ Delete a root prompt and all of its children.
1573
1892
 
1574
1893
  </dd>
1575
-
1576
1894
  </dl>
1577
-
1578
1895
  </dd>
1579
-
1580
1896
  </dl>
1581
1897
 
1582
1898
  #### 🔌 Usage
1583
1899
 
1584
1900
  <dl>
1585
-
1586
1901
  <dd>
1587
1902
 
1588
1903
  <dl>
1589
-
1590
1904
  <dd>
1591
1905
 
1592
- ```ts
1593
- await scorecard.prompt.create({
1594
- promptTemplate:
1595
- "<system>\nYou are a helpful assistant. Use the provided context to answer the user's query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
1596
- name: "Prompt Name",
1597
- description: "Description of the prompt",
1598
- modelParams: {
1599
- param1: "value1",
1600
- param2: 0.1,
1601
- param3: 100,
1602
- param4: true,
1603
- },
1604
- });
1906
+ ```typescript
1907
+ await client.prompt.delete("id");
1605
1908
  ```
1606
1909
 
1607
1910
  </dd>
1608
-
1609
1911
  </dl>
1610
-
1611
1912
  </dd>
1612
-
1613
1913
  </dl>
1614
1914
 
1615
1915
  #### ⚙️ Parameters
1616
1916
 
1617
1917
  <dl>
1618
-
1619
1918
  <dd>
1620
1919
 
1621
1920
  <dl>
1622
-
1623
1921
  <dd>
1624
1922
 
1625
- **request: `Scorecard.PromptCreateParams`**
1923
+ **id:** `string` — The id of the root prompt to delete.
1626
1924
 
1627
1925
  </dd>
1628
-
1629
1926
  </dl>
1630
1927
 
1631
1928
  <dl>
1632
-
1633
1929
  <dd>
1634
1930
 
1635
- **requestOptions: `Prompt.RequestOptions`**
1931
+ **requestOptions:** `Prompt.RequestOptions`
1636
1932
 
1637
1933
  </dd>
1638
-
1639
1934
  </dl>
1640
-
1641
1935
  </dd>
1642
-
1643
1936
  </dl>
1644
1937
 
1645
1938
  </dd>
1646
-
1647
1939
  </dl>
1648
1940
  </details>
1649
1941
 
1650
- <details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">get</a>(id) -> Scorecard.Prompt</code> </summary>
1651
-
1942
+ <details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">update</a>(id, { ...params }) -> Scorecard.Prompt</code></summary>
1652
1943
  <dl>
1653
-
1654
1944
  <dd>
1655
1945
 
1656
1946
  #### 📝 Description
1657
1947
 
1658
1948
  <dl>
1659
-
1660
1949
  <dd>
1661
1950
 
1662
1951
  <dl>
1663
-
1664
1952
  <dd>
1665
1953
 
1666
- Retrieve a prompt by id
1954
+ Update a prompt.
1667
1955
 
1668
- </dd>
1956
+ `is_prod` tags the provided prompt as the production prompt within the prompt graph.
1669
1957
 
1958
+ </dd>
1670
1959
  </dl>
1671
-
1672
1960
  </dd>
1673
-
1674
1961
  </dl>
1675
1962
 
1676
1963
  #### 🔌 Usage
1677
1964
 
1678
1965
  <dl>
1679
-
1680
1966
  <dd>
1681
1967
 
1682
1968
  <dl>
1683
-
1684
1969
  <dd>
1685
1970
 
1686
- ```ts
1687
- await scorecard.prompt.get("id");
1971
+ ```typescript
1972
+ await client.prompt.update("id", {
1973
+ isProd: true,
1974
+ });
1688
1975
  ```
1689
1976
 
1690
1977
  </dd>
1691
-
1692
1978
  </dl>
1693
-
1694
1979
  </dd>
1695
-
1696
1980
  </dl>
1697
1981
 
1698
1982
  #### ⚙️ Parameters
1699
1983
 
1700
1984
  <dl>
1701
-
1702
1985
  <dd>
1703
1986
 
1704
1987
  <dl>
1705
-
1706
1988
  <dd>
1707
1989
 
1708
- **id: `string`** — The id of the prompt to get.
1990
+ **id:** `string` — The id of the prompt to update.
1709
1991
 
1710
1992
  </dd>
1711
-
1712
1993
  </dl>
1713
1994
 
1714
1995
  <dl>
1715
-
1716
1996
  <dd>
1717
1997
 
1718
- **requestOptions: `Prompt.RequestOptions`**
1998
+ **request:** `Scorecard.PromptUpdateParams`
1719
1999
 
1720
2000
  </dd>
1721
-
1722
2001
  </dl>
1723
2002
 
1724
- </dd>
2003
+ <dl>
2004
+ <dd>
1725
2005
 
1726
- </dl>
2006
+ **requestOptions:** `Prompt.RequestOptions`
1727
2007
 
1728
2008
  </dd>
2009
+ </dl>
2010
+ </dd>
2011
+ </dl>
1729
2012
 
2013
+ </dd>
1730
2014
  </dl>
1731
2015
  </details>
1732
2016
 
1733
- <details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">delete</a>(id) -> unknown</code> </summary>
2017
+ ## ScoringConfig
1734
2018
 
2019
+ <details><summary><code>client.scoringConfig.<a href="/src/api/resources/scoringConfig/client/Client.ts">create</a>({ ...params }) -> Scorecard.ScoringConfig</code></summary>
1735
2020
  <dl>
1736
-
1737
2021
  <dd>
1738
2022
 
1739
2023
  #### 📝 Description
1740
2024
 
1741
2025
  <dl>
1742
-
1743
2026
  <dd>
1744
2027
 
1745
2028
  <dl>
1746
-
1747
2029
  <dd>
1748
2030
 
1749
- Delete a root prompt and all of its children.
2031
+ Create a new scoring config.
1750
2032
 
1751
2033
  </dd>
1752
-
1753
2034
  </dl>
1754
-
1755
2035
  </dd>
1756
-
1757
2036
  </dl>
1758
2037
 
1759
2038
  #### 🔌 Usage
1760
2039
 
1761
2040
  <dl>
1762
-
1763
2041
  <dd>
1764
2042
 
1765
2043
  <dl>
1766
-
1767
2044
  <dd>
1768
2045
 
1769
- ```ts
1770
- await scorecard.prompt.delete("id");
2046
+ ```typescript
2047
+ await client.scoringConfig.create({
2048
+ name: "Scoring Config Name",
2049
+ description: "Description of the scoring config",
2050
+ metrics: [1, 2, 3],
2051
+ projectId: 1,
2052
+ });
1771
2053
  ```
1772
2054
 
1773
2055
  </dd>
1774
-
1775
2056
  </dl>
1776
-
1777
2057
  </dd>
1778
-
1779
2058
  </dl>
1780
2059
 
1781
2060
  #### ⚙️ Parameters
1782
2061
 
1783
2062
  <dl>
1784
-
1785
2063
  <dd>
1786
2064
 
1787
2065
  <dl>
1788
-
1789
2066
  <dd>
1790
2067
 
1791
- **id: `string`** — The id of the root prompt to delete.
2068
+ **request:** `Scorecard.ScoringConfigCreateParams`
1792
2069
 
1793
2070
  </dd>
1794
-
1795
2071
  </dl>
1796
2072
 
1797
2073
  <dl>
1798
-
1799
2074
  <dd>
1800
2075
 
1801
- **requestOptions: `Prompt.RequestOptions`**
2076
+ **requestOptions:** `ScoringConfig.RequestOptions`
1802
2077
 
1803
2078
  </dd>
1804
-
1805
2079
  </dl>
1806
-
1807
2080
  </dd>
1808
-
1809
2081
  </dl>
1810
2082
 
1811
2083
  </dd>
1812
-
1813
2084
  </dl>
1814
2085
  </details>
1815
2086
 
1816
- <details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">update</a>(id, { ...params }) -> Scorecard.Prompt</code> </summary>
1817
-
2087
+ <details><summary><code>client.scoringConfig.<a href="/src/api/resources/scoringConfig/client/Client.ts">get</a>(id) -> Scorecard.ScoringConfig</code></summary>
1818
2088
  <dl>
1819
-
1820
2089
  <dd>
1821
2090
 
1822
2091
  #### 📝 Description
1823
2092
 
1824
2093
  <dl>
1825
-
1826
2094
  <dd>
1827
2095
 
1828
2096
  <dl>
1829
-
1830
2097
  <dd>
1831
2098
 
1832
- Update a prompt.
1833
-
1834
- `is_prod` tags the provided prompt as the production prompt within the prompt graph.
2099
+ Retrieve a scoring config by id
1835
2100
 
1836
2101
  </dd>
1837
-
1838
2102
  </dl>
1839
-
1840
2103
  </dd>
1841
-
1842
2104
  </dl>
1843
2105
 
1844
2106
  #### 🔌 Usage
1845
2107
 
1846
2108
  <dl>
1847
-
1848
2109
  <dd>
1849
2110
 
1850
2111
  <dl>
1851
-
1852
2112
  <dd>
1853
2113
 
1854
- ```ts
1855
- await scorecard.prompt.update("id", {
1856
- isProd: true,
1857
- });
2114
+ ```typescript
2115
+ await client.scoringConfig.get("id");
1858
2116
  ```
1859
2117
 
1860
2118
  </dd>
1861
-
1862
2119
  </dl>
1863
-
1864
2120
  </dd>
1865
-
1866
2121
  </dl>
1867
2122
 
1868
2123
  #### ⚙️ Parameters
1869
2124
 
1870
2125
  <dl>
1871
-
1872
- <dd>
1873
-
1874
- <dl>
1875
-
1876
2126
  <dd>
1877
2127
 
1878
- **id: `string`** — The id of the prompt to update.
1879
-
1880
- </dd>
1881
-
1882
- </dl>
1883
-
1884
2128
  <dl>
1885
-
1886
2129
  <dd>
1887
2130
 
1888
- **request: `Scorecard.PromptUpdateParams`**
2131
+ **id:** `string` — The id of the scoring config to get.
1889
2132
 
1890
2133
  </dd>
1891
-
1892
2134
  </dl>
1893
2135
 
1894
2136
  <dl>
1895
-
1896
2137
  <dd>
1897
2138
 
1898
- **requestOptions: `Prompt.RequestOptions`**
2139
+ **requestOptions:** `ScoringConfig.RequestOptions`
1899
2140
 
1900
2141
  </dd>
1901
-
1902
2142
  </dl>
1903
-
1904
2143
  </dd>
1905
-
1906
2144
  </dl>
1907
2145
 
1908
2146
  </dd>
1909
-
1910
2147
  </dl>
1911
2148
  </details>
1912
2149
 
1913
- <details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">getByName</a>(name) -> Scorecard.Prompt</code> </summary>
1914
-
2150
+ <details><summary><code>client.scoringConfig.<a href="/src/api/resources/scoringConfig/client/Client.ts">delete</a>(id) -> unknown</code></summary>
1915
2151
  <dl>
1916
-
1917
2152
  <dd>
1918
2153
 
1919
2154
  #### 📝 Description
1920
2155
 
1921
2156
  <dl>
1922
-
1923
2157
  <dd>
1924
2158
 
1925
2159
  <dl>
1926
-
1927
2160
  <dd>
1928
2161
 
1929
- Retrieve a prod prompt by name
2162
+ Delete a scoring config.
1930
2163
 
1931
2164
  </dd>
1932
-
1933
2165
  </dl>
1934
-
1935
2166
  </dd>
1936
-
1937
2167
  </dl>
1938
2168
 
1939
2169
  #### 🔌 Usage
1940
2170
 
1941
2171
  <dl>
1942
-
1943
2172
  <dd>
1944
2173
 
1945
2174
  <dl>
1946
-
1947
2175
  <dd>
1948
2176
 
1949
- ```ts
1950
- await scorecard.prompt.getByName("name");
2177
+ ```typescript
2178
+ await client.scoringConfig.delete("id");
1951
2179
  ```
1952
2180
 
1953
2181
  </dd>
1954
-
1955
2182
  </dl>
1956
-
1957
2183
  </dd>
1958
-
1959
2184
  </dl>
1960
2185
 
1961
2186
  #### ⚙️ Parameters
1962
2187
 
1963
2188
  <dl>
1964
-
1965
2189
  <dd>
1966
2190
 
1967
2191
  <dl>
1968
-
1969
2192
  <dd>
1970
2193
 
1971
- **name: `string`**Name of the prompt.
2194
+ **id:** `string`The id of the scoring config to delete.
1972
2195
 
1973
2196
  </dd>
1974
-
1975
2197
  </dl>
1976
2198
 
1977
2199
  <dl>
1978
-
1979
2200
  <dd>
1980
2201
 
1981
- **requestOptions: `Prompt.RequestOptions`**
2202
+ **requestOptions:** `ScoringConfig.RequestOptions`
1982
2203
 
1983
2204
  </dd>
1984
-
1985
2205
  </dl>
1986
-
1987
2206
  </dd>
1988
-
1989
2207
  </dl>
1990
2208
 
1991
2209
  </dd>
1992
-
1993
2210
  </dl>
1994
2211
  </details>