sapiopycommons 2025.9.9a738__py3-none-any.whl → 2025.9.10a743__py3-none-any.whl

sapiopycommons/ai/tool_service_base.py

@@ -12,11 +12,12 @@ from typing import Any, Iterable, Mapping
 
 from grpc import ServicerContext
 from sapiopylib.rest.User import SapioUser, ensure_logger_initialized
-from sapiopylib.rest.pojo.datatype.FieldDefinition import AbstractVeloxFieldDefinition
+from sapiopylib.rest.pojo.datatype.FieldDefinition import AbstractVeloxFieldDefinition, FieldValidator
 
 from sapiopycommons.ai.protoapi.fielddefinitions.fields_pb2 import FieldValueMapPbo, FieldValuePbo
 from sapiopycommons.ai.protoapi.fielddefinitions.velox_field_def_pb2 import VeloxFieldDefPbo, FieldTypePbo, \
-    SelectionPropertiesPbo, IntegerPropertiesPbo, DoublePropertiesPbo, BooleanPropertiesPbo, StringPropertiesPbo
+    SelectionPropertiesPbo, IntegerPropertiesPbo, DoublePropertiesPbo, BooleanPropertiesPbo, StringPropertiesPbo, \
+    FieldValidatorPbo
 from sapiopycommons.ai.protoapi.plan.item.item_container_pb2 import ContentTypePbo
 from sapiopycommons.ai.protoapi.plan.tool.entry_pb2 import StepOutputBatchPbo, StepItemContainerPbo, \
     StepBinaryContainerPbo, StepCsvContainerPbo, StepCsvHeaderRowPbo, StepCsvRowPbo, StepJsonContainerPbo, \
@@ -637,8 +638,8 @@ class ToolBase(ABC):
         ))
 
     def add_string_config_field(self, field_name: str, display_name: str, description: str,
-                                default_value: str | None = None, max_length: int = 1000, optional: bool = False) \
-            -> None:
+                                default_value: str | None = None, max_length: int = 1000, optional: bool = False,
+                                validation_regex: str | None = None, error_msg: str | None = None) -> None:
         """
         Add a string configuration field to the tool. This field will be used to configure the tool in the plan
         manager.
@@ -649,6 +650,8 @@ class ToolBase(ABC):
         :param default_value: The default value of the field.
         :param max_length: The maximum length of the field.
         :param optional: If true, this field is optional. If false, this field is required.
+        :param validation_regex: An optional regex that the field value must match.
+        :param error_msg: An optional error message to display if the field value does not match the regex.
         """
         self.config_fields.append(VeloxFieldDefPbo(
             data_field_type=FieldTypePbo.STRING,
@@ -659,13 +662,15 @@ class ToolBase(ABC):
             editable=True,
             string_properties=StringPropertiesPbo(
                 default_value=default_value,
-                max_length=max_length
+                max_length=max_length,
+                field_validator=FieldValidatorPbo(validation_regex, error_msg) if validation_regex else None
             )
         ))
 
     def add_list_config_field(self, field_name: str, display_name: str, description: str,
                               default_value: str | None = None, allowed_values: list[str] | None = None,
-                              direct_edit: bool = False, optional: bool = False) -> None:
+                              direct_edit: bool = False, optional: bool = False,
+                              validation_regex: str | None = None, error_msg: str | None = None) -> None:
         """
         Add a list configuration field to the tool. This field will be used to configure the tool in the plan
         manager.
@@ -678,6 +683,8 @@ class ToolBase(ABC):
         :param direct_edit: If true, the user can enter a value that is not in the list of allowed values. If false,
             the user can only select from the list of allowed values.
         :param optional: If true, this field is optional. If false, this field is required.
+        :param validation_regex: An optional regex that the field value must match.
+        :param error_msg: An optional error message to display if the field value does not match the regex.
         """
         self.config_fields.append(VeloxFieldDefPbo(
             data_field_type=FieldTypePbo.SELECTION,
@@ -690,12 +697,14 @@ class ToolBase(ABC):
                 default_value=default_value,
                 static_list_values=allowed_values,
                 direct_edit=direct_edit,
+                field_validator=FieldValidatorPbo(validation_regex, error_msg) if validation_regex else None
             )
         ))
 
     def add_multi_list_config_field(self, field_name: str, display_name: str, description: str,
                                     default_value: list[str] | None = None, allowed_values: list[str] | None = None,
-                                    direct_edit: bool = False, optional: bool = False) -> None:
+                                    direct_edit: bool = False, optional: bool = False,
+                                    validation_regex: str | None = None, error_msg: str | None = None) -> None:
         """
         Add a multi-select list configuration field to the tool. This field will be used to configure the tool in the
         plan manager.
@@ -708,6 +717,8 @@ class ToolBase(ABC):
         :param direct_edit: If true, the user can enter a value that is not in the list of allowed values. If false,
             the user can only select from the list of allowed values.
         :param optional: If true, this field is optional. If false, this field is required.
+        :param validation_regex: An optional regex that the field value must match.
+        :param error_msg: An optional error message to display if the field value does not match the regex.
         """
         self.config_fields.append(VeloxFieldDefPbo(
             data_field_type=FieldTypePbo.SELECTION,
@@ -721,6 +732,7 @@ class ToolBase(ABC):
                 static_list_values=allowed_values,
                 multi_select=True,
                 direct_edit=direct_edit,
+                field_validator=FieldValidatorPbo(validation_regex, error_msg) if validation_regex else None
             )
         ))
 

{sapiopycommons-2025.9.9a738.dist-info → sapiopycommons-2025.9.10a743.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.9.9a738
+Version: 2025.9.10a743
 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.9.9a738.dist-info → sapiopycommons-2025.9.10a743.dist-info}/RECORD

@@ -4,7 +4,7 @@ sapiopycommons/ai/converter_service_base.py,sha256=TMSyEekbbqMk9dRuAtLlSJ1sA1H8K
 sapiopycommons/ai/protobuf_utils.py,sha256=cBjbxoFAwU02kNUxEce95WnMU2CMuDD-qFaeWgvQJMQ,24599
 sapiopycommons/ai/server.py,sha256=XDm_mj1yWHw-xQRFsFRHnsGw2JU0wsW2mR22P8PB09A,5744
 sapiopycommons/ai/test_client.py,sha256=-kMXXU_f5FAB7n4UX66NT8I8G52M0eZjn-hpESN_io8,16330
-sapiopycommons/ai/tool_service_base.py,sha256=G4gvZPG9lhlfOZNIpY306JDCyfP_IlOIdCpkN37ekGM,48621
+sapiopycommons/ai/tool_service_base.py,sha256=9YI2MzjXIHmzhCsB-VIUOI3Gad0HNG26KxSUwmM01cs,49851
 sapiopycommons/ai/protoapi/fielddefinitions/fields_pb2.py,sha256=8tKXwLXcqFGdQHHSEBSi6Fd7dcaCFoOqmhjzqhenb_M,2372
 sapiopycommons/ai/protoapi/fielddefinitions/fields_pb2.pyi,sha256=FwtXmNAf7iYGEFm4kbqb04v77jNHbZg18ZmEDhle_bU,1444
 sapiopycommons/ai/protoapi/fielddefinitions/fields_pb2_grpc.py,sha256=uO25bcnfGqXpP4ggUur54Nr73Wj-DGWftExzLNcxdHI,931
@@ -99,7 +99,7 @@ sapiopycommons/webhook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 sapiopycommons/webhook/webhook_context.py,sha256=D793uLsb1691SalaPnBUk3rOSxn_hYLhdvkaIxjNXss,1909
 sapiopycommons/webhook/webhook_handlers.py,sha256=7o_wXOruhT9auNh8OfhJAh4WhhiPKij67FMBSpGPICc,39939
 sapiopycommons/webhook/webservice_handlers.py,sha256=cvW6Mk_110BzYqkbk63Kg7jWrltBCDALOlkJRu8h4VQ,14300
-sapiopycommons-2025.9.9a738.dist-info/METADATA,sha256=w4xrNnptiu4pINKxhPQylg8Kt_ybYEZ_sIXp48xYPDQ,3142
-sapiopycommons-2025.9.9a738.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2025.9.9a738.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2025.9.9a738.dist-info/RECORD,,
+sapiopycommons-2025.9.10a743.dist-info/METADATA,sha256=InFBl-Vd6Qxi0CC0H5T3Q-Jw1L8V6lF7Ioai5f4fXEs,3143
+sapiopycommons-2025.9.10a743.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2025.9.10a743.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2025.9.10a743.dist-info/RECORD,,