@roarkanalytics/sdk 2.9.1 → 2.11.0

package/src/resources/call.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
 import * as Core from '../core';
 
 export class Call extends APIResource {
@@ -14,6 +15,27 @@ export class Call extends APIResource {
     return this._client.get(`/v1/call/${callId}/evaluation-run`, options);
   }
 
+  /**
+   * Fetch all call-level metrics for a specific call, including both
+   * system-generated and custom metrics. Only returns successfully computed metrics.
+   */
+  getMetrics(
+    callId: string,
+    query?: CallGetMetricsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CallGetMetricsResponse>;
+  getMetrics(callId: string, options?: Core.RequestOptions): Core.APIPromise<CallGetMetricsResponse>;
+  getMetrics(
+    callId: string,
+    query: CallGetMetricsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CallGetMetricsResponse> {
+    if (isRequestOptions(query)) {
+      return this.getMetrics(callId, {}, query);
+    }
+    return this._client.get(`/v1/call/${callId}/metrics`, { query, ...options });
+  }
+
   /**
    * Fetch detailed sentiment analysis results for a specific call, including
    * emotional tone, key phrases, and sentiment scores.
@@ -214,6 +236,204 @@ export namespace CallGetEvaluationRunsResponse {
   }
 }
 
+export interface CallGetMetricsResponse {
+  /**
+   * Call metrics response payload grouped by metric definition
+   */
+  data: Array<CallGetMetricsResponse.Data>;
+}
+
+export namespace CallGetMetricsResponse {
+  /**
+   * Call metric data grouped by metric definition
+   */
+  export interface Data {
+    /**
+     * Description of what the metric measures
+     */
+    description: string;
+
+    /**
+     * Unique identifier for the metric definition
+     */
+    metricDefinitionId: string;
+
+    /**
+     * Stable metric identifier
+     */
+    metricId: string;
+
+    /**
+     * Name of the metric
+     */
+    name: string;
+
+    /**
+     * Whether metric is global or per-participant
+     */
+    scope: 'GLOBAL' | 'PER_PARTICIPANT';
+
+    /**
+     * Type of value this metric produces
+     */
+    type: 'COUNT' | 'NUMERIC' | 'BOOLEAN' | 'SCALE' | 'TEXT' | 'CLASSIFICATION' | 'OFFSET';
+
+    /**
+     * Array of metric values (multiple for PER_PARTICIPANT metrics, or multiple
+     * segments/turns)
+     */
+    values: Array<Data.Value>;
+
+    /**
+     * Unit information if applicable
+     */
+    unit?: Data.Unit;
+  }
+
+  export namespace Data {
+    export interface Value {
+      /**
+       * ISO 8601 timestamp when the metric was computed
+       */
+      computedAt: string;
+
+      /**
+       * Confidence score (0-1) for the computed value. Defaults to 1.0 for deterministic
+       * metrics.
+       */
+      confidence: number;
+
+      /**
+       * Context level: CALL (entire call), SEGMENT (single segment), SEGMENT_RANGE
+       * (between/across segments)
+       */
+      context: 'CALL' | 'SEGMENT' | 'SEGMENT_RANGE';
+
+      /**
+       * The metric value (type depends on outputType)
+       */
+      value: number | boolean | string;
+
+      /**
+       * Starting segment information (for SEGMENT_RANGE context metrics)
+       */
+      fromSegment?: Value.FromSegment;
+
+      /**
+       * Role of participant (only for PER_PARTICIPANT metrics)
+       */
+      participantRole?: 'agent' | 'customer';
+
+      /**
+       * Segment information (for SEGMENT context metrics)
+       */
+      segment?: Value.Segment;
+
+      /**
+       * Ending segment information (for SEGMENT_RANGE context metrics)
+       */
+      toSegment?: Value.ToSegment;
+
+      /**
+       * Explanation for the metric value (especially useful for AI-computed metrics)
+       */
+      valueReasoning?: string;
+    }
+
+    export namespace Value {
+      /**
+       * Starting segment information (for SEGMENT_RANGE context metrics)
+       */
+      export interface FromSegment {
+        /**
+         * Starting segment ID
+         */
+        id: string;
+
+        /**
+         * End time offset in milliseconds
+         */
+        endOffsetMs: number;
+
+        /**
+         * Start time offset in milliseconds
+         */
+        startOffsetMs: number;
+
+        /**
+         * Starting segment text content
+         */
+        text: string;
+      }
+
+      /**
+       * Segment information (for SEGMENT context metrics)
+       */
+      export interface Segment {
+        /**
+         * Segment ID
+         */
+        id: string;
+
+        /**
+         * End time offset in milliseconds
+         */
+        endOffsetMs: number;
+
+        /**
+         * Start time offset in milliseconds
+         */
+        startOffsetMs: number;
+
+        /**
+         * Segment text content
+         */
+        text: string;
+      }
+
+      /**
+       * Ending segment information (for SEGMENT_RANGE context metrics)
+       */
+      export interface ToSegment {
+        /**
+         * Ending segment ID
+         */
+        id: string;
+
+        /**
+         * End time offset in milliseconds
+         */
+        endOffsetMs: number;
+
+        /**
+         * Start time offset in milliseconds
+         */
+        startOffsetMs: number;
+
+        /**
+         * Ending segment text content
+         */
+        text: string;
+      }
+    }
+
+    /**
+     * Unit information if applicable
+     */
+    export interface Unit {
+      /**
+       * Name of the unit
+       */
+      name: string;
+
+      /**
+       * Symbol for the unit
+       */
+      symbol: string | null;
+    }
+  }
+}
+
 export interface CallGetSentimentRunsResponse {
   /**
    * Sentiment run response payload
@@ -248,9 +468,19 @@ export namespace CallGetSentimentRunsResponse {
   }
 }
 
+export interface CallGetMetricsParams {
+  /**
+   * Whether to return a flat list instead of grouped by metric definition (default:
+   * false)
+   */
+  flatten?: string;
+}
+
 export declare namespace Call {
   export {
     type CallGetEvaluationRunsResponse as CallGetEvaluationRunsResponse,
+    type CallGetMetricsResponse as CallGetMetricsResponse,
     type CallGetSentimentRunsResponse as CallGetSentimentRunsResponse,
+    type CallGetMetricsParams as CallGetMetricsParams,
   };
 }

package/src/resources/evaluation.ts

@@ -1363,8 +1363,8 @@ export namespace EvaluationCreateJobParams {
     participants: Array<Call.Participant>;
 
     /**
-     * URL of source recording (must be an accessible WAV or MP3 file). Can be a signed
-     * URL.
+     * URL of source recording (must be an accessible WAV, MP3, or MP4 file). Can be a
+     * signed URL.
      */
     recordingUrl: string;
 
@@ -1382,14 +1382,21 @@ export namespace EvaluationCreateJobParams {
      * High-level call end status, indicating how the call terminated
      */
     endedStatus?:
+      | 'PARTICIPANTS_DID_NOT_SPEAK'
+      | 'AGENT_DID_NOT_ANSWER'
+      | 'AGENT_DID_NOT_SPEAK'
+      | 'AGENT_STOPPED_SPEAKING'
       | 'AGENT_ENDED_CALL'
       | 'AGENT_TRANSFERRED_CALL'
+      | 'AGENT_BUSY'
       | 'AGENT_ERROR'
       | 'CUSTOMER_ENDED_CALL'
       | 'VOICE_MAIL_REACHED'
       | 'SILENCE_TIME_OUT'
       | 'PHONE_CALL_PROVIDER_CONNECTION_ERROR'
       | 'CUSTOMER_DID_NOT_ANSWER'
+      | 'CUSTOMER_DID_NOT_SPEAK'
+      | 'CUSTOMER_STOPPED_SPEAKING'
       | 'CUSTOMER_BUSY'
       | 'DIAL_ERROR'
       | 'MAX_DURATION_REACHED'
@@ -1412,8 +1419,8 @@ export namespace EvaluationCreateJobParams {
     retellCallId?: string;
 
     /**
-     * URL of source stereo recording in WAV format. Must be accessible. Can be a
-     * signed URL. While optional it allows for a richer audio player
+     * URL of source stereo recording. Must be accessible. Can be a signed URL. While
+     * optional it allows for a richer audio player. Supported formats: WAV, MP3, MP4.
      */
     stereoRecordingUrl?: string;
 
@@ -1436,6 +1443,8 @@ export namespace EvaluationCreateJobParams {
 
       name?: string | null;
 
+      participantId?: string | null;
+
       phoneNumber?: string | null;
 
       spokeFirst?: boolean;
@@ -1515,8 +1524,8 @@ export namespace EvaluationCreateJobParams {
       participants: Array<Call.Participant>;
 
       /**
-       * URL of source recording (must be an accessible WAV or MP3 file). Can be a signed
-       * URL.
+       * URL of source recording (must be an accessible WAV, MP3, or MP4 file). Can be a
+       * signed URL.
        */
       recordingUrl: string;
 
@@ -1534,14 +1543,21 @@ export namespace EvaluationCreateJobParams {
        * High-level call end status, indicating how the call terminated
        */
       endedStatus?:
+        | 'PARTICIPANTS_DID_NOT_SPEAK'
+        | 'AGENT_DID_NOT_ANSWER'
+        | 'AGENT_DID_NOT_SPEAK'
+        | 'AGENT_STOPPED_SPEAKING'
         | 'AGENT_ENDED_CALL'
         | 'AGENT_TRANSFERRED_CALL'
+        | 'AGENT_BUSY'
         | 'AGENT_ERROR'
         | 'CUSTOMER_ENDED_CALL'
         | 'VOICE_MAIL_REACHED'
         | 'SILENCE_TIME_OUT'
         | 'PHONE_CALL_PROVIDER_CONNECTION_ERROR'
         | 'CUSTOMER_DID_NOT_ANSWER'
+        | 'CUSTOMER_DID_NOT_SPEAK'
+        | 'CUSTOMER_STOPPED_SPEAKING'
         | 'CUSTOMER_BUSY'
         | 'DIAL_ERROR'
         | 'MAX_DURATION_REACHED'
@@ -1564,8 +1580,8 @@ export namespace EvaluationCreateJobParams {
       retellCallId?: string;
 
       /**
-       * URL of source stereo recording in WAV format. Must be accessible. Can be a
-       * signed URL. While optional it allows for a richer audio player
+       * URL of source stereo recording. Must be accessible. Can be a signed URL. While
+       * optional it allows for a richer audio player. Supported formats: WAV, MP3, MP4.
        */
       stereoRecordingUrl?: string;
 
@@ -1588,6 +1604,8 @@ export namespace EvaluationCreateJobParams {
 
         name?: string | null;
 
+        participantId?: string | null;
+
         phoneNumber?: string | null;
 
         spokeFirst?: boolean;

package/src/resources/index.ts

@@ -1,6 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Call, type CallGetEvaluationRunsResponse, type CallGetSentimentRunsResponse } from './call';
+export {
+  Call,
+  type CallGetEvaluationRunsResponse,
+  type CallGetMetricsResponse,
+  type CallGetSentimentRunsResponse,
+  type CallGetMetricsParams,
+} from './call';
 export {
   Evaluation,
   type EvaluationCreateJobResponse,
@@ -20,6 +26,7 @@ export {
   type IntegrationCreateRetellCallParams,
   type IntegrationCreateVapiCallParams,
 } from './integrations';
+export { Metric, type MetricGetDefinitionsResponse } from './metric';
 export {
   Persona,
   type PersonaCreateResponse,

package/src/resources/metric.ts

@@ -0,0 +1,90 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class Metric extends APIResource {
+  /**
+   * Fetch all metric definitions available in the project, including both
+   * system-generated and custom metrics. Only returns metrics from enabled analysis
+   * packages.
+   */
+  getDefinitions(options?: Core.RequestOptions): Core.APIPromise<MetricGetDefinitionsResponse> {
+    return this._client.get('/v1/metric/definitions', options);
+  }
+}
+
+export interface MetricGetDefinitionsResponse {
+  /**
+   * Metrics response payload
+   */
+  data: Array<MetricGetDefinitionsResponse.Data>;
+}
+
+export namespace MetricGetDefinitionsResponse {
+  /**
+   * 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
+     */
+    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 declare namespace Metric {
+  export { type MetricGetDefinitionsResponse as MetricGetDefinitionsResponse };
+}