freeplay 0.3.9__tar.gz → 0.3.11__tar.gz

{freeplay-0.3.9 → freeplay-0.3.11}/PKG-INFO

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

{freeplay-0.3.9 → freeplay-0.3.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "freeplay"
-version = "0.3.9"
+version = "0.3.11"
 description = ""
 authors = ["FreePlay Engineering <engineering@freeplay.ai>"]
 license = "MIT"
@@ -16,10 +16,11 @@ pystache = "^0.6.5"
 [tool.poetry.group.dev.dependencies]
 mypy = "^1"
 types-requests = "^2.31"
-anthropic = {extras = ["bedrock"], version = "^0.39.0"}
+anthropic = { extras = ["bedrock"], version = "^0.39.0" }
 openai = "^1"
 boto3 = "^1.34.97"
 google-cloud-aiplatform = "1.51.0"
+httpx = "0.27.2"
 
 [tool.poetry.group.test.dependencies]
 responses = "^0.23.1"

{freeplay-0.3.9 → freeplay-0.3.11}/src/freeplay/resources/prompts.py

@@ -1,19 +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, Protocol, cast, Any, Union, runtime_checkable
+from typing import Dict, Optional, List, Sequence, 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__(
@@ -21,6 +23,7 @@ class MissingFlavorError(FreeplayConfigurationError):
             'a different model in the Freeplay UI.'
         )
 
+
 class UnsupportedToolSchemaError(FreeplayConfigurationError):
     def __init__(self) -> None:
         super().__init__(
@@ -28,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:
@@ -42,13 +59,6 @@ class PromptInfo:
     flavor_name: str
     project_id: str
 
-# Client SDKs (Anthropic and OpenAI) have pydantic types for messages that require strict structures.
-# We want to avoid taking a dependency on the client SDKs, so we instead just ensure they can be converted to a dict,
-# this will ultimately be validated at runtime by the server for any incompatibility.
-@runtime_checkable
-class GenericProviderMessage(Protocol):
-    def to_dict(self) -> Dict[str, Any]:
-        pass
 
 class FormattedPrompt:
     def __init__(
@@ -78,20 +88,18 @@ class FormattedPrompt:
     # 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], GenericProviderMessage]
+            new_message: GenericProviderMessage
     ) -> List[Dict[str, Any]]:
-        # Check if it's a OpenAI or Anthropic message: if it's a provider message object (has to_dict method)
-        if isinstance(new_message, GenericProviderMessage):
-            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__(
@@ -145,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':
@@ -161,9 +169,8 @@ class BoundPrompt:
                     'type': 'function'
                 } for tool_schema in tool_schema
             ]
-        
-        raise UnsupportedToolSchemaError()
 
+        raise UnsupportedToolSchemaError()
 
     def format(
             self,
@@ -173,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
 
@@ -204,12 +211,15 @@ class TemplatePrompt:
         self.tool_schema = tool_schema
         self.messages = messages
 
-    def bind(self, variables: InputVariables, history: Optional[List[Dict[str, str]]] = None) -> BoundPrompt:
+    def bind(self, variables: InputVariables, history: Optional[Sequence[GenericProviderMessage]] = None) -> BoundPrompt:
         # check history for a system message
         history_clean = []
         if history:
-            for msg in history:
-                if (msg.get('role') == 'system') and ('system' in [message.get('role') for message in self.messages]):
+            template_messages_contain_system = any(message.get('role') == 'system' for message in self.messages)
+            history_dict = [convert_provider_message_to_dict(msg) for msg in history]
+            for msg in history_dict:
+                history_has_system = msg.get('role', None) == 'system'
+                if history_has_system and template_messages_contain_system:
                     log_freeplay_client_warning("System message found in history, and prompt template."
                                                 "Removing system message from the history")
                 else:
@@ -334,7 +344,12 @@ class FilesystemTemplateResolver(TemplateResolver):
                     params=metadata.get('params'),
                     provider_info=metadata.get('provider_info')
                 ),
-                project_id=str(json_dom.get('project_id'))
+                project_id=str(json_dom.get('project_id')),
+                tool_schema=[ToolSchema(
+                    name=schema.get('name'),
+                    description=schema.get('description'),
+                    parameters=schema.get('parameters')
+                ) for schema in json_dom.get('tool_schema', [])] if json_dom.get('tool_schema') else None
             )
         else:
             metadata = json_dom['metadata']
@@ -511,7 +526,7 @@ class Prompts:
             template_name: str,
             environment: str,
             variables: InputVariables,
-            history: Optional[List[Dict[str, str]]] = None,
+            history: Optional[Sequence[GenericProviderMessage]] = None,
             flavor_name: Optional[str] = None
     ) -> FormattedPrompt:
         bound_prompt = self.get(

{freeplay-0.3.9 → freeplay-0.3.11}/src/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-0.3.9 → freeplay-0.3.11}/src/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-0.3.9 → freeplay-0.3.11}/src/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-0.3.9 → freeplay-0.3.11}/src/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