freeplay 0.2.24__tar.gz → 0.2.25__tar.gz

{freeplay-0.2.24 → freeplay-0.2.25}/PKG-INFO

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

{freeplay-0.2.24 → freeplay-0.2.25}/freeplay/freeplay.py

@@ -46,8 +46,20 @@ class CallSupport:
             raise FreeplayConfigurationError(f'Could not find template with name "{template_name}"')
         return templates[0]
 
-    def create_session(self, project_id: str, tag: str, test_run_id: Optional[str] = None) -> JsonDom:
-        request_body = {'test_run_id': test_run_id} if test_run_id is not None else None
+    def create_session(
+            self,
+            project_id: str,
+            tag: str,
+            test_run_id: Optional[str] = None,
+            metadata: Optional[dict[str, str|int|float]] = None
+        ) -> JsonDom:
+        request_body: dict[str, Any] = {}
+        if test_run_id is not None:
+            request_body['test_run_id'] = test_run_id
+        if metadata is not None:
+            check_all_values_string_or_number(metadata)
+            request_body['metadata'] = metadata
+
         response = api_support.post_raw(api_key=self.freeplay_api_key,
                                         url=f'{self.api_base}/projects/{project_id}/sessions/tag/{tag}',
                                         payload=request_body)
@@ -535,9 +547,10 @@ class Freeplay:
             variables: dict[str, str],
             tag: str = default_tag,
             flavor: Optional[Flavor] = None,
+            metadata: Optional[dict[str, str|int|float]] = None,
             **kwargs: Any
     ) -> CompletionResponse:
-        project_session = self.call_support.create_session(project_id, tag)
+        project_session = self.call_support.create_session(project_id, tag, None, metadata)
         prompts = self.call_support.get_prompts(project_id, tag)
         completion_flavor = flavor or self.client_flavor
 
@@ -557,9 +570,10 @@ class Freeplay:
             variables: dict[str, str],
             tag: str = default_tag,
             flavor: Optional[Flavor] = None,
+            metadata: Optional[dict[str, str|int|float]] = None,
             **kwargs: Any
     ) -> Generator[CompletionChunk, None, None]:
-        project_session = self.call_support.create_session(project_id, tag)
+        project_session = self.call_support.create_session(project_id, tag, None, metadata)
         prompts = self.call_support.get_prompts(project_id, tag)
         completion_flavor = flavor or self.client_flavor
 
@@ -597,9 +611,10 @@ class Freeplay:
             template_name: str,
             variables: Variables,
             tag: str = default_tag,
+            metadata: Optional[dict[str, str|int|float]] = None,
             **kwargs: Any
     ) -> Tuple[ChatSession, ChatCompletionResponse]:
-        session = self.__create_chat_session(project_id, tag, template_name, variables)
+        session = self.__create_chat_session(project_id, tag, template_name, variables, metadata)
         completion_response = session.start_chat(**kwargs)
         return session, completion_response
 
@@ -632,17 +647,24 @@ class Freeplay:
             template_name: str,
             variables: Variables,
             tag: str = default_tag,
+            metadata: Optional[dict[str, str|int|float]] = None,
             **kwargs: Any
     ) -> Tuple[ChatSession, Generator[CompletionChunk, None, None]]:
         """Returns a chat session, the base prompt template messages, and a streamed response from the LLM."""
-        session = self.__create_chat_session(project_id, tag, template_name, variables)
+        session = self.__create_chat_session(project_id, tag, template_name, variables, metadata)
         completion_response = session.start_chat_stream(**kwargs)
         return session, completion_response
 
-    def __create_chat_session(self, project_id: str, tag: str, template_name: str, variables: Variables) -> ChatSession:
+    def __create_chat_session(
+            self,
+            project_id: str,
+            tag: str,
+            template_name: str,
+            variables: Variables,
+            metadata: Optional[dict[str, str|int|float]] = None) -> ChatSession:
         chat_flavor = require_chat_flavor(self.client_flavor) if self.client_flavor else None
 
-        project_session = self.call_support.create_session(project_id, tag)
+        project_session = self.call_support.create_session(project_id, tag, None, metadata)
         prompts = self.call_support.get_prompts(project_id, tag)
         return ChatSession(
             self.call_support,
@@ -677,3 +699,9 @@ def require_chat_flavor(flavor: Flavor) -> ChatFlavor:
         raise FreeplayConfigurationError('A Chat flavor is required to start a chat session.')
 
     return flavor
+
+def check_all_values_string_or_number(metadata: Optional[dict[str, str|int|float]]) -> None:
+    if metadata:
+        for key, value in metadata.items():
+            if not isinstance(value, (str, int, float)):
+                raise FreeplayConfigurationError(f"Invalid value for key {key}: Value must be a string or number.")

{freeplay-0.2.24 → freeplay-0.2.25}/pyproject.toml

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