Langfuse JS/TS SDKs
    Preparing search index...

    Interface CreateScoreRequest

    {
     *         name: "novelty",
     *         value: 0.9,
     *         traceId: "cdef-1234-5678-90ab"
     *     }

    {
     *         name: "consistency",
     *         value: 1.2,
     *         dataType: LangfuseAPI.ScoreDataType.Numeric,
     *         traceId: "cdef-1234-5678-90ab"
     *     }

    {
     *         name: "accuracy",
     *         value: 0.9,
     *         dataType: LangfuseAPI.ScoreDataType.Numeric,
     *         configId: "9203-4567-89ab-cdef",
     *         traceId: "cdef-1234-5678-90ab",
     *         environment: "test"
     *     }

    {
     *         name: "toxicity",
     *         value: "not toxic",
     *         traceId: "cdef-1234-5678-90ab",
     *         environment: "production"
     *     }

    {
     *         name: "correctness",
     *         value: "partially correct",
     *         dataType: LangfuseAPI.ScoreDataType.Categorical,
     *         configId: "1234-5678-90ab-cdef",
     *         traceId: "cdef-1234-5678-90ab"
     *     }

    {
     *         name: "hallucination",
     *         value: 0,
     *         dataType: LangfuseAPI.ScoreDataType.Boolean,
     *         traceId: "cdef-1234-5678-90ab"
     *     }

    {
     *         name: "helpfulness",
     *         value: 1,
     *         dataType: LangfuseAPI.ScoreDataType.Boolean,
     *         configId: "1234-5678-90ab-cdef",
     *         traceId: "cdef-1234-5678-90ab"
     *     }

    {
     *         name: "feedback",
     *         value: "Great explanation of the concept",
     *         dataType: LangfuseAPI.ScoreDataType.Text,
     *         traceId: "cdef-1234-5678-90ab"
     *     }

    {
     *         name: "accuracy",
     *         value: 0.9,
     *         dataType: LangfuseAPI.ScoreDataType.Numeric,
     *         configId: "9203-4567-89ab-cdef",
     *         traceId: "cdef-1234-5678-90ab",
     *         source: LangfuseAPI.legacy.CreateScoreSource.Annotation,
     *         queueId: "aq-1234-5678-90ab-cdef"
     *     }
    interface CreateScoreRequest {
        comment?: string;
        configId?: string;
        datasetRunId?: string;
        dataType?: ScoreDataType;
        environment?: string;
        id?: string;
        metadata?: Record<string, unknown>;
        name: string;
        observationId?: string;
        queueId?: string;
        sessionId?: string;
        source?: legacy.CreateScoreSource;
        traceId?: string;
        value: CreateScoreValue;
    }
    Index

    Properties

    comment? configId? datasetRunId? dataType? environment? id? metadata? name observationId? queueId? sessionId? source? traceId? value

    Properties

    comment?: string
    configId?: string

    Reference a score config on a score. The unique langfuse identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated.

    datasetRunId?: string
    dataType?: ScoreDataType

    The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric.

    environment?: string

    The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'.

    id?: string
    metadata?: Record<string, unknown>
    name: string
    observationId?: string
    queueId?: string

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

    sessionId?: string
    source?: legacy.CreateScoreSource

    The source of the score. Defaults to API. Set to ANNOTATION to prefill scores (e.g. from an LLM) for a human reviewer to verify in an annotation queue. When source is ANNOTATION, a configId is required unless dataType is CORRECTION. EVAL is reserved for internal evaluator outputs and is not accepted on this endpoint.

    traceId?: string
    value: CreateScoreValue

    The value of the score. Must be passed as string for categorical and text scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false). Text score values must be between 1 and 500 characters.

    Settings

    Member Visibility

    On This Page

    Properties