"site_location": "Algiers"
, "project_phase": "foundation"
, or "weather_conditions": "sunny"
. This enables more precise tracking and management of your data.
Before importing any files with custom metadata to Encord, we recommend that you import a metadata schema. Encord uses metadata schemas to validate custom metadata uploaded to Encord and to instruct Index and Active how to display your metadata.
video.description
, while team B could use audio.description
. Another example could be TeamName.MetadataKey
. This approach maintains clarity and avoids key collisions across departments.add_scalar
to add a scalar key to your metadata schema.
Scalar Key | Description | Display Benefits |
---|---|---|
boolean | Binary data type with values “true” or “false”. | Filtering by binary values |
datetime | ISO 8601 formatted date and time. | Filtering by time and date |
number | Numeric data type supporting float values. | Filtering by numeric values |
uuid | UUIDv4 formatted unique identifier for a data unit. | Filtering by customer specified unique identifier |
varchar | Textual data type. Formally string . string can be used as an alias for varchar , but we STRONGLY RECOMMEND that you use varchar . | Filtering by string. |
text | Text data with unlimited length (example: transcripts for audio). Formally long_string . long_string can be used as an alias for text , but we STRONGLY RECOMMEND that you use text . | Storing and filtering large amounts of text. |
add_enum
and add_enum_options
to add an enum and enum options to your metadata schema.
Key | Description | Display Benefits |
---|---|---|
enum | Enumerated type with predefined set of values. | Facilitates categorical filtering and data validation |
add_embedding
to add an embedding to your metadata schema.
Key | Description | Display Benefits |
---|---|---|
embedding | 1 to 4096 for Index. 1 to 2000 for Active. | Filtering by embeddings, similarity search, 2D scatter plot visualization (Coming Soon) |
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 |
Import cloud data
Import local data
General Example
Agent 1
and with a pathway called continue to Review
.<private_key_path>
with the path to your private key.<project_hash>
with the hash of your Project.Pre-Classification of Images Using GPT 4o
<private_key_path>
with the hash of your private key.<project_hash>
with the hash of your Project.Agent 1
with the name of your Agent stage.Pre-Labeling Videos Using a Mock Model
encord-agents
library using the following command:Annotate 1
). Below is an example of a Workflow where the Pre-Labeling agent can be effectively utilized.<project_hash>
with the hash of your Project.prelabel_video.py
with your new file name.Video tutorial - Creating workflow templates
Invite individuals
Invite user groups
Video tutorial - Introduction to image annotation
Video tutorial - Introduction to video annotation