clientMetadata
) to specify key frames, custom metadata, and custom embeddings. For more information go here or here for information on using the SDK.JSON Format
skip_duplicate_urls
is set to true
, all object URLs that exactly match existing images/videos in the dataset are skipped.JSON for AWS
Audio files
audiometadata
flag. When the audiometadata
flag is present in the JSON file, we directly use the supplied metadata without performing any additional validation, and do not store the file on our servers. To guarantee accurate labels, it is crucial that the metadata you provide is accurate.Text Files
Single images
Image groups
skip_duplicate_urls
is set to true
, all URLs exactly matching existing image groups in the dataset are skipped.objectUrl_{position_number}
).Image sequences
image_groups
array with the createVideo
flag set to true
represents a single image sequence.skip_duplicate_urls
is set to true
, all URLs exactly matching existing image sequences in the dataset are skipped.createVideo
flag to be set to true
. Both use the key image_groups
.objectUrl_{position_number}
).DICOM
dicom_series
element can contain one or more DICOM series.skip_duplicate_urls
is set to true
, all object URLs exactly matching existing DICOM files in the dataset will be skipped..dcm
file and does not have to be specific during the upload to Encord. DicomSeries
file is created. This file represents the series file-set. Only DicomSeries
are displayed in the Encord application.Multiple file types
JSON for GCP
Audio files
audiometadata
flag. When the audiometadata
flag is present in the JSON file, we directly use the supplied metadata without performing any additional validation, and do not store the file on our servers. To guarantee accurate labels, it is crucial that the metadata you provide is accurate.Text Files
Single images
Image groups
skip_duplicate_urls
is set to true
, all URLs exactly matching existing image groups in the dataset are skipped.objectUrl_{position_number}
).Image sequences
image_groups
array with the createVideo
flag set to true
represents a single image sequence.skip_duplicate_urls
is set to true
, all URLs exactly matching existing image sequences in the dataset are skipped.createVideo
flag to be set to true
. Both use the key image_groups
.objectUrl_{position_number}
).DICOM
dicom_series
element can contain one or more DICOM series.skip_duplicate_urls
is set to true
, all object URLs exactly matching existing DICOM files in the dataset will be skipped..dcm
file and does not have to be specific during the upload to Encord. DicomSeries
file is created. This file represents the series file-set. Only DicomSeries
are displayed in the Encord application.Multiple file types
JSON for Azure
Audio files
audiometadata
flag. When the audiometadata
flag is present in the JSON file, we directly use the supplied metadata without performing any additional validation, and do not store the file on our servers. To guarantee accurate labels, it is crucial that the metadata you provide is accurate.Text Files
Single images
Image groups
skip_duplicate_urls
is set to true
, all URLs exactly matching existing image groups in the dataset are skipped.objectUrl_{position_number}
).Image sequences
image_groups
array with the createVideo
flag set to true
represents a single image sequence.skip_duplicate_urls
is set to true
, all URLs exactly matching existing image sequences in the dataset are skipped.createVideo
flag to be set to true
. Both use the key image_groups
.objectUrl_{position_number}
).DICOM
dicom_series
element can contain one or more DICOM series.skip_duplicate_urls
is set to true
, all object URLs exactly matching existing DICOM files in the dataset will be skipped..dcm
file and does not have to be specific during the upload to Encord. DicomSeries
file is created. This file represents the series file-set. Only DicomSeries
are displayed in the Encord application.Multiple file types
JSON for OTC
Audio files
audiometadata
flag. When the audiometadata
flag is present in the JSON file, we directly use the supplied metadata without performing any additional validation, and do not store the file on our servers. To guarantee accurate labels, it is crucial that the metadata you provide is accurate.Text Files
Single images
Image groups
skip_duplicate_urls
is set to true
, all URLs exactly matching existing image groups in the dataset are skipped.objectUrl_{position_number}
).Image sequences
image_groups
array with the createVideo
flag set to true
represents a single image sequence.skip_duplicate_urls
is set to true
, all URLs exactly matching existing image sequences in the dataset are skipped.createVideo
flag to be set to true
. Both use the key image_groups
.objectUrl_{position_number}
).DICOM
dicom_series
element can contain one or more DICOM series.skip_duplicate_urls
is set to true
, all object URLs exactly matching existing DICOM files in the dataset will be skipped..dcm
file and does not have to be specific during the upload to Encord. DicomSeries
file is created. This file represents the series file-set. Only DicomSeries
are displayed in the Encord application.Multiple file types
JSON for AWS Multi-Region Access Point
CSV Format
ObjectUrl
column is interpreted as a request for video upload. If your objects are of a different type (for example, images), this error displays: “Expected a video, got a file of type XXX”.Videos
objectUrl
. This field is mandatory for each file, as it specifies the full URL of the video resource.
video_title
. If left blank, the original file name is used.
ObjectUrl | Video title |
---|---|
path/to/storage-location/frame1.mp4 | Video 1 |
path/to/storage-location/frame2.mp4 | Video 2 |
path/to/storage-location/frame3.mp4 | |
path/to/storage-location/frame4.mp4 | Video 3 |
Single images
objectUrl
. This field is mandatory for each file, as it specifies the full URL of the image resource.
image_title
. If left blank, the original file name is used.
ObjectUrl | Image title |
---|---|
path/to/storage-location/frame1.jpg | Image 1 |
path/to/storage-location/frame2.jpg | Image 2 |
path/to/storage-location/frame3.jpg | |
path/to/storage-location/frame4.jpg | Image 3 |
Image groups
objectUrl
. This field is mandatory for each file, as it specifies the full URL of the resource.
image_group_title
. This field is mandatory, as it determines which image group a file will be assigned to.
ObjectUrl | Image group title | Create video |
---|---|---|
path/to/storage-location/frame1.jpg | Group 1 | false |
path/to/storage-location/frame2.jpg | Group 1 | false |
path/to/storage-location/frame3.jpg | Group 2 | false |
path/to/storage-location/frame4.jpg | Group 2 | false |
Image sequences
objectUrl
. This field is mandatory for each file, as it specifies the full URL of the resource.
image_group_title
. This field is mandatory, as it determines which image sequence a file will be assigned to. The dimensions of the image sequence are determined by the first file in the sequence.
ObjectUrl | Image group title | Create video |
---|---|---|
path/to/storage-location/frame1.jpg | Sequence 1 | true |
path/to/storage-location/frame2.jpg | Sequence 1 | true |
path/to/storage-location/frame3.jpg | Sequence 2 | true |
path/to/storage-location/frame4.jpg | Sequence 2 | true |
DICOM
objectUrl
. This field is mandatory for each file, as it specifies the full URL of the resource.
dicom_title
. When two files are given the same title they are grouped into the same DICOM series. If left blank, the original file name is used.
ObjectUrl | Series title |
---|---|
path/to/storage-location/frame1.dcm | dicom series 1 |
path/to/storage-location/frame2.dcm | dicom series 1 |
path/to/storage-location/frame3.dcm | dicom series 2 |
path/to/storage-location/frame4.dcm | dicom series 2 |
path/to/storage-location/frame5.dcm | dicom series 3 |
Multiple file types
true
all files that are not image sequences must contain the value false
ObjectUrl | Image group title | Create video |
---|---|---|
path/to/storage-location/frame1.jpg | Sequence 1 | true |
path/to/storage-location/frame2.jpg | Sequence 1 | true |
path/to/storage-location/frame3.jpg | Sequence 2 | true |
path/to/storage-location/frame4.jpg | Sequence 2 | true |
path/to/storage-location/frame5.jpg | Group 1 | false |
path/to/storage-location/frame6.jpg | Group 1 | false |
ObjectUrl | Image title | Create video |
path/to/storage-location/frame1.jpg | Image 1 | false |
ObjectUrl | Image title | Create video |
full/storage/path/video.mp4 | Video 1 | false |
Register Cloud Data
Import Local Data
File Quality Metrics
Criteria | Description |
---|---|
File Size | Filters files (video) based on their size in bytes. |
Random Value | Filters files (video) based on a random value assigned as the file is added to Index. |
Video Quality Metrics
Criteria | Description |
---|---|
Area | Filters videos based on the area of the frame. |
Aspect Ratio | Filters videos based on the aspect ratio of the video. |
Clip Duration | Filters videos based on the duration of the video by hundredths of seconds. |
Frame per Second | Filters videos based on the frames per second of the video. |
Height | Filters videos based on the height of the video frame. |
No. of Video Frames | Filters videos based on the number of frames in the video. |
Random Value | Filters videos based on a random value assigned as the file is added to Index. |
Width | Filters videos based on the width of the video. |
Frame Quality Metrics
Criteria | Description |
---|---|
Area | Filters images/video frames based on the area of the frame. |
Aspect Ratio | Filters images/video frames based on the aspect ratio of the video. |
Frame Number | Filters images/video frames based on the height of the video frame. |
Height | Filters images/video frames based on the height of the video frame. |
Random Value | Filters images/video frames based on a random value assigned as the file is added to Index. |
Width | Filters images/video frames based on the width of the video. |
Audio Quality Metrics
Criteria | Description |
---|---|
Bit Depth | Filters audio files based on the size of each sample (int) in bits. |
Duration | Filters audio files based on the duration of the audio file by hundredths of seconds. |
Number of Channels | Filters audio files based on number of audio channels in the audio file. |
Random Value | Filters audio files based on a random value assigned as the file is added to Index. |
Samples per Second | Filters audio files based on the number of samples per second. |
Custom Metadata, Custom Embeddings, Key Frames
Criteria | Description |
---|---|
Custom Metadata | Filters files by any custom metadata available on your data. For more information about custom metadata with Index, refer to our documentation |
Custom Embeddings | Filters files by any custom embeddings available on your data. For more information about custom embeddings with Index, refer to our documentation |
Key Frames | VIDEO ONLY Filters files by any key frames specified on frames in your video data. Specifying key frames on videos significantly speeds up importing videos in to Index. Index imports videos at 1 FPS by default. |
Other Filtering Criteria
Criteria | Description |
---|---|
Collection | Filters files by the Collection the files belong to. |
Data Title | Filters files their file name. |
Data Type | Filters files their file type: Video, Audio, Image, Image Group, Image Sequence, DICOM Series |
File ID | Filters files their unique file ID. |
Folder | Filters files by the Folders that contain the files. |
Integration | Filters files by the Integrations that contain the files. |
Mime | Filters files the file’s Mime type. |
Storage Location | Filters files by the storage location that contains the files. |
Uploaded At | Filters files the time and date of their upload. |