sapiopycommons 2025.8.22a715__tar.gz → 2025.8.29a719__tar.gz

{sapiopycommons-2025.8.22a715 → sapiopycommons-2025.8.29a719}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.8.22a715
+Version: 2025.8.29a719
 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.8.22a715 → sapiopycommons-2025.8.29a719}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2025.08.22a715'
+version='2025.08.29a719'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2025.8.22a715 → sapiopycommons-2025.8.29a719}/src/sapiopycommons/ai/protoapi/plan/item/item_container_pb2.py

@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n9sapiopycommons/ai/protoapi/plan/item/item_container.proto\"2\n\x0e\x43ontentTypePbo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x12\n\nextensions\x18\x02 \x03(\t\"$\n\x13StepCsvHeaderRowPbo\x12\r\n\x05\x63\x65lls\x18\x01 \x03(\t\"\x1e\n\rStepCsvRowPbo\x12\r\n\x05\x63\x65lls\x18\x01 \x03(\t\"Z\n\x13StepCsvContainerPbo\x12$\n\x06header\x18\x0e \x01(\x0b\x32\x14.StepCsvHeaderRowPbo\x12\x1d\n\x05items\x18\x0f \x03(\x0b\x32\x0e.StepCsvRowPbo\"%\n\x14StepJsonContainerPbo\x12\r\n\x05items\x18\x0f \x03(\t\"%\n\x14StepTextContainerPbo\x12\r\n\x05items\x18\x0f \x03(\t\"\'\n\x16StepBinaryContainerPbo\x12\r\n\x05items\x18\x0f \x03(\x0c\"<\n\x15StepImageContainerPbo\x12\x14\n\x0cimage_format\x18\x01 \x01(\t\x12\r\n\x05items\x18\x0f \x03(\x0c\"\x94\x02\n\x14StepItemContainerPbo\x12%\n\x0c\x63ontent_type\x18\x02 \x01(\x0b\x32\x0f.ContentTypePbo\x12\x34\n\x10\x62inary_container\x18\xff\x0f \x01(\x0b\x32\x17.StepBinaryContainerPboH\x00\x12.\n\rcsv_container\x18\xfe\x0f \x01(\x0b\x32\x14.StepCsvContainerPboH\x00\x12\x30\n\x0ejson_container\x18\xfd\x0f \x01(\x0b\x32\x15.StepJsonContainerPboH\x00\x12\x30\n\x0etext_container\x18\xfc\x0f \x01(\x0b\x32\x15.StepTextContainerPboH\x00\x42\x0b\n\tcontainer*A\n\x0b\x44\x61taTypePbo\x12\n\n\x06\x42INARY\x10\x00\x12\x08\n\x04JSON\x10\x01\x12\x07\n\x03\x43SV\x10\x02\x12\x08\n\x04TEXT\x10\x03\x12\t\n\x05IMAGE\x10\x04\x42 \n\x1c\x63om.velox.protoapi.plan.itemP\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n9sapiopycommons/ai/protoapi/plan/item/item_container.proto\"2\n\x0e\x43ontentTypePbo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x12\n\nextensions\x18\x02 \x03(\t\"$\n\x13StepCsvHeaderRowPbo\x12\r\n\x05\x63\x65lls\x18\x01 \x03(\t\"\x1e\n\rStepCsvRowPbo\x12\r\n\x05\x63\x65lls\x18\x01 \x03(\t\"Z\n\x13StepCsvContainerPbo\x12$\n\x06header\x18\x0e \x01(\x0b\x32\x14.StepCsvHeaderRowPbo\x12\x1d\n\x05items\x18\x0f \x03(\x0b\x32\x0e.StepCsvRowPbo\"%\n\x14StepJsonContainerPbo\x12\r\n\x05items\x18\x0f \x03(\t\"%\n\x14StepTextContainerPbo\x12\r\n\x05items\x18\x0f \x03(\t\"\'\n\x16StepBinaryContainerPbo\x12\r\n\x05items\x18\x0f \x03(\x0c\"<\n\x15StepImageContainerPbo\x12\x14\n\x0cimage_format\x18\x01 \x01(\t\x12\r\n\x05items\x18\x0f \x03(\x0c\"\xac\x02\n\x14StepItemContainerPbo\x12%\n\x0c\x63ontent_type\x18\x02 \x01(\x0b\x32\x0f.ContentTypePbo\x12\x16\n\x0e\x63ontainer_name\x18\x03 \x01(\t\x12\x34\n\x10\x62inary_container\x18\xff\x0f \x01(\x0b\x32\x17.StepBinaryContainerPboH\x00\x12.\n\rcsv_container\x18\xfe\x0f \x01(\x0b\x32\x14.StepCsvContainerPboH\x00\x12\x30\n\x0ejson_container\x18\xfd\x0f \x01(\x0b\x32\x15.StepJsonContainerPboH\x00\x12\x30\n\x0etext_container\x18\xfc\x0f \x01(\x0b\x32\x15.StepTextContainerPboH\x00\x42\x0b\n\tcontainer*A\n\x0b\x44\x61taTypePbo\x12\n\n\x06\x42INARY\x10\x00\x12\x08\n\x04JSON\x10\x01\x12\x07\n\x03\x43SV\x10\x02\x12\x08\n\x04TEXT\x10\x03\x12\t\n\x05IMAGE\x10\x04\x42 \n\x1c\x63om.velox.protoapi.plan.itemP\x01\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -32,8 +32,8 @@ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'sapiopycommons.ai.protoapi.
 if not _descriptor._USE_C_DESCRIPTORS:
   _globals['DESCRIPTOR']._loaded_options = None
   _globals['DESCRIPTOR']._serialized_options = b'\n\034com.velox.protoapi.plan.itemP\001'
-  _globals['_DATATYPEPBO']._serialized_start=735
-  _globals['_DATATYPEPBO']._serialized_end=800
+  _globals['_DATATYPEPBO']._serialized_start=759
+  _globals['_DATATYPEPBO']._serialized_end=824
   _globals['_CONTENTTYPEPBO']._serialized_start=61
   _globals['_CONTENTTYPEPBO']._serialized_end=111
   _globals['_STEPCSVHEADERROWPBO']._serialized_start=113
@@ -51,5 +51,5 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_STEPIMAGECONTAINERPBO']._serialized_start=394
   _globals['_STEPIMAGECONTAINERPBO']._serialized_end=454
   _globals['_STEPITEMCONTAINERPBO']._serialized_start=457
-  _globals['_STEPITEMCONTAINERPBO']._serialized_end=733
+  _globals['_STEPITEMCONTAINERPBO']._serialized_end=757
 # @@protoc_insertion_point(module_scope)

{sapiopycommons-2025.8.22a715 → sapiopycommons-2025.8.29a719}/src/sapiopycommons/ai/protoapi/plan/item/item_container_pb2.pyi

@@ -74,15 +74,17 @@ class StepImageContainerPbo(_message.Message):
     def __init__(self, image_format: _Optional[str] = ..., items: _Optional[_Iterable[bytes]] = ...) -> None: ...
 
 class StepItemContainerPbo(_message.Message):
-    __slots__ = ("content_type", "binary_container", "csv_container", "json_container", "text_container")
+    __slots__ = ("content_type", "container_name", "binary_container", "csv_container", "json_container", "text_container")
     CONTENT_TYPE_FIELD_NUMBER: _ClassVar[int]
+    CONTAINER_NAME_FIELD_NUMBER: _ClassVar[int]
     BINARY_CONTAINER_FIELD_NUMBER: _ClassVar[int]
     CSV_CONTAINER_FIELD_NUMBER: _ClassVar[int]
     JSON_CONTAINER_FIELD_NUMBER: _ClassVar[int]
     TEXT_CONTAINER_FIELD_NUMBER: _ClassVar[int]
     content_type: ContentTypePbo
+    container_name: str
     binary_container: StepBinaryContainerPbo
     csv_container: StepCsvContainerPbo
     json_container: StepJsonContainerPbo
     text_container: StepTextContainerPbo
-    def __init__(self, content_type: _Optional[_Union[ContentTypePbo, _Mapping]] = ..., binary_container: _Optional[_Union[StepBinaryContainerPbo, _Mapping]] = ..., csv_container: _Optional[_Union[StepCsvContainerPbo, _Mapping]] = ..., json_container: _Optional[_Union[StepJsonContainerPbo, _Mapping]] = ..., text_container: _Optional[_Union[StepTextContainerPbo, _Mapping]] = ...) -> None: ...
+    def __init__(self, content_type: _Optional[_Union[ContentTypePbo, _Mapping]] = ..., container_name: _Optional[str] = ..., binary_container: _Optional[_Union[StepBinaryContainerPbo, _Mapping]] = ..., csv_container: _Optional[_Union[StepCsvContainerPbo, _Mapping]] = ..., json_container: _Optional[_Union[StepJsonContainerPbo, _Mapping]] = ..., text_container: _Optional[_Union[StepTextContainerPbo, _Mapping]] = ...) -> None: ...

{sapiopycommons-2025.8.22a715 → sapiopycommons-2025.8.29a719}/src/sapiopycommons/ai/tool_service_base.py

@@ -53,21 +53,26 @@ class BinaryResult(SapioToolResult):
     binary_data: list[bytes]
     content_type: str
     file_extensions: list[str]
+    name: str
 
-    def __init__(self, binary_data: list[bytes], content_type: str = "binary", file_extensions: list[str] = None):
+    def __init__(self, binary_data: list[bytes], content_type: str = "binary", file_extensions: list[str] = None,
+                 name: str | None = None):
         """
         :param binary_data: The binary data as a list of bytes.
         :param content_type: The content type of the data.
         :param file_extensions: A list of file extensions that this binary data can be saved as.
+        :param name: An optional identifying name for this result that will be accessible to the next tool.
         """
         self.binary_data = binary_data
         self.content_type = content_type
         self.file_extensions = file_extensions if file_extensions else []
+        self.name = name
 
     def to_proto(self) -> StepOutputBatchPbo | list[FieldValueMapPbo]:
         return StepOutputBatchPbo(
             item_container=StepItemContainerPbo(
                 content_type=ContentTypePbo(name=self.content_type, extensions=self.file_extensions),
+                container_name=self.name,
                 binary_container=StepBinaryContainerPbo(items=self.binary_data)
             )
         )
@@ -80,21 +85,26 @@ class CsvResult(SapioToolResult):
     csv_data: list[dict[str, Any]]
     content_type: str
     file_extensions: list[str]
+    name: str
 
-    def __init__(self, csv_data: list[dict[str, Any]], content_type: str = "csv", file_extensions: list[str] = None):
+    def __init__(self, csv_data: list[dict[str, Any]], content_type: str = "csv", file_extensions: list[str] = None,
+                 name: str | None = None):
         """
         :param csv_data: The list of CSV data results, provided as a list of dictionaries of column name to value.
         :param content_type: The content type of the data.
         :param file_extensions: A list of file extensions that this binary data can be saved as.
+        :param name: An optional identifying name for this result that will be accessible to the next tool.
         """
         self.csv_data = csv_data
         self.content_type = content_type
         self.file_extensions = file_extensions if file_extensions else ["csv"]
+        self.name = name
 
     def to_proto(self) -> StepOutputBatchPbo | list[FieldValueMapPbo]:
         return StepOutputBatchPbo(
             item_container=StepItemContainerPbo(
                 content_type=ContentTypePbo(name=self.content_type, extensions=self.file_extensions),
+                container_name=self.name,
                 csv_container=StepCsvContainerPbo(
                     header=StepCsvHeaderRowPbo(cells=self.csv_data[0].keys()),
                     items=[StepCsvRowPbo(cells=[str(x) for x in row.values()]) for row in self.csv_data]
@@ -143,22 +153,27 @@ class JsonResult(SapioToolResult):
     json_data: list[Any]
     content_type: str
     file_extensions: list[str]
+    name: str
 
-    def __init__(self, json_data: list[Any], content_type: str = "json", file_extensions: list[str] = None):
+    def __init__(self, json_data: list[Any], content_type: str = "json", file_extensions: list[str] = None,
+                 name: str | None = None):
         """
         :param json_data: The list of JSON data results. Each entry in the list represents a separate JSON object.
             These entries must be able to be serialized to JSON using json.dumps().
         :param content_type: The content type of the data.
         :param file_extensions: A list of file extensions that this binary data can be saved as.
+        :param name: An optional identifying name for this result that will be accessible to the next tool.
         """
         self.json_data = json_data
         self.content_type = content_type
         self.file_extensions = file_extensions if file_extensions else ["json"]
+        self.name = name
 
     def to_proto(self) -> StepOutputBatchPbo | list[FieldValueMapPbo]:
         return StepOutputBatchPbo(
             item_container=StepItemContainerPbo(
                 content_type=ContentTypePbo(name=self.content_type, extensions=self.file_extensions),
+                container_name=self.name,
                 json_container=StepJsonContainerPbo(items=[json.dumps(x) for x in self.json_data])
             )
         )
@@ -171,21 +186,26 @@ class TextResult(SapioToolResult):
     text_data: list[str]
     content_type: str
     file_extensions: list[str]
+    name: str
 
-    def __init__(self, text_data: list[str], content_type: str = "text", file_extensions: list[str] = None):
+    def __init__(self, text_data: list[str], content_type: str = "text", file_extensions: list[str] = None,
+                 name: str | None = None):
         """
         :param text_data: The text data as a list of strings.
         :param content_type: The content type of the data.
         :param file_extensions: A list of file extensions that this binary data can be saved as.
+        :param name: An optional identifying name for this result that will be accessible to the next tool.
         """
         self.text_data = text_data
         self.content_type = content_type
         self.file_extensions = file_extensions if file_extensions else ["txt"]
+        self.name = name
 
     def to_proto(self) -> StepOutputBatchPbo | list[FieldValueMapPbo]:
         return StepOutputBatchPbo(
             item_container=StepItemContainerPbo(
                 content_type=ContentTypePbo(name=self.content_type, extensions=self.file_extensions),
+                container_name=self.name,
                 text_container=StepTextContainerPbo(items=self.text_data)
             )
         )
@@ -817,6 +837,15 @@ class ToolBase(ABC):
         self.logs.append(f"EXCEPTION: {self._name}: {message} - {e}")
         self.logger.error(f"{message}\n{traceback.format_exc()}")
 
+    def get_input_name(self, index: int = 0) -> str | None:
+        """
+        Get the name of the input from the request object.
+
+        :param index: The index of the input to parse. Defaults to 0. Used for tools that accept multiple inputs.
+        :return: The name of the input from the request object, or None if no name is set.
+        """
+        return self.request.input[index].item_container.container_name
+
     def get_input_binary(self, index: int = 0) -> list[bytes]:
         """
         Get the binary data from the request object.