sapiopycommons 2025.10.15a782__py3-none-any.whl → 2025.10.16a785__py3-none-any.whl

sapiopycommons/ai/agent_service_base.py

@@ -22,7 +22,7 @@ from sapiopycommons.ai.protoapi.externalcredentials.external_credentials_pb2 imp
 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, \
-    FieldValidatorPbo
+    FieldValidatorPbo, DatePropertiesPbo
 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, \
@@ -782,6 +782,67 @@ class AgentBase(ABC):
             )
         ))
 
+    def add_date_config_field(self, field_name: str, display_name: str, description: str, optional: bool = False,
+                              date_time_format: str = "MMM dd, yyyy", default_to_today: bool = False,
+                              is_static_date: bool = False) -> None:
+        """
+        Add a date configuration field to the agent. This field will be used to configure the agent 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 date_time_format: The format that this date field should appear in. The date format is Java-style.
+            See https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/text/SimpleDateFormat.html for more
+            details.
+        :param default_to_today: If true, the default value of the field will be set to today's date. If false, the
+            default value will be None.
+        :param is_static_date: If true, the user will input the date as UTC. If false, the user will input the date
+            as local time.
+        :param optional: If true, this field is optional. If false, this field is required.
+        """
+        self.config_fields.append(VeloxFieldDefPbo(
+            data_field_type=FieldTypePbo.DATE,
+            data_field_name=field_name,
+            display_name=display_name,
+            description=description,
+            required=not optional,
+            editable=True,
+            date_properties=DatePropertiesPbo(
+                default_value="@Today" if default_to_today else None,
+                static_date=is_static_date,
+                date_time_format=date_time_format
+            )
+        ))
+
+    def add_credentials_config_field(self, field_name: str, display_name: str, description: str, optional: bool = False,
+                                     category: str | None = None) -> None:
+        """
+        Add a list field that asks the user to choose which credentials to use. This field will be used to
+        configure the agent 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 optional: If true, this field is optional. If false, this field is required.
+        :param category: If provided, only credentials in this category will be shown to the user.
+        """
+        self.config_fields.append(VeloxFieldDefPbo(
+            data_field_type=FieldTypePbo.SELECTION,
+            data_field_name=field_name,
+            display_name=display_name,
+            description=description,
+            required=not optional,
+            editable=True,
+            selection_properties=SelectionPropertiesPbo(
+                # A credentials field is just a selection field with its list mode set to [ExternalCredentials].
+                list_mode=f"[ExternalCredentials]{category.strip() if category else ''}",
+                multi_select=False,
+                default_value=None,
+                direct_edit=False
+            )
+        ))
+
     def to_pbo(self) -> ToolDetailsPbo:
         """
         :return: The ToolDetailsPbo proto object representing this agent.
@@ -910,6 +971,23 @@ class AgentBase(ABC):
 
         return ExternalCredentials.from_pbo(matching_creds[0])
 
+    def get_credentials_from_config(self, value: str) -> ExternalCredentials:
+        """
+        Get credentials given the value of a credentials config field.
+
+        :param value: The value of the credentials config field.
+        :return: An ExternalCredentials object containing the credentials.
+        """
+        # Values should be of the format "Name (Identifier)"
+        match = re.match(r"^(.*) \((.*)\)$", value)
+        if not match:
+            raise ValueError(f"Invalid credentials value '{value}'. Expected format 'Name (Identifier)'.")
+        identifier: str = match.group(2)
+        for cred in self.request.external_credential:
+            if cred.id == identifier:
+                return ExternalCredentials.from_pbo(cred)
+        raise ValueError(f"No credentials found with identifier '{identifier}'.")
+
     def call_subprocess(self,
                         args: str | bytes | PathLike[str] | PathLike[bytes] | Sequence[str | bytes | PathLike[str] | PathLike[bytes]],
                         cwd: str | bytes | PathLike[str] | PathLike[bytes] | None = None,

{sapiopycommons-2025.10.15a782.dist-info → sapiopycommons-2025.10.16a785.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.10.15a782
+Version: 2025.10.16a785
 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.10.15a782.dist-info → sapiopycommons-2025.10.16a785.dist-info}/RECORD

@@ -1,6 +1,6 @@
 sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/ai/agent_service_base.py,sha256=LVZg_4Kw5WTcIB7ru5hEqJoMWQr2eTDYjMrX8pzpn9I,56301
+sapiopycommons/ai/agent_service_base.py,sha256=eTJunFQoxLc0risWiQIkQK946XpHzSFO38NzzRvOn9Q,60325
 sapiopycommons/ai/converter_service_base.py,sha256=HiUXmwqv1STgyQeF9_eTFXzjIFXp5-NJ7sEhMpV3aAU,6351
 sapiopycommons/ai/external_credentials.py,sha256=ki_xIH4J843b_sSwEa8YHr8vW9erVv-jowZJXSgPQs8,4347
 sapiopycommons/ai/protobuf_utils.py,sha256=cBjbxoFAwU02kNUxEce95WnMU2CMuDD-qFaeWgvQJMQ,24599
@@ -106,7 +106,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.10.15a782.dist-info/METADATA,sha256=DIeUTx52EZpA1ZIecBFRA4_LsTMKBwOZLzB6i2iBgxs,3143
-sapiopycommons-2025.10.15a782.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2025.10.15a782.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2025.10.15a782.dist-info/RECORD,,
+sapiopycommons-2025.10.16a785.dist-info/METADATA,sha256=2yQ4MjvJOysrdpojvELXBXHk9Pk_hDU7D1cl3k6zHKQ,3143
+sapiopycommons-2025.10.16a785.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2025.10.16a785.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2025.10.16a785.dist-info/RECORD,,