scorecard-ai 0.1.10 → 0.1.12

package/Client.d.ts

@@ -7,6 +7,7 @@ import { Testset } from "./api/resources/testset/client/Client";
 import { Testcase } from "./api/resources/testcase/client/Client";
 import { Testrecord } from "./api/resources/testrecord/client/Client";
 import { Run } from "./api/resources/run/client/Client";
+import { Score } from "./api/resources/score/client/Client";
 export declare namespace ScorecardClient {
     interface Options {
         environment?: core.Supplier<environments.ScorecardEnvironment | string>;
@@ -28,4 +29,6 @@ export declare class ScorecardClient {
     get testrecord(): Testrecord;
     protected _run: Run | undefined;
     get run(): Run;
+    protected _score: Score | undefined;
+    get score(): Score;
 }

package/Client.js

@@ -8,6 +8,7 @@ const Client_1 = require("./api/resources/testset/client/Client");
 const Client_2 = require("./api/resources/testcase/client/Client");
 const Client_3 = require("./api/resources/testrecord/client/Client");
 const Client_4 = require("./api/resources/run/client/Client");
+const Client_5 = require("./api/resources/score/client/Client");
 class ScorecardClient {
     constructor(_options) {
         this._options = _options;
@@ -28,5 +29,9 @@ class ScorecardClient {
         var _a;
         return ((_a = this._run) !== null && _a !== void 0 ? _a : (this._run = new Client_4.Run(this._options)));
     }
+    get score() {
+        var _a;
+        return ((_a = this._score) !== null && _a !== void 0 ? _a : (this._score = new Client_5.Score(this._options)));
+    }
 }
 exports.ScorecardClient = ScorecardClient;

package/README.md

@@ -1,5 +1,6 @@
 # Scorecard AI Node Library
 
+[![npm shield](https://img.shields.io/npm/v/scorecard-ai)](https://www.npmjs.com/package/scorecard-ai)
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
 
 ## Installation

package/api/resources/index.d.ts

@@ -4,7 +4,9 @@ export * as testrecord from "./testrecord";
 export * from "./testrecord/types";
 export * as testset from "./testset";
 export * as run from "./run";
+export * as score from "./score";
 export * from "./testset/client/requests";
 export * from "./testcase/client/requests";
 export * from "./testrecord/client/requests";
 export * from "./run/client/requests";
+export * from "./score/client/requests";

package/api/resources/index.js

@@ -26,14 +26,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = exports.testset = exports.testrecord = exports.testcase = void 0;
+exports.score = exports.run = exports.testset = exports.testrecord = exports.testcase = void 0;
 exports.testcase = __importStar(require("./testcase"));
 __exportStar(require("./testcase/types"), exports);
 exports.testrecord = __importStar(require("./testrecord"));
 __exportStar(require("./testrecord/types"), exports);
 exports.testset = __importStar(require("./testset"));
 exports.run = __importStar(require("./run"));
+exports.score = __importStar(require("./score"));
 __exportStar(require("./testset/client/requests"), exports);
 __exportStar(require("./testcase/client/requests"), exports);
 __exportStar(require("./testrecord/client/requests"), exports);
 __exportStar(require("./run/client/requests"), exports);
+__exportStar(require("./score/client/requests"), exports);

package/api/resources/run/client/Client.d.ts

@@ -23,8 +23,19 @@ export declare class Run {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.run.create({
+     *         testsetId: 1,
+     *         scoringConfigId: 2,
+     *         status: "RUNNING_EXECUTION",
+     *         modelParams: {
+     *             "param1": "value1",
+     *             "param2": "value2"
+     *         }
+     *     })
      */
-    create(request: Scorecard.RunCreateParams, requestOptions?: Run.RequestOptions): Promise<Scorecard.RunExternal>;
+    create(request?: Scorecard.RunCreateParams, requestOptions?: Run.RequestOptions): Promise<Scorecard.RunExternal>;
     /**
      * Retrieve a Run metadata
      * @throws {@link Scorecard.UnauthorizedError}

package/api/resources/run/client/Client.js

@@ -55,8 +55,19 @@ class Run {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.run.create({
+     *         testsetId: 1,
+     *         scoringConfigId: 2,
+     *         status: "RUNNING_EXECUTION",
+     *         modelParams: {
+     *             "param1": "value1",
+     *             "param2": "value2"
+     *         }
+     *     })
      */
-    create(request, requestOptions) {
+    create(request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
@@ -66,7 +77,7 @@ class Run {
                     "X-API-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "scorecard-ai",
-                    "X-Fern-SDK-Version": "0.1.10",
+                    "X-Fern-SDK-Version": "0.1.12",
                 },
                 contentType: "application/json",
                 body: yield serializers.RunCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -158,7 +169,7 @@ class Run {
                     "X-API-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "scorecard-ai",
-                    "X-Fern-SDK-Version": "0.1.10",
+                    "X-Fern-SDK-Version": "0.1.12",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -251,7 +262,7 @@ class Run {
                     "X-API-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "scorecard-ai",
-                    "X-Fern-SDK-Version": "0.1.10",
+                    "X-Fern-SDK-Version": "0.1.12",
                 },
                 contentType: "application/json",
                 body: yield serializers.UpdateStatusParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

package/api/resources/run/client/requests/RunCreateParams.d.ts

@@ -1,9 +1,24 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         testsetId: 1,
+ *         scoringConfigId: 2,
+ *         status: "RUNNING_EXECUTION",
+ *         modelParams: {
+ *             "param1": "value1",
+ *             "param2": "value2"
+ *         }
+ *     }
+ */
 export interface RunCreateParams {
-    testsetId: number;
+    testsetId?: number;
     scoringConfigId?: number;
     status?: string;
     modelParams?: Record<string, unknown>;
+    source?: string;
+    notes?: string;
+    promptTemplate?: string;
 }

package/api/resources/score/client/Client.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Scorecard from "../../..";
+export declare namespace Score {
+    interface Options {
+        environment?: core.Supplier<environments.ScorecardEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class Score {
+    protected readonly _options: Score.Options;
+    constructor(_options: Score.Options);
+    /**
+     * Create a score
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.score.create(1, 1, {
+     *         metricId: 1
+     *     })
+     */
+    create(runId: number, testrecordId: number, request: Scorecard.ScoreCreateParams, requestOptions?: Score.RequestOptions): Promise<Scorecard.Grade>;
+    /**
+     * Update a score
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.score.update(1, 1, 1, {})
+     */
+    update(runId: number, testrecordId: number, scoreId: number, request?: Scorecard.ScoreUpdateParams, requestOptions?: Score.RequestOptions): Promise<Scorecard.Grade>;
+}

package/api/resources/score/client/Client.js

@@ -0,0 +1,239 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Score = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const Scorecard = __importStar(require("../../.."));
+const serializers = __importStar(require("../../../../serialization"));
+const url_join_1 = __importDefault(require("url-join"));
+const errors = __importStar(require("../../../../errors"));
+class Score {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Create a score
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.score.create(1, 1, {
+     *         metricId: 1
+     *     })
+     */
+    create(runId, testrecordId, request, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.ScorecardEnvironment.Default, `v1/run/${runId}/testrecord/${testrecordId}/score`),
+                method: "POST",
+                headers: {
+                    "X-API-Key": yield core.Supplier.get(this._options.apiKey),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "scorecard-ai",
+                    "X-Fern-SDK-Version": "0.1.12",
+                },
+                contentType: "application/json",
+                body: yield serializers.ScoreCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+            });
+            if (_response.ok) {
+                return yield serializers.Grade.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 401:
+                        throw new Scorecard.UnauthorizedError(yield serializers.UnauthenticatedError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 403:
+                        throw new Scorecard.ForbiddenError(yield serializers.UnauthorizedErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 404:
+                        throw new Scorecard.NotFoundError(yield serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 422:
+                        throw new Scorecard.UnprocessableEntityError(yield serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.ScorecardError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ScorecardError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.ScorecardTimeoutError();
+                case "unknown":
+                    throw new errors.ScorecardError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Update a score
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.score.update(1, 1, 1, {})
+     */
+    update(runId, testrecordId, scoreId, request = {}, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.ScorecardEnvironment.Default, `v1/run/${runId}/testrecord/${testrecordId}/score/${scoreId}`),
+                method: "PATCH",
+                headers: {
+                    "X-API-Key": yield core.Supplier.get(this._options.apiKey),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "scorecard-ai",
+                    "X-Fern-SDK-Version": "0.1.12",
+                },
+                contentType: "application/json",
+                body: yield serializers.ScoreUpdateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+            });
+            if (_response.ok) {
+                return yield serializers.Grade.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 401:
+                        throw new Scorecard.UnauthorizedError(yield serializers.UnauthenticatedError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 403:
+                        throw new Scorecard.ForbiddenError(yield serializers.UnauthorizedErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 404:
+                        throw new Scorecard.NotFoundError(yield serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 422:
+                        throw new Scorecard.UnprocessableEntityError(yield serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.ScorecardError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ScorecardError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.ScorecardTimeoutError();
+                case "unknown":
+                    throw new errors.ScorecardError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+}
+exports.Score = Score;

package/api/resources/score/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/api/resources/score/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/api/resources/score/client/requests/ScoreCreateParams.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         metricId: 1
+ *     }
+ */
+export interface ScoreCreateParams {
+    metricId: number;
+    intScore?: number;
+    binaryScore?: boolean;
+    reasoning?: string;
+}

package/api/resources/score/client/requests/ScoreUpdateParams.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ScoreUpdateParams {
+    intScore?: number;
+    binaryScore?: boolean;
+    reasoning?: string;
+}

package/api/resources/score/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { ScoreCreateParams } from "./ScoreCreateParams";
+export { ScoreUpdateParams } from "./ScoreUpdateParams";

package/api/resources/score/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/score/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/api/resources/score/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);

package/api/resources/testcase/client/Client.d.ts

@@ -23,6 +23,11 @@ export declare class Testcase {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testcase.create(1, {
+     *         userQuery: "user_query"
+     *     })
      */
     create(testsetId: number, request: Scorecard.TestcaseCreateParams, requestOptions?: Testcase.RequestOptions): Promise<Scorecard.TestCase>;
     /**
@@ -31,6 +36,9 @@ export declare class Testcase {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testcase.get(1, 1)
      */
     get(testcaseId: number, testsetId: number, requestOptions?: Testcase.RequestOptions): Promise<Scorecard.TestCase>;
     /**
@@ -39,6 +47,9 @@ export declare class Testcase {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testcase.delete(1, 1)
      */
     delete(testcaseId: number, testsetId: number, requestOptions?: Testcase.RequestOptions): Promise<unknown>;
 }

package/api/resources/testcase/client/Client.js

@@ -55,6 +55,11 @@ class Testcase {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testcase.create(1, {
+     *         userQuery: "user_query"
+     *     })
      */
     create(testsetId, request, requestOptions) {
         var _a;
@@ -66,7 +71,7 @@ class Testcase {
                     "X-API-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "scorecard-ai",
-                    "X-Fern-SDK-Version": "0.1.10",
+                    "X-Fern-SDK-Version": "0.1.12",
                 },
                 contentType: "application/json",
                 body: yield serializers.TestcaseCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -144,6 +149,9 @@ class Testcase {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testcase.get(1, 1)
      */
     get(testcaseId, testsetId, requestOptions) {
         var _a;
@@ -155,7 +163,7 @@ class Testcase {
                     "X-API-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "scorecard-ai",
-                    "X-Fern-SDK-Version": "0.1.10",
+                    "X-Fern-SDK-Version": "0.1.12",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -232,6 +240,9 @@ class Testcase {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testcase.delete(1, 1)
      */
     delete(testcaseId, testsetId, requestOptions) {
         var _a;
@@ -243,7 +254,7 @@ class Testcase {
                     "X-API-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "scorecard-ai",
-                    "X-Fern-SDK-Version": "0.1.10",
+                    "X-Fern-SDK-Version": "0.1.12",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/testcase/client/requests/TestcaseCreateParams.d.ts

@@ -2,6 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Scorecard from "../../../..";
+/**
+ * @example
+ *     {
+ *         userQuery: "user_query"
+ *     }
+ */
 export interface TestcaseCreateParams {
     userQuery: string;
     context?: string;

package/api/resources/testrecord/client/Client.d.ts

@@ -23,6 +23,9 @@ export declare class Testrecord {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testrecord.get(1, 1)
      */
     get(testrecordId: number, runId: number, requestOptions?: Testrecord.RequestOptions): Promise<Scorecard.Testrecord>;
     /**
@@ -31,6 +34,9 @@ export declare class Testrecord {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testrecord.create(1, {})
      */
-    create(runId: number, request: Scorecard.TestrecordCreateParams, requestOptions?: Testrecord.RequestOptions): Promise<Scorecard.Testrecord>;
+    create(runId: number, request?: Scorecard.TestrecordCreateParams, requestOptions?: Testrecord.RequestOptions): Promise<Scorecard.Testrecord>;
 }