freeplay 0.4.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

freeplay/resources/prompts.py

@@ -8,7 +8,6 @@ from typing import (
     Any,
     Dict,
     List,
-    Literal,
     Optional,
     Protocol,
     Sequence,
@@ -56,7 +55,12 @@ logger = logging.getLogger(__name__)
 class UnsupportedToolSchemaError(FreeplayConfigurationError):
     def __init__(self) -> None:
         super().__init__(
-            f'Tool schema not supported for this model and provider.'
+            'Tool schema not supported for this model and provider.'
+        )
+class VertexAIToolSchemaError(FreeplayConfigurationError):
+    def __init__(self) -> None:
+        super().__init__(
+            'Vertex AI SDK not found. Install google-cloud-aiplatform to get proper Tool objects.'
         )
 
 
@@ -89,19 +93,22 @@ GenericProviderMessage = ProviderMessage
 
 
 # SDK-Exposed Classes
+
 @dataclass
-class PromptInfo:
+class PromptVersionInfo:
+    prompt_template_version_id: str
+    environment: Optional[str]
+
+@dataclass
+class PromptInfo(PromptVersionInfo):
     prompt_template_id: str
     prompt_template_version_id: str
     template_name: str
-    environment: Optional[str]
     model_parameters: LLMParameters
     provider_info: Optional[Dict[str, Any]]
     provider: str
     model: str
     flavor_name: str
-    project_id: str
-
 
 class FormattedPrompt:
     def __init__(
@@ -187,6 +194,21 @@ class BoundPrompt:
                     for tool_schema in tool_schema
                 ]
             }
+        elif flavor_name == "gemini_chat":
+            try:
+                from vertexai.generative_models import Tool, FunctionDeclaration  # type: ignore[import-untyped]
+                
+                function_declarations = [
+                    FunctionDeclaration(
+                        name=tool_schema.name,
+                        description=tool_schema.description,
+                        parameters=tool_schema.parameters
+                    )
+                    for tool_schema in tool_schema
+                ]
+                return [Tool(function_declarations=function_declarations)]
+            except ImportError:
+                raise VertexAIToolSchemaError()
 
         raise UnsupportedToolSchemaError()
 
@@ -471,6 +493,7 @@ class FilesystemTemplateResolver(TemplateResolver):
             'azure_openai_chat': 'azure',
             'anthropic_chat': 'anthropic',
             'openai_chat': 'openai',
+            "gemini_chat": "vertex",
         }
         provider = flavor_provider.get(flavor)
         if not provider:
@@ -540,7 +563,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)
@@ -576,7 +598,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/resources/recordings.py

@@ -1,8 +1,8 @@
 import json
 import logging
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Any, Dict, List, Literal, Optional, Union
-from uuid import UUID
+from uuid import UUID, uuid4
 
 from requests import HTTPError
 
@@ -11,17 +11,17 @@ from freeplay.errors import FreeplayClientError, FreeplayError
 from freeplay.llm_parameters import LLMParameters
 from freeplay.model import (
     InputVariables,
-    MediaInput,
     MediaInputMap,
-    MediaInputUrl,
     OpenAIFunctionCall,
     TestRunInfo,
 )
 from freeplay.resources.prompts import (
     PromptInfo,
+    PromptVersionInfo,
 )
 from freeplay.resources.sessions import SessionInfo, TraceInfo
-from freeplay.support import CallSupport
+from freeplay.support import CallSupport, media_inputs_to_json
+from freeplay.utils import convert_provider_message_to_dict
 
 logger = logging.getLogger(__name__)
 
@@ -37,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
@@ -77,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_version_info: Optional[PromptVersionInfo] = None
+    call_info: Optional[CallInfo] = None
     media_inputs: Optional[MediaInputMap] = None
     tool_schema: Optional[List[Dict[str, Any]]] = None
     response_info: Optional[ResponseInfo] = None
@@ -105,18 +108,7 @@ class RecordResponse:
     completion_id: str
 
 
-def media_inputs_to_json(media_input: MediaInput) -> Dict[str, Any]:
-    if isinstance(media_input, MediaInputUrl):
-        return {
-            "type": media_input.type,
-            "url": media_input.url
-        }
-    else:
-        return {
-            "type": media_input.type,
-            "data": media_input.data,
-            "content_type": media_input.content_type
-        }
+
 
 class Recordings:
     def __init__(self, call_support: CallSupport):
@@ -126,25 +118,33 @@ class Recordings:
         if len(record_payload.all_messages) < 1:
             raise FreeplayClientError("Messages list must have at least one message. "
                                       "The last message should be the current response.")
+        
+        if record_payload.tool_schema is not None:
+            record_payload.tool_schema = [convert_provider_message_to_dict(tool) for tool in record_payload.tool_schema]
 
         record_api_payload: Dict[str, Any] = {
             "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,
-                "prompt_template_version_id": record_payload.prompt_info.prompt_template_version_id,
-            },
-            "call_info": {
+        }
+
+        if record_payload.prompt_version_info is not None:
+            record_api_payload["prompt_info"] = {
+                "environment": record_payload.prompt_version_info.environment,
+                "prompt_template_version_id": record_payload.prompt_version_info.prompt_template_version_id,
+            }
+        
+        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)
@@ -175,15 +175,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)
@@ -193,7 +190,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/resources/test_cases.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 from typing import List, Optional, Dict, Any
 
-from freeplay.model import InputVariables, NormalizedMessage
+from freeplay.model import InputVariables, NormalizedMessage, MediaInputMap
 from freeplay.support import CallSupport, DatasetTestCaseRequest, DatasetTestCasesRetrievalResponse
 
 
@@ -13,12 +13,14 @@ class DatasetTestCase:
             output: Optional[str],
             history: Optional[List[NormalizedMessage]] = None,
             metadata: Optional[Dict[str, str]] = None,
+            media_inputs: Optional[MediaInputMap] = None,
             id: Optional[str] = None, # Only set on retrieval
     ):
         self.inputs = inputs
         self.output = output
         self.history = history
         self.metadata = metadata
+        self.media_inputs = media_inputs
         self.id = id
 
 
@@ -44,7 +46,7 @@ class TestCases:
         return self.create_many(project_id, dataset_id, [test_case])
 
     def create_many(self, project_id: str, dataset_id: str, test_cases: List[DatasetTestCase]) -> Dataset:
-        dataset_test_cases = [DatasetTestCaseRequest(test_case.history, test_case.inputs, test_case.metadata, test_case.output) for test_case in test_cases]
+        dataset_test_cases = [DatasetTestCaseRequest(test_case.history, test_case.inputs, test_case.metadata, test_case.output, test_case.media_inputs) for test_case in test_cases]
         self.call_support.create_test_cases(project_id, dataset_id, dataset_test_cases)
         return Dataset(dataset_id, test_cases)
 

freeplay/resources/test_runs.py

@@ -1,5 +1,6 @@
 import warnings
 from dataclasses import dataclass
+from uuid import UUID
 from typing import Any, Dict, List, Optional, Union
 
 from freeplay.model import InputVariables, MediaInputBase64, MediaInputUrl, TestRunInfo
@@ -117,10 +118,11 @@ class TestRuns:
             include_outputs: bool = False,
             name: Optional[str] = None,
             description: Optional[str] = None,
-            flavor_name: Optional[str] = None
+            flavor_name: Optional[str] = None,
+            target_evaluation_ids: Optional[List[UUID]] = None,
     ) -> TestRun:
         test_run = self.call_support.create_test_run(
-            project_id, testlist, include_outputs, name, description, flavor_name)
+            project_id, testlist, include_outputs, name, description, flavor_name, target_evaluation_ids)
         test_cases = [
             CompletionTestCase(
                 test_case_id=test_case.id,

freeplay/support.py

@@ -1,6 +1,7 @@
 from dataclasses import asdict, dataclass, field
 from json import JSONEncoder
 from typing import Any, Dict, List, Literal, Optional, Union
+from uuid import UUID
 
 from freeplay import api_support
 from freeplay.api_support import try_decode
@@ -11,7 +12,7 @@ from freeplay.model import (
     MediaInputBase64,
     MediaInputUrl,
     NormalizedMessage,
-    TestRunInfo,
+    TestRunInfo, MediaInputMap, MediaInput,
 )
 
 CustomMetadata = Optional[Dict[str, Union[str, int, float, bool]]]
@@ -35,7 +36,6 @@ class ToolSchema:
 
 Role = Literal['system', 'user', 'assistant']
 
-
 MediaType = Literal["image", "audio", "video", "file"]
 
 
@@ -56,6 +56,7 @@ class TemplateChatMessage:
 class HistoryTemplateMessage:
     kind: Literal["history"]
 
+
 TemplateMessage = Union[HistoryTemplateMessage, TemplateChatMessage]
 
 
@@ -94,6 +95,20 @@ class ProjectInfos:
     projects: List[ProjectInfo]
 
 
+def media_inputs_to_json(media_input: MediaInput) -> Dict[str, Any]:
+    if isinstance(media_input, MediaInputUrl):
+        return {
+            "type": media_input.type,
+            "url": media_input.url
+        }
+    else:
+        return {
+            "type": media_input.type,
+            "data": media_input.data,
+            "content_type": media_input.content_type
+        }
+
+
 class PromptTemplateEncoder(JSONEncoder):
     def default(self, prompt_template: PromptTemplate) -> Dict[str, Any]:
         return prompt_template.__dict__
@@ -176,12 +191,19 @@ class TestRunRetrievalResponse:
 
 
 class DatasetTestCaseRequest:
-    def __init__(self, history: Optional[List[NormalizedMessage]], inputs: InputVariables,
-                 metadata: Optional[Dict[str, str]], output: Optional[str]) -> None:
+    def __init__(
+            self,
+            history: Optional[List[NormalizedMessage]],
+            inputs: InputVariables,
+            metadata: Optional[Dict[str, str]],
+            output: Optional[str],
+            media_inputs: Optional[MediaInputMap] = None,
+    ) -> None:
         self.history: Optional[List[NormalizedMessage]] = history
         self.inputs: InputVariables = inputs
         self.metadata: Optional[Dict[str, str]] = metadata
         self.output: Optional[str] = output
+        self.media_inputs = media_inputs
 
 
 class DatasetTestCaseResponse:
@@ -325,7 +347,8 @@ class CallSupport:
             include_outputs: bool = False,
             name: Optional[str] = None,
             description: Optional[str] = None,
-            flavor_name: Optional[str] = None
+            flavor_name: Optional[str] = None,
+            target_evaluation_ids: Optional[List[UUID]] = None
     ) -> TestRunResponse:
         response = api_support.post_raw(
             api_key=self.freeplay_api_key,
@@ -335,7 +358,10 @@ class CallSupport:
                 'include_outputs': include_outputs,
                 'test_run_name': name,
                 'test_run_description': description,
-                'flavor_name': flavor_name
+                'flavor_name': flavor_name,
+                'target_evaluation_ids': [
+                    str(id) for id in target_evaluation_ids
+                ] if target_evaluation_ids is not None else None
             },
         )
 
@@ -403,13 +429,22 @@ class CallSupport:
         if response.status_code != 201:
             raise freeplay_response_error('Error while deleting session.', response)
 
-    def create_test_cases(self, project_id: str, dataset_id: str, test_cases: List[DatasetTestCaseRequest]) -> None:
+    def create_test_cases(
+            self,
+            project_id: str,
+            dataset_id: str,
+            test_cases: List[DatasetTestCaseRequest]
+    ) -> None:
         examples = [
             {
                 "history": test_case.history,
                 "output": test_case.output,
                 "metadata": test_case.metadata,
-                "inputs": test_case.inputs
+                "inputs": test_case.inputs,
+                "media_inputs": {
+                    name: media_inputs_to_json(media_input)
+                    for name, media_input in test_case.media_inputs.items()
+                } if test_case.media_inputs is not None else None
             } for test_case in test_cases]
         payload: Dict[str, Any] = {"examples": examples}
         url = f'{self.api_base}/v2/projects/{project_id}/datasets/id/{dataset_id}/test-cases'

freeplay/utils.py

@@ -75,14 +75,55 @@ def get_user_agent() -> str:
 # 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'):
+    """
+    Convert provider message objects to dictionaries.
+    For Vertex AI objects, automatically converts to camelCase.
+    """
+    # List of possible raw attribute names in Vertex AI objects
+    vertex_raw_attrs = [
+        '_raw_content',      # For Content objects
+        '_raw_tool',         # For Tool objects  
+        '_raw_message',      # For message objects
+        '_raw_candidate',    # For Candidate objects
+        '_raw_response',     # For response objects
+        '_raw_function_declaration',  # For FunctionDeclaration
+        '_raw_generation_config',     # For GenerationConfig
+        '_pb',              # Generic protobuf attribute
+    ]
+    
+    # Check for Vertex AI objects with raw protobuf attributes
+    for attr_name in vertex_raw_attrs:
+        if hasattr(obj, attr_name):
+            raw_obj = getattr(obj, attr_name)
+            if raw_obj is not None:
+                try:
+                    # Use the metaclass to_dict with camelCase conversion
+                    return type(raw_obj).to_dict(
+                        raw_obj,
+                        preserving_proto_field_name=False,  # camelCase
+                        use_integers_for_enums=False,  # Keep as strings (we'll lowercase them)
+                        including_default_value_fields=False  # Exclude defaults
+                    )
+                except:  # noqa: E722
+                    # If we can't convert, continue to the next attribute
+                    pass
+    
+    # For non-Vertex AI objects, use their standard to_dict methods
+    if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')):
+        # Regular to_dict (for Vertex AI wrappers without _raw_* attributes)
+        return obj.to_dict()
+    elif 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):
+        # Handle dictionaries recursively
         return {k: convert_provider_message_to_dict(v) for k, v in obj.items()}
     elif isinstance(obj, list):
+        # Handle lists recursively
         return [convert_provider_message_to_dict(item) for item in obj]
+    
+    # Return as-is for primitive types
     return obj

{freeplay-0.4.1.dist-info → freeplay-0.5.0.dist-info}/METADATA

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

{freeplay-0.4.1.dist-info → freeplay-0.5.0.dist-info}/RECORD

@@ -9,15 +9,15 @@ freeplay/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 freeplay/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 freeplay/resources/adapters.py,sha256=6ZAPpoLeOkUkV1s9VNQNsYrnupV0-sy11zFfKfctM1Y,9296
 freeplay/resources/customer_feedback.py,sha256=6AUgHyOcXIpHvrxGAhsQgmDERvRHKutB6J-GkhkGH6s,928
-freeplay/resources/prompts.py,sha256=83OPxdyCodxLSIhxL8MVEjlKsT6eHwnn_2DErMXyi5A,23299
-freeplay/resources/recordings.py,sha256=pzX7SeEipAMSeiC8RoNekTpMep4APBaoveAh8OCmUlU,9190
+freeplay/resources/prompts.py,sha256=uSLMZrQBZ7LSKniQZj6xhl4xvuD8ue6ltY8g7VE7fOw,24223
+freeplay/resources/recordings.py,sha256=MK3xyPiAAF4z-Y0O8D0ixF-sfqtVbvCHDxQQ8IUXIpg,9466
 freeplay/resources/sessions.py,sha256=dZtd9nq2nH8pmXxQOJitBnN5Jl3kjggDItDcjC69TYo,3883
-freeplay/resources/test_cases.py,sha256=nXL_976RwSJDT6OWDM4GEzbcOzcGkJ9ulvb0XOzCRDM,2240
-freeplay/resources/test_runs.py,sha256=IkqW2LrVrLzFcGtalwP4FV-DeQKKb6Nekvy02FfoH8k,5007
-freeplay/support.py,sha256=9X-utKyM9BkhCLJbPT184ud26Dc69f3DiHjyN8qq0vQ,15266
-freeplay/utils.py,sha256=Xvt4mNLXLL7E6MI2hTuDLV5cl5Y83DgdjCZSyDGMjR0,3187
-freeplay-0.4.1.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
-freeplay-0.4.1.dist-info/METADATA,sha256=BqYvmeKI3Ae6rXuOqvx1Y2GNqOI3JV38BdyR4pG2U-8,1660
-freeplay-0.4.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-freeplay-0.4.1.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
-freeplay-0.4.1.dist-info/RECORD,,
+freeplay/resources/test_cases.py,sha256=yJPtcAk1HznXSiJ8K5PtW_PIO_309LqObs4swBzzcNk,2378
+freeplay/resources/test_runs.py,sha256=ZQ7K2hjNRRiQOx8e4-mXTvPDb7ksTsIzBVlq2utrMNo,5117
+freeplay/support.py,sha256=smTwTTMRyK9NvhY0-uILWD_4Ri-Uw6_QZAagfhfOoJo,16372
+freeplay/utils.py,sha256=OtoSnlDrLEk3MWiXmKFJ4Sw42-1kQ94-d_2ekHT6eUo,5038
+freeplay-0.5.0.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
+freeplay-0.5.0.dist-info/METADATA,sha256=lp6MaftLuzLNzRxMOK9EWScBFwTQiwfb-VdJgim_HQo,1660
+freeplay-0.5.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+freeplay-0.5.0.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
+freeplay-0.5.0.dist-info/RECORD,,

{freeplay-0.4.1.dist-info → freeplay-0.5.0.dist-info}/WHEEL

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