@roarkanalytics/sdk 2.24.0 → 2.26.0

package/src/resources/metric.ts

@@ -5,16 +5,112 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
 export class Metric extends APIResource {
+  /**
+   * Create a new custom metric definition. The metric will be added to the specified
+   * analysis package and can be used for evaluating calls.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metric.createDefinition({
+   *   analysisPackageId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   name: 'Customer Satisfaction',
+   *   outputType: 'BOOLEAN',
+   * });
+   * ```
+   */
+  createDefinition(
+    body: MetricCreateDefinitionParams,
+    options?: RequestOptions,
+  ): APIPromise<MetricCreateDefinitionResponse> {
+    return this._client.post('/v1/metric/definitions', { body, ...options });
+  }
+
   /**
    * Fetch all metric definitions available in the project, including both
    * system-generated and custom metrics. Only returns metrics from enabled analysis
    * packages.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metric.listDefinitions();
+   * ```
    */
   listDefinitions(options?: RequestOptions): APIPromise<MetricListDefinitionsResponse> {
     return this._client.get('/v1/metric/definitions', options);
   }
 }
 
+export interface MetricCreateDefinitionResponse {
+  /**
+   * Metric definition data
+   */
+  data: MetricCreateDefinitionResponse.Data;
+}
+
+export namespace MetricCreateDefinitionResponse {
+  /**
+   * Metric definition data
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the metric definition
+     */
+    id: string;
+
+    /**
+     * Description of what the metric measures
+     */
+    description: string;
+
+    /**
+     * Stable metric identifier (e.g. "call_reason", "customer_satisfaction")
+     */
+    metricId: string;
+
+    /**
+     * Name of the metric
+     */
+    name: string;
+
+    /**
+     * Whether metric is global or per-participant
+     */
+    scope: 'GLOBAL' | 'PER_PARTICIPANT';
+
+    /**
+     * Which levels this metric can produce values at
+     */
+    supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
+
+    /**
+     * Type of value this metric produces
+     */
+    type: 'COUNT' | 'NUMERIC' | 'BOOLEAN' | 'SCALE' | 'TEXT' | 'CLASSIFICATION' | 'OFFSET';
+
+    /**
+     * Unit information if applicable
+     */
+    unit?: Data.Unit;
+  }
+
+  export namespace Data {
+    /**
+     * Unit information if applicable
+     */
+    export interface Unit {
+      /**
+       * Name of the unit
+       */
+      name: string;
+
+      /**
+       * Symbol for the unit
+       */
+      symbol: string | null;
+    }
+  }
+}
+
 export interface MetricListDefinitionsResponse {
   /**
    * Metrics response payload
@@ -86,6 +182,141 @@ export namespace MetricListDefinitionsResponse {
   }
 }
 
+export interface MetricCreateDefinitionParams {
+  /**
+   * ID of the analysis package to add this metric to
+   */
+  analysisPackageId: string;
+
+  /**
+   * Name of the metric
+   */
+  name: string;
+
+  /**
+   * Type of value this metric produces
+   */
+  outputType: 'COUNT' | 'NUMERIC' | 'BOOLEAN' | 'SCALE' | 'TEXT' | 'CLASSIFICATION' | 'OFFSET';
+
+  /**
+   * Label for the false/negative case (only for BOOLEAN type)
+   */
+  booleanFalseLabel?: string;
+
+  /**
+   * Label for the true/positive case (only for BOOLEAN type)
+   */
+  booleanTrueLabel?: string;
+
+  /**
+   * Options for classification. Required for CLASSIFICATION type.
+   */
+  classificationOptions?: Array<MetricCreateDefinitionParams.ClassificationOption>;
+
+  /**
+   * LLM prompt/criteria for evaluating this metric. Used to instruct the model on
+   * how to score. Required for BOOLEAN, NUMERIC, TEXT, and SCALE types.
+   */
+  llmPrompt?: string;
+
+  /**
+   * Maximum number of classifications that can be selected (only for CLASSIFICATION
+   * type)
+   */
+  maxClassifications?: number;
+
+  /**
+   * Unique identifier for the metric (e.g. "customer_satisfaction"). Auto-generated
+   * from name if not provided.
+   */
+  metricId?: string;
+
+  /**
+   * Participant role to evaluate. Required when scope is PER_PARTICIPANT.
+   */
+  participantRole?: 'AGENT' | 'CUSTOMER' | 'SIMULATED_CUSTOMER' | 'BACKGROUND_SPEAKER';
+
+  /**
+   * Labels for scale ranges (only for SCALE type)
+   */
+  scaleLabels?: Array<MetricCreateDefinitionParams.ScaleLabel>;
+
+  /**
+   * Maximum value for scale. Required for SCALE type.
+   */
+  scaleMax?: number;
+
+  /**
+   * Minimum value for scale. Required for SCALE type.
+   */
+  scaleMin?: number;
+
+  /**
+   * Whether metric is global or per-participant (default: GLOBAL)
+   */
+  scope?: 'GLOBAL' | 'PER_PARTICIPANT';
+
+  /**
+   * Which levels this metric can produce values at (default: ["CALL"])
+   */
+  supportedContexts?: Array<'CALL' | 'SEGMENT' | 'TURN'>;
+}
+
+export namespace MetricCreateDefinitionParams {
+  export interface ClassificationOption {
+    /**
+     * Description of what this option means
+     */
+    description: string;
+
+    /**
+     * Display order of this option
+     */
+    displayOrder: number;
+
+    /**
+     * Label for this classification option
+     */
+    label: string;
+  }
+
+  export interface ScaleLabel {
+    /**
+     * Display order of this label
+     */
+    displayOrder: number;
+
+    /**
+     * Label for this range
+     */
+    label: string;
+
+    /**
+     * Maximum value for this label range
+     */
+    rangeMax: number;
+
+    /**
+     * Minimum value for this label range
+     */
+    rangeMin: number;
+
+    /**
+     * Hex color code for this label (e.g. "#FF0000")
+     */
+    colorHex?: string;
+
+    /**
+     * Description of what this range means
+     */
+    description?: string;
+  }
+}
+
 export declare namespace Metric {
-  export { type MetricListDefinitionsResponse as MetricListDefinitionsResponse };
+  export {
+    type MetricCreateDefinitionResponse as MetricCreateDefinitionResponse,
+    type MetricListDefinitionsResponse as MetricListDefinitionsResponse,
+    type MetricCreateDefinitionParams as MetricCreateDefinitionParams,
+  };
 }

package/src/resources/simulation-job.ts

@@ -191,13 +191,33 @@ export namespace SimulationJobGetByIDResponse {
       /**
        * Gender of the persona
        */
-      gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+      gender: 'MALE' | 'FEMALE';
 
       /**
        * Whether the persona uses filler words like "um" and "uh"
        */
       hasDisfluencies: boolean;
 
+      /**
+       * Maximum number of idle messages the persona will send before giving up
+       */
+      idleMessageMaxSpokenCount: number;
+
+      /**
+       * Whether the idle message counter resets when the agent speaks
+       */
+      idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+      /**
+       * Messages the persona will say when the agent goes silent during a call
+       */
+      idleMessages: Array<string>;
+
+      /**
+       * Seconds of silence before the persona sends an idle message
+       */
+      idleTimeoutSeconds: number;
+
       /**
        * How clearly the persona expresses their intentions
        */
@@ -428,13 +448,33 @@ export namespace SimulationJobLookupResponse {
       /**
        * Gender of the persona
        */
-      gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+      gender: 'MALE' | 'FEMALE';
 
       /**
        * Whether the persona uses filler words like "um" and "uh"
        */
       hasDisfluencies: boolean;
 
+      /**
+       * Maximum number of idle messages the persona will send before giving up
+       */
+      idleMessageMaxSpokenCount: number;
+
+      /**
+       * Whether the idle message counter resets when the agent speaks
+       */
+      idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+      /**
+       * Messages the persona will say when the agent goes silent during a call
+       */
+      idleMessages: Array<string>;
+
+      /**
+       * Seconds of silence before the persona sends an idle message
+       */
+      idleTimeoutSeconds: number;
+
       /**
        * How clearly the persona expresses their intentions
        */

package/src/resources/simulation-persona.ts

@@ -138,13 +138,33 @@ export namespace SimulationPersonaCreateResponse {
     /**
      * Gender of the persona
      */
-    gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+    gender: 'MALE' | 'FEMALE';
 
     /**
      * Whether the persona uses filler words like "um" and "uh"
      */
     hasDisfluencies: boolean;
 
+    /**
+     * Maximum number of idle messages the persona will send before giving up
+     */
+    idleMessageMaxSpokenCount: number;
+
+    /**
+     * Whether the idle message counter resets when the agent speaks
+     */
+    idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+    /**
+     * Messages the persona will say when the agent goes silent during a call
+     */
+    idleMessages: Array<string>;
+
+    /**
+     * Seconds of silence before the persona sends an idle message
+     */
+    idleTimeoutSeconds: number;
+
     /**
      * How clearly the persona expresses their intentions
      */
@@ -271,13 +291,33 @@ export namespace SimulationPersonaUpdateResponse {
     /**
      * Gender of the persona
      */
-    gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+    gender: 'MALE' | 'FEMALE';
 
     /**
      * Whether the persona uses filler words like "um" and "uh"
      */
     hasDisfluencies: boolean;
 
+    /**
+     * Maximum number of idle messages the persona will send before giving up
+     */
+    idleMessageMaxSpokenCount: number;
+
+    /**
+     * Whether the idle message counter resets when the agent speaks
+     */
+    idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+    /**
+     * Messages the persona will say when the agent goes silent during a call
+     */
+    idleMessages: Array<string>;
+
+    /**
+     * Seconds of silence before the persona sends an idle message
+     */
+    idleTimeoutSeconds: number;
+
     /**
      * How clearly the persona expresses their intentions
      */
@@ -406,13 +446,33 @@ export namespace SimulationPersonaListResponse {
     /**
      * Gender of the persona
      */
-    gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+    gender: 'MALE' | 'FEMALE';
 
     /**
      * Whether the persona uses filler words like "um" and "uh"
      */
     hasDisfluencies: boolean;
 
+    /**
+     * Maximum number of idle messages the persona will send before giving up
+     */
+    idleMessageMaxSpokenCount: number;
+
+    /**
+     * Whether the idle message counter resets when the agent speaks
+     */
+    idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+    /**
+     * Messages the persona will say when the agent goes silent during a call
+     */
+    idleMessages: Array<string>;
+
+    /**
+     * Seconds of silence before the persona sends an idle message
+     */
+    idleTimeoutSeconds: number;
+
     /**
      * How clearly the persona expresses their intentions
      */
@@ -556,13 +616,33 @@ export namespace SimulationPersonaGetByIDResponse {
     /**
      * Gender of the persona
      */
-    gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+    gender: 'MALE' | 'FEMALE';
 
     /**
      * Whether the persona uses filler words like "um" and "uh"
      */
     hasDisfluencies: boolean;
 
+    /**
+     * Maximum number of idle messages the persona will send before giving up
+     */
+    idleMessageMaxSpokenCount: number;
+
+    /**
+     * Whether the idle message counter resets when the agent speaks
+     */
+    idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+    /**
+     * Messages the persona will say when the agent goes silent during a call
+     */
+    idleMessages: Array<string>;
+
+    /**
+     * Seconds of silence before the persona sends an idle message
+     */
+    idleTimeoutSeconds: number;
+
     /**
      * How clearly the persona expresses their intentions
      */
@@ -651,7 +731,7 @@ export interface SimulationPersonaCreateParams {
   /**
    * Gender of the persona
    */
-  gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+  gender: 'MALE' | 'FEMALE';
 
   /**
    * Primary language ISO 639-1 code for the persona
@@ -701,6 +781,26 @@ export interface SimulationPersonaCreateParams {
    */
   hasDisfluencies?: boolean;
 
+  /**
+   * Maximum number of idle messages the persona will send before giving up
+   */
+  idleMessageMaxSpokenCount?: number;
+
+  /**
+   * Whether the idle message counter resets when the agent speaks
+   */
+  idleMessageResetCountOnUserSpeechEnabled?: boolean;
+
+  /**
+   * Messages the persona will say when the agent goes silent during a call
+   */
+  idleMessages?: Array<string>;
+
+  /**
+   * Seconds of silence before the persona sends an idle message
+   */
+  idleTimeoutSeconds?: number;
+
   /**
    * How clearly the persona expresses their intentions
    */
@@ -796,13 +896,33 @@ export interface SimulationPersonaUpdateParams {
   /**
    * Gender of the persona
    */
-  gender?: 'MALE' | 'FEMALE' | 'NEUTRAL';
+  gender?: 'MALE' | 'FEMALE';
 
   /**
    * Whether the persona uses filler words like "um" and "uh"
    */
   hasDisfluencies?: boolean;
 
+  /**
+   * Maximum number of idle messages the persona will send before giving up
+   */
+  idleMessageMaxSpokenCount?: number;
+
+  /**
+   * Whether the idle message counter resets when the agent speaks
+   */
+  idleMessageResetCountOnUserSpeechEnabled?: boolean;
+
+  /**
+   * Messages the persona will say when the agent goes silent during a call
+   */
+  idleMessages?: Array<string>;
+
+  /**
+   * Seconds of silence before the persona sends an idle message
+   */
+  idleTimeoutSeconds?: number;
+
   /**
    * How clearly the persona expresses their intentions
    */

package/src/resources/simulation-run-plan-job.ts

@@ -97,7 +97,8 @@ export namespace SimulationRunPlanJobListResponse {
       | 'FAILED'
       | 'TIMED_OUT'
       | 'CANCELLED'
-      | 'CANCELLING';
+      | 'CANCELLING'
+      | 'ENDING_SIMULATIONS';
 
     /**
      * How the job was triggered (SCHEDULED, USER_TRIGGERED_FROM_UI,
@@ -179,7 +180,8 @@ export namespace SimulationRunPlanJobGetByIDResponse {
       | 'FAILED'
       | 'TIMED_OUT'
       | 'CANCELLED'
-      | 'CANCELLING';
+      | 'CANCELLING'
+      | 'ENDING_SIMULATIONS';
 
     /**
      * When the job ended
@@ -213,6 +215,7 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         | 'CONNECTING'
         | 'WAITING_FOR_OUTBOUND_CALL'
         | 'SIMULATING'
+        | 'ENDING'
         | 'ANALYZING'
         | 'EVALUATING'
         | 'COLLECTING_METRICS'
@@ -348,13 +351,33 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         /**
          * Gender of the persona
          */
-        gender: 'MALE' | 'FEMALE' | 'NEUTRAL';
+        gender: 'MALE' | 'FEMALE';
 
         /**
          * Whether the persona uses filler words like "um" and "uh"
          */
         hasDisfluencies: boolean;
 
+        /**
+         * Maximum number of idle messages the persona will send before giving up
+         */
+        idleMessageMaxSpokenCount: number;
+
+        /**
+         * Whether the idle message counter resets when the agent speaks
+         */
+        idleMessageResetCountOnUserSpeechEnabled: boolean;
+
+        /**
+         * Messages the persona will say when the agent goes silent during a call
+         */
+        idleMessages: Array<string>;
+
+        /**
+         * Seconds of silence before the persona sends an idle message
+         */
+        idleTimeoutSeconds: number;
+
         /**
          * How clearly the persona expresses their intentions
          */
@@ -475,7 +498,8 @@ export namespace SimulationRunPlanJobStartResponse {
       | 'FAILED'
       | 'TIMED_OUT'
       | 'CANCELLED'
-      | 'CANCELLING';
+      | 'CANCELLING'
+      | 'ENDING_SIMULATIONS';
   }
 }
 
@@ -508,7 +532,8 @@ export interface SimulationRunPlanJobListParams {
 
   /**
    * Filter by plan job status (PENDING, CREATING_SNAPSHOTS, CREATING_SIMULATIONS,
-   * RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING)
+   * RUNNING_SIMULATIONS, ENDING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT,
+   * CANCELLED, CANCELLING)
    */
   status?:
     | 'PENDING'
@@ -520,7 +545,8 @@ export interface SimulationRunPlanJobListParams {
     | 'FAILED'
     | 'TIMED_OUT'
     | 'CANCELLED'
-    | 'CANCELLING';
+    | 'CANCELLING'
+    | 'ENDING_SIMULATIONS';
 }
 
 export interface SimulationRunPlanJobStartParams {

package/src/resources/simulation-run-plan.ts

@@ -158,6 +158,12 @@ export namespace SimulationRunPlanCreateResponse {
        */
       endCallPhrases: Array<string>;
 
+      /**
+       * Semantic conditions that trigger end of call. The LLM evaluates the conversation
+       * against these conditions. Empty array means disabled.
+       */
+      endCallReasons: Array<string>;
+
       /**
        * Deprecated: Use metrics instead. Evaluators included in this run plan.
        */
@@ -278,7 +284,8 @@ export namespace SimulationRunPlanCreateResponse {
         | 'FAILED'
         | 'TIMED_OUT'
         | 'CANCELLED'
-        | 'CANCELLING';
+        | 'CANCELLING'
+        | 'ENDING_SIMULATIONS';
     }
   }
 }
@@ -320,6 +327,12 @@ export namespace SimulationRunPlanUpdateResponse {
      */
     endCallPhrases: Array<string>;
 
+    /**
+     * Semantic conditions that trigger end of call. The LLM evaluates the conversation
+     * against these conditions. Empty array means disabled.
+     */
+    endCallReasons: Array<string>;
+
     /**
      * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
@@ -448,6 +461,12 @@ export namespace SimulationRunPlanListResponse {
      */
     endCallPhrases: Array<string>;
 
+    /**
+     * Semantic conditions that trigger end of call. The LLM evaluates the conversation
+     * against these conditions. Empty array means disabled.
+     */
+    endCallReasons: Array<string>;
+
     /**
      * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
@@ -604,6 +623,12 @@ export namespace SimulationRunPlanGetByIDResponse {
      */
     endCallPhrases: Array<string>;
 
+    /**
+     * Semantic conditions that trigger end of call. The LLM evaluates the conversation
+     * against these conditions. Empty array means disabled.
+     */
+    endCallReasons: Array<string>;
+
     /**
      * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
@@ -745,6 +770,12 @@ export interface SimulationRunPlanCreateParams {
    */
   endCallPhrases?: Array<string>;
 
+  /**
+   * Semantic conditions that trigger end of call. The LLM evaluates the conversation
+   * against these conditions. Empty array disables the feature.
+   */
+  endCallReasons?: Array<string>;
+
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
    */
@@ -815,6 +846,12 @@ export interface SimulationRunPlanUpdateParams {
    */
   endCallPhrases?: Array<string>;
 
+  /**
+   * Semantic conditions that trigger end of call. The LLM evaluates the conversation
+   * against these conditions. Empty array disables the feature.
+   */
+  endCallReasons?: Array<string>;
+
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
    */