scorecard-ai 0.5.4 → 0.6.1

package/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/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/README.md

@@ -17,11 +17,11 @@ The SDK uses fetch and is compatible in multiple environments
 such as Node, Vercel, Cloudflare Workers. 
 
 ```typescript
-import { ScorecardClient } from "scorecard";
+import { ScorecardClient } from "scorecard-ai";
 
-const scorecard = new ScorecardClient(
-  api_key="YOUR_API_KEY" // Defaults to SCORECARD_API_KEY
-)
+const scorecard = new ScorecardClient({
+  apiKey: "YOUR_API_KEY"
+})
 
 const testset = await scorecard.testset.create({
   testsetId=1234, 
@@ -42,11 +42,11 @@ available on both the sync and async client.
 
 ```typescript
 import { callModel } from "../app.ts";
-import { ScorecardClient } from "scorecard";
+import { ScorecardClient } from "scorecard-ai";
 
-const scorecard = new ScorecardClient(
-  apiKey="YOUR_API_KEY"
-)
+const scorecard = new ScorecardClient({
+  apiKey: "YOUR_API_KEY"
+})
 
 client.runTests({
   inputTestsetId: 123,
@@ -76,7 +76,7 @@ All exceptions thrown by the SDK will
 sublcass [ScorecardError](./src/errors/ScorecardError.ts). 
 
 ```typescript
-import { Scorecard, ScorecardError } from "scorecard";
+import { Scorecard, ScorecardError } from "scorecard-ai";
 
 try {
   await client.testset.get({...});

package/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/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/api/resources/prompt/client/Client.d.ts

@@ -11,8 +11,11 @@ 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;
     }
 }
@@ -20,11 +23,28 @@ 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).
+     * Retrieve a prompt by name, defaulting to the production prompt, unless a tag to select the prompt by is specified
      *
-     *         A root prompt can be created by providing the `name` param, and it will always be tagged as prod.
+     * @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 the app).
+     *
+     *         A root prompt can be created by providing the `name` param, and it will always be tagged as production.
      *
-     *         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.
+     *         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 descendants 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 production.
      *
      * @param {Scorecard.PromptCreateParams} request
      * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
@@ -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",
@@ -44,11 +64,13 @@ export declare class Prompt {
      *             "param2": 0.1,
      *             "param3": 100,
      *             "param4": true
-     *         }
+     *         },
+     *         tag: "1.0",
+     *         projectId: 1
      *     })
      *
      * @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",
@@ -58,10 +80,27 @@ export declare class Prompt {
      *             "param3": 100,
      *             "param4": true
      *         },
-     *         isProd: true
+     *         tag: "v1.1",
+     *         isProd: true,
+     *         projectId: 1
      *     })
      */
     create(request: Scorecard.PromptCreateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * List all prompts with cursor-based pagination
+     *
+     * @param {Scorecard.PromptListPromptsRequest} 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.listPrompts()
+     */
+    listPrompts(request?: Scorecard.PromptListPromptsRequest, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.PromptCursorPage>;
     /**
      * Retrieve a prompt by id
      *
@@ -74,7 +113,7 @@ 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>;
     /**
@@ -89,7 +128,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 +146,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;
     }>;