Class LLMObsLabelSchema

Schema definition for a single label in an annotation queue.

Hierarchy

  • LLMObsLabelSchema

Constructors

constructor

Properties

additionalProperties? description? hasAssessment? hasReasoning? id? isAssessment? isInteger? isRequired? max? min? name type values?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional description

description?: string

Description of the label.

Optional hasAssessment

hasAssessment?: boolean

Whether this label includes an assessment field.

Optional hasReasoning

hasReasoning?: boolean

Whether this label includes a reasoning field.

Optional id

id?: string

Unique identifier of the label schema. Assigned by the server if not provided.

Optional isAssessment

isAssessment?: boolean

Whether the boolean label represents an assessment. Requires has_assessment to be true.

Optional isInteger

isInteger?: boolean

Whether score values must be integers. Applicable to score-type labels.

Optional isRequired

isRequired?: boolean

Whether this label is required for an annotation.

Optional max

max?: number

Maximum value for score-type labels.

Optional min

min?: number

Minimum value for score-type labels.

name

name: string

Name of the label. Must match the pattern ^[a-zA-Z0-9_-]+$ and be unique within the queue.

type

type: LLMObsLabelSchemaType

Type of a label in an annotation queue label schema.

Optional values

values?: string[]

Allowed values for categorical-type labels. Must contain at least one non-empty, unique value.

Settings

Member Visibility

Theme

Generated using TypeDoc