scorecard-ai 1.1.0 → 2.0.0-alpha.1

package/src/resources/systems/versions.ts

@@ -2,92 +2,51 @@
 
 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';
 
 export class Versions extends APIResource {
   /**
-   * Create a new version for a system.
-   *
-   * Each version contains specific parameter values that match the system's
-   * `configSchema` - things like model parameters, thresholds, or processing
-   * options. Once created, versions cannot be modified, ensuring stable reference
-   * points for evaluations.
-   *
-   * When creating a system version:
-   *
-   * - The `config` object is validated against the parent system's `configSchema`.
-   * - System versions with validation errors are still stored, with errors included
-   *   in the response.
-   * - Validation errors indicate fields that don't match the schema but don't
-   *   prevent creation.
-   * - Having validation errors may affect how some evaluation metrics are
-   *   calculated.
+   * Retrieve a specific system version by ID.
    *
    * @example
    * ```ts
-   * const systemVersion = await client.systems.versions.create(
-   *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
-   *   {
-   *     config: {
-   *       temperature: 0.1,
-   *       maxTokens: 1024,
-   *       model: 'gpt-4-turbo',
-   *     },
-   *     name: 'Production (Low Temperature)',
-   *   },
+   * const systemVersion = await client.systems.versions.get(
+   *   '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
    * );
    * ```
    */
-  create(systemID: string, body: VersionCreateParams, options?: RequestOptions): APIPromise<SystemVersion> {
-    return this._client.post(path`/systems/${systemID}/configs`, { body, ...options });
+  get(systemVersionID: string, options?: RequestOptions): APIPromise<SystemVersion> {
+    return this._client.get(path`/systems/versions/${systemVersionID}`, options);
   }
 
   /**
-   * Retrieve a paginated list of system versions for a specific system.
+   * Create a new system version if it does not already exist. Does **not** set the
+   * created version to be the system's production version.
    *
-   * System versions provide concrete parameter values for a System Under Test,
-   * defining exactly how the system should be configured during an evaluation run.
+   * If there is already a system version with the same config, its name will be
+   * updated.
    *
    * @example
    * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const systemVersion of client.systems.versions.list(
+   * const systemVersion = await client.systems.versions.upsert(
    *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    systemID: string,
-    query: VersionListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<SystemVersionsPaginatedResponse, SystemVersion> {
-    return this._client.getAPIList(path`/systems/${systemID}/configs`, PaginatedResponse<SystemVersion>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Retrieve a specific system version by ID.
-   *
-   * @example
-   * ```ts
-   * const systemVersion = await client.systems.versions.get(
-   *   '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
+   *   {
+   *     config: {
+   *       temperature: 0.5,
+   *       maxTokens: 1024,
+   *       model: 'gemini-2.0-flash',
+   *     },
+   *     name: 'Test model: Gemini',
+   *   },
    * );
    * ```
    */
-  get(systemVersionID: string, options?: RequestOptions): APIPromise<SystemVersion> {
-    return this._client.get(path`/systems/configs/${systemVersionID}`, options);
+  upsert(systemID: string, body: VersionUpsertParams, options?: RequestOptions): APIPromise<SystemVersion> {
+    return this._client.post(path`/systems/${systemID}/versions`, { body, ...options });
   }
 }
 
-export type SystemVersionsPaginatedResponse = PaginatedResponse<SystemVersion>;
-
 /**
  * A SystemVersion defines the specific settings for a System Under Test.
  *
@@ -96,9 +55,6 @@ export type SystemVersionsPaginatedResponse = PaginatedResponse<SystemVersion>;
  *
  * When running evaluations, you reference a specific systemVersionId to establish
  * which system version to test.
- *
- * System versions will be validated against the system's configSchema, with
- * non-conforming values generating warnings.
  */
 export interface SystemVersion {
   /**
@@ -120,47 +76,21 @@ export interface SystemVersion {
    * The ID of the system the system version belongs to.
    */
   systemId: string;
-
-  /**
-   * Validation errors found in the system version. If present, the system version
-   * doesn't fully conform to its system's configSchema.
-   */
-  validationErrors?: Array<SystemVersion.ValidationError>;
-}
-
-export namespace SystemVersion {
-  export interface ValidationError {
-    /**
-     * Human-readable error description.
-     */
-    message: string;
-
-    /**
-     * JSON Pointer to the field with the validation error.
-     */
-    path: string;
-  }
 }
 
-export interface VersionCreateParams {
+export interface VersionUpsertParams {
   /**
    * The configuration of the system version.
    */
   config: Record<string, unknown>;
 
   /**
-   * The name of the system version.
+   * The name of the system version. If creating a new system version and the name
+   * isn't provided, it will be autogenerated.
    */
-  name: string;
+  name?: string;
 }
 
-export interface VersionListParams extends PaginatedResponseParams {}
-
 export declare namespace Versions {
-  export {
-    type SystemVersion as SystemVersion,
-    type SystemVersionsPaginatedResponse as SystemVersionsPaginatedResponse,
-    type VersionCreateParams as VersionCreateParams,
-    type VersionListParams as VersionListParams,
-  };
+  export { type SystemVersion as SystemVersion, type VersionUpsertParams as VersionUpsertParams };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.1.0'; // x-release-please-version
+export const VERSION = '2.0.0-alpha.1'; // x-release-please-version

package/version.d.mts

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

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}

package/version.js

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

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}