freeplay 0.3.24a0__py3-none-any.whl → 0.3.25__py3-none-any.whl

freeplay/freeplay_cli.py

@@ -50,7 +50,53 @@ def download(project_id: str, environment: str, output_dir: str) -> None:
         click.echo(f"Found {len(prompts.prompt_templates)} prompt templates")
 
         for prompt in prompts.prompt_templates:
-            __write_single_file(environment, output_dir, project_id, prompt)
+            __write_single_file(environment, output_dir, prompt)
+    except FreeplayClientError as e:
+        print(f"Error downloading templates: {e}.\nIs your project ID correct?", file=sys.stderr)
+        exit(1)
+    except FreeplayServerError as e:
+        print(f"Error on Freeplay's servers downloading templates: {e}.\nTry again after a short wait.",
+              file=sys.stderr)
+        exit(2)
+    except Exception as e:
+        print(f"Error downloading templates: {e}", file=sys.stderr)
+        exit(3)
+
+
+@cli.command()
+@click.option("--environment", required=True, help="The environment from which the prompts will be pulled.", default="latest")
+@click.option("--output-dir", required=True, help="The directory where the prompts will be saved.")
+def download_all(environment: str, output_dir: str) -> None:
+    if "FREEPLAY_API_KEY" not in os.environ:
+        print("FREEPLAY_API_KEY is not set. It is required to run the freeplay command.", file=sys.stderr)
+        exit(4)
+
+    if "FREEPLAY_SUBDOMAIN" not in os.environ:
+        print("FREEPLAY_SUBDOMAIN is not set. It is required to run the freeplay command.", file=sys.stderr)
+        exit(4)
+
+    FREEPLAY_API_KEY = os.environ["FREEPLAY_API_KEY"]
+    freeplay_api_url = f'https://{os.environ["FREEPLAY_SUBDOMAIN"]}.freeplay.ai/api'
+
+    if "FREEPLAY_API_URL" in os.environ:
+        freeplay_api_url = f'{os.environ["FREEPLAY_API_URL"]}/api'
+        click.echo("Using URL override for Freeplay specified in the FREEPLAY_API_URL environment variable")
+
+    click.echo(
+        f"Downloading prompts for environment {environment}, "
+        f"to directory {output_dir} from {freeplay_api_url}")
+
+    fp_client = Freeplay(
+        freeplay_api_key=FREEPLAY_API_KEY,
+        api_base=freeplay_api_url
+    )
+
+    try:
+        prompts: PromptTemplates = fp_client.prompts.get_all_for_environment(environment=environment)
+        click.echo(f"Found {len(prompts.prompt_templates)} prompt templates")
+
+        for prompt in prompts.prompt_templates:
+            __write_single_file(environment, output_dir, prompt)
     except FreeplayClientError as e:
         print(f"Error downloading templates: {e}.\nIs your project ID correct?", file=sys.stderr)
         exit(1)
@@ -66,10 +112,9 @@ def download(project_id: str, environment: str, output_dir: str) -> None:
 def __write_single_file(
         environment: str,
         output_dir: str,
-        project_id: str,
         prompt: PromptTemplate
 ) -> None:
-    directory = __root_dir(environment, output_dir, project_id)
+    directory = __root_dir(environment, output_dir, prompt.project_id)
     basename = f'{prompt.prompt_template_name}'
     prompt_path = directory / f'{basename}.json'
     click.echo("Writing prompt file: %s" % prompt_path)
@@ -87,6 +132,6 @@ def __write_single_file(
 
 
 def __root_dir(environment: str, output_dir: str, project_id: str) -> Path:
-    directory = Path(output_dir) / "freeplay" / "prompts" / project_id / environment
+    directory = Path(output_dir).resolve() / "freeplay" / "prompts" / project_id / environment
     os.makedirs(directory, exist_ok=True)
     return directory

freeplay/resources/prompts.py

@@ -557,6 +557,9 @@ class Prompts:
 
         return TemplatePrompt(prompt_info, prompt.content, prompt.tool_schema)
 
+    def get_all_for_environment(self, environment: str) -> PromptTemplates:
+        return self.call_support.get_prompts_for_environment(environment=environment)
+
     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)
 

freeplay/resources/test_runs.py

@@ -1,23 +1,34 @@
 from dataclasses import dataclass
-from typing import List, Optional, Dict
+from typing import List, Optional, Dict, Any
+import warnings
 
 from freeplay.model import InputVariables, TestRunInfo
 from freeplay.support import CallSupport, SummaryStatistics
 
-
 @dataclass
-class TestCase:
+class CompletionTestCase:
     def __init__(
             self,
             test_case_id: str,
             variables: InputVariables,
             output: Optional[str],
-            history: Optional[List[Dict[str, str]]]
+            history: Optional[List[Dict[str, str]]],
+            custom_metadata: Optional[Dict[str, str]]
     ):
         self.id = test_case_id
         self.variables = variables
         self.output = output
         self.history = history
+        self.custom_metadata = custom_metadata
+
+class TestCase(CompletionTestCase):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        warnings.warn(
+            "'TestCase' is deprecated; use 'CompletionTestCase' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)
 
 class TraceTestCase:
     def __init__(
@@ -25,17 +36,18 @@ class TraceTestCase:
             test_case_id: str,
             input: str,
             output: Optional[str],
+            custom_metadata: Optional[Dict[str, str]]
     ):
         self.id = test_case_id
         self.input = input
         self.output = output
-
+        self.custom_metadata = custom_metadata
 @dataclass
 class TestRun:
     def __init__(
             self,
             test_run_id: str,
-            test_cases: List[TestCase] = [],
+            test_cases: List[CompletionTestCase] = [],
             trace_test_cases: List[TraceTestCase] = []
     ):
         self.test_run_id = test_run_id
@@ -46,7 +58,7 @@ class TestRun:
         if self.test_cases and len(self.test_cases) > 0 and self.trace_test_cases and len(self.trace_test_cases) > 0:
             raise ValueError("Test case and trace test case cannot both be present")
 
-    def get_test_cases(self) -> List[TestCase]:
+    def get_test_cases(self) -> List[CompletionTestCase]:
         self.__must_not_be_both_trace_and_completion()
         if len(self.trace_test_cases) > 0:
             raise ValueError("Completion test cases are not present. Please use get_trace_test_cases() instead.")
@@ -93,16 +105,18 @@ class TestRuns:
         test_run = self.call_support.create_test_run(
             project_id, testlist, include_outputs, name, description, flavor_name)
         test_cases = [
-            TestCase(test_case_id=test_case.id,
+            CompletionTestCase(test_case_id=test_case.id,
                      variables=test_case.variables,
                      output=test_case.output,
-                     history=test_case.history)
+                     history=test_case.history,
+                     custom_metadata=test_case.custom_metadata)
             for test_case in test_run.test_cases
         ]
         trace_test_cases = [
             TraceTestCase(test_case_id=test_case.id,
                           input=test_case.input,
-                          output=test_case.output)
+                          output=test_case.output,
+                          custom_metadata=test_case.custom_metadata)
             for test_case in test_run.trace_test_cases
         ]
 

freeplay/support.py

@@ -76,6 +76,17 @@ class SummaryStatistics:
     human_evaluation: Dict[str, Any]
 
 
+@dataclass
+class ProjectInfo:
+    id: str
+    name: str
+
+
+@dataclass
+class ProjectInfos:
+    projects: List[ProjectInfo]
+
+
 class PromptTemplateEncoder(JSONEncoder):
     def default(self, prompt_template: PromptTemplate) -> Dict[str, Any]:
         return prompt_template.__dict__
@@ -89,6 +100,7 @@ class TestCaseTestRunResponse:
         self.history: Optional[List[Dict[str, Any]]] = test_case.get('history')
         self.custom_metadata: Optional[Dict[str, str]] = test_case.get('custom_metadata')
 
+
 class TraceTestCaseTestRunResponse:
     def __init__(self, test_case: Dict[str, Any]):
         self.id: str = test_case['test_case_id']
@@ -96,6 +108,7 @@ class TraceTestCaseTestRunResponse:
         self.output: Optional[str] = test_case.get('output')
         self.custom_metadata: Optional[Dict[str, str]] = test_case.get('custom_metadata')
 
+
 class TestRunResponse:
     def __init__(
             self,
@@ -185,6 +198,26 @@ class CallSupport:
 
         return maybe_prompts
 
+    def get_prompts_for_environment(self, environment: str) -> PromptTemplates:
+        projects_response = api_support.get_raw(
+            api_key=self.freeplay_api_key,
+            url=f'{self.api_base}/v2/projects/all'
+        )
+        if projects_response.status_code != 200:
+            raise freeplay_response_error("Error getting prompt templates", projects_response)
+
+        maybe_projects: Optional[ProjectInfos] = try_decode(ProjectInfos, projects_response.content)
+        if maybe_projects is None:
+            raise FreeplayServerError('Failed to parse list of projects from server')
+
+        prompt_templates = PromptTemplates([])
+        for project in maybe_projects.projects:
+            prompt_templates.prompt_templates.extend(
+                self.get_prompts(project.id, environment).prompt_templates
+            )
+
+        return prompt_templates
+
     def get_prompt(self, project_id: str, template_name: str, environment: str) -> PromptTemplate:
         response = api_support.get_raw(
             api_key=self.freeplay_api_key,

{freeplay-0.3.24a0.dist-info → freeplay-0.3.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: freeplay
-Version: 0.3.24a0
+Version: 0.3.25
 Summary: 
 License: MIT
 Author: FreePlay Engineering

{freeplay-0.3.24a0.dist-info → freeplay-0.3.25.dist-info}/RECORD

@@ -2,22 +2,22 @@ freeplay/__init__.py,sha256=ljXF0vHC3oGgk-vLyJFawr7MZKOj_ExYJJsVdrpqZoM,482
 freeplay/api_support.py,sha256=Kn2x3g6yloHQl3NwFRjbZE9BnIh7d1sgwGwC0mHuvw4,2483
 freeplay/errors.py,sha256=vwotUBldxDzREZOmLUeoiDoZjcvDwgH1AMwKBLhLooE,807
 freeplay/freeplay.py,sha256=J04-erDD6rI2SAje_Nsf3x5Qx-Z6p8gQvGrMRHFWoD4,1602
-freeplay/freeplay_cli.py,sha256=lmdsYwzdpWmUKHz_ieCzB-e6j1EnDHlVw3XIEyP_NEk,3460
+freeplay/freeplay_cli.py,sha256=TFkMt4_gjV9BLmxA9iBaPgdl4QK4qYdN-HLxHm1A1-A,5451
 freeplay/llm_parameters.py,sha256=bQbfuC8EICF0XMZQa5pwI3FkQqxmCUVqHO3gYHy3Tg8,898
 freeplay/model.py,sha256=GI3qPRouwdrBFOPBrcQFt5O0chtlSNvl8jAstePuYlA,1480
 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=bw8MfEOKbGgn4FOyvcADrcs9GhcpNXNTgxKjBjIzywE,899
-freeplay/resources/prompts.py,sha256=mnL1VscMGM7D4ulGf3CBGQKdsSj8I5Wf_6nJEYa7mZI,23353
+freeplay/resources/prompts.py,sha256=7hQU0f6GW3qNqEytsiFOnHY6M5c1O6B0w9QDmNk91n0,23516
 freeplay/resources/recordings.py,sha256=V8KAPWnYAQ2-gqwyAJveD8a_AaBPYT32N_xbPU4S27M,9153
 freeplay/resources/sessions.py,sha256=dZtd9nq2nH8pmXxQOJitBnN5Jl3kjggDItDcjC69TYo,3883
 freeplay/resources/test_cases.py,sha256=nXL_976RwSJDT6OWDM4GEzbcOzcGkJ9ulvb0XOzCRDM,2240
-freeplay/resources/test_runs.py,sha256=snaNOqgwMiIKTRMw2nIGEficVrBdRX6O_zKuGW94k68,3969
-freeplay/support.py,sha256=AcaG6vkmI9r6_eNFoX29eTh4MRjdb4To5wIEm78v7IE,13299
+freeplay/resources/test_runs.py,sha256=u7bBfJ3Ro5DJZQdjCAXj4Xj-3fYmtQIGhy8vJeluJvQ,4668
+freeplay/support.py,sha256=NYk0IBUZtyYJ4h4dyNA4dVG-QT5zsO9MHQ8PuXNFP_4,14297
 freeplay/utils.py,sha256=Xvt4mNLXLL7E6MI2hTuDLV5cl5Y83DgdjCZSyDGMjR0,3187
-freeplay-0.3.24a0.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
-freeplay-0.3.24a0.dist-info/METADATA,sha256=t-Xi5FKYXUv59Wj59dxDar6pXokD8OxFY6EvYbuGSo8,1663
-freeplay-0.3.24a0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-freeplay-0.3.24a0.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
-freeplay-0.3.24a0.dist-info/RECORD,,
+freeplay-0.3.25.dist-info/LICENSE,sha256=_jzIw45hB1XHGxiQ8leZ0GH_X7bR_a8qgxaqnHbCUOo,1064
+freeplay-0.3.25.dist-info/METADATA,sha256=bmBW4iPCJsJYyFpgQ0Q4LbsUE9_Df494gUgtpEg0DC8,1661
+freeplay-0.3.25.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+freeplay-0.3.25.dist-info/entry_points.txt,sha256=32s3rf2UUCqiJT4jnClEXZhdXlvl30uwpcxz-Gsy4UU,54
+freeplay-0.3.25.dist-info/RECORD,,