The IndexesClient.VideosClient class provides methods to manage the videos you’ve uploaded to the platform.

Methods

Retrieve video information

Description: This method retrieves information about the specified video.

Function signature and example:

1
def retrieve(
2
    self,
3
    index_id: str,
4
    video_id: str,
5
    *,
6
    embedding_option: Optional[Union[VideosRetrieveRequestEmbeddingOptionItem, Sequence[VideosRetrieveRequestEmbeddingOptionItem]]] = None,
7
    transcription: Optional[bool] = None,
8
    request_options: Optional[RequestOptions] = None,
9
) -> VideosRetrieveResponse

Parameters

Return value

Returns a VideosRetrieveResponse object representing the retrieved video.

The VideosRetrieveResponse class contains the following properties:

The VideosRetrieveResponseSystemMetadata class contains the following properties:

The VideosRetrieveResponseEmbedding class contains the following properties:

The VideosRetrieveResponseEmbeddingVideoEmbedding class contains the following properties:

The TranscriptionDataItem class contains the following properties:

API Reference

Retrieve video information.

List videos

Description: This method returns a list of the videos in the specified index. By default, the platform returns your videos sorted by creation date, with the newest at the top of the list.

Function signature and example:

1
def list(
2
    self,
3
    index_id: str,
4
    *,
5
    page: Optional[int] = None,
6
    page_limit: Optional[int] = None,
7
    sort_by: Optional[str] = None,
8
    sort_option: Optional[str] = None,
9
    filename: Optional[str] = None,
10
    duration: Optional[float] = None,
11
    fps: Optional[float] = None,
12
    width: Optional[float] = None,
13
    height: Optional[int] = None,
14
    size: Optional[float] = None,
15
    created_at: Optional[str] = None,
16
    updated_at: Optional[str] = None,
17
    user_metadata: Optional[Dict[str, Optional[VideosListRequestUserMetadataValue]]] = None,
18
    request_options: Optional[RequestOptions] = None,
19
) -> SyncPager[VideoVector]

Parameters

Return value

Returns a SyncPager[VideoVector] object that allows you to iterate through the paginated list of videos in the specified index.

The SyncPager[T] class contains the following properties and methods:

The VideoVector class contains the following properties:

The VideoVectorSystemMetadata class contains the following properties:

API Reference

List videos page.

Update video information

Description: This method updates the title and metadata of a video.

Function signature and example:

1
def update(
2
    self,
3
    index_id: str,
4
    video_id: str,
5
    *,
6
    user_metadata: Optional[Dict[str, Optional[Any]]] = OMIT,
7
    request_options: Optional[RequestOptions] = None,
8
) -> None

Parameters

Return value

None. The method doesn’t return any value.

API Reference

Update video information.

Delete video information

Description: This method deletes all the information about the specified video. This action cannot be undone.

Function signature and example:

1
def delete(
2
    self,
3
    index_id: str,
4
    video_id: str,
5
    *,
6
    request_options: Optional[RequestOptions] = None
7
) -> None

Parameters

Return value

None. The method doesn’t return any value.

API Reference

Delete video information.