unique_toolkit 1.32.0__tar.gz → 1.33.0__tar.gz

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.33.0] - 2025-11-28
+- Add support for system reminders in sub agent responses.
+
+## [1.32.1] - 2025-12-01
+- Added documentation for the toolkit,some missing type hints and doc string fixes.
+
 ## [1.32.0] - 2025-11-28
 - Add option to filter duplicate sub agent answers.
 

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 1.32.0
+Version: 1.33.0
 Summary: 
 License: Proprietary
 Author: Cedric Klinkert
@@ -121,6 +121,12 @@ 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.33.0] - 2025-11-28
+- Add support for system reminders in sub agent responses.
+
+## [1.32.1] - 2025-12-01
+- Added documentation for the toolkit,some missing type hints and doc string fixes.
+
 ## [1.32.0] - 2025-11-28
 - Add option to filter duplicate sub agent answers.
 

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "1.32.0"
+version = "1.33.0"
 description = ""
 authors = [
     "Cedric Klinkert <cedric.klinkert@unique.ch>",

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/_common/utils/jinja/render.py

@@ -5,8 +5,14 @@ from jinja2 import Template
 from unique_toolkit._common.utils.jinja.schema import Jinja2PromptParams
 
 
-def render_template(template: str, params: Jinja2PromptParams | dict[str, Any]) -> str:
+def render_template(
+    template: str, params: Jinja2PromptParams | dict[str, Any] | None = None, **kwargs
+) -> str:
+    params = params or {}
+
     if isinstance(params, Jinja2PromptParams):
         params = params.model_dump(exclude_none=True, mode="json")
 
+    params.update(kwargs)
+
     return Template(template, lstrip_blocks=True).render(**params)

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/agentic/tools/a2a/tool/config.py

@@ -1,10 +1,74 @@
-from typing import Literal
+import re
+from enum import StrEnum
+from typing import Annotated, Generic, Literal, TypeVar
 
 from pydantic import Field
+from pydantic.main import BaseModel
 
 from unique_toolkit._common.pydantic_helpers import get_configuration_dict
 from unique_toolkit.agentic.tools.schemas import BaseToolConfig
 
+
+class SubAgentSystemReminderType(StrEnum):
+    FIXED = "fixed"
+    REGEXP = "regexp"
+    REFERENCE = "reference"
+
+
+T = TypeVar("T", bound=SubAgentSystemReminderType)
+
+
+class SystemReminderConfig(BaseModel, Generic[T]):
+    model_config = get_configuration_dict()
+
+    type: T
+
+
+_SYSTEM_REMINDER_FIELD_DESCRIPTION = """
+The reminder to add to the tool response. The reminder can be a Jinja template and can contain the following placeholders:
+- {{ display_name }}: The display name of the sub agent.
+- {{ tool_name }}: The tool name. 
+""".strip()
+
+
+class ReferenceSystemReminderConfig(SystemReminderConfig):
+    type: Literal[SubAgentSystemReminderType.REFERENCE] = (
+        SubAgentSystemReminderType.REFERENCE
+    )
+    reminder: str = Field(
+        default="Rememeber to properly reference EACH fact from sub agent {{ display_name }}'s response with the correct format INLINE.",
+        description=_SYSTEM_REMINDER_FIELD_DESCRIPTION,
+    )
+
+
+class FixedSystemReminderConfig(SystemReminderConfig):
+    type: Literal[SubAgentSystemReminderType.FIXED] = SubAgentSystemReminderType.FIXED
+    reminder: str = Field(
+        description=_SYSTEM_REMINDER_FIELD_DESCRIPTION,
+    )
+
+
+_REGEXP_DETECTED_REMINDER_FIELD_DESCRIPTION = """
+The reminder to add to the tool response. The reminder can be a Jinja template and can contain the following placeholders:
+- {{ display_name }}: The display name of the sub agent.
+- {{ tool_name }}: The tool name. 
+- {{ text_matches }}: Will be replaced with the portions of the text that triggered the reminder.
+""".strip()
+
+
+class RegExpDetectedSystemReminderConfig(SystemReminderConfig):
+    """A system reminder that is only added if the sub agent response matches a regular expression."""
+
+    type: Literal[SubAgentSystemReminderType.REGEXP] = SubAgentSystemReminderType.REGEXP
+
+    regexp: re.Pattern[str] = Field(
+        description="The regular expression to use to detect whether the system reminder should be added.",
+    )
+    reminder: str = Field(
+        description=_REGEXP_DETECTED_REMINDER_FIELD_DESCRIPTION,
+    )
+
+
 DEFAULT_PARAM_DESCRIPTION_SUB_AGENT_USER_MESSAGE = """
 This is the message that will be sent to the sub-agent.
 """.strip()
@@ -80,3 +144,15 @@ class SubAgentToolConfig(BaseToolConfig):
         default=False,
         description="If set, the sub-agent response will be interpreted as a list of content chunks.",
     )
+
+    system_reminders_config: list[
+        Annotated[
+            FixedSystemReminderConfig
+            | RegExpDetectedSystemReminderConfig
+            | ReferenceSystemReminderConfig,
+            Field(discriminator="type"),
+        ]
+    ] = Field(
+        default=[],
+        description="Configuration for the system reminders to add to the tool response.",
+    )

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/agentic/tools/a2a/tool/service.py

@@ -4,7 +4,7 @@ import json
 import logging
 import re
 from datetime import datetime
-from typing import override
+from typing import cast, override
 
 import unique_sdk
 from pydantic import Field, TypeAdapter, create_model
@@ -15,6 +15,7 @@ from unique_toolkit._common.referencing import (
     remove_all_refs,
     replace_ref_number,
 )
+from unique_toolkit._common.utils.jinja.render import render_template
 from unique_toolkit.agentic.evaluation.schemas import EvaluationMetricName
 from unique_toolkit.agentic.tools.a2a.response_watcher import SubAgentResponseWatcher
 from unique_toolkit.agentic.tools.a2a.tool._memory import (
@@ -25,6 +26,8 @@ from unique_toolkit.agentic.tools.a2a.tool._schema import (
     SubAgentToolInput,
 )
 from unique_toolkit.agentic.tools.a2a.tool.config import (
+    RegExpDetectedSystemReminderConfig,
+    SubAgentSystemReminderType,
     SubAgentToolConfig,
 )
 from unique_toolkit.agentic.tools.factory import ToolFactory
@@ -215,12 +218,63 @@ class SubAgentTool(Tool[SubAgentToolConfig]):
             )
 
             return ToolCallResponse(
-                id=tool_call.id,  # type: ignore
+                id=tool_call.id,
                 name=tool_call.name,
-                content=content,
+                content=_format_response(
+                    tool_name=self.name,
+                    text=content,
+                    system_reminders=self._get_system_reminders(response),
+                ),
                 content_chunks=content_chunks,
             )
 
+    def _get_system_reminders(self, message: unique_sdk.Space.Message) -> list[str]:
+        reminders = []
+        for reminder_config in self.config.system_reminders_config:
+            if reminder_config.type == SubAgentSystemReminderType.FIXED:
+                reminders.append(
+                    render_template(
+                        reminder_config.reminder,
+                        display_name=self.display_name(),
+                        tool_name=self.name,
+                    )
+                )
+            elif (
+                reminder_config.type == SubAgentSystemReminderType.REFERENCE
+                and self.config.use_sub_agent_references
+                and message["references"] is not None
+                and len(message["references"]) > 0
+            ):
+                reminders.append(
+                    render_template(
+                        reminder_config.reminder,
+                        display_name=self.display_name(),
+                        tool_name=self.name,
+                    )
+                )
+            elif (
+                reminder_config.type == SubAgentSystemReminderType.REGEXP
+                and message["text"] is not None
+            ):
+                reminder_config = cast(
+                    RegExpDetectedSystemReminderConfig, reminder_config
+                )
+                text_matches = [
+                    match.group(0)
+                    for match in reminder_config.regexp.finditer(message["text"])
+                ]
+                if len(text_matches) > 0:
+                    reminders.append(
+                        render_template(
+                            reminder_config.reminder,
+                            display_name=self.display_name(),
+                            tool_name=self.name,
+                            text_matches=text_matches,
+                        )
+                    )
+
+        return reminders
+
     async def _get_chat_id(self) -> str | None:
         if not self.config.reuse_chat:
             return None
@@ -326,4 +380,14 @@ class SubAgentTool(Tool[SubAgentToolConfig]):
             ) from e
 
 
+def _format_response(tool_name: str, text: str, system_reminders: list[str]) -> str:
+    if len(system_reminders) == 0:
+        return text
+
+    reponse_key = f"{tool_name} response"
+    response = {reponse_key: text, "SYSTEM_REMINDERS": system_reminders}
+
+    return json.dumps(response, indent=2)
+
+
 ToolFactory.register_tool(SubAgentTool, SubAgentToolConfig)

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/chat/functions.py

@@ -263,7 +263,7 @@ def create_message(
     references: list[ContentReference] | None = None,
     debug_info: dict | None = None,
     set_completed_at: bool | None = False,
-):
+) -> ChatMessage:
     """Creates a message in the chat session synchronously.
 
     Args:

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/content/functions.py

@@ -144,7 +144,7 @@ def search_contents(
     chat_id: str,
     where: dict,
     include_failed_content: bool = False,
-):
+) -> list[Content]:
     """
     Performs an asynchronous search for content files in the knowledge base by filter.
 
@@ -297,7 +297,7 @@ def upload_content_from_bytes(
     skip_ingestion: bool = False,
     ingestion_config: unique_sdk.Content.IngestionConfig | None = None,
     metadata: dict[str, Any] | None = None,
-):
+) -> Content:
     """
     Uploads content to the knowledge base.
 
@@ -347,7 +347,7 @@ def upload_content(
     skip_excel_ingestion: bool = False,
     ingestion_config: unique_sdk.Content.IngestionConfig | None = None,
     metadata: dict[str, Any] | None = None,
-):
+) -> Content:
     """
     Uploads content to the knowledge base.
 
@@ -399,7 +399,7 @@ def _trigger_upload_content(
     skip_excel_ingestion: bool = False,
     ingestion_config: unique_sdk.Content.IngestionConfig | None = None,
     metadata: dict[str, Any] | None = None,
-):
+) -> Content:
     """
     Uploads content to the knowledge base.
 

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/content/service.py

@@ -528,7 +528,7 @@ class ContentService:
         skip_excel_ingestion: bool = False,
         ingestion_config: unique_sdk.Content.IngestionConfig | None = None,
         metadata: dict[str, Any] | None = None,
-    ):
+    ) -> Content:
         """
         Uploads content to the knowledge base.
 

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/embedding/service.py

@@ -145,7 +145,7 @@ class EmbeddingService(BaseService):
         Embed text.
 
         Args:
-            text (str): The text to embed.
+            texts (list[str]): The texts to embed.
             timeout (int): The timeout in milliseconds. Defaults to 600000.
 
         Returns:

unique_toolkit-1.33.0/unique_toolkit/framework_utilities/langchain/__init__.py

@@ -0,0 +1,10 @@
+"""Langchain framework utilities."""
+
+try:
+    from .client import LangchainNotInstalledError, get_langchain_client
+
+    __all__ = ["get_langchain_client", "LangchainNotInstalledError"]
+except (ImportError, Exception):
+    # If langchain is not installed, don't export anything
+    # This handles both ImportError and LangchainNotInstalledError
+    __all__ = []

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/framework_utilities/openai/client.py

@@ -30,7 +30,8 @@ def get_openai_client(
     """Get an OpenAI client instance.
 
     Args:
-        env_file: Optional path to environment file
+        unique_settings (UniqueSettings | None): Optional UniqueSettings instance
+        additional_headers (dict[str, str] | None): Optional additional headers to add to the request
 
     Returns:
         OpenAI client instance

{unique_toolkit-1.32.0 → unique_toolkit-1.33.0}/unique_toolkit/services/knowledge_base.py

@@ -377,7 +377,6 @@ class KnowledgeBaseService:
             mime_type (str): The MIME type of the content.
             scope_id (str | None): The scope ID. Defaults to None.
             skip_ingestion (bool): Whether to skip ingestion. Defaults to False.
-            skip_excel_ingestion (bool): Whether to skip excel ingestion. Defaults to False.
             ingestion_config (unique_sdk.Content.IngestionConfig | None): The ingestion configuration. Defaults to None.
             metadata (dict | None): The metadata to associate with the content. Defaults to None.
 
@@ -449,7 +448,7 @@ class KnowledgeBaseService:
         skip_excel_ingestion: bool = False,
         ingestion_config: unique_sdk.Content.IngestionConfig | None = None,
         metadata: dict[str, Any] | None = None,
-    ):
+    ) -> Content:
         """
         Uploads content to the knowledge base.
 
@@ -487,14 +486,14 @@ class KnowledgeBaseService:
         content_id: str,
         output_dir_path: Path | None = None,
         output_filename: str | None = None,
-    ):
+    ) -> Path:
         """
         Downloads content from a chat and saves it to a file.
 
         Args:
             content_id (str): The ID of the content to download.
-            filename (str | None): The name of the file to save the content as. If not provided, the original filename will be used. Defaults to None.
-            tmp_dir_path (str | Path | None): The path to the temporary directory where the content will be saved. Defaults to "/tmp".
+            output_filename (str | None): The name of the file to save the content as. If not provided, the original filename will be used. Defaults to None.
+            output_dir_path (str | Path | None): The path to the temporary directory where the content will be saved. Defaults to "/tmp".
 
         Returns:
             Path: The path to the downloaded file.
@@ -522,7 +521,6 @@ class KnowledgeBaseService:
 
         Args:
             content_id (str): The id of the uploaded content.
-            chat_id (Optional[str]): The chat_id, defaults to None.
 
         Returns:
             bytes: The downloaded content.