scorecard-ai 0.2.1 → 0.4.0

package/Client.d.ts

@@ -8,6 +8,9 @@ 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";
+import { RunMetric } from "./api/resources/runMetric/client/Client";
+import { Traces } from "./api/resources/traces/client/Client";
+import { Prompt } from "./api/resources/prompt/client/Client";
 export declare namespace ScorecardClient {
     interface Options {
         environment?: core.Supplier<environments.ScorecardEnvironment | string>;
@@ -31,4 +34,10 @@ export declare class ScorecardClient {
     get run(): Run;
     protected _score: Score | undefined;
     get score(): Score;
+    protected _runMetric: RunMetric | undefined;
+    get runMetric(): RunMetric;
+    protected _traces: Traces | undefined;
+    get traces(): Traces;
+    protected _prompt: Prompt | undefined;
+    get prompt(): Prompt;
 }

package/Client.js

@@ -9,6 +9,9 @@ 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");
+const Client_6 = require("./api/resources/runMetric/client/Client");
+const Client_7 = require("./api/resources/traces/client/Client");
+const Client_8 = require("./api/resources/prompt/client/Client");
 class ScorecardClient {
     constructor(_options) {
         this._options = _options;
@@ -33,5 +36,17 @@ class ScorecardClient {
         var _a;
         return ((_a = this._score) !== null && _a !== void 0 ? _a : (this._score = new Client_5.Score(this._options)));
     }
+    get runMetric() {
+        var _a;
+        return ((_a = this._runMetric) !== null && _a !== void 0 ? _a : (this._runMetric = new Client_6.RunMetric(this._options)));
+    }
+    get traces() {
+        var _a;
+        return ((_a = this._traces) !== null && _a !== void 0 ? _a : (this._traces = new Client_7.Traces(this._options)));
+    }
+    get prompt() {
+        var _a;
+        return ((_a = this._prompt) !== null && _a !== void 0 ? _a : (this._prompt = new Client_8.Prompt(this._options)));
+    }
 }
 exports.ScorecardClient = ScorecardClient;

package/api/errors/ForbiddenError.d.ts

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
-import * as Scorecard from "..";
+import * as errors from "../../errors/index";
+import * as Scorecard from "../index";
 export declare class ForbiddenError extends errors.ScorecardError {
     constructor(body: Scorecard.UnauthorizedErrorBody);
 }

package/api/errors/ForbiddenError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForbiddenError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class ForbiddenError extends errors.ScorecardError {
     constructor(body) {
         super({

package/api/errors/NotFoundError.d.ts

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
-import * as Scorecard from "..";
+import * as errors from "../../errors/index";
+import * as Scorecard from "../index";
 export declare class NotFoundError extends errors.ScorecardError {
     constructor(body: Scorecard.NotFoundErrorBody);
 }

package/api/errors/NotFoundError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class NotFoundError extends errors.ScorecardError {
     constructor(body) {
         super({

package/api/errors/UnauthorizedError.d.ts

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
-import * as Scorecard from "..";
+import * as errors from "../../errors/index";
+import * as Scorecard from "../index";
 export declare class UnauthorizedError extends errors.ScorecardError {
     constructor(body: Scorecard.UnauthenticatedError);
 }

package/api/errors/UnauthorizedError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnauthorizedError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class UnauthorizedError extends errors.ScorecardError {
     constructor(body) {
         super({

package/api/errors/UnprocessableEntityError.d.ts

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
-import * as Scorecard from "..";
+import * as errors from "../../errors/index";
+import * as Scorecard from "../index";
 export declare class UnprocessableEntityError extends errors.ScorecardError {
     constructor(body: Scorecard.HttpValidationError);
 }

package/api/errors/UnprocessableEntityError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnprocessableEntityError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class UnprocessableEntityError extends errors.ScorecardError {
     constructor(body) {
         super({

package/api/resources/index.d.ts

@@ -2,11 +2,16 @@ export * as testcase from "./testcase";
 export * from "./testcase/types";
 export * as testrecord from "./testrecord";
 export * from "./testrecord/types";
+export * as prompt from "./prompt";
+export * from "./prompt/types";
 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 * 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";

package/api/resources/index.js

@@ -26,16 +26,21 @@ 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.score = exports.run = exports.testset = exports.testrecord = exports.testcase = void 0;
+exports.traces = 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"));
 __exportStar(require("./testrecord/types"), exports);
+exports.prompt = __importStar(require("./prompt"));
+__exportStar(require("./prompt/types"), exports);
 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"));
 __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);

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

@@ -0,0 +1,131 @@
+/**
+ * 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 Prompt {
+    interface Options {
+        environment?: core.Supplier<environments.ScorecardEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class Prompt {
+    protected readonly _options: Prompt.Options;
+    constructor(_options: Prompt.Options);
+    /**
+     * 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.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.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",
+     *         modelParams: {
+     *             "param1": "value1",
+     *             "param2": 0.1,
+     *             "param3": 100,
+     *             "param4": true
+     *         }
+     *     })
+     *
+     * @example
+     *     await scorecard.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",
+     *         modelParams: {
+     *             "param1": "value1",
+     *             "param2": 0.1,
+     *             "param3": 100,
+     *             "param4": true
+     *         },
+     *         isProd: true
+     *     })
+     */
+    create(request: Scorecard.PromptCreateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * 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.get("id")
+     */
+    get(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * Delete a root prompt and all of its children.
+     *
+     * @param {string} id - The id of the root prompt to delete.
+     * @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.delete("id")
+     */
+    delete(id: string, requestOptions?: Prompt.RequestOptions): Promise<unknown>;
+    /**
+     * 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
+     * @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.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;
+    }>;
+}