scorecard-ai 0.6.0 → 0.6.1

package/dist/serialization/types/index.d.ts

@@ -12,6 +12,7 @@ export * from "./NotFoundErrorBody";
 export * from "./PaginatedTestcaseResponse";
 export * from "./PromptModelParamsValue";
 export * from "./Prompt";
+export * from "./PromptCursorPage";
 export * from "./RoleEnum";
 export * from "./Run";
 export * from "./RunMetric";
@@ -31,6 +32,7 @@ export * from "./TestrecordModelParamsValue";
 export * from "./TestrecordModelDebugInfoValue";
 export * from "./Testrecord";
 export * from "./Testset";
+export * from "./TestsetCursorPage";
 export * from "./Trace";
 export * from "./UnauthenticatedError";
 export * from "./UnauthorizedErrorBody";

package/dist/serialization/types/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./NotFoundErrorBody"), exports);
 __exportStar(require("./PaginatedTestcaseResponse"), exports);
 __exportStar(require("./PromptModelParamsValue"), exports);
 __exportStar(require("./Prompt"), exports);
+__exportStar(require("./PromptCursorPage"), exports);
 __exportStar(require("./RoleEnum"), exports);
 __exportStar(require("./Run"), exports);
 __exportStar(require("./RunMetric"), exports);
@@ -47,6 +48,7 @@ __exportStar(require("./TestrecordModelParamsValue"), exports);
 __exportStar(require("./TestrecordModelDebugInfoValue"), exports);
 __exportStar(require("./Testrecord"), exports);
 __exportStar(require("./Testset"), exports);
+__exportStar(require("./TestsetCursorPage"), exports);
 __exportStar(require("./Trace"), exports);
 __exportStar(require("./UnauthenticatedError"), exports);
 __exportStar(require("./UnauthorizedErrorBody"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "scorecard-ai",
-    "version": "0.6.0",
+    "version": "0.6.1",
     "private": false,
     "repository": "https://github.com/scorecard-ai/scorecard-node",
     "license": "See LICENSE",

package/reference.md

@@ -2,7 +2,7 @@
 
 ## Testset
 
-<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">get</a>(testsetId) -> Scorecard.Testset</code></summary>
+<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">get</a>({ ...params }) -> Scorecard.TestsetCursorPage</code></summary>
 <dl>
 <dd>
 
@@ -14,7 +14,7 @@
 <dl>
 <dd>
 
-Retrieve Testset metadata without Testcase data
+Retrieve all Testsets with cursor-based pagination
 
 </dd>
 </dl>
@@ -30,7 +30,7 @@ Retrieve Testset metadata without Testcase data
 <dd>
 
 ```typescript
-await client.testset.get(1);
+await client.testset.get();
 ```
 
 </dd>
@@ -46,7 +46,7 @@ await client.testset.get(1);
 <dl>
 <dd>
 
-**testsetId:** `number` — The ID of the Testset to retrieve.
+**request:** `Scorecard.TestsetGetRequest`
 
 </dd>
 </dl>
@@ -692,7 +692,7 @@ await client.testcase.update(1, 1);
 </dl>
 </details>
 
-<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">batchCopy</a>(testsetId, { ...params }) -> Scorecard.TestCase</code></summary>
+<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">batchCopy</a>(testsetId, { ...params }) -> Scorecard.TestCase[]</code></summary>
 <dl>
 <dd>
 
@@ -1617,7 +1617,7 @@ await client.tracing.span("trace_id", "span_id");
 <dl>
 <dd>
 
-Retrieve a prod prompt by name
+Retrieve a prompt by name, defaulting to the production prompt, unless a tag to select the prompt by is specified
 
 </dd>
 </dl>
@@ -1682,11 +1682,11 @@ await client.prompt.getByName({
 <dl>
 <dd>
 
-Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in app).
+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 prod.
+        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.
 
 </dd>
 </dl>
@@ -1713,6 +1713,8 @@ await client.prompt.create({
         param3: 100,
         param4: true,
     },
+    tag: "1.0",
+    projectId: 1,
 });
 ```
 
@@ -1748,6 +1750,69 @@ await client.prompt.create({
 </dl>
 </details>
 
+<details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">listPrompts</a>({ ...params }) -> Scorecard.PromptCursorPage</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all prompts with cursor-based pagination
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.prompt.listPrompts();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Scorecard.PromptListPromptsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Prompt.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">get</a>(id) -> Scorecard.Prompt</code></summary>
 <dl>
 <dd>
@@ -1823,7 +1888,7 @@ await client.prompt.get("id");
 <dl>
 <dd>
 
-Delete a scoring config.
+Delete a root prompt and all of its children.
 
 </dd>
 </dl>
@@ -1855,7 +1920,7 @@ await client.prompt.delete("id");
 <dl>
 <dd>
 
-**id:** `string` — The id of the scoring config to delete.
+**id:** `string` — The id of the root prompt to delete.
 
 </dd>
 </dl>
@@ -1983,6 +2048,7 @@ await client.scoringConfig.create({
     name: "Scoring Config Name",
     description: "Description of the scoring config",
     metrics: [1, 2, 3],
+    projectId: 1,
 });
 ```
 
@@ -2080,3 +2146,66 @@ await client.scoringConfig.get("id");
 </dd>
 </dl>
 </details>
+
+<details><summary><code>client.scoringConfig.<a href="/src/api/resources/scoringConfig/client/Client.ts">delete</a>(id) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete a scoring config.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.scoringConfig.delete("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — The id of the scoring config to delete.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ScoringConfig.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>

package/serialization/resources/prompt/client/requests/PromptCreateParams.d.ts

@@ -13,6 +13,8 @@ export declare namespace PromptCreateParams {
         parent_id?: string | null;
         description?: string | null;
         model_params?: Record<string, PromptCreateParamsModelParamsValue.Raw | null | undefined> | null;
+        tag?: string | null;
         is_prod?: boolean | null;
+        project_id?: number | null;
     }
 }

package/serialization/resources/prompt/client/requests/PromptCreateParams.js

@@ -35,5 +35,7 @@ exports.PromptCreateParams = core.serialization.object({
     parentId: core.serialization.property("parent_id", core.serialization.string().optional()),
     description: core.serialization.string().optional(),
     modelParams: core.serialization.property("model_params", core.serialization.record(core.serialization.string(), PromptCreateParamsModelParamsValue_1.PromptCreateParamsModelParamsValue.optional()).optional()),
+    tag: core.serialization.string().optional(),
     isProd: core.serialization.property("is_prod", core.serialization.boolean().optional()),
+    projectId: core.serialization.property("project_id", core.serialization.number().optional()),
 });

package/serialization/resources/scoringConfig/client/requests/ScoringConfigCreateParams.d.ts

@@ -10,5 +10,6 @@ export declare namespace ScoringConfigCreateParams {
         name?: string | null;
         description?: string | null;
         metrics?: number[] | null;
+        project_id?: number | null;
     }
 }

package/serialization/resources/scoringConfig/client/requests/ScoringConfigCreateParams.js

@@ -32,4 +32,5 @@ exports.ScoringConfigCreateParams = core.serialization.object({
     name: core.serialization.string().optional(),
     description: core.serialization.string().optional(),
     metrics: core.serialization.list(core.serialization.number()).optional(),
+    projectId: core.serialization.property("project_id", core.serialization.number().optional()),
 });

package/serialization/resources/testcase/client/batchCopy.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as Scorecard from "../../../../api/index";
+import * as core from "../../../../core";
+import { TestCase } from "../../../types/TestCase";
+export declare const Response: core.serialization.Schema<serializers.testcase.batchCopy.Response.Raw, Scorecard.TestCase[]>;
+export declare namespace Response {
+    type Raw = TestCase.Raw[];
+}

package/serialization/resources/testcase/client/batchCopy.js

@@ -0,0 +1,32 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Response = void 0;
+const core = __importStar(require("../../../../core"));
+const TestCase_1 = require("../../../types/TestCase");
+exports.Response = core.serialization.list(TestCase_1.TestCase);

package/serialization/resources/testcase/client/index.d.ts

@@ -1 +1,2 @@
+export * as batchCopy from "./batchCopy";
 export * from "./requests";

package/serialization/resources/testcase/client/index.js

@@ -10,8 +10,22 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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 __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.batchCopy = void 0;
+exports.batchCopy = __importStar(require("./batchCopy"));
 __exportStar(require("./requests"), exports);

package/serialization/resources/testset/client/requests/TestsetCreateParams.d.ts

@@ -16,5 +16,6 @@ export declare namespace TestsetCreateParams {
         project_id?: number | null;
         ingestion_method?: IngestionMethod.Raw | null;
         published?: boolean | null;
+        created_by_playground?: boolean | null;
     }
 }

package/serialization/resources/testset/client/requests/TestsetCreateParams.js

@@ -38,4 +38,5 @@ exports.TestsetCreateParams = core.serialization.object({
     projectId: core.serialization.property("project_id", core.serialization.number().optional()),
     ingestionMethod: core.serialization.property("ingestion_method", IngestionMethod_1.IngestionMethod.optional()),
     published: core.serialization.boolean().optional(),
+    createdByPlayground: core.serialization.property("created_by_playground", core.serialization.boolean().optional()),
 });

package/serialization/types/Prompt.d.ts

@@ -20,5 +20,6 @@ export declare namespace Prompt {
         parent_id?: string | null;
         merge_parent_id?: string | null;
         created_at?: string | null;
+        project_id?: number | null;
     }
 }

package/serialization/types/Prompt.js

@@ -42,4 +42,5 @@ exports.Prompt = core.serialization.object({
     parentId: core.serialization.property("parent_id", core.serialization.string().optional()),
     mergeParentId: core.serialization.property("merge_parent_id", core.serialization.string().optional()),
     createdAt: core.serialization.property("created_at", core.serialization.date().optional()),
+    projectId: core.serialization.property("project_id", core.serialization.number().optional()),
 });

package/serialization/types/PromptCursorPage.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../index";
+import * as Scorecard from "../../api/index";
+import * as core from "../../core";
+import { Prompt } from "./Prompt";
+export declare const PromptCursorPage: core.serialization.ObjectSchema<serializers.PromptCursorPage.Raw, Scorecard.PromptCursorPage>;
+export declare namespace PromptCursorPage {
+    interface Raw {
+        items: Prompt.Raw[];
+        total?: number | null;
+        current_page?: string | null;
+        current_page_backwards?: string | null;
+        previous_page?: string | null;
+        next_page?: string | null;
+    }
+}

package/serialization/types/PromptCursorPage.js

@@ -0,0 +1,39 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptCursorPage = void 0;
+const core = __importStar(require("../../core"));
+const Prompt_1 = require("./Prompt");
+exports.PromptCursorPage = core.serialization.object({
+    items: core.serialization.list(Prompt_1.Prompt),
+    total: core.serialization.number().optional(),
+    currentPage: core.serialization.property("current_page", core.serialization.string().optional()),
+    currentPageBackwards: core.serialization.property("current_page_backwards", core.serialization.string().optional()),
+    previousPage: core.serialization.property("previous_page", core.serialization.string().optional()),
+    nextPage: core.serialization.property("next_page", core.serialization.string().optional()),
+});

package/serialization/types/ScoringConfig.d.ts

@@ -16,5 +16,6 @@ export declare namespace ScoringConfig {
         is_archived?: boolean | null;
         metrics?: number[] | null;
         created_at?: string | null;
+        project_id?: number | null;
     }
 }

package/serialization/types/ScoringConfig.js

@@ -38,4 +38,5 @@ exports.ScoringConfig = core.serialization.object({
     isArchived: core.serialization.property("is_archived", core.serialization.boolean().optional()),
     metrics: core.serialization.list(core.serialization.number()).optional(),
     createdAt: core.serialization.property("created_at", core.serialization.date().optional()),
+    projectId: core.serialization.property("project_id", core.serialization.number().optional()),
 });

package/serialization/types/Testset.d.ts

@@ -20,5 +20,6 @@ export declare namespace Testset {
         is_archived?: boolean | null;
         project_id?: number | null;
         custom_schema?: CustomSchema.Raw | null;
+        created_by_playground?: boolean | null;
     }
 }

package/serialization/types/Testset.js

@@ -42,4 +42,5 @@ exports.Testset = core.serialization.object({
     isArchived: core.serialization.property("is_archived", core.serialization.boolean().optional()),
     projectId: core.serialization.property("project_id", core.serialization.number().optional()),
     customSchema: core.serialization.property("custom_schema", CustomSchema_1.CustomSchema.optional()),
+    createdByPlayground: core.serialization.property("created_by_playground", core.serialization.boolean().optional()),
 });

package/serialization/types/TestsetCursorPage.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../index";
+import * as Scorecard from "../../api/index";
+import * as core from "../../core";
+import { Testset } from "./Testset";
+export declare const TestsetCursorPage: core.serialization.ObjectSchema<serializers.TestsetCursorPage.Raw, Scorecard.TestsetCursorPage>;
+export declare namespace TestsetCursorPage {
+    interface Raw {
+        items: Testset.Raw[];
+        total?: number | null;
+        current_page?: string | null;
+        current_page_backwards?: string | null;
+        previous_page?: string | null;
+        next_page?: string | null;
+    }
+}

package/serialization/types/TestsetCursorPage.js

@@ -0,0 +1,39 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestsetCursorPage = void 0;
+const core = __importStar(require("../../core"));
+const Testset_1 = require("./Testset");
+exports.TestsetCursorPage = core.serialization.object({
+    items: core.serialization.list(Testset_1.Testset),
+    total: core.serialization.number().optional(),
+    currentPage: core.serialization.property("current_page", core.serialization.string().optional()),
+    currentPageBackwards: core.serialization.property("current_page_backwards", core.serialization.string().optional()),
+    previousPage: core.serialization.property("previous_page", core.serialization.string().optional()),
+    nextPage: core.serialization.property("next_page", core.serialization.string().optional()),
+});

package/serialization/types/index.d.ts

@@ -12,6 +12,7 @@ export * from "./NotFoundErrorBody";
 export * from "./PaginatedTestcaseResponse";
 export * from "./PromptModelParamsValue";
 export * from "./Prompt";
+export * from "./PromptCursorPage";
 export * from "./RoleEnum";
 export * from "./Run";
 export * from "./RunMetric";
@@ -31,6 +32,7 @@ export * from "./TestrecordModelParamsValue";
 export * from "./TestrecordModelDebugInfoValue";
 export * from "./Testrecord";
 export * from "./Testset";
+export * from "./TestsetCursorPage";
 export * from "./Trace";
 export * from "./UnauthenticatedError";
 export * from "./UnauthorizedErrorBody";

package/serialization/types/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./NotFoundErrorBody"), exports);
 __exportStar(require("./PaginatedTestcaseResponse"), exports);
 __exportStar(require("./PromptModelParamsValue"), exports);
 __exportStar(require("./Prompt"), exports);
+__exportStar(require("./PromptCursorPage"), exports);
 __exportStar(require("./RoleEnum"), exports);
 __exportStar(require("./Run"), exports);
 __exportStar(require("./RunMetric"), exports);
@@ -47,6 +48,7 @@ __exportStar(require("./TestrecordModelParamsValue"), exports);
 __exportStar(require("./TestrecordModelDebugInfoValue"), exports);
 __exportStar(require("./Testrecord"), exports);
 __exportStar(require("./Testset"), exports);
+__exportStar(require("./TestsetCursorPage"), exports);
 __exportStar(require("./Trace"), exports);
 __exportStar(require("./UnauthenticatedError"), exports);
 __exportStar(require("./UnauthorizedErrorBody"), exports);