Langfuse JS/TS SDKs
    Preparing search index...

    Type Alias ExperimentParams<Input, ExpectedOutput, Metadata>

    type ExperimentParams<
        Input = any,
        ExpectedOutput = any,
        Metadata extends Record<string, any> = Record<string, any>,
    > = {
        data: ExperimentItem<Input, ExpectedOutput, Metadata>[];
        description?: string;
        evaluators?: Evaluator<Input, ExpectedOutput, Metadata>[];
        maxConcurrency?: number;
        metadata?: Record<string, any>;
        name: string;
        runEvaluators?: RunEvaluator<Input, ExpectedOutput, Metadata>[];
        runName?: string;
        task: ExperimentTask<Input, ExpectedOutput, Metadata>;
    }

    Type Parameters

    • Input = any
    • ExpectedOutput = any
    • Metadata extends Record<string, any> = Record<string, any>
    Index

    Properties

    data description? evaluators? maxConcurrency? metadata? name runEvaluators? runName? task

    Properties

    data: ExperimentItem<Input, ExpectedOutput, Metadata>[]

    Array of data items to process.

    Can be either custom ExperimentItem[] or DatasetItem[] from Langfuse. Each item should contain input data and optionally expected output.

    description?: string

    Optional description explaining the experiment's purpose.

    Provide context about what you're testing, methodology, or goals. This helps with experiment tracking and result interpretation.

    evaluators?: Evaluator<Input, ExpectedOutput, Metadata>[]

    Optional array of evaluator functions to assess each item's output.

    Each evaluator receives input, output, and expected output (if available) and returns evaluation results. Multiple evaluators enable comprehensive assessment.

    maxConcurrency?: number

    Maximum number of concurrent task executions (default: Infinity).

    Controls parallelism to manage resource usage and API rate limits. Set lower values for expensive operations or rate-limited services.

    metadata?: Record<string, any>

    Optional metadata to attach to the experiment run.

    Store additional context like model versions, hyperparameters, or any other relevant information for analysis and comparison.

    name: string

    Human-readable name for the experiment.

    This name will appear in Langfuse UI and experiment results. Choose a descriptive name that identifies the experiment's purpose.

    runEvaluators?: RunEvaluator<Input, ExpectedOutput, Metadata>[]

    Optional array of run-level evaluators to assess the entire experiment.

    These evaluators receive all item results and can perform aggregate analysis like calculating averages, detecting patterns, or statistical analysis.

    runName?: string

    Optional exact name for the experiment run.

    If provided, this will be used as the exact dataset run name if the data contains Langfuse dataset items. If not provided, this will default to the experiment name appended with an ISO timestamp.

    task: ExperimentTask<Input, ExpectedOutput, Metadata>

    The task function to execute on each data item.

    This function receives input data and produces output that will be evaluated. It should encapsulate the model or system being tested.

    Settings

    Member Visibility

    On This Page

    Properties