Langfuse JS/TS SDKs
    Preparing search index...

    Interface LegacyEvaluationRule

    Legacy trace- or dataset-level evaluation rule returned by list and get for migration.

    This resource is read-only through the unstable public API. Its mapping preserves the trace, dataset item, or named observation that each evaluator variable previously read from. Its filters use the persisted legacy filter format so migration clients can read the configuration without losing information.

    interface LegacyEvaluationRule {
        createdAt: string;
        delay: number;
        enabled: boolean;
        evaluator: unstable.EvaluationRuleEvaluator;
        filter: unstable.EvaluationRuleFilter[];
        id: string;
        mapping: unstable.LegacyEvaluationRuleMapping[];
        name: string;
        pausedMessage: null | string;
        pausedReason: null | string;
        sampling: number;
        status: unstable.EvaluationRuleStatus;
        target: unstable.LegacyEvaluationRuleTarget;
        timeScope: unstable.EvaluationRuleTimeScope[];
        updatedAt: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt: string

    Timestamp when the evaluation rule was created.

    delay: number

    Delay in milliseconds before the legacy evaluation job runs.

    enabled: boolean

    Desired enabled state configured by the client.

    Evaluator currently used by this rule.

    name and scope identify the evaluator family conceptually. id is the currently active evaluator version in that family. If you create a newer project version with the same evaluator name later, existing evaluation rules are moved to it automatically.

    Stored filters used by the legacy trace or dataset rule.

    id: string

    Stable evaluation rule identifier.

    Stored variable mappings, including the trace, dataset item, or named observation selected for each variable.

    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.

    Effective runtime status after Langfuse applies validation and blocking rules.

    Whether the legacy rule evaluates newly ingested data, existing data, or both.

    updatedAt: string

    Timestamp when the evaluation rule was last updated.