sapiopycommons 2025.10.13a781__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.
@@ -908,7 +969,24 @@ class AgentBase(ABC):
         if len(matching_creds) > 1:
             raise ValueError(f"Multiple credentials found for category '{category}' and host '{host}'.")
 
-        return ExternalCredentials(matching_creds[0])
+        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]],

sapiopycommons/ai/external_credentials.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from sapiopycommons.ai.protoapi.externalcredentials.external_credentials_pb2 import ExternalCredentialsPbo
 
 
@@ -5,26 +7,97 @@ class ExternalCredentials:
     """
     A class representing external credentials.
     """
-    id: str
-    display_name: str
-    description: str
-    category: str
-    url: str
-    username: str
-    password: str
-    token: str
-    custom_fields: dict[str, str]
-
-    def __init__(self, pbo: ExternalCredentialsPbo):
-        self.id = pbo.id
-        self.display_name = pbo.display_name
-        self.description = pbo.description
-        self.category = pbo.category
-        self.url = pbo.url
-        self.username = pbo.username
-        self.password = pbo.password
-        self.token = pbo.token
-        self.custom_fields = dict(pbo.custom_field)
+    _identifier: str
+    _display_name: str
+    _description: str
+    _category: str
+    _url: str
+    _username: str
+    _password: str
+    _token: str
+    _custom_fields: dict[str, str]
+
+    def __init__(self, url: str, category: str, identifier: str = "", display_name: str = "", description: str = "",
+                 username: str = "", password: str = "", token: str = "", custom_fields: dict[str, str] | None = None):
+        """
+        :param url: The URL that the credentials are for.
+        :param category: The category of the credentials. This can be used to search for the credentials using the
+            AgentBase.get_credentials function.
+        :param identifier: The unique identifier for the credentials.
+        :param display_name: The display name for the credentials.
+        :param description: A description of the credentials.
+        :param username: The username for the credentials.
+        :param password: The password for the credentials.
+        :param token: The token for the credentials.
+        :param custom_fields: A dictionary of custom fields associated with the credentials.
+        """
+        self._identifier = identifier
+        self._display_name = display_name
+        self._description = description
+        self._category = category
+        self._url = url
+        self._username = username
+        self._password = password
+        self._token = token
+        self._custom_fields = custom_fields or {}
+
+    @staticmethod
+    def from_pbo(pbo: ExternalCredentialsPbo) -> ExternalCredentials:
+        """
+        Create an ExternalCredentials instance from a protobuf object.
+
+        :param pbo: An ExternalCredentialsPbo object.
+        :return: An ExternalCredentials instance.
+        """
+        creds = ExternalCredentials(pbo.url, pbo.category)
+        creds._identifier = pbo.id
+        creds._display_name = pbo.display_name
+        creds._description = pbo.description
+        creds._username = pbo.username
+        creds._password = pbo.password
+        creds._token = pbo.token
+        creds._custom_fields = dict(pbo.custom_field)
+        return creds
+
+    @property
+    def identifier(self) -> str:
+        """The unique identifier for the credentials."""
+        return self._identifier
+
+    @property
+    def display_name(self) -> str:
+        """The display name for the credentials."""
+        return self._display_name
+
+    @property
+    def description(self) -> str:
+        """A description of the credentials."""
+        return self._description
+
+    @property
+    def category(self) -> str:
+        """The category of the credentials."""
+        return self._category
+
+    @property
+    def url(self) -> str:
+        """The URL that the credentials are for."""
+        return self._url
+
+    @property
+    def username(self) -> str:
+        """The username for the credentials."""
+        return self._username
+
+    @property
+    def password(self) -> str:
+        """The password for the credentials."""
+        return self._password
+
+    @property
+    def token(self) -> str:
+        """The token for the credentials."""
+        return self._token
 
     def get_custom_field(self, key: str, default: str = None) -> str | None:
         """
@@ -34,4 +107,22 @@ class ExternalCredentials:
         :param default: The value to return if the key does not exist.
         :return: The value of the custom field, or None if the key does not exist.
         """
-        return self.custom_fields.get(key, default)
+        return self._custom_fields.get(key, default)
+
+    def to_pbo(self) -> ExternalCredentialsPbo:
+        """
+        Convert the ExternalCredentials instance to a protobuf object.
+
+        :return: An ExternalCredentialsPbo object.
+        """
+        return ExternalCredentialsPbo(
+            id=self._identifier,
+            display_name=self._display_name,
+            description=self._description,
+            category=self._category,
+            url=self._url,
+            username=self._username,
+            password=self._password,
+            token=self._token,
+            custom_field=self._custom_fields
+        )

sapiopycommons/ai/test_client.py

@@ -7,6 +7,8 @@ from typing import Any
 import grpc
 from sapiopylib.rest.User import SapioUser
 
+from sapiopycommons.ai.external_credentials import ExternalCredentials
+from sapiopycommons.ai.protoapi.externalcredentials.external_credentials_pb2 import ExternalCredentialsPbo
 from sapiopycommons.ai.protoapi.fielddefinitions.fields_pb2 import FieldValuePbo
 from sapiopycommons.ai.protoapi.plan.converter.converter_pb2 import ConverterDetailsRequestPbo, \
     ConverterDetailsResponsePbo, ConvertResponsePbo, ConvertRequestPbo
@@ -65,7 +67,8 @@ class AgentOutput:
         self.new_records = []
         self.logs = []
 
-    def save_outputs(self, path: str = "test_outputs", subfolder: str | None = None, file_extensions: list[str] | None = None) -> None:
+    def save_outputs(self, path: str = "test_outputs", subfolder: str | None = None,
+                     file_extensions: list[str] | None = None) -> None:
         """
         Save all outputs to files in the specified output directory.
 
@@ -168,6 +171,7 @@ class TestClient:
     connection: SapioConnectionInfoPbo
     _request_inputs: list[StepItemContainerPbo]
     _config_fields: dict[str, FieldValuePbo]
+    _credentials: list[ExternalCredentialsPbo]
 
     def __init__(self, grpc_server_url: str, message_mb_size: int = 1024, user: SapioUser | None = None,
                  options: list[tuple[str, Any]] | None = None):
@@ -188,6 +192,7 @@ class TestClient:
         self._create_connection(user)
         self._request_inputs = []
         self._config_fields = {}
+        self._credentials = []
 
     def _create_connection(self, user: SapioUser | None = None):
         """
@@ -272,10 +277,28 @@ class TestClient:
         """
         self._config_fields.clear()
 
+    def add_credentials(self, credentials: list[ExternalCredentials]) -> None:
+        """
+        Add external credentials to the connection info for the next request.
+
+        :param credentials: A list of ExternalCredentialsPbo objects to add to the connection info.
+        """
+        for cred in credentials:
+            self._credentials.append(cred.to_pbo())
+
+    def clear_credentials(self) -> None:
+        """
+        Clear all external credentials that have been added to the next request.
+        This is useful if you want to start a new request without the previous credentials.
+        """
+        self._credentials.clear()
+
     def clear_request(self) -> None:
         """
         Clear all inputs and configuration fields that have been added to the next request.
         This is useful if you want to start a new request without the previous inputs and configurations.
+
+        Credentials are not cleared, as they may be reused across multiple requests.
         """
         self.clear_inputs()
         self.clear_configs()
@@ -331,6 +354,7 @@ class TestClient:
                     config_field_values=self._config_fields,
                     dry_run=is_dry_run,
                     verbose_logging=is_verbose,
+                    external_credential=self._credentials,
                     input=[
                         StepInputBatchPbo(is_partial=False, item_container=item)
                         for item in self._request_inputs

{sapiopycommons-2025.10.13a781.dist-info → sapiopycommons-2025.10.16a785.dist-info}/METADATA

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

@@ -1,12 +1,12 @@
 sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/ai/agent_service_base.py,sha256=UF5mSCXMxX0qUtEUWRtQ6_690aOo6pCRB89dyj8Amug,56292
+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=40AI7VtHf6PzvwJLR_mZemUCrfAUvC--tGH-npaDIgo,1163
+sapiopycommons/ai/external_credentials.py,sha256=ki_xIH4J843b_sSwEa8YHr8vW9erVv-jowZJXSgPQs8,4347
 sapiopycommons/ai/protobuf_utils.py,sha256=cBjbxoFAwU02kNUxEce95WnMU2CMuDD-qFaeWgvQJMQ,24599
 sapiopycommons/ai/request_validation.py,sha256=TD2EUi_G5cy1OOVK1AmY2SQc3PEoAKGWs2pT8Qnp2Oo,25092
 sapiopycommons/ai/server.py,sha256=gutSskn_Fenq1uz0DDMvjx4QVFiKt2WVEP3-01a69eU,6384
-sapiopycommons/ai/test_client.py,sha256=aiS58O_A3KSgRCzDT61iKyVXy9F4UY7xUyGQu5E7bTw,19432
+sapiopycommons/ai/test_client.py,sha256=IRZ-8prhg7XMDmN9aC1MQr5mSkMgfT37aLsOy-VB-MU,20495
 sapiopycommons/ai/protoapi/externalcredentials/external_credentials_pb2.py,sha256=mEonoj6Iq-AyvO4m3YsPYu85aZfD1E0a0cL8B9yPfEo,2481
 sapiopycommons/ai/protoapi/externalcredentials/external_credentials_pb2.pyi,sha256=sfExq8fFwIwFxCpV50ytdxW5ePNBjJBr_80_trq_JQw,1658
 sapiopycommons/ai/protoapi/externalcredentials/external_credentials_pb2_grpc.py,sha256=TNS1CB_QGBSa1YU9sYR_hF-pmBwv2GpxjaNQoM_r9iU,948
@@ -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.13a781.dist-info/METADATA,sha256=Ex7Fc6UXveEGSs8qgYNAUSzjwKhsBOZU3jyOzIWKlyY,3143
-sapiopycommons-2025.10.13a781.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2025.10.13a781.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2025.10.13a781.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,,