freeplay 0.3.0a9__tar.gz → 0.3.0a11__tar.gz

{freeplay-0.3.0a9 → freeplay-0.3.0a11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplay
-Version: 0.3.0a9
+Version: 0.3.0a11
 Summary: 
 License: MIT
 Author: FreePlay Engineering

{freeplay-0.3.0a9 → freeplay-0.3.0a11}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "freeplay"
-version = "0.3.0-alpha.9"
+version = "0.3.0-alpha.11"
 description = ""
 authors = ["FreePlay Engineering <engineering@freeplay.ai>"]
 license = "MIT"

{freeplay-0.3.0a9 → freeplay-0.3.0a11}/src/freeplay/__init__.py

@@ -1,7 +1,7 @@
 from .freeplay import Freeplay
 from .resources.prompts import PromptInfo
 from .resources.recordings import CallInfo, ResponseInfo, RecordPayload, TestRunInfo
-from .resources.sessions import SessionInfo
+from .resources.sessions import SessionInfo, TraceInfo
 
 __all__ = [
     'CallInfo',
@@ -11,4 +11,5 @@ __all__ = [
     'ResponseInfo',
     'SessionInfo',
     'TestRunInfo',
+    'TraceInfo',
 ]

{freeplay-0.3.0a9 → freeplay-0.3.0a11}/src/freeplay/api_support.py

@@ -60,6 +60,13 @@ def post_raw(api_key: str, url: str, payload: t.Optional[Dict[str, t.Any]] = Non
     )
 
 
+def delete_raw(api_key: str, url: str) -> Response:
+    return requests.delete(
+        url=url,
+        headers=build_request_header(api_key),
+    )
+
+
 def get(target_type: t.Type[T], api_key: str, url: str) -> T:
     response = requests.get(
         url=url,

{freeplay-0.3.0a9 → freeplay-0.3.0a11}/src/freeplay/freeplay.py

@@ -36,5 +36,5 @@ class Freeplay:
         self.customer_feedback = CustomerFeedback(self.call_support)
         self.prompts = Prompts(self.call_support, resolver)
         self.recordings = Recordings(self.call_support)
-        self.sessions = Sessions()
+        self.sessions = Sessions(self.call_support)
         self.test_runs = TestRuns(self.call_support)

{freeplay-0.3.0a9 → freeplay-0.3.0a11}/src/freeplay/resources/recordings.py

@@ -10,7 +10,7 @@ from freeplay.errors import FreeplayClientError, FreeplayError
 from freeplay.llm_parameters import LLMParameters
 from freeplay.model import InputVariables, OpenAIFunctionCall
 from freeplay.resources.prompts import PromptInfo
-from freeplay.resources.sessions import SessionInfo
+from freeplay.resources.sessions import SessionInfo, TraceInfo
 from freeplay.support import CallSupport
 
 logger = logging.getLogger(__name__)
@@ -62,6 +62,7 @@ class RecordPayload:
     response_info: Optional[ResponseInfo] = None
     test_run_info: Optional[TestRunInfo] = None
     eval_results: Optional[Dict[str, Union[bool, float]]] = None
+    trace_info: Optional[TraceInfo] = None
 
 
 @dataclass
@@ -117,6 +118,11 @@ class Recordings:
         if record_payload.eval_results is not None:
             record_api_payload['eval_results'] = record_payload.eval_results
 
+        if record_payload.trace_info is not None:
+            record_api_payload['trace_info'] = {
+                "trace_id": record_payload.trace_info.trace_id
+            }
+
         try:
             recorded_response = api_support.post_raw(
                 api_key=self.call_support.freeplay_api_key,

freeplay-0.3.0a11/src/freeplay/resources/sessions.py

@@ -0,0 +1,92 @@
+import uuid
+from dataclasses import dataclass
+from typing import Optional, Dict, Union
+
+from freeplay.errors import FreeplayClientError
+from freeplay.support import CallSupport
+
+CustomMetadata = Optional[Dict[str, Union[str, int, float]]]
+
+
+@dataclass
+class SessionInfo:
+    session_id: str
+    custom_metadata: CustomMetadata
+
+
+class TraceInfo:
+    session_id: str
+    trace_id: str
+    input: Optional[str] = None
+    _call_support: CallSupport
+
+    def __init__(
+            self,
+            trace_id: str,
+            session_id: str,
+            _call_support: CallSupport,
+            input: Optional[str] = None,
+    ):
+        self.trace_id = trace_id
+        self.session_id = session_id
+        self.input = input
+        self._call_support = _call_support
+
+    def record_output(self, project_id: str, output: str) -> None:
+        if self.input is None:
+            raise FreeplayClientError("Input must be set before recording output")
+        self._call_support.record_trace(project_id, self.session_id, self.trace_id, self.input, output)
+
+
+@dataclass
+class Session:
+    session_id: str
+    custom_metadata: CustomMetadata
+
+    def __init__(self, session_id: str, custom_metadata: CustomMetadata, _call_support: CallSupport):
+        self.session_id = session_id
+        self.custom_metadata = custom_metadata
+        self._session_info = SessionInfo(self.session_id, self.custom_metadata)
+        self._call_support = _call_support
+
+    @property
+    def session_info(self) -> SessionInfo:
+        return self._session_info
+
+    def create_trace(self, input: str) -> TraceInfo:
+        return TraceInfo(
+            trace_id=str(uuid.uuid4()),
+            session_id=self.session_id,
+            input=input,
+            _call_support=self._call_support
+        )
+
+    def restore_trace(self, trace_id: uuid.UUID, input: Optional[str]) -> TraceInfo:
+        return TraceInfo(
+            trace_id=str(trace_id),
+            session_id=self.session_id,
+            input=input,
+            _call_support=self._call_support
+        )
+
+
+class Sessions:
+    def __init__(self, call_support: CallSupport):
+        self.call_support = call_support
+
+    def create(self, custom_metadata: CustomMetadata = None) -> Session:
+        return Session(
+            session_id=str(uuid.uuid4()),
+            custom_metadata=custom_metadata,
+            _call_support=self.call_support,
+        )
+
+    def delete(self, project_id: str, session_id: str) -> None:
+        self.call_support.delete_session(project_id, session_id)
+
+    def restore_session(self, session_id: str, custom_metadata: CustomMetadata = None) -> Session:
+        return Session(
+            session_id=session_id,
+            custom_metadata=custom_metadata,
+            _call_support=self.call_support,
+        )

{freeplay-0.3.0a9 → freeplay-0.3.0a11}/src/freeplay/support.py

@@ -177,8 +177,8 @@ class CallSupport:
             payload={
                 'dataset_name': testlist,
                 'include_test_case_outputs': include_test_case_outputs,
-                'name': name,
-                'description': description
+                'test_run_name': name,
+                'test_run_description': description
             },
         )
 
@@ -210,3 +210,23 @@ class CallSupport:
             summary_statistics=json_dom['summary_statistics']
         )
 
+    def record_trace(self, project_id: str, session_id: str, trace_id: str, input: str, output: str) -> None:
+        response = api_support.post_raw(
+            self.freeplay_api_key,
+            f'{self.api_base}/v2/projects/{project_id}/sessions/{session_id}/traces/id/{trace_id}',
+            {
+                'input': input,
+                'output': output
+            }
+        )
+        if response.status_code != 201:
+            raise freeplay_response_error('Error while recording trace.', response)
+
+    def delete_session(self, project_id: str, session_id: str) -> None:
+        response = api_support.delete_raw(
+            self.freeplay_api_key,
+            f'{self.api_base}/v2/projects/{project_id}/sessions/{session_id}'
+        )
+        if response.status_code != 201:
+            raise freeplay_response_error('Error while deleting session.', response)
+

freeplay-0.3.0a9/src/freeplay/resources/sessions.py

@@ -1,32 +0,0 @@
-import uuid
-from dataclasses import dataclass
-from typing import Optional, Dict, Union
-
-CustomMetadata = Optional[Dict[str, Union[str, int, float]]]
-
-
-@dataclass
-class SessionInfo:
-    session_id: str
-    custom_metadata: CustomMetadata
-
-
-@dataclass
-class Session:
-    session_id: str
-    custom_metadata: CustomMetadata
-
-    def __init__(self, session_id: str, custom_metadata: CustomMetadata):
-        self.session_id = session_id
-        self.custom_metadata = custom_metadata
-        self._session_info = SessionInfo(self.session_id, self.custom_metadata)
-
-    @property
-    def session_info(self) -> SessionInfo:
-        return self._session_info
-
-
-class Sessions:
-    # noinspection PyMethodMayBeStatic
-    def create(self, custom_metadata: CustomMetadata = None) -> Session:
-        return Session(session_id=str(uuid.uuid4()), custom_metadata=custom_metadata)