@roarkanalytics/sdk 0.331.2 → 0.333.0

package/resources/evaluation.d.ts

@@ -5,6 +5,16 @@ export declare class Evaluation extends APIResource {
      * Create a evaluation job for a single call or dataset of calls
      */
     createJob(body: EvaluationCreateJobParams, options?: Core.RequestOptions): Core.APIPromise<EvaluationCreateJobResponse>;
+    /**
+     * Returns a specific evaluator with its blocks and configuration.
+     */
+    getEvaluatorById(evaluatorId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetEvaluatorByIDResponse>;
+    /**
+     * Returns a list of evaluators with their blocks and configuration for the
+     * authenticated project.
+     */
+    getEvaluators(query?: EvaluationGetEvaluatorsParams, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetEvaluatorsResponse>;
+    getEvaluators(options?: Core.RequestOptions): Core.APIPromise<EvaluationGetEvaluatorsResponse>;
     /**
      * Retrieve details of a specific evaluation job
      */
@@ -30,6 +40,698 @@ export declare namespace EvaluationCreateJobResponse {
         status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
     }
 }
+/**
+ * Evaluator with its configured blocks
+ */
+export interface EvaluationGetEvaluatorByIDResponse {
+    /**
+     * Unique identifier for the evaluator
+     */
+    id: string;
+    /**
+     * Array of evaluation blocks configured for this evaluator
+     */
+    blocks: Array<EvaluationGetEvaluatorByIDResponse.UnionMember0 | EvaluationGetEvaluatorByIDResponse.UnionMember1 | EvaluationGetEvaluatorByIDResponse.UnionMember2 | EvaluationGetEvaluatorByIDResponse.UnionMember3 | EvaluationGetEvaluatorByIDResponse.UnionMember4 | EvaluationGetEvaluatorByIDResponse.UnionMember5 | EvaluationGetEvaluatorByIDResponse.UnionMember6 | EvaluationGetEvaluatorByIDResponse.UnionMember7 | EvaluationGetEvaluatorByIDResponse.UnionMember8>;
+    /**
+     * ISO timestamp when the evaluator was created
+     */
+    createdAt: string;
+    /**
+     * Optional description of the evaluator
+     */
+    description: string | null;
+    /**
+     * Name of the evaluator
+     */
+    name: string;
+    /**
+     * Unique slug identifier for the evaluator
+     */
+    slug: string;
+    /**
+     * ISO timestamp when the evaluator was last updated
+     */
+    updatedAt: string;
+}
+export declare namespace EvaluationGetEvaluatorByIDResponse {
+    interface UnionMember0 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'CUSTOM_PROMPT';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Name of the metric this prompt evaluates
+         */
+        metricName: string;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * The prompt to evaluate the call against
+         */
+        prompt: string;
+        /**
+         * Minimum score threshold to pass evaluation (0-1)
+         */
+        threshold: number;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember1 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'DATAFIELD_CHECK';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Criteria for evaluating the property
+         */
+        evaluationCriteria: string;
+        /**
+         * Whether this property must be present
+         */
+        isRequired: boolean;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * Name of the property to check
+         */
+        propertyName: string;
+        /**
+         * Minimum score threshold to pass evaluation (0-1)
+         */
+        threshold: number;
+        /**
+         * Expected type of the property value
+         */
+        valueType: string;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember2 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'EMOTION';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * The emotion to detect (e.g., "joy", "anger", "sadness")
+         */
+        selectedEmotion: string;
+        /**
+         * Minimum confidence threshold for emotion detection (0-1)
+         */
+        threshold: number;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember3 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'LATENCY';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Maximum number of silence periods allowed
+         */
+        maxAllowedSilences: number;
+        /**
+         * Minimum duration of silence in milliseconds to be considered
+         */
+        minSilenceDuration: number;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * Maximum allowed latency score
+         */
+        threshold: number;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember4 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'POLITENESS';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * Minimum politeness score threshold (0-1)
+         */
+        threshold: number;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember5 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'SENTIMENT';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * Minimum sentiment score threshold (0-1)
+         */
+        threshold: number;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember6 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'TOOL_CALLS';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Condition that must be met for tool invocation
+         */
+        invocationCondition: string | null;
+        /**
+         * Minimum number of times the tool should be invoked
+         */
+        minInvocationCount: number | null;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * Whether the tool should be invoked
+         */
+        shouldBeInvoked: boolean;
+        /**
+         * ID of the tool definition
+         */
+        toolDefinitionId: string;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember7 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'TOXICITY';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * Maximum allowed toxicity score (0-1)
+         */
+        threshold: number;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+    interface UnionMember8 {
+        /**
+         * Unique identifier for the block
+         */
+        id: string;
+        blockType: 'VOCAL_CUE';
+        /**
+         * Optional description of what this block evaluates
+         */
+        description: string | null;
+        /**
+         * Display name of the evaluation block
+         */
+        name: string;
+        /**
+         * Order in which this block is executed
+         */
+        orderIndex: number;
+        /**
+         * The vocal cue to detect (e.g., "pace", "tone", "volume")
+         */
+        selectedCue: string;
+        /**
+         * Minimum confidence threshold for vocal cue detection (0-1)
+         */
+        threshold: number;
+        /**
+         * Weight of this block in the overall evaluation score (0-100)
+         */
+        weight: number;
+    }
+}
+/**
+ * Response containing evaluators and pagination info
+ */
+export interface EvaluationGetEvaluatorsResponse {
+    /**
+     * Array of evaluators with their blocks
+     */
+    data: Array<EvaluationGetEvaluatorsResponse.Data>;
+    /**
+     * Pagination information
+     */
+    pagination: EvaluationGetEvaluatorsResponse.Pagination;
+}
+export declare namespace EvaluationGetEvaluatorsResponse {
+    /**
+     * Evaluator with its configured blocks
+     */
+    interface Data {
+        /**
+         * Unique identifier for the evaluator
+         */
+        id: string;
+        /**
+         * Array of evaluation blocks configured for this evaluator
+         */
+        blocks: Array<Data.UnionMember0 | Data.UnionMember1 | Data.UnionMember2 | Data.UnionMember3 | Data.UnionMember4 | Data.UnionMember5 | Data.UnionMember6 | Data.UnionMember7 | Data.UnionMember8>;
+        /**
+         * ISO timestamp when the evaluator was created
+         */
+        createdAt: string;
+        /**
+         * Optional description of the evaluator
+         */
+        description: string | null;
+        /**
+         * Name of the evaluator
+         */
+        name: string;
+        /**
+         * Unique slug identifier for the evaluator
+         */
+        slug: string;
+        /**
+         * ISO timestamp when the evaluator was last updated
+         */
+        updatedAt: string;
+    }
+    namespace Data {
+        interface UnionMember0 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'CUSTOM_PROMPT';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Name of the metric this prompt evaluates
+             */
+            metricName: string;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * The prompt to evaluate the call against
+             */
+            prompt: string;
+            /**
+             * Minimum score threshold to pass evaluation (0-1)
+             */
+            threshold: number;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember1 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'DATAFIELD_CHECK';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Criteria for evaluating the property
+             */
+            evaluationCriteria: string;
+            /**
+             * Whether this property must be present
+             */
+            isRequired: boolean;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * Name of the property to check
+             */
+            propertyName: string;
+            /**
+             * Minimum score threshold to pass evaluation (0-1)
+             */
+            threshold: number;
+            /**
+             * Expected type of the property value
+             */
+            valueType: string;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember2 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'EMOTION';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * The emotion to detect (e.g., "joy", "anger", "sadness")
+             */
+            selectedEmotion: string;
+            /**
+             * Minimum confidence threshold for emotion detection (0-1)
+             */
+            threshold: number;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember3 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'LATENCY';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Maximum number of silence periods allowed
+             */
+            maxAllowedSilences: number;
+            /**
+             * Minimum duration of silence in milliseconds to be considered
+             */
+            minSilenceDuration: number;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * Maximum allowed latency score
+             */
+            threshold: number;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember4 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'POLITENESS';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * Minimum politeness score threshold (0-1)
+             */
+            threshold: number;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember5 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'SENTIMENT';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * Minimum sentiment score threshold (0-1)
+             */
+            threshold: number;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember6 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'TOOL_CALLS';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Condition that must be met for tool invocation
+             */
+            invocationCondition: string | null;
+            /**
+             * Minimum number of times the tool should be invoked
+             */
+            minInvocationCount: number | null;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * Whether the tool should be invoked
+             */
+            shouldBeInvoked: boolean;
+            /**
+             * ID of the tool definition
+             */
+            toolDefinitionId: string;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember7 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'TOXICITY';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * Maximum allowed toxicity score (0-1)
+             */
+            threshold: number;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+        interface UnionMember8 {
+            /**
+             * Unique identifier for the block
+             */
+            id: string;
+            blockType: 'VOCAL_CUE';
+            /**
+             * Optional description of what this block evaluates
+             */
+            description: string | null;
+            /**
+             * Display name of the evaluation block
+             */
+            name: string;
+            /**
+             * Order in which this block is executed
+             */
+            orderIndex: number;
+            /**
+             * The vocal cue to detect (e.g., "pace", "tone", "volume")
+             */
+            selectedCue: string;
+            /**
+             * Minimum confidence threshold for vocal cue detection (0-1)
+             */
+            threshold: number;
+            /**
+             * Weight of this block in the overall evaluation score (0-100)
+             */
+            weight: number;
+        }
+    }
+    /**
+     * Pagination information
+     */
+    interface Pagination {
+        /**
+         * Whether there are more evaluators to fetch
+         */
+        hasMore: boolean;
+        /**
+         * Cursor for the next page, null if no more pages
+         */
+        nextCursor: string | null;
+        /**
+         * Total number of evaluators
+         */
+        total: number;
+    }
+}
 export interface EvaluationGetJobResponse {
     /**
      * Evaluation job response payload
@@ -485,6 +1187,16 @@ export declare namespace EvaluationCreateJobParams {
         }
     }
 }
+export interface EvaluationGetEvaluatorsParams {
+    /**
+     * Cursor for pagination - evaluator ID to start after
+     */
+    after?: string;
+    /**
+     * Maximum number of evaluators to return (default: 20, max: 50)
+     */
+    limit?: string;
+}
 export interface EvaluationGetJobRunsParams {
     /**
      * Number of items to return per page
@@ -496,6 +1208,6 @@ export interface EvaluationGetJobRunsParams {
     nextCursor?: string;
 }
 export declare namespace Evaluation {
-    export { type EvaluationCreateJobResponse as EvaluationCreateJobResponse, type EvaluationGetJobResponse as EvaluationGetJobResponse, type EvaluationGetJobRunsResponse as EvaluationGetJobRunsResponse, type EvaluationCreateJobParams as EvaluationCreateJobParams, type EvaluationGetJobRunsParams as EvaluationGetJobRunsParams, };
+    export { type EvaluationCreateJobResponse as EvaluationCreateJobResponse, type EvaluationGetEvaluatorByIDResponse as EvaluationGetEvaluatorByIDResponse, type EvaluationGetEvaluatorsResponse as EvaluationGetEvaluatorsResponse, type EvaluationGetJobResponse as EvaluationGetJobResponse, type EvaluationGetJobRunsResponse as EvaluationGetJobRunsResponse, type EvaluationCreateJobParams as EvaluationCreateJobParams, type EvaluationGetEvaluatorsParams as EvaluationGetEvaluatorsParams, type EvaluationGetJobRunsParams as EvaluationGetJobRunsParams, };
 }
 //# sourceMappingURL=evaluation.d.ts.map