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

package/resources/{execution-records.mjs → records.mjs}

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../core/resource.mjs";
 import { path } from "../internal/utils/path.mjs";
-export class ExecutionRecords extends APIResource {
+export class Records extends APIResource {
     /**
-     * Create a new execution record.
+     * Create a new Record in a Run.
      */
     create(runID, body, options) {
-        return this._client.post(path `/runs/${runID}/executionrecords`, { body, ...options });
+        return this._client.post(path `/runs/${runID}/records`, { body, ...options });
     }
 }
-//# sourceMappingURL=execution-records.mjs.map
+//# sourceMappingURL=records.mjs.map

package/resources/records.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.mjs","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}

package/resources/runs.d.mts

@@ -3,11 +3,11 @@ import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Runs extends APIResource {
     /**
-     * Create a new run.
+     * Create a new Run.
      */
     create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run>;
     /**
-     * Update the status of a run.
+     * Update the status of a Run.
      */
     update(runID: string, body: RunUpdateParams, options?: RequestOptions): APIPromise<RunUpdateResponse>;
 }
@@ -16,53 +16,53 @@ export declare class Runs extends APIResource {
  */
 export interface Run {
     /**
-     * The ID of the Run
+     * The ID of the Run.
      */
     id: string;
     /**
-     * The IDs of the metrics this Run is using
+     * The IDs of the metrics this Run is using.
      */
     metricIds: Array<string>;
     /**
-     * The status of the Run
+     * The status of the Run.
      */
     status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
     /**
-     * The ID of the Testset this Run is testing
+     * The ID of the Testset this Run is testing.
      */
     testsetId: string;
     /**
-     * The ID of the system configuration this Run is using
+     * The ID of the system configuration this Run is using.
      */
     systemConfigId?: string;
 }
 export interface RunUpdateResponse {
     /**
-     * The ID of the Run
+     * The ID of the Run.
      */
     id: string;
     /**
-     * The status of the Run
+     * The status of the Run.
      */
     status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
 }
 export interface RunCreateParams {
     /**
-     * The IDs of the metrics this Run is using
+     * The IDs of the metrics this Run is using.
      */
     metricIds: Array<string>;
     /**
-     * The ID of the Testset this Run is testing
+     * The ID of the Testset this Run is testing.
      */
     testsetId: string;
     /**
-     * The ID of the system configuration this Run is using
+     * The ID of the system configuration this Run is using.
      */
     systemConfigId?: string;
 }
 export interface RunUpdateParams {
     /**
-     * The status of the Run
+     * The status of the Run.
      */
     status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
 }

package/resources/runs.d.ts

@@ -3,11 +3,11 @@ import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Runs extends APIResource {
     /**
-     * Create a new run.
+     * Create a new Run.
      */
     create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run>;
     /**
-     * Update the status of a run.
+     * Update the status of a Run.
      */
     update(runID: string, body: RunUpdateParams, options?: RequestOptions): APIPromise<RunUpdateResponse>;
 }
@@ -16,53 +16,53 @@ export declare class Runs extends APIResource {
  */
 export interface Run {
     /**
-     * The ID of the Run
+     * The ID of the Run.
      */
     id: string;
     /**
-     * The IDs of the metrics this Run is using
+     * The IDs of the metrics this Run is using.
      */
     metricIds: Array<string>;
     /**
-     * The status of the Run
+     * The status of the Run.
      */
     status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
     /**
-     * The ID of the Testset this Run is testing
+     * The ID of the Testset this Run is testing.
      */
     testsetId: string;
     /**
-     * The ID of the system configuration this Run is using
+     * The ID of the system configuration this Run is using.
      */
     systemConfigId?: string;
 }
 export interface RunUpdateResponse {
     /**
-     * The ID of the Run
+     * The ID of the Run.
      */
     id: string;
     /**
-     * The status of the Run
+     * The status of the Run.
      */
     status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
 }
 export interface RunCreateParams {
     /**
-     * The IDs of the metrics this Run is using
+     * The IDs of the metrics this Run is using.
      */
     metricIds: Array<string>;
     /**
-     * The ID of the Testset this Run is testing
+     * The ID of the Testset this Run is testing.
      */
     testsetId: string;
     /**
-     * The ID of the system configuration this Run is using
+     * The ID of the system configuration this Run is using.
      */
     systemConfigId?: string;
 }
 export interface RunUpdateParams {
     /**
-     * The status of the Run
+     * The status of the Run.
      */
     status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
 }

package/resources/runs.js

@@ -6,13 +6,13 @@ const resource_1 = require("../core/resource.js");
 const path_1 = require("../internal/utils/path.js");
 class Runs extends resource_1.APIResource {
     /**
-     * Create a new run.
+     * Create a new Run.
      */
     create(projectID, body, options) {
         return this._client.post((0, path_1.path) `/projects/${projectID}/runs`, { body, ...options });
     }
     /**
-     * Update the status of a run.
+     * Update the status of a Run.
      */
     update(runID, body, options) {
         return this._client.patch((0, path_1.path) `/runs/${runID}`, { body, ...options });

package/resources/runs.mjs

@@ -3,13 +3,13 @@ import { APIResource } from "../core/resource.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class Runs extends APIResource {
     /**
-     * Create a new run.
+     * Create a new Run.
      */
     create(projectID, body, options) {
         return this._client.post(path `/projects/${projectID}/runs`, { body, ...options });
     }
     /**
-     * Update the status of a run.
+     * Update the status of a Run.
      */
     update(runID, body, options) {
         return this._client.patch(path `/runs/${runID}`, { body, ...options });

package/resources/shared.d.mts

@@ -1,5 +1,5 @@
 /**
- * An API error
+ * An API error.
  */
 export interface APIError {
     code: string;

package/resources/shared.d.ts

@@ -1,5 +1,5 @@
 /**
- * An API error
+ * An API error.
  */
 export interface APIError {
     code: string;

package/resources/system-configs.d.mts

@@ -48,19 +48,19 @@ export type SystemConfigsPaginatedResponse = PaginatedResponse<SystemConfig>;
  */
 export interface SystemConfig {
     /**
-     * The ID of the system configuration
+     * The ID of the system configuration.
      */
     id: string;
     /**
-     * The configuration of the system
+     * The configuration of the system.
      */
     config: Record<string, unknown>;
     /**
-     * The name of the system configuration
+     * The name of the system configuration.
      */
     name: string;
     /**
-     * The ID of the system the configuration belongs to
+     * The ID of the system the configuration belongs to.
      */
     systemId: string;
     /**
@@ -72,22 +72,22 @@ export interface SystemConfig {
 export declare namespace SystemConfig {
     interface ValidationError {
         /**
-         * Human-readable error description
+         * Human-readable error description.
          */
         message: string;
         /**
-         * JSON Pointer to the field with the validation error
+         * JSON Pointer to the field with the validation error.
          */
         path: string;
     }
 }
 export interface SystemConfigCreateParams {
     /**
-     * The configuration of the system
+     * The configuration of the system.
      */
     config: Record<string, unknown>;
     /**
-     * The name of the system configuration
+     * The name of the system configuration.
      */
     name: string;
     /**
@@ -99,11 +99,11 @@ export interface SystemConfigCreateParams {
 export declare namespace SystemConfigCreateParams {
     interface ValidationError {
         /**
-         * Human-readable error description
+         * Human-readable error description.
          */
         message: string;
         /**
-         * JSON Pointer to the field with the validation error
+         * JSON Pointer to the field with the validation error.
          */
         path: string;
     }
@@ -112,7 +112,7 @@ export interface SystemConfigListParams extends PaginatedResponseParams {
 }
 export interface SystemConfigGetParams {
     /**
-     * The ID of the system the configuration belongs to
+     * The ID of the system the configuration belongs to.
      */
     systemId: string;
 }

package/resources/system-configs.d.ts

@@ -48,19 +48,19 @@ export type SystemConfigsPaginatedResponse = PaginatedResponse<SystemConfig>;
  */
 export interface SystemConfig {
     /**
-     * The ID of the system configuration
+     * The ID of the system configuration.
      */
     id: string;
     /**
-     * The configuration of the system
+     * The configuration of the system.
      */
     config: Record<string, unknown>;
     /**
-     * The name of the system configuration
+     * The name of the system configuration.
      */
     name: string;
     /**
-     * The ID of the system the configuration belongs to
+     * The ID of the system the configuration belongs to.
      */
     systemId: string;
     /**
@@ -72,22 +72,22 @@ export interface SystemConfig {
 export declare namespace SystemConfig {
     interface ValidationError {
         /**
-         * Human-readable error description
+         * Human-readable error description.
          */
         message: string;
         /**
-         * JSON Pointer to the field with the validation error
+         * JSON Pointer to the field with the validation error.
          */
         path: string;
     }
 }
 export interface SystemConfigCreateParams {
     /**
-     * The configuration of the system
+     * The configuration of the system.
      */
     config: Record<string, unknown>;
     /**
-     * The name of the system configuration
+     * The name of the system configuration.
      */
     name: string;
     /**
@@ -99,11 +99,11 @@ export interface SystemConfigCreateParams {
 export declare namespace SystemConfigCreateParams {
     interface ValidationError {
         /**
-         * Human-readable error description
+         * Human-readable error description.
          */
         message: string;
         /**
-         * JSON Pointer to the field with the validation error
+         * JSON Pointer to the field with the validation error.
          */
         path: string;
     }
@@ -112,7 +112,7 @@ export interface SystemConfigListParams extends PaginatedResponseParams {
 }
 export interface SystemConfigGetParams {
     /**
-     * The ID of the system the configuration belongs to
+     * The ID of the system the configuration belongs to.
      */
     systemId: string;
 }

package/resources/systems.d.mts

@@ -57,9 +57,9 @@ export type SystemsPaginatedResponse = PaginatedResponse<System>;
  *
  * It specifies three contracts through schemas:
  *
- * - inputSchema: The structure of data the system accepts
- * - outputSchema: The structure of data the system produces
- * - configSchema: The parameters that modify system behavior
+ * - inputSchema: The structure of data the system accepts.
+ * - outputSchema: The structure of data the system produces.
+ * - configSchema: The parameters that modify system behavior.
  *
  * This abstraction lets you evaluate any system as a black box, focusing on its
  * interface rather than implementation details. It's particularly useful for
@@ -70,77 +70,77 @@ export type SystemsPaginatedResponse = PaginatedResponse<System>;
  */
 export interface System {
     /**
-     * The ID of the system
+     * The ID of the system.
      */
     id: string;
     /**
-     * The schema of the system's configuration
+     * The schema of the system's configuration.
      */
     configSchema: Record<string, unknown>;
     /**
-     * The description of the system
+     * The description of the system.
      */
     description: string;
     /**
-     * The schema of the system's inputs
+     * The schema of the system's inputs.
      */
     inputSchema: Record<string, unknown>;
     /**
-     * The name of the system
+     * The name of the system.
      */
     name: string;
     /**
-     * The schema of the system's outputs
+     * The schema of the system's outputs.
      */
     outputSchema: Record<string, unknown>;
 }
 export interface SystemDeleteResponse {
     /**
-     * Whether the deletion was successful
+     * Whether the deletion was successful.
      */
     success: boolean;
 }
 export interface SystemCreateParams {
     /**
-     * The schema of the system's configuration
+     * The schema of the system's configuration.
      */
     configSchema: Record<string, unknown>;
     /**
-     * The description of the system
+     * The description of the system.
      */
     description: string;
     /**
-     * The schema of the system's inputs
+     * The schema of the system's inputs.
      */
     inputSchema: Record<string, unknown>;
     /**
-     * The name of the system
+     * The name of the system.
      */
     name: string;
     /**
-     * The schema of the system's outputs
+     * The schema of the system's outputs.
      */
     outputSchema: Record<string, unknown>;
 }
 export interface SystemUpdateParams {
     /**
-     * The schema of the system's configuration
+     * The schema of the system's configuration.
      */
     configSchema?: Record<string, unknown>;
     /**
-     * The description of the system
+     * The description of the system.
      */
     description?: string;
     /**
-     * The schema of the system's inputs
+     * The schema of the system's inputs.
      */
     inputSchema?: Record<string, unknown>;
     /**
-     * The name of the system
+     * The name of the system.
      */
     name?: string;
     /**
-     * The schema of the system's outputs
+     * The schema of the system's outputs.
      */
     outputSchema?: Record<string, unknown>;
 }

package/resources/systems.d.ts

@@ -57,9 +57,9 @@ export type SystemsPaginatedResponse = PaginatedResponse<System>;
  *
  * It specifies three contracts through schemas:
  *
- * - inputSchema: The structure of data the system accepts
- * - outputSchema: The structure of data the system produces
- * - configSchema: The parameters that modify system behavior
+ * - inputSchema: The structure of data the system accepts.
+ * - outputSchema: The structure of data the system produces.
+ * - configSchema: The parameters that modify system behavior.
  *
  * This abstraction lets you evaluate any system as a black box, focusing on its
  * interface rather than implementation details. It's particularly useful for
@@ -70,77 +70,77 @@ export type SystemsPaginatedResponse = PaginatedResponse<System>;
  */
 export interface System {
     /**
-     * The ID of the system
+     * The ID of the system.
      */
     id: string;
     /**
-     * The schema of the system's configuration
+     * The schema of the system's configuration.
      */
     configSchema: Record<string, unknown>;
     /**
-     * The description of the system
+     * The description of the system.
      */
     description: string;
     /**
-     * The schema of the system's inputs
+     * The schema of the system's inputs.
      */
     inputSchema: Record<string, unknown>;
     /**
-     * The name of the system
+     * The name of the system.
      */
     name: string;
     /**
-     * The schema of the system's outputs
+     * The schema of the system's outputs.
      */
     outputSchema: Record<string, unknown>;
 }
 export interface SystemDeleteResponse {
     /**
-     * Whether the deletion was successful
+     * Whether the deletion was successful.
      */
     success: boolean;
 }
 export interface SystemCreateParams {
     /**
-     * The schema of the system's configuration
+     * The schema of the system's configuration.
      */
     configSchema: Record<string, unknown>;
     /**
-     * The description of the system
+     * The description of the system.
      */
     description: string;
     /**
-     * The schema of the system's inputs
+     * The schema of the system's inputs.
      */
     inputSchema: Record<string, unknown>;
     /**
-     * The name of the system
+     * The name of the system.
      */
     name: string;
     /**
-     * The schema of the system's outputs
+     * The schema of the system's outputs.
      */
     outputSchema: Record<string, unknown>;
 }
 export interface SystemUpdateParams {
     /**
-     * The schema of the system's configuration
+     * The schema of the system's configuration.
      */
     configSchema?: Record<string, unknown>;
     /**
-     * The description of the system
+     * The description of the system.
      */
     description?: string;
     /**
-     * The schema of the system's inputs
+     * The schema of the system's inputs.
      */
     inputSchema?: Record<string, unknown>;
     /**
-     * The name of the system
+     * The name of the system.
      */
     name?: string;
     /**
-     * The schema of the system's outputs
+     * The schema of the system's outputs.
      */
     outputSchema?: Record<string, unknown>;
 }