Types

See also

Please visit our docs for more information on Segments.ai and visit the setup page to learn how to install and setup the Segments.ai Python SDK.

Datasets

class Dataset

field name: str

field full_name: str

field cloned_from: str | None

field description: str

field category: Category

field public: bool

field archived: bool

field owner: Owner

field created_at: str

field enable_ratings: bool

field enable_skip_labeling: bool

field enable_skip_reviewing: bool

field enable_save_button: bool

field enable_label_status_verified: bool

field enable_same_dimensions_track_constraint: bool

field enable_3d_region_of_interest: bool

field enable_3d_cuboid_rotation: bool | None

field enable_confirm_on_submit: bool | None

field enable_interpolation: bool

field use_timestamps_for_interpolation: bool

field enable_object_linking: bool

field task_type: TaskType

field label_stats: LabelStats

field labeling_inactivity_timeout_seconds: int | None

field samples_count: str | int | None

field collaborators_count: int | None

field task_attributes: TaskAttributes | None

field labelsets: List[Labelset] | None

field role: str | None

field readme: str | None

field metadata: Dict[str, Any]

field noncollaborator_can_label: bool | None

field noncollaborator_can_review: bool | None

field insights_urls: Dict[str, str] | None

field region_of_interest: Dict[str, Any] | None

class Collaborator

field user: User

field role: Role

class User

field username: str

field created_at: str

field is_organization: bool

field email: str | None

field webhooks_enabled: bool | None

field private_upload_count: int | None

field public_upload_count: int | None

field subscription: Subscription | None

field is_trial_expired: bool | None

field organizations: List[User] | None

field organization_created_by: str | None

field organization_role: Role | None

field members: List[User] | None

field insights_urls: Dict[str, str] | None

class TaskType(*values)

SEGMENTATION_BITMAP = 'segmentation-bitmap'

SEGMENTATION_BITMAP_HIGHRES = 'segmentation-bitmap-highres'

IMAGE_SEGMENTATION_SEQUENCE = 'image-segmentation-sequence'

BBOXES = 'bboxes'

VECTOR = 'vector'

IMAGE_VECTOR_SEQUENCE = 'image-vector-sequence'

KEYPOINTS = 'keypoints'

POINTCLOUD_CUBOID = 'pointcloud-cuboid'

POINTCLOUD_CUBOID_SEQUENCE = 'pointcloud-cuboid-sequence'

POINTCLOUD_SEGMENTATION = 'pointcloud-segmentation'

POINTCLOUD_SEGMENTATION_SEQUENCE = 'pointcloud-segmentation-sequence'

POINTCLOUD_VECTOR = 'pointcloud-vector'

POINTCLOUD_VECTOR_SEQUENCE = 'pointcloud-vector-sequence'

MULTISENSOR_SEQUENCE = 'multisensor-sequence'

EMPTY = ''

Samples

class Sample

field uuid: str

field name: str

field attributes: SampleAttributes | None

field metadata: Dict[str, Any]

field created_at: str

field created_by: str

field readme: str

field assigned_labeler: str | None

field assigned_reviewer: str | None

field priority: float

field label: Label | LabelSummary | None

field issues: List[Issue] | None

field dataset_full_name: str | None

class Issue

field uuid: str

field description: str

field created_at: str

field updated_at: str

field created_by: str

field updated_by: str

field status: IssueStatus

field comments: List[IssueComment]

field anchor: IssueAnchor | None

field sample_uuid: str

field sample_name: str

class IssueComment

field created_at: str

field created_by: str

field text: str

class IssueStatus(*values)

OPEN = 'OPEN'

CLOSED = 'CLOSED'

Image sample

class ImageSampleAttributes

field image: URL

Image sequence sample

class ImageSequenceSampleAttributes

field frames: List[ImageFrame]

class ImageFrame

Bases: ImageSampleAttributes

field name: str | None

field timestamp: Timestamp | None

Point cloud sample

class PointcloudSampleAttributes

field pcd: PCD

field images: List[CalibratedImage]

field ego_pose: EgoPose | None

field default_z: float | None

field name: str | None

field timestamp: Timestamp | None

field bounds: Bounds | None

Point cloud sequence sample

class PointcloudSequenceSampleAttributes

field frames: List[PointcloudSampleAttributes]

Multi-sensor sample

class MultiSensorSampleAttributes

field sensors: List[MultiSensorPointcloudSequenceSampleAttributes | MultiSensorImageSequenceSampleAttributes]

class MultiSensorPointcloudSequenceSampleAttributes

field name: str

field task_type: Literal[TaskType.POINTCLOUD_CUBOID_SEQUENCE] | Literal[TaskType.POINTCLOUD_VECTOR_SEQUENCE] | Literal[TaskType.POINTCLOUD_SEGMENTATION_SEQUENCE]

field attributes: PointcloudSequenceSampleAttributes

class MultiSensorImageSequenceSampleAttributes

field name: str

field task_type: Literal[TaskType.IMAGE_VECTOR_SEQUENCE] | Literal[TaskType.IMAGE_SEGMENTATION_SEQUENCE]

field attributes: ImageSequenceSampleAttributes

Labels

class Label

field sample_uuid: str

field label_type: TaskType

field label_status: LabelStatus

field labelset: str

field attributes: LabelAttributes | None

field created_at: str

field created_by: str

field updated_at: str

field updated_by: str | None

field score: float | None

field rating: float | None

field reviewed_at: str | None

field reviewed_by: str | None

class LabelStatus(*values)

REVIEWED = 'REVIEWED'

REVIEWING_IN_PROGRESS = 'REVIEWING_IN_PROGRESS'

LABELED = 'LABELED'

LABELING_IN_PROGRESS = 'LABELING_IN_PROGRESS'

REJECTED = 'REJECTED'

PRELABELED = 'PRELABELED'

SKIPPED = 'SKIPPED'

VERIFIED = 'VERIFIED'

UNLABELED = 'UNLABELED'

Image segmentation label

class ImageSegmentationLabelAttributes

field annotations: List[Annotation]

field segmentation_bitmap: URL

field image_attributes: ImageAttributes | None

field format_version: FormatVersion | None

class Annotation

field id: int

field category_id: int

field attributes: ObjectAttributes | None

Image vector label

class ImageVectorLabelAttributes

field annotations: List[ImageVectorAnnotation]

field format_version: FormatVersion | None

field image_attributes: ImageAttributes | None

class ImageVectorAnnotation

field id: int

field category_id: int

field points: List[List[float]]

field type: ImageVectorAnnotationType

field attributes: ObjectAttributes | None

class ImageVectorAnnotationType(*values)

BBOX = 'bbox'

POLYGON = 'polygon'

POLYLINE = 'polyline'

POINT = 'point'

Image sequence vector label

class ImageSequenceVectorLabelAttributes

field frames: List[ImageVectorFrame]

field format_version: FormatVersion | None

class ImageVectorFrame

Bases: ImageVectorLabelAttributes

field annotations: List[ImageSequenceVectorAnnotation]

field timestamp: Timestamp | None

field format_version: FormatVersion | None

field image_attributes: ImageAttributes | None

class ImageSequenceVectorAnnotation

Bases: ImageVectorAnnotation

field track_id: int

field is_keyframe: bool

Point cloud segmentation label

class PointcloudSegmentationLabelAttributes

field annotations: List[Annotation]

field image_attributes: ImageAttributes | None

field point_annotations: List[int]

field format_version: FormatVersion | None

Point cloud cuboid label

class PointcloudCuboidLabelAttributes

field links: List[Link] | None

class PointcloudCuboidAnnotation

field id: int

field category_id: int

field position: XYZ

field dimensions: XYZ

field yaw: float

field rotation: XYZW | None

field type: PointcloudCuboidAnnotationTypeLiteral

field attributes: ObjectAttributes | None

field velocity: Velocity | None

field acceleration: Acceleration | None

class PointcloudCuboidAnnotationType(*values)

CUBOID = 'cuboid'

CUBOID_SYNC = 'cuboid-sync'

PointcloudCuboidAnnotationTypeLiteral

alias of Literal[CUBOID, CUBOID_SYNC]

Point cloud vector label

class PointcloudVectorLabelAttributes

field links: List[Link] | None

class PointcloudVectorAnnotation

field id: int

field category_id: int

field points: List[List[float]]

field type: PointcloudVectorAnnotationTypeLiteral

field attributes: ObjectAttributes | None

class PointcloudVectorAnnotationType(*values)

POLYGON = 'polygon'

POLYLINE = 'polyline'

POINT = 'point'

PointcloudVectorAnnotationTypeLiteral

alias of Literal[POLYGON, POLYLINE, POINT]

Point cloud sequence segmentation

class PointcloudSequenceSegmentationLabelAttributes

field frames: List[PointcloudSegmentationFrame]

field format_version: FormatVersion | None

class PointcloudSegmentationFrame

Bases: PointcloudSegmentationLabelAttributes

field annotations: List[PointcloudSequenceSegmentationAnnotation]

field timestamp: Timestamp | None

class PointcloudSequenceSegmentationAnnotation

Bases: Annotation

field track_id: int

field is_keyframe: bool

field attributes: ObjectAttributes | None

Point cloud sequence cuboid label

class BasePointcloudSequenceCuboidLabelAttributes

field frames: List[PointcloudSequenceCuboidFrame]

field format_version: FormatVersion | None

class PointcloudSequenceCuboidLabelAttributes

Bases: BasePointcloudSequenceCuboidLabelAttributes

field links: List[Link] | None

class PointcloudSequenceCuboidFrame

Bases: BasePointcloudCuboidLabelAttributes

field annotations: List[PointcloudSequenceCuboidAnnotation]

field timestamp: Timestamp | None

field format_version: FormatVersion | None

class PointcloudSequenceCuboidAnnotation

Bases: PointcloudCuboidAnnotation

field track_id: int

field is_keyframe: bool

Point cloud sequence vector label

class BasePointcloudSequenceVectorLabelAttributes

field frames: List[PointcloudSequenceVectorFrame]

field format_version: FormatVersion | None

class PointcloudSequenceVectorLabelAttributes

Bases: BasePointcloudSequenceVectorLabelAttributes

field links: List[Link] | None

class PointcloudSequenceVectorFrame

Bases: PointcloudVectorLabelAttributes

field annotations: List[Annotated[PointcloudSequenceVectorAnnotation | PointcloudSequenceCuboidAnnotation, pydantic.Field(discriminator='type')]]

field timestamp: Timestamp | None

class PointcloudSequenceVectorAnnotation

Bases: PointcloudVectorAnnotation

field track_id: int

field is_keyframe: bool

Multi-sensor label

class MultiSensorLabelAttributes

field sensors: List[Annotated[MultiSensorPointcloudSequenceCuboidLabelAttributes | MultiSensorPointcloudSequenceVectorLabelAttributes | MultiSensorPointcloudSequenceSegmentationLabelAttributes | MultiSensorImageSequenceVectorLabelAttributes | MultiSensorImageSequenceSegmentationLabelAttributes, pydantic.Field(discriminator='task_type')]]

field links: List[Link] | None

class MultiSensorPointcloudSequenceCuboidLabelAttributes

field name: str

field task_type: Literal[TaskType.POINTCLOUD_CUBOID_SEQUENCE]

field attributes: BasePointcloudSequenceCuboidLabelAttributes | List

class MultiSensorPointcloudSequenceVectorLabelAttributes

field name: str

field task_type: Literal[TaskType.POINTCLOUD_VECTOR_SEQUENCE]

field attributes: BasePointcloudSequenceVectorLabelAttributes | List

class MultiSensorImageSequenceVectorLabelAttributes

field name: str

field task_type: Literal[TaskType.IMAGE_VECTOR_SEQUENCE]

field attributes: ImageSequenceVectorLabelAttributes | List

class MultiSensorImageSequenceSegmentationLabelAttributes

field name: str

field task_type: Literal[TaskType.IMAGE_SEGMENTATION_SEQUENCE]

field attributes: ImageSequenceSegmentationLabelAttributes | List

class MultiSensorPointcloudSequenceSegmentationLabelAttributes

field name: str

field task_type: Literal[TaskType.POINTCLOUD_SEGMENTATION_SEQUENCE]

field attributes: PointcloudSequenceSegmentationLabelAttributes | List

Links

class Link

field from_id: int

field to_id: int

field attributes: LinkAttributes | None

Labelsets

class Labelset

field name: str

field description: str

field is_groundtruth: bool | None

field created_at: str | None

Workunits

class Workunit

field uuid: str | None

field created_at: str

field created_by: str

field work_type: str

field next_label_status: str | None

field time: int

field inactive_time: int

field sample_uuid: str

field sample_name: str

field label_rating: int | None

Releases

class Release

field uuid: str

field name: str

field description: str

field release_type: Literal['JSON']

field attributes: URL

field status: ReleaseStatus

field created_at: str

field samples_count: int

class ReleaseStatus(*values)

PENDING = 'PENDING'

SUCCEEDED = 'SUCCEEDED'

FAILED = 'FAILED'

Files

class File

field uuid: str

field filename: str

field url: str

field created_at: str

field presignedPostFields: PresignedPostFields

class PresignedPostFields

field url: str

field fields: AWSFields

Object attribute definitions

Base task attributes

This types are not used directly, but are instead mix-ins for their respective object and linking attribute classes.

class BaseAttribute

field name: str

field is_mandatory: bool | None

class BaseSelectTaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.SELECT]

field values: List[str]

field default_value: str | None

class BaseTextTaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.TEXT]

field default_value: str | None

class BaseNumberTaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.NUMBER]

field default_value: float | None

field min: float | None

field max: float | None

field step: float | None

class BaseCheckboxTaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.CHECKBOX]

field default_value: bool | None

class BaseMultiselectTaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.MULTISELECT]

field values: List[str]

field default_value: str | None

class BaseVector3TaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.VECTOR3]

class BaseQuaternionTaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.QUATERNION]

class BasePointsTaskAttribute

Bases: BaseAttribute

field input_type: Literal[InputType.POINTS]

Task attributes

These types are used for defining task attributes.

class TaskAttributes

field format_version: FormatVersion | None

field categories: List[TaskAttributeCategory] | None

field image_attributes: List[TaskAttribute] | None

field warning_rules: List[WarningRule] | None

TaskAttribute

TaskAttribute can be one of the following:

• SelectTaskAttribute

• MultiselectTaskAttribute

• TextTaskAttribute

• NumberTaskAttribute

• CheckboxTaskAttribute

• Vector3TaskAttribute

• QuaternionTaskAttribute

• PointsTaskAttribute

class TaskAttributeCategory

field name: str

field id: int

field color: RGB | RGBA | None

field has_instances: bool | None

field attributes: List[TaskAttribute] | None

field dimensions: XYZ | None

field link_attributes: List[TaskLinkAttribute] | None

class BaseTaskAttribute

field is_track_level: bool | None

field synced_across_sensors: bool | None

field sensor_filter: str | None

class SelectTaskAttribute

Bases: BaseTaskAttribute, BaseSelectTaskAttribute

class TextTaskAttribute

Bases: BaseTaskAttribute, BaseTextTaskAttribute

class NumberTaskAttribute

Bases: BaseTaskAttribute, BaseNumberTaskAttribute

class CheckboxTaskAttribute

Bases: BaseTaskAttribute, BaseCheckboxTaskAttribute

class MultiselectTaskAttribute

Bases: BaseTaskAttribute, BaseMultiselectTaskAttribute

class Vector3TaskAttribute

Bases: BaseTaskAttribute, BaseVector3TaskAttribute

class QuaternionTaskAttribute

Bases: BaseTaskAttribute, BaseQuaternionTaskAttribute

class PointsTaskAttribute

Bases: BaseTaskAttribute, BasePointsTaskAttribute

Link attributes

These types are used for defining link attributes.

class BaseTaskLinkAttribute

field is_track_level: Literal[True]

TaskLinkAttribute

TaskLinkAttribute can be one of the following:

• SelectTaskLinkAttribute

• MultiselectTaskLinkAttribute

• TextTaskLinkAttribute

• NumberTaskLinkAttribute

• CheckboxTaskLinkAttribute

class CheckboxTaskLinkAttribute

Bases: BaseTaskLinkAttribute, BaseCheckboxTaskAttribute

class NumberTaskLinkAttribute

Bases: BaseTaskLinkAttribute, BaseNumberTaskAttribute

class TextTaskLinkAttribute

Bases: BaseTaskLinkAttribute, BaseTextTaskAttribute

class MultiselectTaskLinkAttribute

Bases: BaseTaskLinkAttribute, BaseMultiselectTaskAttribute

class SelectTaskLinkAttribute

Bases: BaseTaskLinkAttribute, BaseSelectTaskAttribute

Helper classes

class URL

field url: str | None

field signed_url: str | None

class Owner

field username: str

field created_at: str

field email: str | None

class LabelStats

field REVIEWED: int | None

field REVIEWING_IN_PROGRESS: int | None

field LABELED: int | None

field LABELING_IN_PROGRESS: int | None

field REJECTED: int | None

field PRELABELED: int | None

field SKIPPED: int | None

field VERIFIED: int | None

field UNLABELED: int | None

field TOTAL: int | None

class XYZ

field x: float

field y: float

field z: float

class XYZW

field qx: float

field qy: float

field qz: float

field qw: float

class EgoPose

field position: XYZ

field heading: XYZW

class PCD

field url: str

field signed_url: str | None

field type: PCDType

class PCDType(*values)

PCD = 'pcd'

BINARY_XYZI = 'binary-xyzi'

KITTI = 'kitti'

BINARY_XYZIR = 'binary-xyzir'

NUSCENES = 'nuscenes'

PLY = 'ply'

LAS = 'las'

SPLAT = 'splat'

class CalibratedImage

Bases: URL

field row: int | None

field col: int | None

field intrinsics: CameraIntrinsics | None

field extrinsics: CameraExtrinsics | None

field distortion: Distortion | None

field camera_convention: CameraConvention

field name: str | None

field rotation: float | None

class CameraConvention(*values)

OPEN_CV = 'OpenCV'

OPEN_GL = 'OpenGL'

class CameraIntrinsics

field intrinsic_matrix: List[List[float]]

class CameraExtrinsics

field translation: XYZ

field rotation: XYZW

class DistortionFisheye

field model: Literal[CameraDistortionModel.FISH_EYE]

field coefficients: FisheyeDistortionCoefficients

class DistortionBrownConrady

field model: Literal[CameraDistortionModel.BROWN_CONRADY]

field coefficients: BrownConradyDistortionCoefficients

class CameraDistortionModel(*values)

FISH_EYE = 'fisheye'

BROWN_CONRADY = 'brown-conrady'

class FisheyeDistortionCoefficients

field k1: float

field k2: float

field k3: float

field k4: float

class BrownConradyDistortionCoefficients

field k1: float

field k2: float

field p1: float

field p2: float

field k3: float

field k4: float | None

field k5: float | None

field k6: float | None