unique_toolkit 1.19.0__py3-none-any.whl → 1.19.1__py3-none-any.whl

unique_toolkit/_common/api_calling/human_verification_manager.py

@@ -4,7 +4,7 @@ from logging import Logger
 from typing import Any, Generic
 
 import jinja2
-from pydantic import BaseModel
+from pydantic import BaseModel, ValidationError
 
 from unique_toolkit._common.endpoint_builder import (
     ApiOperationProtocol,
@@ -41,11 +41,13 @@ NEXT_USER_MESSAGE_JINJA2_TEMPLATE = jinja2.Template("""I confirm the api call wi
 ```""")
 
 
-ASSISTANT_CONFIRMATION_MESSAGE_JINJA2_TEMPLATE = jinja2.Template("""I would like to call the api with the following data:
-
+ASSISTANT_CONFIRMATION_MESSAGE_JINJA2_TEMPLATE = jinja2.Template(
+    """
+\n
 {{ api_call_as_markdown_table }}
-
-[{{ button_text }}](https://prompt={{ next_user_message | urlencode }})""")
+\n\n
+[{{ button_text }}](https://prompt={{ next_user_message | urlencode }})"""
+)
 
 
 class HumanVerificationManagerForApiCalling(
@@ -175,7 +177,9 @@ class HumanVerificationManagerForApiCalling(
                             self._environment_payload_params.model_dump()
                         )
 
-                    return self._operation.payload_model().model_validate(payload_dict)
+                    return self._operation.payload_model().model_validate(
+                        payload_dict, by_alias=True, by_name=True
+                    )
 
             except Exception as e:
                 self._logger.error(f"Error detecting api calls from user message: {e}")
@@ -211,7 +215,9 @@ class HumanVerificationManagerForApiCalling(
             modifiable_dict = payload_dict
 
         modifiable_params = self._modifiable_payload_params_model.model_validate(
-            modifiable_dict
+            modifiable_dict,
+            by_alias=True,
+            by_name=True,
         )
         api_call = self._verification_model(
             modifiable_params=modifiable_params,
@@ -226,10 +232,12 @@ class HumanVerificationManagerForApiCalling(
             api_call_as_json=api_call.model_dump_json(indent=2)
         )
 
-    def create_assistant_confirmation_message(self, *, payload: PayloadType) -> str:
+    def create_assistant_confirmation_message(
+        self, *, payload: PayloadType, button_text: str = "Confirm"
+    ) -> str:
         return ASSISTANT_CONFIRMATION_MESSAGE_JINJA2_TEMPLATE.render(
             api_call_as_markdown_table=dict_to_markdown_table(payload.model_dump()),
-            button_text="Please confirm the call by pressing this button.",
+            button_text=button_text,
             next_user_message=self._create_next_user_message(payload),
         )
 
@@ -255,7 +263,11 @@ class HumanVerificationManagerForApiCalling(
             context=context,
             **params,
         )
-        return self._operation.handle_response(response)
+        try:
+            return self._operation.handle_response(response)
+        except ValidationError as e:
+            self._logger.error(f"Error calling api: {e}. Response: {response}")
+            raise e
 
 
 if __name__ == "__main__":

unique_toolkit/_common/endpoint_builder.py

@@ -3,6 +3,7 @@ This module provides a minimal framework for building endpoint classes such that
 the endpoints without having to know the details of the endpoints.
 """
 
+import warnings
 from enum import StrEnum
 from string import Template
 from typing import (
@@ -15,7 +16,7 @@ from typing import (
     cast,
 )
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ValidationError
 
 # Paramspecs
 PayloadParamSpec = ParamSpec("PayloadParamSpec")
@@ -46,6 +47,42 @@ class HttpMethods(StrEnum):
 EndpointMethods = HttpMethods
 
 
+class ResponseValidationException(Exception):
+    """
+    This exception is raised when the response validation fails.
+    """
+
+    def __init__(
+        self, operation_name: str, response: dict[str, Any], pydantic_error: str
+    ):
+        super().__init__(
+            f"Response validation failed for operation {operation_name}\n"
+            f"Response: {response}\n"
+            f"Pydantic error: {pydantic_error}"
+        )
+        self._operation_name = operation_name
+        self._response = response
+        self._pydantic_error = pydantic_error
+
+    @property
+    def operation_name(self) -> str:
+        return self._operation_name
+
+    @property
+    def response(self) -> dict[str, Any]:
+        return self._response
+
+    @property
+    def pydantic_error(self) -> str:
+        return self._pydantic_error
+
+    def __str__(self):
+        return (
+            f"Response validation failed for {self._operation_name}\n"
+            + f"Response: {self._response}"
+        )
+
+
 class ApiOperationProtocol(
     Protocol,
     Generic[
@@ -56,12 +93,21 @@ class ApiOperationProtocol(
         ResponseType,
     ],
 ):
+    @staticmethod
+    def path_dump_options() -> dict[str, Any]: ...
+
     @staticmethod
     def path_params_model() -> type[PathParamsType]: ...
 
+    @staticmethod
+    def payload_dump_options() -> dict[str, Any]: ...
+
     @staticmethod
     def payload_model() -> type[PayloadType]: ...
 
+    @staticmethod
+    def response_validate_options() -> dict[str, Any]: ...
+
     @staticmethod
     def response_model() -> type[ResponseType]: ...
 
@@ -71,17 +117,24 @@ class ApiOperationProtocol(
     ) -> str: ...
 
     @staticmethod
-    def create_path_from_model(path_params: PathParamsType) -> str: ...
+    def create_path_from_model(
+        path_params: PathParamsType, *, model_dump_options: dict | None = None
+    ) -> str: ...
+
     @staticmethod
     def create_payload(
         *args: PayloadParamSpec.args, **kwargs: PayloadParamSpec.kwargs
     ) -> dict[str, Any]: ...
 
     @staticmethod
-    def create_payload_from_model(payload: PayloadType) -> dict[str, Any]: ...
+    def create_payload_from_model(
+        payload: PayloadType, *, model_dump_options: dict | None = None
+    ) -> dict[str, Any]: ...
 
     @staticmethod
-    def handle_response(response: dict[str, Any]) -> ResponseType: ...
+    def handle_response(
+        response: dict[str, Any], *, model_validate_options: dict | None = None
+    ) -> ResponseType: ...
 
     @staticmethod
     def request_method() -> EndpointMethods: ...
@@ -100,7 +153,10 @@ def build_api_operation(
     path_params_constructor: Callable[PathParamsSpec, PathParamsType],
     payload_constructor: Callable[PayloadParamSpec, PayloadType],
     response_model_type: type[ResponseType],
-    dump_options: dict | None = None,
+    payload_dump_options: dict | None = None,
+    path_dump_options: dict | None = None,
+    response_validate_options: dict | None = None,
+    dump_options: dict | None = None,  # Deprecated
 ) -> type[
     ApiOperationProtocol[
         PathParamsSpec,
@@ -126,16 +182,33 @@ def build_api_operation(
             "by_alias": True,
             "exclude_defaults": True,
         }
+    else:
+        warnings.warn(
+            "dump_options is deprecated. Use payload_dump_options instead.",
+            DeprecationWarning,
+        )
 
     class Operation(ApiOperationProtocol):
+        @staticmethod
+        def path_dump_options() -> dict[str, Any]:
+            return path_dump_options or {}
+
         @staticmethod
         def path_params_model() -> type[PathParamsType]:
             return cast(type[PathParamsType], path_params_constructor)
 
+        @staticmethod
+        def payload_dump_options() -> dict[str, Any]:
+            return payload_dump_options or {}
+
         @staticmethod
         def payload_model() -> type[PayloadType]:
             return cast(type[PayloadType], payload_constructor)
 
+        @staticmethod
+        def response_validate_options() -> dict[str, Any]:
+            return response_validate_options or {}
+
         @staticmethod
         def response_model() -> type[ResponseType]:
             return response_model_type
@@ -145,8 +218,18 @@ def build_api_operation(
             return path_template
 
         @staticmethod
-        def create_path_from_model(path_params: PathParamsType) -> str:
-            return path_template.substitute(**path_params.model_dump(**dump_options))
+        def create_path_from_model(
+            path_params: PathParamsType, *, model_dump_options: dict | None = None
+        ) -> str:
+            if model_dump_options is None:
+                if path_dump_options is None:
+                    model_dump_options = dump_options
+                else:
+                    model_dump_options = path_dump_options
+
+            return path_template.substitute(
+                **path_params.model_dump(**model_dump_options)
+            )
 
         @staticmethod
         def create_path(
@@ -157,19 +240,51 @@ def build_api_operation(
 
         @staticmethod
         def create_payload(
-            *args: PayloadParamSpec.args, **kwargs: PayloadParamSpec.kwargs
+            *args: PayloadParamSpec.args,
+            **kwargs: PayloadParamSpec.kwargs,
         ) -> dict[str, Any]:
             """Create request body payload."""
+            if payload_dump_options is None:
+                model_dump_options = dump_options
+            else:
+                model_dump_options = payload_dump_options
+
             request_model = Operation.payload_model()(*args, **kwargs)
-            return request_model.model_dump(**dump_options)
+            return request_model.model_dump(**model_dump_options)
 
         @staticmethod
-        def create_payload_from_model(payload: PayloadType) -> dict[str, Any]:
-            return payload.model_dump(**dump_options)
+        def create_payload_from_model(
+            payload: PayloadType, *, model_dump_options: dict | None = None
+        ) -> dict[str, Any]:
+            if model_dump_options is None:
+                if payload_dump_options is None:
+                    model_dump_options = dump_options
+                else:
+                    model_dump_options = payload_dump_options
+
+            return payload.model_dump(**model_dump_options)
 
         @staticmethod
-        def handle_response(response: dict[str, Any]) -> ResponseType:
-            return Operation.response_model().model_validate(response)
+        def handle_response(
+            response: dict[str, Any],
+            *,
+            model_validate_options: dict[str, Any] | None = None,
+        ) -> ResponseType:
+            if model_validate_options is None:
+                if response_validate_options is None:
+                    model_validate_options = {}
+                else:
+                    model_validate_options = response_validate_options
+            try:
+                return Operation.response_model().model_validate(
+                    response, **model_validate_options
+                )
+            except ValidationError as e:
+                raise ResponseValidationException(
+                    operation_name=Operation.__name__,
+                    response=response,
+                    pydantic_error=str(e),
+                ) from e
 
         @staticmethod
         def request_method() -> HttpMethods:

unique_toolkit/_common/endpoint_requestor.py

@@ -86,7 +86,10 @@ def build_fake_requestor(
                     f"Invalid parameters passed to combined model {combined_model.__name__}: {e}"
                 )
 
-            return cls._operation.handle_response(return_value)
+            return cls._operation.handle_response(
+                return_value,
+                model_validate_options=cls._operation.response_validate_options(),
+            )
 
         @classmethod
         async def request_async(
@@ -132,11 +135,15 @@ def build_request_requestor(
                 combined=kwargs
             )
 
-            path = cls._operation.create_path_from_model(path_params)
+            path = cls._operation.create_path_from_model(
+                path_params, model_dump_options=cls._operation.path_dump_options()
+            )
             url = urljoin(context.base_url, path)
             _verify_url(url)
 
-            payload = cls._operation.create_payload_from_model(payload_model)
+            payload = cls._operation.create_payload_from_model(
+                payload_model, model_dump_options=cls._operation.payload_dump_options()
+            )
 
             response = requests.request(
                 method=cls._operation.request_method(),
@@ -144,7 +151,13 @@ def build_request_requestor(
                 headers=context.headers,
                 json=payload,
             )
-            return cls._operation.handle_response(response.json())
+
+            response_json = response.json()
+
+            return cls._operation.handle_response(
+                response_json,
+                model_validate_options=cls._operation.response_validate_options(),
+            )
 
         @classmethod
         async def request_async(
@@ -191,7 +204,9 @@ def build_httpx_requestor(
                 combined=kwargs
             )
 
-            path = cls._operation.create_path_from_model(path_params)
+            path = cls._operation.create_path_from_model(
+                path_params, model_dump_options=cls._operation.path_dump_options()
+            )
             url = urljoin(context.base_url, path)
             _verify_url(url)
             with httpx.Client() as client:
@@ -199,9 +214,16 @@ def build_httpx_requestor(
                     method=cls._operation.request_method(),
                     url=url,
                     headers=headers,
-                    json=cls._operation.create_payload_from_model(payload_model),
+                    json=cls._operation.create_payload_from_model(
+                        payload_model,
+                        model_dump_options=cls._operation.payload_dump_options(),
+                    ),
+                )
+                response_json = response.json()
+                return cls._operation.handle_response(
+                    response_json,
+                    model_validate_options=cls._operation.response_validate_options(),
                 )
-                return cls._operation.handle_response(response.json())
 
         @classmethod
         async def request_async(
@@ -216,7 +238,9 @@ def build_httpx_requestor(
                 combined=kwargs
             )
 
-            path = cls._operation.create_path_from_model(path_params)
+            path = cls._operation.create_path_from_model(
+                path_params, model_dump_options=cls._operation.path_dump_options()
+            )
             url = urljoin(context.base_url, path)
             _verify_url(url)
             async with httpx.AsyncClient() as client:
@@ -224,9 +248,16 @@ def build_httpx_requestor(
                     method=cls._operation.request_method(),
                     url=url,
                     headers=headers,
-                    json=cls._operation.create_payload_from_model(payload_model),
+                    json=cls._operation.create_payload_from_model(
+                        payload_model,
+                        model_dump_options=cls._operation.payload_dump_options(),
+                    ),
+                )
+                response_json = response.json()
+                return cls._operation.handle_response(
+                    response_json,
+                    model_validate_options=cls._operation.response_validate_options(),
                 )
-                return cls._operation.handle_response(response.json())
 
     return HttpxRequestor
 
@@ -272,7 +303,9 @@ def build_aiohttp_requestor(
             path_params, payload_model = cls._operation.models_from_combined(
                 combined=kwargs
             )
-            path = cls._operation.create_path_from_model(path_params)
+            path = cls._operation.create_path_from_model(
+                path_params, model_dump_options=cls._operation.path_dump_options()
+            )
             url = urljoin(context.base_url, path)
             _verify_url(url)
 
@@ -281,9 +314,16 @@ def build_aiohttp_requestor(
                     method=cls._operation.request_method(),
                     url=url,
                     headers=headers,
-                    json=cls._operation.create_payload_from_model(payload_model),
+                    json=cls._operation.create_payload_from_model(
+                        payload=payload_model,
+                        model_dump_options=cls._operation.payload_dump_options(),
+                    ),
+                )
+                response_json = await response.json()
+                return cls._operation.handle_response(
+                    response=response_json,
+                    model_validate_options=cls._operation.response_validate_options(),
                 )
-            return cls._operation.handle_response(await response.json())
 
     return AiohttpRequestor
 
@@ -367,7 +407,7 @@ if __name__ == "__main__":
 
     # Note that the return value is a pydantic UserResponse object
     response = FakeUserRequestor().request(
-        context=RequestContext(headers={"a": "b"}),
+        context=RequestContext(base_url="https://example.com", headers={"a": "b"}),
         user_id=123,
         include_profile=True,
     )
@@ -379,7 +419,9 @@ if __name__ == "__main__":
 
     # Check type hints
     response = RequestRequestor().request(
-        context=RequestContext(headers={"a": "b"}), user_id=123, include_profile=True
+        context=RequestContext(base_url="https://example.com", headers={"a": "b"}),
+        user_id=123,
+        include_profile=True,
     )
 
     print(response.model_dump())

unique_toolkit/_common/exception.py

@@ -35,3 +35,23 @@ class CommonException(Exception):
 
 class ConfigurationException(Exception):
     pass
+
+
+class InfoExceptionForAi(Exception):
+    """
+    This exception is raised as information to the AI.
+    Such that it can be used to inform the user about the error.
+    In a meaningful way.
+    """
+
+    def __init__(
+        self,
+        error_message: str,
+        message_for_ai: str,
+    ):
+        super().__init__(error_message)
+        self._message_for_ai = message_for_ai
+
+    @property
+    def message_for_ai(self):
+        return self._message_for_ai

{unique_toolkit-1.19.0.dist-info → unique_toolkit-1.19.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 1.19.0
+Version: 1.19.1
 Summary: 
 License: Proprietary
 Author: Cedric Klinkert
@@ -118,6 +118,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.19.1] - 2025-10-29
+- Make api operations more flexible
+- Make verification button text adaptable
+
 
 ## [1.19.0] - 2025-10-28
 - Enable additional headers on openai and langchain client

{unique_toolkit-1.19.0.dist-info → unique_toolkit-1.19.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
 unique_toolkit/__init__.py,sha256=qrQ0kgAZnmGR6-UpWOpAL4yd-2ic5Jjwh6s8et-7ZTc,1372
 unique_toolkit/_common/_base_service.py,sha256=S8H0rAebx7GsOldA7xInLp3aQJt9yEPDQdsGSFRJsGg,276
 unique_toolkit/_common/_time_utils.py,sha256=ztmTovTvr-3w71Ns2VwXC65OKUUh-sQlzbHdKTQWm-w,135
-unique_toolkit/_common/api_calling/human_verification_manager.py,sha256=AeGzaGYlo8RHwEp7jhWM7gdx32dRyLUIioZRfrVbgUI,11905
+unique_toolkit/_common/api_calling/human_verification_manager.py,sha256=cM_sS0BqnKhbgXMw90QGi140JPbTP5P6MsyR92SnLt8,12169
 unique_toolkit/_common/base_model_type_attribute.py,sha256=7rzVqjXa0deYEixeo_pJSJcQ7nKXpWK_UGpOiEH3yZY,10382
 unique_toolkit/_common/chunk_relevancy_sorter/config.py,sha256=tHETuMIC4CA_TPwU0oaHbckaKhvMFMYdO_d4lNRKnRc,1806
 unique_toolkit/_common/chunk_relevancy_sorter/exception.py,sha256=1mY4zjbvnXsd5oIxwiVsma09bS2XRnHrxW8KJBGtgCM,126
@@ -9,9 +9,9 @@ unique_toolkit/_common/chunk_relevancy_sorter/schemas.py,sha256=YAyvXzVk8h5q6FEs
 unique_toolkit/_common/chunk_relevancy_sorter/service.py,sha256=ZX1pxcy53zh3Ha0_pN6yYIbMX1acRxcvqKTPTKpGKwA,13938
 unique_toolkit/_common/chunk_relevancy_sorter/tests/test_service.py,sha256=giD9b5W8A0xP18dZCcrLUruoGi38BeBvPnO1phY7Sp0,8892
 unique_toolkit/_common/default_language_model.py,sha256=XCZu6n270QkxEeTpj5NZJda6Ok_IR-GcS8w30DU21aI,343
-unique_toolkit/_common/endpoint_builder.py,sha256=09Y8rC83oNsmxBLAf7WiHqK_OjZmeKb82TPzF0SLSVM,5499
-unique_toolkit/_common/endpoint_requestor.py,sha256=3B7ekfiTmgCEc2h1_m94DsfPwigE2yfiFUmbAAdjuVc,12039
-unique_toolkit/_common/exception.py,sha256=hwh60UUawHDyPFNs-Wom-Gc6Yb09gPelftAuW1tXE6o,779
+unique_toolkit/_common/endpoint_builder.py,sha256=Ge83hyipUbh4fhxzA5XVeg3cj6T4JU4dL8Ue9MWElcw,9100
+unique_toolkit/_common/endpoint_requestor.py,sha256=pY2SlRaHmHftNpPybmzxRsn4OBZCj_7niCMehL8I5O0,13744
+unique_toolkit/_common/exception.py,sha256=ho0uBcPeZXU2w15IrSBhO5w7KUgxp1HcKAQrf2uin-w,1243
 unique_toolkit/_common/feature_flags/schema.py,sha256=F1NdVJFNU8PKlS7bYzrIPeDu2LxRqHSM9pyw622a1Kk,547
 unique_toolkit/_common/pydantic/rjsf_tags.py,sha256=T3AZIF8wny3fFov66s258nEl1GqfKevFouTtG6k9PqU,31219
 unique_toolkit/_common/pydantic_helpers.py,sha256=1zzg6PlzSkHqPTdX-KoBaDHmBeeG7S5PprBsyMSCEuU,4806
@@ -165,7 +165,7 @@ unique_toolkit/short_term_memory/service.py,sha256=5PeVBu1ZCAfyDb2HLVvlmqSbyzBBu
 unique_toolkit/smart_rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 unique_toolkit/smart_rules/compile.py,sha256=Ozhh70qCn2yOzRWr9d8WmJeTo7AQurwd3tStgBMPFLA,1246
 unique_toolkit/test_utilities/events.py,sha256=_mwV2bs5iLjxS1ynDCjaIq-gjjKhXYCK-iy3dRfvO3g,6410
-unique_toolkit-1.19.0.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
-unique_toolkit-1.19.0.dist-info/METADATA,sha256=vFbZDvCyQYheZ7FvASbBZh5M7PqjI4GoRVqDbGkcAKY,38772
-unique_toolkit-1.19.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_toolkit-1.19.0.dist-info/RECORD,,
+unique_toolkit-1.19.1.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
+unique_toolkit-1.19.1.dist-info/METADATA,sha256=Dh7RpQJ3P5uPe9kN7mfhkBY5I0lgSC7aK4uLJVJBsEI,38876
+unique_toolkit-1.19.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_toolkit-1.19.1.dist-info/RECORD,,