ImageData Objects
~encord.orm.dataset.DataRow of type
:meth:DataType.IMG_GROUP <encord.constants.enums.DataType.IMG_GROUP>. Get this information
via the :meth:DataRow.images <encord.orm.dataset.DataRow.images> property.
file_type
file_size
signed_url
DataRow Objects
dict style member functions and the property accessors and setters is discouraged.
WARNING: Do NOT use the .data member of this class. Its usage could corrupt the correctness of the
datastructure.
uid
title
.DataRow.upload.
data_type
created_at
frames_per_second
DataType.VIDEO <encord.constants.enums.DataType.VIDEO> this returns the
actual number of frames per second for the video. Otherwise, it returns None as a frames_per_second
field is not applicable.
duration
DataType.VIDEO <encord.constants.enums.DataType.VIDEO> this returns the
actual duration for the video. Otherwise, it returns None as a duration field is not applicable.
client_metadata
~encord.orm.dataset.DataRow.refetch_data() function.
The setter updates the custom client metadata. This queues a request for the backend which will
be executed on a call of :meth:.DataRow.upload.
width
None for data types of
:meth:DataType.IMG_GROUP <encord.constants.enums.DataType.IMG_GROUP> where
:meth:is_image_sequence <encord.data.DataRow.is_image_sequence> is False, because
each image in this group can have a different dimension. Inspect the
:meth:images <encord.data.DataRow.images> to get the height of individual images.
height
None for data types of
:meth:DataType.IMG_GROUP <encord.constants.enums.DataType.IMG_GROUP> where
:meth:is_image_sequence <encord.data.DataRow.is_image_sequence> is False, because
each image in this group can have a different dimension. Inspect the
:meth:images <encord.data.DataRow.images> to get the height of individual images.
file_link
StorageLocation.CORD_STORAGE <encord.orm.dataset.StorageLocation.CORD_STORAGE> this will be the
internal file path. In private bucket storage location this will be the full path to the file.
If the data type is DataType.DICOM then this returns None as no single file is associated with the
series.
signed_url
~encord.orm.dataset.DataRow.refetch_data() function.
file_size
file_type
images_data
~encord.orm.dataset.ImageData objects for the given data asset.
Fetch the images with appropriate settings in the :meth:~encord.orm.dataset.DataRow.refetch_data() function.
If the data type is not :meth:DataType.IMG_GROUP <encord.constants.enums.DataType.IMG_GROUP>
then this returns None.
is_optimised_image_group
DataType.IMG_GROUP <encord.constants.enums.DataType.IMG_GROUP>,
returns whether this is a performance optimised image group. Returns None for other data types.
DEPRECATED: This method is deprecated and will be removed in the upcoming library version.
Please use :meth:.is_image_sequence instead
is_image_sequence
DataType.IMG_GROUP <encord.constants.enums.DataType.IMG_GROUP>,
returns whether this is an image sequence. Returns None for other data types.
For more details refer to the
:ref:documentation on image sequences <https://docs.encord.com/docs/annotate-supported-data#image-sequences>
backing_item_uuid
encord.storage.StorageItem that underlies this data row.
See also :meth:encord.user_client.EncordUserClient.get_storage_item.
refetch_data
signed_url- If True, this will fetch a generated signed url of the data asset.images_data_fetch_options- If not None, this will fetch the image data of the data asset. You can additionally specify what to fetch with the :class:.ImagesDataFetchOptionsclass.client_metadata- If True, this will fetch the client metadata of the data asset.
save
.DataRow object.
DataRows Objects
DatasetInfo Objects
Dataset Objects
__init__
encord.dataset.Dataset class instead.
This class has dict-style accessors for backwards compatibility.
Clients who are using this class for the first time are encouraged to use the property accessors and setters
instead of the underlying dictionary.
The mixed use of the dict style member functions and the property accessors and setters is discouraged.
WARNING: Do NOT use the .data member of this class. Its usage could corrupt the correctness of the
datastructure.
AddPrivateDataResponse Objects
CreateDatasetResponse Objects
__init__
dict style member functions and the property accessors and setters is discouraged.
WARNING: Do NOT use the .data member of this class. Its usage could corrupt the correctness of the
datastructure.
StorageLocation Objects
NEW_STORAGE
This is a placeholder for a new storage location that is not yet supported by your SDK version. Please update your SDK to the latest version.DatasetType
For backwards compatibilityDatasetData Objects
SignedVideoURL Objects
SignedImageURL Objects
SignedImagesURL Objects
SignedAudioURL Objects
SignedDicomURL Objects
SignedDicomsURL Objects
Video Objects
ImageGroup Objects
Image Objects
SingleImage Objects
Audio Objects
Images Objects
ReEncodeVideoTask Objects
DatasetAccessSettings Objects
fetch_client_metadata
Whether client metadata should be retrieved for eachdata_row.
ImagesDataFetchOptions Objects
fetch_signed_urls
Whether to fetch signed urls for each individual image. Only set this to true if you need to download the images.LongPollingStatus Objects
PENDING
Job will automatically start soon (waiting in queue) or already started processing.DONE
Job has finished successfully (possibly with errors ifignore_errors=True).
If ignore_errors=False was specified in :meth:encord.dataset.Dataset.add_private_data_to_dataset_start, the job will only have the status DONE` if there were no errors.
If ignore_errors=True was specified in :meth:encord.dataset.Dataset.add_private_data_to_dataset_start,
the job will always show the status DONE once complete and will never show ERROR
status if this flag was set to True. There could be errors that were ignored.
Information about number of errors and stringified exceptions is available in the
units_error_count: int and errors: List[str] attributes.
ERROR
Job has completed with errors. This can only happen ifignore_errors was set to False.
Information about errors is available in the units_error_count: int and errors: List[str] attributes.
CANCELLED
Job was cancelled explicitly by the user through the Encord UI or via the Encord SDK using theadd_data_to_folder_job_cancel method.
In the context of this status:
- The job may have been partially processed, but it was explicitly interrupted before completion by a user action.
- Cancellation can occur either manually through the Encord UI or programmatically using the SDK
method
add_data_to_folder_job_cancel. - Once a job is cancelled, no further processing will occur, and any processed data before the cancellation will be available.
- The presence of cancelled data units (
units_cancelled_count) indicates that some data upload units were interrupted and cancelled before completion. - If
ignore_errorswas set toTrue, the job may continue despite errors, and cancellation will only apply to the unprocessed units.
DataUnitError Objects
object_urls
URLs involved. A single item for videos and images; a list of frames for image groups and DICOMerror
The error messagesubtask_uuid
Opaque ID of the process. Please quote this when contacting Encord support.action_description
Human-readable description of the action that failed (e.g. āUploading DICOM seriesā).DatasetDataLongPolling Objects
status
Status of the upload job. Documented in detail in :meth:LongPollingStatus
data_hashes_with_titles
Information about data which was added to the dataset.errors
Stringified list of exceptions.data_unit_errors
Structured list of per-item upload errors. See :class:DataUnitError for more details.

