@coval/sdk 0.7.1 → 0.9.3

package/dist/generated/apis/PythonMetricsApi.js

@@ -0,0 +1,291 @@
+/* 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 * as runtime from '../runtime.js';
+import { PythonMetricsAPICreatePythonMetricDraftRequestToJSON, } from '../models/PythonMetricsAPICreatePythonMetricDraftRequest.js';
+import { PythonMetricsAPIPreviewPythonMetricBodyToJSON, } from '../models/PythonMetricsAPIPreviewPythonMetricBody.js';
+import { PythonMetricsAPIPublishPythonMetricBodyToJSON, } from '../models/PythonMetricsAPIPublishPythonMetricBody.js';
+import { PythonMetricsAPIPublishPythonMetricResponseFromJSON, } from '../models/PythonMetricsAPIPublishPythonMetricResponse.js';
+import { PythonMetricsAPIPythonMetricDraftResponseFromJSON, } from '../models/PythonMetricsAPIPythonMetricDraftResponse.js';
+import { PythonMetricsAPIPythonMetricPreviewsResponseFromJSON, } from '../models/PythonMetricsAPIPythonMetricPreviewsResponse.js';
+/**
+ *
+ */
+export class PythonMetricsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for cancelPythonMetricPreview without sending the request
+     */
+    async cancelPythonMetricPreviewRequestOpts(requestParameters) {
+        if (requestParameters['draftId'] == null) {
+            throw new runtime.RequiredError('draftId', 'Required parameter "draftId" was null or undefined when calling cancelPythonMetricPreview().');
+        }
+        if (requestParameters['previewId'] == null) {
+            throw new runtime.RequiredError('previewId', 'Required parameter "previewId" was null or undefined when calling cancelPythonMetricPreview().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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"); // Python_Metrics_API_ApiKeyAuth authentication
+        }
+        let urlPath = `/python-metric-drafts/{draft_id}/previews/{preview_id}/cancel`;
+        urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
+        urlPath = urlPath.replace('{preview_id}', encodeURIComponent(String(requestParameters['previewId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Cancel a pending preview. An already running evaluation cannot overwrite terminal cancellation.
+     * Cancel a historical preview
+     */
+    async cancelPythonMetricPreviewRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.cancelPythonMetricPreviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricPreviewsResponseFromJSON(jsonValue));
+    }
+    /**
+     * Cancel a pending preview. An already running evaluation cannot overwrite terminal cancellation.
+     * Cancel a historical preview
+     */
+    async cancelPythonMetricPreview(requestParameters, initOverrides) {
+        const response = await this.cancelPythonMetricPreviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for createPythonMetricDraft without sending the request
+     */
+    async createPythonMetricDraftRequestOpts(requestParameters) {
+        if (requestParameters['pythonMetricsAPICreatePythonMetricDraftRequest'] == null) {
+            throw new runtime.RequiredError('pythonMetricsAPICreatePythonMetricDraftRequest', 'Required parameter "pythonMetricsAPICreatePythonMetricDraftRequest" was null or undefined when calling createPythonMetricDraft().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        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"); // Python_Metrics_API_ApiKeyAuth authentication
+        }
+        let urlPath = `/python-metric-drafts`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PythonMetricsAPICreatePythonMetricDraftRequestToJSON(requestParameters['pythonMetricsAPICreatePythonMetricDraftRequest']),
+        };
+    }
+    /**
+     * Save an immutable hidden draft pinned to the accepted runtime. Source or input changes require another draft.
+     * Save a Python metric draft
+     */
+    async createPythonMetricDraftRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createPythonMetricDraftRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricDraftResponseFromJSON(jsonValue));
+    }
+    /**
+     * Save an immutable hidden draft pinned to the accepted runtime. Source or input changes require another draft.
+     * Save a Python metric draft
+     */
+    async createPythonMetricDraft(requestParameters, initOverrides) {
+        const response = await this.createPythonMetricDraftRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getPythonMetricDraft without sending the request
+     */
+    async getPythonMetricDraftRequestOpts(requestParameters) {
+        if (requestParameters['draftId'] == null) {
+            throw new runtime.RequiredError('draftId', 'Required parameter "draftId" was null or undefined when calling getPythonMetricDraft().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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"); // Python_Metrics_API_ApiKeyAuth authentication
+        }
+        let urlPath = `/python-metric-drafts/{draft_id}`;
+        urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Read the immutable definition and fingerprint of a draft in the authenticated workspace.
+     * Get a Python metric draft
+     */
+    async getPythonMetricDraftRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getPythonMetricDraftRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricDraftResponseFromJSON(jsonValue));
+    }
+    /**
+     * Read the immutable definition and fingerprint of a draft in the authenticated workspace.
+     * Get a Python metric draft
+     */
+    async getPythonMetricDraft(requestParameters, initOverrides) {
+        const response = await this.getPythonMetricDraftRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getPythonMetricPreview without sending the request
+     */
+    async getPythonMetricPreviewRequestOpts(requestParameters) {
+        if (requestParameters['draftId'] == null) {
+            throw new runtime.RequiredError('draftId', 'Required parameter "draftId" was null or undefined when calling getPythonMetricPreview().');
+        }
+        if (requestParameters['previewId'] == null) {
+            throw new runtime.RequiredError('previewId', 'Required parameter "previewId" was null or undefined when calling getPythonMetricPreview().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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"); // Python_Metrics_API_ApiKeyAuth authentication
+        }
+        let urlPath = `/python-metric-drafts/{draft_id}/previews/{preview_id}`;
+        urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
+        urlPath = urlPath.replace('{preview_id}', encodeURIComponent(String(requestParameters['previewId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Read a preview outcome, including successful numeric zero or boolean false values.
+     * Get a historical preview result
+     */
+    async getPythonMetricPreviewRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getPythonMetricPreviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricPreviewsResponseFromJSON(jsonValue));
+    }
+    /**
+     * Read a preview outcome, including successful numeric zero or boolean false values.
+     * Get a historical preview result
+     */
+    async getPythonMetricPreview(requestParameters, initOverrides) {
+        const response = await this.getPythonMetricPreviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for previewPythonMetric without sending the request
+     */
+    async previewPythonMetricRequestOpts(requestParameters) {
+        if (requestParameters['draftId'] == null) {
+            throw new runtime.RequiredError('draftId', 'Required parameter "draftId" was null or undefined when calling previewPythonMetric().');
+        }
+        if (requestParameters['pythonMetricsAPIPreviewPythonMetricBody'] == null) {
+            throw new runtime.RequiredError('pythonMetricsAPIPreviewPythonMetricBody', 'Required parameter "pythonMetricsAPIPreviewPythonMetricBody" was null or undefined when calling previewPythonMetric().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        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"); // Python_Metrics_API_ApiKeyAuth authentication
+        }
+        let urlPath = `/python-metric-drafts/{draft_id}/previews`;
+        urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PythonMetricsAPIPreviewPythonMetricBodyToJSON(requestParameters['pythonMetricsAPIPreviewPythonMetricBody']),
+        };
+    }
+    /**
+     * Queue a historical conversation evaluation. Poll the returned preview ID for the durable result.
+     * Evaluate a draft on a historical conversation
+     */
+    async previewPythonMetricRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.previewPythonMetricRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricPreviewsResponseFromJSON(jsonValue));
+    }
+    /**
+     * Queue a historical conversation evaluation. Poll the returned preview ID for the durable result.
+     * Evaluate a draft on a historical conversation
+     */
+    async previewPythonMetric(requestParameters, initOverrides) {
+        const response = await this.previewPythonMetricRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for publishPythonMetric without sending the request
+     */
+    async publishPythonMetricRequestOpts(requestParameters) {
+        if (requestParameters['draftId'] == null) {
+            throw new runtime.RequiredError('draftId', 'Required parameter "draftId" was null or undefined when calling publishPythonMetric().');
+        }
+        if (requestParameters['pythonMetricsAPIPublishPythonMetricBody'] == null) {
+            throw new runtime.RequiredError('pythonMetricsAPIPublishPythonMetricBody', 'Required parameter "pythonMetricsAPIPublishPythonMetricBody" was null or undefined when calling publishPythonMetric().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        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"); // Python_Metrics_API_ApiKeyAuth authentication
+        }
+        let urlPath = `/python-metric-drafts/{draft_id}/publish`;
+        urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PythonMetricsAPIPublishPythonMetricBodyToJSON(requestParameters['pythonMetricsAPIPublishPythonMetricBody']),
+        };
+    }
+    /**
+     * Publish only when successful preview evidence matches this exact draft fingerprint and runtime version.
+     * Publish an approved and tested Python metric
+     */
+    async publishPythonMetricRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.publishPythonMetricRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPublishPythonMetricResponseFromJSON(jsonValue));
+    }
+    /**
+     * Publish only when successful preview evidence matches this exact draft fingerprint and runtime version.
+     * Publish an approved and tested Python metric
+     */
+    async publishPythonMetric(requestParameters, initOverrides) {
+        const response = await this.publishPythonMetricRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+//# sourceMappingURL=PythonMetricsApi.js.map

package/dist/generated/apis/PythonMetricsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PythonMetricsApi.js","sourceRoot":"","sources":["../../../src/generated/apis/PythonMetricsApi.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EAGH,oDAAoD,GACvD,MAAM,6DAA6D,CAAC;AACrE,OAAO,EAGH,6CAA6C,GAChD,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAGH,6CAA6C,GAChD,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAEH,mDAAmD,GAEtD,MAAM,0DAA0D,CAAC;AAClE,OAAO,EAEH,iDAAiD,GAEpD,MAAM,wDAAwD,CAAC;AAChE,OAAO,EAEH,oDAAoD,GAEvD,MAAM,2DAA2D,CAAC;AAiNnE;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,OAAO,CAAC,OAAO;IAEjD;;OAEG;IACH,KAAK,CAAC,oCAAoC,CAAC,iBAAmD;QAC1F,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,SAAS,EACT,8FAA8F,CACjG,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,WAAW,EACX,gGAAgG,CACnG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAClD,gBAAgB,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,+CAA+C;QACjI,CAAC;QAGD,IAAI,OAAO,GAAG,+DAA+D,CAAC;QAC9E,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAClG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtG,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,4BAA4B,CAAC,iBAAmD,EAAE,aAA0D;QAC9I,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,oCAAoC,CAAC,iBAAiB,CAAC,CAAC;QAC1F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,oDAAoD,CAAC,SAAS,CAAC,CAAC,CAAC;IACjI,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,yBAAyB,CAAC,iBAAmD,EAAE,aAA0D;QAC3I,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC3F,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kCAAkC,CAAC,iBAAiD;QACtF,IAAI,iBAAiB,CAAC,gDAAgD,CAAC,IAAI,IAAI,EAAE,CAAC;YAC9E,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,gDAAgD,EAChD,mIAAmI,CACtI,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAClD,gBAAgB,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,+CAA+C;QACjI,CAAC;QAGD,IAAI,OAAO,GAAG,uBAAuB,CAAC;QAEtC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,oDAAoD,CAAC,iBAAiB,CAAC,gDAAgD,CAAC,CAAC;SAClI,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,0BAA0B,CAAC,iBAAiD,EAAE,aAA0D;QAC1I,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,kCAAkC,CAAC,iBAAiB,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,iDAAiD,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9H,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAAiD,EAAE,aAA0D;QACvI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACzF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,+BAA+B,CAAC,iBAA8C;QAChF,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,SAAS,EACT,yFAAyF,CAC5F,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAClD,gBAAgB,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,+CAA+C;QACjI,CAAC;QAGD,IAAI,OAAO,GAAG,kCAAkC,CAAC;QACjD,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAElG,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAA8C,EAAE,aAA0D;QACpI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,+BAA+B,CAAC,iBAAiB,CAAC,CAAC;QACrF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,iDAAiD,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9H,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA8C,EAAE,aAA0D;QACjI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACtF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iCAAiC,CAAC,iBAAgD;QACpF,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,SAAS,EACT,2FAA2F,CAC9F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,WAAW,EACX,6FAA6F,CAChG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAClD,gBAAgB,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,+CAA+C;QACjI,CAAC;QAGD,IAAI,OAAO,GAAG,wDAAwD,CAAC;QACvE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAClG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtG,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,yBAAyB,CAAC,iBAAgD,EAAE,aAA0D;QACxI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iCAAiC,CAAC,iBAAiB,CAAC,CAAC;QACvF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,oDAAoD,CAAC,SAAS,CAAC,CAAC,CAAC;IACjI,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAAgD,EAAE,aAA0D;QACrI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACxF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,8BAA8B,CAAC,iBAA6C;QAC9E,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,SAAS,EACT,wFAAwF,CAC3F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,yCAAyC,CAAC,IAAI,IAAI,EAAE,CAAC;YACvE,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,yCAAyC,EACzC,wHAAwH,CAC3H,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAClD,gBAAgB,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,+CAA+C;QACjI,CAAC;QAGD,IAAI,OAAO,GAAG,2CAA2C,CAAC;QAC1D,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAElG,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,6CAA6C,CAAC,iBAAiB,CAAC,yCAAyC,CAAC,CAAC;SACpH,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAA6C,EAAE,aAA0D;QAClI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,CAAC,CAAC;QACpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,oDAAoD,CAAC,SAAS,CAAC,CAAC,CAAC;IACjI,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,iBAA6C,EAAE,aAA0D;QAC/H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACrF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,8BAA8B,CAAC,iBAA6C;QAC9E,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,SAAS,EACT,wFAAwF,CAC3F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,yCAAyC,CAAC,IAAI,IAAI,EAAE,CAAC;YACvE,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,yCAAyC,EACzC,wHAAwH,CAC3H,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAClD,gBAAgB,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,+CAA+C;QACjI,CAAC;QAGD,IAAI,OAAO,GAAG,0CAA0C,CAAC;QACzD,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAElG,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,6CAA6C,CAAC,iBAAiB,CAAC,yCAAyC,CAAC,CAAC;SACpH,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAA6C,EAAE,aAA0D;QAClI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,CAAC,CAAC;QACpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,mDAAmD,CAAC,SAAS,CAAC,CAAC,CAAC;IAChI,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,iBAA6C,EAAE,aAA0D;QAC/H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACrF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ"}

package/dist/generated/apis/ReviewAnnotationsApi.d.ts

@@ -58,23 +58,23 @@ 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
      */
     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>;
@@ -177,7 +177,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
@@ -189,7 +189,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>;
@@ -197,24 +197,24 @@ 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
      */
     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>;
@@ -228,12 +228,12 @@ export declare class ReviewAnnotationsApi extends runtime.BaseAPI implements Rev
      */
     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.
      * Create review annotation
      */
     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>;
@@ -298,12 +298,12 @@ export declare class ReviewAnnotationsApi extends runtime.BaseAPI implements Rev
      */
     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.
      * List review annotations
      */
     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>;
@@ -312,12 +312,12 @@ export declare class ReviewAnnotationsApi extends runtime.BaseAPI implements Rev
      */
     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.
      * Update review annotation
      */
     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>;

package/dist/generated/apis/ReviewAnnotationsApi.js

@@ -51,7 +51,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * 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, initOverrides) {
@@ -60,7 +60,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => CovalReviewsAPICreateReviewAnnotationResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {
@@ -255,7 +255,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * 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, initOverrides) {
@@ -264,7 +264,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => CovalReviewsAPIListReviewAnnotationsResponseFromJSON(jsonValue));
     }
     /**
-     * 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 = {}, initOverrides) {
@@ -301,7 +301,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * 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, initOverrides) {
@@ -310,7 +310,7 @@ export class ReviewAnnotationsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => CovalReviewsAPIUpdateReviewAnnotationResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {

package/dist/generated/apis/ReviewProjectsApi.d.ts

@@ -109,7 +109,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.
@@ -119,7 +119,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>;
@@ -339,12 +339,12 @@ export declare class ReviewProjectsApi extends runtime.BaseAPI implements Review
      */
     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.
      * Create review project
      */
     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>;

package/dist/generated/apis/ReviewProjectsApi.js

@@ -101,7 +101,7 @@ export class ReviewProjectsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * 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, initOverrides) {
@@ -110,7 +110,7 @@ export class ReviewProjectsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => CovalReviewsAPICreateReviewProjectResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {