Merge pull request #772 from parea-ai/PAI-1049-public-api-get-list-of-experiment-uui-ds-by-filtering-on-one-of-the-following-items-metadata-key-matches-value-or-experiment-run-name-contains-string

feat: list experiment uuids

Author: joschkabraun

parea/client.py

@@ -31,7 +31,7 @@
     TestCaseCollection,
     TraceLog,
     UseDeployedPrompt,
-    UseDeployedPromptResponse,
+    UseDeployedPromptResponse, ListExperimentUUIDsFilters,
 )
 from parea.utils.trace_utils import get_current_trace_id, get_root_trace_id, logger_all_possible, logger_record_log, trace_data
 
@@ -50,6 +50,7 @@
 CREATE_COLLECTION_ENDPOINT = "/collection"
 ADD_TEST_CASES_ENDPOINT = "/testcases"
 GET_TRACE_LOG_ENDPOINT = "/trace_log/{trace_id}"
+LIST_EXPERIMENTS_ENDPOINT = "/experiments"
 
 
 @define
@@ -346,6 +347,14 @@ async def aget_trace_log(self, trace_id: str) -> TraceLog:
         response = await self._client.request_async("GET", GET_TRACE_LOG_ENDPOINT.format(trace_id=trace_id))
         return structure_trace_log_from_api(response.json())
 
+    def list_experiment_uuids(self, filter_conditions: Optional[ListExperimentUUIDsFilters] = ListExperimentUUIDsFilters()) -> List[str]:
+        response = self._client.request("POST", LIST_EXPERIMENTS_ENDPOINT, data=asdict(filter_conditions))
+        return response.json()
+
+    async def alist_experiment_uuids(self, filter_conditions: Optional[ListExperimentUUIDsFilters] = ListExperimentUUIDsFilters()) -> List[str]:
+        response = await self._client.request_async("POST", LIST_EXPERIMENTS_ENDPOINT, data=asdict(filter_conditions))
+        return response.json()
+
 
 _initialized_parea_wrapper = False
 

parea/cookbook/list_experiments.py

@@ -0,0 +1,14 @@
+import os
+
+from dotenv import load_dotenv
+
+from parea import Parea
+from parea.schemas import ListExperimentUUIDsFilters
+
+load_dotenv()
+
+p = Parea(api_key=os.getenv("PAREA_API_KEY"))
+
+exp_uuids = p.list_experiment_uuids(ListExperimentUUIDsFilters())
+print(len(exp_uuids))
+print(exp_uuids)

parea/schemas/models.py

@@ -278,3 +278,11 @@ class CreateTestCaseCollection(CreateTestCases):
 @define
 class FinishExperimentRequestSchema:
     dataset_level_stats: Optional[List[EvaluationResult]] = field(factory=list)
+
+
+@define
+class ListExperimentUUIDsFilters:
+    project_name: Optional[str] = None
+    metadata_filter: Optional[Dict[str, Any]] = None
+    experiment_name_filter: Optional[str] = None
+    run_name_filter: Optional[str] = None