freeplay 0.3.7__py3-none-any.whl → 0.3.9__py3-none-any.whl

freeplay/resources/prompts.py

@@ -1,18 +1,19 @@
 import copy
 import json
 from abc import ABC, abstractmethod
-from dataclasses import dataclass
+from dataclasses import asdict, dataclass
+import logging
 from pathlib import Path
-from typing import Dict, Optional, List, cast, Any, Union
+from typing import Dict, Optional, List, Protocol, cast, Any, Union, runtime_checkable
 
 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
+from freeplay.support import CallSupport, ToolSchema
 from freeplay.support import PromptTemplate, PromptTemplates, PromptTemplateMetadata
 from freeplay.utils import bind_template_variables
 
-
+logger = logging.getLogger(__name__)
 class MissingFlavorError(FreeplayConfigurationError):
     def __init__(self, flavor_name: str):
         super().__init__(
@@ -20,6 +21,12 @@ class MissingFlavorError(FreeplayConfigurationError):
             'a different model in the Freeplay UI.'
         )
 
+class UnsupportedToolSchemaError(FreeplayConfigurationError):
+    def __init__(self) -> None:
+        super().__init__(
+            f'Tool schema not supported for this model and provider.'
+        )
+
 
 # SDK-Exposed Classes
 @dataclass
@@ -35,6 +42,13 @@ 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__(
@@ -42,10 +56,14 @@ class FormattedPrompt:
             prompt_info: PromptInfo,
             messages: List[Dict[str, str]],
             formatted_prompt: Optional[List[Dict[str, str]]] = None,
-            formatted_prompt_text: Optional[str] = None
+            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
         if formatted_prompt_text:
             self.llm_prompt_text = formatted_prompt_text
 
@@ -56,21 +74,35 @@ 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: Dict[str, str]
-    ) -> List[Dict[str, str]]:
-        return self.messages + [new_message]
-
+            new_message: Union[Dict[str, str], 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]
 
 class BoundPrompt:
     def __init__(
             self,
             prompt_info: PromptInfo,
-            messages: List[Dict[str, str]]
+            messages: List[Dict[str, str]],
+            tool_schema: Optional[List[ToolSchema]] = None
     ):
         self.prompt_info = prompt_info
         self.messages = messages
+        self.tool_schema = tool_schema
 
     @staticmethod
     def __format_messages_for_flavor(
@@ -113,6 +145,25 @@ 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':
+            return [{
+                'name': tool_schema.name,
+                'description': tool_schema.description,
+                'input_schema': tool_schema.parameters
+            } for tool_schema in tool_schema]
+        elif flavor_name in ['openai_chat', 'azure_openai_chat']:
+            return [
+                {
+                    'function': asdict(tool_schema),
+                    'type': 'function'
+                } for tool_schema in tool_schema
+            ]
+        
+        raise UnsupportedToolSchemaError()
+
 
     def format(
             self,
@@ -121,17 +172,24 @@ class BoundPrompt:
         final_flavor = flavor_name or self.prompt_info.flavor_name
         formatted_prompt = BoundPrompt.__format_messages_for_flavor(final_flavor, self.messages)
 
+        formatted_tool_schema = BoundPrompt.__format_tool_schema(
+            final_flavor, 
+            self.tool_schema
+        ) if self.tool_schema else None
+
         if isinstance(formatted_prompt, str):
             return FormattedPrompt(
                 prompt_info=self.prompt_info,
                 messages=self.messages,
-                formatted_prompt_text=formatted_prompt
+                formatted_prompt_text=formatted_prompt,
+                tool_schema=formatted_tool_schema
             )
         else:
             return FormattedPrompt(
                 prompt_info=self.prompt_info,
                 messages=self.messages,
-                formatted_prompt=formatted_prompt
+                formatted_prompt=formatted_prompt,
+                tool_schema=formatted_tool_schema
             )
 
 
@@ -139,9 +197,11 @@ class TemplatePrompt:
     def __init__(
             self,
             prompt_info: PromptInfo,
-            messages: List[Dict[str, str]]
+            messages: List[Dict[str, str]],
+            tool_schema: Optional[List[ToolSchema]] = None
     ):
         self.prompt_info = prompt_info
+        self.tool_schema = tool_schema
         self.messages = messages
 
     def bind(self, variables: InputVariables, history: Optional[List[Dict[str, str]]] = None) -> BoundPrompt:
@@ -172,7 +232,7 @@ class TemplatePrompt:
                     'content': bind_template_variables(msg['content'], variables)},
                 )
 
-        return BoundPrompt(self.prompt_info, bound_messages)
+        return BoundPrompt(self.prompt_info, bound_messages, self.tool_schema)
 
 
 class TemplateResolver(ABC):
@@ -410,7 +470,7 @@ class Prompts:
             project_id=prompt.project_id
         )
 
-        return TemplatePrompt(prompt_info, prompt.content)
+        return TemplatePrompt(prompt_info, prompt.content, prompt.tool_schema)
 
     def get_by_version_id(self, project_id: str, template_id: str, version_id: str) -> TemplatePrompt:
         prompt = self.template_resolver.get_prompt_version_id(project_id, template_id, version_id)
@@ -443,7 +503,7 @@ class Prompts:
             project_id=prompt.project_id
         )
 
-        return TemplatePrompt(prompt_info, prompt.content)
+        return TemplatePrompt(prompt_info, prompt.content, prompt.tool_schema)
 
     def get_formatted(
             self,

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 PromptInfo
+from freeplay.resources.prompts import FormattedPrompt, PromptInfo
 from freeplay.resources.sessions import SessionInfo, TraceInfo
 from freeplay.support import CallSupport
 
@@ -59,6 +59,7 @@ class RecordPayload:
     session_info: SessionInfo
     prompt_info: PromptInfo
     call_info: CallInfo
+    tool_schema: Optional[List[Dict[str, Any]]] = None
     response_info: Optional[ResponseInfo] = None
     test_run_info: Optional[TestRunInfo] = None
     eval_results: Optional[Dict[str, Union[bool, float]]] = None
@@ -82,6 +83,7 @@ class Recordings:
         record_api_payload = {
             "messages": record_payload.all_messages,
             "inputs": record_payload.inputs,
+            "tool_schema": record_payload.tool_schema,
             "session_info": {"custom_metadata": record_payload.session_info.custom_metadata},
             "prompt_info": {
                 "environment": record_payload.prompt_info.environment,

freeplay/support.py

@@ -16,6 +16,11 @@ class PromptTemplateMetadata:
     params: Optional[Dict[str, Any]] = None
     provider_info: Optional[Dict[str, Any]] = None
 
+@dataclass
+class ToolSchema:
+    name: str
+    description: str
+    parameters: Dict[str, Any]
 
 @dataclass
 class PromptTemplate:
@@ -27,6 +32,7 @@ class PromptTemplate:
     project_id: str
     format_version: int
     environment: Optional[str] = None
+    tool_schema: Optional[List[ToolSchema]] = None
 
 
 @dataclass

{freeplay-0.3.7.dist-info → freeplay-0.3.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplay
-Version: 0.3.7
+Version: 0.3.9
 Summary: 
 License: MIT
 Author: FreePlay Engineering
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: click (==8.1.7)
 Requires-Dist: dacite (>=1.8.0,<2.0.0)
 Requires-Dist: pystache (>=0.6.5,<0.7.0)

{freeplay-0.3.7.dist-info → freeplay-0.3.9.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=Iv-f1o-cBgwzyLfWhcBybTn2zJdc006kf_bNSCMl54o,18895
-freeplay/resources/recordings.py,sha256=kUElo6Yvc6lyo221ghbElx75uxftw7HpgBV_R9gYlE4,5938
+freeplay/resources/prompts.py,sha256=YPjM0YibT-ONWya9PEcllyAeUYOi5rFl_pN0JY-vz6E,21675
+freeplay/resources/recordings.py,sha256=28P77nVqPObICUeWFJKY4nTOAqNC6VBmR5_CmSbCRNc,6065
 freeplay/resources/sessions.py,sha256=Qz5v7VOf1DmQTd1wCOFXnrizlW5WFJT5V8-pq22Ifvg,2793
 freeplay/resources/test_runs.py,sha256=qF4CE4XiX_6epcs5bFKJg73C94YgrJQTxnCJLBERkos,2549
-freeplay/support.py,sha256=nuly_GCWEAEz0CmjlviadKK2_r4X6RdxxiQ6yo78wdk,8449
+freeplay/support.py,sha256=57n-Rv3yRBh3Zpg67uIkXZDLtFtk_bGj91IeheqjoDM,8595
 freeplay/utils.py,sha256=roDF_4QYKt93XO_hRdQC_mFAORVuqUWgCVAPXTj_vsU,2488
-freeplay-0.3.7.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
-freeplay-0.3.7.dist-info/METADATA,sha256=Br__sIy9olEIWT4tFGfZVXGgDYKMJMpM4NgHXoxhSGw,1602
-freeplay-0.3.7.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-freeplay-0.3.7.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
-freeplay-0.3.7.dist-info/RECORD,,
+freeplay-0.3.9.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
+freeplay-0.3.9.dist-info/METADATA,sha256=BQh3WgxEhS5U2tYgb8pRwFH6fyI35Mdw-lD_neIce_8,1653
+freeplay-0.3.9.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+freeplay-0.3.9.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
+freeplay-0.3.9.dist-info/RECORD,,

{freeplay-0.3.7.dist-info → freeplay-0.3.9.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 1.9.1
 Root-Is-Purelib: true
 Tag: py3-none-any