scorecard-ai 0.5.3 → 0.6.0

package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js

@@ -1,13 +1,4 @@
 "use strict";
-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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.undiscriminatedUnion = void 0;
 const Schema_1 = require("../../Schema");
@@ -15,37 +6,35 @@ const maybeSkipValidation_1 = require("../../utils/maybeSkipValidation");
 const schema_utils_1 = require("../schema-utils");
 function undiscriminatedUnion(schemas) {
     const baseSchema = {
-        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
+        parse: (raw, opts) => {
             return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.parse(raw, opts), schemas, opts);
-        }),
-        json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () {
+        },
+        json: (parsed, opts) => {
             return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.json(parsed, opts), schemas, opts);
-        }),
+        },
         getType: () => Schema_1.SchemaType.UNDISCRIMINATED_UNION,
     };
     return Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema));
 }
 exports.undiscriminatedUnion = undiscriminatedUnion;
 function validateAndTransformUndiscriminatedUnion(transform, schemas, opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const errors = [];
-        for (const [index, schema] of schemas.entries()) {
-            const transformed = yield transform(schema, Object.assign(Object.assign({}, opts), { skipValidation: false }));
-            if (transformed.ok) {
-                return transformed;
-            }
-            else {
-                for (const error of transformed.errors) {
-                    errors.push({
-                        path: error.path,
-                        message: `[Variant ${index}] ${error.message}`,
-                    });
-                }
+    const errors = [];
+    for (const [index, schema] of schemas.entries()) {
+        const transformed = transform(schema, Object.assign(Object.assign({}, opts), { skipValidation: false }));
+        if (transformed.ok) {
+            return transformed;
+        }
+        else {
+            for (const error of transformed.errors) {
+                errors.push({
+                    path: error.path,
+                    message: `[Variant ${index}] ${error.message}`,
+                });
             }
         }
-        return {
-            ok: false,
-            errors,
-        };
-    });
+    }
+    return {
+        ok: false,
+        errors,
+    };
 }

package/core/schemas/builders/union/union.js

@@ -1,13 +1,4 @@
 "use strict";
-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 __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -36,7 +27,7 @@ function union(discriminant, union) {
         : discriminant.parsedDiscriminant;
     const discriminantValueSchema = (0, enum_1.enum_)((0, keys_1.keys)(union));
     const baseSchema = {
-        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
+        parse: (raw, opts) => {
             return transformAndValidateUnion({
                 value: raw,
                 discriminant: rawDiscriminant,
@@ -53,8 +44,8 @@ function union(discriminant, union) {
                 transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.parse(additionalProperties, opts),
                 breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
             });
-        }),
-        json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () {
+        },
+        json: (parsed, opts) => {
             return transformAndValidateUnion({
                 value: parsed,
                 discriminant: parsedDiscriminant,
@@ -71,71 +62,69 @@ function union(discriminant, union) {
                 transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.json(additionalProperties, opts),
                 breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
             });
-        }),
+        },
         getType: () => Schema_1.SchemaType.UNION,
     };
     return Object.assign(Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema)), (0, object_like_1.getObjectLikeUtils)(baseSchema));
 }
 exports.union = union;
 function transformAndValidateUnion({ value, discriminant, transformedDiscriminant, transformDiscriminantValue, getAdditionalPropertiesSchema, allowUnrecognizedUnionMembers = false, transformAdditionalProperties, breadcrumbsPrefix = [], }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!(0, isPlainObject_1.isPlainObject)(value)) {
+    if (!(0, isPlainObject_1.isPlainObject)(value)) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "object"),
+                },
+            ],
+        };
+    }
+    const _a = value, _b = discriminant, discriminantValue = _a[_b], additionalProperties = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
+    if (discriminantValue == null) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: `Missing discriminant ("${discriminant}")`,
+                },
+            ],
+        };
+    }
+    const transformedDiscriminantValue = transformDiscriminantValue(discriminantValue);
+    if (!transformedDiscriminantValue.ok) {
+        return {
+            ok: false,
+            errors: transformedDiscriminantValue.errors,
+        };
+    }
+    const additionalPropertiesSchema = getAdditionalPropertiesSchema(transformedDiscriminantValue.value);
+    if (additionalPropertiesSchema == null) {
+        if (allowUnrecognizedUnionMembers) {
             return {
-                ok: false,
-                errors: [
-                    {
-                        path: breadcrumbsPrefix,
-                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "object"),
-                    },
-                ],
+                ok: true,
+                value: Object.assign({ [transformedDiscriminant]: transformedDiscriminantValue.value }, additionalProperties),
             };
         }
-        const _a = value, _b = discriminant, discriminantValue = _a[_b], additionalProperties = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
-        if (discriminantValue == null) {
+        else {
             return {
                 ok: false,
                 errors: [
                     {
-                        path: breadcrumbsPrefix,
-                        message: `Missing discriminant ("${discriminant}")`,
+                        path: [...breadcrumbsPrefix, discriminant],
+                        message: "Unexpected discriminant value",
                     },
                 ],
             };
         }
-        const transformedDiscriminantValue = yield transformDiscriminantValue(discriminantValue);
-        if (!transformedDiscriminantValue.ok) {
-            return {
-                ok: false,
-                errors: transformedDiscriminantValue.errors,
-            };
-        }
-        const additionalPropertiesSchema = getAdditionalPropertiesSchema(transformedDiscriminantValue.value);
-        if (additionalPropertiesSchema == null) {
-            if (allowUnrecognizedUnionMembers) {
-                return {
-                    ok: true,
-                    value: Object.assign({ [transformedDiscriminant]: transformedDiscriminantValue.value }, additionalProperties),
-                };
-            }
-            else {
-                return {
-                    ok: false,
-                    errors: [
-                        {
-                            path: [...breadcrumbsPrefix, discriminant],
-                            message: "Unexpected discriminant value",
-                        },
-                    ],
-                };
-            }
-        }
-        const transformedAdditionalProperties = yield transformAdditionalProperties(additionalProperties, additionalPropertiesSchema);
-        if (!transformedAdditionalProperties.ok) {
-            return transformedAdditionalProperties;
-        }
-        return {
-            ok: true,
-            value: Object.assign({ [transformedDiscriminant]: discriminantValue }, transformedAdditionalProperties.value),
-        };
-    });
+    }
+    const transformedAdditionalProperties = transformAdditionalProperties(additionalProperties, additionalPropertiesSchema);
+    if (!transformedAdditionalProperties.ok) {
+        return transformedAdditionalProperties;
+    }
+    return {
+        ok: true,
+        value: Object.assign({ [transformedDiscriminant]: discriminantValue }, transformedAdditionalProperties.value),
+    };
 }

package/core/schemas/utils/maybeSkipValidation.js

@@ -1,13 +1,4 @@
 "use strict";
-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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.maybeSkipValidation = void 0;
 function maybeSkipValidation(schema) {
@@ -15,8 +6,8 @@ function maybeSkipValidation(schema) {
 }
 exports.maybeSkipValidation = maybeSkipValidation;
 function transformAndMaybeSkipValidation(transform) {
-    return (value, opts) => __awaiter(this, void 0, void 0, function* () {
-        const transformed = yield transform(value, opts);
+    return (value, opts) => {
+        const transformed = transform(value, opts);
         const { skipValidation = false } = opts !== null && opts !== void 0 ? opts : {};
         if (!transformed.ok && skipValidation) {
             // eslint-disable-next-line no-console
@@ -33,5 +24,5 @@ function transformAndMaybeSkipValidation(transform) {
         else {
             return transformed;
         }
-    });
+    };
 }

package/dist/Client.d.ts

@@ -9,8 +9,9 @@ import { Testrecord } from "./api/resources/testrecord/client/Client";
 import { Run } from "./api/resources/run/client/Client";
 import { Score } from "./api/resources/score/client/Client";
 import { RunMetric } from "./api/resources/runMetric/client/Client";
-import { Traces } from "./api/resources/traces/client/Client";
+import { Tracing } from "./api/resources/tracing/client/Client";
 import { Prompt } from "./api/resources/prompt/client/Client";
+import { ScoringConfig } from "./api/resources/scoringConfig/client/Client";
 export declare namespace ScorecardClient {
     interface Options {
         environment?: core.Supplier<environments.ScorecardEnvironment | string>;
@@ -18,8 +19,11 @@ export declare namespace ScorecardClient {
         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;
     }
 }
@@ -38,8 +42,10 @@ export declare class ScorecardClient {
     get score(): Score;
     protected _runMetric: RunMetric | undefined;
     get runMetric(): RunMetric;
-    protected _traces: Traces | undefined;
-    get traces(): Traces;
+    protected _tracing: Tracing | undefined;
+    get tracing(): Tracing;
     protected _prompt: Prompt | undefined;
     get prompt(): Prompt;
+    protected _scoringConfig: ScoringConfig | undefined;
+    get scoringConfig(): ScoringConfig;
 }

package/dist/Client.js

@@ -10,8 +10,9 @@ 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");
 const Client_6 = require("./api/resources/runMetric/client/Client");
-const Client_7 = require("./api/resources/traces/client/Client");
+const Client_7 = require("./api/resources/tracing/client/Client");
 const Client_8 = require("./api/resources/prompt/client/Client");
+const Client_9 = require("./api/resources/scoringConfig/client/Client");
 class ScorecardClient {
     constructor(_options) {
         this._options = _options;
@@ -40,13 +41,17 @@ class ScorecardClient {
         var _a;
         return ((_a = this._runMetric) !== null && _a !== void 0 ? _a : (this._runMetric = new Client_6.RunMetric(this._options)));
     }
-    get traces() {
+    get tracing() {
         var _a;
-        return ((_a = this._traces) !== null && _a !== void 0 ? _a : (this._traces = new Client_7.Traces(this._options)));
+        return ((_a = this._tracing) !== null && _a !== void 0 ? _a : (this._tracing = new Client_7.Tracing(this._options)));
     }
     get prompt() {
         var _a;
         return ((_a = this._prompt) !== null && _a !== void 0 ? _a : (this._prompt = new Client_8.Prompt(this._options)));
     }
+    get scoringConfig() {
+        var _a;
+        return ((_a = this._scoringConfig) !== null && _a !== void 0 ? _a : (this._scoringConfig = new Client_9.ScoringConfig(this._options)));
+    }
 }
 exports.ScorecardClient = ScorecardClient;

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

@@ -8,10 +8,12 @@ export * as testset from "./testset";
 export * as run from "./run";
 export * as score from "./score";
 export * as runMetric from "./runMetric";
-export * as traces from "./traces";
+export * as tracing from "./tracing";
+export * as scoringConfig from "./scoringConfig";
 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";
 export * from "./prompt/client/requests";
+export * from "./scoringConfig/client/requests";

package/dist/api/resources/index.js

@@ -26,7 +26,7 @@ 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.traces = exports.runMetric = exports.score = exports.run = exports.testset = exports.prompt = exports.testrecord = exports.testcase = void 0;
+exports.scoringConfig = exports.tracing = exports.runMetric = exports.score = exports.run = exports.testset = exports.prompt = exports.testrecord = exports.testcase = void 0;
 exports.testcase = __importStar(require("./testcase"));
 __exportStar(require("./testcase/types"), exports);
 exports.testrecord = __importStar(require("./testrecord"));
@@ -37,10 +37,12 @@ exports.testset = __importStar(require("./testset"));
 exports.run = __importStar(require("./run"));
 exports.score = __importStar(require("./score"));
 exports.runMetric = __importStar(require("./runMetric"));
-exports.traces = __importStar(require("./traces"));
+exports.tracing = __importStar(require("./tracing"));
+exports.scoringConfig = __importStar(require("./scoringConfig"));
 __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);
 __exportStar(require("./prompt/client/requests"), exports);
+__exportStar(require("./scoringConfig/client/requests"), exports);

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

@@ -11,14 +11,34 @@ export declare namespace Prompt {
         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 Prompt {
     protected readonly _options: Prompt.Options;
     constructor(_options: Prompt.Options);
+    /**
+     * Retrieve a prod prompt by name
+     *
+     * @param {Scorecard.PromptGetByNameRequest} request
+     * @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 client.prompt.getByName({
+     *         name: "name"
+     *     })
+     */
+    getByName(request: Scorecard.PromptGetByNameRequest, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
     /**
      * Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in app).
      *
@@ -35,7 +55,7 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.create({
+     *     await client.prompt.create({
      *         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",
@@ -48,7 +68,7 @@ export declare class Prompt {
      *     })
      *
      * @example
-     *     await scorecard.prompt.create({
+     *     await client.prompt.create({
      *         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",
@@ -74,13 +94,13 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.get("id")
+     *     await client.prompt.get("id")
      */
     get(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
     /**
-     * Delete a root prompt and all of its children.
+     * Delete a scoring config.
      *
-     * @param {string} id - The id of the root prompt to delete.
+     * @param {string} id - The id of the scoring config to delete.
      * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Scorecard.UnauthorizedError}
@@ -89,7 +109,7 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.delete("id")
+     *     await client.prompt.delete("id")
      */
     delete(id: string, requestOptions?: Prompt.RequestOptions): Promise<unknown>;
     /**
@@ -107,26 +127,11 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.update("id", {
+     *     await client.prompt.update("id", {
      *         isProd: true
      *     })
      */
     update(id: string, request?: Scorecard.PromptUpdateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
-    /**
-     * Retrieve a prod prompt by name
-     *
-     * @param {string} name - Name 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.getByName("name")
-     */
-    getByName(name: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-API-Key": string;
     }>;