StorageLocationName Objects
OPEN_TELEKOM
TODO: Remove when enough people have updated their sdk to include S3_COMPATIBLE belowStorageItem Objects
is_tombstone
This item has been deleted but the link is retained for consistency reasons. Mostly for items in the ‘cloud linked folders’ that are referenced but aren’t present after a re-syncis_placeholder
This item has been added to the folder but isn’t fully processed yetCloudSyncedFolderParams Objects
integration_uuid
UUID of the cloud storage integration to use. This UUID refers to a preconfigured integration in Encord that contains authentication credentials and settings for a cloud storage provider. The integration must be set up in the Encord platform before creating a cloud-synced folder.remote_url
URL or path to the cloud storage location to sync with. The format depends on the cloud storage provider:- Amazon S3: “s3://bucket-name/path/”
- Google Cloud Storage: “gs://bucket-name/path/”
- Azure Blob Storage: “https://account.blob.core.windows.net/container/path/”
- S3-compatible services: “https://endpoint/bucket-name/path/”
UploadLongPollingState Objects
status
Status of the upload job. Documented in detail in :meth:encord.orm.dataset.LongPollingStatus
items_with_names
Information about data which was added to the folder.errors
Stringified list of exceptions.units_pending_count
Number of upload job units that have pending status.units_done_count
Number of upload job units that have done status.units_error_count
Number of upload job units that have error status.units_cancelled_count
Number of upload job units that have been cancelled.unit_errors
Structured list of per-item upload errors. See :class:DataUnitError for more details.
file_name
Name of the JSON or CSV file that contained the list of URLs to ingest form the cloud bucket. Optional.CustomerProvidedImageMetadata Objects
mime_type
MIME type of the image file (e.g.image/jpeg or image/png).
file_size
Size of the image file in bytes.height
Height of the image in pixels.width
Width of the image in pixels.CustomerProvidedVideoMetadata Objects
fps
Frame rate of the video in frames per second.duration
Video duration in (float) seconds.width
Width of the video in pixels.height
Height of the video in pixels.file_size
Size of the video file in bytes.mime_type
MIME type of the video file (e.g.video/mp4 or video/webm).
CustomerProvidedAudioMetadata Objects
duration
Audio duration in (float) seconds.file_size
Size of the audio file in bytes.mime_type
MIME type of the audio file (for example:audio/mpeg or audio/wav).
sample_rate
Sample rate (int) in Hz.bit_depth
Size of each sample (int) in bits.codec
Codec (for example: mp3, pcm).num_channels
Number of channelsCustomerProvidedTextMetadata Objects
file_size
Size of the text file in bytes.mime_type
MIME type of the text file (for example:application/json or text/plain…).
CustomerProvidedPdfMetadata Objects
file_size
Size of the PDF file in bytes.num_pages
Number of pages in the PDF file.CustomerProvidedDicomSeriesDicomFileMetadata Objects
tags dictionary must contain all required DICOM tags as keys, though their corresponding values may be None.
Tags should be provided in the format returned by pydicom to_json_dict() method.
Required tags (using standard DICOM tag numbers):
- 00080018: SOPInstanceUID
- 00100020: PatientID
- 00180050: SliceThickness
- 00181114: EstimatedRadiographicMagnificationFactor
- 00181164: ImagerPixelSpacing
- 0020000D: StudyInstanceUID
- 0020000E: SeriesInstanceUID
- 00200013: InstanceNumber
- 00200032: ImagePositionPatient
- 00200037: ImageOrientationPatient
- 00209113: PlanePositionSequence
- 00209116: PlaneOrientationSequence
- 00280004: PhotometricInterpretation
- 00280008: NumberOfFrames
- 00280010: Rows
- 00280011: Columns
- 00280030: PixelSpacing
- 00281050: WindowCenter
- 00281051: WindowWidth
- 00289110: PixelMeasuresSequence
- 52009229: SharedFunctionalGroupsSequence
- 52009230: PerFrameFunctionalGroupsSequence
tags dictionary key will raise a validation error.
DataUploadImage Objects
object_url
“URL of the image file to be registered.title
Title of the image item (derived from the URL if omitted).client_metadata
Custom metadata to be associated with the image item.external_file_type
Type of the external file.image_metadata
Optional media metadata of the image file (if provided). See :class:CustomerProvidedImageMetadata for more details.
placeholder_item_uuid
For system use only.DataUploadVideo Objects
object_url
URL of the video file to be registered.title
Title of the video item (derived from the URL if omitted).client_metadata
Custom metadata to be associated with the video item.external_file_type
Type of the external file.video_metadata
Optional media metadata of the video file (if provided). See :class:CustomerProvidedVideoMetadata for more details.
placeholder_item_uuid
For system use only.DataUploadNifti Objects
object_url
URL of the NIFTI file to be registered.title
Title of the NIFTI item (derived from the URL if omitted).client_metadata
Custom metadata to be associated with the NIFTI item.external_file_type
Type of the external file.placeholder_item_uuid
For system use only.DataUploadImageGroupImage Objects
url
URL of the image file to be used as the frame in the image group.title
Title of the image item (derived from the URL if omitted).image_metadata
Optional media metadata of the image file (if provided). See :class:CustomerProvidedImageMetadata for more details.
placeholder_item_uuid
For system use only.DataUploadImageGroup Objects
images
List of images to be used as frames in the image group. See :class:DataUploadImageGroupImage for more details.
title
Title of the image group item (requred if using cloud integration).client_metadata
Custom metadata to be associated with the image group item.create_video
If set toTrue, create an image sequence backed by a video file uploaded to the cloud storage.
external_file_type
Type of the external file.cluster_by_resolution
For system use only.DataUploadImageGroupFromItems Objects
image_items
List of image items to be used as frames in the image group.title
Title of the image group item (required if using cloud integration).client_metadata
Custom metadata to be associated with the image group.create_video
If set toTrue, create an image sequence backed by a video file uploaded to the cloud storage.
video_url_prefix
URL prefix for the video file to be created from the image group.external_file_type
Type of the external file.cluster_by_resolution
For system use only.DataUploadDicomSeriesDicomFile Objects
url
URL of the DICOM file to be registered with Encord service.title
Title of the DICOM file (derived from the URL if omitted).dicom_metadata
Optional media metadata of the DICOM file (if provided). See :class:CustomerProvidedDicomSeriesDicomFileMetadata for more details.
placeholder_item_uuid
For system use only.DataUploadDicomSeries Objects
dicom_files
List of DICOM files to be used in the series item. See :class:DataUploadDicomSeriesDicomFile for more details.
title
Title of the DICOM series item (required if using cloud integration).client_metadata
Custom metadata to be associated with the DICOM series item.external_file_type
Type of the external file.DataUploadText Objects
object_url
URL of the text (TXT, HTML, etc) file to be registered with Encord service.title
Title of the file (derived from the URL if omitted).client_metadata
Custom metadata to be associated with the file.external_file_type
Type of the external file.text_metadata
Optional media metadata of the text file. See :class:CustomerProvidedTextMetadata for more details.
placeholder_item_uuid
For system use only.DataUploadPDF Objects
object_url
URL of the PDF file to be registered with Encord service.title
Title of the file (derived from the URL if omitted).client_metadata
Custom metadata to be associated with the file.pdf_metadata
Optional media metadata of the PDF file. See :class:CustomerProvidedPdfMetadata for more details.
external_file_type
Type of the external file.placeholder_item_uuid
For system use only.DataUploadAudio Objects
object_url
URL of the audio file to be registered.title
Title of the audio item (derived from the URL if omitted).client_metadata
Custom metadata to be associated with the audio item.audio_metadata
Optional media metadata of the audio file (if provided). See :class:CustomerProvidedAudioMetadata for more details.
external_file_type
Type of the external file.placeholder_item_uuid
For system use only.DataUploadItems Objects
videos
List of video items to be registered. See :class:DataUploadVideo for more details.
image_groups
List of image group items to be registered. See :class:DataUploadImageGroup for more details.
dicom_series
List of DICOM series items to be registered. See :class:DataUploadDicomSeries for more details.
images
List of image items to be registered. See :class:DataUploadImage for more details.
image_groups_from_items
List of image group items to be created from previously uploaded images. See :class:DataUploadImageGroupFromItems for more details.
audio
List of audio items to be registered. See :class:DataUploadAudio for more details.
nifti
List of NIFTI items to be registered. See :class:DataUploadNifti for more details.
text
List of text items to be registered. See :class:DataUploadText for more details.
DataUploadPDF for more details.
skip_duplicate_urls
If set toTrue, Encord service will skip items with URLs that already exist in the same folder.
Otherwise, duplicate items will be created.
upsert_metadata
If set toTrue, Encord service will update metadata of existing items with the same URL in the same folder.
This flag has no effect if skip_duplicate_urls is set to False.
StorageItemSummary Objects
frame_in_groups
A number of group items (DICOM_SERIES, IMAGE_GROUP, IMAGE_SEQUENCE) that contain this itemaccessible_group_items
List of group items that contain this item (only those that the user has access to, so the length of this list can be less thanframe_in_groups)
used_in_datasets
A number of datasets that contain this item as aDataRow
accessible_datasets
List of datasets that contain this item as aDataRow (only those that the user has access to, so
the length of this list can be less than used_in_datasets)
SyncPrivateDataWithCloudSyncedFolderStatus Objects
PENDING
The synchronization job is currently in progress. This status indicates that either:- The job is queued and waiting to be processed
- The job is actively processing bucket content
- The job is creating or updating items in the Encord storage folder
DONE
The synchronization job has successfully completed. This status indicates that all phases of the synchronization (bucket scanning, item creation/updating/tombstoning) have been completed without critical errors. Note that individual items may still have failed to process (check upload_jobs_units_error).ERROR
The synchronization job encountered a critical error. This status indicates that a severe error occurred during synchronization, such as:- Unable to access the cloud storage bucket
- Database transaction failures
- Other system-level errors