sapiopycommons 2025.4.24a495__tar.gz → 2025.4.25a497__tar.gz

{sapiopycommons-2025.4.24a495 → sapiopycommons-2025.4.25a497}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.4.24a495
+Version: 2025.4.25a497
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2025.4.24a495 → sapiopycommons-2025.4.25a497}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2025.04.24a495'
+version='2025.04.25a497'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2025.4.24a495 → sapiopycommons-2025.4.25a497}/src/sapiopycommons/ai/tool_service_base.py

@@ -7,7 +7,8 @@ from typing import Any
 
 from grpc import ServicerContext
 
-from sapiopycommons.ai.api.fielddefinitions.proto.velox_field_def_pb2 import VeloxFieldDefProto
+from sapiopycommons.ai.api.fielddefinitions.proto.velox_field_def_pb2 import VeloxFieldDefProto, FieldTypeProto, \
+    IntegerProperties, DoubleProperties, SelectionProperties, BooleanProperties
 from sapiopycommons.general.aliases import FieldMap
 from sapiopylib.rest.User import SapioUser
 
@@ -359,6 +360,110 @@ class ToolBase(ABC):
         """
         self.configs.append(field)
 
+    def add_integer_config_field(self, field_name: str, display_name: str, description: str,
+                                 default_value: int, min_value: int = -2**31, max_value: int = 2**31-1) -> None:
+        """
+        Add an integer configuration field to the tool. This field will be used to configure the tool in the plan
+        manager.
+
+        :param field_name: The name of the field.
+        :param display_name: The display name of the field.
+        :param description: The description of the field.
+        :param default_value: The default value of the field.
+        :param min_value: The minimum value of the field.
+        :param max_value: The maximum value of the field.
+        """
+        self.configs.append(VeloxFieldDefProto(
+            data_field_type=FieldTypeProto.INTEGER,
+            data_field_name=field_name,
+            display_name=display_name,
+            description=description,
+            required=True,
+            editable=True,
+            integer_properties=IntegerProperties(
+                default_value=default_value,
+                min_value=min_value,
+                max_value=max_value
+            )
+        ))
+
+    def add_double_config_field(self, field_name: str, display_name: str, description: str, default_value: float,
+                                min_value: float = -10.**120, max_value: float = 10.**120, precision: int = 2) -> None:
+        """
+        Add a double configuration field to the tool. This field will be used to configure the tool in the plan
+        manager.
+
+        :param field_name: The name of the field.
+        :param display_name: The display name of the field.
+        :param description: The description of the field.
+        :param default_value: The default value of the field.
+        :param min_value: The minimum value of the field.
+        :param max_value: The maximum value of the field.
+        :param precision: The precision of the field.
+        """
+        self.configs.append(VeloxFieldDefProto(
+            data_field_type=FieldTypeProto.DOUBLE,
+            data_field_name=field_name,
+            display_name=display_name,
+            description=description,
+            required=True,
+            editable=True,
+            double_properties=DoubleProperties(
+                default_value=default_value,
+                min_value=min_value,
+                max_value=max_value,
+                precision=precision
+            )
+        ))
+
+    def add_list_config_field(self, field_name: str, display_name: str, description: str, default_value: str,
+                              allowed_values: list[str]) -> None:
+        """
+        Add a list configuration field to the tool. This field will be used to configure the tool in the plan
+        manager.
+
+        :param field_name: The name of the field.
+        :param display_name: The display name of the field.
+        :param description: The description of the field.
+        :param default_value: The default value of the field.
+        :param allowed_values: The list of allowed values for the field.
+        """
+        self.configs.append(VeloxFieldDefProto(
+            data_field_type=FieldTypeProto.SELECTION,
+            data_field_name=field_name,
+            display_name=display_name,
+            description=description,
+            required=True,
+            editable=True,
+            selection_properties=SelectionProperties(
+                default_value=default_value,
+                static_list_values=allowed_values,
+            )
+        ))
+
+    def add_boolean_config_field(self, field_name: str, display_name: str, description: str, default_value: bool) \
+            -> None:
+        """
+        Add a boolean configuration field to the tool. This field will be used to configure the tool in the plan
+        manager.
+
+        :param field_name: The name of the field.
+        :param display_name: The display name of the field.
+        :param description: The description of the field.
+        :param default_value: The default value of the field.
+        """
+        self.configs.append(VeloxFieldDefProto(
+            data_field_type=FieldTypeProto.BOOLEAN,
+            data_field_name=field_name,
+            display_name=display_name,
+            description=description,
+            required=True,
+            editable=True,
+            boolean_properties=BooleanProperties(
+                default_value=default_value
+            )
+        ))
+
     def to_proto(self) -> ToolDetails:
         """
         :return: The ToolDetails proto object representing this tool.
@@ -378,7 +483,7 @@ class ToolBase(ABC):
 
         :param message: The message to log.
         """
-        self.logs.append(message)
+        self.logs.append(f"{self.name}: {message}")
 
     @abstractmethod
     def run(self, user: SapioUser, request: ProcessStepRequest, context: ServicerContext) -> list[SapioToolResult]:
@@ -392,3 +497,60 @@ class ToolBase(ABC):
         :return: A SapioToolResults object containing the response data.
         """
         pass
+
+    @staticmethod
+    def get_request_json(request: ProcessStepRequest, index: int = 0) -> list[Any]:
+        """
+        Parse the JSON data from the request object.
+
+        :param request: The request object containing the input data.
+        :param index: The index of the input to parse. Defaults to 0.
+        :return: A list of parsed JSON objects. Each entry in the list represents a separate JSON entry from the input.
+        """
+        entry_data = request.entry_data
+        input_data: list[Any] = [json.loads(x) for x in entry_data[index].entry_data.json_data.entries]
+        return input_data
+
+    @staticmethod
+    def read_from_json(json_data: list[dict[str, Any]], key: str) -> list[Any]:
+        """
+        From a list of dictionaries, return a list of values for the given key from each dictionary. Skips null values.
+
+        :param json_data: The JSON data to read from.
+        :param key: The key to read the values from.
+        :return: A list of values corresponding to the given key in the JSON data.
+        """
+        ret_val: list[Any] = []
+        for entry in json_data:
+            if key in entry:
+                value = entry[key]
+                if isinstance(value, list):
+                    ret_val.extend(value)
+                elif value is not None:
+                    ret_val.append(value)
+        return ret_val
+
+    def get_config_fields(self, request: ProcessStepRequest) -> dict[str, Any]:
+        """
+        Get the configuration fields from the request object.
+
+        :param request: The request object containing the input data.
+        :return: A dictionary of configuration field names and their values.
+        """
+        config_fields: dict[str, Any] = {}
+        # noinspection PyUnresolvedReferences,PyTypeChecker
+        field_defs: dict[str, VeloxFieldDefProto] = {x.data_field_name: x for x in self.to_proto().config_fields}
+        for field, value in request.config_field_values.items():
+            if field not in field_defs:
+                continue
+            field_type: FieldTypeProto = field_defs[field].data_field_type
+            if field_type == FieldTypeProto.BOOLEAN:
+                value = value.bool_value
+            elif field_type == FieldTypeProto.DOUBLE:
+                value = value.double_value
+            elif field_type in [FieldTypeProto.INTEGER, FieldTypeProto.SHORT, FieldTypeProto.LONG, FieldTypeProto.ENUM]:
+                value = value.int_value
+            else:
+                value = value.string_value
+            config_fields[field] = value
+        return config_fields