freeplay 0.4.0__tar.gz → 0.5.0a1__tar.gz

{freeplay-0.4.0 → freeplay-0.5.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: freeplay
-Version: 0.4.0
+Version: 0.5.0a1
 Summary: 
 License: MIT
 Author: FreePlay Engineering

{freeplay-0.4.0 → freeplay-0.5.0a1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "freeplay"
-version = "0.4.0"
+version = "0.5.0a1"
 description = ""
 authors = ["FreePlay Engineering <engineering@freeplay.ai>"]
 license = "MIT"

{freeplay-0.4.0 → freeplay-0.5.0a1}/src/freeplay/model.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import List, Union, Any, Dict, Mapping, TypedDict, Literal
+from typing import Any, Dict, List, Literal, Mapping, TypedDict, Union
 
 InputValue = Union[str, int, bool, float, Dict[str, Any], List[Any]]
 InputVariables = Mapping[str, InputValue]
@@ -7,6 +7,23 @@ TestRunInput = Mapping[str, InputValue]
 FeedbackValue = Union[bool, str, int, float]
 
 
+@dataclass
+class MediaInputUrl:
+    type: Literal["url"]
+    url: str
+
+
+@dataclass
+class MediaInputBase64:
+    type: Literal["base64"]
+    data: str
+    content_type: str
+
+
+MediaInput = Union[MediaInputUrl, MediaInputBase64]
+MediaInputMap = Dict[str, MediaInput]
+
+
 @dataclass
 class TestRun:
     id: str

{freeplay-0.4.0 → freeplay-0.5.0a1}/src/freeplay/resources/prompts.py

@@ -24,7 +24,11 @@ from freeplay.errors import (
     log_freeplay_client_warning,
 )
 from freeplay.llm_parameters import LLMParameters
-from freeplay.model import InputVariables
+from freeplay.model import (
+    InputVariables,
+    MediaInputMap,
+    MediaInputUrl,
+)
 from freeplay.resources.adapters import (
     MediaContentBase64,
     MediaContentUrl,
@@ -96,8 +100,6 @@ class PromptInfo:
     provider: str
     model: str
     flavor_name: str
-    project_id: str
-
 
 class FormattedPrompt:
     def __init__(
@@ -214,22 +216,6 @@ class BoundPrompt:
             )
 
 
-@dataclass
-class MediaInputUrl:
-    type: Literal["url"]
-    url: str
-
-
-@dataclass
-class MediaInputBase64:
-    type: Literal["base64"]
-    data: str
-    content_type: str
-
-
-MediaInput = Union[MediaInputUrl, MediaInputBase64]
-
-MediaInputMap = Dict[str, MediaInput]
 
 
 def extract_media_content(media_inputs: MediaInputMap, media_slots: List[MediaSlot]) -> List[
@@ -552,7 +538,6 @@ class Prompts:
             model=model,
             flavor_name=prompt.metadata.flavor,
             provider_info=prompt.metadata.provider_info,
-            project_id=prompt.project_id
         )
 
         return TemplatePrompt(prompt_info, prompt.content, prompt.tool_schema)
@@ -588,7 +573,6 @@ class Prompts:
             model=model,
             flavor_name=prompt.metadata.flavor,
             provider_info=prompt.metadata.provider_info,
-            project_id=prompt.project_id
         )
 
         return TemplatePrompt(prompt_info, prompt.content, prompt.tool_schema)

{freeplay-0.4.0 → freeplay-0.5.0a1}/src/freeplay/resources/recordings.py

@@ -1,20 +1,28 @@
 import json
 import logging
-from dataclasses import dataclass
-from typing import Any, Dict, List, Optional, Union, Literal
-from uuid import UUID
+from dataclasses import dataclass, field
+from typing import Any, Dict, List, Literal, Optional, Union
+from uuid import UUID, uuid4
 
 from requests import HTTPError
 
 from freeplay import api_support
 from freeplay.errors import FreeplayClientError, FreeplayError
 from freeplay.llm_parameters import LLMParameters
-from freeplay.model import InputVariables, OpenAIFunctionCall, TestRunInfo
-from freeplay.resources.prompts import PromptInfo, MediaInputMap, MediaInput, MediaInputUrl
+from freeplay.model import (
+    InputVariables,
+    MediaInput,
+    MediaInputMap,
+    MediaInputUrl,
+    OpenAIFunctionCall,
+    TestRunInfo,
+)
+from freeplay.resources.prompts import (
+    PromptInfo,
+)
 from freeplay.resources.sessions import SessionInfo, TraceInfo
 from freeplay.support import CallSupport
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -29,11 +37,11 @@ ApiStyle = Union[Literal['batch'], Literal['default']]
 
 @dataclass
 class CallInfo:
-    provider: str
-    model: str
-    start_time: float
-    end_time: float
-    model_parameters: LLMParameters
+    provider: Optional[str] = None
+    model: Optional[str] = None
+    start_time: Optional[float] = None
+    end_time: Optional[float] = None
+    model_parameters: Optional[LLMParameters] = None
     provider_info: Optional[Dict[str, Any]] = None
     usage: Optional[UsageTokens] = None
     api_style: Optional[ApiStyle] = None
@@ -69,12 +77,15 @@ class ResponseInfo:
 
 @dataclass
 class RecordPayload:
+    project_id: str
     all_messages: List[Dict[str, Any]]
-    inputs: InputVariables
 
-    session_info: SessionInfo
-    prompt_info: PromptInfo
-    call_info: CallInfo
+    session_info: SessionInfo = field(
+        default_factory=lambda: SessionInfo(session_id=str(uuid4()), custom_metadata=None)
+    )
+    inputs: Optional[InputVariables] = None
+    prompt_info: Optional[PromptInfo] = None
+    call_info: Optional[CallInfo] = None
     media_inputs: Optional[MediaInputMap] = None
     tool_schema: Optional[List[Dict[str, Any]]] = None
     response_info: Optional[ResponseInfo] = None
@@ -124,19 +135,25 @@ class Recordings:
             "inputs": record_payload.inputs,
             "tool_schema": record_payload.tool_schema,
             "session_info": {"custom_metadata": record_payload.session_info.custom_metadata},
-            "prompt_info": {
+            
+        }
+
+        if record_payload.prompt_info is not None:
+            record_api_payload["prompt_info"] = {
                 "environment": record_payload.prompt_info.environment,
                 "prompt_template_version_id": record_payload.prompt_info.prompt_template_version_id,
-            },
-            "call_info": {
+            }
+        
+        if record_payload.call_info is not None:
+            record_api_payload["call_info"] = {
                 "start_time": record_payload.call_info.start_time,
                 "end_time": record_payload.call_info.end_time,
                 "model": record_payload.call_info.model,
                 "provider": record_payload.call_info.provider,
                 "provider_info": record_payload.call_info.provider_info,
                 "llm_parameters": record_payload.call_info.model_parameters,
+                "api_style": record_payload.call_info.api_style,
             }
-        }
 
         if record_payload.completion_id is not None:
             record_api_payload['completion_id'] = str(record_payload.completion_id)
@@ -167,15 +184,12 @@ class Recordings:
                 "trace_id": record_payload.trace_info.trace_id
             }
 
-        if record_payload.call_info.usage is not None:
+        if record_payload.call_info is not None and record_payload.call_info.usage is not None:
             record_api_payload['call_info']['usage'] = {
                 "prompt_tokens": record_payload.call_info.usage.prompt_tokens,
                 "completion_tokens": record_payload.call_info.usage.completion_tokens,
             }
 
-        if record_payload.call_info.api_style is not None:
-            record_api_payload['call_info']['api_style'] = record_payload.call_info.api_style
-
         if record_payload.media_inputs is not None:
             record_api_payload['media_inputs'] = {
                 name: media_inputs_to_json(media_input)
@@ -185,7 +199,7 @@ class Recordings:
         try:
             recorded_response = api_support.post_raw(
                 api_key=self.call_support.freeplay_api_key,
-                url=f'{self.call_support.api_base}/v2/projects/{record_payload.prompt_info.project_id}/sessions/{record_payload.session_info.session_id}/completions',
+                url=f'{self.call_support.api_base}/v2/projects/{record_payload.project_id}/sessions/{record_payload.session_info.session_id}/completions',
                 payload=record_api_payload
             )
             recorded_response.raise_for_status()

{freeplay-0.4.0 → freeplay-0.5.0a1}/src/freeplay/resources/test_runs.py

@@ -1,25 +1,31 @@
-from dataclasses import dataclass
-from typing import List, Optional, Dict, Any
 import warnings
+from dataclasses import dataclass
+from typing import Any, Dict, List, Optional, Union
 
-from freeplay.model import InputVariables, TestRunInfo
+from freeplay.model import InputVariables, MediaInputBase64, MediaInputUrl, TestRunInfo
 from freeplay.support import CallSupport, SummaryStatistics
 
+
 @dataclass
 class CompletionTestCase:
     def __init__(
-            self,
-            test_case_id: str,
-            variables: InputVariables,
-            output: Optional[str],
-            history: Optional[List[Dict[str, str]]],
-            custom_metadata: Optional[Dict[str, str]]
+        self,
+        test_case_id: str,
+        variables: InputVariables,
+        output: Optional[str],
+        history: Optional[List[Dict[str, str]]],
+        custom_metadata: Optional[Dict[str, str]],
+        media_variables: Optional[
+            Dict[str, Union[MediaInputBase64, MediaInputUrl]]
+        ] = None,
     ):
         self.id = test_case_id
         self.variables = variables
         self.output = output
         self.history = history
         self.custom_metadata = custom_metadata
+        self.media_variables = media_variables
+
 
 class TestCase(CompletionTestCase):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -30,44 +36,55 @@ class TestCase(CompletionTestCase):
         )
         super().__init__(*args, **kwargs)
 
+
 class TraceTestCase:
     def __init__(
-            self,
-            test_case_id: str,
-            input: str,
-            output: Optional[str],
-            custom_metadata: Optional[Dict[str, str]]
+        self,
+        test_case_id: str,
+        input: str,
+        output: Optional[str],
+        custom_metadata: Optional[Dict[str, str]],
     ):
         self.id = test_case_id
         self.input = input
         self.output = output
         self.custom_metadata = custom_metadata
+
 @dataclass
 class TestRun:
     def __init__(
-            self,
-            test_run_id: str,
-            test_cases: List[CompletionTestCase] = [],
-            trace_test_cases: List[TraceTestCase] = []
+        self,
+        test_run_id: str,
+        test_cases: List[CompletionTestCase] = [],
+        trace_test_cases: List[TraceTestCase] = [],
     ):
         self.test_run_id = test_run_id
         self.test_cases = test_cases
         self.trace_test_cases = trace_test_cases
 
     def __must_not_be_both_trace_and_completion(self) -> None:
-        if self.test_cases and len(self.test_cases) > 0 and self.trace_test_cases and len(self.trace_test_cases) > 0:
+        if (
+            self.test_cases
+            and len(self.test_cases) > 0
+            and self.trace_test_cases
+            and len(self.trace_test_cases) > 0
+        ):
             raise ValueError("Test case and trace test case cannot both be present")
 
     def get_test_cases(self) -> List[CompletionTestCase]:
         self.__must_not_be_both_trace_and_completion()
         if len(self.trace_test_cases) > 0:
-            raise ValueError("Completion test cases are not present. Please use get_trace_test_cases() instead.")
+            raise ValueError(
+                "Completion test cases are not present. Please use get_trace_test_cases() instead."
+            )
         return self.test_cases
 
     def get_trace_test_cases(self) -> List[TraceTestCase]:
         self.__must_not_be_both_trace_and_completion()
         if len(self.test_cases) > 0:
-            raise ValueError("Trace test cases are not present. Please use get_test_cases() instead.")
+            raise ValueError(
+                "Trace test cases are not present. Please use get_test_cases() instead."
+            )
         return self.trace_test_cases
 
     def get_test_run_info(self, test_case_id: str) -> TestRunInfo:
@@ -105,11 +122,14 @@ class TestRuns:
         test_run = self.call_support.create_test_run(
             project_id, testlist, include_outputs, name, description, flavor_name)
         test_cases = [
-            CompletionTestCase(test_case_id=test_case.id,
-                     variables=test_case.variables,
-                     output=test_case.output,
-                     history=test_case.history,
-                     custom_metadata=test_case.custom_metadata)
+            CompletionTestCase(
+                test_case_id=test_case.id,
+                variables=test_case.variables,
+                output=test_case.output,
+                history=test_case.history,
+                custom_metadata=test_case.custom_metadata,
+                media_variables=test_case.media_variables,
+            )
             for test_case in test_run.test_cases
         ]
         trace_test_cases = [

{freeplay-0.4.0 → freeplay-0.5.0a1}/src/freeplay/support.py

@@ -1,11 +1,18 @@
-from dataclasses import dataclass, field, asdict
+from dataclasses import asdict, dataclass, field
 from json import JSONEncoder
-from typing import Optional, Dict, Any, List, Union, Literal
+from typing import Any, Dict, List, Literal, Optional, Union
 
 from freeplay import api_support
 from freeplay.api_support import try_decode
-from freeplay.errors import freeplay_response_error, FreeplayServerError
-from freeplay.model import InputVariables, FeedbackValue, NormalizedMessage, TestRunInfo
+from freeplay.errors import FreeplayServerError, freeplay_response_error
+from freeplay.model import (
+    FeedbackValue,
+    InputVariables,
+    MediaInputBase64,
+    MediaInputUrl,
+    NormalizedMessage,
+    TestRunInfo,
+)
 
 CustomMetadata = Optional[Dict[str, Union[str, int, float, bool]]]
 
@@ -100,6 +107,26 @@ class TestCaseTestRunResponse:
         self.history: Optional[List[Dict[str, Any]]] = test_case.get('history')
         self.custom_metadata: Optional[Dict[str, str]] = test_case.get('custom_metadata')
 
+        if test_case.get("media_variables", None):
+            self.media_variables: Optional[
+                Dict[str, Union[MediaInputBase64, MediaInputUrl]]
+            ] = {}
+            for name, media_data in test_case.get("media_variables", {}).items():
+                media_type = media_data.get("type", "base64")
+                if media_type == "url":
+                    self.media_variables[name] = MediaInputUrl(
+                        type="url",
+                        url=media_data["url"],
+                    )
+                else:
+                    self.media_variables[name] = MediaInputBase64(
+                        type="base64",
+                        data=media_data["data"],
+                        content_type=media_data["content_type"],
+                    )
+        else:
+            self.media_variables = None
+
 
 class TraceTestCaseTestRunResponse:
     def __init__(self, test_case: Dict[str, Any]):