@roarkanalytics/sdk 4.6.0 → 4.8.0

package/src/resources/simulation.ts

@@ -276,9 +276,11 @@ export declare namespace SimulationRunParams {
       metrics: Array<Plan.Metric>;
 
       /**
-       * The value of `comparisonProperty` every other value is measured against, for
-       * example `NONE` for `BACKGROUND_NOISE` or `NORMAL` for `SPEECH_PACE`. Must be a
-       * value that property can take.
+       * The reference value of `comparisonProperty`, for example `NONE` for
+       * `BACKGROUND_NOISE` or `NORMAL` for `SPEECH_PACE`: shown first in the results.
+       * Must be a value that property can take. Whether a value did significantly worse
+       * does not depend on it: that is decided against every other value combined (see
+       * `sweepAttribution`).
        *
        * Stored rather than assumed, so the report can say "compared against US accent"
        * instead of implying Roark decided which value is normal. Most properties have an
@@ -734,8 +736,10 @@ export declare namespace SimulationRunParams {
     template: string;
 
     /**
-     * The value of the sweep every other value is measured against. Defaults to the
-     * template's own baseline, as returned by GET /v1/simulation/template.
+     * The sweep's reference value, shown first in the results. Defaults to the
+     * template's own baseline, as returned by GET /v1/simulation/template. Whether a
+     * value did significantly worse does not depend on it: that is decided against
+     * every other value combined.
      *
      * Send it with `comparisonValues` and it must be one of them, or the request is
      * rejected: anchoring every difference to an arm the run never made would measure
@@ -802,7 +806,9 @@ export declare namespace SimulationRunParams {
     flows?: Array<RunSimulationFromTemplate.Flow>;
 
     /**
-     * Number of iterations to run for each test case (1-10000)
+     * Runs per test case (1-10000). Defaults to 1, or to 6 for a template that sweeps
+     * a property. A sweep needs at least 5 calls per value (test cases per value times
+     * iterations) to compare its values, and a lower count is refused with 400.
      */
     iterationCount?: number;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.6.0'; // x-release-please-version
+export const VERSION = '4.8.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.6.0";
+export declare const VERSION = "4.8.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 = '4.6.0'; // x-release-please-version
+exports.VERSION = '4.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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