scorecard-ai 1.0.0-alpha.2 → 1.0.0-alpha.4

package/src/resources/testsets.ts

@@ -8,7 +8,7 @@ import { path } from '../internal/utils/path';
 
 export class Testsets extends APIResource {
   /**
-   * Create a new testset for a project. The testset will be created in the project
+   * Create a new Testset for a Project. The Testset will be created in the Project
    * specified in the path.
    */
   create(projectID: string, body: TestsetCreateParams, options?: RequestOptions): APIPromise<Testset> {
@@ -16,7 +16,7 @@ export class Testsets extends APIResource {
   }
 
   /**
-   * Update a testset. Only the fields provided in the request body will be updated.
+   * Update a Testset. Only the fields provided in the request body will be updated.
    * If a field is provided, the new content will replace the existing content. If a
    * field is not provided, the existing content will remain unchanged.
    *
@@ -38,7 +38,7 @@ export class Testsets extends APIResource {
   }
 
   /**
-   * Retrieve a paginated list of testsets belonging to a project.
+   * Retrieve a paginated list of Testsets belonging to a Project.
    */
   list(
     projectID: string,
@@ -52,14 +52,14 @@ export class Testsets extends APIResource {
   }
 
   /**
-   * Delete testset
+   * Delete Testset
    */
   delete(testsetID: string, options?: RequestOptions): APIPromise<TestsetDeleteResponse> {
     return this._client.delete(path`/testsets/${testsetID}`, options);
   }
 
   /**
-   * Get testset by ID
+   * Get Testset by ID
    */
   get(testsetID: string, options?: RequestOptions): APIPromise<Testset> {
     return this._client.get(path`/testsets/${testsetID}`, options);
@@ -69,76 +69,77 @@ export class Testsets extends APIResource {
 export type TestsetsPaginatedResponse = PaginatedResponse<Testset>;
 
 /**
- * A collection of test cases that share the same schema. Each testset defines the
- * structure of its test cases through a JSON schema. The `fieldMapping` object
- * maps top-level keys of the testcase schema to their roles (input/label). Fields
- * not mentioned in the `fieldMapping` during creation or update are treated as
+ * A collection of Testcases that share the same schema. Each Testset defines the
+ * structure of its Testcases through a JSON schema. The `fieldMapping` object maps
+ * top-level keys of the Testcase schema to their roles (input/label). Fields not
+ * mentioned in the `fieldMapping` during creation or update are treated as
  * metadata.
  *
  * ## JSON Schema validation constraints supported:
  *
  * - **Required fields** - Fields listed in the schema's `required` array must be
- *   present in testcases
+ *   present in Testcases.
  * - **Type validation** - Values must match the specified type (string, number,
- *   boolean, null, integer, object, array)
+ *   boolean, null, integer, object, array).
  * - **Enum validation** - Values must be one of the options specified in the
- *   `enum` array
+ *   `enum` array.
  * - **Object property validation** - Properties of objects must conform to their
- *   defined schemas
- * - **Array item validation** - Items in arrays must conform to the `items` schema
+ *   defined schemas.
+ * - **Array item validation** - Items in arrays must conform to the `items`
+ *   schema.
  * - **Logical composition** - Values must conform to at least one schema in the
- *   `anyOf` array
+ *   `anyOf` array.
  *
  * Testcases that fail validation will still be stored, but will include
- * `validationErrors` detailing the issues. Extra fields in the testcase data that
+ * `validationErrors` detailing the issues. Extra fields in the Testcase data that
  * are not in the schema will be stored but are ignored during validation.
  */
 export interface Testset {
   /**
-   * The ID of the testset
+   * The ID of the Testset.
    */
   id: string;
 
   /**
-   * The description of the testset
+   * The description of the Testset.
    */
   description: string;
 
   /**
-   * Maps top-level keys of the testcase schema to their roles (input/label).
+   * Maps top-level keys of the Testcase schema to their roles (input/label).
    * Unmapped fields are treated as metadata.
    */
   fieldMapping: Testset.FieldMapping;
 
   /**
-   * The JSON schema for each testcase in the testset
+   * The JSON schema for each Testcase in the Testset.
    */
   jsonSchema: Record<string, unknown>;
 
   /**
-   * The name of the testset
+   * The name of the Testset.
    */
   name: string;
 }
 
 export namespace Testset {
   /**
-   * Maps top-level keys of the testcase schema to their roles (input/label).
+   * Maps top-level keys of the Testcase schema to their roles (input/label).
    * Unmapped fields are treated as metadata.
    */
   export interface FieldMapping {
     /**
-     * Fields that represent inputs to the AI system
+     * Fields that represent inputs to the AI system.
      */
     inputs: Array<string>;
 
     /**
-     * Fields that represent expected outputs/labels
+     * Fields that represent expected outputs/labels.
      */
     labels: Array<string>;
 
     /**
-     * Fields that are not inputs or labels
+     * Fields that are not inputs or labels.
      */
     metadata: Array<string>;
   }
@@ -146,52 +147,52 @@ export namespace Testset {
 
 export interface TestsetDeleteResponse {
   /**
-   * Whether the deletion was successful
+   * Whether the deletion was successful.
    */
   success: boolean;
 }
 
 export interface TestsetCreateParams {
   /**
-   * The description of the testset
+   * The description of the Testset.
    */
   description: string;
 
   /**
-   * Maps top-level keys of the testcase schema to their roles (input/label).
+   * Maps top-level keys of the Testcase schema to their roles (input/label).
    * Unmapped fields are treated as metadata.
    */
   fieldMapping: TestsetCreateParams.FieldMapping;
 
   /**
-   * The JSON schema for each testcase in the testset
+   * The JSON schema for each Testcase in the Testset.
    */
   jsonSchema: Record<string, unknown>;
 
   /**
-   * The name of the testset
+   * The name of the Testset.
    */
   name: string;
 }
 
 export namespace TestsetCreateParams {
   /**
-   * Maps top-level keys of the testcase schema to their roles (input/label).
+   * Maps top-level keys of the Testcase schema to their roles (input/label).
    * Unmapped fields are treated as metadata.
    */
   export interface FieldMapping {
     /**
-     * Fields that represent inputs to the AI system
+     * Fields that represent inputs to the AI system.
      */
     inputs: Array<string>;
 
     /**
-     * Fields that represent expected outputs/labels
+     * Fields that represent expected outputs/labels.
      */
     labels: Array<string>;
 
     /**
-     * Fields that are not inputs or labels
+     * Fields that are not inputs or labels.
      */
     metadata: Array<string>;
   }
@@ -199,45 +200,45 @@ export namespace TestsetCreateParams {
 
 export interface TestsetUpdateParams {
   /**
-   * The description of the testset
+   * The description of the Testset.
    */
   description?: string;
 
   /**
-   * Maps top-level keys of the testcase schema to their roles (input/label).
+   * Maps top-level keys of the Testcase schema to their roles (input/label).
    * Unmapped fields are treated as metadata.
    */
   fieldMapping?: TestsetUpdateParams.FieldMapping;
 
   /**
-   * The JSON schema for each testcase in the testset
+   * The JSON schema for each Testcase in the Testset.
    */
   jsonSchema?: Record<string, unknown>;
 
   /**
-   * The name of the testset
+   * The name of the Testset.
    */
   name?: string;
 }
 
 export namespace TestsetUpdateParams {
   /**
-   * Maps top-level keys of the testcase schema to their roles (input/label).
+   * Maps top-level keys of the Testcase schema to their roles (input/label).
    * Unmapped fields are treated as metadata.
    */
   export interface FieldMapping {
     /**
-     * Fields that represent inputs to the AI system
+     * Fields that represent inputs to the AI system.
      */
     inputs: Array<string>;
 
     /**
-     * Fields that represent expected outputs/labels
+     * Fields that represent expected outputs/labels.
      */
     labels: Array<string>;
 
     /**
-     * Fields that are not inputs or labels
+     * Fields that are not inputs or labels.
      */
     metadata: Array<string>;
   }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.0.0-alpha.2'; // x-release-please-version
+export const VERSION = '1.0.0-alpha.4'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.0.0-alpha.2";
+export declare const VERSION = "1.0.0-alpha.4";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.0.0-alpha.2";
+export declare const VERSION = "1.0.0-alpha.4";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.0.0-alpha.2'; // x-release-please-version
+exports.VERSION = '1.0.0-alpha.4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.0.0-alpha.2'; // x-release-please-version
+export const VERSION = '1.0.0-alpha.4'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/resources/execution-records.d.mts

@@ -1,62 +0,0 @@
-import { APIResource } from "../core/resource.mjs";
-import { APIPromise } from "../core/api-promise.mjs";
-import { RequestOptions } from "../internal/request-options.mjs";
-export declare class ExecutionRecords extends APIResource {
-    /**
-     * Create a new execution record.
-     */
-    create(runID: string, body: ExecutionRecordCreateParams, options?: RequestOptions): APIPromise<ExecutionRecord>;
-}
-/**
- * An execution record in the Scorecard system.
- */
-export interface ExecutionRecord {
-    /**
-     * The ID of the execution record
-     */
-    id: string;
-    /**
-     * The actual inputs sent to the system, which should match the system's input
-     * schema
-     */
-    inputs: Record<string, unknown>;
-    /**
-     * The expected outputs for the testcase
-     */
-    labels: Record<string, unknown>;
-    /**
-     * The actual outputs from the system
-     */
-    outputs: Record<string, unknown>;
-    /**
-     * The ID of the run containing this execution record
-     */
-    runId: string;
-    /**
-     * The ID of the testcase
-     */
-    testcaseId?: string;
-}
-export interface ExecutionRecordCreateParams {
-    /**
-     * The actual inputs sent to the system, which should match the system's input
-     * schema
-     */
-    inputs: Record<string, unknown>;
-    /**
-     * The expected outputs for the testcase
-     */
-    labels: Record<string, unknown>;
-    /**
-     * The actual outputs from the system
-     */
-    outputs: Record<string, unknown>;
-    /**
-     * The ID of the testcase
-     */
-    testcaseId?: string;
-}
-export declare namespace ExecutionRecords {
-    export { type ExecutionRecord as ExecutionRecord, type ExecutionRecordCreateParams as ExecutionRecordCreateParams, };
-}
-//# sourceMappingURL=execution-records.d.mts.map

package/resources/execution-records.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"execution-records.d.mts","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAG/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/execution-records.d.ts

@@ -1,62 +0,0 @@
-import { APIResource } from "../core/resource.js";
-import { APIPromise } from "../core/api-promise.js";
-import { RequestOptions } from "../internal/request-options.js";
-export declare class ExecutionRecords extends APIResource {
-    /**
-     * Create a new execution record.
-     */
-    create(runID: string, body: ExecutionRecordCreateParams, options?: RequestOptions): APIPromise<ExecutionRecord>;
-}
-/**
- * An execution record in the Scorecard system.
- */
-export interface ExecutionRecord {
-    /**
-     * The ID of the execution record
-     */
-    id: string;
-    /**
-     * The actual inputs sent to the system, which should match the system's input
-     * schema
-     */
-    inputs: Record<string, unknown>;
-    /**
-     * The expected outputs for the testcase
-     */
-    labels: Record<string, unknown>;
-    /**
-     * The actual outputs from the system
-     */
-    outputs: Record<string, unknown>;
-    /**
-     * The ID of the run containing this execution record
-     */
-    runId: string;
-    /**
-     * The ID of the testcase
-     */
-    testcaseId?: string;
-}
-export interface ExecutionRecordCreateParams {
-    /**
-     * The actual inputs sent to the system, which should match the system's input
-     * schema
-     */
-    inputs: Record<string, unknown>;
-    /**
-     * The expected outputs for the testcase
-     */
-    labels: Record<string, unknown>;
-    /**
-     * The actual outputs from the system
-     */
-    outputs: Record<string, unknown>;
-    /**
-     * The ID of the testcase
-     */
-    testcaseId?: string;
-}
-export declare namespace ExecutionRecords {
-    export { type ExecutionRecord as ExecutionRecord, type ExecutionRecordCreateParams as ExecutionRecordCreateParams, };
-}
-//# sourceMappingURL=execution-records.d.ts.map

package/resources/execution-records.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"execution-records.d.ts","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAG/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/execution-records.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"execution-records.js","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAa,EACb,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AAXD,4CAWC"}

package/resources/execution-records.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"execution-records.mjs","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAa,EACb,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF"}

package/src/resources/execution-records.ts

@@ -1,85 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
-
-export class ExecutionRecords extends APIResource {
-  /**
-   * Create a new execution record.
-   */
-  create(
-    runID: string,
-    body: ExecutionRecordCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<ExecutionRecord> {
-    return this._client.post(path`/runs/${runID}/executionrecords`, { body, ...options });
-  }
-}
-
-/**
- * An execution record in the Scorecard system.
- */
-export interface ExecutionRecord {
-  /**
-   * The ID of the execution record
-   */
-  id: string;
-
-  /**
-   * The actual inputs sent to the system, which should match the system's input
-   * schema
-   */
-  inputs: Record<string, unknown>;
-
-  /**
-   * The expected outputs for the testcase
-   */
-  labels: Record<string, unknown>;
-
-  /**
-   * The actual outputs from the system
-   */
-  outputs: Record<string, unknown>;
-
-  /**
-   * The ID of the run containing this execution record
-   */
-  runId: string;
-
-  /**
-   * The ID of the testcase
-   */
-  testcaseId?: string;
-}
-
-export interface ExecutionRecordCreateParams {
-  /**
-   * The actual inputs sent to the system, which should match the system's input
-   * schema
-   */
-  inputs: Record<string, unknown>;
-
-  /**
-   * The expected outputs for the testcase
-   */
-  labels: Record<string, unknown>;
-
-  /**
-   * The actual outputs from the system
-   */
-  outputs: Record<string, unknown>;
-
-  /**
-   * The ID of the testcase
-   */
-  testcaseId?: string;
-}
-
-export declare namespace ExecutionRecords {
-  export {
-    type ExecutionRecord as ExecutionRecord,
-    type ExecutionRecordCreateParams as ExecutionRecordCreateParams,
-  };
-}