Langfuse JS/TS SDKs
    Preparing search index...

    Interface EvaluationRule

    Live evaluation rule for incoming data.

    An evaluation rule answers:

    • which evaluator should be used
    • which target objects should trigger scoring
    • how often scoring should run
    • which target fields should populate each prompt variable
    • whether the deployment is active, inactive, or paused

    Important status semantics:

    • enabled is the desired on/off setting from the client
    • status is the effective runtime state after Langfuse applies validation and blocking rules
    • enabled=true with status=paused means the rule should run, but Langfuse has paused it until the underlying problem is fixed
    interface EvaluationRule {
        createdAt: string;
        enabled: boolean;
        evaluator: null | unstable.EvaluationRuleEvaluator;
        evaluators: unstable.EvaluationRuleEvaluatorAssignment[];
        filter: unstable.EvaluationRuleFilter[];
        id: string;
        mapping: unstable.PromptVariableMappingRead[];
        name: string;
        pausedMessage: null | string;
        pausedReason: null | string;
        sampling: number;
        status: unstable.EvaluationRuleStatus;
        target: unstable.EvaluationRuleTarget;
        updatedAt: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt enabled evaluator evaluators filter id mapping name pausedMessage pausedReason sampling status target updatedAt

    Properties

    createdAt: string

    Timestamp when the evaluation rule was created.

    enabled: boolean

    Desired enabled state configured by the client.

    evaluator: null | unstable.EvaluationRuleEvaluator

    Deprecated compatibility alias for evaluators[0].evaluator, or null when the rule currently has no evaluator assignments.

    id identifies the evaluator family. The rule automatically uses the latest available version of that evaluator.

    evaluators: unstable.EvaluationRuleEvaluatorAssignment[]

    Evaluators attached to this rule in deterministic assignment order. A null mapping inherits the evaluator version's default mapping.

    filter: unstable.EvaluationRuleFilter[]

    List of filter conditions used to decide whether a target should be evaluated.

    id: string

    Stable evaluation rule identifier.

    mapping: unstable.PromptVariableMappingRead[]

    Deprecated compatibility alias containing the effective mapping for evaluators[0].

    name: string

    Human-readable deployment name. This is independent from the evaluator name.

    pausedMessage: null | string

    Human-readable explanation when status=paused, otherwise null.

    pausedReason: null | string

    Machine-readable reason when status=paused, otherwise null.

    sampling: number

    Fraction of matching target objects that should be evaluated.

    Must be greater than 0 and less than or equal to 1.

    • 1 means evaluate every matching target.
    • 0.25 means evaluate approximately 25% of matching targets.
    status: unstable.EvaluationRuleStatus

    Effective runtime status after Langfuse applies validation and blocking rules.

    target: unstable.EvaluationRuleTarget

    Target object type that should trigger scoring.

    updatedAt: string

    Timestamp when the evaluation rule was last updated.

    Settings

    Member Visibility

    On This Page

    Properties