// This file was auto-generated by Fern from our API Definition.

import type * as Vapi from "../index.js";

export interface Scorecard {
    /** This is the unique identifier for the scorecard. */
    id: string;
    /** This is the unique identifier for the org that this scorecard belongs to. */
    orgId: string;
    /** This is the ISO 8601 date-time string of when the scorecard was created. */
    createdAt: string;
    /** This is the ISO 8601 date-time string of when the scorecard was last updated. */
    updatedAt: string;
    /** This is the name of the scorecard. It is only for user reference and will not be used for any evaluation. */
    name?: string | undefined;
    /** This is the description of the scorecard. It is only for user reference and will not be used for any evaluation. */
    description?: string | undefined;
    /**
     * These are the metrics that will be used to evaluate the scorecard.
     * Each metric will have a set of conditions and points that will be used to generate the score.
     */
    metrics: Vapi.ScorecardMetric[];
    /**
     * These are the assistant IDs that this scorecard is linked to.
     * When linked to assistants, this scorecard will be available for evaluation during those assistants' calls.
     */
    assistantIds?: string[] | undefined;
}
