Interface Annotation

The base interface for all kinds of annotations (span, trace, session)

interface Annotation {
    explanation?: string;
    identifier?: string;
    label?: string;
    metadata?: Record<string, unknown>;
    name: string;
    score?: number;
}

Hierarchy (View Summary)

Properties

explanation? identifier? label? metadata? name score?

Properties

Optionalexplanation

explanation?: string

Explanation of the annotation result

Optionalidentifier

identifier?: string

The identifier of the annotation. If provided, the annotation will be updated if it already exists.

Optionallabel

label?: string

The label assigned by the annotation

Optionalmetadata

metadata?: Record<string, unknown>

Metadata for the annotation

name

name: string

The name of the annotation

Optionalscore

score?: number

The score assigned by the annotation

Settings

Member Visibility

On This Page

Properties