freeplay 0.3.8__py3-none-any.whl → 0.3.10__py3-none-any.whl

freeplay/resources/prompts.py

@@ -1,21 +1,21 @@
 import copy
 import json
+import logging
 from abc import ABC, abstractmethod
 from dataclasses import asdict, dataclass
-import logging
 from pathlib import Path
-from typing import Dict, Optional, List, cast, Any, Union, overload
-from anthropic.types.message import Message as AnthropicMessage
-from openai.types.chat import ChatCompletionMessage as OpenAIMessage
+from typing import Dict, Optional, List, cast, Any, Union, runtime_checkable, Protocol
 
 from freeplay.errors import FreeplayConfigurationError, FreeplayClientError, log_freeplay_client_warning
 from freeplay.llm_parameters import LLMParameters
 from freeplay.model import InputVariables
 from freeplay.support import CallSupport, ToolSchema
 from freeplay.support import PromptTemplate, PromptTemplates, PromptTemplateMetadata
-from freeplay.utils import bind_template_variables
+from freeplay.utils import bind_template_variables, convert_provider_message_to_dict
 
 logger = logging.getLogger(__name__)
+
+
 class MissingFlavorError(FreeplayConfigurationError):
     def __init__(self, flavor_name: str):
         super().__init__(
@@ -23,6 +23,7 @@ class MissingFlavorError(FreeplayConfigurationError):
             'a different model in the Freeplay UI.'
         )
 
+
 class UnsupportedToolSchemaError(FreeplayConfigurationError):
     def __init__(self) -> None:
         super().__init__(
@@ -30,6 +31,20 @@ class UnsupportedToolSchemaError(FreeplayConfigurationError):
         )
 
 
+# Models ==
+
+# A content block a la OpenAI or Anthropic. Intentionally over-permissive to allow schema evolution by the providers.
+@runtime_checkable
+class ContentBlock(Protocol):
+    def model_dump(self) -> Dict[str, Any]:
+        pass
+
+
+# A content/role pair with a type-safe content for common provider recording. If not using a common provider,
+# use {'content': str, 'role': str} to record. If using a common provider, this is usually the `.content` field.
+GenericProviderMessage = Union[Dict[str, Any], ContentBlock]
+
+
 # SDK-Exposed Classes
 @dataclass
 class PromptInfo:
@@ -54,9 +69,11 @@ class FormattedPrompt:
             formatted_prompt_text: Optional[str] = None,
             tool_schema: Optional[List[Dict[str, Any]]] = None
     ):
+        # These two definitions allow us to operate on typed fields unitl we expose them as Any for client use.
+        self._llm_prompt = formatted_prompt
+        self._tool_schema = tool_schema
+
         self.prompt_info = prompt_info
-        self.llm_prompt = formatted_prompt
-        self.tool_schema = tool_schema
         if formatted_prompt_text:
             self.llm_prompt_text = formatted_prompt_text
 
@@ -67,14 +84,22 @@ class FormattedPrompt:
         # Note: messages are **not formatted** for the provider.
         self.messages = messages
 
+    @property
+    # We know this is a list of dict[str,str], but we use Any to avoid typing issues with client SDK libraries, which require strict TypedDict.
+    def llm_prompt(self) -> Any:
+        return self._llm_prompt
+
+    @property
+    def tool_schema(self) -> Any:
+        return self._tool_schema
+
     def all_messages(
             self,
-            new_message: Union[Dict[str, str], AnthropicMessage, OpenAIMessage]
+            new_message: GenericProviderMessage
     ) -> List[Dict[str, Any]]:
-        if isinstance(new_message, AnthropicMessage) or isinstance(new_message, OpenAIMessage):
-            return self.messages + [new_message.to_dict()]
-        elif isinstance(new_message, dict):
-            return self.messages + [new_message]
+        converted_message = convert_provider_message_to_dict(new_message)
+        return self.messages + [converted_message]
+
 
 class BoundPrompt:
     def __init__(
@@ -128,7 +153,7 @@ class BoundPrompt:
             return formatted
 
         raise MissingFlavorError(flavor_name)
-    
+
     @staticmethod
     def __format_tool_schema(flavor_name: str, tool_schema: List[ToolSchema]) -> List[Dict[str, Any]]:
         if flavor_name == 'anthropic_chat':
@@ -144,9 +169,8 @@ class BoundPrompt:
                     'type': 'function'
                 } for tool_schema in tool_schema
             ]
-        
-        raise UnsupportedToolSchemaError()
 
+        raise UnsupportedToolSchemaError()
 
     def format(
             self,
@@ -156,7 +180,7 @@ class BoundPrompt:
         formatted_prompt = BoundPrompt.__format_messages_for_flavor(final_flavor, self.messages)
 
         formatted_tool_schema = BoundPrompt.__format_tool_schema(
-            final_flavor, 
+            final_flavor,
             self.tool_schema
         ) if self.tool_schema else None
 

freeplay/resources/recordings.py

@@ -9,7 +9,7 @@ from freeplay import api_support
 from freeplay.errors import FreeplayClientError, FreeplayError
 from freeplay.llm_parameters import LLMParameters
 from freeplay.model import InputVariables, OpenAIFunctionCall
-from freeplay.resources.prompts import FormattedPrompt, PromptInfo
+from freeplay.resources.prompts import PromptInfo
 from freeplay.resources.sessions import SessionInfo, TraceInfo
 from freeplay.support import CallSupport
 
@@ -53,7 +53,7 @@ class TestRunInfo:
 
 @dataclass
 class RecordPayload:
-    all_messages: List[Dict[str, str]]
+    all_messages: List[Dict[str, Any]]
     inputs: InputVariables
 
     session_info: SessionInfo

freeplay/resources/test_runs.py

@@ -37,6 +37,7 @@ class TestRun:
     def get_test_run_info(self, test_case_id: str) -> TestRunInfo:
         return TestRunInfo(self.test_run_id, test_case_id)
 
+
 @dataclass
 class TestRunResults:
     def __init__(
@@ -62,9 +63,11 @@ class TestRuns:
             testlist: str,
             include_outputs: bool = False,
             name: Optional[str] = None,
-            description: Optional[str] = None
+            description: Optional[str] = None,
+            flavor_name: Optional[str] = None
     ) -> TestRun:
-        test_run = self.call_support.create_test_run(project_id, testlist, include_outputs, name, description)
+        test_run = self.call_support.create_test_run(
+            project_id, testlist, include_outputs, name, description, flavor_name)
         test_cases = [
             TestCase(test_case_id=test_case.id,
                      variables=test_case.variables,

freeplay/support.py

@@ -55,7 +55,7 @@ class TestCaseTestRunResponse:
         self.variables: InputVariables = test_case['variables']
         self.id: str = test_case['test_case_id']
         self.output: Optional[str] = test_case.get('output')
-        self.history: Optional[List[Dict[str, str]]] = test_case.get('history')
+        self.history: Optional[List[Dict[str, Any]]] = test_case.get('history')
 
 
 class TestRunResponse:
@@ -190,7 +190,8 @@ class CallSupport:
             testlist: str,
             include_outputs: bool = False,
             name: Optional[str] = None,
-            description: Optional[str] = None
+            description: Optional[str] = None,
+            flavor_name: Optional[str] = None
     ) -> TestRunResponse:
         response = api_support.post_raw(
             api_key=self.freeplay_api_key,
@@ -199,7 +200,8 @@ class CallSupport:
                 'dataset_name': testlist,
                 'include_outputs': include_outputs,
                 'test_run_name': name,
-                'test_run_description': description
+                'test_run_description': description,
+                'flavor_name': flavor_name
             },
         )
 

freeplay/utils.py

@@ -1,7 +1,7 @@
-import json
-from typing import Dict, Union, Optional, Any
 import importlib.metadata
+import json
 import platform
+from typing import Dict, Union, Optional, Any
 
 import pystache  # type: ignore
 
@@ -70,3 +70,19 @@ def get_user_agent() -> str:
     # Output format
     # Freeplay/0.2.30 (Python/3.11.4; Darwin/23.2.0)
     return f"{sdk_name}/{sdk_version} ({language}/{language_version}; {os_name}/{os_version})"
+
+
+# Recursively convert Pydantic models, lists, and dicts to dict compatible format -- used to allow us to accept
+# provider message shapes (usually generated types) or the default {'content': ..., 'role': ...} shape.
+def convert_provider_message_to_dict(obj: Any) -> Any:
+    if hasattr(obj, 'model_dump'):
+        # Pydantic v2
+        return obj.model_dump(mode='json')
+    elif hasattr(obj, 'dict'):
+        # Pydantic v1
+        return obj.dict(encode_json=True)
+    elif isinstance(obj, dict):
+        return {k: convert_provider_message_to_dict(v) for k, v in obj.items()}
+    elif isinstance(obj, list):
+        return [convert_provider_message_to_dict(item) for item in obj]
+    return obj

{freeplay-0.3.8.dist-info → freeplay-0.3.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplay
-Version: 0.3.8
+Version: 0.3.10
 Summary: 
 License: MIT
 Author: FreePlay Engineering

{freeplay-0.3.8.dist-info → freeplay-0.3.10.dist-info}/RECORD

@@ -8,14 +8,14 @@ freeplay/model.py,sha256=bh3TmINOxvKFxeVO8Uz7ybX28eD1tmO0XLewwLOtS7I,436
 freeplay/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 freeplay/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 freeplay/resources/customer_feedback.py,sha256=bw8MfEOKbGgn4FOyvcADrcs9GhcpNXNTgxKjBjIzywE,899
-freeplay/resources/prompts.py,sha256=g0TPjHdr1A83Vkn-PUrTk0UN2sN9eRq5KBvbLtKKyIs,20880
-freeplay/resources/recordings.py,sha256=28P77nVqPObICUeWFJKY4nTOAqNC6VBmR5_CmSbCRNc,6065
+freeplay/resources/prompts.py,sha256=woSQcJ6QKpiVyhnrp-t9vx6UND6bxDtWjdbMHO3o9sk,21581
+freeplay/resources/recordings.py,sha256=nECoZb159POpOm-pZnJuFrmvFFWSrea665I5YXEYMFY,6048
 freeplay/resources/sessions.py,sha256=Qz5v7VOf1DmQTd1wCOFXnrizlW5WFJT5V8-pq22Ifvg,2793
-freeplay/resources/test_runs.py,sha256=qF4CE4XiX_6epcs5bFKJg73C94YgrJQTxnCJLBERkos,2549
-freeplay/support.py,sha256=57n-Rv3yRBh3Zpg67uIkXZDLtFtk_bGj91IeheqjoDM,8595
-freeplay/utils.py,sha256=roDF_4QYKt93XO_hRdQC_mFAORVuqUWgCVAPXTj_vsU,2488
-freeplay-0.3.8.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
-freeplay-0.3.8.dist-info/METADATA,sha256=oBCXIMM2M-38pzGPblMCglPrmG-0Wro6BE1NC2fxVMQ,1653
-freeplay-0.3.8.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-freeplay-0.3.8.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
-freeplay-0.3.8.dist-info/RECORD,,
+freeplay/resources/test_runs.py,sha256=Tp2N-odInT5XEEWrEsVhdgfnsclOE8n92_C8gTwO2MI,2623
+freeplay/support.py,sha256=RgC-EDMdxKu7iQEHQ16gxt9VGmjHLUbaKi_k0U5YR1I,8686
+freeplay/utils.py,sha256=Xvt4mNLXLL7E6MI2hTuDLV5cl5Y83DgdjCZSyDGMjR0,3187
+freeplay-0.3.10.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
+freeplay-0.3.10.dist-info/METADATA,sha256=hxD6Q6S1B0KN52AxYHanuWOOog_foMudTjIQurIvrQk,1654
+freeplay-0.3.10.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+freeplay-0.3.10.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
+freeplay-0.3.10.dist-info/RECORD,,