scorecard-ai 0.5.3 → 0.6.0

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

@@ -10,7 +10,15 @@ import * as Scorecard from "../../../../index";
  */
 export interface TestsetCreateParams {
     name: string;
+    /** A description for the testset. */
     description?: string;
+    /** Whether or not the testset uses retrieval. */
     usingRetrieval?: boolean;
     customSchema?: Scorecard.CustomSchema;
+    /** The ID of the project to create the testset in. Omitting this optional argument will create the testset inside your Organization's default project. */
+    projectId?: number;
+    /** The method of ingestion for the testset. */
+    ingestionMethod?: Scorecard.IngestionMethod;
+    /** Whether or not the testset is published. */
+    published?: boolean;
 }

package/dist/api/resources/testset/client/requests/TestsetUpdateParams.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Scorecard from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface TestsetUpdateParams {
+    name?: string;
+    /** A description for the testset. */
+    description?: string;
+    /** Whether or not the testset uses retrieval. */
+    usingRetrieval?: boolean;
+    customSchema?: Scorecard.CustomSchema;
+}

package/dist/api/resources/testset/client/requests/TestsetUpdateParams.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/testset/client/requests/index.d.ts

@@ -1,2 +1,3 @@
+export { type TestsetUpdateParams } from "./TestsetUpdateParams";
 export { type TestsetCreateParams } from "./TestsetCreateParams";
 export { type TestsetGetTestcasesRequest } from "./TestsetGetTestcasesRequest";

package/dist/api/resources/tracing/client/Client.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 Tracing {
+    interface Options {
+        environment?: core.Supplier<environments.ScorecardEnvironment | string>;
+        apiKey: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Tracing {
+    protected readonly _options: Tracing.Options;
+    constructor(_options: Tracing.Options);
+    /**
+     * Retrieve traces
+     *
+     * @param {Tracing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     *
+     * @example
+     *     await client.tracing.traces()
+     */
+    traces(requestOptions?: Tracing.RequestOptions): Promise<Scorecard.Trace[]>;
+    /**
+     * Retrieve specified trace
+     *
+     * @param {string} traceId - The ID of the trace to retrieve spans from.
+     * @param {Tracing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracing.trace("trace_id")
+     */
+    trace(traceId: string, requestOptions?: Tracing.RequestOptions): Promise<Scorecard.Trace>;
+    /**
+     * Retrieve specified span
+     *
+     * @param {string} traceId - The ID of the trace which the span is a part of.
+     * @param {string} spanId - The ID of the span to retrieve.
+     * @param {Tracing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracing.span("trace_id", "span_id")
+     */
+    span(traceId: string, spanId: string, requestOptions?: Tracing.RequestOptions): Promise<Scorecard.Span>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-API-Key": string;
+    }>;
+}

package/dist/api/resources/tracing/client/Client.js

@@ -0,0 +1,327 @@
+"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.Tracing = 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 Tracing {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Retrieve traces
+     *
+     * @param {Tracing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     *
+     * @example
+     *     await client.tracing.traces()
+     */
+    traces(requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, "v1/traces"),
+                method: "GET",
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.6.0", "User-Agent": "scorecard-ai/0.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                contentType: "application/json",
+                requestType: "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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.tracing.traces.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(serializers.UnauthenticatedError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 403:
+                        throw new Scorecard.ForbiddenError(serializers.UnauthorizedErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 404:
+                        throw new Scorecard.NotFoundError(serializers.NotFoundErrorBody.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,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieve specified trace
+     *
+     * @param {string} traceId - The ID of the trace to retrieve spans from.
+     * @param {Tracing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracing.trace("trace_id")
+     */
+    trace(traceId, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/traces/${encodeURIComponent(traceId)}`),
+                method: "GET",
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.6.0", "User-Agent": "scorecard-ai/0.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                contentType: "application/json",
+                requestType: "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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.Trace.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(serializers.UnauthenticatedError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 403:
+                        throw new Scorecard.ForbiddenError(serializers.UnauthorizedErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 404:
+                        throw new Scorecard.NotFoundError(serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 422:
+                        throw new Scorecard.UnprocessableEntityError(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,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieve specified span
+     *
+     * @param {string} traceId - The ID of the trace which the span is a part of.
+     * @param {string} spanId - The ID of the span to retrieve.
+     * @param {Tracing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracing.span("trace_id", "span_id")
+     */
+    span(traceId, spanId, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/traces/${encodeURIComponent(traceId)}/spans/${encodeURIComponent(spanId)}`),
+                method: "GET",
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.6.0", "User-Agent": "scorecard-ai/0.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                contentType: "application/json",
+                requestType: "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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.Span.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(serializers.UnauthenticatedError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 403:
+                        throw new Scorecard.ForbiddenError(serializers.UnauthorizedErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 404:
+                        throw new Scorecard.NotFoundError(serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 422:
+                        throw new Scorecard.UnprocessableEntityError(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.Tracing = Tracing;

package/dist/api/resources/tracing/client/index.js

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

package/dist/api/types/Grade.d.ts

@@ -4,19 +4,30 @@
 import * as Scorecard from "../index";
 export interface Grade {
     userId?: string;
+    /** The ID of the grade. */
     id?: number;
+    /** The ID of the run that created the grade. */
     runId?: number;
+    /** The ID of the testcase associated with the grade. */
     testcaseId?: number;
+    /** The ID of the testrecord for which the grade was created. */
     testrecordId?: number;
+    /** The ID of the metric used to compute the grade. */
     metricId?: number;
+    /** The binary score assigned to the grade. */
     binaryScore?: boolean;
+    /** The integer score assigned to the grade. */
     intScore?: number;
+    /** The reasoning for the assigned score. */
     reasoning?: string;
     /** Indicates if a human should assign a grade. */
     humanEval?: boolean;
     /** The status of the grade. */
     status?: Scorecard.ScoreStatus;
+    /** The error message if the grade was not created successfully. */
     errorMessage?: string;
+    /** when the grade was created. */
     createdAt?: Date;
+    /** when the grade was last updated. */
     updatedAt?: Date;
 }

package/dist/api/types/IngestionMethod.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type IngestionMethod = "csv" | "logging";
+export declare const IngestionMethod: {
+    readonly Csv: "csv";
+    readonly Logging: "logging";
+};

package/dist/api/types/IngestionMethod.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IngestionMethod = void 0;
+exports.IngestionMethod = {
+    Csv: "csv",
+    Logging: "logging",
+};

package/dist/api/types/PaginatedTestcaseResponse.d.ts

@@ -4,7 +4,9 @@
 import * as Scorecard from "../index";
 export interface PaginatedTestcaseResponse {
     count: number;
+    /** The URL to fetch the next page of testcases. */
     next?: string;
+    /** The URL to fetch the previous page of testcases. */
     previous?: string;
     /** The list of Testcases retrieved in this page. */
     results: Scorecard.TestCase[];

package/dist/api/types/Prompt.d.ts

@@ -3,7 +3,9 @@
  */
 import * as Scorecard from "../index";
 export interface Prompt {
+    /** The organization this resource belongs to. */
     orgId?: string;
+    /** The user this record belongs to. */
     userId?: string;
     id?: string;
     name?: string;

package/dist/api/types/Run.d.ts

@@ -3,18 +3,32 @@
  */
 export interface Run {
     id?: number;
+    /** The creation date and time of the run. */
     createdAt?: Date;
+    /** The last time the run was updated. */
     updatedAt?: Date;
+    /** The start time of the run. */
     executionStartTime?: Date;
+    /** The end time of the run. */
     executionEndTime?: Date;
+    /** The testset that was executed in this run. */
     testsetId?: number;
+    /** The current status of the run. */
     status?: string;
+    /** The maximum number of testcases to run. */
     limitTestcases?: number;
+    /** How the run was created. */
     source?: string;
+    /** The model parameters used when generating the run. */
     modelParams?: Record<string, unknown>;
+    /** Notes about the run. */
     notes?: string;
+    /** The ID of the scoring configuration the run uses. */
     scoringConfigId?: number;
+    /** The prompt template to be used while executing the run. */
     promptTemplate?: string;
+    /** The start time of scoring the run's results. */
     scoringStartTime?: Date;
+    /** The end time of scoring the run's results. */
     scoringEndTime?: Date;
 }

package/dist/api/types/ScoringConfig.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ScoringConfig {
+    /** The organization this resource belongs to. */
+    orgId?: string;
+    /** The user this record belongs to. */
+    userId?: string;
+    id?: number;
+    name?: string;
+    description?: string;
+    config?: Record<string, unknown>;
+    isArchived?: boolean;
+    metrics?: number[];
+    createdAt?: Date;
+}

package/dist/api/types/ScoringConfig.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/TestCase.d.ts

@@ -3,13 +3,17 @@
  */
 import * as Scorecard from "../index";
 export interface TestCase {
+    /** The ID of the testcase. */
     id?: number;
+    /** The creation date and time of the testcase. */
     createdAt?: Date;
     /** The ID of the testset the testcase belongs to. */
     testsetId: number;
     /** The user query for the testcase. */
     userQuery: string;
+    /** The context for the testcase. */
     context?: string;
+    /** The ideal response for the testcase. */
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestCaseCustomInputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestCaseCustomLabelsValue | undefined>;

package/dist/api/types/TestcaseBatchDeletionResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TestcaseBatchDeletionResponse {
+    /** The IDs of the testcases that were deleted. */
+    ids: number[];
+    /** The message indicating the testcases were deleted. */
+    detail: string;
+}

package/dist/api/types/TestcaseBatchDeletionResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/Testrecord.d.ts

@@ -4,19 +4,33 @@
 import * as Scorecard from "../index";
 export interface Testrecord {
     id?: number;
+    /** The creation date and time of the testrecord. */
     createdAt?: Date;
+    /** The ID of the run the testrecord belongs to. */
     runId?: number;
+    /** The ID of the testset the testrecord belongs to. */
     testsetId?: number;
+    /** The ID of the testcase the testrecord belongs to. */
     testcaseId?: number;
+    /** The user query for the testrecord. */
     userQuery?: string;
+    /** The context for the testrecord. */
     context?: string;
+    /** The actual response of the model for the testrecord. */
     modelResponse?: string;
+    /** The ideal response for the testrecord. */
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestrecordCustomInputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestrecordCustomLabelsValue | undefined>;
     customOutputs?: Record<string, Scorecard.TestrecordCustomOutputsValue | undefined>;
+    /** The current status of the testrecord. */
     status?: string;
+    /** The prompt used to generate the testrecord. */
     prompt?: string;
+    /** The model parameters used when generating the testrecord. */
     modelParams?: Record<string, Scorecard.TestrecordModelParamsValue | undefined>;
+    /** Debug information produced during the testrecord's generation. */
     modelDebugInfo?: Record<string, Scorecard.TestrecordModelDebugInfoValue | undefined>;
+    /** The error message for the testrecord. */
+    errorMessage?: string;
 }