The TasksClient class provides methods to create embeddings for your videos.

To create video embeddings:

1. Create a video embedding task that uploads and processes a video.
2. Monitor the status of your task.
3. Retrieve the embeddings once the task is completed.

Related quickstart notebook

Methods

Create a video embedding task

Description: This method creates a new video embedding task that uploads a video to the platform.

Function signature and example:

1
def create(
2
    self,
3
    *,
4
    model_name: str,
5
    video_file: typing.Optional[core.File] = OMIT,
6
    video_url: typing.Optional[str] = OMIT,
7
    video_start_offset_sec: typing.Optional[float] = OMIT,
8
    video_end_offset_sec: typing.Optional[float] = OMIT,
9
    video_clip_length: typing.Optional[float] = OMIT,
10
    video_embedding_scope: typing.Optional[typing.List[TasksCreateRequestVideoEmbeddingScopeItem]] = OMIT,
11
    request_options: typing.Optional[RequestOptions] = None,
12
) -> TasksCreateResponse

Parameters:

Return value: Return value: Returns a TasksCreateResponse object representing the new video embedding task.

The TasksCreateResponse class contains the following properties:

API Reference: Create a video embedding task.

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:

1
def status(self, task_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> TasksStatusResponse

Parameters:

Return value: Returns a TasksStatusResponse object containing the current status of the embedding task.

The TasksStatusResponse class contains the following properties:

The TasksStatusResponseVideoEmbedding class contains the following properties:

The VideoEmbeddingMetadata class extends BaseEmbeddingMetadata and contains the following properties:

API Reference: Retrieve the status of a video embedding task.

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.

1
def wait_for_done(
2
    self,
3
    task_id: str,
4
    *,
5
    sleep_interval: float = 5.0,
6
    callback: typing.Optional[typing.Callable[[TasksStatusResponse], None]] = None,
7
    request_options: typing.Optional[RequestOptions] = None,
8
) -> TasksStatusResponse

Parameters

Return value: Returns a TasksStatusResponse object containing the status of your completed task. See the Retrieve the status of a video embedding task section above for complete property details.

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:

1
def retrieve(
2
    self,
3
    task_id: str,
4
    *,
5
    embedding_option: typing.Optional[
6
        typing.Union[
7
            TasksRetrieveRequestEmbeddingOptionItem, typing.Sequence[TasksRetrieveRequestEmbeddingOptionItem]
8
        ]
9
    ] = None,
10
    request_options: typing.Optional[RequestOptions] = None,
11
) -> TasksRetrieveResponse

Parameters:

Return value: Returns a TasksRetrieveResponse object containing your embeddings.

The TasksRetrieveResponse class contains the following properties:

The TasksRetrieveResponseVideoEmbedding class contains the following properties:

The VideoEmbeddingMetadata class extends BaseEmbeddingMetadata and contains the following properties:

The VideoSegment class extends AudioSegment and contains the following properties:

API Reference: Retrieve video embeddings.

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 than video_start_offset_sec