sapiopycommons 2025.7.18a614__tar.gz → 2025.7.21a626__tar.gz

{sapiopycommons-2025.7.18a614 → sapiopycommons-2025.7.21a626}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.7.18a614
+Version: 2025.7.21a626
 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>
@@ -17,7 +17,7 @@ Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Requires-Dist: databind>=4.5
-Requires-Dist: sapiopylib>=2024.5.24.210
+Requires-Dist: sapiopylib>=2025.4.17.264
 Description-Content-Type: text/markdown
 
 

{sapiopycommons-2025.7.18a614 → sapiopycommons-2025.7.21a626}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2025.07.18a614'
+version='2025.07.21a626'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },
@@ -14,7 +14,7 @@ license = "MPL-2.0"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-        'sapiopylib>=2024.5.24.210', 'databind>=4.5'
+        'sapiopylib>=2025.4.17.264', 'databind>=4.5'
 ]
 classifiers = [
     "Intended Audience :: Developers",

{sapiopycommons-2025.7.18a614 → sapiopycommons-2025.7.21a626}/src/sapiopycommons/ai/api/plan/tool/proto/tool_pb2.py

@@ -34,7 +34,7 @@ from sapiopycommons.ai.api.plan.tool.proto.entry_pb2 import *
 from sapiopycommons.ai.api.plan.proto.step_pb2 import *
 from sapiopycommons.ai.api.session.proto.sapio_conn_info_pb2 import *
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n0sapiopycommons/ai/api/plan/tool/proto/tool.proto\x1a\x39sapiopycommons/ai/api/fielddefinitions/proto/fields.proto\x1a\x42sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def.proto\x1a\x31sapiopycommons/ai/api/plan/tool/proto/entry.proto\x1a+sapiopycommons/ai/api/plan/proto/step.proto\x1a\x39sapiopycommons/ai/api/session/proto/sapio_conn_info.proto\"R\n\x13\x45xampleContainerPbo\x12\x16\n\x0ctext_example\x18\x01 \x01(\tH\x00\x12\x18\n\x0e\x62inary_example\x18\x02 \x01(\x0cH\x00\x42\t\n\x07\x65xample\"\xe9\x01\n\x13ToolIoConfigBasePbo\x12\x14\n\x0c\x63ontent_type\x18\x01 \x01(\t\x12\x11\n\tio_number\x18\x02 \x01(\x05\x12\x14\n\x0c\x64isplay_name\x18\x03 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x04 \x01(\t\x12\x1e\n\x16\x64\x65precated_old_example\x18\x05 \x01(\t\x12/\n\x11structure_example\x18\x06 \x01(\x0b\x32\x14.ExampleContainerPbo\x12-\n\x0ftesting_example\x18\x07 \x01(\x0b\x32\x14.ExampleContainerPbo\"\xd9\x02\n\x13ToolInputDetailsPbo\x12)\n\x0b\x62\x61se_config\x18\x01 \x01(\x0b\x32\x14.ToolIoConfigBasePbo\x12\x12\n\nvalidation\x18\x02 \x01(\t\x12\x1c\n\x0fmin_input_count\x18\x03 \x01(\x05H\x00\x88\x01\x01\x12\x1c\n\x0fmax_input_count\x18\x04 \x01(\x05H\x01\x88\x01\x01\x12\r\n\x05paged\x18\x05 \x01(\x08\x12\x1a\n\rmin_page_size\x18\x06 \x01(\x05H\x02\x88\x01\x01\x12\x1a\n\rmax_page_size\x18\x07 \x01(\x05H\x03\x88\x01\x01\x12\x1e\n\x11max_request_bytes\x18\x08 \x01(\x05H\x04\x88\x01\x01\x42\x12\n\x10_min_input_countB\x12\n\x10_max_input_countB\x10\n\x0e_min_page_sizeB\x10\n\x0e_max_page_sizeB\x14\n\x12_max_request_bytes\"A\n\x14ToolOutputDetailsPbo\x12)\n\x0b\x62\x61se_config\x18\x01 \x01(\x0b\x32\x14.ToolIoConfigBasePbo\"\xab\x03\n\x15ProcessStepRequestPbo\x12+\n\nsapio_user\x18\x01 \x01(\x0b\x32\x17.SapioConnectionInfoPbo\x12\x11\n\ttool_name\x18\x02 \x01(\t\x12\x18\n\x10plan_instance_id\x18\x03 \x01(\x03\x12\x18\n\x10step_instance_id\x18\x04 \x01(\x03\x12\x15\n\rinvocation_id\x18\x05 \x01(\x03\x12%\n\rinput_configs\x18\x06 \x03(\x0b\x32\x0e.StepIoInfoPbo\x12&\n\x0eoutput_configs\x18\x07 \x03(\x0b\x32\x0e.StepIoInfoPbo\x12J\n\x13\x63onfig_field_values\x18\x08 \x03(\x0b\x32-.ProcessStepRequestPbo.ConfigFieldValuesEntry\x12\"\n\x05input\x18\xff\x0f \x03(\x0b\x32\x12.StepInputBatchPbo\x1aH\n\x16\x43onfigFieldValuesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1d\n\x05value\x18\x02 \x01(\x0b\x32\x0e.FieldValuePbo:\x02\x38\x01\"u\n\x16ProcessStepResponsePbo\x12\'\n\x0bnew_records\x18\xfd\x0f \x03(\x0b\x32\x11.FieldValueMapPbo\x12\x0c\n\x03log\x18\xfe\x0f \x03(\t\x12$\n\x06output\x18\xff\x0f \x03(\x0b\x32\x13.StepOutputBatchPbo\"I\n\x15ToolDetailsRequestPbo\x12\x30\n\x0fsapio_conn_info\x18\x01 \x01(\x0b\x32\x17.SapioConnectionInfoPbo\"\xd8\x01\n\x0eToolDetailsPbo\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x1d\n\x15output_data_type_name\x18\x04 \x01(\t\x12+\n\rinput_configs\x18\x05 \x03(\x0b\x32\x14.ToolInputDetailsPbo\x12-\n\x0eoutput_configs\x18\x06 \x03(\x0b\x32\x15.ToolOutputDetailsPbo\x12(\n\rconfig_fields\x18\x07 \x03(\x0b\x32\x11.VeloxFieldDefPbo\"_\n\x16ToolDetailsResponsePbo\x12\x1e\n\x16tool_framework_version\x18\x01 \x01(\x05\x12%\n\x0ctool_details\x18\x02 \x03(\x0b\x32\x0f.ToolDetailsPbo2\x90\x01\n\x0bToolService\x12\x41\n\x0eGetToolDetails\x12\x16.ToolDetailsRequestPbo\x1a\x17.ToolDetailsResponsePbo\x12>\n\x0bProcessData\x12\x16.ProcessStepRequestPbo\x1a\x17.ProcessStepResponsePboB!\n\x1d\x63om.velox.api.plan.tool.protoP\x01P\x00P\x01P\x02P\x03P\x04\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n0sapiopycommons/ai/api/plan/tool/proto/tool.proto\x1a\x39sapiopycommons/ai/api/fielddefinitions/proto/fields.proto\x1a\x42sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def.proto\x1a\x31sapiopycommons/ai/api/plan/tool/proto/entry.proto\x1a+sapiopycommons/ai/api/plan/proto/step.proto\x1a\x39sapiopycommons/ai/api/session/proto/sapio_conn_info.proto\"R\n\x13\x45xampleContainerPbo\x12\x16\n\x0ctext_example\x18\x01 \x01(\tH\x00\x12\x18\n\x0e\x62inary_example\x18\x02 \x01(\x0cH\x00\x42\t\n\x07\x65xample\"\xe9\x01\n\x13ToolIoConfigBasePbo\x12\x14\n\x0c\x63ontent_type\x18\x01 \x01(\t\x12\x11\n\tio_number\x18\x02 \x01(\x05\x12\x14\n\x0c\x64isplay_name\x18\x03 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x04 \x01(\t\x12\x1e\n\x16\x64\x65precated_old_example\x18\x05 \x01(\t\x12/\n\x11structure_example\x18\x06 \x01(\x0b\x32\x14.ExampleContainerPbo\x12-\n\x0ftesting_example\x18\x07 \x01(\x0b\x32\x14.ExampleContainerPbo\"\xd9\x02\n\x13ToolInputDetailsPbo\x12)\n\x0b\x62\x61se_config\x18\x01 \x01(\x0b\x32\x14.ToolIoConfigBasePbo\x12\x12\n\nvalidation\x18\x02 \x01(\t\x12\x1c\n\x0fmin_input_count\x18\x03 \x01(\x05H\x00\x88\x01\x01\x12\x1c\n\x0fmax_input_count\x18\x04 \x01(\x05H\x01\x88\x01\x01\x12\r\n\x05paged\x18\x05 \x01(\x08\x12\x1a\n\rmin_page_size\x18\x06 \x01(\x05H\x02\x88\x01\x01\x12\x1a\n\rmax_page_size\x18\x07 \x01(\x05H\x03\x88\x01\x01\x12\x1e\n\x11max_request_bytes\x18\x08 \x01(\x05H\x04\x88\x01\x01\x42\x12\n\x10_min_input_countB\x12\n\x10_max_input_countB\x10\n\x0e_min_page_sizeB\x10\n\x0e_max_page_sizeB\x14\n\x12_max_request_bytes\"A\n\x14ToolOutputDetailsPbo\x12)\n\x0b\x62\x61se_config\x18\x01 \x01(\x0b\x32\x14.ToolIoConfigBasePbo\"\xd5\x03\n\x15ProcessStepRequestPbo\x12+\n\nsapio_user\x18\x01 \x01(\x0b\x32\x17.SapioConnectionInfoPbo\x12\x11\n\ttool_name\x18\x02 \x01(\t\x12\x18\n\x10plan_instance_id\x18\x03 \x01(\x03\x12\x18\n\x10step_instance_id\x18\x04 \x01(\x03\x12\x15\n\rinvocation_id\x18\x05 \x01(\x03\x12%\n\rinput_configs\x18\x06 \x03(\x0b\x32\x0e.StepIoInfoPbo\x12&\n\x0eoutput_configs\x18\x07 \x03(\x0b\x32\x0e.StepIoInfoPbo\x12J\n\x13\x63onfig_field_values\x18\x08 \x03(\x0b\x32-.ProcessStepRequestPbo.ConfigFieldValuesEntry\x12\x0f\n\x07\x64ry_run\x18\t \x01(\x08\x12\x17\n\x0fverbose_logging\x18\n \x01(\x08\x12\"\n\x05input\x18\xff\x0f \x03(\x0b\x32\x12.StepInputBatchPbo\x1aH\n\x16\x43onfigFieldValuesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1d\n\x05value\x18\x02 \x01(\x0b\x32\x0e.FieldValuePbo:\x02\x38\x01\"\xbc\x01\n\x16ProcessStepResponsePbo\x12-\n\x06status\x18\x01 \x01(\x0e\x32\x1d.ProcessStepResponseStatusPbo\x12\x16\n\x0estatus_message\x18\x02 \x01(\t\x12\'\n\x0bnew_records\x18\xfd\x0f \x03(\x0b\x32\x11.FieldValueMapPbo\x12\x0c\n\x03log\x18\xfe\x0f \x03(\t\x12$\n\x06output\x18\xff\x0f \x03(\x0b\x32\x13.StepOutputBatchPbo\"I\n\x15ToolDetailsRequestPbo\x12\x30\n\x0fsapio_conn_info\x18\x01 \x01(\x0b\x32\x17.SapioConnectionInfoPbo\"\xd8\x01\n\x0eToolDetailsPbo\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x1d\n\x15output_data_type_name\x18\x04 \x01(\t\x12+\n\rinput_configs\x18\x05 \x03(\x0b\x32\x14.ToolInputDetailsPbo\x12-\n\x0eoutput_configs\x18\x06 \x03(\x0b\x32\x15.ToolOutputDetailsPbo\x12(\n\rconfig_fields\x18\x07 \x03(\x0b\x32\x11.VeloxFieldDefPbo\"_\n\x16ToolDetailsResponsePbo\x12\x1e\n\x16tool_framework_version\x18\x01 \x01(\x05\x12%\n\x0ctool_details\x18\x02 \x03(\x0b\x32\x0f.ToolDetailsPbo*E\n\x1cProcessStepResponseStatusPbo\x12\x0b\n\x07UNKNOWN\x10\x00\x12\x0b\n\x07SUCCESS\x10\x01\x12\x0b\n\x07\x46\x41ILURE\x10\x02\x32\x90\x01\n\x0bToolService\x12\x41\n\x0eGetToolDetails\x12\x16.ToolDetailsRequestPbo\x1a\x17.ToolDetailsResponsePbo\x12>\n\x0bProcessData\x12\x16.ProcessStepRequestPbo\x1a\x17.ProcessStepResponsePboB!\n\x1d\x63om.velox.api.plan.tool.protoP\x01P\x00P\x01P\x02P\x03P\x04\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -44,6 +44,8 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['DESCRIPTOR']._serialized_options = b'\n\035com.velox.api.plan.tool.protoP\001'
   _globals['_PROCESSSTEPREQUESTPBO_CONFIGFIELDVALUESENTRY']._loaded_options = None
   _globals['_PROCESSSTEPREQUESTPBO_CONFIGFIELDVALUESENTRY']._serialized_options = b'8\001'
+  _globals['_PROCESSSTEPRESPONSESTATUSPBO']._serialized_start=2123
+  _globals['_PROCESSSTEPRESPONSESTATUSPBO']._serialized_end=2192
   _globals['_EXAMPLECONTAINERPBO']._serialized_start=334
   _globals['_EXAMPLECONTAINERPBO']._serialized_end=416
   _globals['_TOOLIOCONFIGBASEPBO']._serialized_start=419
@@ -53,17 +55,17 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_TOOLOUTPUTDETAILSPBO']._serialized_start=1002
   _globals['_TOOLOUTPUTDETAILSPBO']._serialized_end=1067
   _globals['_PROCESSSTEPREQUESTPBO']._serialized_start=1070
-  _globals['_PROCESSSTEPREQUESTPBO']._serialized_end=1497
-  _globals['_PROCESSSTEPREQUESTPBO_CONFIGFIELDVALUESENTRY']._serialized_start=1425
-  _globals['_PROCESSSTEPREQUESTPBO_CONFIGFIELDVALUESENTRY']._serialized_end=1497
-  _globals['_PROCESSSTEPRESPONSEPBO']._serialized_start=1499
-  _globals['_PROCESSSTEPRESPONSEPBO']._serialized_end=1616
-  _globals['_TOOLDETAILSREQUESTPBO']._serialized_start=1618
-  _globals['_TOOLDETAILSREQUESTPBO']._serialized_end=1691
-  _globals['_TOOLDETAILSPBO']._serialized_start=1694
-  _globals['_TOOLDETAILSPBO']._serialized_end=1910
-  _globals['_TOOLDETAILSRESPONSEPBO']._serialized_start=1912
-  _globals['_TOOLDETAILSRESPONSEPBO']._serialized_end=2007
-  _globals['_TOOLSERVICE']._serialized_start=2010
-  _globals['_TOOLSERVICE']._serialized_end=2154
+  _globals['_PROCESSSTEPREQUESTPBO']._serialized_end=1539
+  _globals['_PROCESSSTEPREQUESTPBO_CONFIGFIELDVALUESENTRY']._serialized_start=1467
+  _globals['_PROCESSSTEPREQUESTPBO_CONFIGFIELDVALUESENTRY']._serialized_end=1539
+  _globals['_PROCESSSTEPRESPONSEPBO']._serialized_start=1542
+  _globals['_PROCESSSTEPRESPONSEPBO']._serialized_end=1730
+  _globals['_TOOLDETAILSREQUESTPBO']._serialized_start=1732
+  _globals['_TOOLDETAILSREQUESTPBO']._serialized_end=1805
+  _globals['_TOOLDETAILSPBO']._serialized_start=1808
+  _globals['_TOOLDETAILSPBO']._serialized_end=2024
+  _globals['_TOOLDETAILSRESPONSEPBO']._serialized_start=2026
+  _globals['_TOOLDETAILSRESPONSEPBO']._serialized_end=2121
+  _globals['_TOOLSERVICE']._serialized_start=2195
+  _globals['_TOOLSERVICE']._serialized_end=2339
 # @@protoc_insertion_point(module_scope)

{sapiopycommons-2025.7.18a614 → sapiopycommons-2025.7.21a626}/src/sapiopycommons/ai/api/plan/tool/proto/tool_pb2.pyi

@@ -4,6 +4,7 @@ from sapiopycommons.ai.api.plan.tool.proto import entry_pb2 as _entry_pb2
 from sapiopycommons.ai.api.plan.proto import step_pb2 as _step_pb2
 from sapiopycommons.ai.api.session.proto import sapio_conn_info_pb2 as _sapio_conn_info_pb2
 from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import message as _message
 from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
@@ -110,6 +111,15 @@ IMAGE: _entry_pb2.DataTypePbo
 SESSION_TOKEN: _sapio_conn_info_pb2.SapioUserSecretTypePbo
 PASSWORD: _sapio_conn_info_pb2.SapioUserSecretTypePbo
 
+class ProcessStepResponseStatusPbo(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    UNKNOWN: _ClassVar[ProcessStepResponseStatusPbo]
+    SUCCESS: _ClassVar[ProcessStepResponseStatusPbo]
+    FAILURE: _ClassVar[ProcessStepResponseStatusPbo]
+UNKNOWN: ProcessStepResponseStatusPbo
+SUCCESS: ProcessStepResponseStatusPbo
+FAILURE: ProcessStepResponseStatusPbo
+
 class ExampleContainerPbo(_message.Message):
     __slots__ = ("text_example", "binary_example")
     TEXT_EXAMPLE_FIELD_NUMBER: _ClassVar[int]
@@ -163,7 +173,7 @@ class ToolOutputDetailsPbo(_message.Message):
     def __init__(self, base_config: _Optional[_Union[ToolIoConfigBasePbo, _Mapping]] = ...) -> None: ...
 
 class ProcessStepRequestPbo(_message.Message):
-    __slots__ = ("sapio_user", "tool_name", "plan_instance_id", "step_instance_id", "invocation_id", "input_configs", "output_configs", "config_field_values", "input")
+    __slots__ = ("sapio_user", "tool_name", "plan_instance_id", "step_instance_id", "invocation_id", "input_configs", "output_configs", "config_field_values", "dry_run", "verbose_logging", "input")
     class ConfigFieldValuesEntry(_message.Message):
         __slots__ = ("key", "value")
         KEY_FIELD_NUMBER: _ClassVar[int]
@@ -179,6 +189,8 @@ class ProcessStepRequestPbo(_message.Message):
     INPUT_CONFIGS_FIELD_NUMBER: _ClassVar[int]
     OUTPUT_CONFIGS_FIELD_NUMBER: _ClassVar[int]
     CONFIG_FIELD_VALUES_FIELD_NUMBER: _ClassVar[int]
+    DRY_RUN_FIELD_NUMBER: _ClassVar[int]
+    VERBOSE_LOGGING_FIELD_NUMBER: _ClassVar[int]
     INPUT_FIELD_NUMBER: _ClassVar[int]
     sapio_user: _sapio_conn_info_pb2.SapioConnectionInfoPbo
     tool_name: str
@@ -188,18 +200,24 @@ class ProcessStepRequestPbo(_message.Message):
     input_configs: _containers.RepeatedCompositeFieldContainer[_step_pb2.StepIoInfoPbo]
     output_configs: _containers.RepeatedCompositeFieldContainer[_step_pb2.StepIoInfoPbo]
     config_field_values: _containers.MessageMap[str, _fields_pb2.FieldValuePbo]
+    dry_run: bool
+    verbose_logging: bool
     input: _containers.RepeatedCompositeFieldContainer[_entry_pb2.StepInputBatchPbo]
-    def __init__(self, sapio_user: _Optional[_Union[_sapio_conn_info_pb2.SapioConnectionInfoPbo, _Mapping]] = ..., tool_name: _Optional[str] = ..., plan_instance_id: _Optional[int] = ..., step_instance_id: _Optional[int] = ..., invocation_id: _Optional[int] = ..., input_configs: _Optional[_Iterable[_Union[_step_pb2.StepIoInfoPbo, _Mapping]]] = ..., output_configs: _Optional[_Iterable[_Union[_step_pb2.StepIoInfoPbo, _Mapping]]] = ..., config_field_values: _Optional[_Mapping[str, _fields_pb2.FieldValuePbo]] = ..., input: _Optional[_Iterable[_Union[_entry_pb2.StepInputBatchPbo, _Mapping]]] = ...) -> None: ...
+    def __init__(self, sapio_user: _Optional[_Union[_sapio_conn_info_pb2.SapioConnectionInfoPbo, _Mapping]] = ..., tool_name: _Optional[str] = ..., plan_instance_id: _Optional[int] = ..., step_instance_id: _Optional[int] = ..., invocation_id: _Optional[int] = ..., input_configs: _Optional[_Iterable[_Union[_step_pb2.StepIoInfoPbo, _Mapping]]] = ..., output_configs: _Optional[_Iterable[_Union[_step_pb2.StepIoInfoPbo, _Mapping]]] = ..., config_field_values: _Optional[_Mapping[str, _fields_pb2.FieldValuePbo]] = ..., dry_run: bool = ..., verbose_logging: bool = ..., input: _Optional[_Iterable[_Union[_entry_pb2.StepInputBatchPbo, _Mapping]]] = ...) -> None: ...
 
 class ProcessStepResponsePbo(_message.Message):
-    __slots__ = ("new_records", "log", "output")
+    __slots__ = ("status", "status_message", "new_records", "log", "output")
+    STATUS_FIELD_NUMBER: _ClassVar[int]
+    STATUS_MESSAGE_FIELD_NUMBER: _ClassVar[int]
     NEW_RECORDS_FIELD_NUMBER: _ClassVar[int]
     LOG_FIELD_NUMBER: _ClassVar[int]
     OUTPUT_FIELD_NUMBER: _ClassVar[int]
+    status: ProcessStepResponseStatusPbo
+    status_message: str
     new_records: _containers.RepeatedCompositeFieldContainer[_fields_pb2.FieldValueMapPbo]
     log: _containers.RepeatedScalarFieldContainer[str]
     output: _containers.RepeatedCompositeFieldContainer[_entry_pb2.StepOutputBatchPbo]
-    def __init__(self, new_records: _Optional[_Iterable[_Union[_fields_pb2.FieldValueMapPbo, _Mapping]]] = ..., log: _Optional[_Iterable[str]] = ..., output: _Optional[_Iterable[_Union[_entry_pb2.StepOutputBatchPbo, _Mapping]]] = ...) -> None: ...
+    def __init__(self, status: _Optional[_Union[ProcessStepResponseStatusPbo, str]] = ..., status_message: _Optional[str] = ..., new_records: _Optional[_Iterable[_Union[_fields_pb2.FieldValueMapPbo, _Mapping]]] = ..., log: _Optional[_Iterable[str]] = ..., output: _Optional[_Iterable[_Union[_entry_pb2.StepOutputBatchPbo, _Mapping]]] = ...) -> None: ...
 
 class ToolDetailsRequestPbo(_message.Message):
     __slots__ = ("sapio_conn_info",)

{sapiopycommons-2025.7.18a614 → sapiopycommons-2025.7.21a626}/src/sapiopycommons/ai/protobuf_utils.py

@@ -22,6 +22,7 @@ from sapiopycommons.ai.api.plan.tool.proto.entry_pb2 import DataTypePbo
 from sapiopycommons.general.aliases import FieldValue
 
 
+# FR-47422: Created class.
 class ProtobufUtils:
     @staticmethod
     def content_type_str(content_type: DataTypePbo) -> str:

{sapiopycommons-2025.7.18a614 → sapiopycommons-2025.7.21a626}/src/sapiopycommons/ai/test_client.py

@@ -13,6 +13,7 @@ from sapiopycommons.ai.api.plan.tool.proto.tool_pb2_grpc import ToolServiceStub
 from sapiopycommons.ai.api.session.proto.sapio_conn_info_pb2 import SapioConnectionInfoPbo, SapioUserSecretTypePbo
 
 
+# FR-47422: Created class.
 class ToolOutput:
     """
     A class for holding the output of a TestClient that calls a ToolService. ToolOutput objects an be

{sapiopycommons-2025.7.18a614 → sapiopycommons-2025.7.21a626}/src/sapiopycommons/ai/tool_service_base.py

@@ -1,7 +1,10 @@
 from __future__ import annotations
 
+import base64
+import io
 import json
 import logging
+import re
 import traceback
 from abc import abstractmethod, ABC
 from logging import Logger
@@ -19,13 +22,15 @@ from sapiopycommons.ai.api.plan.tool.proto.entry_pb2 import StepOutputBatchPbo,
     StepJsonContainerPbo, StepTextContainerPbo, StepInputBatchPbo
 from sapiopycommons.ai.api.plan.tool.proto.tool_pb2 import ToolDetailsRequestPbo, ToolDetailsResponsePbo, \
     ToolDetailsPbo, ProcessStepRequestPbo, ProcessStepResponsePbo, ToolOutputDetailsPbo, ToolIoConfigBasePbo, \
-    ToolInputDetailsPbo, ExampleContainerPbo
+    ToolInputDetailsPbo, ExampleContainerPbo, ProcessStepResponseStatusPbo
 from sapiopycommons.ai.api.plan.tool.proto.tool_pb2_grpc import ToolServiceServicer
 from sapiopycommons.ai.api.session.proto.sapio_conn_info_pb2 import SapioUserSecretTypePbo, SapioConnectionInfoPbo
 from sapiopycommons.ai.protobuf_utils import ProtobufUtils
+from sapiopycommons.files.file_util import FileUtil
 from sapiopycommons.general.aliases import FieldMap, FieldValue
 
 
+# FR-47422: Created classes.
 class SapioToolResult(ABC):
     """
     A class representing a result from a Sapio tool. Instantiate one of the subclasses to create a result object.
@@ -194,35 +199,43 @@ class ToolServiceBase(ToolServiceServicer, ABC):
     def GetToolDetails(self, request: ToolDetailsRequestPbo, context: ServicerContext) -> ToolDetailsResponsePbo:
         try:
             # Get the tool details from the registered tools.
-            details: list[ToolDetailsPbo] = self.get_details()
+            details: list[ToolDetailsPbo] = []
+            for tool in self._initialize_tools():
+                details.append(tool.to_pbo())
             return ToolDetailsResponsePbo(tool_framework_version=self.tool_version(), tool_details=details)
         except Exception:
-            # TODO: This response doesn't even allow logs. What should we do if an exception occurs in this case?
+            # Woe to you if you somehow cause an exception to be raised when just initializing your tools.
+            # There's no way to log this.
             return ToolDetailsResponsePbo()
 
     def ProcessData(self, request: ProcessStepRequestPbo, context: ServicerContext) -> ProcessStepResponsePbo:
         try:
             # Convert the SapioConnectionInfo proto object to a SapioUser object.
-            user = self.create_user(request.sapio_user)
-            # Get the tool results from the registered tool matching the request and convert them to proto objects.
+            user = self._create_user(request.sapio_user)
+            # Get the tool results from the registered tool matching the request.
+            success, msg, results, logs = self.run(user, request, context)
+            # Convert the results to protobuf objects.
             output_data: list[StepOutputBatchPbo] = []
             new_records: list[FieldValueMapPbo] = []
-            # TODO: Make use of the success value after the response object has a field for it.
-            success, results, logs = self.run(user, request, context)
             for result in results:
                 data: StepOutputBatchPbo | list[FieldValueMapPbo] = result.to_proto()
                 if isinstance(data, StepOutputBatchPbo):
                     output_data.append(data)
                 else:
                     new_records.extend(data)
-            # Return a ProcessStepResponse proto object containing the output data and new records to the caller.
-            return ProcessStepResponsePbo(output=output_data, log=logs, new_records=new_records)
-        except Exception:
-            # TODO: Return a False success result after the response object has a field for it.
-            return ProcessStepResponsePbo(log=[traceback.format_exc()])
+            # Return a ProcessStepResponse proto object containing the results to the caller.
+            status = ProcessStepResponseStatusPbo.SUCCESS if success else ProcessStepResponseStatusPbo.FAILURE
+            return ProcessStepResponsePbo(status=status, status_message=msg, output=output_data, log=logs,
+                                          new_records=new_records)
+        except Exception as e:
+            # This try/except should never be needed, as the tool should handle its own exceptions, but better safe
+            # than sorry.
+            return ProcessStepResponsePbo(status=ProcessStepResponseStatusPbo.FAILURE,
+                                          status_message=f"CRITICAL ERROR: {e}",
+                                          log=[traceback.format_exc()])
 
     @staticmethod
-    def create_user(info: SapioConnectionInfoPbo, timeout_seconds: int = 60) -> SapioUser:
+    def _create_user(info: SapioConnectionInfoPbo, timeout_seconds: int = 60) -> SapioUser:
         """
         Create a SapioUser object from the given SapioConnectionInfo proto object.
 
@@ -230,48 +243,28 @@ class ToolServiceBase(ToolServiceServicer, ABC):
         :param timeout_seconds: The request timeout for calls made from this user object.
         """
         # TODO: Have a customizable request timeout? Would need to be added to the request object.
-        # TODO: How should the RMI hosts and port be used in the connection info?
         user = SapioUser(info.webservice_url, True, timeout_seconds, guid=info.app_guid)
-        if info.secret_type == SapioUserSecretTypePbo.SESSION_TOKEN:
-            user.api_token = info.secret
-        elif info.secret_type == SapioUserSecretTypePbo.PASSWORD:
-            # TODO: Will the secret be base64 encoded if it's a password? That's how basic auth is normally handled.
-            user.password = info.secret
-        else:
-            raise Exception(f"Unexpected secret type: {info.secret_type}")
+        match info.secret_type:
+            case SapioUserSecretTypePbo.SESSION_TOKEN:
+                user.api_token = info.secret
+            case SapioUserSecretTypePbo.PASSWORD:
+                secret: str = info.secret
+                if secret.startswith("Basic "):
+                    secret = secret[6:]
+                credentials: list[str] = base64.b64decode(secret).decode().split(":")
+                user.username = credentials[0]
+                user.password = credentials[1]
+            case _:
+                raise Exception(f"Unexpected secret type: {info.secret_type}")
         return user
 
     @staticmethod
     def tool_version() -> int:
         """
-        :return: The version of this tool.
+        :return: The version of this set of tools.
         """
         return 1
 
-    def _get_tools(self) -> list[ToolBase]:
-        """
-        return: Get instances of the tools registered with this service.
-        """
-        # This is complaining about the name and description not being filled from ToolBase,
-        # but none of the provided tools should have any init parameters.
-        # noinspection PyArgumentList
-        tools: list[ToolBase] = [x() for x in self.register_tools()]
-        if not tools:
-            raise Exception("No tools registered with this service.")
-        return tools
-
-    def _get_tool(self, name: str) -> ToolBase:
-        """
-        Get a specific tool instance by its name.
-
-        :param name: The name of the tool to retrieve.
-        :return: The tool object corresponding to the given name.
-        """
-        tools: dict[str, ToolBase] = {x.name: x for x in self._get_tools()}
-        if name not in tools:
-            raise Exception(f"Tool \"{name}\" not found in registered tools.")
-        return tools[name]
-
     @abstractmethod
     def register_tools(self) -> list[type[ToolBase]]:
         """
@@ -282,19 +275,20 @@ class ToolServiceBase(ToolServiceServicer, ABC):
         """
         pass
 
-    def get_details(self) -> list[ToolDetailsPbo]:
+    def _initialize_tools(self) -> list[ToolBase]:
         """
-        Get the details of the tool.
-
-        :return: A ToolDetailsResponse object containing the tool details.
+        return: Get instances of the tools registered with this service.
         """
-        tool_details: list[ToolDetailsPbo] = []
-        for tool in self._get_tools():
-            tool_details.append(tool.to_pbo())
-        return tool_details
+        # This is complaining about the name and description not being filled from ToolBase,
+        # but none of the provided tools should have any init parameters.
+        # noinspection PyArgumentList
+        tools: list[ToolBase] = [x() for x in self.register_tools()]
+        if not tools:
+            raise Exception("No tools registered with this service.")
+        return tools
 
     def run(self, user: SapioUser, request: ProcessStepRequestPbo, context: ServicerContext) \
-            -> tuple[bool, list[SapioToolResult], list[str]]:
+            -> tuple[bool, str, list[SapioToolResult], list[str]]:
         """
         Execute a tool from this service.
 
@@ -302,16 +296,36 @@ class ToolServiceBase(ToolServiceServicer, ABC):
             system.
         :param request: The request object containing the input data.
         :param context: The gRPC context.
-        :return: Whether or not the tool succeeded, the results of the tool, and any logs generated by the tool.
-        """
-        tool = self._get_tool(request.tool_name)
+        :return: Whether or not the tool succeeded, the status message, the results of the tool, and any logs
+            generated by the tool.
+        """
+        # Locate the tool named in the request.
+        tool: ToolBase | None = None
+        for t in self._initialize_tools():
+            if t.name == request.tool_name:
+                tool = t
+                break
+        if not tool:
+            return False, f"Tool \"{request.tool_name}\" not found in the registered tools for this service.", [], []
+
         try:
+            # Setup the tool with details from the request.
             tool.setup(user, request, context)
-            results: list[SapioToolResult] = tool.run(user)
-            return True, results, tool.logs
+            # Validate that the provided inputs match the tool's expected inputs.
+            success, msg = tool.validate_input()
+            # If this is a dry run, then provide the fixed dry run output.
+            # Otherwise, if the inputs were successfully validated, then the tool is executed normally.
+            results: list[SapioToolResult] = []
+            if request.dry_run:
+                results = tool.dry_run_output()
+            elif success:
+                results = tool.run(user)
+                # Update the status message to reflect the successful execution of the tool.
+                msg = f"{tool.name} successfully completed."
+            return success, msg, results, tool.logs
         except Exception as e:
             tool.log_exception("Exception occurred during tool execution.", e)
-            return False, [], tool.logs
+            return False, str(e), [], tool.logs
 
 
 class ToolBase(ABC):
@@ -363,8 +377,7 @@ class ToolBase(ABC):
         self.user = user
         self.request = request
         self.context = context
-        # TODO: Determine verbose logging from the request.
-        self.verbose_logging = False
+        self.verbose_logging = request.verbose_logging
 
     def add_input(self, content_type: DataTypePbo, display_name: str, description: str,
                   structure_example: str | bytes | None = None, validation: str | None = None,
@@ -412,7 +425,7 @@ class ToolBase(ABC):
         ))
 
     def add_output(self, content_type: DataTypePbo, display_name: str, description: str,
-                   testing_example: str | bytes | None = None, structure_example: str | bytes | None = None) -> None:
+                   testing_example: str | bytes, structure_example: str | bytes | None = None) -> None:
         """
         Add an output configuration to the tool. This determines how many inputs this tool will accept in the plan
         manager, as well as what those inputs are. The IO number of the output will be set to the current number of
@@ -430,18 +443,18 @@ class ToolBase(ABC):
             JSON output may look. This does not need to be an entirely valid example, and should often be truncated for
             brevity.
         """
-        structure: ExampleContainerPbo | None = None
-        if isinstance(structure_example, str):
-            structure = ExampleContainerPbo(text_example=structure_example)
-        elif isinstance(structure_example, bytes):
-            structure = ExampleContainerPbo(binary_example=structure_example)
-
         testing: ExampleContainerPbo | None = None
         if isinstance(testing_example, str):
             testing = ExampleContainerPbo(text_example=testing_example)
         elif isinstance(testing_example, bytes):
             testing = ExampleContainerPbo(binary_example=testing_example)
 
+        structure: ExampleContainerPbo | None = None
+        if isinstance(structure_example, str):
+            structure = ExampleContainerPbo(text_example=structure_example)
+        elif isinstance(structure_example, bytes):
+            structure = ExampleContainerPbo(binary_example=structure_example)
+
         self.outputs.append(ToolOutputDetailsPbo(
             base_config=ToolIoConfigBasePbo(
                 io_number=len(self.outputs),
@@ -651,6 +664,69 @@ class ToolBase(ABC):
             config_fields=self.configs
         )
 
+    @abstractmethod
+    def validate_input(self) -> tuple[bool, str]:
+        """
+        Validate the request given to this tool. If the request is validly formatted, this method should return True
+        and a success message. If the request is not valid, this method should return False and an error message
+        indicating what is wrong with the request.
+
+        This method should not perform any actual processing of the request. It should only validate the inputs and
+        configurations provided in the request.
+
+        The request inputs can be accessed using the self.get_input_*() methods.
+        The request settings can be accessed using the self.get_config_fields() method.
+        The request itself can be accessed using self.request.
+
+        :return: A tuple containing a boolean indicating whether the request is valid and a message describing the
+            result of the validation.
+        """
+        pass
+
+    def dry_run_output(self) -> list[SapioToolResult]:
+        """
+        Provide fixed results for a dry run of this tool. This method should not perform any actual processing of the
+        request. It should only return example outputs that can be used to test the next tool in the plan.
+
+        The default implementation of this method looks at the testing_example field of each output configuration
+        and returns a SapioToolResult object based on the content type of the output.
+
+        :return: A list of SapioToolResult objects containing example outputs for this tool. Each result in the list
+            corresponds to a separate output from the tool.
+        """
+        results: list[SapioToolResult] = []
+        for output in self.outputs:
+            example: Any = output.base_config.testing_example
+            match output.base_config.content_type:
+                case DataTypePbo.BINARY:
+                    example: bytes
+                    results.append(BinaryResult(binary_data=[example]))
+                case DataTypePbo.CSV:
+                    example: str
+                    results.append(CsvResult(FileUtil.tokenize_csv(example.encode())[0]))
+                case DataTypePbo.IMAGE:
+                    example: bytes
+                    # We can't know what the actual image format is, so just assume PNG. If this is wrong and having
+                    # the correct image format is necessary for testing, then the tool should override this method to
+                    # provide the correct format.
+                    results.append(ImageResult(image_format="PNG", image_data=[example]))
+                case DataTypePbo.JSON:
+                    # The example may be in the JSONL format instead of plain JSON, so we need to use Pandas to parse
+                    # the example into plain JSON.
+                    example: str
+                    # Format the JSONL in a way that Pandas likes. Collapse everything into a single line, and then
+                    # split it back into multiple lines where each line is a single JSON list or dictionary.
+                    example = re.sub("([]}])\s*([\[{])", r"\1\n\2", example.replace("\n", "")).strip()
+                    # Read the JSONL into a Pandas DataFrame and convert it back to plain JSON.
+                    import pandas as pd
+                    with io.StringIO(example) as stream:
+                        example = pd.read_json(path_or_buf=stream, lines=True).to_json()
+                    results.append(JsonResult(json_data=[json.loads(example)]))
+                case DataTypePbo.TEXT:
+                    example: str
+                    results.append(TextResult(text_data=[example]))
+        return results
+
     @abstractmethod
     def run(self, user: SapioUser) -> list[SapioToolResult]:
         """
@@ -662,8 +738,8 @@ class ToolBase(ABC):
 
         :param user: A user object that can be used to initialize manager classes using DataMgmtServer to query the
             system.
-        :return: A SapioToolResults object containing the response data. Each result in the list corresponds to a
-            separate output from the tool. Field map results do not appear as tool output in the plan manager, instead
+        :return: A list of SapioToolResult objects containing the response data. Each result in the list corresponds to
+            a separate output from the tool. Field map results do not appear as tool output in the plan manager, instead
             appearing as records related to the plan step during the run.
         """
         pass