Function toHtml

Parameters

• result: {
      scores: {
          faithfulness?: number;
          contextRelevance?: number;
          answerRelevance?: number;
          contextRecall?: number;
          contextPrecision?: number;
          overall: number;
          [key: string]: unknown;
      };
      samples: {
          id?: string;
          question: string;
          scores: Record<string, number>;
          reasoning?: Record<string, string>;
          tenantId?: string;
          metadata?: Record<string, unknown>;
      }[];
      stats?: Record<
          string,
          { mean: number; min: number; max: number; stddev: number; count: number },
      >;
      meta: {
          totalSamples: number;
          metrics: string[];
          provider: string;
          model: string;
          startedAt: string;
          completedAt: string;
          durationMs: number;
      };
  }

  The evaluation result from evaluate().

  • scores: {
        faithfulness?: number;
        contextRelevance?: number;
        answerRelevance?: number;
        contextRecall?: number;
        contextPrecision?: number;
        overall: number;
        [key: string]: unknown;
    }

    Aggregate scores averaged across all samples.

  • samples: {
        id?: string;
        question: string;
        scores: Record<string, number>;
        reasoning?: Record<string, string>;
        tenantId?: string;
        metadata?: Record<string, unknown>;
    }[]

    Per-sample detailed results.

  • Optionalstats?: Record<
        string,
        { mean: number; min: number; max: number; stddev: number; count: number },
    >

    Per-metric score distribution statistics (min, max, stddev, count).

    Keys are metric names (same as keys in scores, minus overall). Useful for understanding score variance and identifying which questions score poorly. overall is excluded — compute it from individual metric stats.

    Example

    const { stats } = await evaluate({ ... })
    // High stddev indicates inconsistent pipeline behaviour:
    if ((stats.faithfulness?.stddev ?? 0) > 0.15) {
      console.warn('Faithfulness varies widely across samples — review your retrieval.')
    }
    Copy

  • meta: {
        totalSamples: number;
        metrics: string[];
        provider: string;
        model: string;
        startedAt: string;
        completedAt: string;
        durationMs: number;
    }

    Metadata about the evaluation run.

    • totalSamples: number

      Total number of samples evaluated.

    • metrics: string[]

      Names of the metrics that were evaluated.

    • provider: string

      LLM provider used (e.g. 'anthropic', 'openai').

    • model: string

      LLM model used (e.g. 'claude-opus-4-6').

    • startedAt: string

      ISO 8601 timestamp when evaluation started.

    • completedAt: string

      ISO 8601 timestamp when evaluation completed.

    • durationMs: number

      Wall-clock duration of the evaluation in milliseconds.

• title: string = 'rageval Evaluation Report'

  Optional report title shown in the header.