freeplay 0.2.32__py3-none-any.whl → 0.2.34__py3-none-any.whl

freeplay/freeplay_cli.py

@@ -9,7 +9,7 @@ import click
 
 from .completions import PromptTemplates, PromptTemplateWithMetadata
 from .errors import FreeplayClientError, FreeplayServerError
-from .freeplay_thin import FreeplayThin
+from .thin import Freeplay
 
 
 @click.group()
@@ -40,13 +40,13 @@ def download(project_id: str, environment: str, output_dir: str) -> None:
     click.echo("Downloading prompts for project %s, environment %s, to directory %s from %s" %
                (project_id, environment, output_dir, freeplay_api_url))
 
-    fp_client = FreeplayThin(
+    fp_client = Freeplay(
         freeplay_api_key=FREEPLAY_API_KEY,
         api_base=freeplay_api_url
     )
 
     try:
-        prompts: PromptTemplates = fp_client.get_prompts(project_id, tag=environment)
+        prompts: PromptTemplates = fp_client.prompts.get_all(project_id, environment=environment)
         click.echo("Found %s prompt templates" % len(prompts.templates))
 
         for prompt in prompts.templates:

freeplay/thin/__init__.py

@@ -0,0 +1,11 @@
+from .freeplay_thin import Freeplay
+from .model import CallInfo, ResponseInfo, RecordPayload, PromptInfo, TestRunInfo
+
+__all__ = [
+    'Freeplay',
+    'CallInfo',
+    'PromptInfo',
+    'RecordPayload',
+    'ResponseInfo',
+    'TestRunInfo',
+]

freeplay/thin/freeplay_thin.py

@@ -0,0 +1,28 @@
+from freeplay.errors import FreeplayConfigurationError
+from freeplay.record import DefaultRecordProcessor
+from freeplay.support import CallSupport
+from freeplay.thin.resources.prompts import Prompts
+from freeplay.thin.resources.recordings import Recordings
+from freeplay.thin.resources.sessions import Sessions
+from freeplay.thin.resources.test_runs import TestRuns
+
+
+class Freeplay:
+    def __init__(
+            self,
+            freeplay_api_key: str,
+            api_base: str
+    ) -> None:
+        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.freeplay_api_key = freeplay_api_key
+        self.api_base = api_base
+
+        # Resources ========
+        self.sessions = Sessions()
+        self.prompts = Prompts(self.call_support)
+        self.test_runs = TestRuns(self.call_support)
+        self.recordings = Recordings(self.call_support)

freeplay/thin/model.py

@@ -0,0 +1,152 @@
+from dataclasses import dataclass
+from typing import Optional, List, cast, Union
+
+from freeplay.completions import OpenAIFunctionCall, ChatMessage
+from freeplay.flavors import Flavor
+from freeplay.llm_parameters import LLMParameters
+from freeplay.model import InputVariables
+from freeplay.utils import bind_template_variables
+
+
+@dataclass
+class CallInfo:
+    provider: str
+    model: str
+    start_time: float
+    end_time: float
+    model_parameters: LLMParameters
+
+
+@dataclass
+class PromptInfo:
+    prompt_template_id: str
+    prompt_template_version_id: str
+    template_name: str
+    environment: str
+    model_parameters: LLMParameters
+    provider: str
+    model: str
+    flavor_name: str
+
+    def get_call_info(self, start_time: float, end_time: float) -> CallInfo:
+        return CallInfo(
+            self.provider,
+            self.model,
+            start_time,
+            end_time,
+            self.model_parameters
+        )
+
+
+@dataclass
+class ResponseInfo:
+    is_complete: bool
+    function_call_response: Optional[OpenAIFunctionCall] = None
+    prompt_tokens: Optional[int] = None
+    response_tokens: Optional[int] = None
+
+
+@dataclass
+class TestRunInfo:
+    test_run_id: str
+    test_case_id: str
+
+
+@dataclass
+class RecordPayload:
+    all_messages: List[dict[str, str]]
+    inputs: InputVariables
+    session_id: str
+
+    prompt_info: PromptInfo
+    call_info: CallInfo
+    response_info: ResponseInfo
+    test_run_info: Optional[TestRunInfo] = None
+
+
+@dataclass
+class Session:
+    session_id: str
+
+
+class FormattedPrompt:
+    def __init__(
+            self,
+            prompt_info: PromptInfo,
+            messages: List[dict[str, str]],
+            formatted_prompt: Union[str, List[dict[str, str]]]
+    ):
+        self.prompt_info = prompt_info
+        self.messages = messages
+        self.llm_prompt = formatted_prompt
+
+    def all_messages(
+            self,
+            new_message: dict[str, str]
+    ) -> List[dict[str, str]]:
+        return self.messages + [new_message]
+
+
+class BoundPrompt:
+    def __init__(
+            self,
+            prompt_info: PromptInfo,
+            messages: List[dict[str, str]]
+    ):
+        self.prompt_info = prompt_info
+        self.messages = messages
+
+    def format(
+            self,
+            flavor_name: Optional[str] = None
+    ) -> FormattedPrompt:
+        final_flavor = flavor_name or self.prompt_info.flavor_name
+        flavor = Flavor.get_by_name(final_flavor)
+        llm_format = flavor.to_llm_syntax(cast(List[ChatMessage], self.messages))
+
+        return FormattedPrompt(
+            self.prompt_info,
+            self.messages,
+            cast(Union[str, List[dict[str, str]]], llm_format)
+        )
+
+
+class TemplatePrompt:
+    def __init__(
+            self,
+            prompt_info: PromptInfo,
+            messages: List[dict[str, str]]
+    ):
+        self.prompt_info = prompt_info
+        self.messages = messages
+
+    def bind(self, variables: InputVariables) -> BoundPrompt:
+        bound_messages = [
+            {'role': message['role'], 'content': bind_template_variables(message['content'], variables)}
+            for message in self.messages
+        ]
+        return BoundPrompt(self.prompt_info, bound_messages)
+
+
+@dataclass
+class TestCase:
+    def __init__(self, test_case_id: str, variables: InputVariables):
+        self.id = test_case_id
+        self.variables = variables
+
+
+@dataclass
+class TestRun:
+    def __init__(
+            self,
+            test_run_id: str,
+            test_cases: List[TestCase]
+    ):
+        self.test_run_id = test_run_id
+        self.test_cases = test_cases
+
+    def get_test_cases(self) -> List[TestCase]:
+        return self.test_cases
+
+    def get_test_run_info(self, test_case_id: str) -> TestRunInfo:
+        return TestRunInfo(self.test_run_id, test_case_id)

freeplay/thin/resources/prompts.py

@@ -0,0 +1,64 @@
+import json
+from typing import Optional
+
+from freeplay.completions import PromptTemplates
+from freeplay.errors import FreeplayConfigurationError
+from freeplay.flavors import Flavor
+from freeplay.model import InputVariables
+from freeplay.support import CallSupport
+from freeplay.thin.model import TemplatePrompt, PromptInfo, FormattedPrompt
+
+
+class Prompts:
+    def __init__(self, call_support: CallSupport) -> None:
+        self.call_support = call_support
+
+    def get_all(self, project_id: str, environment: str) -> PromptTemplates:
+        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_template = self.call_support.get_prompt(
+            project_id=project_id,
+            template_name=template_name,
+            environment=environment
+        )
+
+        messages = json.loads(prompt_template.content)
+
+        params = prompt_template.get_params()
+        model = params.pop('model')
+
+        if not prompt_template.flavor_name:
+            raise FreeplayConfigurationError(
+                "Flavor must be configured in the Freeplay UI. Unable to fulfill request.")
+
+        flavor = Flavor.get_by_name(prompt_template.flavor_name)
+
+        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,
+            environment=environment,
+            model_parameters=params,
+            provider=flavor.provider,
+            model=model,
+            flavor_name=prompt_template.flavor_name
+        )
+
+        return TemplatePrompt(prompt_info, messages)
+
+    def get_formatted(
+            self,
+            project_id: str,
+            template_name: str,
+            environment: str,
+            variables: InputVariables,
+            flavor_name: Optional[str] = None
+    ) -> FormattedPrompt:
+        bound_prompt = self.get(
+            project_id=project_id,
+            template_name=template_name,
+            environment=environment
+        ).bind(variables=variables)
+
+        return bound_prompt.format(flavor_name)

freeplay/thin/resources/recordings.py

@@ -0,0 +1,49 @@
+import json
+
+from freeplay.completions import PromptTemplateWithMetadata
+from freeplay.errors import FreeplayClientError
+from freeplay.record import RecordCallFields
+from freeplay.support import CallSupport
+from freeplay.thin.model import RecordPayload
+
+
+class Recordings:
+    def __init__(self, call_support: CallSupport):
+        self.call_support = call_support
+
+    def create(self, record_payload: RecordPayload) -> None:
+        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.")
+
+        completion = record_payload.all_messages[-1]
+        history_as_string = json.dumps(record_payload.all_messages[0:-1])
+
+        template = PromptTemplateWithMetadata(
+            prompt_template_id=record_payload.prompt_info.prompt_template_id,
+            prompt_template_version_id=record_payload.prompt_info.prompt_template_version_id,
+            name=record_payload.prompt_info.template_name,
+            content=history_as_string,
+            flavor_name=record_payload.prompt_info.flavor_name,
+            params=record_payload.prompt_info.model_parameters
+        )
+
+        self.call_support.record_processor.record_call(
+            RecordCallFields(
+                formatted_prompt=history_as_string,
+                completion_content=completion['content'],
+                completion_is_complete=record_payload.response_info.is_complete,
+                start=record_payload.call_info.start_time,
+                end=record_payload.call_info.end_time,
+                session_id=record_payload.session_id,
+                target_template=template,
+                variables=record_payload.inputs,
+                tag=record_payload.prompt_info.environment,
+                test_run_id=record_payload.test_run_info.test_run_id if record_payload.test_run_info else None,
+                test_case_id=record_payload.test_run_info.test_case_id if record_payload.test_run_info else None,
+                model=record_payload.call_info.model,
+                provider=record_payload.prompt_info.provider,
+                llm_parameters=record_payload.call_info.model_parameters,
+                record_format_type=None  # This is deprecated and unused in the API
+            )
+        )

freeplay/thin/resources/sessions.py

@@ -0,0 +1,9 @@
+import uuid
+
+from freeplay.thin.model import Session
+
+
+class Sessions:
+    # noinspection PyMethodMayBeStatic
+    def create(self) -> Session:
+        return Session(session_id=str(uuid.uuid4()))

freeplay/thin/resources/test_runs.py

@@ -0,0 +1,16 @@
+from freeplay.support import CallSupport
+from freeplay.thin.model import TestRun, TestCase
+
+
+class TestRuns:
+    def __init__(self, call_support: CallSupport) -> None:
+        self.call_support = call_support
+
+    def create(self, project_id: str, testlist: str) -> TestRun:
+        test_run = self.call_support.create_test_run(project_id, testlist)
+        test_cases = [
+            TestCase(test_case_id=test_case.id, variables=test_case.variables)
+            for test_case in test_run.test_cases
+        ]
+
+        return TestRun(test_run.test_run_id, test_cases)

{freeplay-0.2.32.dist-info → freeplay-0.2.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplay
-Version: 0.2.32
+Version: 0.2.34
 Summary: 
 License: MIT
 Author: FreePlay Engineering
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: anthropic (>=0.7.7,<0.8.0)
 Requires-Dist: click (==8.1.7)
 Requires-Dist: dacite (>=1.8.0,<2.0.0)
@@ -48,8 +49,8 @@ fp_client = Freeplay(
 
 # Completion Request
 completion = fp_client.get_completion(project_id=FREEPLAY_PROJECT_ID,
-                                          template_name="template",
-                                          variables={"input_variable_name": "input_variable_value"})
+                                      template_name="template",
+                                      variables={"input_variable_name": "input_variable_value"})
 ```
 
 See the [Freeplay Docs](https://docs.freeplay.ai) for more usage examples and the API reference.

freeplay-0.2.34.dist-info/RECORD

@@ -0,0 +1,27 @@
+freeplay/__init__.py,sha256=74A9S9hmLq9BNHsdx0-37yDxlSukudNl9bJ0TE60Z30,61
+freeplay/api_support.py,sha256=E4Mxa3Lx31TEw_X6o4s9eAR1TSxs0PhFYYaWax6dH2I,2027
+freeplay/completions.py,sha256=F1rMBtQaCtn0rBQqvCurkV25g8gLtwnEod5rRvf-txY,1176
+freeplay/errors.py,sha256=bPqsw32YX-xSr7O-G49M0sSFF7mq-YF1WGq928UV47s,631
+freeplay/flavors.py,sha256=XroBKT8Nf92VTsuC261Nceo9f9stkkpC5CXbi8y4NEs,17236
+freeplay/freeplay.py,sha256=BLlr4YXh3a624xcM93KvZGsiIGSMrIMFM07lLyVCIao,17089
+freeplay/freeplay_cli.py,sha256=k9QPBedcFqpy9Ec9k7DT_y-NpVxHqRF5jKPTaQBBs1Q,3863
+freeplay/llm_parameters.py,sha256=bQbfuC8EICF0XMZQa5pwI3FkQqxmCUVqHO3gYHy3Tg8,898
+freeplay/model.py,sha256=kVARXUEJKbhOdWz7T8eR7npTPXlpaY9wWaEzJvbIvOU,534
+freeplay/provider_config.py,sha256=hruf3Khusrwb76_-hv7ouuxmvJuaRyC1UxIw7XlJx8A,1416
+freeplay/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+freeplay/record.py,sha256=_0uo0rUFZz8kwgWC0JhxFg13JyXgMfAVCkzZsuRLzBA,3354
+freeplay/support.py,sha256=OOnUZOMYnLSEG_3toycWfHb2XZ8meF77uQRllYexXeo,12616
+freeplay/thin/__init__.py,sha256=G9ytYsefgugzUNR7B1cuhLFYumLn3Til5mFHH8lIQRE,243
+freeplay/thin/freeplay_thin.py,sha256=kwCe8vh3YjAqUPbvCwMcRVQxLGDjS-K7CAOuE-yOPiE,1137
+freeplay/thin/model.py,sha256=29jNYKG6ClhtOfOmc_ljUas4JecNHUC3O3SNmyytEDs,3799
+freeplay/thin/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+freeplay/thin/resources/prompts.py,sha256=AUei2sZF0RgP-l6PsyHvTNOxthjOaXvCyDRiYeFFegk,2239
+freeplay/thin/resources/recordings.py,sha256=DgV-l59r95JJmOuJTvhhqV11ZlSb7YNPv3BQRlGT-_o,2356
+freeplay/thin/resources/sessions.py,sha256=EX4VjZBEzUm0-jgUpIuF-eV_QxE458OrwQ1iCsUG7hc,196
+freeplay/thin/resources/test_runs.py,sha256=_B3KcllvHqz0pRlMkKXgXMJIg5vHh2ie1CdWR5e-YnM,569
+freeplay/utils.py,sha256=cRCCIzVqWNDKlTI-DDhXGyCkplbd-X4qzDs__aUpvww,1840
+freeplay-0.2.34.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
+freeplay-0.2.34.dist-info/METADATA,sha256=uAaAyh8GYScvYdy0RPsKEbyfmdym9SG2_7UvpQ8yrWE,1676
+freeplay-0.2.34.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+freeplay-0.2.34.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
+freeplay-0.2.34.dist-info/RECORD,,

{freeplay-0.2.32.dist-info → freeplay-0.2.34.dist-info}/WHEEL

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

freeplay/freeplay_thin.py

@@ -1,22 +0,0 @@
-from .completions import PromptTemplates
-from .errors import FreeplayConfigurationError
-from .record import DefaultRecordProcessor
-from .support import CallSupport
-
-
-class FreeplayThin:
-    def __init__(
-            self,
-            freeplay_api_key: str,
-            api_base: str
-    ) -> None:
-        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.freeplay_api_key = freeplay_api_key
-        self.api_base = api_base
-
-    def get_prompts(self, project_id: str, tag: str) -> PromptTemplates:
-        return self.call_support.get_prompts(project_id=project_id, tag=tag)

freeplay-0.2.32.dist-info/RECORD

@@ -1,20 +0,0 @@
-freeplay/__init__.py,sha256=74A9S9hmLq9BNHsdx0-37yDxlSukudNl9bJ0TE60Z30,61
-freeplay/api_support.py,sha256=E4Mxa3Lx31TEw_X6o4s9eAR1TSxs0PhFYYaWax6dH2I,2027
-freeplay/completions.py,sha256=F1rMBtQaCtn0rBQqvCurkV25g8gLtwnEod5rRvf-txY,1176
-freeplay/errors.py,sha256=bPqsw32YX-xSr7O-G49M0sSFF7mq-YF1WGq928UV47s,631
-freeplay/flavors.py,sha256=XroBKT8Nf92VTsuC261Nceo9f9stkkpC5CXbi8y4NEs,17236
-freeplay/freeplay.py,sha256=BLlr4YXh3a624xcM93KvZGsiIGSMrIMFM07lLyVCIao,17089
-freeplay/freeplay_cli.py,sha256=nasbc_ckSr5-YtUKfg_w-6X1geQZ9s5u79VzRULGsbs,3868
-freeplay/freeplay_thin.py,sha256=WHoVCkS30mDM7ghjDadgfj48BNL5EvaXktUsGfeXlIY,867
-freeplay/llm_parameters.py,sha256=bQbfuC8EICF0XMZQa5pwI3FkQqxmCUVqHO3gYHy3Tg8,898
-freeplay/model.py,sha256=kVARXUEJKbhOdWz7T8eR7npTPXlpaY9wWaEzJvbIvOU,534
-freeplay/provider_config.py,sha256=hruf3Khusrwb76_-hv7ouuxmvJuaRyC1UxIw7XlJx8A,1416
-freeplay/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-freeplay/record.py,sha256=_0uo0rUFZz8kwgWC0JhxFg13JyXgMfAVCkzZsuRLzBA,3354
-freeplay/support.py,sha256=OOnUZOMYnLSEG_3toycWfHb2XZ8meF77uQRllYexXeo,12616
-freeplay/utils.py,sha256=cRCCIzVqWNDKlTI-DDhXGyCkplbd-X4qzDs__aUpvww,1840
-freeplay-0.2.32.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
-freeplay-0.2.32.dist-info/METADATA,sha256=o9MiS7BrkV0M2Erp7bKomeRUBgveiqW6XQf7LLyVA4s,1633
-freeplay-0.2.32.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-freeplay-0.2.32.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
-freeplay-0.2.32.dist-info/RECORD,,