@roarkanalytics/sdk 3.17.0 → 3.18.0

package/src/resources/simulation-template.ts

@@ -94,6 +94,20 @@ export namespace SimulationTemplateListResponse {
      */
     slug: string;
 
+    /**
+     * Set when this template is a property sweep: it runs ONE flow once per value of a
+     * single caller or environment property, and the report compares the values
+     * against `baseline`.
+     *
+     * This is what decides the size of the run. A sweep attaches the flow once per
+     * entry in `values`, so a plan built from it costs `values.length` times the calls
+     * a normal template would, before iterations. Read it before creating a plan you
+     * have to pay for.
+     *
+     * `null` for every other template.
+     */
+    sweep: Data.Sweep | null;
+
     /**
      * The Pass/Fail checks this template attaches alongside its metrics.
      */
@@ -182,6 +196,50 @@ export namespace SimulationTemplateListResponse {
       slug: string;
     }
 
+    /**
+     * Set when this template is a property sweep: it runs ONE flow once per value of a
+     * single caller or environment property, and the report compares the values
+     * against `baseline`.
+     *
+     * This is what decides the size of the run. A sweep attaches the flow once per
+     * entry in `values`, so a plan built from it costs `values.length` times the calls
+     * a normal template would, before iterations. Read it before creating a plan you
+     * have to pay for.
+     *
+     * `null` for every other template.
+     */
+    export interface Sweep {
+      /**
+       * The value the others are measured against, resolved to what a plan built from
+       * this template will actually record. `null` when the property has no obvious
+       * norm, and the report then compares against the best-performing value instead.
+       */
+      baseline: string | null;
+
+      /**
+       * The property this template varies across the flow it runs.
+       */
+      property:
+        | 'ACCENT'
+        | 'AGE'
+        | 'BACKGROUND_NOISE'
+        | 'BACKGROUND_NOISE_VOLUME'
+        | 'BASE_EMOTION'
+        | 'CONFIRMATION_STYLE'
+        | 'GENDER'
+        | 'INTENT_CLARITY'
+        | 'LANGUAGE'
+        | 'MEMORY_RELIABILITY'
+        | 'RESPONSE_TIMING'
+        | 'SPEECH_CLARITY'
+        | 'SPEECH_PACE';
+
+      /**
+       * Every value the template sweeps, in the order the plan attaches them.
+       */
+      values: Array<string>;
+    }
+
     export interface Threshold {
       /**
        * Metric definition ID

package/src/resources/simulation.ts

@@ -216,6 +216,20 @@ export declare namespace SimulationRunParams {
         | 'SPEECH_PACE'
         | null;
 
+      /**
+       * Which values of `comparisonProperty` to run. This is what the plan costs: the
+       * flow is attached once per value, so ten values is ten times the calls of one.
+       *
+       * Omit it to run every value the property has, which for `ACCENT` is more than
+       * twenty. Send a subset to narrow the sweep, for example three accents you
+       * actually serve. A `comparisonBaseline` outside this set is rejected, because it
+       * would anchor every difference to an arm the run never made.
+       *
+       * Not stored as a field: the arms are the values. Reading the plan back returns
+       * them as its flow attachments.
+       */
+      comparisonValues?: Array<string>;
+
       /**
        * Description of the run plan
        */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.17.0'; // x-release-please-version
+export const VERSION = '3.18.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.17.0";
+export declare const VERSION = "3.18.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.17.0";
+export declare const VERSION = "3.18.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.17.0'; // x-release-please-version
+exports.VERSION = '3.18.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.17.0'; // x-release-please-version
+export const VERSION = '3.18.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map