Interface: IAnnotation
interfaces.IAnnotation
An interface representing an Annotation object, extending the IEntity interface.
Interface
IAnnotation
Hierarchy
-
IEntity
↳
IAnnotation
Implemented by
Table of contents
Properties
- clientId
- coordinates
- createdAt
- creator
- datasetId
- id
- itemId
- label
- labelSuggestions
- metadata
- type
- updatedAt
- updatedBy
Properties
clientId
• Optional
clientId: string
A local identifier for the Entity, unique within the client.
Inherited from
coordinates
• Optional
coordinates: any
The coordinates associated with the annotation.
createdAt
• createdAt: IDate
The date and time the annotation was created.
Overrides
creator
• Optional
creator: string
The creator of the Entity.
Inherited from
datasetId
• datasetId: string
The ID of the dataset the annotation belongs to.
id
• id: string
A globally unique identifier for the Entity.
Inherited from
itemId
• itemId: string
The ID of the item the annotation is associated with.
label
• label: string
The label associated with the annotation.
labelSuggestions
• labelSuggestions: Object
The label suggestions and their associated confidence scores.
Index signature
▪ [key: string
]: number
metadata
• metadata: any
The metadata associated with the annotation.
type
• type: string
The type of the annotation.
updatedAt
• updatedAt: IDate
The date and time the annotation was last updated.
Overrides
updatedBy
• updatedBy: string
The user who last updated the annotation.