@coval/sdk 0.7.1 → 0.9.3

package/src/generated/apis/ReviewAnnotationsApi.ts

@@ -110,17 +110,17 @@ export interface ReviewAnnotationsApiInterface {
     /**
      * Creates request options for createReviewAnnotation without sending the request
      * @param {CovalReviewsAPICreateReviewAnnotationRequest} covalReviewsAPICreateReviewAnnotationRequest 
-     * @param {string} [projectId] Optional project ID to apply project-rule-aware completion status
+     * @param {string} [projectId] Optional project ID. The simulation output, metric, and reviewer must match an assignment in this project. Applies project rules to the returned completion status. 
      * @throws {RequiredError}
      * @memberof ReviewAnnotationsApiInterface
      */
     createReviewAnnotationRequestOpts(requestParameters: CreateReviewAnnotationRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Create a new review annotation for your organization.
+     * Create or update the saved annotation for a simulation output, metric, and reviewer. Project creation does not create these annotation records. Use the returned `review_annotation.id` with PATCH for later partial updates. Repeating POST replaces the saved answer fields, including clearing omitted optional answer fields. 
      * @summary Create review annotation
      * @param {CovalReviewsAPICreateReviewAnnotationRequest} covalReviewsAPICreateReviewAnnotationRequest 
-     * @param {string} [projectId] Optional project ID to apply project-rule-aware completion status
+     * @param {string} [projectId] Optional project ID. The simulation output, metric, and reviewer must match an assignment in this project. Applies project rules to the returned completion status. 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReviewAnnotationsApiInterface
@@ -128,7 +128,7 @@ export interface ReviewAnnotationsApiInterface {
     createReviewAnnotationRaw(requestParameters: CreateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPICreateReviewAnnotationResponse>>;
 
     /**
-     * Create a new review annotation for your organization.
+     * Create or update the saved annotation for a simulation output, metric, and reviewer. Project creation does not create these annotation records. Use the returned `review_annotation.id` with PATCH for later partial updates. Repeating POST replaces the saved answer fields, including clearing omitted optional answer fields. 
      * Create review annotation
      */
     createReviewAnnotation(requestParameters: CreateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPICreateReviewAnnotationResponse>;
@@ -245,7 +245,7 @@ export interface ReviewAnnotationsApiInterface {
     listReviewAnnotationsRequestOpts(requestParameters: ListReviewAnnotationsRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * List review annotations for your organization with optional filtering, sorting, and pagination.
+     * List saved review annotations for your organization with optional filtering, sorting, and pagination. A `project_id` filter returns saved annotations matching that project\'s assignments; it does not list unannotated assignments. A project can have assigned review work and an empty annotation list. 
      * @summary List review annotations
      * @param {number} [pageSize] Maximum number of results per page
      * @param {string} [pageToken] Opaque pagination token from previous response
@@ -258,7 +258,7 @@ export interface ReviewAnnotationsApiInterface {
     listReviewAnnotationsRaw(requestParameters: ListReviewAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPIListReviewAnnotationsResponse>>;
 
     /**
-     * List review annotations for your organization with optional filtering, sorting, and pagination.
+     * List saved review annotations for your organization with optional filtering, sorting, and pagination. A `project_id` filter returns saved annotations matching that project\'s assignments; it does not list unannotated assignments. A project can have assigned review work and an empty annotation list. 
      * List review annotations
      */
     listReviewAnnotations(requestParameters: ListReviewAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPIListReviewAnnotationsResponse>;
@@ -267,18 +267,18 @@ export interface ReviewAnnotationsApiInterface {
      * Creates request options for updateReviewAnnotation without sending the request
      * @param {string} annotationId The annotation ID
      * @param {CovalReviewsAPIUpdateReviewAnnotationRequest} covalReviewsAPIUpdateReviewAnnotationRequest 
-     * @param {string} [projectId] Optional project ID to apply project-rule-aware completion status
+     * @param {string} [projectId] Optional project ID. The annotation must match an assignment in this project. Applies project rules to the returned completion status. 
      * @throws {RequiredError}
      * @memberof ReviewAnnotationsApiInterface
      */
     updateReviewAnnotationRequestOpts(requestParameters: UpdateReviewAnnotationRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Partially update a review annotation. Providing a ground truth value auto-sets `completion_status` to `COMPLETED`. 
+     * Partially update an existing saved review annotation using its annotation ID. Create the annotation with POST before attempting to update it; project assignment IDs cannot be used as annotation IDs. The reviewer cannot be changed. A different non-null `assignee` returns HTTP 400 (`INVALID_ARGUMENT`); create an annotation for that reviewer instead. Completion status is derived from saved ground truth and, when `project_id` is supplied, the applicable project rules. 
      * @summary Update review annotation
      * @param {string} annotationId The annotation ID
      * @param {CovalReviewsAPIUpdateReviewAnnotationRequest} covalReviewsAPIUpdateReviewAnnotationRequest 
-     * @param {string} [projectId] Optional project ID to apply project-rule-aware completion status
+     * @param {string} [projectId] Optional project ID. The annotation must match an assignment in this project. Applies project rules to the returned completion status. 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReviewAnnotationsApiInterface
@@ -286,7 +286,7 @@ export interface ReviewAnnotationsApiInterface {
     updateReviewAnnotationRaw(requestParameters: UpdateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPIUpdateReviewAnnotationResponse>>;
 
     /**
-     * Partially update a review annotation. Providing a ground truth value auto-sets `completion_status` to `COMPLETED`. 
+     * Partially update an existing saved review annotation using its annotation ID. Create the annotation with POST before attempting to update it; project assignment IDs cannot be used as annotation IDs. The reviewer cannot be changed. A different non-null `assignee` returns HTTP 400 (`INVALID_ARGUMENT`); create an annotation for that reviewer instead. Completion status is derived from saved ground truth and, when `project_id` is supplied, the applicable project rules. 
      * Update review annotation
      */
     updateReviewAnnotation(requestParameters: UpdateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPIUpdateReviewAnnotationResponse>;
@@ -336,7 +336,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI implements ReviewAnnot
     }
 
     /**
-     * Create a new review annotation for your organization.
+     * Create or update the saved annotation for a simulation output, metric, and reviewer. Project creation does not create these annotation records. Use the returned `review_annotation.id` with PATCH for later partial updates. Repeating POST replaces the saved answer fields, including clearing omitted optional answer fields. 
      * Create review annotation
      */
     async createReviewAnnotationRaw(requestParameters: CreateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPICreateReviewAnnotationResponse>> {
@@ -347,7 +347,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI implements ReviewAnnot
     }
 
     /**
-     * Create a new review annotation for your organization.
+     * Create or update the saved annotation for a simulation output, metric, and reviewer. Project creation does not create these annotation records. Use the returned `review_annotation.id` with PATCH for later partial updates. Repeating POST replaces the saved answer fields, including clearing omitted optional answer fields. 
      * Create review annotation
      */
     async createReviewAnnotation(requestParameters: CreateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPICreateReviewAnnotationResponse> {
@@ -605,7 +605,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI implements ReviewAnnot
     }
 
     /**
-     * List review annotations for your organization with optional filtering, sorting, and pagination.
+     * List saved review annotations for your organization with optional filtering, sorting, and pagination. A `project_id` filter returns saved annotations matching that project\'s assignments; it does not list unannotated assignments. A project can have assigned review work and an empty annotation list. 
      * List review annotations
      */
     async listReviewAnnotationsRaw(requestParameters: ListReviewAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPIListReviewAnnotationsResponse>> {
@@ -616,7 +616,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI implements ReviewAnnot
     }
 
     /**
-     * List review annotations for your organization with optional filtering, sorting, and pagination.
+     * List saved review annotations for your organization with optional filtering, sorting, and pagination. A `project_id` filter returns saved annotations matching that project\'s assignments; it does not list unannotated assignments. A project can have assigned review work and an empty annotation list. 
      * List review annotations
      */
     async listReviewAnnotations(requestParameters: ListReviewAnnotationsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPIListReviewAnnotationsResponse> {
@@ -670,7 +670,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI implements ReviewAnnot
     }
 
     /**
-     * Partially update a review annotation. Providing a ground truth value auto-sets `completion_status` to `COMPLETED`. 
+     * Partially update an existing saved review annotation using its annotation ID. Create the annotation with POST before attempting to update it; project assignment IDs cannot be used as annotation IDs. The reviewer cannot be changed. A different non-null `assignee` returns HTTP 400 (`INVALID_ARGUMENT`); create an annotation for that reviewer instead. Completion status is derived from saved ground truth and, when `project_id` is supplied, the applicable project rules. 
      * Update review annotation
      */
     async updateReviewAnnotationRaw(requestParameters: UpdateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPIUpdateReviewAnnotationResponse>> {
@@ -681,7 +681,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI implements ReviewAnnot
     }
 
     /**
-     * Partially update a review annotation. Providing a ground truth value auto-sets `completion_status` to `COMPLETED`. 
+     * Partially update an existing saved review annotation using its annotation ID. Create the annotation with POST before attempting to update it; project assignment IDs cannot be used as annotation IDs. The reviewer cannot be changed. A different non-null `assignee` returns HTTP 400 (`INVALID_ARGUMENT`); create an annotation for that reviewer instead. Completion status is derived from saved ground truth and, when `project_id` is supplied, the applicable project rules. 
      * Update review annotation
      */
     async updateReviewAnnotation(requestParameters: UpdateReviewAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPIUpdateReviewAnnotationResponse> {

package/src/generated/apis/ReviewProjectsApi.ts

@@ -184,7 +184,7 @@ export interface ReviewProjectsApiInterface {
     createReviewProjectRequestOpts(requestParameters: CreateReviewProjectRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Create a new review project. Automatically generates annotations for every (simulation, metric, assignee) combination. 
+     * Create a new review project defining assignments for the configured (simulation, metric, assignee) combinations. Assignments track review work separately from saved annotations. Submit review data with POST `/review-annotations` and use the returned annotation ID for later edits. 
      * @summary Create review project
      * @param {CovalReviewsAPICreateReviewProjectRequest} covalReviewsAPICreateReviewProjectRequest 
      * @param {string} [xCovalWorkspaceId] Workspace that scopes this operation. When omitted, the organization\&#39;s active default workspace is used when one can be resolved.
@@ -195,7 +195,7 @@ export interface ReviewProjectsApiInterface {
     createReviewProjectRaw(requestParameters: CreateReviewProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPICreateReviewProjectResponse>>;
 
     /**
-     * Create a new review project. Automatically generates annotations for every (simulation, metric, assignee) combination. 
+     * Create a new review project defining assignments for the configured (simulation, metric, assignee) combinations. Assignments track review work separately from saved annotations. Submit review data with POST `/review-annotations` and use the returned annotation ID for later edits. 
      * Create review project
      */
     createReviewProject(requestParameters: CreateReviewProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPICreateReviewProjectResponse>;
@@ -526,7 +526,7 @@ export class ReviewProjectsApi extends runtime.BaseAPI implements ReviewProjects
     }
 
     /**
-     * Create a new review project. Automatically generates annotations for every (simulation, metric, assignee) combination. 
+     * Create a new review project defining assignments for the configured (simulation, metric, assignee) combinations. Assignments track review work separately from saved annotations. Submit review data with POST `/review-annotations` and use the returned annotation ID for later edits. 
      * Create review project
      */
     async createReviewProjectRaw(requestParameters: CreateReviewProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReviewsAPICreateReviewProjectResponse>> {
@@ -537,7 +537,7 @@ export class ReviewProjectsApi extends runtime.BaseAPI implements ReviewProjects
     }
 
     /**
-     * Create a new review project. Automatically generates annotations for every (simulation, metric, assignee) combination. 
+     * Create a new review project defining assignments for the configured (simulation, metric, assignee) combinations. Assignments track review work separately from saved annotations. Submit review data with POST `/review-annotations` and use the returned annotation ID for later edits. 
      * Create review project
      */
     async createReviewProject(requestParameters: CreateReviewProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReviewsAPICreateReviewProjectResponse> {

package/src/generated/apis/SimulatedConversationsApi.ts

@@ -84,6 +84,7 @@ export interface GetSimulatedConversationAudioRequest {
 export interface GetSimulationAttributeRequest {
     simulationId: string;
     attributeName: string;
+    xCovalWorkspaceId?: string;
 }
 
 export interface GetSimulationConnectRequest {
@@ -128,7 +129,7 @@ export interface SimulatedConversationsApiInterface {
     deleteSimulatedConversationRequestOpts(requestParameters: DeleteSimulatedConversationRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Cancel or delete a simulation.
+     * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
      * @summary Delete or cancel simulation
      * @param {string} simulationId The simulation ID to delete/cancel
      * @param {*} [options] Override http request option.
@@ -138,7 +139,7 @@ export interface SimulatedConversationsApiInterface {
     deleteSimulatedConversationRaw(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Cancel or delete a simulation.
+     * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
      * Delete or cancel simulation
      */
     deleteSimulatedConversation(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -193,18 +194,20 @@ export interface SimulatedConversationsApiInterface {
 
     /**
      * Creates request options for getSimulationAttribute without sending the request
-     * @param {string} simulationId 
-     * @param {string} attributeName 
+     * @param {string} simulationId Simulation output ID for the conversation. Pass {{simulation_output_id}} to your backend through a supported connection field and use the received value here. 
+     * @param {string} attributeName Exact, case-sensitive top-level key in the test case\&#39;s expected_output_json. Dots are literal characters. URL-encode special characters. 
+     * @param {string} [xCovalWorkspaceId] Workspace containing the simulation. Omit to use the organization\&#39;s default workspace. A resolved, accessible workspace is required. 
      * @throws {RequiredError}
      * @memberof SimulatedConversationsApiInterface
      */
     getSimulationAttributeRequestOpts(requestParameters: GetSimulationAttributeRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB. 
+     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB.  See [Retrieve test-case attributes during a simulation](https://docs.coval.ai/concepts/attributes/overview#retrieve-test-case-attributes-during-a-simulation) for attribute setup, passing the simulation ID to your backend, and request examples. 
      * @summary Retrieve a named simulation attribute
-     * @param {string} simulationId 
-     * @param {string} attributeName 
+     * @param {string} simulationId Simulation output ID for the conversation. Pass {{simulation_output_id}} to your backend through a supported connection field and use the received value here. 
+     * @param {string} attributeName Exact, case-sensitive top-level key in the test case\&#39;s expected_output_json. Dots are literal characters. URL-encode special characters. 
+     * @param {string} [xCovalWorkspaceId] Workspace containing the simulation. Omit to use the organization\&#39;s default workspace. A resolved, accessible workspace is required. 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SimulatedConversationsApiInterface
@@ -212,7 +215,7 @@ export interface SimulatedConversationsApiInterface {
     getSimulationAttributeRaw(requestParameters: GetSimulationAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSimulationAttribute200Response>>;
 
     /**
-     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB. 
+     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB.  See [Retrieve test-case attributes during a simulation](https://docs.coval.ai/concepts/attributes/overview#retrieve-test-case-attributes-during-a-simulation) for attribute setup, passing the simulation ID to your backend, and request examples. 
      * Retrieve a named simulation attribute
      */
     getSimulationAttribute(requestParameters: GetSimulationAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSimulationAttribute200Response>;
@@ -388,7 +391,7 @@ export class SimulatedConversationsApi extends runtime.BaseAPI implements Simula
     }
 
     /**
-     * Cancel or delete a simulation.
+     * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
      * Delete or cancel simulation
      */
     async deleteSimulatedConversationRaw(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -399,7 +402,7 @@ export class SimulatedConversationsApi extends runtime.BaseAPI implements Simula
     }
 
     /**
-     * Cancel or delete a simulation.
+     * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
      * Delete or cancel simulation
      */
     async deleteSimulatedConversation(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -531,6 +534,10 @@ export class SimulatedConversationsApi extends runtime.BaseAPI implements Simula
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+        if (requestParameters['xCovalWorkspaceId'] != null) {
+            headerParameters['X-Coval-Workspace-Id'] = String(requestParameters['xCovalWorkspaceId']);
+        }
+
         if (this.configuration && this.configuration.apiKey) {
             headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Simulated_Conversations_API_ApiKeyAuth authentication
         }
@@ -549,7 +556,7 @@ export class SimulatedConversationsApi extends runtime.BaseAPI implements Simula
     }
 
     /**
-     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB. 
+     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB.  See [Retrieve test-case attributes during a simulation](https://docs.coval.ai/concepts/attributes/overview#retrieve-test-case-attributes-during-a-simulation) for attribute setup, passing the simulation ID to your backend, and request examples. 
      * Retrieve a named simulation attribute
      */
     async getSimulationAttributeRaw(requestParameters: GetSimulationAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSimulationAttribute200Response>> {
@@ -560,7 +567,7 @@ export class SimulatedConversationsApi extends runtime.BaseAPI implements Simula
     }
 
     /**
-     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB. 
+     * Returns an exact, case-sensitive top-level attribute from the simulation\'s current active test case. Names are literal keys, including dots, rather than paths. URL-encode names when necessary.  Requires simulations:read permission. The simulation, run, test case and test set must be accessible in the authenticated organization and workspace. A resolved workspace is required. Select one with X-Coval-Workspace-Id when the organization has no default workspace. Legacy unassigned rows are accessible only through the default workspace. Monitoring conversations and deleted runs are excluded. This endpoint can be used while a simulation is running or after it finishes.  JSON values return directly without an envelope. Null is a successful JSON value, while an absent attribute returns 404. Changes to the test case are visible on subsequent requests. This endpoint does not capture a snapshot or persist tool-call events.  An object with type: image_ref is reserved for image references and must contain attachment: <name>, matching exactly one media attachment on the test case. Image responses contain raw PNG/JPEG bytes, with a maximum size of 4 MiB. Ordinary objects without that marker return unchanged.  This deliberately returns content instead of an AIP-131 resource envelope: customer tool handlers consume the fixture directly, including image bytes. Both JSON and image response content are limited to 4 MiB.  See [Retrieve test-case attributes during a simulation](https://docs.coval.ai/concepts/attributes/overview#retrieve-test-case-attributes-during-a-simulation) for attribute setup, passing the simulation ID to your backend, and request examples. 
      * Retrieve a named simulation attribute
      */
     async getSimulationAttribute(requestParameters: GetSimulationAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSimulationAttribute200Response> {

package/src/generated/apis/index.ts

@@ -16,6 +16,7 @@ export * from './MutationsApi.js';
 export * from './OrganizationConversationsConfigApi.js';
 export * from './OrganizationUsersApi.js';
 export * from './PersonasApi.js';
+export * from './PythonMetricsApi.js';
 export * from './ReportsApi.js';
 export * from './ReviewAnnotationsApi.js';
 export * from './ReviewProjectsApi.js';

package/src/generated/models/CovalMetricsAPIMetricType.ts

@@ -30,6 +30,7 @@
  * - `METRIC_TRANSCRIPT_REGEX` - Regex pattern matching
  * - `METRIC_PAUSE_ANALYSIS` - Speech pause detection
  * - `METRIC_SQL_FLOAT` - Custom SQL query over the simulation's data (set `sql_query`)
+ * - `METRIC_PYTHON` - Tested Python metric; create and edit through the Python draft publication API.
  * - `METRIC_COMPOSITE_EVALUATION` - Judges a list of criteria independently and reports how
  *   many were met (set `criteria_source`, and `criteria_path` or `criteria` to match)
  * 
@@ -52,6 +53,7 @@ export const CovalMetricsAPIMetricType = {
     MetricAgentRefusal: 'METRIC_AGENT_REFUSAL',
     MetricPauseAnalysis: 'METRIC_PAUSE_ANALYSIS',
     MetricSqlFloat: 'METRIC_SQL_FLOAT',
+    MetricPython: 'METRIC_PYTHON',
     MetricCompositeEvaluation: 'METRIC_COMPOSITE_EVALUATION',
     MetricLlmTtfb: 'METRIC_LLM_TTFB',
     MetricTtsTtfb: 'METRIC_TTS_TTFB',

package/src/generated/models/CovalPersonasAPICreatePersonaRequest.ts

@@ -159,6 +159,15 @@ export interface CovalPersonasAPICreatePersonaRequest {
      * @memberof CovalPersonasAPICreatePersonaRequest
      */
     interruption_rate?: CovalPersonasAPICreatePersonaRequestInterruptionRateEnum | null;
+    /**
+     * Whether the persona follows interruption instructions in the test case or the
+     * persona prompt, interrupting the agent mid-utterance when one is met. Takes effect
+     * only for organizations with prompted interruptions enabled. Defaults to false.
+     * 
+     * @type {boolean}
+     * @memberof CovalPersonasAPICreatePersonaRequest
+     */
+    interruption_instructions_enabled?: boolean | null;
     /**
      * Enable multilingual speech-to-text so callers speaking languages
      * other than the primary language_code are still transcribed accurately.
@@ -281,6 +290,7 @@ export function CovalPersonasAPICreatePersonaRequestFromJSONTyped(json: any, ign
         'wait_seconds': json['wait_seconds'] == null ? undefined : json['wait_seconds'],
         'conversation_initiation': json['conversation_initiation'] == null ? undefined : json['conversation_initiation'],
         'interruption_rate': json['interruption_rate'] == null ? undefined : json['interruption_rate'],
+        'interruption_instructions_enabled': json['interruption_instructions_enabled'] == null ? undefined : json['interruption_instructions_enabled'],
         'multi_language_stt': json['multi_language_stt'] == null ? undefined : json['multi_language_stt'],
         'hold_music_timeout_seconds': json['hold_music_timeout_seconds'] == null ? undefined : json['hold_music_timeout_seconds'],
         'situate_speaker': json['situate_speaker'] == null ? undefined : json['situate_speaker'],
@@ -317,6 +327,7 @@ export function CovalPersonasAPICreatePersonaRequestToJSONTyped(value?: CovalPer
         'wait_seconds': value['wait_seconds'],
         'conversation_initiation': value['conversation_initiation'],
         'interruption_rate': value['interruption_rate'],
+        'interruption_instructions_enabled': value['interruption_instructions_enabled'],
         'multi_language_stt': value['multi_language_stt'],
         'hold_music_timeout_seconds': value['hold_music_timeout_seconds'],
         'situate_speaker': value['situate_speaker'],

package/src/generated/models/CovalPersonasAPIPersonaResource.ts

@@ -181,6 +181,15 @@ export interface CovalPersonasAPIPersonaResource {
      * @memberof CovalPersonasAPIPersonaResource
      */
     interruption_rate?: CovalPersonasAPIPersonaResourceInterruptionRateEnum;
+    /**
+     * Whether the persona follows interruption instructions in the test case or the
+     * persona prompt, interrupting the agent mid-utterance when one is met. Takes effect
+     * only for organizations with prompted interruptions enabled. Defaults to false.
+     * 
+     * @type {boolean}
+     * @memberof CovalPersonasAPIPersonaResource
+     */
+    interruption_instructions_enabled?: boolean;
     /**
      * Enable multilingual speech-to-text so callers speaking languages
      * other than the primary language_code are still transcribed accurately.
@@ -327,6 +336,7 @@ export function CovalPersonasAPIPersonaResourceFromJSONTyped(json: any, ignoreDi
         'wait_seconds': json['wait_seconds'] == null ? undefined : json['wait_seconds'],
         'conversation_initiation': json['conversation_initiation'] == null ? undefined : json['conversation_initiation'],
         'interruption_rate': json['interruption_rate'] == null ? undefined : json['interruption_rate'],
+        'interruption_instructions_enabled': json['interruption_instructions_enabled'] == null ? undefined : json['interruption_instructions_enabled'],
         'multi_language_stt': json['multi_language_stt'] == null ? undefined : json['multi_language_stt'],
         'hold_music_timeout_seconds': json['hold_music_timeout_seconds'] == null ? undefined : json['hold_music_timeout_seconds'],
         'situate_speaker': json['situate_speaker'] == null ? undefined : json['situate_speaker'],
@@ -367,6 +377,7 @@ export function CovalPersonasAPIPersonaResourceToJSONTyped(value?: Omit<CovalPer
         'wait_seconds': value['wait_seconds'],
         'conversation_initiation': value['conversation_initiation'],
         'interruption_rate': value['interruption_rate'],
+        'interruption_instructions_enabled': value['interruption_instructions_enabled'],
         'multi_language_stt': value['multi_language_stt'],
         'hold_music_timeout_seconds': value['hold_music_timeout_seconds'],
         'situate_speaker': value['situate_speaker'],

package/src/generated/models/CovalPersonasAPIUpdatePersonaRequest.ts

@@ -146,6 +146,16 @@ export interface CovalPersonasAPIUpdatePersonaRequest {
      * @memberof CovalPersonasAPIUpdatePersonaRequest
      */
     interruption_rate?: CovalPersonasAPIUpdatePersonaRequestInterruptionRateEnum | null;
+    /**
+     * Whether the persona follows interruption instructions in the test case or the
+     * persona prompt, interrupting the agent mid-utterance when one is met. Takes effect
+     * only for organizations with prompted interruptions enabled. Defaults to false. null
+     * is ignored; send false to disable.
+     * 
+     * @type {boolean}
+     * @memberof CovalPersonasAPIUpdatePersonaRequest
+     */
+    interruption_instructions_enabled?: boolean | null;
     /**
      * Enable multilingual speech-to-text so callers speaking languages other than the primary language_code are still transcribed accurately. Send null to clear an existing override.
      * @type {boolean}
@@ -264,6 +274,7 @@ export function CovalPersonasAPIUpdatePersonaRequestFromJSONTyped(json: any, ign
         'wait_seconds': json['wait_seconds'] == null ? undefined : json['wait_seconds'],
         'conversation_initiation': json['conversation_initiation'] == null ? undefined : json['conversation_initiation'],
         'interruption_rate': json['interruption_rate'] == null ? undefined : json['interruption_rate'],
+        'interruption_instructions_enabled': json['interruption_instructions_enabled'] == null ? undefined : json['interruption_instructions_enabled'],
         'multi_language_stt': json['multi_language_stt'] == null ? undefined : json['multi_language_stt'],
         'hold_music_timeout_seconds': json['hold_music_timeout_seconds'] == null ? undefined : json['hold_music_timeout_seconds'],
         'situate_speaker': json['situate_speaker'] == null ? undefined : json['situate_speaker'],
@@ -300,6 +311,7 @@ export function CovalPersonasAPIUpdatePersonaRequestToJSONTyped(value?: CovalPer
         'wait_seconds': value['wait_seconds'],
         'conversation_initiation': value['conversation_initiation'],
         'interruption_rate': value['interruption_rate'],
+        'interruption_instructions_enabled': value['interruption_instructions_enabled'],
         'multi_language_stt': value['multi_language_stt'],
         'hold_music_timeout_seconds': value['hold_music_timeout_seconds'],
         'situate_speaker': value['situate_speaker'],

package/src/generated/models/CovalReviewsAPICreateReviewAnnotationRequest.ts

@@ -44,13 +44,13 @@ export interface CovalReviewsAPICreateReviewAnnotationRequest {
      */
     assignee?: string | null;
     /**
-     * Optional ground truth numeric value (auto-completes annotation)
+     * Optional ground truth numeric value; completion also depends on applicable project rules
      * @type {number}
      * @memberof CovalReviewsAPICreateReviewAnnotationRequest
      */
     ground_truth_float_value?: number | null;
     /**
-     * Optional ground truth string value (auto-completes annotation)
+     * Optional ground truth string value; completion also depends on applicable project rules
      * @type {string}
      * @memberof CovalReviewsAPICreateReviewAnnotationRequest
      */

package/src/generated/models/CovalReviewsAPIProjectType.ts

@@ -14,7 +14,7 @@
 
 
 /**
- * Project type: COLLABORATIVE (shared annotations) or INDIVIDUAL (per-assignee annotations)
+ * Project review workflow type: PROJECT_COLLABORATIVE or PROJECT_INDIVIDUAL
  * @export
  */
 export const CovalReviewsAPIProjectType = {

package/src/generated/models/CovalReviewsAPIReviewAnnotationResource.ts

@@ -36,7 +36,7 @@ import {
 } from './CovalReviewsAPIAnnotationStatus.js';
 
 /**
- * A single review annotation resource.
+ * Saved review data for a simulation output, metric, and reviewer.
  * @export
  * @interface CovalReviewsAPIReviewAnnotationResource
  */
@@ -48,7 +48,7 @@ export interface CovalReviewsAPIReviewAnnotationResource {
      */
     name: string;
     /**
-     * Unique annotation ID
+     * Saved annotation ID used for GET, PATCH, and DELETE; not a project assignment ID
      * @type {string}
      * @memberof CovalReviewsAPIReviewAnnotationResource
      */

package/src/generated/models/CovalReviewsAPIReviewAnnotationWithMetricVersionResource.ts

@@ -48,7 +48,7 @@ export interface CovalReviewsAPIReviewAnnotationWithMetricVersionResource {
      */
     name: string;
     /**
-     * Unique annotation ID
+     * Saved annotation ID used for GET, PATCH, and DELETE; not a project assignment ID
      * @type {string}
      * @memberof CovalReviewsAPIReviewAnnotationWithMetricVersionResource
      */

package/src/generated/models/CovalReviewsAPIReviewProjectResource.ts

@@ -137,11 +137,17 @@ export interface CovalReviewsAPIReviewProjectResource {
      */
     enforced_collaboration?: boolean;
     /**
-     * Allow reviewers to skip linked metrics
+     * Allow reviewers to skip linked metrics. Rejected on collaborative projects unless enforced_collaboration is true.
      * @type {boolean}
      * @memberof CovalReviewsAPIReviewProjectResource
      */
     allow_metric_skipping?: boolean;
+    /**
+     * Metric IDs eligible for skipping. Null means all linked metrics; an empty list means none.
+     * @type {Array<string>}
+     * @memberof CovalReviewsAPIReviewProjectResource
+     */
+    skippable_metric_ids?: Array<string> | null;
     /**
      * Creation timestamp (ISO 8601)
      * @type {Date}
@@ -268,6 +274,7 @@ export function CovalReviewsAPIReviewProjectResourceFromJSONTyped(json: any, ign
         'project_rules': json['project_rules'] == null ? undefined : ((json['project_rules'] as Array<any>).map(CovalReviewsAPIProjectRuleFromJSON)),
         'enforced_collaboration': json['enforced_collaboration'] == null ? undefined : json['enforced_collaboration'],
         'allow_metric_skipping': json['allow_metric_skipping'] == null ? undefined : json['allow_metric_skipping'],
+        'skippable_metric_ids': json['skippable_metric_ids'] == null ? undefined : json['skippable_metric_ids'],
         'create_time': (new Date(json['create_time'])),
         'update_time': (new Date(json['update_time'])),
         'blind_labeling_shown_metric_ids': json['blind_labeling_shown_metric_ids'] == null ? undefined : json['blind_labeling_shown_metric_ids'],
@@ -305,6 +312,7 @@ export function CovalReviewsAPIReviewProjectResourceToJSONTyped(value?: Omit<Cov
         'project_rules': value['project_rules'] == null ? undefined : ((value['project_rules'] as Array<any>).map(CovalReviewsAPIProjectRuleToJSON)),
         'enforced_collaboration': value['enforced_collaboration'],
         'allow_metric_skipping': value['allow_metric_skipping'],
+        'skippable_metric_ids': value['skippable_metric_ids'],
         'create_time': value['create_time'].toISOString(),
         'update_time': value['update_time'].toISOString(),
         'blind_labeling_shown_metric_ids': value['blind_labeling_shown_metric_ids'],

package/src/generated/models/CovalReviewsAPIUpdateReviewAnnotationRequest.ts

@@ -28,13 +28,13 @@ import {
  */
 export interface CovalReviewsAPIUpdateReviewAnnotationRequest {
     /**
-     * Ground truth numeric value (auto-completes annotation)
+     * Ground truth numeric value; completion also depends on applicable project rules
      * @type {number}
      * @memberof CovalReviewsAPIUpdateReviewAnnotationRequest
      */
     ground_truth_float_value?: number | null;
     /**
-     * Ground truth string value (auto-completes annotation)
+     * Ground truth string value; completion also depends on applicable project rules
      * @type {string}
      * @memberof CovalReviewsAPIUpdateReviewAnnotationRequest
      */
@@ -58,7 +58,11 @@ export interface CovalReviewsAPIUpdateReviewAnnotationRequest {
      */
     priority?: CovalReviewsAPIAnnotationPriority;
     /**
-     * Reassign to a different reviewer
+     * Existing reviewer email, retained for compatibility. Omission, null,
+     * or the current value leaves the reviewer unchanged. A different
+     * non-null value is rejected with HTTP 400 (`INVALID_ARGUMENT`);
+     * create an annotation for that reviewer instead.
+     * 
      * @type {string}
      * @memberof CovalReviewsAPIUpdateReviewAnnotationRequest
      */

package/src/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.ts

@@ -118,11 +118,17 @@ export interface CovalReviewsAPIUpdateReviewProjectRequest {
      */
     enforced_collaboration?: boolean;
     /**
-     * Allow reviewers to skip linked metrics
+     * Allow reviewers to skip linked metrics. Rejected on collaborative projects unless enforced_collaboration is true.
      * @type {boolean}
      * @memberof CovalReviewsAPIUpdateReviewProjectRequest
      */
     allow_metric_skipping?: boolean;
+    /**
+     * Metric IDs eligible for skipping. Null means all linked metrics; omission preserves the current value.
+     * @type {Array<string>}
+     * @memberof CovalReviewsAPIUpdateReviewProjectRequest
+     */
+    skippable_metric_ids?: Array<string> | null;
     /**
      * 
      * @type {string}
@@ -218,6 +224,7 @@ export function CovalReviewsAPIUpdateReviewProjectRequestFromJSONTyped(json: any
         'opted_out_assignees': json['opted_out_assignees'] == null ? undefined : json['opted_out_assignees'],
         'enforced_collaboration': json['enforced_collaboration'] == null ? undefined : json['enforced_collaboration'],
         'allow_metric_skipping': json['allow_metric_skipping'] == null ? undefined : json['allow_metric_skipping'],
+        'skippable_metric_ids': json['skippable_metric_ids'],
         'project_type': json['project_type'] == null ? undefined : json['project_type'],
         'review_label_enabled': json['review_label_enabled'] == null ? undefined : json['review_label_enabled'],
         'review_label_input_mode': json['review_label_input_mode'] == null ? undefined : json['review_label_input_mode'],
@@ -253,6 +260,7 @@ export function CovalReviewsAPIUpdateReviewProjectRequestToJSONTyped(value?: Cov
         'opted_out_assignees': value['opted_out_assignees'],
         'enforced_collaboration': value['enforced_collaboration'],
         'allow_metric_skipping': value['allow_metric_skipping'],
+        'skippable_metric_ids': value['skippable_metric_ids'],
         'project_type': value['project_type'],
         'review_label_enabled': value['review_label_enabled'],
         'review_label_input_mode': value['review_label_input_mode'],

package/src/generated/models/CovalRunTemplatesAPIErrorResponseError.ts

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

package/src/generated/models/CovalRunsAPIError.ts

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

package/src/generated/models/CovalSimulatedConversationsAPIRerunSimulatedConversationMetricsRequest.ts

@@ -26,7 +26,7 @@ export interface CovalSimulatedConversationsAPIRerunSimulatedConversationMetrics
      */
     simulation_ids: Array<string>;
     /**
-     * Metric IDs (22-character ShortUUIDs) to run against every simulation. Up to 500 per call.
+     * Metric IDs (22 characters, allowing letters, digits, and hyphens) to run against every simulation. Up to 500 per call.
      * @type {Array<string>}
      * @memberof CovalSimulatedConversationsAPIRerunSimulatedConversationMetricsRequest
      */