sapiopycommons 2025.4.24a493__py3-none-any.whl → 2025.4.24a494__py3-none-any.whl

sapiopycommons/ai/tool_service_base.py

@@ -6,13 +6,15 @@ from abc import abstractmethod, ABC
 from typing import Any
 
 from grpc import ServicerContext
+
+from sapiopycommons.ai.api.fielddefinitions.proto.velox_field_def_pb2 import VeloxFieldDefProto
 from sapiopycommons.general.aliases import FieldMap
 from sapiopylib.rest.User import SapioUser
 
 from sapiopycommons.ai.api.plan.tool.proto.entry_pb2 import StepEntryOutputData, StepEntryData, StepJsonData, DataType, \
     StepImageData, StepTextData, StepCsvData, StepBinaryData, StepCsvHeaderRow, StepCsvRow
 from sapiopycommons.ai.api.plan.tool.proto.tool_pb2 import ProcessStepRequest, ToolDetailsRequest, ToolDetailsResponse, \
-    ProcessStepResponse, ToolDetails, StepRecord, StepRecordFieldValue
+    ProcessStepResponse, ToolDetails, StepRecord, StepRecordFieldValue, ToolInputDetails, ToolOutputDetails
 from sapiopycommons.ai.api.plan.tool.proto.tool_pb2_grpc import ToolServiceServicer
 from sapiopycommons.ai.api.session.proto.sapio_conn_info_pb2 import SapioConnectionInfo, SapioUserSecretType
 
@@ -185,6 +187,8 @@ class ToolServiceBase(ToolServiceServicer, ABC):
 
     Subclasses must implement the get_details and run methods to provide specific functionality for the tool.
     """
+    tools: list[ToolBase]
+
     def GetToolDetails(self, request: ToolDetailsRequest, context: ServicerContext) -> ToolDetailsResponse:
         try:
             # Convert the SapioConnectionInfo proto object to a SapioUser object.
@@ -212,9 +216,12 @@ class ToolServiceBase(ToolServiceServicer, ABC):
                 else:
                     new_records.extend(data)
             # Return a ProcessStepResponse proto object containing the output data and new records to the caller.
+            # TODO: Return an is_success = true value.
+            # TODO: Allow logging in the tools?
             return ProcessStepResponse(entry_data=entry_data, new_records=new_records)
         except Exception as e:
             # TODO: Do something other than dump the full stack trace into the logs?
+            # TODO: Eventually we'll return an is_success = false value.
             return ProcessStepResponse(log=[traceback.format_exc()])
 
     @staticmethod
@@ -244,6 +251,25 @@ class ToolServiceBase(ToolServiceServicer, ABC):
         """
         return 1
 
+    def _get_tools(self) -> list[ToolBase]:
+        """
+        Get the tools registered with this service.
+        """
+        # If the tools have not been registered, call the register_tools method to do so.
+        if not hasattr(self, "tools"):
+            self.tools = self.register_tools()
+        # If the tools are still not registered, raise an exception.
+        if not self.tools:
+            raise Exception("No tools registered with this service.")
+        return self.tools
+
+    @abstractmethod
+    def register_tools(self) -> list[ToolBase]:
+        """
+        Register the tools with this service.
+        """
+        pass
+
     @abstractmethod
     def get_details(self, user: SapioUser, request: ToolDetailsRequest, context: ServicerContext) -> list[ToolDetails]:
         """
@@ -255,7 +281,81 @@ class ToolServiceBase(ToolServiceServicer, ABC):
         :param context: The gRPC context.
         :return: A ToolDetailsResponse object containing the tool details.
         """
-        pass
+        tool_details: list[ToolDetails] = []
+        for tool in self._get_tools():
+            tool_details.append(tool.to_proto())
+        return tool_details
+
+    @abstractmethod
+    def run(self, user: SapioUser, request: ProcessStepRequest, context: ServicerContext) -> list[SapioToolResult]:
+        """
+        Execute a tool from this service.
+
+        :param user: A user object that can be used to initialize manager classes using DataMgmtServer to query the
+            system.
+        :param request: The request object containing the input data.
+        :param context: The gRPC context.
+        :return: A SapioToolResults object containing the response data.
+        """
+        for tool in self._get_tools():
+            if request.tool_name == tool.name:
+                return tool.run(user, request, context)
+        raise Exception(f"Tool {request.tool_name} not found in registered tools.")
+
+
+class ToolBase(ABC):
+    name: str
+    description: str
+    data_type_name: str | None
+    inputs: list[ToolInputDetails]
+    outputs: list[ToolOutputDetails]
+    configs: list[VeloxFieldDefProto]
+
+    def __init__(self, name: str, description: str, data_type_name: str | None = None):
+        self.name = name
+        self.description = description
+        self.data_type_name = data_type_name
+        self.inputs = []
+        self.outputs = []
+
+    def add_input(self, details: ToolInputDetails) -> None:
+        """
+        Add an input configuration to the tool.
+
+        :param details: The input configuration details.
+        """
+        self.inputs.append(details)
+
+    def add_output(self, details: ToolOutputDetails) -> None:
+        """
+        Add an output configuration to the tool.
+
+        :param details: The output configuration details.
+        """
+        self.outputs.append(details)
+
+    def add_config_field(self, field: VeloxFieldDefProto) -> None:
+        """
+        Add a configuration field to the tool.
+
+        :param field: The configuration field details.
+        """
+        self.configs.append(field)
+
+    def to_proto(self) -> ToolDetails:
+        """
+        Convert this tool to a ToolDetails proto object.
+
+        :return: The ToolDetails proto object.
+        """
+        return ToolDetails(
+            name=self.name,
+            description=self.description,
+            input_configs=self.inputs,
+            output_configs=self.outputs,
+            output_data_type_name=self.data_type_name,
+            config_fields=self.configs
+        )
 
     @abstractmethod
     def run(self, user: SapioUser, request: ProcessStepRequest, context: ServicerContext) -> list[SapioToolResult]:

{sapiopycommons-2025.4.24a493.dist-info → sapiopycommons-2025.4.24a494.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.4.24a493
+Version: 2025.4.24a494
 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.24a493.dist-info → sapiopycommons-2025.4.24a494.dist-info}/RECORD

@@ -1,7 +1,7 @@
 sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/tool_of_tools.py,sha256=zYmQ4rNX-qYQnc-vNDnYZjtv9JgmQAmVVuHfVOdBF3w,46984
-sapiopycommons/ai/tool_service_base.py,sha256=YJoHWTPD10TXXmZUKZIS6ryrV3Xqzt6TWNMNFaD8aQ4,10911
+sapiopycommons/ai/tool_service_base.py,sha256=tftW0TFatccbx47QtfiKcsZaPpOHoOlEfDlrU_IQVUU,14376
 sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def_pb2.py,sha256=qPkyQsREtTLMliV9JB6tC5-NhmdWVWHJr70XNfcAfDI,20605
 sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def_pb2.pyi,sha256=gVXRsuscx9XavKsTcepzXWf0LDAAyQ_J5ZjFK6kPYuo,34028
 sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def_pb2_grpc.py,sha256=4vD4jWanaJ4uclSkFmS7JIz_lwYXDWBE3DomuPjUyII,941
@@ -82,7 +82,7 @@ sapiopycommons/webhook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 sapiopycommons/webhook/webhook_context.py,sha256=D793uLsb1691SalaPnBUk3rOSxn_hYLhdvkaIxjNXss,1909
 sapiopycommons/webhook/webhook_handlers.py,sha256=L0HetSm43NvA5KyW3xbLpGFh2DbAaeZJVtXIEl2fvV8,39689
 sapiopycommons/webhook/webservice_handlers.py,sha256=Y5dHx_UFWFuSqaoPL6Re-fsKYRuxvCWZ8bj6KSZ3jfM,14285
-sapiopycommons-2025.4.24a493.dist-info/METADATA,sha256=FMPyRCRl6p7rmhrM1EEKrCE_Iod4lx7Z2xsy5piQ_kE,3143
-sapiopycommons-2025.4.24a493.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2025.4.24a493.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2025.4.24a493.dist-info/RECORD,,
+sapiopycommons-2025.4.24a494.dist-info/METADATA,sha256=sLGtVufAGHGHXHpjTPI4TYwjcG1ya14ACJRNVWkLPHw,3143
+sapiopycommons-2025.4.24a494.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2025.4.24a494.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2025.4.24a494.dist-info/RECORD,,