Merge pull request #194 from fastlabel/feature/add-get-dataset-param

SDKでリビジョン、バージョンを指定してデータセットを取得できる

Author: anegawa-j

README.md

@@ -2583,7 +2583,21 @@ dataset_object = client.find_dataset_object(
     object_name="brushwood_dog.jpg"
 )
 ```
-
+You can find a object of specified revision by version or revision_id.  
+```python
+dataset_object = client.find_dataset_object(
+    dataset_id="YOUR_DATASET_ID",
+    object_name="brushwood_dog.jpg",
+    version="YOUR_VERSION_NAME" # default is "latest"
+)   
+```
+```python
+dataset_object = client.find_dataset_object(
+    dataset_id="YOUR_DATASET_ID",
+    object_name="brushwood_dog.jpg",
+    revision_id="YOUR_REVISION_ID" # 8 characters or more
+)   
+```
 Success response is the same as when created.
 
 ### Get Dataset Object
@@ -2596,7 +2610,7 @@ dataset_objects = client.get_dataset_objects(dataset="YOUR_DATASET_NAME")
 
 The success response is the same as when created, but it is an array.
 
-You can filter by version and tags.
+You can filter by version or revision_id and tags.
 
 ```python
 dataset_objects = client.get_dataset_objects(
@@ -2605,7 +2619,12 @@ dataset_objects = client.get_dataset_objects(
     tags=["cat"],
 )
 ```
-
+```python
+dataset_objects = client.get_dataset_objects(
+    dataset="YOUR_DATASET_NAME",
+    revision_id="YOUR_REVISION_ID" # 8 characters or more
+)
+```
 ### Download Dataset Objects
 
 Download dataset objects in the dataset to specific directories.

fastlabel/__init__.py

@@ -3914,27 +3914,60 @@ def delete_dataset(self, dataset_id: str) -> None:
 
     # Dataset Object
 
-    def find_dataset_object(self, dataset_id: str, object_name: str) -> dict:
+    def find_dataset_object(
+        self,
+        dataset_id: str,
+        object_name: str,
+        version: str = None,
+        revision_id: str = None,
+    ) -> dict:
         """
         Find a dataset object.
+
+        dataset_id is dataset id (Required).
+        object_name is dataset object name (Required).
+        version is dataset version (Optional).
+        revision_id is dataset rebision (Optional).
+        Only use specify one of revision_id or version.
         """
-        endpoint = "datasets-v2/" + dataset_id  + "/objects/" + object_name
-        return self.api.get_request(endpoint)
+        if version and revision_id:
+            raise FastLabelInvalidException(
+                "only use specify one of revisionId or version.", 400)
+        endpoint = "datasets-v2/" + dataset_id + "/objects/" + object_name
+        params = {}
+        if revision_id:
+            params["revisionId"] = revision_id
+        elif version:
+            params["version"] = version
+        return self.api.get_request(endpoint, params=params)
 
     def get_dataset_objects(
-        self, dataset: str, version: str = None, tags: List[str] = []
+        self,
+        dataset: str,
+        version: str = None,
+        tags: List[str] = None,
+        revision_id: str = None,
     ) -> list:
         """
         Returns a list of dataset objects.
 
         dataset is dataset name (Required).
         version is dataset version (Optional).
         tags is a list of tag (Optional).
+        revision_id is dataset rebision (Optional).
+        Only use specify one of revision_id or version.
         """
+        if version and revision_id:
+            raise FastLabelInvalidException(
+                "only use specify one of revisionId or version.", 400)
         endpoint = "dataset-objects-v2"
         params = {"dataset": dataset}
+        if revision_id:
+            params["revisionId"] = revision_id
         if version:
             params["version"] = version
+
+        tags = tags or []
         if tags:
             params["tags"] = tags
         return self.api.get_request(endpoint, params=params)
@@ -4049,7 +4082,7 @@ def delete_dataset_object(self, dataset_id: str, object_name: str) -> None:
         """
         Delete a dataset object.
         """
-        endpoint = "datasets-v2/" + dataset_id  + "/objects/" + object_name
+        endpoint = "datasets-v2/" + dataset_id + "/objects/" + object_name
         self.api.delete_request(endpoint)
 
     def update_aws_s3_storage(