freeplay 0.2.37__py3-none-any.whl → 0.2.38__py3-none-any.whl

freeplay/flavors.py

@@ -28,7 +28,7 @@ class Flavor(ABC):
             return AnthropicClaudeChat()
         else:
             raise FreeplayConfigurationError(
-                'Configured flavor not found in SDK. Please update your SDK version or configure '
+                f'Configured flavor ({flavor_name}) not found in SDK. Please update your SDK version or configure '
                 'a different model in the Freeplay UI.')
 
     @property

freeplay/support.py

@@ -1,6 +1,7 @@
 import json
 import time
 from copy import copy
+from dataclasses import dataclass
 from typing import Dict, Any, Optional, Union, List, Generator
 from uuid import uuid4
 
@@ -37,6 +38,25 @@ class TestRunResponse:
         self.test_run_id = test_run_id
 
 
+@dataclass
+class PromptTemplateMetadata:
+    provider: Optional[str]
+    flavor: Optional[str]
+    model: Optional[str]
+    params: Optional[Dict[str, Any]] = None
+    provider_info: Optional[Dict[str, Any]] = None
+
+
+@dataclass
+class PromptTemplate:
+    prompt_template_id: str
+    prompt_template_version_id: str
+    prompt_template_name: str
+    content: List[Dict[str, str]]
+    metadata: PromptTemplateMetadata
+    format_version: int
+
+
 class CallSupport:
     def __init__(
             self,
@@ -57,10 +77,12 @@ class CallSupport:
             raise FreeplayConfigurationError(f'Could not find template with name "{template_name}"')
         return templates[0]
 
-    def create_session_id(self) -> str:
+    @staticmethod
+    def create_session_id() -> str:
         return str(uuid4())
 
-    def check_all_values_string_or_number(self, metadata: Optional[Dict[str, Union[str, int, float]]]) -> None:
+    @staticmethod
+    def check_all_values_string_or_number(metadata: Optional[Dict[str, Union[str, int, float]]]) -> None:
         if metadata:
             for key, value in metadata.items():
                 if not isinstance(value, (str, int, float)):
@@ -79,9 +101,27 @@ class CallSupport:
         if response.status_code != 201:
             raise freeplay_response_error("Error updating customer feedback", response)
 
-    def get_prompt(self, project_id: str, template_name: str, environment: str) -> PromptTemplateWithMetadata:
-        prompt_templates = self.get_prompts(project_id, environment)
-        return self.find_template_by_name(prompt_templates, template_name)
+    def get_prompt(self, project_id: str, template_name: str, environment: str) -> PromptTemplate:
+        response = api_support.get_raw(
+            api_key=self.freeplay_api_key,
+            url=f'{self.api_base}/v2/projects/{project_id}/prompt-templates/name/{template_name}'
+        )
+
+        if response.status_code != 200:
+            raise freeplay_response_error(
+                f"Error getting prompt template {template_name} in project {project_id} "
+                f"and environment {environment}",
+                response
+            )
+
+        maybe_prompt = try_decode(PromptTemplate, response.content)
+        if maybe_prompt is None:
+            raise FreeplayServerError(
+                f"Error handling prompt {template_name} in project {project_id} "
+                f"and environment {environment}"
+            )
+
+        return maybe_prompt
 
     def get_prompts(self, project_id: str, tag: str) -> PromptTemplates:
         response = api_support.get_raw(

freeplay/thin/freeplay_thin.py

@@ -20,8 +20,11 @@ class Freeplay:
         if not freeplay_api_key or not freeplay_api_key.strip():
             raise FreeplayConfigurationError("Freeplay API key not set. It must be set to the Freeplay API.")
 
-        self.call_support = CallSupport(freeplay_api_key, api_base,
-                                        DefaultRecordProcessor(freeplay_api_key, api_base))
+        self.call_support = CallSupport(
+            freeplay_api_key,
+            api_base,
+            DefaultRecordProcessor(freeplay_api_key, api_base)
+        )
         self.freeplay_api_key = freeplay_api_key
         self.api_base = api_base
 

freeplay/thin/resources/prompts.py

@@ -2,17 +2,18 @@ import json
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Dict, Optional, List, Union, cast
+from typing import Dict, Optional, List, Union, cast, Any
 
 from freeplay.completions import PromptTemplates, ChatMessage, PromptTemplateWithMetadata
-from freeplay.errors import FreeplayConfigurationError
+from freeplay.errors import FreeplayConfigurationError, FreeplayClientError
 from freeplay.flavors import Flavor
 from freeplay.llm_parameters import LLMParameters
 from freeplay.model import InputVariables
-from freeplay.support import CallSupport
+from freeplay.support import CallSupport, PromptTemplate, PromptTemplateMetadata
 from freeplay.utils import bind_template_variables
 
 
+# SDK-Exposed Classes
 @dataclass
 class PromptInfo:
     prompt_template_id: str
@@ -20,6 +21,7 @@ class PromptInfo:
     template_name: str
     environment: str
     model_parameters: LLMParameters
+    provider_info: Optional[Dict[str, Any]]
     provider: str
     model: str
     flavor_name: str
@@ -89,8 +91,21 @@ class TemplateResolver(ABC):
     def get_prompts(self, project_id: str, environment: str) -> PromptTemplates:
         pass
 
+    @abstractmethod
+    def get_prompt(self, project_id: str, template_name: str, environment: str) -> PromptTemplate:
+        pass
+
 
 class FilesystemTemplateResolver(TemplateResolver):
+    # If you think you need a change here, be sure to check the server as the translations must match. Once we have
+    # all the SDKs and all customers on the new common format, this translation can go away.
+    __role_translations = {
+        'system': 'system',
+        'user': 'user',
+        'assistant': 'assistant',
+        'Assistant': 'assistant',
+        'Human': 'user'  # Don't think we ever store this, but in case...
+    }
 
     def __init__(self, freeplay_directory: Path):
         FilesystemTemplateResolver.__validate_freeplay_directory(freeplay_directory)
@@ -117,6 +132,52 @@ class FilesystemTemplateResolver(TemplateResolver):
 
         return PromptTemplates(prompt_list)
 
+    def get_prompt(self, project_id: str, template_name: str, environment: str) -> PromptTemplate:
+        self.__validate_prompt_directory(project_id, environment)
+
+        expected_file: Path = self.prompts_directory / project_id / environment / f"{template_name}.json"
+
+        if not expected_file.exists():
+            raise FreeplayClientError(
+                f"Could not find prompt with name {template_name} for project "
+                f"{project_id} in environment {environment}"
+            )
+
+        json_dom = json.loads(expected_file.read_text())
+
+        format_version = json_dom.get('format_version')
+
+        if format_version == 2:
+            raise NotImplementedError("Cannot yet handle new format bundled prompts")
+
+        flavor_name = json_dom.get('metadata').get('flavor_name')
+        flavor = Flavor.get_by_name(flavor_name)
+
+        params = json_dom.get('metadata').get('params')
+        model = params.pop('model') if 'model' in params else None
+
+        return PromptTemplate(
+            format_version=2,
+            prompt_template_id=json_dom.get('prompt_template_id'),
+            prompt_template_version_id=json_dom.get('prompt_template_version_id'),
+            prompt_template_name=json_dom.get('name'),
+            content=FilesystemTemplateResolver.__normalize_roles(json.loads(json_dom.get('content'))),  # type: ignore
+            metadata=PromptTemplateMetadata(
+                provider=flavor.provider,
+                flavor=flavor_name,
+                model=model,
+                params=params
+            )
+        )
+
+    @staticmethod
+    def __normalize_roles(messages: List[ChatMessage]) -> List[ChatMessage]:
+        normalized = []
+        for message in messages:
+            role = FilesystemTemplateResolver.__role_translations.get(message['role']) or message['role']
+            normalized.append(ChatMessage(role=role, content=message['content']))
+        return normalized
+
     @staticmethod
     def __validate_freeplay_directory(freeplay_directory: Path) -> None:
         if not freeplay_directory.is_dir():
@@ -151,6 +212,13 @@ class APITemplateResolver(TemplateResolver):
             tag=environment
         )
 
+    def get_prompt(self, project_id: str, template_name: str, environment: str) -> PromptTemplate:
+        return self.call_support.get_prompt(
+            project_id=project_id,
+            template_name=template_name,
+            environment=environment
+        )
+
 
 class Prompts:
     def __init__(self, call_support: CallSupport, template_resolver: TemplateResolver) -> None:
@@ -161,32 +229,34 @@ class Prompts:
         return self.call_support.get_prompts(project_id=project_id, tag=environment)
 
     def get(self, project_id: str, template_name: str, environment: str) -> TemplatePrompt:
-        prompt_templates = self.template_resolver.get_prompts(project_id, environment)
-        prompt_template = self.call_support.find_template_by_name(prompt_templates, template_name)
+        prompt = self.template_resolver.get_prompt(project_id, template_name, environment)
 
-        messages = json.loads(prompt_template.content)
+        params = prompt.metadata.params
+        model = prompt.metadata.model
 
-        params = prompt_template.get_params()
-        model = params.pop('model')
+        if not model:
+            raise FreeplayConfigurationError(
+                "Model must be configured in the Freeplay UI. Unable to fulfill request.")
 
-        if not prompt_template.flavor_name:
+        if not prompt.metadata.flavor:
             raise FreeplayConfigurationError(
                 "Flavor must be configured in the Freeplay UI. Unable to fulfill request.")
 
-        flavor = Flavor.get_by_name(prompt_template.flavor_name)
+        flavor = Flavor.get_by_name(prompt.metadata.flavor)
 
         prompt_info = PromptInfo(
-            prompt_template_id=prompt_template.prompt_template_id,
-            prompt_template_version_id=prompt_template.prompt_template_version_id,
-            template_name=prompt_template.name,
+            prompt_template_id=prompt.prompt_template_id,
+            prompt_template_version_id=prompt.prompt_template_version_id,
+            template_name=prompt.prompt_template_name,
             environment=environment,
-            model_parameters=params,
+            model_parameters=cast(LLMParameters, params) or LLMParameters({}),
             provider=flavor.provider,
             model=model,
-            flavor_name=prompt_template.flavor_name
+            flavor_name=prompt.metadata.flavor,
+            provider_info=prompt.metadata.provider_info
         )
 
-        return TemplatePrompt(prompt_info, messages)
+        return TemplatePrompt(prompt_info, prompt.content)
 
     def get_formatted(
             self,

{freeplay-0.2.37.dist-info → freeplay-0.2.38.dist-info}/METADATA

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

{freeplay-0.2.37.dist-info → freeplay-0.2.38.dist-info}/RECORD

@@ -2,7 +2,7 @@ freeplay/__init__.py,sha256=74A9S9hmLq9BNHsdx0-37yDxlSukudNl9bJ0TE60Z30,61
 freeplay/api_support.py,sha256=u8b1e9prlR4_qOcqmFduU7U35ubQt1tWJ6bXhUdsv0c,2240
 freeplay/completions.py,sha256=F1rMBtQaCtn0rBQqvCurkV25g8gLtwnEod5rRvf-txY,1176
 freeplay/errors.py,sha256=bPqsw32YX-xSr7O-G49M0sSFF7mq-YF1WGq928UV47s,631
-freeplay/flavors.py,sha256=IytHc1C1q0ZTJn9T6Mt6oJn6eeTqQBc-9habH7p-T80,17242
+freeplay/flavors.py,sha256=9jVvhym9L5zyWM3RTBViibIgG6f6Fh1_63uMEVZAFT4,17259
 freeplay/freeplay.py,sha256=BLlr4YXh3a624xcM93KvZGsiIGSMrIMFM07lLyVCIao,17089
 freeplay/freeplay_cli.py,sha256=k9QPBedcFqpy9Ec9k7DT_y-NpVxHqRF5jKPTaQBBs1Q,3863
 freeplay/llm_parameters.py,sha256=bQbfuC8EICF0XMZQa5pwI3FkQqxmCUVqHO3gYHy3Tg8,898
@@ -10,18 +10,18 @@ freeplay/model.py,sha256=7BRAuyxsLl8X-ue8wXPmAiKYp4OaYI-HkaGc3t5qtMU,534
 freeplay/provider_config.py,sha256=hruf3Khusrwb76_-hv7ouuxmvJuaRyC1UxIw7XlJx8A,1416
 freeplay/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 freeplay/record.py,sha256=69vO9vYGFL8gLrvRqLzlvodVNo05GOzKDJnCyhUha08,3615
-freeplay/support.py,sha256=KP_rRgn0gh6n5BOGGExHO9pip9Pj22_WSvF6v106kX8,13083
+freeplay/support.py,sha256=tipac902gW1TRICUgxGhO4X645XRglxHHmaqYvqfifo,14197
 freeplay/thin/__init__.py,sha256=XgU_eMmTpOPCa9w5mVOyxPgwAgRFfVdRWDazYGYZtQ0,351
-freeplay/thin/freeplay_thin.py,sha256=raVESB8VWoCSeCsGPDr-DOx37WXi8D27odKnOeDWwV0,1613
+freeplay/thin/freeplay_thin.py,sha256=0w_ECjassczsHJUcpzPxEHUDbiGo7Ey7Ba7vIaWc5ds,1619
 freeplay/thin/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 freeplay/thin/resources/customer_feedback.py,sha256=aTM7Eez7iYmjXSpRqkHxf4pi6xBrzVnMiQCEJVfPGvg,527
-freeplay/thin/resources/prompts.py,sha256=CRsvrIIe59WHTAA1PFvfNOK2x9S-C9zCz_z8XzsIg4w,7142
+freeplay/thin/resources/prompts.py,sha256=3sfH1k1AAXRfgHxfV6Acws0fAiMswgE93auRKWLGVIQ,10135
 freeplay/thin/resources/recordings.py,sha256=utrGTjPPiNt1btI0Hiti9s7VvCYFWqitAx35zrXrOfg,5047
 freeplay/thin/resources/sessions.py,sha256=ioWdeTM9BSrEWKrFH66ysQIw5kCTlCVopJDmWtFgHz0,868
 freeplay/thin/resources/test_runs.py,sha256=L8A1tQHzYg9UmLgbNFtFa8pGXqyrcoyTtSE0sSnd9UE,1267
 freeplay/utils.py,sha256=cRCCIzVqWNDKlTI-DDhXGyCkplbd-X4qzDs__aUpvww,1840
-freeplay-0.2.37.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
-freeplay-0.2.37.dist-info/METADATA,sha256=0QabpMND4wK9yg-3bGxZZJzMKVTikH0v1iLf0HOgyiE,1676
-freeplay-0.2.37.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-freeplay-0.2.37.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
-freeplay-0.2.37.dist-info/RECORD,,
+freeplay-0.2.38.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
+freeplay-0.2.38.dist-info/METADATA,sha256=N9DOEBhiTSyDMCBm9MYBK7XserJj0JxlPhYN96NhrnI,1676
+freeplay-0.2.38.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+freeplay-0.2.38.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
+freeplay-0.2.38.dist-info/RECORD,,