scorecard-ai 0.2.1 → 0.4.0

package/api/resources/prompt/types/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("./PromptCreateParamsModelParamsValue"), exports);

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Scorecard from "../../..";
+import * as Scorecard from "../../../index";
 export declare namespace Run {
     interface Options {
         environment?: core.Supplier<environments.ScorecardEnvironment | string>;
@@ -19,25 +19,25 @@ export declare class Run {
     constructor(_options: Run.Options);
     /**
      * Create a new Run
+     *
+     * @param {Scorecard.RunCreateParams} request
+     * @param {Run.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @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"
-     *         }
-     *     })
+     *     await scorecard.run.create()
      */
     create(request?: Scorecard.RunCreateParams, requestOptions?: Run.RequestOptions): Promise<Scorecard.Run>;
     /**
      * Retrieve a Run metadata
+     *
+     * @param {number} runId - The id of the run to retrieve.
+     * @param {Run.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
@@ -49,15 +49,21 @@ export declare class Run {
     get(runId: number, requestOptions?: Run.RequestOptions): Promise<Scorecard.Run>;
     /**
      * Update the status of a run.
+     *
+     * @param {number} runId - The id of the run to update.
+     * @param {Scorecard.UpdateStatusParams} request
+     * @param {Run.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.run.updateStatus(1, {
-     *         status: Scorecard.RunStatus.Pending
-     *     })
+     *     await scorecard.run.updateStatus(1)
      */
-    updateStatus(runId: number, request: Scorecard.UpdateStatusParams, requestOptions?: Run.RequestOptions): Promise<Scorecard.Run>;
+    updateStatus(runId: number, request?: Scorecard.UpdateStatusParams, requestOptions?: Run.RequestOptions): Promise<Scorecard.Run>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-API-Key": string;
+    }>;
 }

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

@@ -41,31 +41,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Run = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Scorecard = __importStar(require("../../.."));
-const serializers = __importStar(require("../../../../serialization"));
+const Scorecard = __importStar(require("../../../index"));
+const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class Run {
     constructor(_options) {
         this._options = _options;
     }
     /**
      * Create a new Run
+     *
+     * @param {Scorecard.RunCreateParams} request
+     * @param {Run.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @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"
-     *         }
-     *     })
+     *     await scorecard.run.create()
      */
     create(request = {}, requestOptions) {
         var _a;
@@ -73,12 +69,7 @@ class Run {
             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"),
                 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.2.1",
-                },
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.RunCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -151,6 +142,10 @@ class Run {
     }
     /**
      * Retrieve a Run metadata
+     *
+     * @param {number} runId - The id of the run to retrieve.
+     * @param {Run.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
@@ -163,14 +158,9 @@ class Run {
         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}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.ScorecardEnvironment.Default, `v1/run/${encodeURIComponent(runId)}`),
                 method: "GET",
-                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.2.1",
-                },
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 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,
@@ -242,28 +232,26 @@ class Run {
     }
     /**
      * Update the status of a run.
+     *
+     * @param {number} runId - The id of the run to update.
+     * @param {Scorecard.UpdateStatusParams} request
+     * @param {Run.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.run.updateStatus(1, {
-     *         status: Scorecard.RunStatus.Pending
-     *     })
+     *     await scorecard.run.updateStatus(1)
      */
-    updateStatus(runId, request, requestOptions) {
+    updateStatus(runId, 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}/status`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.ScorecardEnvironment.Default, `v1/run/${encodeURIComponent(runId)}/status`),
                 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.2.1",
-                },
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.UpdateStatusParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -334,5 +322,12 @@ class Run {
             }
         });
     }
+    _getCustomAuthorizationHeaders() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["SCORECARD_API_KEY"];
+            return { "X-API-Key": apiKeyValue };
+        });
+    }
 }
 exports.Run = Run;

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

@@ -3,15 +3,7 @@
  */
 /**
  * @example
- *     {
- *         testsetId: 1,
- *         scoringConfigId: 2,
- *         status: "RUNNING_EXECUTION",
- *         modelParams: {
- *             "param1": "value1",
- *             "param2": "value2"
- *         }
- *     }
+ *     {}
  */
 export interface RunCreateParams {
     testsetId?: number;
@@ -21,4 +13,5 @@ export interface RunCreateParams {
     source?: string;
     notes?: string;
     promptTemplate?: string;
+    metrics?: number[];
 }

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

@@ -1,13 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Scorecard from "../../../..";
+import * as Scorecard from "../../../../index";
 /**
  * @example
- *     {
- *         status: Scorecard.RunStatus.Pending
- *     }
+ *     {}
  */
 export interface UpdateStatusParams {
-    status: Scorecard.RunStatus;
+    status?: Scorecard.RunStatus;
 }

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

@@ -1,2 +1,2 @@
-export { RunCreateParams } from "./RunCreateParams";
-export { UpdateStatusParams } from "./UpdateStatusParams";
+export { type RunCreateParams } from "./RunCreateParams";
+export { type UpdateStatusParams } from "./UpdateStatusParams";

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

@@ -0,0 +1,38 @@
+/**
+ * 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 "../../../index";
+export declare namespace RunMetric {
+    interface Options {
+        environment?: core.Supplier<environments.ScorecardEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class RunMetric {
+    protected readonly _options: RunMetric.Options;
+    constructor(_options: RunMetric.Options);
+    /**
+     * Retrieve metrics associated with a run
+     *
+     * @param {number} runId - The id of the run to retrieve.
+     * @param {RunMetric.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.runMetric.get(1)
+     */
+    get(runId: number, requestOptions?: RunMetric.RequestOptions): Promise<Scorecard.RunMetric[]>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-API-Key": string;
+    }>;
+}

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

@@ -0,0 +1,150 @@
+"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.RunMetric = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const Scorecard = __importStar(require("../../../index"));
+const url_join_1 = __importDefault(require("url-join"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
+class RunMetric {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Retrieve metrics associated with a run
+     *
+     * @param {number} runId - The id of the run to retrieve.
+     * @param {RunMetric.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.runMetric.get(1)
+     */
+    get(runId, 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_metric/${encodeURIComponent(runId)}`),
+                method: "GET",
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                contentType: "application/json",
+                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.runMetric.get.Response.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,
+                    });
+            }
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["SCORECARD_API_KEY"];
+            return { "X-API-Key": apiKeyValue };
+        });
+    }
+}
+exports.RunMetric = RunMetric;

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

@@ -0,0 +1 @@
+export {};

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

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

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

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

package/api/resources/runMetric/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/score/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Scorecard from "../../..";
+import * as Scorecard from "../../../index";
 export declare namespace Score {
     interface Options {
         environment?: core.Supplier<environments.ScorecardEnvironment | string>;
@@ -19,6 +19,12 @@ export declare class Score {
     constructor(_options: Score.Options);
     /**
      * Create a score
+     *
+     * @param {number} runId - The ID of the run that created the testrecord to be scored.
+     * @param {number} testrecordId - The ID of the testrecord to be scored.
+     * @param {Scorecard.ScoreCreateParams} request
+     * @param {Score.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
@@ -32,13 +38,23 @@ export declare class Score {
     create(runId: number, testrecordId: number, request: Scorecard.ScoreCreateParams, requestOptions?: Score.RequestOptions): Promise<Scorecard.Grade>;
     /**
      * Update a score
+     *
+     * @param {number} runId - The run ID that created the test record to be scored.
+     * @param {number} testrecordId - The ID of the testrecord whose score will be updated.
+     * @param {number} scoreId - The ID of the score to be updated.
+     * @param {Scorecard.ScoreUpdateParams} request
+     * @param {Score.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.score.update(1, 1, 1, {})
+     *     await scorecard.score.update(1, 1, 1)
      */
     update(runId: number, testrecordId: number, scoreId: number, request?: Scorecard.ScoreUpdateParams, requestOptions?: Score.RequestOptions): Promise<Scorecard.Grade>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-API-Key": string;
+    }>;
 }

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

@@ -41,16 +41,22 @@ 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 Scorecard = __importStar(require("../../../index"));
+const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class Score {
     constructor(_options) {
         this._options = _options;
     }
     /**
      * Create a score
+     *
+     * @param {number} runId - The ID of the run that created the testrecord to be scored.
+     * @param {number} testrecordId - The ID of the testrecord to be scored.
+     * @param {Scorecard.ScoreCreateParams} request
+     * @param {Score.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
@@ -65,14 +71,9 @@ class Score {
         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`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.ScorecardEnvironment.Default, `v1/run/${encodeURIComponent(runId)}/testrecord/${encodeURIComponent(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.2.1",
-                },
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 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,
@@ -145,26 +146,28 @@ class Score {
     }
     /**
      * Update a score
+     *
+     * @param {number} runId - The run ID that created the test record to be scored.
+     * @param {number} testrecordId - The ID of the testrecord whose score will be updated.
+     * @param {number} scoreId - The ID of the score to be updated.
+     * @param {Scorecard.ScoreUpdateParams} request
+     * @param {Score.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.score.update(1, 1, 1, {})
+     *     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}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.ScorecardEnvironment.Default, `v1/run/${encodeURIComponent(runId)}/testrecord/${encodeURIComponent(testrecordId)}/score/${encodeURIComponent(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.2.1",
-                },
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 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,
@@ -235,5 +238,12 @@ class Score {
             }
         });
     }
+    _getCustomAuthorizationHeaders() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["SCORECARD_API_KEY"];
+            return { "X-API-Key": apiKeyValue };
+        });
+    }
 }
 exports.Score = Score;

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

@@ -8,6 +8,7 @@
  *     }
  */
 export interface ScoreCreateParams {
+    /** The ID of the metric */
     metricId: number;
     intScore?: number;
     binaryScore?: boolean;

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

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