Label

A label include all information resulting of the action of annotation by a specific user.

type Label {
  _: Boolean
  annotations: [Annotation!]! @deprecated
  annotationsScalar: [AnnotationScalar!]!
  speakers: [Speaker!]!
  chatItems: [ChatItem!]!
  id: ID!
  assetId: String!
  author: User!
  authorId: String!
  assetStep: AssetWorkflowStep
  createdAt: DateTime!
  honeypotMark: Float
  clientVersion: Int!
  inferenceMark: Float
  isCorrected: Boolean!
  correctedByUserId: ID
  isHoneypot: Boolean!
  isLatestLabelForUser: Boolean!
  isLastForStep: Boolean!
  isLatestDefaultLabelForUser: Boolean!
  isLatestReviewLabelForUser: Boolean!
  isLatestPredictionLabelForUser: Boolean!
  isSentBackToQueue: Boolean
  jsonResponseUrl: String
  jsonResponse: String!
  labelOf: Asset!
  labelType: LabelType!
  modelName: String
  numberOfAnnotations: Int
  projectId: String!
  response: JSON!
  reviewScore: Float
  referencedLabel: Label
  secondsToLabel: Float
  search: JSON!
  totalSecondsToLabel: Int
  version: Int!
  openIssuesObjectMids: [String!]!
}

Fields

Label._ ● Boolean scalar

Label.annotationsScalar ● [AnnotationScalar!]! non-null scalar

Returns all annotations as an array of scalars. Optimized for performance by skipping per-element GraphQL validation overhead.

Label.speakers ● [Speaker!]! non-null object

Speakers associated with this label (for audio projects).

Label.chatItems ● [ChatItem!]! non-null object

Label.id ● ID! non-null scalar

Label.assetId ● String! non-null scalar

Label.author ● User! non-null object

User that created this label.

Label.authorId ● String! non-null scalar

Label.assetStep ● AssetWorkflowStep object

Asset step id of the asset step related to this label.

Label.createdAt ● DateTime! non-null scalar

Label.honeypotMark ● Float scalar

Honeypot is a quality parameter to measure the agreement between a pre-annotated asset (a golden standard) and the annotation made by an annotator. Quality is measured against a predefined truth.

In the case of Honeypot Asset, chord note expressed in percentage between the label and the target. In the case of an Asset that is not of Honeypot type, the field is null.

Label.clientVersion ● Int! non-null scalar

Version of the label given by the client. It differs from the version field because for each new save, either the client gives the version number or it is at 0 by default.

This is used to check order of autosave.

Label.inferenceMark ● Float scalar

Inference mark is a quality parameter to measure the agreement between an inference run (from a model) and the annotation made by an annotator.

Label.isCorrected ● Boolean! non-null scalar

Boolean flagging whether the label has been revised. Derived from correctedByUserId.

Label.correctedByUserId ● ID scalar

Id of the user who triggered the correction of this label, or null if the label has not been corrected. Resolved from the same column as isCorrected, so it adds no query complexity.

Label.isHoneypot ● Boolean! non-null scalar

Boolean flagging whether the label is used as the base for computing the honeypot mark of the other labels

Label.isLatestLabelForUser ● Boolean! non-null scalar

Boolean flagging whether the label is the latest submitted label for this asset for the user

Label.isLastForStep ● Boolean! non-null scalar

Boolean flagging whether the label is the last label submitted by the user for its asset step.

Label.isLatestDefaultLabelForUser ● Boolean! non-null scalar

Boolean flagging whether the label is the latest submitted DEFAULT label for this asset for the user.

Label.isLatestReviewLabelForUser ● Boolean! non-null scalar

Boolean flagging whether the label is the latest submitted REVIEW label for this asset for the user.

Label.isLatestPredictionLabelForUser ● Boolean! non-null scalar

Boolean flagging whether the label is the latest submitted PREDICTION label for this asset for the user.

Label.isSentBackToQueue ● Boolean scalar

Technical field.

Label.jsonResponseUrl ● String scalar

URL to the JSON file stored in the bucket containing the list of all annotations of this label

Label.jsonResponse ● String! non-null scalar

The list of all annotations of this label, for each task of this project, in a JSON character string. Kili annotations closely follow the Google format.

Label.labelOf ● Asset! non-null object

Asset related to this label.

Label.labelType ● LabelType! non-null enum

Type of label used to identify if the label is a prediction (made by a model), an ordinary label (made by an annotator) or a journal (carried out by a reviewer).

Can take the following values: DEFAULT INFERENCE PREDICTION REVIEW

Label.modelName ● String scalar

In case the label was uploaded (and is of type PREDICTION), name (chosen during the upload) of the model used to create the label.

Label.numberOfAnnotations ● Int scalar

Total number of annotation elements on the asset.

Label.projectId ● String! non-null scalar

Label.response ● JSON! non-null scalar

The list of all annotations of this label, for each task of this project, in a JSON field. Kili annotations closely follow the Google format.

Label.reviewScore ● Float scalar

Quality parameter to measure agreement score between labelers and reviewers computed on reviewed assets.

Label.referencedLabel ● Label object

Label used by the labeler as a reference to create its label. For example in the case of a review, the referenced label is the label that is reviewed.

Label.secondsToLabel ● Float scalar

Amount of time (in seconds) spent by the labeller on the interface before submitting the label.

Label.search ● JSON! non-null scalar

Technical field.

Label.totalSecondsToLabel ● Int scalar

Total cumulated amount of time (in seconds) spent by the user on all other labels of the same asset on the interface.

Label.version ● Int! non-null scalar

Version of the label.

Label.openIssuesObjectMids ● [String!]! non-null scalar

The list of unique object IDs that are assigned to open issues on the asset created by this label's author.

Show deprecated

Member Of

Asset object ● Label object