freeplay 0.3.18__tar.gz → 0.3.20__tar.gz

{freeplay-0.3.18 → freeplay-0.3.20}/PKG-INFO

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

{freeplay-0.3.18 → freeplay-0.3.20}/pyproject.toml

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

freeplay-0.3.20/src/freeplay/resources/adapters.py

@@ -0,0 +1,236 @@
+import copy
+from dataclasses import dataclass
+from typing import Protocol, Dict, List, Union, Any
+
+from freeplay.errors import FreeplayConfigurationError
+from freeplay.support import MediaType
+
+
+@dataclass
+class TextContent:
+    text: str
+
+
+@dataclass
+class MediaContentUrl:
+    slot_name: str
+    type: MediaType
+    url: str
+
+
+@dataclass
+class MediaContentBase64:
+    slot_name: str
+    type: MediaType
+    content_type: str
+    data: str
+
+
+class MissingFlavorError(FreeplayConfigurationError):
+    def __init__(self, flavor_name: str):
+        super().__init__(
+            f'Configured flavor ({flavor_name}) not found in SDK. Please update your SDK version or configure '
+            'a different model in the Freeplay UI.'
+        )
+
+
+class LLMAdapter(Protocol):
+    def to_llm_syntax(self, messages: List[Dict[str, Any]]) -> Union[str, List[Dict[str, Any]]]:
+        pass
+
+
+class PassthroughAdapter(LLMAdapter):
+    def to_llm_syntax(self, messages: List[Dict[str, Any]]) -> Union[str, List[Dict[str, Any]]]:
+        # We need a deepcopy here to avoid referential equality with the llm_prompt
+        return copy.deepcopy(messages)
+
+
+class AnthropicAdapter(LLMAdapter):
+    def to_llm_syntax(self, messages: List[Dict[str, Any]]) -> Union[str, List[Dict[str, Any]]]:
+        anthropic_messages = []
+
+        for message in messages:
+            if message['role'] == 'system':
+                continue
+            if "has_media" in message and message["has_media"]:
+                anthropic_messages.append({
+                    'role': message['role'],
+                    'content': [self.__map_content(content) for content in message['content']]
+                })
+            else:
+                anthropic_messages.append(copy.deepcopy(message))
+
+        return anthropic_messages
+
+    @staticmethod
+    def __map_content(content: Union[TextContent, MediaContentBase64, MediaContentUrl]) -> Dict[str, Any]:
+        if isinstance(content, TextContent):
+            return {
+                "type": "text",
+                "text": content.text
+            }
+        if content.type == "audio" or content.type == "video":
+            raise ValueError("Anthropic does not support audio or video content")
+
+        media_type = "image" if content.type == "image" else "document"
+        if isinstance(content, MediaContentBase64):
+            return {
+                "type": media_type,
+                "source": {
+                    "type": "base64",
+                    "media_type": content.content_type,
+                    "data": content.data,
+                }
+            }
+        elif isinstance(content, MediaContentUrl):
+            return {
+                "type": media_type,
+                "source": {
+                    "type": "url",
+                    "url": content.url,
+                }
+            }
+        else:
+            raise ValueError(f"Unexpected content type {type(content)}")
+
+
+class OpenAIAdapter(LLMAdapter):
+    def to_llm_syntax(self, messages: List[Dict[str, Any]]) -> Union[str, List[Dict[str, Any]]]:
+        openai_messages = []
+
+        for message in messages:
+            if "has_media" in message and message["has_media"]:
+                openai_messages.append({
+                    'role': message['role'],
+                    'content': [self.__map_content(content) for content in message['content']]
+                })
+            else:
+                openai_messages.append(copy.deepcopy(message))
+
+        return openai_messages
+
+    @staticmethod
+    def __map_content(content: Union[TextContent, MediaContentBase64, MediaContentUrl]) -> Dict[str, Any]:
+        if isinstance(content, TextContent):
+            return {
+                "type": "text",
+                "text": content.text
+            }
+        elif isinstance(content, MediaContentBase64):
+            return OpenAIAdapter.__format_base64_content(content)
+        elif isinstance(content, MediaContentUrl):
+            if content.type != "image":
+                raise ValueError("Message contains a non-image URL, but OpenAI only supports image URLs.")
+
+            return {
+                "type": "image_url",
+                "image_url": {
+                    "url": content.url
+                }
+            }
+        else:
+            raise ValueError(f"Unexpected content type {type(content)}")
+
+    @staticmethod
+    def __format_base64_content(content: MediaContentBase64) -> Dict[str, Any]:
+        if content.type == "audio":
+            return {
+                "type": "input_audio",
+                "input_audio": {
+                    "data": content.data,
+                    "format": content.content_type.split("/")[-1].replace("mpeg", "mp3")
+                }
+            }
+        elif content.type == "file":
+            return {
+                "type": "file",
+                "file": {
+                    "filename": f"{content.slot_name}.{content.content_type.split('/')[-1]}",
+                    "file_data": f"data:{content.content_type};base64,{content.data}"
+                }
+            }
+        else:
+            return {
+                "type": "image_url",
+                "image_url": {
+                    "url": f"data:{content.content_type};base64,{content.data}"
+                }
+            }
+
+
+class Llama3Adapter(LLMAdapter):
+    def to_llm_syntax(self, messages: List[Dict[str, Any]]) -> Union[str, List[Dict[str, Any]]]:
+        if len(messages) < 1:
+            raise ValueError("Must have at least one message to format")
+
+        formatted = "<|begin_of_text|>"
+        for message in messages:
+            formatted += f"<|start_header_id|>{message['role']}<|end_header_id|>\n{message['content']}<|eot_id|>"
+        formatted += "<|start_header_id|>assistant<|end_header_id|>"
+
+        return formatted
+
+
+class GeminiAdapter(LLMAdapter):
+    def to_llm_syntax(self, messages: List[Dict[str, Any]]) -> Union[str, List[Dict[str, Any]]]:
+        if len(messages) < 1:
+            raise ValueError("Must have at least one message to format")
+
+        gemini_messages = []
+
+        for message in messages:
+            if message['role'] == 'system':
+                continue
+
+            if "has_media" in message and message["has_media"]:
+                gemini_messages.append({
+                    "role": self.__translate_role(message["role"]),
+                    "parts": [self.__map_content(content) for content in message['content']]
+                })
+            else:
+                gemini_messages.append({
+                    "role": self.__translate_role(message["role"]),
+                    "parts": [{"text": message["content"]}]
+                })
+
+        return gemini_messages
+
+    @staticmethod
+    def __map_content(content: Union[TextContent, MediaContentBase64, MediaContentUrl]) -> Dict[str, Any]:
+        if isinstance(content, TextContent):
+            return {"text": content.text}
+        elif isinstance(content, MediaContentBase64):
+            return {
+                "inline_data": {
+                    "data": content.data,
+                    "mime_type": content.content_type,
+                }
+            }
+        elif isinstance(content, MediaContentUrl):
+            raise ValueError("Message contains an image URL, but image URLs are not supported by Gemini")
+        else:
+            raise ValueError(f"Unexpected content type {type(content)}")
+
+    @staticmethod
+    def __translate_role(role: str) -> str:
+        if role == "user":
+            return "user"
+        elif role == "assistant":
+            return "model"
+        else:
+            raise ValueError(f"Gemini formatting found unexpected role {role}")
+
+
+def adaptor_for_flavor(flavor_name: str) -> LLMAdapter:
+    if flavor_name in ["baseten_mistral_chat", "mistral_chat", "perplexity_chat"]:
+        return PassthroughAdapter()
+    elif flavor_name in ["azure_openai_chat", "openai_chat"]:
+        return OpenAIAdapter()
+    elif flavor_name == "anthropic_chat":
+        return AnthropicAdapter()
+    elif flavor_name == "llama_3_chat":
+        return Llama3Adapter()
+    elif flavor_name == "gemini_chat":
+        return GeminiAdapter()
+    else:
+        raise MissingFlavorError(flavor_name)

{freeplay-0.3.18 → freeplay-0.3.20}/src/freeplay/resources/prompts.py

@@ -1,4 +1,3 @@
-import copy
 import json
 import logging
 import warnings
@@ -16,6 +15,7 @@ from typing import (
     Union,
     cast,
     runtime_checkable,
+    Literal,
 )
 
 from freeplay.errors import (
@@ -25,26 +25,21 @@ from freeplay.errors import (
 )
 from freeplay.llm_parameters import LLMParameters
 from freeplay.model import InputVariables
+from freeplay.resources.adapters import MissingFlavorError, adaptor_for_flavor, MediaContentBase64, MediaContentUrl, \
+    TextContent
 from freeplay.support import (
     CallSupport,
     PromptTemplate,
     PromptTemplateMetadata,
     PromptTemplates,
-    ToolSchema,
+    TemplateMessage,
+    ToolSchema, TemplateChatMessage, HistoryTemplateMessage, MediaSlot, Role,
 )
 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__(
-            f'Configured flavor ({flavor_name}) not found in SDK. Please update your SDK version or configure '
-            'a different model in the Freeplay UI.'
-        )
-
-
 class UnsupportedToolSchemaError(FreeplayConfigurationError):
     def __init__(self) -> None:
         super().__init__(
@@ -97,12 +92,12 @@ class PromptInfo:
 
 class FormattedPrompt:
     def __init__(
-            self,
-            prompt_info: PromptInfo,
-            messages: List[Dict[str, str]],
-            formatted_prompt: Optional[List[Dict[str, str]]] = None,
-            formatted_prompt_text: Optional[str] = None,
-            tool_schema: Optional[List[Dict[str, Any]]] = None
+        self,
+        prompt_info: PromptInfo,
+        messages: List[Dict[str, str]],
+        formatted_prompt: Optional[List[Dict[str, 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 until we expose them as Any for client use.
         self._llm_prompt = formatted_prompt
@@ -142,63 +137,15 @@ class FormattedPrompt:
 
 class BoundPrompt:
     def __init__(
-            self,
-            prompt_info: PromptInfo,
-            messages: List[Dict[str, str]],
-            tool_schema: Optional[List[ToolSchema]] = None
+        self,
+        prompt_info: PromptInfo,
+        messages: List[Dict[str, Any]],
+        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(
-            flavor_name: str,
-            messages: List[Dict[str, str]]
-    ) -> Union[str, List[Dict[str, str]]]:
-        if flavor_name in [
-            'azure_openai_chat',
-            'openai_chat',
-            'baseten_mistral_chat',
-            'mistral_chat',
-            'perplexity_chat'
-        ]:
-            # We need a deepcopy here to avoid referential equality with the llm_prompt
-            return copy.deepcopy(messages)
-        elif flavor_name == 'anthropic_chat':
-            messages_without_system = [message for message in messages if message['role'] != 'system']
-            return messages_without_system
-        elif flavor_name == 'llama_3_chat':
-            if len(messages) < 1:
-                raise ValueError("Must have at least one message to format")
-
-            formatted = "<|begin_of_text|>"
-            for message in messages:
-                formatted += f"<|start_header_id|>{message['role']}<|end_header_id|>\n{message['content']}<|eot_id|>"
-            formatted += "<|start_header_id|>assistant<|end_header_id|>"
-
-            return formatted
-        elif flavor_name == 'gemini_chat':
-            if len(messages) < 1:
-                raise ValueError("Must have at least one message to format")
-
-            def translate_role(role: str) -> str:
-                if role == "user":
-                    return "user"
-                elif role == "assistant":
-                    return "model"
-                else:
-                    raise ValueError(f"Gemini formatting found unexpected role {role}")
-
-            formatted = [  # type: ignore
-                {'role': translate_role(message['role']), 'parts': [{'text': message['content']}]}
-                for message in messages if message['role'] != 'system'
-            ]
-
-            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':
@@ -218,11 +165,12 @@ class BoundPrompt:
         raise UnsupportedToolSchemaError()
 
     def format(
-            self,
-            flavor_name: Optional[str] = None
+        self,
+        flavor_name: Optional[str] = None
     ) -> FormattedPrompt:
         final_flavor = flavor_name or self.prompt_info.flavor_name
-        formatted_prompt = BoundPrompt.__format_messages_for_flavor(final_flavor, self.messages)
+        adapter = adaptor_for_flavor(final_flavor)
+        formatted_prompt = adapter.to_llm_syntax(self.messages)
 
         formatted_tool_schema = BoundPrompt.__format_tool_schema(
             final_flavor,
@@ -245,12 +193,45 @@ 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[
+    Union[MediaContentBase64, MediaContentUrl]]:
+    media_content: List[Union[MediaContentBase64, MediaContentUrl]] = []
+    for slot in media_slots:
+        file = media_inputs.get(slot.placeholder_name, None)
+        if file is None:
+            continue
+        if isinstance(file, MediaInputUrl):
+            media_content.append(MediaContentUrl(type=slot.type, url=file.url, slot_name=slot.placeholder_name))
+        else:
+            media_content.append(MediaContentBase64(type=slot.type, content_type=file.content_type, data=file.data, slot_name=slot.placeholder_name))
+
+    return media_content
+
+
 class TemplatePrompt:
     def __init__(
-            self,
-            prompt_info: PromptInfo,
-            messages: List[Dict[str, str]],
-            tool_schema: Optional[List[ToolSchema]] = None
+        self,
+        prompt_info: PromptInfo,
+        messages: List[TemplateMessage],
+        tool_schema: Optional[List[ToolSchema]] = None
     ):
         self.prompt_info = prompt_info
         self.tool_schema = tool_schema
@@ -260,11 +241,13 @@ class TemplatePrompt:
         self,
         variables: InputVariables,
         history: Optional[Sequence[ProviderMessage]] = None,
+        media_inputs: Optional[MediaInputMap] = None
     ) -> BoundPrompt:
         # check history for a system message
         history_clean = []
         if history:
-            template_messages_contain_system = any(message.get('role') == 'system' for message in self.messages)
+            template_messages_contain_system = any(
+                message.role == 'system' for message in self.messages if isinstance(message, TemplateChatMessage))
             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'
@@ -274,22 +257,37 @@ class TemplatePrompt:
                 else:
                     history_clean.append(msg)
 
-        has_history_placeholder = {"kind": "history"} in self.messages
+        has_history_placeholder = any(isinstance(message, HistoryTemplateMessage) for message in self.messages)
         if history and not has_history_placeholder:
             raise FreeplayClientError(
                 "History provided for prompt that does not expect history")
         if has_history_placeholder and not history:
             log_freeplay_client_warning("History missing for prompt that expects history")
 
-        bound_messages = []
+        bound_messages: List[Dict[str, Any]] = []
+        if not media_inputs:
+            media_inputs = {}
         for msg in self.messages:
-            if msg.get('kind') == 'history':
+            if isinstance(msg, HistoryTemplateMessage):
                 bound_messages.extend(history_clean)
             else:
-                bound_messages.append({
-                    'role': msg['role'],
-                    'content': bind_template_variables(msg['content'], variables)},
-                )
+                media_content = extract_media_content(media_inputs, msg.media_slots)
+                content = bind_template_variables(msg.content, variables)
+
+                if media_content:
+                    bound_messages.append({
+                        'role': msg.role,
+                        'content': [
+                            TextContent(text=content),
+                            *media_content
+                        ],
+                        'has_media': True,
+                    })
+                else:
+                    bound_messages.append({
+                        'role': msg.role,
+                        'content': content},
+                    )
 
         return BoundPrompt(self.prompt_info, bound_messages, self.tool_schema)
 
@@ -385,7 +383,7 @@ class FilesystemTemplateResolver(TemplateResolver):
                 prompt_template_id=json_dom.get('prompt_template_id'),  # type: ignore
                 prompt_template_version_id=json_dom.get('prompt_template_version_id'),  # type: ignore
                 prompt_template_name=json_dom.get('prompt_template_name'),  # type: ignore
-                content=FilesystemTemplateResolver.__normalize_roles(json_dom['content']),
+                content=FilesystemTemplateResolver.__normalize_messages(json_dom['content']),
                 metadata=PromptTemplateMetadata(
                     provider=FilesystemTemplateResolver.__flavor_to_provider(flavor_name),
                     flavor=flavor_name,
@@ -412,7 +410,7 @@ class FilesystemTemplateResolver(TemplateResolver):
                 prompt_template_id=json_dom.get('prompt_template_id'),  # type: ignore
                 prompt_template_version_id=json_dom.get('prompt_template_version_id'),  # type: ignore
                 prompt_template_name=json_dom.get('name'),  # type: ignore
-                content=FilesystemTemplateResolver.__normalize_roles(json.loads(str(json_dom['content']))),
+                content=FilesystemTemplateResolver.__normalize_messages(json.loads(str(json_dom['content']))),
                 metadata=PromptTemplateMetadata(
                     provider=FilesystemTemplateResolver.__flavor_to_provider(flavor_name),
                     flavor=flavor_name,
@@ -424,14 +422,16 @@ class FilesystemTemplateResolver(TemplateResolver):
             )
 
     @staticmethod
-    def __normalize_roles(messages: List[Dict[str, str]]) -> List[Dict[str, str]]:
-        normalized = []
+    def __normalize_messages(messages: List[Dict[str, Any]]) -> List[TemplateMessage]:
+        normalized: List[TemplateMessage] = []
         for message in messages:
             if 'kind' in message:
-                normalized.append(message)
+                normalized.append(HistoryTemplateMessage(kind="history"))
             else:
                 role = FilesystemTemplateResolver.__role_translations.get(message['role']) or message['role']
-                normalized.append({'role': role, 'content': message['content']})
+                media_slots: List[MediaSlot] = cast(List[MediaSlot], message.get('media_slots', []))
+                normalized.append(
+                    TemplateChatMessage(role=cast(Role, role), content=message['content'], media_slots=media_slots))
         return normalized
 
     @staticmethod
@@ -577,22 +577,23 @@ class Prompts:
         variables: InputVariables,
         history: Optional[Sequence[ProviderMessage]] = None,
         flavor_name: Optional[str] = None,
+        media_inputs: Optional[MediaInputMap] = None,
     ) -> FormattedPrompt:
         bound_prompt = self.get(
             project_id=project_id,
             template_name=template_name,
             environment=environment
-        ).bind(variables=variables, history=history)
+        ).bind(variables=variables, history=history, media_inputs=media_inputs)
 
         return bound_prompt.format(flavor_name)
 
     def get_formatted_by_version_id(
-            self,
-            project_id: str,
-            template_id: str,
-            version_id: str,
-            variables: InputVariables,
-            flavor_name: Optional[str] = None,
+        self,
+        project_id: str,
+        template_id: str,
+        version_id: str,
+        variables: InputVariables,
+        flavor_name: Optional[str] = None,
     ) -> FormattedPrompt:
         bound_prompt = self.get_by_version_id(
             project_id=project_id,

{freeplay-0.3.18 → freeplay-0.3.20}/src/freeplay/resources/recordings.py

@@ -10,7 +10,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 PromptInfo, MediaInputMap, MediaInput, MediaInputUrl
 from freeplay.resources.sessions import SessionInfo, TraceInfo
 from freeplay.support import CallSupport
 
@@ -79,6 +79,7 @@ class RecordPayload:
     session_info: SessionInfo
     prompt_info: PromptInfo
     call_info: CallInfo
+    media_inputs: Optional[MediaInputMap] = None
     tool_schema: Optional[List[Dict[str, Any]]] = None
     response_info: Optional[ResponseInfo] = None
     test_run_info: Optional[TestRunInfo] = None
@@ -100,6 +101,19 @@ 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):
         self.call_support = call_support
@@ -166,6 +180,12 @@ class Recordings:
         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)
+                for name, media_input in record_payload.media_inputs.items()
+            }
+
         try:
             recorded_response = api_support.post_raw(
                 api_key=self.call_support.freeplay_api_key,

{freeplay-0.3.18 → freeplay-0.3.20}/src/freeplay/support.py

@@ -1,6 +1,6 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from json import JSONEncoder
-from typing import Optional, Dict, Any, List, Union
+from typing import Optional, Dict, Any, List, Union, Literal
 
 from freeplay import api_support
 from freeplay.api_support import try_decode
@@ -26,12 +26,38 @@ class ToolSchema:
     parameters: Dict[str, Any]
 
 
+Role = Literal['system', 'user', 'assistant']
+
+
+MediaType = Literal["image", "audio", "video", "file"]
+
+
+@dataclass
+class MediaSlot:
+    type: MediaType
+    placeholder_name: str
+
+
+@dataclass
+class TemplateChatMessage:
+    role: Role
+    content: str
+    media_slots: List[MediaSlot] = field(default_factory=list)
+
+
+@dataclass
+class HistoryTemplateMessage:
+    kind: Literal["history"]
+
+TemplateMessage = Union[HistoryTemplateMessage, TemplateChatMessage]
+
+
 @dataclass
 class PromptTemplate:
     prompt_template_id: str
     prompt_template_version_id: str
     prompt_template_name: str
-    content: List[Dict[str, str]]
+    content: List[TemplateMessage]
     metadata: PromptTemplateMetadata
     project_id: str
     format_version: int