core
API
Generated with
core/org.llm4s/org.llm4s.rag/org.llm4s.rag.benchmark/BenchmarkReport

BenchmarkReport

org.llm4s.rag.benchmark.BenchmarkReport
object BenchmarkReport

Report generator for benchmark results.

Supports multiple output formats:

  • Console: Formatted text for terminal display
  • JSON: Machine-readable format for processing
  • Markdown: Documentation-ready format

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def comparison(comparison: ExperimentComparison): String

Generate comparison report between two results.

Generate comparison report between two results.

Attributes

def console(results: BenchmarkResults): String

Generate console-friendly report.

Generate console-friendly report.

Value parameters

results

Benchmark results

Attributes

Returns

Formatted string for terminal display

def consoleDetailed(results: BenchmarkResults): String

Generate detailed console report with per-metric breakdown.

Generate detailed console report with per-metric breakdown.

Value parameters

results

Benchmark results

Attributes

Returns

Detailed formatted string

def json(results: BenchmarkResults, pretty: Boolean): String

Generate JSON report.

Generate JSON report.

Value parameters

pretty

Pretty-print with indentation

results

Benchmark results

Attributes

Returns

JSON string

def markdown(results: BenchmarkResults): String

Generate Markdown report.

Generate Markdown report.

Value parameters

results

Benchmark results

Attributes

Returns

Markdown string

def save(results: BenchmarkResults, path: String, format: ReportFormat): Result[Unit]

Save report to file.

Save report to file.

Value parameters

format

Output format (console, json, markdown)

path

Output file path

results

Benchmark results

Attributes

Returns

Unit or error

Generated with