Merge pull request #1045 from parea-ai/PAI-1455-fetch-traces-via-api

feat: fetch logs via api

Author: joschkabraun

cookbook/fetch_logs.py

@@ -0,0 +1,13 @@
+import os
+
+from dotenv import load_dotenv
+
+from parea import Parea
+from parea.schemas import FilterOperator, QueryParams
+
+load_dotenv()
+
+p = Parea(api_key=os.getenv("PAREA_API_KEY"))
+
+paginated_resp = p.get_trace_logs(QueryParams(project_name="default", filter_field="trace_name", filter_operator=FilterOperator.LIKE, filter_value="llm"))
+print(f"Num. LLM logs fetched: {len(paginated_resp.results)} | total LLM logs: {paginated_resp.total}")

parea/client.py

@@ -14,7 +14,7 @@
 from parea.cache.cache import Cache
 from parea.constants import PAREA_OS_ENV_EXPERIMENT_UUID
 from parea.experiment.datasets import create_test_cases, create_test_collection
-from parea.helpers import gen_trace_id, serialize_metadata_values, structure_trace_log_from_api, structure_trace_logs_from_api
+from parea.helpers import create_paginated_trace_logs_response_from_api, gen_trace_id, serialize_metadata_values, structure_trace_log_from_api, structure_trace_logs_from_api
 from parea.parea_logger import parea_logger
 from parea.schemas import EvaluationResult
 from parea.schemas.models import (
@@ -30,7 +30,9 @@
     FeedbackRequest,
     FinishExperimentRequestSchema,
     ListExperimentUUIDsFilters,
+    PaginatedTraceLogsResponse,
     ProjectSchema,
+    QueryParams,
     TestCaseCollection,
     TraceLogFilters,
     TraceLogTree,
@@ -59,6 +61,7 @@
 GET_TRACE_LOG_ENDPOINT = "/trace_log/{trace_id}"
 LIST_EXPERIMENTS_ENDPOINT = "/experiments"
 GET_EXPERIMENT_LOGS_ENDPOINT = "/experiment/{experiment_uuid}/trace_logs"
+GET_TRACE_LOGS_ENDPOINT = "/get_trace_logs"
 
 
 @define
@@ -524,6 +527,14 @@ async def aget_experiment(self, experiment_uuid: str) -> Optional[ExperimentWith
         result = response_json[0] if isinstance(response_json, list) else None
         return structure(result, ExperimentWithPinnedStatsSchema)
 
+    def get_trace_logs(self, query_params: QueryParams) -> PaginatedTraceLogsResponse:
+        response = self._client.request("POST", GET_TRACE_LOGS_ENDPOINT, data=asdict(query_params))
+        return create_paginated_trace_logs_response_from_api(response.json())
+
+    async def aget_trace_logs(self, query_params: QueryParams) -> PaginatedTraceLogsResponse:
+        response = await self._client.request_async("POST", GET_TRACE_LOGS_ENDPOINT, data=asdict(query_params))
+        return create_paginated_trace_logs_response_from_api(response.json())
+
 
 def patch_openai_client_classes(openai_client, parea_client: Parea):
     """Creates a subclass of the given openai_client to always wrap it with Parea at instantiation."""

parea/helpers.py

@@ -11,7 +11,7 @@
 from cattrs import GenConverter
 
 from parea.constants import ADJECTIVES, NOUNS, TURN_OFF_PAREA_LOGGING
-from parea.schemas.models import Completion, TraceLog, TraceLogTree, UpdateLog
+from parea.schemas.models import Completion, PaginatedTraceLogsResponse, TraceLog, TraceLogTree, UpdateLog
 from parea.utils.universal_encoder import json_dumps
 
 
@@ -103,13 +103,35 @@ def structure_float_or_none(obj: Any, cl: type) -> Optional[float]:
     converter.register_structure_hook(Union[str, Dict[str, str], None], structure_union_type)
     converter.register_structure_hook(float, structure_float_or_none)
     converter.register_structure_hook(Optional[float], structure_float_or_none)
+
+    def structure_trace_log_tree(data, _):
+        kwargs = {}
+        for key, value in data.items():
+            if key == "children_logs":
+                kwargs["children_logs"] = [structure_trace_log_tree(child, TraceLogTree) for child in value]
+            elif key in fields_dict(TraceLogTree):
+                kwargs[key] = value
+        return TraceLogTree(**kwargs)
+
+    converter.register_structure_hook(TraceLogTree, structure_trace_log_tree)
+
     return converter.structure(d, TraceLogTree)
 
 
 def structure_trace_logs_from_api(data: List[dict]) -> List[TraceLogTree]:
     return [structure_trace_log_from_api(d) for d in data]
 
 
+def create_paginated_trace_logs_response_from_api(data: dict) -> PaginatedTraceLogsResponse:
+    return PaginatedTraceLogsResponse(
+        total=data["total"],
+        page=data["page"],
+        total_pages=data["total_pages"],
+        page_size=data["page_size"],
+        results=structure_trace_logs_from_api(data["results"]),
+    )
+
+
 PAREA_LOGGING_DISABLED = False
 
 

parea/schemas/models.py

@@ -480,5 +480,41 @@ class FilterOperator(str, Enum):
 @define
 class TraceLogFilters:
     filter_field: Optional[str] = None
+    filter_key: Optional[str] = None
     filter_operator: Optional[FilterOperator] = None
     filter_value: Optional[str] = None
+
+
+class TimeRange(str, Enum):
+    NA = "na"
+    LAST_1_HOUR = "1h"
+    LAST_3_HOURS = "3h"
+    LAST_6_HOURS = "6h"
+    LAST_24_HOURS = "24h"
+    LAST_7_DAYS = "7d"
+    LAST_1_MONTH = "1m"
+    LAST_3_MONTHS = "3m"
+    LAST_6_MONTHS = "6m"
+    LAST_12_MONTHS = "1y"
+
+
+@define
+class QueryParams:
+    project_name: str
+    filter_field: Optional[str] = None
+    filter_key: Optional[str] = None
+    filter_operator: Optional[FilterOperator] = None
+    filter_value: Optional[str] = None
+    page: int = 1
+    page_size: int = 20
+    time_range: TimeRange = TimeRange.NA
+    status: Optional[str] = None
+
+
+@define
+class PaginatedTraceLogsResponse:
+    total: int
+    page: int
+    total_pages: int
+    page_size: int
+    results: List[TraceLogTree]

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 name = "parea-ai"
 packages = [{ include = "parea" }]
-version = "0.2.198"
+version = "0.2.199"
 description = "Parea python sdk"
 readme = "README.md"
 authors = ["joel-parea-ai <[email protected]>"]