Developer guide for importing attachments and image overlay layers
Type | Value | Description |
---|---|---|
IMAGE | URL of Image (PNG/JPG) (HTTPS or IAM delegated access path) | Labelers can see the attached image files while labeling the primary data row |
VIDEO | URL of Video (MP4) (HTTPS or IAM delegated access path) | Labelers can see the attached video files while labeling the primary data row |
AUDIO | URL of Audio (MP3/WAV) (HTTPS or IAM delegated access path) | Labelers can see the attached audio files while labeling the primary data row |
RAW_TEXT | Text string or hyperlink (see below for cloud-hosted text files) | Labelers can see the attached text or hyperlink while labeling the primary data row. If passing a hyperlink, we will show a clickable hyperlink. If you want to display text from a URL endpoint, please use the TEXT_URL type. |
TEXT_URL | URL of a text file (HTTPS or IAM delegated access path) | Labelers can see the attached text from the linked text URL while labeling the primary data row |
HTML | URL of an HTML file (HTTPS or IAM delegated access path) | Renders HTML in an iframe as an attachment. Labelers can see and interact with the attached HTML widget while labeling the primary data row |
IMAGE_OVERLAY | URL of the image layer (PNG/JPG) (HTTPS or IAM delegated access path). | A visualization tool designed to help you view the asset to be labeled in different ways by adding image layers over the asset |
PDF_URL | URL of the PDF file (HTTPS or IAM delegated access path) | Labelers can see the attached document while labeling the primary data row |
#
,<
, >
and |
| are not supported in URLs and should be avoided in your file names to prevent loading issues.Please refer to https://datatracker.ietf.org/doc/html/rfc2396#section-2.4.3 on URI standards.A good test for the handling of special characters is to test URLs in your browser address bar — if the URL doesn’t load properly in your browser, it won’t load in Labelbox.DataRow
object. The required arguments for creating an attachment are the attachment_type
and attachment_value
. You can also name an attachment via the attribute attachment_name
.