scorecard-ai 2.1.1 → 2.3.0

package/src/resources/records.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as ScoresAPI from './scores';
 import { APIPromise } from '../core/api-promise';
+import { PagePromise, PaginatedResponse, type PaginatedResponseParams } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
@@ -24,8 +26,47 @@ export class Records extends APIResource {
   create(runID: string, body: RecordCreateParams, options?: RequestOptions): APIPromise<Record> {
     return this._client.post(path`/runs/${runID}/records`, { body, ...options });
   }
+
+  /**
+   * Retrieve a paginated list of Records for a Run, including all scores for each
+   * record.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const recordListResponse of client.records.list(
+   *   '135',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    runID: string,
+    query: RecordListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RecordListResponsesPaginatedResponse, RecordListResponse> {
+    return this._client.getAPIList(path`/runs/${runID}/records`, PaginatedResponse<RecordListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a specific Record by ID.
+   *
+   * @example
+   * ```ts
+   * const record = await client.records.delete('777');
+   * ```
+   */
+  delete(recordID: string, options?: RequestOptions): APIPromise<RecordDeleteResponse> {
+    return this._client.delete(path`/records/${recordID}`, options);
+  }
 }
 
+export type RecordListResponsesPaginatedResponse = PaginatedResponse<RecordListResponse>;
+
 /**
  * A record of a system execution in the Scorecard system.
  */
@@ -62,6 +103,23 @@ export interface Record {
   testcaseId?: string;
 }
 
+/**
+ * A record with all its associated scores.
+ */
+export interface RecordListResponse extends Record {
+  /**
+   * All scores associated with this record.
+   */
+  scores: Array<ScoresAPI.Score>;
+}
+
+export interface RecordDeleteResponse {
+  /**
+   * Whether the deletion was successful.
+   */
+  success: boolean;
+}
+
 export interface RecordCreateParams {
   /**
    * The expected outputs for the Testcase.
@@ -85,6 +143,15 @@ export interface RecordCreateParams {
   testcaseId?: string;
 }
 
+export interface RecordListParams extends PaginatedResponseParams {}
+
 export declare namespace Records {
-  export { type Record as Record, type RecordCreateParams as RecordCreateParams };
+  export {
+    type Record as Record,
+    type RecordListResponse as RecordListResponse,
+    type RecordDeleteResponse as RecordDeleteResponse,
+    type RecordListResponsesPaginatedResponse as RecordListResponsesPaginatedResponse,
+    type RecordCreateParams as RecordCreateParams,
+    type RecordListParams as RecordListParams,
+  };
 }

package/src/resources/runs.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { PagePromise, PaginatedResponse, type PaginatedResponseParams } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
@@ -21,8 +22,45 @@ export class Runs extends APIResource {
   create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run> {
     return this._client.post(path`/projects/${projectID}/runs`, { body, ...options });
   }
+
+  /**
+   * Retrieve a paginated list of all Runs for a Project. Runs are ordered by
+   * creation date, most recent first.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const run of client.runs.list('314')) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    projectID: string,
+    query: RunListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RunsPaginatedResponse, Run> {
+    return this._client.getAPIList(path`/projects/${projectID}/runs`, PaginatedResponse<Run>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific Run by ID.
+   *
+   * @example
+   * ```ts
+   * const run = await client.runs.get('135');
+   * ```
+   */
+  get(runID: string, options?: RequestOptions): APIPromise<Run> {
+    return this._client.get(path`/runs/${runID}`, options);
+  }
 }
 
+export type RunsPaginatedResponse = PaginatedResponse<Run>;
+
 /**
  * A Run in the Scorecard system.
  */
@@ -37,6 +75,27 @@ export interface Run {
    */
   metricIds: Array<string>;
 
+  /**
+   * The IDs of the metric versions this Run is using.
+   */
+  metricVersionIds: Array<string>;
+
+  /**
+   * The number of expected records in the Run. Determined by the number of testcases
+   * in the Run's Testset at the time of Run creation.
+   */
+  numExpectedRecords: number | null;
+
+  /**
+   * The number of records in the Run.
+   */
+  numRecords: number;
+
+  /**
+   * The number of completed scores in the Run so far.
+   */
+  numScores: number;
+
   /**
    * The status of the Run.
    */
@@ -50,14 +109,19 @@ export interface Run {
     | 'completed';
 
   /**
-   * The ID of the Testset this Run is testing.
+   * The ID of the system this Run is using.
    */
-  testsetId: string | null;
+  systemId: string | null;
 
   /**
    * The ID of the system version this Run is using.
    */
-  systemVersionId?: string;
+  systemVersionId: string | null;
+
+  /**
+   * The ID of the Testset this Run is testing.
+   */
+  testsetId: string | null;
 }
 
 export interface RunCreateParams {
@@ -69,7 +133,7 @@ export interface RunCreateParams {
   /**
    * The ID of the system version this Run is using.
    */
-  systemVersionId?: string;
+  systemVersionId?: string | null;
 
   /**
    * The ID of the Testset this Run is testing.
@@ -77,6 +141,13 @@ export interface RunCreateParams {
   testsetId?: string | null;
 }
 
+export interface RunListParams extends PaginatedResponseParams {}
+
 export declare namespace Runs {
-  export { type Run as Run, type RunCreateParams as RunCreateParams };
+  export {
+    type Run as Run,
+    type RunsPaginatedResponse as RunsPaginatedResponse,
+    type RunCreateParams as RunCreateParams,
+    type RunListParams as RunListParams,
+  };
 }

package/src/resources/scores.ts

@@ -81,7 +81,7 @@ export namespace Score {
 
 export interface ScoreUpsertParams {
   /**
-   * Path param: The ID of the Record.
+   * Path param: The ID of the Record to upsert the Score for.
    */
   recordId: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.1.1'; // x-release-please-version
+export const VERSION = '2.3.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.1.1";
+export declare const VERSION = "2.3.0";
 //# 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 = '2.1.1'; // x-release-please-version
+exports.VERSION = '2.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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