QUO-790: Add list method for logs (#71)

* GET logs from clients

* Enable users to get logs

Author: freddiev4

quotientai/async_client.py

@@ -19,8 +19,16 @@ def __init__(self, api_key: str):
         )
 
     @handle_async_errors
-    async def _get(self, path: str, timeout: int = None) -> dict:
-        response = await self.get(path, timeout=timeout)
+    async def _get(self, path: str, params: Optional[Dict[str, Any]] = None, timeout: int = None) -> dict:
+        """
+        Send an async GET request to the specified path.
+        
+        Args:
+            path: API endpoint path
+            params: Optional query parameters
+            timeout: Optional request timeout in seconds
+        """
+        response = await self.get(path, params=params, timeout=timeout)
         return response
 
     @handle_async_errors

quotientai/client.py

@@ -19,8 +19,16 @@ def __init__(self, api_key: str):
         )
 
     @handle_errors
-    def _get(self, path: str, timeout: int = None) -> dict:
-        response = self.get(path, timeout=timeout)
+    def _get(self, path: str, params: Optional[Dict[str, Any]] = None, timeout: int = None) -> dict:
+        """
+        Send a GET request to the specified path.
+        
+        Args:
+            path: API endpoint path
+            params: Optional query parameters
+            timeout: Optional request timeout in seconds
+        """
+        response = self.get(path, params=params, timeout=timeout)
         return response
 
     @handle_errors

quotientai/resources/logs.py

@@ -2,13 +2,99 @@
 import asyncio
 import httpx
 import logging
+from dataclasses import dataclass
+from datetime import datetime
+
+
+@dataclass
+class Log:
+    """
+    Represents a log entry from the QuotientAI API
+    """
+    id: str
+    app_name: str
+    environment: str
+    hallucination_detection: bool
+    inconsistency_detection: bool
+    user_query: str
+    model_output: str
+    documents: List[str]
+    message_history: Optional[List[Dict[str, Any]]]
+    instructions: Optional[List[str]]
+    tags: Dict[str, Any]
+    created_at: datetime
+
+    def __rich_repr__(self):
+        yield "id", self.id
+        yield "app_name", self.app_name
+        yield "environment", self.environment
+        yield "created_at", self.created_at
 
 
 class LogsResource:
     def __init__(self, client) -> None:
         self._client = client
         self.logger = logging.getLogger(__name__)
 
+    def list(
+        self,
+        *,
+        app_name: Optional[str] = None,
+        environment: Optional[str] = None,
+        start_date: Optional[datetime] = None,
+        end_date: Optional[datetime] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+    ) -> List[Log]:
+        """
+        List logs with optional filtering parameters.
+        
+        Args:
+            app_name: Filter logs by application name
+            environment: Filter logs by environment
+            start_date: Filter logs created after this date
+            end_date: Filter logs created before this date
+            limit: Maximum number of logs to return
+            offset: Number of logs to skip
+        """
+        params = {
+            "app_name": app_name,
+            "environment": environment,
+            "start_date": start_date.isoformat() if start_date else None,
+            "end_date": end_date.isoformat() if end_date else None,
+            "limit": limit,
+            "offset": offset,
+        }
+        # Remove None values
+        params = {k: v for k, v in params.items() if v is not None}
+        
+        try:
+            response = self._client._get("/logs", params=params)
+            data = response["logs"]
+
+            logs = []
+            for log in data:
+                logs.append(
+                    Log(
+                        id=log["id"],
+                        app_name=log["app_name"],
+                        environment=log["environment"],
+                        hallucination_detection=log["hallucination_detection"],
+                        inconsistency_detection=log["inconsistency_detection"],
+                        user_query=log["user_query"],
+                        model_output=log["model_output"],
+                        documents=log["documents"],
+                        message_history=log["message_history"],
+                        instructions=log["instructions"],
+                        tags=log["tags"],
+                        created_at=datetime.fromisoformat(log["created_at"]),
+                    )
+                )
+            return logs
+        except Exception:
+            self.logger.error("Error listing logs", exc_info=True)
+            raise
+
     def create(
         self,
         app_name: str,
@@ -21,7 +107,6 @@ def create(
         message_history: Optional[List[Dict[str, Any]]] = None,
         instructions: Optional[List[str]] = None,
         tags: Optional[Dict[str, Any]] = {},
-        contexts: Optional[List[str]] = [],
         hallucination_detection_sample_rate: Optional[float] = 0,
     ):
         """
@@ -38,7 +123,6 @@ def create(
             "documents": documents,
             "message_history": message_history,
             "instructions": instructions,
-            "contexts": contexts,
             "hallucination_detection_sample_rate": hallucination_detection_sample_rate,
         }
 
@@ -55,6 +139,65 @@ def __init__(self, client) -> None:
         self._client = client
         self.logger = logging.getLogger(__name__)
 
+    async def list(
+        self,
+        *,
+        app_name: Optional[str] = None,
+        environment: Optional[str] = None,
+        start_date: Optional[datetime] = None,
+        end_date: Optional[datetime] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+    ) -> List[Log]:
+        """
+        List logs asynchronously with optional filtering parameters.
+        
+        Args:
+            app_name: Filter logs by application name
+            environment: Filter logs by environment
+            start_date: Filter logs created after this date
+            end_date: Filter logs created before this date
+            limit: Maximum number of logs to return
+            offset: Number of logs to skip
+        """
+        params = {
+            "app_name": app_name,
+            "environment": environment,
+            "start_date": start_date.isoformat() if start_date else None,
+            "end_date": end_date.isoformat() if end_date else None,
+            "limit": limit,
+            "offset": offset,
+        }
+        # Remove None values
+        params = {k: v for k, v in params.items() if v is not None}
+        
+        try:
+            response = await self._client._get("/logs", params=params)
+            data = response["logs"]
+
+            logs = []
+            for log in data:
+                logs.append(
+                    Log(
+                        id=log["id"],
+                        app_name=log["app_name"],
+                        environment=log["environment"],
+                        hallucination_detection=log["hallucination_detection"],
+                        inconsistency_detection=log["inconsistency_detection"],
+                        user_query=log["user_query"],
+                        model_output=log["model_output"],
+                        documents=log["documents"],
+                        message_history=log["message_history"],
+                        instructions=log["instructions"],
+                        tags=log["tags"],
+                        created_at=datetime.fromisoformat(log["created_at"]),
+                    )
+                )
+            return logs
+        except Exception:
+            self.logger.error("Error listing logs", exc_info=True)
+            raise
+
     async def create(
         self,
         app_name: str,
@@ -67,7 +210,6 @@ async def create(
         message_history: Optional[List[Dict[str, Any]]] = None,
         instructions: Optional[List[str]] = None,
         tags: Optional[Dict[str, Any]] = {},
-        contexts: Optional[List[str]] = [],
         hallucination_detection_sample_rate: Optional[float] = 0,
     ):
         """
@@ -84,7 +226,6 @@ async def create(
             "documents": documents,
             "message_history": message_history,
             "instructions": instructions,
-            "contexts": contexts,
             "hallucination_detection_sample_rate": hallucination_detection_sample_rate,
         }