Interface ApiScoreBody

ScoreBody

interface ApiScoreBody {
    comment?: null | string;
    configId?: null | string;
    dataType?: null | ApiScoreDataType;
    id?: null | string;
    name: string;
    observationId?: null | string;
    traceId: string;
    value: ApiCreateScoreValue;
}

Properties

comment? configId? dataType? id? name observationId? traceId value

Properties

Optionalcomment

comment?: null | string

OptionalconfigId

configId?: null | string

Reference a score config on a score. When set, the score name must equal the config name and scores must comply with the config's range and data type. For categorical scores, the value must map to a config category. Numeric scores might be constrained by the score config's max and min values

OptionaldataType

dataType?: null | ApiScoreDataType

When set, must match the score value's type. If not set, will be inferred from the score value or config

Optionalid

id?: null | string

name

name: string

Example

"novelty"

OptionalobservationId

observationId?: null | string

traceId

traceId: string

Example

"cdef-1234-5678-90ab"

value

value: ApiCreateScoreValue

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

Settings

Member Visibility

On This Page

Properties