@roarkanalytics/sdk 4.22.0 → 5.0.0

package/src/resources/simulation.ts

@@ -276,9 +276,10 @@ export declare namespace SimulationRunParams {
        * `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
-       * obvious baseline and the dashboard prefills it; `GENDER` has none, so choose the
-       * one you are testing against.
+       * instead of implying Roark decided which value is normal. Omit it and the
+       * property's own norm is used, as the dashboard prefills it, or none when your
+       * `comparisonValues` leave the norm out. `GENDER` has no norm, so choose the one
+       * you are testing against.
        */
       comparisonBaseline?: string | null;
 
@@ -312,18 +313,37 @@ export declare namespace SimulationRunParams {
         | 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.
+       * The arms to run, for a plan that sweeps `comparisonProperty`. This is what the
+       * plan costs: the flow is attached once per arm, so ten arms 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.
+       * Attach each flow once, as you would without a comparison: the plan builds the
+       * arms, running the happy path or edge cases you selected under every arm. Built
+       * arms need at least 5 calls per arm (`iterationCount` times the test cases per
+       * arm), or the plan is refused with `400`. Flows that all carry `overrides` on
+       * `comparisonProperty` already are the arms and are kept as you wrote them; a mix
+       * of flows with and without one is refused.
+       *
+       * Each entry is one arm. A bare value runs it plain: `"CITY"`. An object runs the
+       * value with something pinned on that arm only, such as a noise level per bed:
+       * `{ "value": "OFFICE", "backgroundNoiseVolume": 0.6 }` plays OFFICE at 60% while
+       * the other beds keep the default. List a value more than once with different pins
+       * to run it as several arms: DRIVING at 0.7 and DRIVING at 1 are two arms,
+       * reported as `Driving (70% noise)` and `Driving (100% noise)`, and `"DRIVING"`
+       * beside them keeps the plain arm too. The sweep still varies one property; what
+       * an arm pins is part of "everything else" for that arm only, so the report still
+       * compares the arms on `comparisonProperty`.
+       *
+       * Omit it to run every value the property has, plain, which for `ACCENT` is more
+       * than twenty. A `comparisonBaseline` outside the values listed is rejected,
+       * because it would anchor every difference to an arm the run never made. A value
+       * the property cannot take, a pin the sweep cannot account for, or the same arm
+       * listed twice is rejected with `400`.
        *
        * Not stored as a field: the arms are the values. Reading the plan back returns
-       * them as its flow attachments.
+       * them as its flow attachments, each with its pins as `overrides`.
        */
-      comparisonValues?: Array<string>;
+      comparisonValues?: Array<string | Plan.ComparisonArm>;
 
       /**
        * Description of the run plan
@@ -469,6 +489,28 @@ export declare namespace SimulationRunParams {
         id: string;
       }
 
+      /**
+       * One arm of a sweep: the swept value it runs, and what it pins besides that
+       * value. The OFFICE arm of a BACKGROUND_NOISE sweep playing at 60% while the other
+       * beds keep their level is `{ "value": "OFFICE", "backgroundNoiseVolume": 0.6 }`.
+       * The report compares the arms on the swept property only, so each sweep may pin
+       * just what its experiment calls for: a BACKGROUND_NOISE sweep may pin
+       * `backgroundNoiseVolume`, and no other sweep pins anything yet. A pin the sweep
+       * cannot account for is rejected with `400`.
+       */
+      export interface ComparisonArm {
+        /**
+         * The swept value this arm runs, a value of `comparisonProperty`.
+         */
+        value: string;
+
+        /**
+         * The noise level this arm plays at, 0 to 1. The environment default is 0.1. Only
+         * a `BACKGROUND_NOISE` sweep may pin it.
+         */
+        backgroundNoiseVolume?: number;
+      }
+
       /**
        * One customer flow attached to a run plan, and which of its ways of running you
        * cover.
@@ -758,6 +800,13 @@ export declare namespace SimulationRunParams {
      */
     template: string;
 
+    /**
+     * Metrics to collect on top of the template's own, referenced by `id` or `slug`
+     * like a plan's `metrics`. The template's metrics and checks always run; naming
+     * one of them here again keeps it once, with the success criteria you set on it.
+     */
+    additionalMetrics?: Array<RunSimulationFromTemplate.AdditionalMetric>;
+
     /**
      * 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
@@ -773,16 +822,19 @@ export declare namespace SimulationRunParams {
     comparisonBaseline?: string | null;
 
     /**
-     * Which values of the sweep to run, for a template that sweeps one (GET
+     * The arms of the sweep to run, for a template that sweeps one (GET
      * /v1/simulation/template returns `sweep.property` for those that do). This is
-     * what the run costs: the flow is called once per value, so ten values is ten
-     * times the calls of one.
+     * what the run costs: the flow is called once per arm, so ten arms is ten times
+     * the calls of one.
      *
-     * Omit it to run every value the property has, which for `accent-handling` is more
-     * than twenty. Send a subset to narrow it, for example the three accents you
-     * actually serve.
+     * Omit it to run every value the property has, plain, which for `accent-handling`
+     * is more than twenty. Send a subset to narrow it, for example the three accents
+     * you actually serve. An object entry pins something on that arm only, such as a
+     * noise level per bed on `background-noise-robustness`:
+     * `{ "value": "OFFICE", "backgroundNoiseVolume": 0.6 }` plays OFFICE at 60% while
+     * the other beds keep the default. See `POST /v1/simulation/plan`.
      */
-    comparisonValues?: Array<string>;
+    comparisonValues?: Array<string | RunSimulationFromTemplate.ComparisonArm>;
 
     /**
      * Phrases that trigger end of call. Empty array disables the feature.
@@ -830,6 +882,11 @@ export declare namespace SimulationRunParams {
      * REPLACE the ones it would have run, so you can narrow a suite to the cases you
      * care about. Either way, GET /v1/simulation/template lists the flows and variant
      * ids each template covers.
+     *
+     * On a template that sweeps a property, every value runs exactly what you select
+     * here: the happy path, the edge cases you name, or `edgeCases: "ALL"`. Each
+     * selected case is a call per value per iteration, so naming three edge cases
+     * triples the run.
      */
     flows?: Array<RunSimulationFromTemplate.Flow>;
 
@@ -914,6 +971,69 @@ export declare namespace SimulationRunParams {
       id: string;
     }
 
+    export interface AdditionalMetric {
+      /**
+       * Metric definition UUID. Provide either this or `slug`, not both.
+       */
+      id?: string;
+
+      /**
+       * Which side of an enriched run this metric is scored on. Only meaningful with
+       * `enrichWithLiveConversation: true`, where a run has both a simulated
+       * conversation and the customer's own live recording of it.
+       *
+       * Defaults to `SIMULATED`. Use `LIVE` for a metric that must be measured against
+       * the real recording (audio quality, provider latency) rather than the simulated
+       * leg. `null` means the same as omitting it, so a plan read back from GET can be
+       * sent straight to PUT.
+       */
+      conversationSource?: 'SIMULATED' | 'LIVE' | null;
+
+      /**
+       * Alias of `slug` accepted for backwards compatibility. Use `slug` for new
+       * integrations.
+       */
+      metricId?: string;
+
+      /**
+       * THE BAR, and the only thing that decides pass/fail. The share of the run's
+       * simulations that must pass this check, 0-100.
+       *
+       * Applied to this check alone and never pooled: silence duration at 40 and word
+       * count at 80 means the run fails unless 40% of sims clear silence AND 80% clear
+       * word count. Omit or `null` for the 80% default.
+       */
+      minPassRate?: number | null;
+
+      /**
+       * Stable metric slug (e.g. `customer_satisfaction`). Provide either this or `id`,
+       * not both.
+       */
+      slug?: string;
+    }
+
+    /**
+     * One arm of a sweep: the swept value it runs, and what it pins besides that
+     * value. The OFFICE arm of a BACKGROUND_NOISE sweep playing at 60% while the other
+     * beds keep their level is `{ "value": "OFFICE", "backgroundNoiseVolume": 0.6 }`.
+     * The report compares the arms on the swept property only, so each sweep may pin
+     * just what its experiment calls for: a BACKGROUND_NOISE sweep may pin
+     * `backgroundNoiseVolume`, and no other sweep pins anything yet. A pin the sweep
+     * cannot account for is rejected with `400`.
+     */
+    export interface ComparisonArm {
+      /**
+       * The swept value this arm runs, a value of `comparisonProperty`.
+       */
+      value: string;
+
+      /**
+       * The noise level this arm plays at, 0 to 1. The environment default is 0.1. Only
+       * a `BACKGROUND_NOISE` sweep may pin it.
+       */
+      backgroundNoiseVolume?: number;
+    }
+
     /**
      * One customer flow attached to a run plan, and which of its ways of running you
      * cover.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.22.0'; // x-release-please-version
+export const VERSION = '5.0.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

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

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}