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

package/src/resources/runs.ts

@@ -7,14 +7,14 @@ import { path } from '../internal/utils/path';
 
 export class Runs extends APIResource {
   /**
-   * Create a new run.
+   * Create a new Run.
    */
   create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run> {
     return this._client.post(path`/projects/${projectID}/runs`, { body, ...options });
   }
 
   /**
-   * Update the status of a run.
+   * Update the status of a Run.
    */
   update(runID: string, body: RunUpdateParams, options?: RequestOptions): APIPromise<RunUpdateResponse> {
     return this._client.patch(path`/runs/${runID}`, { body, ...options });
@@ -26,17 +26,17 @@ export 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'
@@ -48,24 +48,24 @@ export interface Run {
     | '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'
@@ -79,24 +79,24 @@ export interface RunUpdateResponse {
 
 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'

package/src/resources/shared.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 /**
- * An API error
+ * An API error.
  */
 export interface APIError {
   code: string;

package/src/resources/system-configs.ts

@@ -78,22 +78,22 @@ 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;
 
@@ -107,12 +107,12 @@ export interface SystemConfig {
 export namespace SystemConfig {
   export 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;
   }
@@ -120,12 +120,12 @@ export namespace SystemConfig {
 
 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;
 
@@ -139,12 +139,12 @@ export interface SystemConfigCreateParams {
 export namespace SystemConfigCreateParams {
   export 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;
   }
@@ -154,7 +154,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/src/resources/systems.ts

@@ -88,9 +88,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
@@ -101,93 +101,93 @@ 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/src/resources/testcases.ts

@@ -8,7 +8,7 @@ import { path } from '../internal/utils/path';
 
 export class Testcases extends APIResource {
   /**
-   * Create multiple testcases in the specified testset.
+   * Create multiple Testcases in the specified Testset.
    */
   create(
     testsetID: string,
@@ -19,14 +19,14 @@ export class Testcases extends APIResource {
   }
 
   /**
-   * Replace the data of an existing testcase while keeping its ID.
+   * Replace the data of an existing Testcase while keeping its ID.
    */
   update(testcaseID: string, body: TestcaseUpdateParams, options?: RequestOptions): APIPromise<Testcase> {
     return this._client.put(path`/testcases/${testcaseID}`, { body, ...options });
   }
 
   /**
-   * Retrieve a paginated list of testcases belonging to a testset.
+   * Retrieve a paginated list of Testcases belonging to a Testset.
    */
   list(
     testsetID: string,
@@ -40,14 +40,14 @@ export class Testcases extends APIResource {
   }
 
   /**
-   * Delete multiple testcases by their IDs.
+   * Delete multiple Testcases by their IDs.
    */
   delete(body: TestcaseDeleteParams, options?: RequestOptions): APIPromise<TestcaseDeleteResponse> {
     return this._client.post('/testcases/bulk-delete', { body, ...options });
   }
 
   /**
-   * Retrieve a specific testcase by ID.
+   * Retrieve a specific Testcase by ID.
    */
   get(testcaseID: string, options?: RequestOptions): APIPromise<Testcase> {
     return this._client.get(path`/testcases/${testcaseID}`, options);
@@ -58,43 +58,43 @@ export type TestcasesPaginatedResponse = PaginatedResponse<Testcase>;
 
 /**
  * A test case in the Scorecard system. Contains JSON data that is validated
- * against the schema defined by its testset. The `inputs` and `labels` fields are
- * derived from the `data` field based on the testset's `fieldMapping`, and include
+ * against the schema defined by its Testset. The `inputs` and `labels` fields are
+ * derived from the `data` field based on the Testset's `fieldMapping`, and include
  * all mapped fields, including those with validation errors. Testcases are stored
  * regardless of validation results, with any validation errors included in the
  * `validationErrors` field.
  */
 export interface Testcase {
   /**
-   * The ID of the testcase
+   * The ID of the Testcase.
    */
   id: string;
 
   /**
-   * Derived from data based on the testset's fieldMapping. Contains all fields
+   * Derived from data based on the Testset's fieldMapping. Contains all fields
    * marked as inputs, including those with validation errors.
    */
   inputs: Record<string, unknown>;
 
   /**
-   * The JSON data of the testcase, which is validated against the testset's schema.
+   * The JSON data of the Testcase, which is validated against the Testset's schema.
    */
   jsonData: Record<string, unknown>;
 
   /**
-   * Derived from data based on the testset's fieldMapping. Contains all fields
+   * Derived from data based on the Testset's fieldMapping. Contains all fields
    * marked as labels, including those with validation errors.
    */
   labels: Record<string, unknown>;
 
   /**
-   * The ID of the testset this testcase belongs to
+   * The ID of the Testset this Testcase belongs to.
    */
   testsetId: string;
 
   /**
-   * Validation errors found in the testcase data. If present, the testcase doesn't
-   * fully conform to its testset's schema.
+   * Validation errors found in the Testcase data. If present, the Testcase doesn't
+   * fully conform to its Testset's schema.
    */
   validationErrors?: Array<Testcase.ValidationError>;
 }
@@ -102,12 +102,12 @@ export interface Testcase {
 export namespace Testcase {
   export 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;
   }
@@ -119,14 +119,14 @@ export interface TestcaseCreateResponse {
 
 export interface TestcaseDeleteResponse {
   /**
-   * Whether the deletion was successful
+   * Whether the deletion was successful.
    */
   success: boolean;
 }
 
 export interface TestcaseCreateParams {
   /**
-   * Testcases to create (max 100)
+   * Testcases to create (max 100).
    */
   items: Array<TestcaseCreateParams.Item>;
 }
@@ -134,15 +134,15 @@ export interface TestcaseCreateParams {
 export namespace TestcaseCreateParams {
   /**
    * A test case in the Scorecard system. Contains JSON data that is validated
-   * against the schema defined by its testset. The `inputs` and `labels` fields are
-   * derived from the `data` field based on the testset's `fieldMapping`, and include
+   * against the schema defined by its Testset. The `inputs` and `labels` fields are
+   * derived from the `data` field based on the Testset's `fieldMapping`, and include
    * all mapped fields, including those with validation errors. Testcases are stored
    * regardless of validation results, with any validation errors included in the
    * `validationErrors` field.
    */
   export interface Item {
     /**
-     * The JSON data of the testcase, which is validated against the testset's schema.
+     * The JSON data of the Testcase, which is validated against the Testset's schema.
      */
     jsonData: Record<string, unknown>;
   }
@@ -150,7 +150,7 @@ export namespace TestcaseCreateParams {
 
 export interface TestcaseUpdateParams {
   /**
-   * The JSON data of the testcase, which is validated against the testset's schema.
+   * The JSON data of the Testcase, which is validated against the Testset's schema.
    */
   jsonData: Record<string, unknown>;
 }
@@ -159,7 +159,7 @@ export interface TestcaseListParams extends PaginatedResponseParams {}
 
 export interface TestcaseDeleteParams {
   /**
-   * IDs of testcases to delete
+   * IDs of Testcases to delete.
    */
   ids: Array<string>;
 }