Hierarchy

Index

Constructors

constructor

Properties

confidence

confidence: number

Option for Machine Learning systems to save the confidence results of any model's output

created

created: Date

Time of creation of this Kelvin Data Labels in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

description

description: string

Any type of description that adequately explains this Kelvin Data Label entry. In a practical sense this description could be used in a dashboard for the operators to understand this particular Kelvin Data Label.

endDate

endDate: Date

Timestamp for the end of a time range for which the Kelvin Data Label information is relevant (supports RFC3339 with nanosecond precision, e.g. 2022-11-03T08:15:03.278515Z).

If the Kelvin Data Label is a snapshot in time, the start_time and end_time usually will be the same.

id

id: number

Unique integer number for the Kelvin Data Label.

This is similar to a primary key in a database which is a unique integer number representing one row of data."

info

info: any

A JSON object with any key/value pairs that provide information about this Kelvin Data Label.

It is recommended that any Kelvin Asset / Kelvin Metric pair instantaneous values that are referenced are also saved here rather than trying to link this timestamp to Kelvin Asset / Kelvin Metric pair recorded value timestamp.

labelName

labelName: string

This is the name from the Label variable which can be created with the Kelvin API /datalabels/labels/create.

If the Label name does not exist, it will be automatically created.

metrics

An array of JSON objects containing the Kelvin Asset name and Kelvin Metric name pairs that are related to the Data Label.

source

JSON object detailing the origin of the data. This will be either a user or workload.

startDate

startDate: Date

Timestamp for the start of a time range for which the Kelvin Data Label information is relevant (supports RFC3339 with nanosecond precision, e.g. 2022-11-03T08:15:03.278515Z).

updated

updated: Date

Time of modifying any variable of this Kelvin Data Labels in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

validation

validation: boolean

Option for Machine Learning systems to save the validation results of any model's output

Methods

clone

getClass

  • getClass(): Function

mapping

  • mapping(): {}

serializeArray

  • serializeArray(obj: any[]): Object

serializeObject

  • serializeObject(obj: any): any

serializeObjectInstance

  • serializeObjectInstance(obj: Object): Object

stringify

  • stringify(): string

toJSONObject

  • toJSONObject(): Object