@roarkanalytics/sdk 3.20.0 → 3.21.0

package/src/resources/config.ts

@@ -206,6 +206,8 @@ export namespace Bundle {
 
     intentClarity?: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+    interruption?: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
     memoryReliability?: 'HIGH' | 'LOW';
 
     properties?: { [key: string]: unknown };
@@ -885,6 +887,8 @@ export namespace ConfigApplyParams {
 
     intentClarity?: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+    interruption?: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
     memoryReliability?: 'HIGH' | 'LOW';
 
     properties?: { [key: string]: unknown };
@@ -1418,6 +1422,8 @@ export namespace ConfigDiffParams {
 
     intentClarity?: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+    interruption?: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
     memoryReliability?: 'HIGH' | 'LOW';
 
     properties?: { [key: string]: unknown };

package/src/resources/customer-flow-edge-case.ts

@@ -340,6 +340,16 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -379,9 +389,13 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -679,6 +693,16 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -718,9 +742,13 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -909,6 +937,16 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -948,9 +986,13 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -1238,6 +1280,16 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -1277,9 +1329,13 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -1586,6 +1642,16 @@ export namespace CustomerFlowEdgeCaseAddResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -1625,9 +1691,13 @@ export namespace CustomerFlowEdgeCaseAddResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -1925,6 +1995,16 @@ export namespace CustomerFlowEdgeCaseAddResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -1964,9 +2044,13 @@ export namespace CustomerFlowEdgeCaseAddResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -2155,6 +2239,16 @@ export namespace CustomerFlowEdgeCaseAddResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -2194,9 +2288,13 @@ export namespace CustomerFlowEdgeCaseAddResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -2484,6 +2582,16 @@ export namespace CustomerFlowEdgeCaseAddResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -2523,9 +2631,13 @@ export namespace CustomerFlowEdgeCaseAddResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -2832,6 +2944,16 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -2871,9 +2993,13 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -3171,6 +3297,16 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -3210,9 +3346,13 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -3401,6 +3541,16 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -3440,9 +3590,13 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';
 
@@ -3730,6 +3884,16 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
        */
       intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
 
+      /**
+       * How much the persona talks over the agent while it is still speaking. OFF waits
+       * its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without
+       * taking the floor, which tests whether the agent wrongly stops for them.
+       * OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them.
+       * Timing is randomised per turn, so two runs of the same persona do not interrupt
+       * at identical moments.
+       */
+      interruption: 'OFF' | 'BACKCHANNEL' | 'OCCASIONAL' | 'HEAVY';
+
       /**
        * Primary language ISO 639-1 code for the persona
        */
@@ -3769,9 +3933,13 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
       properties: { [key: string]: unknown };
 
       /**
-       * Controls how quickly the persona responds to pauses in conversation (QUICK,
-       * NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor
-       * for several seconds.
+       * Deprecated and inert: it no longer affects the call. It set how long the persona
+       * waited once the agent stopped talking, and measured across production
+       * simulations it moved the reply gap by less than the noise floor, because model
+       * and speech latency dominate it. Every persona now uses one voice-activity
+       * profile. Use `interruption` for a caller who talks over the agent. Still
+       * accepted and stored so existing clients keep working. BARGE_IN is stored as
+       * `responseTiming: QUICK` with `interruption: OCCASIONAL`.
        */
       responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK' | 'BARGE_IN';