scorecard-ai 0.3.0 → 0.4.0

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

@@ -52,8 +52,8 @@ class Score {
     /**
      * Create a score
      *
-     * @param {number} runId
-     * @param {number} testrecordId
+     * @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.
      *
@@ -73,7 +73,7 @@ class Score {
             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/${encodeURIComponent(runId)}/testrecord/${encodeURIComponent(testrecordId)}/score`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,
@@ -147,9 +147,9 @@ class Score {
     /**
      * Update a score
      *
-     * @param {number} runId
-     * @param {number} testrecordId
-     * @param {number} scoreId
+     * @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.
      *
@@ -167,7 +167,7 @@ class Score {
             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/${encodeURIComponent(runId)}/testrecord/${encodeURIComponent(testrecordId)}/score/${encodeURIComponent(scoreId)}`),
                 method: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,

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/testcase/client/Client.d.ts

@@ -20,7 +20,7 @@ export declare class Testcase {
     /**
      * Create a new Testcase
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to create the Testcase in.
      * @param {Scorecard.TestcaseCreateParams} request
      * @param {Testcase.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -30,16 +30,14 @@ export declare class Testcase {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.testcase.create(1, {
-     *         userQuery: "user_query"
-     *     })
+     *     await scorecard.testcase.create(1)
      */
-    create(testsetId: number, request: Scorecard.TestcaseCreateParams, requestOptions?: Testcase.RequestOptions): Promise<Scorecard.TestCase>;
+    create(testsetId: number, request?: Scorecard.TestcaseCreateParams, requestOptions?: Testcase.RequestOptions): Promise<Scorecard.TestCase>;
     /**
      * Retrieve Testcase data
      *
-     * @param {number} testcaseId
-     * @param {number} testsetId
+     * @param {number} testcaseId - The ID of the Testcase to retrieve.
+     * @param {number} testsetId - The ID of the Testset to retrieve the Testcase from.
      * @param {Testcase.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -54,8 +52,8 @@ export declare class Testcase {
     /**
      * Delete a Testcase
      *
-     * @param {number} testcaseId
-     * @param {number} testsetId
+     * @param {number} testcaseId - The ID of the Testcase to delete.
+     * @param {number} testsetId - The ID of the Testset to delete the Testcase from.
      * @param {Testcase.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -66,7 +64,7 @@ export declare class Testcase {
      * @example
      *     await scorecard.testcase.delete(1, 1)
      */
-    delete(testcaseId: number, testsetId: number, requestOptions?: Testcase.RequestOptions): Promise<unknown>;
+    delete(testcaseId: number, testsetId: number, requestOptions?: Testcase.RequestOptions): Promise<Scorecard.TestcaseDeletionResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-API-Key": string;
     }>;

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

@@ -52,7 +52,7 @@ class Testcase {
     /**
      * Create a new Testcase
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to create the Testcase in.
      * @param {Scorecard.TestcaseCreateParams} request
      * @param {Testcase.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -62,17 +62,15 @@ class Testcase {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.testcase.create(1, {
-     *         userQuery: "user_query"
-     *     })
+     *     await scorecard.testcase.create(1)
      */
-    create(testsetId, request, requestOptions) {
+    create(testsetId, 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/testset/${encodeURIComponent(testsetId)}/testcase`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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.TestcaseCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -146,8 +144,8 @@ class Testcase {
     /**
      * Retrieve Testcase data
      *
-     * @param {number} testcaseId
-     * @param {number} testsetId
+     * @param {number} testcaseId - The ID of the Testcase to retrieve.
+     * @param {number} testsetId - The ID of the Testset to retrieve the Testcase from.
      * @param {Testcase.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -164,7 +162,7 @@ class Testcase {
             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/${encodeURIComponent(testsetId)}/testcase/${encodeURIComponent(testcaseId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,
@@ -237,8 +235,8 @@ class Testcase {
     /**
      * Delete a Testcase
      *
-     * @param {number} testcaseId
-     * @param {number} testsetId
+     * @param {number} testcaseId - The ID of the Testcase to delete.
+     * @param {number} testsetId - The ID of the Testset to delete the Testcase from.
      * @param {Testcase.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -255,13 +253,19 @@ class Testcase {
             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/${encodeURIComponent(testsetId)}/testcase/${encodeURIComponent(testcaseId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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 _response.body;
+                return yield serializers.TestcaseDeletionResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                });
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {

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

@@ -4,12 +4,11 @@
 import * as Scorecard from "../../../../index";
 /**
  * @example
- *     {
- *         userQuery: "user_query"
- *     }
+ *     {}
  */
 export interface TestcaseCreateParams {
-    userQuery: string;
+    /** The user query to be executed. */
+    userQuery?: string;
     context?: string;
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestcaseCreateParamsCustomInputsValue | undefined>;

package/api/resources/testcase/types/TestcaseCreateParamsCustomInputsValue.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Scorecard from "../../../index";
-export declare type TestcaseCreateParamsCustomInputsValue = string | Scorecard.FileUrl | Scorecard.JsonObject;
+export declare type TestcaseCreateParamsCustomInputsValue = Scorecard.FileUrl | Scorecard.JsonObject | string | number | number | boolean;

package/api/resources/testcase/types/TestcaseCreateParamsCustomLabelsValue.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Scorecard from "../../../index";
-export declare type TestcaseCreateParamsCustomLabelsValue = string | Scorecard.FileUrl | Scorecard.JsonObject;
+export declare type TestcaseCreateParamsCustomLabelsValue = Scorecard.FileUrl | Scorecard.JsonObject | string | number | number | boolean;

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

@@ -36,7 +36,7 @@ export declare class Testrecord {
     /**
      * Create a new Testrecord
      *
-     * @param {number} runId
+     * @param {number} runId - The ID of the Run to create the Testrecord in.
      * @param {Scorecard.TestrecordCreateParams} request
      * @param {Testrecord.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -70,7 +70,7 @@ class Testrecord {
             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/${encodeURIComponent(runId)}/testrecord/${encodeURIComponent(testrecordId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,
@@ -143,7 +143,7 @@ class Testrecord {
     /**
      * Create a new Testrecord
      *
-     * @param {number} runId
+     * @param {number} runId - The ID of the Run to create the Testrecord in.
      * @param {Scorecard.TestrecordCreateParams} request
      * @param {Testrecord.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -161,7 +161,7 @@ class Testrecord {
             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/${encodeURIComponent(runId)}/testrecord`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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.TestrecordCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -20,7 +20,7 @@ export declare class Testset {
     /**
      * Retrieve Testset metadata without Testcase data
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to retrieve.
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -35,7 +35,7 @@ export declare class Testset {
     /**
      * Delete a Testset
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to delete.
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -67,7 +67,7 @@ export declare class Testset {
     /**
      * Read the schema of a Testset
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to retrieve the schema from.
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -82,7 +82,7 @@ export declare class Testset {
     /**
      * Retrieve all Testcases from a Testset
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The Testset ID to retrieve testcases from.
      * @param {Scorecard.TestsetGetTestcasesRequest} request
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -52,7 +52,7 @@ class Testset {
     /**
      * Retrieve Testset metadata without Testcase data
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to retrieve.
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -69,7 +69,7 @@ class Testset {
             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/${encodeURIComponent(testsetId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,
@@ -142,7 +142,7 @@ class Testset {
     /**
      * Delete a Testset
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to delete.
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -159,7 +159,7 @@ class Testset {
             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/${encodeURIComponent(testsetId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,
@@ -251,7 +251,7 @@ class Testset {
             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"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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.TestsetCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -325,7 +325,7 @@ class Testset {
     /**
      * Read the schema of a Testset
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The ID of the Testset to retrieve the schema from.
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -342,7 +342,7 @@ class Testset {
             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/${encodeURIComponent(testsetId)}/schema`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,
@@ -415,7 +415,7 @@ class Testset {
     /**
      * Retrieve all Testcases from a Testset
      *
-     * @param {number} testsetId
+     * @param {number} testsetId - The Testset ID to retrieve testcases from.
      * @param {Scorecard.TestsetGetTestcasesRequest} request
      * @param {Testset.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -441,7 +441,7 @@ class Testset {
             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/${encodeURIComponent(testsetId)}/testcase`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -6,6 +6,12 @@
  *     {}
  */
 export interface TestsetGetTestcasesRequest {
+    /**
+     * The offset to start from.
+     */
     offset?: number;
+    /**
+     * The number of testcases to return.
+     */
     limit?: number;
 }

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

@@ -69,7 +69,7 @@ class Traces {
             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/traces/${encodeURIComponent(traceId)}/spans`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.3.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                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,

package/api/types/Grade.d.ts

@@ -12,7 +12,9 @@ export interface Grade {
     binaryScore?: boolean;
     intScore?: number;
     reasoning?: string;
+    /** Indicates if a human should assign a grade. */
     humanEval?: boolean;
+    /** The status of the grade. */
     status?: Scorecard.ScoreStatus;
     errorMessage?: string;
     createdAt?: Date;

package/api/types/PaginatedTestcaseResponse.d.ts

@@ -6,5 +6,6 @@ export interface PaginatedTestcaseResponse {
     count: number;
     next?: string;
     previous?: string;
+    /** The list of Testcases retrieved in this page. */
     results: Scorecard.TestCase[];
 }

package/api/types/TestCase.d.ts

@@ -5,7 +5,9 @@ import * as Scorecard from "../index";
 export interface TestCase {
     id?: number;
     createdAt?: Date;
+    /** The ID of the testset the testcase belongs to. */
     testsetId: number;
+    /** The user query for the testcase. */
     userQuery: string;
     context?: string;
     ideal?: string;

package/api/types/TestCaseCustomInputsValue.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Scorecard from "../index";
-export declare type TestCaseCustomInputsValue = string | Scorecard.FileUrl | Scorecard.JsonObject;
+export declare type TestCaseCustomInputsValue = Scorecard.FileUrl | Scorecard.JsonObject | string | number | number | boolean;

package/api/types/TestCaseCustomLabelsValue.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Scorecard from "../index";
-export declare type TestCaseCustomLabelsValue = string | Scorecard.FileUrl | Scorecard.JsonObject;
+export declare type TestCaseCustomLabelsValue = Scorecard.FileUrl | Scorecard.JsonObject | string | number | number | boolean;

package/api/types/TestcaseDeletionResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TestcaseDeletionResponse {
+    /** The ID of the testcase that was deleted. */
+    id: number;
+    /** The message indicating the testcase was deleted. */
+    detail: string;
+}

package/api/types/TestcaseDeletionResponse.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/api/types/Testrecord.d.ts

@@ -12,7 +12,6 @@ export interface Testrecord {
     context?: string;
     modelResponse?: string;
     ideal?: string;
-    fullPrompt?: string;
     customInputs?: Record<string, Scorecard.TestrecordCustomInputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestrecordCustomLabelsValue | undefined>;
     customOutputs?: Record<string, Scorecard.TestrecordCustomOutputsValue | undefined>;

package/api/types/index.d.ts

@@ -24,6 +24,7 @@ export * from "./TestCase";
 export * from "./TestCaseCreate";
 export * from "./TestRecordCreate";
 export * from "./TestSetCreate";
+export * from "./TestcaseDeletionResponse";
 export * from "./TestrecordCustomInputsValue";
 export * from "./TestrecordCustomLabelsValue";
 export * from "./TestrecordCustomOutputsValue";

package/api/types/index.js

@@ -40,6 +40,7 @@ __exportStar(require("./TestCase"), exports);
 __exportStar(require("./TestCaseCreate"), exports);
 __exportStar(require("./TestRecordCreate"), exports);
 __exportStar(require("./TestSetCreate"), exports);
+__exportStar(require("./TestcaseDeletionResponse"), exports);
 __exportStar(require("./TestrecordCustomInputsValue"), exports);
 __exportStar(require("./TestrecordCustomLabelsValue"), exports);
 __exportStar(require("./TestrecordCustomOutputsValue"), exports);

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

@@ -18,7 +18,11 @@ export declare class Prompt {
     protected readonly _options: Prompt.Options;
     constructor(_options: Prompt.Options);
     /**
-     * Create a new prompt
+     * Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in app).
+     *
+     *         A root prompt can be created by providing the `name` param, and it will always be tagged as prod.
+     *
+     *         A child prompt can be created by providing the `parent_id` param. Note that the `name` param in this case will be ignored as all descendents from a root prompt would share the root's name. `is_prod` can also be provided to configure whether a child should be tagged as prod.
      *
      * @param {Scorecard.PromptCreateParams} request
      * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
@@ -30,7 +34,7 @@ export declare class Prompt {
      *
      * @example
      *     await scorecard.prompt.create({
-     *         promptTemplate: "You are a virtual assistant",
+     *         promptTemplate: "<system>\nYou are a helpful assistant. Use the provided context to answer the user's query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
      *         name: "Prompt Name",
      *         description: "Description of the prompt",
      *         modelParams: {
@@ -43,7 +47,7 @@ export declare class Prompt {
      *
      * @example
      *     await scorecard.prompt.create({
-     *         promptTemplate: "You are a virtual assistant",
+     *         promptTemplate: "<system>\nYou are a helpful assistant. Use the provided context to answer the user's query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
      *         parentId: "7ac3cbd5-3b99-4e72-97f3-9cd2e749cace",
      *         description: "Description of the prompt",
      *         modelParams: {
@@ -57,35 +61,24 @@ export declare class Prompt {
      */
     create(request: Scorecard.PromptCreateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
     /**
-     * Retrieve active root prompts for the org
-     *
-     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Scorecard.UnauthorizedError}
-     * @throws {@link Scorecard.ForbiddenError}
-     * @throws {@link Scorecard.NotFoundError}
-     *
-     * @example
-     *     await scorecard.prompt.getRoots()
-     */
-    getRoots(requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt[]>;
-    /**
-     * Retrieve prod prompts for the org
+     * Retrieve a prompt by id
      *
+     * @param {string} id - The id of the prompt to get.
      * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
      * @throws {@link Scorecard.ForbiddenError}
      * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.getProds()
+     *     await scorecard.prompt.get("id")
      */
-    getProds(requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt[]>;
+    get(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
     /**
-     * Retrieve a prompt by id
+     * Delete a root prompt and all of its children.
      *
-     * @param {string} id - The id of the prompt to get.
+     * @param {string} id - The id of the root prompt to delete.
      * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -94,11 +87,13 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.get("id")
+     *     await scorecard.prompt.delete("id")
      */
-    get(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    delete(id: string, requestOptions?: Prompt.RequestOptions): Promise<unknown>;
     /**
-     * Update a prompt
+     * Update a prompt.
+     *
+     *         `is_prod` tags the provided prompt as the production prompt within the prompt graph.
      *
      * @param {string} id - The id of the prompt to update.
      * @param {Scorecard.PromptUpdateParams} request
@@ -111,7 +106,7 @@ export declare class Prompt {
      *
      * @example
      *     await scorecard.prompt.update("id", {
-     *         isArchived: true
+     *         isProd: true
      *     })
      */
     update(id: string, request?: Scorecard.PromptUpdateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
@@ -130,21 +125,6 @@ export declare class Prompt {
      *     await scorecard.prompt.getByName("name")
      */
     getByName(name: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
-    /**
-     * Retrieve all nodes within the same graph as the prompt, sorted by created_at desc
-     *
-     * @param {string} id - The id of the prompt.
-     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Scorecard.UnauthorizedError}
-     * @throws {@link Scorecard.ForbiddenError}
-     * @throws {@link Scorecard.NotFoundError}
-     * @throws {@link Scorecard.UnprocessableEntityError}
-     *
-     * @example
-     *     await scorecard.prompt.getGraph("id")
-     */
-    getGraph(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt[]>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-API-Key": string;
     }>;