Langfuse JS/TS SDKs
    Preparing search index...

    Interface Categorical

    interface Categorical {
        authorUserId: null | string;
        comment: null | string;
        configId: null | string;
        createdAt: string;
        datasetRunId?: null | string;
        dataType: "CATEGORICAL";
        environment: string;
        id: string;
        metadata?: unknown;
        name: string;
        observationId?: null | string;
        queueId: null | string;
        sessionId?: null | string;
        source: ScoreSource;
        stringValue: string;
        timestamp: string;
        traceId?: null | string;
        updatedAt: string;
        value: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authorUserId: null | string

    The user ID of the author

    comment: null | string

    Comment on the score

    configId: null | string

    Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range

    createdAt: string
    datasetRunId?: null | string

    The dataset run ID associated with the score

    dataType: "CATEGORICAL"
    environment: string

    The environment from which this score originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'.

    id: string
    metadata?: unknown

    Metadata associated with the score

    name: string
    observationId?: null | string

    The observation ID associated with the score

    queueId: null | string

    The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.

    sessionId?: null | string

    The session ID associated with the score

    source: ScoreSource
    stringValue: string

    The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category

    timestamp: string
    traceId?: null | string

    The trace ID associated with the score

    updatedAt: string
    value: number

    Represents the numeric category mapping of the stringValue. If no config is linked, defaults to 0.