Create video embeddings
The resources.EmbedTask
class provides methods to create embeddings for your videos.
To create video embeddings:
- Create a video embedding task that uploads and processes a video.
- Monitor the status of your task.
- Retrieve the embeddings once the task is completed.
Methods
Create a video embedding task
Description: This method creates a new video embedding task.
Video requirements
The videos you wish to upload must meet the following requirements:
- Video resolution: Must be at least 360x360 and must not exceed 3840x2160.
- Aspect ratio: Must be one of 1:1, 4:3, 4:5, 5:4, 16:9, 9:16, or 17:9.
- Video and audio formats: Your video files must be encoded in the video and audio formats listed on the FFmpeg Formats Documentation page. For videos in other formats, contact us at support@twelvelabs.io.
- Duration: Must be between 4 seconds and 2 hours (7,200s).
- File size: Must not exceed 2 GB. If you require different options, contact us at support@twelvelabs.io.
Function signature and example:
Parameters:
Return value: Returns a models.EmbeddingsTask
object representing the new video embedding task.
API Reference: For a description of each field in the request and response, see the Create a video embedding task page.
Related guide: Create video embeddings.
Retrieve the status of a video embedding task
Description: This method retrieves the status of a video embedding task.
Function signature and example:
Parameters:
Return value: Returns a models.EmbeddingsTaskStatus
object containing the current status of the embedding task.
API Reference: For a description of each field in the response, see the Retrieve the status of a video embedding task page.
Related guide: Create video embeddings.
Wait for a video embedding task to complete
Description: This method waits until a video embedding task is completed by periodically checking its status. If you provide a callback function, it calls the function after each status update with the current task object, allowing you to monitor progress.
Parameters
Return value: Returns a string representing the status of the task.
Retrieve video embeddings
Description: This method retrieves embeddings for a specific video embedding task. Ensure the task status is ready
before retrieving your embeddings.
Function signature and example:
Parameters:
Return value: Returns a models.EmbeddingsTask
object containing the details of the embedding task, including the embeddings if available. The video_embeddings
property of the returned object is a RootModelList
of VideoEmbedding
objects when the task is completed, or None
if the embeddings are not yet available.
API Reference: For a description of each field in the request and response, see the Retrieve video embeddings page.
Related guide: Create video embeddings.
Error codes
This section lists the most common error messages you may encounter while creating video embeddings.
parameter_invalid
- The
video_clip_length
parameter is invalid.video_clip_length
should be within 2-10 seconds long - The
video_end_offset_sec
parameter is invalid.video_end_offset_sec
should be greater thanvideo_start_offset_sec
- The