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: Optional[str]

field description: str

field category: Category

Validated by

• check_category

field public: 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_interpolation: bool

field task_type: TaskType

field label_stats: LabelStats

field labeling_inactivity_timeout_seconds: Optional[int]

field samples_count: Optional[Union[str, int]]

field collaborators_count: Optional[int]

field task_attributes: Optional[TaskAttributes]

field labelsets: Optional[List[Labelset]]

field role: Optional[str]

field readme: Optional[str]

field metadata: Dict[str, Any]

field noncollaborator_can_label: Optional[bool]

field noncollaborator_can_review: Optional[bool]

field insights_urls: Optional[Dict[str, str]]

class Collaborator

field user: User

field role: Role

class User

field username: str

field created_at: str

field is_organization: bool

field email: Optional[str]

field webhooks_enabled: Optional[bool]

field private_upload_count: Optional[int]

field public_upload_count: Optional[int]

field subscription: Optional[Subscription]

field is_trial_expired: Optional[bool]

field organizations: Optional[List[User]]

field organization_created_by: Optional[str]

field organization_role: Optional[Role]

field members: Optional[List[User]]

field insights_urls: Optional[Dict[str, str]]

class TaskType(value)

An enumeration.

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'

TEXT_NAMED_ENTITIES = 'text-named-entities'

TEXT_SPAN_CATEGORIZATION = 'text-span-categorization'

EMPTY = ''

Samples

class Sample

field uuid: str

field name: str

field attributes: SampleAttributes

field metadata: Dict[str, Any]

field created_at: str

field created_by: str

field assigned_labeler: Optional[str]

field assigned_reviewer: Optional[str]

field comments: Optional[List[str]]

field priority: float

field label: Optional[Union[Label, LabelSummary]]

field issues: Optional[List[Issue]]

field dataset_full_name: Optional[str]

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 comments: List[IssueComment]

field status: IssueStatus

field sample_uuid: str

field sample_name: str

class IssueComment

field created_at: str

field created_by: str

field text: str

class IssueStatus(value)

An enumeration.

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: Optional[str]

Point cloud sample

class PointcloudSampleAttributes

field pcd: PCD

field images: Optional[List[CalibratedImage]]

field ego_pose: Optional[EgoPose]

field default_z: Optional[float]

field name: Optional[str]

field timestamp: Optional[Union[str, int]]

Point cloud sequence sample

class PointcloudSequenceSampleAttributes

field frames: List[PointcloudSampleAttributes]

Multi-sensor sample

class MultiSensorSampleAttributes

field sensors: List[Union[MultiSensorPointcloudSequenceSampleAttributes, MultiSensorImageSequenceSampleAttributes]]

class MultiSensorPointcloudSequenceSampleAttributes

field name: str

field task_type: Literal[TaskType.POINTCLOUD_CUBOID_SEQUENCE]

field attributes: PointcloudSequenceSampleAttributes

class MultiSensorImageSequenceSampleAttributes

field name: str

field task_type: Literal[TaskType.IMAGE_VECTOR_SEQUENCE]

field attributes: ImageSequenceSampleAttributes

Text sample

class TextSampleAttributes

field text: str

Labels

class Label

field sample_uuid: str

field label_type: TaskType

field label_status: LabelStatus

field labelset: str

field attributes: Optional[LabelAttributes]

field created_at: str

field created_by: str

field updated_at: str

field score: Optional[float]

field rating: Optional[float]

field reviewed_at: Optional[str]

field reviewed_by: Optional[str]

class LabelStatus(value)

An enumeration.

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: Optional[ImageAttributes]

field format_version: Optional[FormatVersion]

class Annotation

field id: int

field category_id: int

field attributes: Optional[ObjectAttributes]

Image vector label

class ImageVectorLabelAttributes

field annotations: List[ImageVectorAnnotation]

field format_version: Optional[FormatVersion]

field image_attributes: Optional[ImageAttributes]

class ImageVectorAnnotation

field id: int

field category_id: int

field points: List[List[float]]

field type: ImageVectorAnnotationType

field attributes: Optional[ObjectAttributes]

class ImageVectorAnnotationType(value)

An enumeration.

BBOX = 'bbox'

POLYGON = 'polygon'

POLYLINE = 'polyline'

POINT = 'point'

Image sequence vector label

class ImageSequenceVectorLabelAttributes

field frames: List[ImageVectorFrame]

field format_version: Optional[FormatVersion]

class ImageVectorFrame

Bases: ImageVectorLabelAttributes

field annotations: List[ImageSequenceVectorAnnotation]

field timestamp: Optional[Union[str, int]]

field format_version: Optional[FormatVersion]

field image_attributes: Optional[ImageAttributes]

class ImageSequenceVectorAnnotation

Bases: ImageVectorAnnotation

field track_id: int

field is_keyframe: bool

Point cloud segmentation label

class PointcloudSegmentationLabelAttributes

field annotations: List[Annotation]

field point_annotations: List[int]

field format_version: Optional[FormatVersion]

Point cloud cuboid label

class PointcloudCuboidLabelAttributes

field annotations: List[PointcloudCuboidAnnotation]

field format_version: Optional[FormatVersion]

class PointcloudCuboidAnnotation

field id: int

field category_id: int

field position: XYZ

field dimensions: XYZ

field yaw: float

field rotation: Optional[XYZW]

field type: PointcloudCuboidAnnotationType

field attributes: Optional[ObjectAttributes]

class PointcloudCuboidAnnotationType(value)

An enumeration.

CUBOID = 'cuboid'

CUBOID_SYNC = 'cuboid-sync'

Point cloud vector label

class PointcloudVectorLabelAttributes

field annotations: List[PointcloudVectorAnnotation]

field format_version: Optional[FormatVersion]

class PointcloudVectorAnnotation

field id: int

field category_id: int

field points: List[List[float]]

field type: PointcloudVectorAnnotationType

field attributes: Optional[ObjectAttributes]

class PointcloudVectorAnnotationType(value)

An enumeration.

POLYGON = 'polygon'

POLYLINE = 'polyline'

POINT = 'point'

Point cloud sequence segmentation

class PointcloudSequenceSegmentationLabelAttributes

field frames: List[PointcloudSegmentationFrame]

field format_version: Optional[FormatVersion]

class PointcloudSegmentationFrame

Bases: PointcloudSegmentationLabelAttributes

field annotations: List[PointcloudSequenceSegmentationAnnotation]

field point_annotations: List[int]

field timestamp: Optional[Union[str, int]]

field format_version: Optional[FormatVersion]

class PointcloudSequenceSegmentationAnnotation

Bases: Annotation

field track_id: int

field is_keyframe: bool

field attributes: Optional[ObjectAttributes]

Point cloud sequence cuboid label

class PointcloudSequenceCuboidLabelAttributes

field frames: List[PointcloudSequenceCuboidFrame]

field format_version: Optional[FormatVersion]

class PointcloudSequenceCuboidFrame

Bases: PointcloudCuboidLabelAttributes

field annotations: List[PointcloudSequenceCuboidAnnotation]

field timestamp: Optional[Union[str, int]]

field format_version: Optional[FormatVersion]

class PointcloudSequenceCuboidAnnotation

Bases: PointcloudCuboidAnnotation

field track_id: int

field is_keyframe: bool

Point cloud sequence vector label

class PointcloudSequenceVectorLabelAttributes

field frames: List[PointcloudSequenceVectorFrame]

field format_version: Optional[FormatVersion]

class PointcloudSequenceVectorFrame

Bases: PointcloudVectorLabelAttributes

field annotations: List[PointcloudSequenceVectorAnnotation]

field format_version: Optional[FormatVersion]

field timestamp: Optional[Union[str, int]]

class PointcloudSequenceVectorAnnotation

Bases: PointcloudVectorAnnotation

field track_id: int

field is_keyframe: bool

Multi-sensor label

class MultiSensorLabelAttributes

field sensors: List[Union[MultiSensorPointcloudSequenceCuboidLabelAttributes, MultiSensorImageSequenceVectorLabelAttributes]]

class MultiSensorPointcloudSequenceCuboidLabelAttributes

field name: str

field task_type: Literal[TaskType.POINTCLOUD_CUBOID_SEQUENCE]

field attributes: Union[PointcloudSequenceCuboidLabelAttributes, List]

class MultiSensorImageSequenceVectorLabelAttributes

field name: str

field task_type: Literal[TaskType.IMAGE_VECTOR_SEQUENCE]

field attributes: Union[ImageSequenceVectorLabelAttributes, List]

Text label

class TextLabelAttributes

field annotations: List[TextAnnotation]

field format_version: Optional[FormatVersion]

class TextAnnotation

field start: int

field end: int

field category_id: int

Labelsets

class Labelset

field name: str

field description: str

field is_groundtruth: Optional[bool]

field created_at: Optional[str]

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(value)

An enumeration.

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

Helper classes

class URL

field url: Optional[str]

class Owner

field username: str

field created_at: str

field email: Optional[str]

class TaskAttributes

field format_version: Optional[FormatVersion]

field categories: Optional[List[TaskAttributeCategory]]

field image_attributes: Optional[List[TaskAttribute]]

class TaskAttributeCategory

field name: str

field id: int

field color: Optional[Union[RGB, RGBA]]

field has_instances: Optional[bool]

field attributes: Optional[List[TaskAttribute]]

field dimensions: Optional[XYZ]

class SelectTaskAttribute(**data)

field name: str

field input_type: Literal[InputType.SELECT]

field values: List[str]

field default_value: Optional[str]

field is_mandatory: Optional[bool]

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': False, 'extra': 'ignore', 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'default_value': FieldInfo(annotation=Union[str, NoneType], required=False), 'input_type': FieldInfo(annotation=Literal[<InputType.SELECT: 'select'>], required=True), 'is_mandatory': FieldInfo(annotation=Union[bool, NoneType], required=False), 'name': FieldInfo(annotation=str, required=True), 'values': FieldInfo(annotation=List[str], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class TextTaskAttribute(**data)

field name: str

field input_type: Literal[InputType.TEXT]

field default_value: Optional[str]

field is_mandatory: Optional[bool]

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': False, 'extra': 'ignore', 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'default_value': FieldInfo(annotation=Union[str, NoneType], required=False), 'input_type': FieldInfo(annotation=Literal[<InputType.TEXT: 'text'>], required=False), 'is_mandatory': FieldInfo(annotation=Union[bool, NoneType], required=False), 'name': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class NumberTaskAttribute(**data)

field name: str

field input_type: Literal[InputType.NUMBER]

field default_value: Optional[float]

field min: Optional[float]

Validated by

• empty_str_to_none

field max: Optional[float]

Validated by

• empty_str_to_none

field step: Optional[float]

Validated by

• empty_str_to_none

field is_mandatory: Optional[bool]

validator empty_str_to_none  »  max, step, min

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': False, 'extra': 'ignore', 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'default_value': FieldInfo(annotation=Union[float, NoneType], required=False), 'input_type': FieldInfo(annotation=Literal[<InputType.NUMBER: 'number'>], required=True), 'is_mandatory': FieldInfo(annotation=Union[bool, NoneType], required=False), 'max': FieldInfo(annotation=Union[float, NoneType], required=False), 'min': FieldInfo(annotation=Union[float, NoneType], required=False), 'name': FieldInfo(annotation=str, required=True), 'step': FieldInfo(annotation=Union[float, NoneType], required=False)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class CheckboxTaskAttribute(**data)

field name: str

field input_type: Literal[InputType.CHECKBOX]

field default_value: Optional[bool]

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': False, 'extra': 'ignore', 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'default_value': FieldInfo(annotation=Union[bool, NoneType], required=False), 'input_type': FieldInfo(annotation=Literal[<InputType.CHECKBOX: 'checkbox'>], required=True), 'name': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class LabelStats

field REVIEWED: Optional[int]

field REVIEWING_IN_PROGRESS: Optional[int]

field LABELED: Optional[int]

field LABELING_IN_PROGRESS: Optional[int]

field REJECTED: Optional[int]

field PRELABELED: Optional[int]

field SKIPPED: Optional[int]

field VERIFIED: Optional[int]

field UNLABELED: Optional[int]

field TOTAL: Optional[int]

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: Optional[str]

field type: PCDType

class PCDType(value)

An enumeration.

PCD = 'pcd'

BINARY_XYZI = 'binary-xyzi'

KITTI = 'kitti'

BINARY_XYZIR = 'binary-xyzir'

NUSCENES = 'nuscenes'

PLY = 'ply'

class CalibratedImage

Bases: URL

field row: Optional[int]

field col: Optional[int]

field intrinsics: Optional[CameraIntrinsics]

field extrinsics: Optional[CameraExtrinsics]

field distortion: Optional[Distortion]

field camera_convention: CameraConvention

class CameraConvention(value)

An enumeration.

OPEN_CV = 'OpenCV'

OPEN_GL = 'OpenGL'

class CameraIntrinsics

field intrinsic_matrix: List[List[float]]

class CameraExtrinsics

field translation: XYZ

field rotation: XYZW

class Distortion

field model: CameraDistortionModel

field coefficients: Union[FisheyeDistortionCoefficients, BrownConradyDistortionCoefficients]

class CameraDistortionModel(value)

An enumeration.

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