scorecard-ai 0.1.10 → 0.1.12

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

@@ -55,6 +55,9 @@ class Testrecord {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testrecord.get(1, 1)
      */
     get(testrecordId, runId, requestOptions) {
         var _a;
@@ -66,7 +69,7 @@ class Testrecord {
                     "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,
@@ -143,8 +146,11 @@ class Testrecord {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testrecord.create(1, {})
      */
-    create(runId, request, requestOptions) {
+    create(runId, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
@@ -154,7 +160,7 @@ class Testrecord {
                     "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.TestrecordCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

package/api/resources/testrecord/client/requests/TestrecordCreateParams.d.ts

@@ -2,14 +2,21 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Scorecard from "../../../..";
+/**
+ * @example
+ *     {}
+ */
 export interface TestrecordCreateParams {
-    testsetId: number;
-    testcaseId: number;
-    userQuery: string;
+    testsetId?: number;
+    testcaseId?: number;
+    userQuery?: string;
     context?: string;
     response?: string;
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestrecordCreateParamsCustomInputsValue | undefined>;
     customOutputs?: Record<string, Scorecard.TestrecordCreateParamsCustomOutputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestrecordCreateParamsCustomLabelsValue | undefined>;
+    prompt?: string;
+    modelParams?: Record<string, Scorecard.TestrecordCreateParamsModelParamsValue | undefined>;
+    modelDebugInfo?: Record<string, Scorecard.TestrecordCreateParamsModelDebugInfoValue | undefined>;
 }

package/api/resources/testrecord/types/TestrecordCreateParamsModelDebugInfoValue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type TestrecordCreateParamsModelDebugInfoValue = number | number | string;

package/api/resources/testrecord/types/TestrecordCreateParamsModelParamsValue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type TestrecordCreateParamsModelParamsValue = number | number | string;

package/api/resources/testrecord/types/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./TestrecordCreateParamsCustomInputsValue";
 export * from "./TestrecordCreateParamsCustomOutputsValue";
 export * from "./TestrecordCreateParamsCustomLabelsValue";
+export * from "./TestrecordCreateParamsModelParamsValue";
+export * from "./TestrecordCreateParamsModelDebugInfoValue";

package/api/resources/testrecord/types/index.js

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./TestrecordCreateParamsCustomInputsValue"), exports);
 __exportStar(require("./TestrecordCreateParamsCustomOutputsValue"), exports);
 __exportStar(require("./TestrecordCreateParamsCustomLabelsValue"), exports);
+__exportStar(require("./TestrecordCreateParamsModelParamsValue"), exports);
+__exportStar(require("./TestrecordCreateParamsModelDebugInfoValue"), exports);

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

@@ -18,7 +18,7 @@ export declare class Testset {
     protected readonly _options: Testset.Options;
     constructor(_options: Testset.Options);
     /**
-     * Retrieve Testset metadata without Testcase data.
+     * Retrieve Testset metadata without Testcase data
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
@@ -45,25 +45,33 @@ export declare class Testset {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testset.create({
+     *         name: "name"
+     *     })
      */
     create(request: Scorecard.TestsetCreateParams, requestOptions?: Testset.RequestOptions): Promise<Scorecard.Testset>;
     /**
-     * Read the schema of a Testset.
+     * Read the schema of a Testset
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.testset.getSchema(1)
+     *     await scorecard.testset.readSchema(1)
      */
-    getSchema(testsetId: number, requestOptions?: Testset.RequestOptions): Promise<Scorecard.CustomSchemaOutput>;
+    readSchema(testsetId: number, requestOptions?: Testset.RequestOptions): Promise<Scorecard.CustomSchema>;
     /**
      * Retrieve all Testcases from a Testset
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testset.getTestcases(1, {})
      */
     getTestcases(testsetId: number, request?: Scorecard.TestsetGetTestcasesRequest, requestOptions?: Testset.RequestOptions): Promise<Scorecard.PaginatedTestcaseResponse>;
 }

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

@@ -50,7 +50,7 @@ class Testset {
         this._options = _options;
     }
     /**
-     * Retrieve Testset metadata without Testcase data.
+     * Retrieve Testset metadata without Testcase data
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
@@ -69,7 +69,7 @@ class Testset {
                     "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,
@@ -160,7 +160,7 @@ class Testset {
                     "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,
@@ -237,6 +237,11 @@ class Testset {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testset.create({
+     *         name: "name"
+     *     })
      */
     create(request, requestOptions) {
         var _a;
@@ -248,7 +253,7 @@ class Testset {
                     "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.TestsetCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -321,16 +326,16 @@ class Testset {
         });
     }
     /**
-     * Read the schema of a Testset.
+     * Read the schema of a Testset
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.testset.getSchema(1)
+     *     await scorecard.testset.readSchema(1)
      */
-    getSchema(testsetId, requestOptions) {
+    readSchema(testsetId, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
@@ -340,14 +345,14 @@ class Testset {
                     "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,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             });
             if (_response.ok) {
-                return yield serializers.CustomSchemaOutput.parseOrThrow(_response.body, {
+                return yield serializers.CustomSchema.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -417,17 +422,20 @@ class Testset {
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
      * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.testset.getTestcases(1, {})
      */
     getTestcases(testsetId, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const { page, pageSize } = request;
+            const { offset, limit } = request;
             const _queryParams = {};
-            if (page != null) {
-                _queryParams["page"] = page.toString();
+            if (offset != null) {
+                _queryParams["offset"] = offset.toString();
             }
-            if (pageSize != null) {
-                _queryParams["page_size"] = pageSize.toString();
+            if (limit != null) {
+                _queryParams["limit"] = limit.toString();
             }
             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/testset/${testsetId}/testcase`),
@@ -436,7 +444,7 @@ class Testset {
                     "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",
                 queryParameters: _queryParams,

package/api/resources/testset/client/requests/TestsetCreateParams.d.ts

@@ -2,9 +2,15 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Scorecard from "../../../..";
+/**
+ * @example
+ *     {
+ *         name: "name"
+ *     }
+ */
 export interface TestsetCreateParams {
     name: string;
     description?: string;
-    usingRetrieval: boolean;
-    customSchema?: Scorecard.CustomSchemaInput;
+    usingRetrieval?: boolean;
+    customSchema?: Scorecard.CustomSchema;
 }

package/api/resources/testset/client/requests/TestsetGetTestcasesRequest.d.ts

@@ -1,7 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {}
+ */
 export interface TestsetGetTestcasesRequest {
-    page?: number;
-    pageSize?: number;
+    offset?: number;
+    limit?: number;
 }

package/api/types/{LibDtoTypesCreateRunParams.d.ts → CreateGithubWorkflowParams.d.ts}

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type LibDtoTypesCreateRunParams = unknown;
+export declare type CreateGithubWorkflowParams = unknown;

package/api/types/CreateRunParams.d.ts

@@ -1,9 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface CreateRunParams {
-    testsetId: number;
-    scoringConfigId: number;
-    status?: string;
-    modelParams?: Record<string, unknown>;
-}
+export declare type CreateRunParams = unknown;

package/{dist/api/types/CustomSchemaInput.d.ts → api/types/CustomSchema.d.ts}

@@ -5,7 +5,7 @@ import * as Scorecard from "..";
 /**
  * Custom schema model with an ordered list of custom variables.
  */
-export interface CustomSchemaInput {
+export interface CustomSchema {
     /** Ordered list of custom variables */
     variables?: Scorecard.CustomVariable[];
 }

package/api/types/Grade.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Grade {
+    id?: number;
+    runId?: number;
+    testcaseId?: number;
+    testrecordId?: number;
+    metricId?: number;
+    binaryScore?: boolean;
+    intScore?: number;
+    reasoning?: string;
+    humanEval?: boolean;
+}

package/api/types/RunStatus.d.ts

@@ -1,12 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type RunStatus = "pending" | "awaiting_execution" | "running_execution" | "awaiting_scoring" | "running_scoring" | "completed";
+export declare type RunStatus = "pending" | "awaiting_execution" | "running_execution" | "awaiting_scoring" | "running_scoring" | "awaiting_human_scoring" | "completed";
 export declare const RunStatus: {
     readonly Pending: "pending";
     readonly AwaitingExecution: "awaiting_execution";
     readonly RunningExecution: "running_execution";
     readonly AwaitingScoring: "awaiting_scoring";
     readonly RunningScoring: "running_scoring";
+    readonly AwaitingHumanScoring: "awaiting_human_scoring";
     readonly Completed: "completed";
 };

package/api/types/RunStatus.js

@@ -10,5 +10,6 @@ exports.RunStatus = {
     RunningExecution: "running_execution",
     AwaitingScoring: "awaiting_scoring",
     RunningScoring: "running_scoring",
+    AwaitingHumanScoring: "awaiting_human_scoring",
     Completed: "completed",
 };

package/api/types/TestRecordCreate.d.ts

@@ -1,16 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface TestRecordCreate {
-    runId: number;
-    testcaseId: number;
-    modelResponse: string;
-    userQuery?: string;
-    context?: string;
-    prompt?: string;
-    ideal?: string;
-    debugOutput?: string;
-    modelParams?: Record<string, unknown>;
-    testsetId?: number;
-    status?: string;
-}
+export declare type TestRecordCreate = unknown;

package/api/types/TestSetCreate.d.ts

@@ -1,8 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface TestSetCreate {
-    name: string;
-    description?: string;
-    usingRetrieval: boolean;
-}
+export declare type TestSetCreate = unknown;

package/api/types/Testrecord.d.ts

@@ -6,8 +6,9 @@ export interface Testrecord {
     id?: number;
     createdAt?: Date;
     runId: number;
-    testsetId: number;
-    userQuery: string;
+    testsetId?: number;
+    testcaseId?: number;
+    userQuery?: string;
     context?: string;
     modelResponse?: string;
     ideal?: string;
@@ -15,4 +16,8 @@ export interface Testrecord {
     customInputs?: Record<string, Scorecard.TestrecordCustomInputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestrecordCustomLabelsValue | undefined>;
     customOutputs?: Record<string, Scorecard.TestrecordCustomOutputsValue | undefined>;
+    status?: string;
+    prompt?: string;
+    modelParams?: Record<string, Scorecard.TestrecordModelParamsValue | undefined>;
+    modelDebugInfo?: Record<string, Scorecard.TestrecordModelDebugInfoValue | undefined>;
 }

package/api/types/TestrecordModelDebugInfoValue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type TestrecordModelDebugInfoValue = number | number | string;

package/api/types/TestrecordModelParamsValue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type TestrecordModelParamsValue = number | number | string;

package/api/types/Testset.d.ts

@@ -14,5 +14,5 @@ export interface Testset {
     updatedAt?: Date;
     isArchived?: boolean;
     projectId?: number;
-    customSchema?: Scorecard.CustomSchemaOutput;
+    customSchema?: Scorecard.CustomSchema;
 }

package/api/types/index.d.ts

@@ -1,9 +1,9 @@
 export * from "./CreateRunParams";
-export * from "./CustomSchemaInput";
-export * from "./CustomSchemaOutput";
+export * from "./CustomSchema";
 export * from "./CustomVariable";
 export * from "./DataTypeEnum";
 export * from "./FileUrl";
+export * from "./Grade";
 export * from "./HttpValidationError";
 export * from "./NotFoundErrorBody";
 export * from "./PaginatedTestcaseResponse";
@@ -19,13 +19,15 @@ export * from "./TestSetCreate";
 export * from "./TestrecordCustomInputsValue";
 export * from "./TestrecordCustomLabelsValue";
 export * from "./TestrecordCustomOutputsValue";
+export * from "./TestrecordModelParamsValue";
+export * from "./TestrecordModelDebugInfoValue";
 export * from "./Testrecord";
 export * from "./Testset";
 export * from "./UnauthenticatedError";
 export * from "./UnauthorizedErrorBody";
 export * from "./ValidationErrorLocItem";
 export * from "./ValidationError";
-export * from "./BodyStartGithubWorkflowStartGithubWorkflowPost";
+export * from "./CreateGithubWorkflowParams";
 export * from "./ExecutionParams";
 export * from "./ModelParams";
 export * from "./ScoreExecutionParams";
@@ -34,6 +36,3 @@ export * from "./TestCaseCreateInput";
 export * from "./AppCreateRunParams";
 export * from "./AppTestRecordCreate";
 export * from "./AppTestSetCreate";
-export * from "./LibDtoTypesCreateRunParams";
-export * from "./LibDtoTypesTestRecordCreate";
-export * from "./LibDtoTypesTestSetCreate";

package/api/types/index.js

@@ -15,11 +15,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CreateRunParams"), exports);
-__exportStar(require("./CustomSchemaInput"), exports);
-__exportStar(require("./CustomSchemaOutput"), exports);
+__exportStar(require("./CustomSchema"), exports);
 __exportStar(require("./CustomVariable"), exports);
 __exportStar(require("./DataTypeEnum"), exports);
 __exportStar(require("./FileUrl"), exports);
+__exportStar(require("./Grade"), exports);
 __exportStar(require("./HttpValidationError"), exports);
 __exportStar(require("./NotFoundErrorBody"), exports);
 __exportStar(require("./PaginatedTestcaseResponse"), exports);
@@ -35,13 +35,15 @@ __exportStar(require("./TestSetCreate"), exports);
 __exportStar(require("./TestrecordCustomInputsValue"), exports);
 __exportStar(require("./TestrecordCustomLabelsValue"), exports);
 __exportStar(require("./TestrecordCustomOutputsValue"), exports);
+__exportStar(require("./TestrecordModelParamsValue"), exports);
+__exportStar(require("./TestrecordModelDebugInfoValue"), exports);
 __exportStar(require("./Testrecord"), exports);
 __exportStar(require("./Testset"), exports);
 __exportStar(require("./UnauthenticatedError"), exports);
 __exportStar(require("./UnauthorizedErrorBody"), exports);
 __exportStar(require("./ValidationErrorLocItem"), exports);
 __exportStar(require("./ValidationError"), exports);
-__exportStar(require("./BodyStartGithubWorkflowStartGithubWorkflowPost"), exports);
+__exportStar(require("./CreateGithubWorkflowParams"), exports);
 __exportStar(require("./ExecutionParams"), exports);
 __exportStar(require("./ModelParams"), exports);
 __exportStar(require("./ScoreExecutionParams"), exports);
@@ -50,6 +52,3 @@ __exportStar(require("./TestCaseCreateInput"), exports);
 __exportStar(require("./AppCreateRunParams"), exports);
 __exportStar(require("./AppTestRecordCreate"), exports);
 __exportStar(require("./AppTestSetCreate"), exports);
-__exportStar(require("./LibDtoTypesCreateRunParams"), exports);
-__exportStar(require("./LibDtoTypesTestRecordCreate"), exports);
-__exportStar(require("./LibDtoTypesTestSetCreate"), exports);

package/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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" }),