@coval/sdk 0.4.1 → 0.4.3

package/src/generated/models/CovalOrganizationAPIConversationMetricRuleMetadataValue.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime.js';
 /**
- * Value to compare the run metadata against.
+ * Value to compare the run metadata against. For LENGTH_AT_LEAST this is the minimum number of array entries required, as a whole number.
  * @export
  * @interface CovalOrganizationAPIConversationMetricRuleMetadataValue
  */

package/src/generated/models/CovalReportsAPICompareBy.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * Dimension to group and compare runs by in the report view.
+ * Dimension to group and compare runs by in the report view. `custom` groups by a
+ * caller-defined dimension and requires `custom_dimensions`.
+ * 
  * @export
  */
 export const CovalReportsAPICompareBy = {
@@ -24,7 +26,8 @@ export const CovalReportsAPICompareBy = {
     Mutation: 'mutation',
     Persona: 'persona',
     TestCase: 'test_case',
-    Metadata: 'metadata'
+    Metadata: 'metadata',
+    Custom: 'custom'
 } as const;
 export type CovalReportsAPICompareBy = typeof CovalReportsAPICompareBy[keyof typeof CovalReportsAPICompareBy];
 

package/src/generated/models/CovalReportsAPICreateReportRequest.ts

@@ -20,6 +20,13 @@ import {
     CovalReportsAPICompareByToJSON,
     CovalReportsAPICompareByToJSONTyped,
 } from './CovalReportsAPICompareBy.js';
+import type { CovalReportsAPIReportCustomDimension } from './CovalReportsAPIReportCustomDimension.js';
+import {
+    CovalReportsAPIReportCustomDimensionFromJSON,
+    CovalReportsAPIReportCustomDimensionFromJSONTyped,
+    CovalReportsAPIReportCustomDimensionToJSON,
+    CovalReportsAPIReportCustomDimensionToJSONTyped,
+} from './CovalReportsAPIReportCustomDimension.js';
 import type { CovalReportsAPIReportPermission } from './CovalReportsAPIReportPermission.js';
 import {
     CovalReportsAPIReportPermissionFromJSON,
@@ -75,6 +82,30 @@ export interface CovalReportsAPICreateReportRequest {
      * @memberof CovalReportsAPICreateReportRequest
      */
     metadata_key?: string | null;
+    /**
+     * Caller-defined groupings of the report's simulations. Required when
+     * `compare_by` is `custom`; otherwise omit it. This is how the app's
+     * "Merge reports" action builds one grouped report out of several.
+     * 
+     * @type {Array<CovalReportsAPIReportCustomDimension>}
+     * @memberof CovalReportsAPICreateReportRequest
+     */
+    custom_dimensions?: Array<CovalReportsAPIReportCustomDimension> | null;
+    /**
+     * Which of `custom_dimensions` to group by. Only valid when `compare_by`
+     * is `custom`; defaults to the first dimension.
+     * 
+     * @type {string}
+     * @memberof CovalReportsAPICreateReportRequest
+     */
+    custom_dimension_id?: string | null;
+    /**
+     * Report layout. `grouped` aggregates each `compare_by` group; defaults to `rows`.
+     * 
+     * @type {CovalReportsAPICreateReportRequestViewModeEnum}
+     * @memberof CovalReportsAPICreateReportRequest
+     */
+    view_mode?: CovalReportsAPICreateReportRequestViewModeEnum | null;
     /**
      * 
      * @type {CovalReportsAPIReportPermission}
@@ -84,6 +115,15 @@ export interface CovalReportsAPICreateReportRequest {
 }
 
 
+/**
+ * @export
+ */
+export const CovalReportsAPICreateReportRequestViewModeEnum = {
+    Rows: 'rows',
+    Grouped: 'grouped'
+} as const;
+export type CovalReportsAPICreateReportRequestViewModeEnum = typeof CovalReportsAPICreateReportRequestViewModeEnum[keyof typeof CovalReportsAPICreateReportRequestViewModeEnum];
+
 
 /**
  * Check if a given object implements the CovalReportsAPICreateReportRequest interface.
@@ -110,6 +150,9 @@ export function CovalReportsAPICreateReportRequestFromJSONTyped(json: any, ignor
         'source_human_review_project_id': json['source_human_review_project_id'] == null ? undefined : json['source_human_review_project_id'],
         'compare_by': json['compare_by'] == null ? undefined : CovalReportsAPICompareByFromJSON(json['compare_by']),
         'metadata_key': json['metadata_key'] == null ? undefined : json['metadata_key'],
+        'custom_dimensions': json['custom_dimensions'] == null ? undefined : ((json['custom_dimensions'] as Array<any>).map(CovalReportsAPIReportCustomDimensionFromJSON)),
+        'custom_dimension_id': json['custom_dimension_id'] == null ? undefined : json['custom_dimension_id'],
+        'view_mode': json['view_mode'] == null ? undefined : json['view_mode'],
         'permissions': json['permissions'] == null ? undefined : CovalReportsAPIReportPermissionFromJSON(json['permissions']),
     };
 }
@@ -131,6 +174,9 @@ export function CovalReportsAPICreateReportRequestToJSONTyped(value?: CovalRepor
         'source_human_review_project_id': value['source_human_review_project_id'],
         'compare_by': CovalReportsAPICompareByToJSON(value['compare_by']),
         'metadata_key': value['metadata_key'],
+        'custom_dimensions': value['custom_dimensions'] == null ? undefined : ((value['custom_dimensions'] as Array<any>).map(CovalReportsAPIReportCustomDimensionToJSON)),
+        'custom_dimension_id': value['custom_dimension_id'],
+        'view_mode': value['view_mode'],
         'permissions': CovalReportsAPIReportPermissionToJSON(value['permissions']),
     };
 }

package/src/generated/models/CovalReportsAPIError.ts

@@ -56,6 +56,7 @@ export const CovalReportsAPIErrorCodeEnum = {
     Unauthenticated: 'UNAUTHENTICATED',
     PermissionDenied: 'PERMISSION_DENIED',
     NotFound: 'NOT_FOUND',
+    FailedPrecondition: 'FAILED_PRECONDITION',
     Internal: 'INTERNAL'
 } as const;
 export type CovalReportsAPIErrorCodeEnum = typeof CovalReportsAPIErrorCodeEnum[keyof typeof CovalReportsAPIErrorCodeEnum];

package/src/generated/models/CovalReportsAPIGetReportResponse.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime.js';
-import type { CovalReportsAPIReport } from './CovalReportsAPIReport.js';
+import type { CovalReportsAPIReportDetail } from './CovalReportsAPIReportDetail.js';
 import {
-    CovalReportsAPIReportFromJSON,
-    CovalReportsAPIReportFromJSONTyped,
-    CovalReportsAPIReportToJSON,
-    CovalReportsAPIReportToJSONTyped,
-} from './CovalReportsAPIReport.js';
+    CovalReportsAPIReportDetailFromJSON,
+    CovalReportsAPIReportDetailFromJSONTyped,
+    CovalReportsAPIReportDetailToJSON,
+    CovalReportsAPIReportDetailToJSONTyped,
+} from './CovalReportsAPIReportDetail.js';
 
 /**
  * 
@@ -29,10 +29,10 @@ import {
 export interface CovalReportsAPIGetReportResponse {
     /**
      * 
-     * @type {CovalReportsAPIReport}
+     * @type {CovalReportsAPIReportDetail}
      * @memberof CovalReportsAPIGetReportResponse
      */
-    report: CovalReportsAPIReport;
+    report: CovalReportsAPIReportDetail;
 }
 
 /**
@@ -53,7 +53,7 @@ export function CovalReportsAPIGetReportResponseFromJSONTyped(json: any, ignoreD
     }
     return {
         
-        'report': CovalReportsAPIReportFromJSON(json['report']),
+        'report': CovalReportsAPIReportDetailFromJSON(json['report']),
     };
 }
 
@@ -68,7 +68,7 @@ export function CovalReportsAPIGetReportResponseToJSONTyped(value?: CovalReports
 
     return {
         
-        'report': CovalReportsAPIReportToJSON(value['report']),
+        'report': CovalReportsAPIReportDetailToJSON(value['report']),
     };
 }
 

package/src/generated/models/CovalReportsAPIMonitoringFiltersConfiguration.ts

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * 
+ * @export
+ * @interface CovalReportsAPIMonitoringFiltersConfiguration
+ */
+export interface CovalReportsAPIMonitoringFiltersConfiguration {
+    /**
+     * Inclusive start of the saved dynamic monitoring cohort.
+     * @type {Date}
+     * @memberof CovalReportsAPIMonitoringFiltersConfiguration
+     */
+    start_date: Date | null;
+    /**
+     * Inclusive end of the saved dynamic monitoring cohort.
+     * @type {Date}
+     * @memberof CovalReportsAPIMonitoringFiltersConfiguration
+     */
+    end_date: Date | null;
+    /**
+     * Whether the saved cohort selects monitoring rather than simulation rows.
+     * @type {boolean}
+     * @memberof CovalReportsAPIMonitoringFiltersConfiguration
+     */
+    monitoring_filter: boolean | null;
+}
+
+/**
+ * Check if a given object implements the CovalReportsAPIMonitoringFiltersConfiguration interface.
+ */
+export function instanceOfCovalReportsAPIMonitoringFiltersConfiguration(value: object): value is CovalReportsAPIMonitoringFiltersConfiguration {
+    if (!('start_date' in value) || value['start_date'] === undefined) return false;
+    if (!('end_date' in value) || value['end_date'] === undefined) return false;
+    if (!('monitoring_filter' in value) || value['monitoring_filter'] === undefined) return false;
+    return true;
+}
+
+export function CovalReportsAPIMonitoringFiltersConfigurationFromJSON(json: any): CovalReportsAPIMonitoringFiltersConfiguration {
+    return CovalReportsAPIMonitoringFiltersConfigurationFromJSONTyped(json, false);
+}
+
+export function CovalReportsAPIMonitoringFiltersConfigurationFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalReportsAPIMonitoringFiltersConfiguration {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'start_date': (json['start_date'] == null ? null : new Date(json['start_date'])),
+        'end_date': (json['end_date'] == null ? null : new Date(json['end_date'])),
+        'monitoring_filter': json['monitoring_filter'],
+    };
+}
+
+export function CovalReportsAPIMonitoringFiltersConfigurationToJSON(json: any): CovalReportsAPIMonitoringFiltersConfiguration {
+    return CovalReportsAPIMonitoringFiltersConfigurationToJSONTyped(json, false);
+}
+
+export function CovalReportsAPIMonitoringFiltersConfigurationToJSONTyped(value?: CovalReportsAPIMonitoringFiltersConfiguration | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'start_date': value['start_date'] == null ? value['start_date'] : value['start_date'].toISOString(),
+        'end_date': value['end_date'] == null ? value['end_date'] : value['end_date'].toISOString(),
+        'monitoring_filter': value['monitoring_filter'],
+    };
+}
+

package/src/generated/models/CovalReportsAPIMonitoringFiltersPatch.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * 
+ * @export
+ * @interface CovalReportsAPIMonitoringFiltersPatch
+ */
+export interface CovalReportsAPIMonitoringFiltersPatch {
+    /**
+     * Inclusive cohort start. Send null to clear the saved bound.
+     * @type {Date}
+     * @memberof CovalReportsAPIMonitoringFiltersPatch
+     */
+    start_date?: Date | null;
+    /**
+     * Inclusive cohort end. Send null to clear the saved bound.
+     * @type {Date}
+     * @memberof CovalReportsAPIMonitoringFiltersPatch
+     */
+    end_date?: Date | null;
+    /**
+     * Select monitoring (`true`) or simulation (`false`) summaries.
+     * @type {boolean}
+     * @memberof CovalReportsAPIMonitoringFiltersPatch
+     */
+    monitoring_filter?: boolean;
+}
+
+/**
+ * Check if a given object implements the CovalReportsAPIMonitoringFiltersPatch interface.
+ */
+export function instanceOfCovalReportsAPIMonitoringFiltersPatch(value: object): value is CovalReportsAPIMonitoringFiltersPatch {
+    return true;
+}
+
+export function CovalReportsAPIMonitoringFiltersPatchFromJSON(json: any): CovalReportsAPIMonitoringFiltersPatch {
+    return CovalReportsAPIMonitoringFiltersPatchFromJSONTyped(json, false);
+}
+
+export function CovalReportsAPIMonitoringFiltersPatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalReportsAPIMonitoringFiltersPatch {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'start_date': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
+        'end_date': json['end_date'] == null ? undefined : (new Date(json['end_date'])),
+        'monitoring_filter': json['monitoring_filter'] == null ? undefined : json['monitoring_filter'],
+    };
+}
+
+export function CovalReportsAPIMonitoringFiltersPatchToJSON(json: any): CovalReportsAPIMonitoringFiltersPatch {
+    return CovalReportsAPIMonitoringFiltersPatchToJSONTyped(json, false);
+}
+
+export function CovalReportsAPIMonitoringFiltersPatchToJSONTyped(value?: CovalReportsAPIMonitoringFiltersPatch | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'start_date': value['start_date'] == null ? value['start_date'] : value['start_date'].toISOString(),
+        'end_date': value['end_date'] == null ? value['end_date'] : value['end_date'].toISOString(),
+        'monitoring_filter': value['monitoring_filter'],
+    };
+}
+

package/src/generated/models/CovalReportsAPIReport.ts

@@ -76,6 +76,12 @@ export interface CovalReportsAPIReport {
      * @memberof CovalReportsAPIReport
      */
     metadata_key: string | null;
+    /**
+     * Custom dimension used for grouping when `compare_by` is `custom`; null otherwise.
+     * @type {string}
+     * @memberof CovalReportsAPIReport
+     */
+    custom_dimension_id?: string | null;
     /**
      * 
      * @type {CovalReportsAPIReportPermission}
@@ -116,6 +122,7 @@ export function CovalReportsAPIReportFromJSONTyped(json: any, ignoreDiscriminato
         'source_human_review_project_id': json['source_human_review_project_id'] == null ? undefined : json['source_human_review_project_id'],
         'compare_by': CovalReportsAPICompareByFromJSON(json['compare_by']),
         'metadata_key': json['metadata_key'],
+        'custom_dimension_id': json['custom_dimension_id'] == null ? undefined : json['custom_dimension_id'],
         'permissions': CovalReportsAPIReportPermissionFromJSON(json['permissions']),
     };
 }
@@ -138,6 +145,7 @@ export function CovalReportsAPIReportToJSONTyped(value?: CovalReportsAPIReport |
         'source_human_review_project_id': value['source_human_review_project_id'],
         'compare_by': CovalReportsAPICompareByToJSON(value['compare_by']),
         'metadata_key': value['metadata_key'],
+        'custom_dimension_id': value['custom_dimension_id'],
         'permissions': CovalReportsAPIReportPermissionToJSON(value['permissions']),
     };
 }

package/src/generated/models/CovalReportsAPIReportCustomDimension.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+import type { CovalReportsAPIReportCustomDimensionGroup } from './CovalReportsAPIReportCustomDimensionGroup.js';
+import {
+    CovalReportsAPIReportCustomDimensionGroupFromJSON,
+    CovalReportsAPIReportCustomDimensionGroupFromJSONTyped,
+    CovalReportsAPIReportCustomDimensionGroupToJSON,
+    CovalReportsAPIReportCustomDimensionGroupToJSONTyped,
+} from './CovalReportsAPIReportCustomDimensionGroup.js';
+
+/**
+ * 
+ * @export
+ * @interface CovalReportsAPIReportCustomDimension
+ */
+export interface CovalReportsAPIReportCustomDimension {
+    /**
+     * Caller-chosen dimension ID, unique within the report.
+     * @type {string}
+     * @memberof CovalReportsAPIReportCustomDimension
+     */
+    id: string;
+    /**
+     * Dimension label shown in the report.
+     * @type {string}
+     * @memberof CovalReportsAPIReportCustomDimension
+     */
+    name: string;
+    /**
+     * 
+     * @type {Array<CovalReportsAPIReportCustomDimensionGroup>}
+     * @memberof CovalReportsAPIReportCustomDimension
+     */
+    groups: Array<CovalReportsAPIReportCustomDimensionGroup>;
+    /**
+     * Hide simulations that no group claims instead of collecting them into an
+     * Unassigned group.
+     * 
+     * @type {boolean}
+     * @memberof CovalReportsAPIReportCustomDimension
+     */
+    hide_unassigned?: boolean;
+}
+
+/**
+ * Check if a given object implements the CovalReportsAPIReportCustomDimension interface.
+ */
+export function instanceOfCovalReportsAPIReportCustomDimension(value: object): value is CovalReportsAPIReportCustomDimension {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('groups' in value) || value['groups'] === undefined) return false;
+    return true;
+}
+
+export function CovalReportsAPIReportCustomDimensionFromJSON(json: any): CovalReportsAPIReportCustomDimension {
+    return CovalReportsAPIReportCustomDimensionFromJSONTyped(json, false);
+}
+
+export function CovalReportsAPIReportCustomDimensionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalReportsAPIReportCustomDimension {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'groups': ((json['groups'] as Array<any>).map(CovalReportsAPIReportCustomDimensionGroupFromJSON)),
+        'hide_unassigned': json['hide_unassigned'] == null ? undefined : json['hide_unassigned'],
+    };
+}
+
+export function CovalReportsAPIReportCustomDimensionToJSON(json: any): CovalReportsAPIReportCustomDimension {
+    return CovalReportsAPIReportCustomDimensionToJSONTyped(json, false);
+}
+
+export function CovalReportsAPIReportCustomDimensionToJSONTyped(value?: CovalReportsAPIReportCustomDimension | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'groups': ((value['groups'] as Array<any>).map(CovalReportsAPIReportCustomDimensionGroupToJSON)),
+        'hide_unassigned': value['hide_unassigned'],
+    };
+}
+

package/src/generated/models/CovalReportsAPIReportCustomDimensionGroup.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * 
+ * @export
+ * @interface CovalReportsAPIReportCustomDimensionGroup
+ */
+export interface CovalReportsAPIReportCustomDimensionGroup {
+    /**
+     * Caller-chosen group ID, unique within the dimension.
+     * @type {string}
+     * @memberof CovalReportsAPIReportCustomDimensionGroup
+     */
+    id: string;
+    /**
+     * Group label shown in the report.
+     * @type {string}
+     * @memberof CovalReportsAPIReportCustomDimensionGroup
+     */
+    name: string;
+    /**
+     * Simulation IDs assigned to this group.
+     * @type {Array<string>}
+     * @memberof CovalReportsAPIReportCustomDimensionGroup
+     */
+    simulation_ids?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the CovalReportsAPIReportCustomDimensionGroup interface.
+ */
+export function instanceOfCovalReportsAPIReportCustomDimensionGroup(value: object): value is CovalReportsAPIReportCustomDimensionGroup {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CovalReportsAPIReportCustomDimensionGroupFromJSON(json: any): CovalReportsAPIReportCustomDimensionGroup {
+    return CovalReportsAPIReportCustomDimensionGroupFromJSONTyped(json, false);
+}
+
+export function CovalReportsAPIReportCustomDimensionGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalReportsAPIReportCustomDimensionGroup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'simulation_ids': json['simulation_ids'] == null ? undefined : json['simulation_ids'],
+    };
+}
+
+export function CovalReportsAPIReportCustomDimensionGroupToJSON(json: any): CovalReportsAPIReportCustomDimensionGroup {
+    return CovalReportsAPIReportCustomDimensionGroupToJSONTyped(json, false);
+}
+
+export function CovalReportsAPIReportCustomDimensionGroupToJSONTyped(value?: CovalReportsAPIReportCustomDimensionGroup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'simulation_ids': value['simulation_ids'],
+    };
+}
+