@roarkanalytics/sdk 3.4.0 → 3.6.0

package/src/resources/metric.ts

@@ -29,16 +29,20 @@ export class Metric extends APIResource {
   }
 
   /**
-   * Fetch all metric definitions available in the project, including both
-   * system-generated and custom metrics.
+   * Fetch metric definitions available in the project, including both
+   * system-generated and custom metrics. Results are ordered by immutable definition
+   * ID; pass `nextCursor` to retrieve the following page.
    *
    * @example
    * ```ts
    * const response = await client.metric.listDefinitions();
    * ```
    */
-  listDefinitions(options?: RequestOptions): APIPromise<MetricListDefinitionsResponse> {
-    return this._client.get('/v1/metric/definitions', options);
+  listDefinitions(
+    query: MetricListDefinitionsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MetricListDefinitionsResponse> {
+    return this._client.get('/v1/metric/definitions', { query, ...options });
   }
 }
 
@@ -59,6 +63,18 @@ export namespace MetricCreateDefinitionResponse {
      */
     id: string;
 
+    /**
+     * For a BOOLEAN metric, what a `false` value means. Also given to the judge as its
+     * polarity rule.
+     */
+    booleanFalseLabel: string | null;
+
+    /**
+     * For a BOOLEAN metric, what a `true` value means. Also given to the judge as its
+     * polarity rule.
+     */
+    booleanTrueLabel: string | null;
+
     /**
      * Metric evaluated by an LLM against a prompt.
      */
@@ -69,6 +85,12 @@ export namespace MetricCreateDefinitionResponse {
      */
     description: string;
 
+    /**
+     * The rubric this judge applies, as stored. Read it back to confirm which criteria
+     * are live after a create or update.
+     */
+    llmPrompt: string | null;
+
     /**
      * Alias of `slug` retained for backwards compatibility. Same value as `slug`.
      */
@@ -79,6 +101,15 @@ export namespace MetricCreateDefinitionResponse {
      */
     name: string;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -94,6 +125,13 @@ export namespace MetricCreateDefinitionResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -166,6 +204,15 @@ export namespace MetricCreateDefinitionResponse {
      */
     name: string;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -181,6 +228,13 @@ export namespace MetricCreateDefinitionResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -270,6 +324,15 @@ export namespace MetricCreateDefinitionResponse {
      */
     pattern: PatternMetricResponse.Pattern;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -285,6 +348,13 @@ export namespace MetricCreateDefinitionResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -384,10 +454,10 @@ export namespace MetricCreateDefinitionResponse {
   }
 }
 
+/**
+ * Cursor-paginated metric definitions available in the project
+ */
 export interface MetricListDefinitionsResponse {
-  /**
-   * Metrics response payload
-   */
   data: Array<
     | MetricListDefinitionsResponse.LlmJudgeMetricResponse
     | MetricListDefinitionsResponse.ProviderMetricResponse
@@ -395,6 +465,8 @@ export interface MetricListDefinitionsResponse {
     | MetricListDefinitionsResponse.FormulaMetricResponse
     | MetricListDefinitionsResponse.PatternMetricResponse
   >;
+
+  pagination: MetricListDefinitionsResponse.Pagination;
 }
 
 export namespace MetricListDefinitionsResponse {
@@ -404,6 +476,18 @@ export namespace MetricListDefinitionsResponse {
      */
     id: string;
 
+    /**
+     * For a BOOLEAN metric, what a `false` value means. Also given to the judge as its
+     * polarity rule.
+     */
+    booleanFalseLabel: string | null;
+
+    /**
+     * For a BOOLEAN metric, what a `true` value means. Also given to the judge as its
+     * polarity rule.
+     */
+    booleanTrueLabel: string | null;
+
     /**
      * Metric evaluated by an LLM against a prompt.
      */
@@ -414,6 +498,12 @@ export namespace MetricListDefinitionsResponse {
      */
     description: string;
 
+    /**
+     * The rubric this judge applies, as stored. Read it back to confirm which criteria
+     * are live after a create or update.
+     */
+    llmPrompt: string | null;
+
     /**
      * Alias of `slug` retained for backwards compatibility. Same value as `slug`.
      */
@@ -424,6 +514,15 @@ export namespace MetricListDefinitionsResponse {
      */
     name: string;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -439,6 +538,13 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -506,6 +612,15 @@ export namespace MetricListDefinitionsResponse {
      */
     name: string;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -521,6 +636,13 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -588,6 +710,15 @@ export namespace MetricListDefinitionsResponse {
      */
     name: string;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -603,6 +734,13 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -705,6 +843,15 @@ export namespace MetricListDefinitionsResponse {
      */
     name: string;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -720,6 +867,13 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -809,6 +963,15 @@ export namespace MetricListDefinitionsResponse {
      */
     pattern: PatternMetricResponse.Pattern;
 
+    /**
+     * True when this metric can only be scored from a live recording
+     * (`supportedConversationSources` is `["LIVE"]`). Selecting one of these on a
+     * simulation run forces live enrichment: the run waits for your recording and, if
+     * none arrives, the metric produces no value. Check this before a run rather than
+     * discovering the wait afterwards.
+     */
+    requiresLiveConversation: boolean;
+
     /**
      * Whether metric is global or per-participant
      */
@@ -824,6 +987,13 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedContexts: Array<'CALL' | 'SEGMENT' | 'TURN'>;
 
+    /**
+     * Which kinds of conversation this metric can be scored on. `null` means both.
+     * `["LIVE"]` marks a metric that can only be scored from your own recording of a
+     * real call, and `["SIMULATED"]` one that only applies to simulations.
+     */
+    supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
+
     /**
      * Type of value this metric produces
      */
@@ -921,6 +1091,14 @@ export namespace MetricListDefinitionsResponse {
       symbol: string | null;
     }
   }
+
+  export interface Pagination {
+    hasMore: boolean;
+
+    limit: number;
+
+    nextCursor: string | null;
+  }
 }
 
 export type MetricCreateDefinitionParams =
@@ -1246,10 +1424,17 @@ export declare namespace MetricCreateDefinitionParams {
   }
 }
 
+export interface MetricListDefinitionsParams {
+  after?: string;
+
+  limit?: number;
+}
+
 export declare namespace Metric {
   export {
     type MetricCreateDefinitionResponse as MetricCreateDefinitionResponse,
     type MetricListDefinitionsResponse as MetricListDefinitionsResponse,
     type MetricCreateDefinitionParams as MetricCreateDefinitionParams,
+    type MetricListDefinitionsParams as MetricListDefinitionsParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.4.0'; // x-release-please-version
+export const VERSION = '3.6.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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