supervisely 6.73.398__py3-none-any.whl → 6.73.400__py3-none-any.whl

supervisely/api/image_api.py

@@ -17,7 +17,7 @@ from collections import defaultdict
 from concurrent.futures import ThreadPoolExecutor
 from contextlib import contextmanager
 from dataclasses import dataclass
-from datetime import datetime
+from datetime import datetime, timezone
 from functools import partial
 from math import ceil
 from pathlib import Path
@@ -57,6 +57,10 @@ from supervisely.annotation.tag import Tag
 from supervisely.annotation.tag_meta import TagApplicableTo, TagMeta, TagValueType
 from supervisely.api.constants import DOWNLOAD_BATCH_SIZE
 from supervisely.api.dataset_api import DatasetInfo
+from supervisely.api.entities_collection_api import (
+    AiSearchThresholdDirection,
+    CollectionTypeFilter,
+)
 from supervisely.api.entity_annotation.figure_api import FigureApi
 from supervisely.api.entity_annotation.tag_api import TagApi
 from supervisely.api.file_api import FileInfo
@@ -379,6 +383,15 @@ class ImageInfo(NamedTuple):
     #: :class:`int`: Bytes offset of the blob file that points to the end of the image data.
     offset_end: Optional[int] = None
 
+    #: :class:`dict`: Image meta that could have the confidence level of the image in Enntities Collection of type AI Search.
+    ai_search_meta: Optional[dict] = None
+
+    #: :class:`str`: Timestamp of the last update of the embeddings for the image.
+    #: This field is used to track when the embeddings were last updated.
+    #: It is set to None if the embeddings have never been computed for the image.
+    #: Format: "YYYY-MM-DDTHH:MM:SS.sssZ"
+    embeddings_updated_at: Optional[str] = None
+
     # DO NOT DELETE THIS COMMENT
     #! New fields must be added with default values to keep backward compatibility.
 
@@ -456,6 +469,8 @@ class ImageApi(RemoveableBulkModuleApi):
             ApiField.DOWNLOAD_ID,
             ApiField.OFFSET_START,
             ApiField.OFFSET_END,
+            ApiField.AI_SEARCH_META,
+            ApiField.EMBEDDINGS_UPDATED_AT,
         ]
 
     @staticmethod
@@ -602,6 +617,10 @@ class ImageApi(RemoveableBulkModuleApi):
         fields: Optional[List[str]] = None,
         recursive: Optional[bool] = False,
         entities_collection_id: Optional[int] = None,
+        ai_search_collection_id: Optional[int] = None,
+        ai_search_threshold: Optional[float] = None,
+        ai_search_threshold_direction: AiSearchThresholdDirection = AiSearchThresholdDirection.ABOVE,
+        extra_fields: Optional[List[str]] = None,
     ) -> List[ImageInfo]:
         """
         List of Images in the given :class:`Dataset<supervisely.project.project.Dataset>`.
@@ -628,8 +647,16 @@ class ImageApi(RemoveableBulkModuleApi):
         :type fields: List[str], optional
         :param recursive: If True, returns all images from dataset recursively (including images in nested datasets).
         :type recursive: bool, optional
-        :param entities_collection_id: :class:`EntitiesCollection<supervisely.api.entities_collection_api.EntitiesCollectionApi>` ID to which the images belong. Can be used to filter images by specific entities collection.
+        :param entities_collection_id: :class:`EntitiesCollection` ID of `Default` type to which the images belong.
         :type entities_collection_id: int, optional
+        :param ai_search_collection_id: :class:`EntitiesCollection` ID of type `AI Search` to which the images belong.
+        :type ai_search_collection_id: int, optional
+        :param ai_search_threshold: Confidence level to filter images in AI Search collection.
+        :type ai_search_threshold: float, optional
+        :param ai_search_threshold_direction: Direction of the confidence level filter. One of {'above' (default), 'below'}.
+        :type ai_search_threshold_direction: str, optional
+        :param extra_fields: List of extra fields to return. If None, returns no extra fields.
+        :type extra_fields: List[str], optional
         :return: Objects with image information from Supervisely.
         :rtype: :class:`List[ImageInfo]<ImageInfo>`
         :Usage example:
@@ -703,20 +730,44 @@ class ImageApi(RemoveableBulkModuleApi):
                     },
                 }
             ]
-        if entities_collection_id is not None:
+        # Handle collection filtering
+        collection_info = None
+        if entities_collection_id is not None and ai_search_collection_id is not None:
+            raise ValueError(
+                "You can use only one of entities_collection_id or ai_search_collection_id"
+            )
+        elif entities_collection_id is not None:
+            collection_info = (CollectionTypeFilter.DEFAULT, entities_collection_id)
+        elif ai_search_collection_id is not None:
+            collection_info = (CollectionTypeFilter.AI_SEARCH, ai_search_collection_id)
+
+        if collection_info is not None:
+            collection_type, collection_id = collection_info
             if ApiField.FILTERS not in data:
                 data[ApiField.FILTERS] = []
+
+            collection_filter_data = {
+                ApiField.COLLECTION_ID: collection_id,
+                ApiField.INCLUDE: True,
+            }
+            if ai_search_threshold is not None:
+                if collection_type != CollectionTypeFilter.AI_SEARCH:
+                    raise ValueError(
+                        "ai_search_threshold is only available for AI Search collection"
+                    )
+                collection_filter_data[ApiField.THRESHOLD] = ai_search_threshold
+                collection_filter_data[ApiField.THRESHOLD_DIRECTION] = ai_search_threshold_direction
             data[ApiField.FILTERS].append(
                 {
-                    "type": "entities_collection",
-                    "data": {
-                        ApiField.COLLECTION_ID: entities_collection_id,
-                        ApiField.INCLUDE: True,
-                    },
+                    ApiField.TYPE: collection_type,
+                    ApiField.DATA: collection_filter_data,
                 }
             )
+
         if fields is not None:
             data[ApiField.FIELDS] = fields
+        if extra_fields is not None:
+            data[ApiField.EXTRA_FIELDS] = extra_fields
         return self.get_list_all_pages(
             "images.list",
             data=data,
@@ -3679,9 +3730,7 @@ class ImageApi(RemoveableBulkModuleApi):
 
         return self.tag.add_to_entities_json(project_id, data, batch_size, log_progress)
 
-    def update_tag_value(
-        self, tag_id: int, value: Union[str, float]
-    ) -> Dict:
+    def update_tag_value(self, tag_id: int, value: Union[str, float]) -> Dict:
         """
         Update tag value with given ID.
 
@@ -4412,11 +4461,14 @@ class ImageApi(RemoveableBulkModuleApi):
 
     def set_remote(self, images: List[int], links: List[str]):
         """
-        This method helps to change local source to remote for images without re-uploading them as new.
+        Updates the source of existing images by setting new remote links.
+        This method is used when an image was initially uploaded as a file or added via a link,
+        but later it was decided to change its location (e.g., moved to another storage or re-uploaded elsewhere).
+        By updating the link, the image source can be redirected to the new location.
 
         :param images: List of image ids.
         :type images: List[int]
-        :param links: List of remote links.
+        :param links: List of new remote links.
         :type links: List[str]
         :return: json-encoded content of a response.
 
@@ -4424,17 +4476,17 @@ class ImageApi(RemoveableBulkModuleApi):
 
             .. code-block:: python
 
-                    import supervisely as sly
+                import supervisely as sly
 
-                    api = sly.Api.from_env()
+                api = sly.Api.from_env()
 
-                    images = [123, 124, 125]
-                    links = [
-                        "s3://bucket/lemons/ds1/img/IMG_444.jpeg",
-                        "s3://bucket/lemons/ds1/img/IMG_445.jpeg",
-                        "s3://bucket/lemons/ds1/img/IMG_446.jpeg",
-                    ]
-                    result = api.image.set_remote(images, links)
+                images = [123, 124, 125]
+                links = [
+                    "s3://bucket/lemons/ds1/img/IMG_444.jpeg",
+                    "s3://bucket/lemons/ds1/img/IMG_445.jpeg",
+                    "s3://bucket/lemons/ds1/img/IMG_446.jpeg",
+                ]
+                result = api.image.set_remote(images, links)
         """
 
         if len(images) == 0:
@@ -5412,3 +5464,47 @@ class ImageApi(RemoveableBulkModuleApi):
             )
             tasks.append(task)
         await asyncio.gather(*tasks)
+
+    def set_embeddings_updated_at(self, ids: List[int], timestamps: Optional[List[str]] = None):
+        """
+        Updates the `updated_at` field of images with the timestamp of the embeddings were created.
+
+        :param ids: List of Image IDs in Supervisely.
+        :type ids: List[int]
+        :param timestamps: List of timestamps in ISO format. If None, uses current time.
+                            You could set timestamps to [None, ..., None] if you need to recreate embeddings for images.
+        :type timestamps: List[str], optional
+        :return: None
+        :rtype: NoneType
+        :Usage example:
+
+         .. code-block:: python
+
+            import supervisely as sly
+            import datetime
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            image_ids = [123, 456, 789]
+            timestamps = [datetime.datetime.now().isoformat() for _ in image_ids]
+            api.image.set_embeddings_updated_at(image_ids, timestamps)
+        """
+        method = "images.embeddings-updated-at.update"
+
+        if timestamps is None:
+            timestamps = [datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ") for _ in ids]
+
+        if len(ids) != len(timestamps):
+            raise ValueError(
+                f"Length of ids and timestamps should be equal. {len(ids)} != {len(timestamps)}"
+            )
+        images = [
+            {ApiField.ID: image_id, ApiField.EMBEDDINGS_UPDATED_AT: timestamp}
+            for image_id, timestamp in zip(ids, timestamps)
+        ]
+        self._api.post(
+            method,
+            {ApiField.IMAGES: images},
+        )

supervisely/api/module_api.py

@@ -663,6 +663,32 @@ class ApiField:
     """"""
     QUALITY_CHECK_USER_IDS = "qualityCheckUserIds"
     """"""
+    EMBEDDINGS = "embeddings"
+    """"""
+    EMBEDDINGS_ENABLED = "embeddingsEnabled"
+    """"""
+    EMBEDDINGS_UPDATED_AT = "embeddingsUpdatedAt"
+    """"""
+    EMBEDDINGS_IN_PROGRESS = "embeddingsInProgress"
+    """"""
+    AI_SEARCH_KEY = "aiSearchKey"
+    """"""
+    AI_SEARCH_META = "aiSearchMeta"
+    """"""
+    ENTITY_ITEMS = "entityItems"
+    """"""
+    SCORE = "score"
+    """"""
+    HARD_DELETE = "hardDelete"
+    """"""
+    THRESHOLD = "threshold"
+    """"""
+    THRESHOLD_DIRECTION = "thresholdDirection"
+    """"""
+    METHOD = "method"
+    """"""
+    PROMPT = "prompt"
+    """"""
     UPDATE_STRATEGY = "updateStrategy"
     """"""
 

supervisely/api/project_api.py

@@ -24,7 +24,7 @@ from tqdm import tqdm
 if TYPE_CHECKING:
     from pandas.core.frame import DataFrame
 
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 
 from supervisely import logger
 from supervisely._utils import (
@@ -97,6 +97,9 @@ class ProjectInfo(NamedTuple):
     import_settings: dict
     version: dict
     created_by_id: int
+    embeddings_enabled: Optional[bool] = None
+    embeddings_updated_at: Optional[str] = None
+    embeddings_in_progress: Optional[bool] = None
 
     @property
     def image_preview_url(self):
@@ -145,6 +148,8 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
         project_info = api.project.get_info_by_id(project_id)
     """
 
+    debug_messages_sent = {"get_list_versions": False}
+
     @staticmethod
     def info_sequence():
         """
@@ -195,6 +200,9 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
             ApiField.IMPORT_SETTINGS,
             ApiField.VERSION,
             ApiField.CREATED_BY_ID,
+            ApiField.EMBEDDINGS_ENABLED,
+            ApiField.EMBEDDINGS_UPDATED_AT,
+            ApiField.EMBEDDINGS_IN_PROGRESS,
         ]
 
     @staticmethod
@@ -227,7 +235,7 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
         :type workspace_id: int
         :param filters: List of params to sort output Projects.
         :type filters: List[dict], optional
-        :param fields: The list of api fields which will be returned with the response.
+        :param fields: The list of api fields which will be returned with the response. You must specify all fields you want to receive, not just additional ones.
         :type fields: List[str]
 
         :return: List of all projects with information for the given Workspace. See :class:`info_sequence<info_sequence>`
@@ -306,25 +314,29 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
             # ]
 
         """
+        method = "projects.list"
+
+        debug_message = "While getting list of projects, the following fields are not available: "
+
         if ApiField.VERSION in fields:
             fields.remove(ApiField.VERSION)
-            logger.debug(
-                "Project version information is not available while getting list of projects"
-            )
-        return self.get_list_all_pages(
-            "projects.list",
-            {
-                ApiField.WORKSPACE_ID: workspace_id,
-                ApiField.FILTER: filters or [],
-                ApiField.FIELDS: fields,
-            },
-        )
+            if self.debug_messages_sent.get("get_list_versions", False) is False:
+                self.debug_messages_sent["get_list_versions"] = True
+                logger.debug(debug_message + "version. ")
+
+        data = {
+            ApiField.WORKSPACE_ID: workspace_id,
+            ApiField.FILTER: filters or [],
+            ApiField.FIELDS: fields,
+        }
+
+        return self.get_list_all_pages(method, data)
 
     def get_info_by_id(
         self,
         id: int,
         expected_type: Optional[str] = None,
-        raise_error: Optional[bool] = False,
+        raise_error: bool = False,
     ) -> ProjectInfo:
         """
         Get Project information by ID.
@@ -892,8 +904,6 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
     def _convert_json_info(self, info: dict, skip_missing=True) -> ProjectInfo:
         """ """
         res = super()._convert_json_info(info, skip_missing=skip_missing)
-        if res.reference_image_url is not None:
-            res = res._replace(reference_image_url=res.reference_image_url)
         if res.items_count is None:
             res = res._replace(items_count=res.images_count)
         return ProjectInfo(**res._asdict())
@@ -1976,6 +1986,7 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
         per_page: Optional[int] = None,
         page: Union[int, Literal["all"]] = "all",
         account_type: Optional[str] = None,
+        extra_fields: Optional[List[str]] = None,
     ) -> dict:
         """
         List all available projects from all available teams for the user that match the specified filtering criteria.
@@ -2009,6 +2020,9 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
         :param account_type: (Deprecated) Type of user account
         :type account_type: str, optional
 
+        :param extra_fields: List of additional fields to be included in the response.
+        :type extra_fields: List[str], optional
+
         :return: Search response information and 'ProjectInfo' of all projects that are searched by a given criterion.
         :rtype: dict
 
@@ -2101,6 +2115,8 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
             logger.warning(
                 "The 'account_type' parameter is deprecated. The result will not be filtered by account type. To filter received ProjectInfos, you could use the 'team_id' from the ProjectInfo object to get TeamInfo and check the account type."
             )
+        if extra_fields is not None:
+            request_body[ApiField.EXTRA_FIELDS] = extra_fields
 
         first_response = self._api.post(method, request_body).json()
 
@@ -2141,3 +2157,206 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
             )
         _convert_entities(first_response)
         return first_response
+
+    def enable_embeddings(self, id: int, silent: bool = True) -> None:
+        """
+        Enable embeddings for the project.
+
+        :param id: Project ID
+        :type id: int
+        :param silent: Determines whether the `updatedAt` timestamp of the Project should be updated or not, if False - update `updatedAt`
+        :type silent: bool
+        :return: None
+        :rtype: :class:`NoneType`
+        """
+        self._api.post(
+            "projects.editInfo",
+            {ApiField.ID: id, ApiField.EMBEDDINGS_ENABLED: True, ApiField.SILENT: silent},
+        )
+
+    def disable_embeddings(self, id: int, silent: bool = True) -> None:
+        """
+        Disable embeddings for the project.
+
+        :param id: Project ID
+        :type id: int
+        :param silent: Determines whether the `updatedAt` timestamp of the Poject should be updated or not, if False - update `updatedAt`
+        :type silent: bool
+        :return: None
+        :rtype: :class:`NoneType`
+        """
+        self._api.post(
+            "projects.editInfo",
+            {ApiField.ID: id, ApiField.EMBEDDINGS_ENABLED: False, ApiField.SILENT: silent},
+        )
+
+    def set_embeddings_in_progress(self, id: int, in_progress: bool) -> None:
+        """
+        Set embeddings in progress status for the project.
+        This method is used to indicate whether embeddings are currently being created for the project.
+
+        :param id: Project ID
+        :type id: int
+        :param in_progress: Status to set. If True, embeddings are in progress right now.
+        :type in_progress: bool
+        :return: None
+        :rtype: :class:`NoneType`
+        """
+        self._api.post(
+            "projects.embeddings-in-progress.update",
+            {ApiField.ID: id, ApiField.EMBEDDINGS_IN_PROGRESS: in_progress},
+        )
+
+    def set_embeddings_updated_at(
+        self, id: int, timestamp: Optional[str] = None, silent: bool = True
+    ) -> None:
+        """
+        Set the timestamp when embeddings were last updated for the project.
+        If no timestamp is provided, uses the current UTC time.
+
+        :param id: Project ID
+        :type id: int
+        :param timestamp: ISO format timestamp (YYYY-MM-DDTHH:MM:SS.fffffZ). If None, current UTC time is used.
+        :type timestamp: Optional[str]
+        :param silent: Determines whether the `updatedAt` timestamp of the Project should be updated or not, if False - update `updatedAt`
+        :type silent: bool
+        :return: None
+        :rtype: :class:`NoneType`
+        :Usage example:
+
+         .. code-block:: python
+
+
+            api = sly.Api.from_env()
+            project_id = 123
+
+            # Set current time as embeddings update timestamp
+            api.project.set_embeddings_updated_at(project_id)
+
+            # Set specific timestamp
+            api.project.set_embeddings_updated_at(project_id, "2025-06-01T10:30:45.123456Z")
+        """
+        if timestamp is None:
+            timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+
+        self._api.post(
+            "projects.editInfo",
+            {ApiField.ID: id, ApiField.EMBEDDINGS_UPDATED_AT: timestamp, ApiField.SILENT: silent},
+        )
+
+    def perform_ai_search(
+        self,
+        project_id: int,
+        dataset_id: Optional[int] = None,
+        image_id: Optional[int] = None,
+        prompt: Optional[str] = None,
+        method: Optional[Literal["centroids", "random"]] = None,
+        limit: int = 100,
+    ) -> Optional[int]:
+        """
+        Send AI search request to initiate search process.
+        This method allows you to search for similar images in a project using either a text prompt, an image ID, or a method type.
+        It is mutually exclusive, meaning you can only provide one of the parameters: `prompt`, `image_id`, or `method`.
+
+        :param project_id: ID of the Project
+        :type project_id: int
+        :param dataset_id: ID of the Dataset. If not None - search will be limited to this dataset.
+        :type dataset_id: Optional[int]
+        :param image_id: ID of the Image. Searches for images similar to the specified image.
+        :type image_id: Optional[int]
+        :param prompt: Text prompt for search request. Searches for similar images based on a text description.
+        :type prompt: Optional[str]
+        :param method: Activates diverse search using one of the following methods: "centroids", "random".
+        :type method: Optional[Literal["centroids", "random"]]
+        :param limit: Limit for search request
+        :type limit: int
+        :return: Entitites Collection ID of the search results, or None if no collection was created.
+        :rtype: Optional[int]
+        :raises ValueError: only one of `prompt`, `image_id` or `method`must be provided, and `method` must be one of the allowed values.
+        :Usage example:
+
+         .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123
+            image_id = 789
+            prompt = "person with a dog"
+
+            # Search with text prompt
+            collection_id = api.project.perform_ai_search(
+                project_id=project_id,
+                prompt=prompt,
+            )
+
+            # Search with method
+            collection_id = api.project.perform_ai_search(
+                project_id=project_id,
+                method="centroids",
+            )
+
+            # Search with image ID
+            collection_id = api.project.perform_ai_search(
+                project_id=project_id,
+                image_id=image_id,
+            )
+        """
+
+        # Check that only one of prompt, method, or image_id is provided
+        provided_params = sum([prompt is not None, method is not None, image_id is not None])
+        if provided_params != 1:
+            raise ValueError(
+                "Must provide exactly one of 'prompt', 'method', or 'image_id' parameters. They are mutually exclusive."
+            )
+
+        if prompt is None and method is None and image_id is None:
+            raise ValueError("Must provide either 'prompt', 'method', or 'image_id' parameter.")
+
+        # Validate method values
+        if method is not None and method not in ["centroids", "random"]:
+            raise ValueError("Method must be either 'centroids' or 'random'.")
+
+        request_body = {
+            ApiField.PROJECT_ID: project_id,
+            ApiField.LIMIT: limit,
+        }
+
+        if dataset_id is not None:
+            request_body[ApiField.DATASET_ID] = dataset_id
+
+        if image_id is not None:
+            request_body[ApiField.IMAGE_ID] = image_id
+
+        if prompt is not None:
+            request_body[ApiField.PROMPT] = prompt
+
+        if method is not None:
+            request_body[ApiField.METHOD] = method
+
+        response = self._api.post("projects.send-ai-search", request_body)
+        return response.json().get(ApiField.COLLECTION_ID, None)
+
+    def calculate_embeddings(self, id: int) -> None:
+        """
+        Calculate embeddings for the project.
+        This method is used to calculate embeddings for all images in the project.
+
+        :param id: Project ID
+        :type id: int
+        :return: None
+        :rtype: :class:`NoneType`
+        :Usage example:
+
+         .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+            project_id = 123
+
+            # Calculate embeddings for the project
+            api.project.calculate_embeddings(project_id)
+        """
+        self._api.post("projects.calculate-project-embeddings", {ApiField.PROJECT_ID: id})

supervisely/api/video/video_api.py

@@ -2355,11 +2355,14 @@ class VideoApi(RemoveableBulkModuleApi):
 
     def set_remote(self, videos: List[int], links: List[str]):
         """
-        This method helps to change local source to remote for videos without re-uploading them as new.
+        Updates the source of existing videos by setting new remote links.
+        This method is used when a video was initially uploaded as a file or added via a link,
+        but later it was decided to change its location (e.g., moved to another storage or re-uploaded elsewhere).
+        By updating the link, the video source can be redirected to the new location.
 
         :param videos: List of video ids.
         :type videos: List[int]
-        :param links: List of remote links.
+        :param links: List of new remote links.
         :type links: List[str]
         :return: json-encoded content of a response.
 
@@ -2367,17 +2370,17 @@ class VideoApi(RemoveableBulkModuleApi):
 
             .. code-block:: python
 
-                    import supervisely as sly
+                import supervisely as sly
 
-                    api = sly.Api.from_env()
+                api = sly.Api.from_env()
 
-                    videos = [123, 124, 125]
-                    links = [
-                        "s3://bucket/f1champ/ds1/lap_1.mp4",
-                        "s3://bucket/f1champ/ds1/lap_2.mp4",
-                        "s3://bucket/f1champ/ds1/lap_3.mp4",
-                    ]
-                    result = api.video.set_remote(videos, links)
+                videos = [123, 124, 125]
+                links = [
+                    "s3://bucket/f1champ/ds1/lap_1.mp4",
+                    "s3://bucket/f1champ/ds1/lap_2.mp4",
+                    "s3://bucket/f1champ/ds1/lap_3.mp4",
+                ]
+                result = api.video.set_remote(videos, links)
         """
 
         if len(videos) == 0: