digitalkin 0.2.23__py3-none-any.whl → 0.3.1.dev2__py3-none-any.whl

digitalkin/models/module/module_types.py

@@ -1,17 +1,31 @@
 """Types for module models."""
 
+from __future__ import annotations
+
+import copy
+import types
+import typing
 from datetime import datetime, timezone
-from typing import Any, ClassVar, Generic, TypeVar, cast
+from typing import TYPE_CHECKING, Any, ClassVar, Generic, TypeVar, cast, get_args, get_origin
 
 from pydantic import BaseModel, ConfigDict, Field, create_model
 
 from digitalkin.logger import logger
+from digitalkin.utils.dynamic_schema import (
+    DynamicField,
+    get_fetchers,
+    has_dynamic,
+    resolve_safe,
+)
+
+if TYPE_CHECKING:
+    from pydantic.fields import FieldInfo
 
 
 class DataTrigger(BaseModel):
-    """Defines the root input model exposing the protocol.
+    """Defines the root input/output model exposing the protocol.
 
-    The mandatory protocol is important to define the module beahvior following the user or agent input.
+    The mandatory protocol is important to define the module beahvior following the user or agent input/output.
 
     Example:
         class MyInput(DataModel):
@@ -24,16 +38,20 @@ class DataTrigger(BaseModel):
     """
 
     protocol: ClassVar[str]
-    created_at: str = datetime.now(tz=timezone.utc).isoformat()
+    created_at: str = Field(
+        default_factory=lambda: datetime.now(tz=timezone.utc).isoformat(),
+        title="Created At",
+        description="Timestamp when the payload was created.",
+    )
 
 
 DataTriggerT = TypeVar("DataTriggerT", bound=DataTrigger)
 
 
 class DataModel(BaseModel, Generic[DataTriggerT]):
-    """Base definition of input model showing mandatory root fields.
+    """Base definition of input/output model showing mandatory root fields.
 
-    The Model define the Module Input, usually referring to multiple input type defined by an union.
+    The Model define the Module Input/output, usually referring to multiple input/output type defined by an union.
 
     Example:
         class ModuleInput(DataModel):
@@ -57,27 +75,50 @@ SetupModelT = TypeVar("SetupModelT", bound="SetupModel")
 class SetupModel(BaseModel):
     """Base definition of setup model showing mandatory root fields.
 
-    Optionally, the setup model can define a config option in json_schema_extra to be used to initialize the Kin.
+    Optionally, the setup model can define a config option in json_schema_extra
+    to be used to initialize the Kin. Supports dynamic schema providers for
+    runtime value generation.
 
-    Example:
-        class MySetup(SetupModel):
-            name: str = Field()
-            number: int = Field(..., json_schema_extra={"config": True})
+    Attributes:
+        model_fields: Inherited from Pydantic BaseModel, contains field definitions.
+
+    See Also:
+        - Documentation: docs/api/dynamic_schema.md
+        - Tests: tests/modules/test_setup_model.py
     """
 
     @classmethod
-    def get_clean_model(cls, *, config_fields: bool, hidden_fields: bool) -> type[SetupModelT]:  # type: ignore
-        """Dynamically builds and returns a new BaseModel subclass.
+    async def get_clean_model(
+        cls,
+        *,
+        config_fields: bool,
+        hidden_fields: bool,
+        force: bool = False,
+    ) -> type[SetupModelT]:
+        """Dynamically builds and returns a new BaseModel subclass with filtered fields.
 
-        containing only those fields where json_schema_extra["config"] == True.
+        This method filters fields based on their `json_schema_extra` metadata:
+        - Fields with `{"config": True}` are included only when `config_fields=True`
+        - Fields with `{"hidden": True}` are included only when `hidden_fields=True`
 
-        Returns:
-            Type[BaseModel]: A new BaseModel subclass with the filtered fields.
+        When `force=True`, fields with dynamic schema providers will have their
+        providers called to fetch fresh values for schema metadata like enums.
+        This includes recursively processing nested BaseModel fields.
 
-        Raises:
-            ValueError: If both config_fields and hidden_fields are set to True.
+        Args:
+            config_fields: If True, include fields marked with `{"config": True}`.
+                These are typically initial configuration fields.
+            hidden_fields: If True, include fields marked with `{"hidden": True}`.
+                These are typically runtime-only fields not shown in initial config.
+            force: If True, refresh dynamic schema fields by calling their providers.
+                Use this when you need up-to-date values from external sources like
+                databases or APIs. Default is False for performance.
+
+        Returns:
+            A new BaseModel subclass with filtered fields.
         """
         clean_fields: dict[str, Any] = {}
+
         for name, field_info in cls.model_fields.items():
             extra = getattr(field_info, "json_schema_extra", {}) or {}
             is_config = bool(extra.get("config", False))
@@ -93,7 +134,27 @@ class SetupModel(BaseModel):
                 logger.debug("Skipping '%s' (hidden-only)", name)
                 continue
 
-            clean_fields[name] = (field_info.annotation, field_info)
+            # Refresh dynamic schema fields when force=True
+            current_field_info = field_info
+            current_annotation = field_info.annotation
+
+            if force:
+                # Check if this field has DynamicField metadata
+                if has_dynamic(field_info):
+                    current_field_info = await cls._refresh_field_schema(name, field_info)
+
+                # Check if the annotation is a nested BaseModel that might have dynamic fields
+                nested_model = cls._get_base_model_type(current_annotation)
+                if nested_model is not None:
+                    refreshed_nested = await cls._refresh_nested_model(nested_model)
+                    if refreshed_nested is not nested_model:
+                        # Update annotation to use refreshed nested model
+                        current_annotation = refreshed_nested
+                        # Create new field_info with updated annotation (deep copy for safety)
+                        current_field_info = copy.deepcopy(current_field_info)
+                        setattr(current_field_info, "annotation", current_annotation)
+
+            clean_fields[name] = (current_annotation, current_field_info)
 
         # Dynamically create a model e.g. "SetupModel"
         m = create_model(
@@ -103,3 +164,230 @@ class SetupModel(BaseModel):
             **clean_fields,
         )
         return cast("type[SetupModelT]", m)
+
+    @classmethod
+    def _get_base_model_type(cls, annotation: type | None) -> type[BaseModel] | None:
+        """Extract BaseModel type from an annotation.
+
+        Handles direct types, Optional, Union, list, dict, set, tuple, and other generics.
+
+        Args:
+            annotation: The type annotation to inspect.
+
+        Returns:
+            The BaseModel subclass if found, None otherwise.
+        """
+        if annotation is None:
+            return None
+
+        # Direct BaseModel subclass check
+        if isinstance(annotation, type) and issubclass(annotation, BaseModel):
+            return annotation
+
+        origin = get_origin(annotation)
+        if origin is None:
+            return None
+
+        args = get_args(annotation)
+        return cls._extract_base_model_from_args(origin, args)
+
+    @classmethod
+    def _extract_base_model_from_args(
+        cls,
+        origin: type,
+        args: tuple[type, ...],
+    ) -> type[BaseModel] | None:
+        """Extract BaseModel from generic type arguments.
+
+        Args:
+            origin: The generic origin type (list, dict, Union, etc.).
+            args: The type arguments.
+
+        Returns:
+            The BaseModel subclass if found, None otherwise.
+        """
+        # Union/Optional: check each arg (supports both typing.Union and types.UnionType)
+        # Python 3.10+ uses types.UnionType for X | Y syntax
+        if origin is typing.Union or origin is types.UnionType:
+            return cls._find_base_model_in_args(args)
+
+        # list, set, frozenset: check first arg
+        if origin in {list, set, frozenset} and args:
+            return cls._check_base_model(args[0])
+
+        # dict: check value type (second arg)
+        dict_value_index = 1
+        if origin is dict and len(args) > dict_value_index:
+            return cls._check_base_model(args[dict_value_index])
+
+        # tuple: check first non-ellipsis arg
+        if origin is tuple:
+            return cls._find_base_model_in_args(args, skip_ellipsis=True)
+
+        return None
+
+    @classmethod
+    def _check_base_model(cls, arg: type) -> type[BaseModel] | None:
+        """Check if arg is a BaseModel subclass.
+
+        Returns:
+            The BaseModel subclass if arg is one, None otherwise.
+        """
+        if isinstance(arg, type) and issubclass(arg, BaseModel):
+            return arg
+        return None
+
+    @classmethod
+    def _find_base_model_in_args(
+        cls,
+        args: tuple[type, ...],
+        *,
+        skip_ellipsis: bool = False,
+    ) -> type[BaseModel] | None:
+        """Find first BaseModel in args.
+
+        Returns:
+            The first BaseModel subclass found, None otherwise.
+        """
+        for arg in args:
+            if arg is type(None):
+                continue
+            if skip_ellipsis and arg is ...:
+                continue
+            result = cls._check_base_model(arg)
+            if result is not None:
+                return result
+        return None
+
+    @classmethod
+    async def _refresh_nested_model(cls, model_cls: type[BaseModel]) -> type[BaseModel]:
+        """Refresh dynamic fields in a nested BaseModel.
+
+        Creates a new model class with all DynamicField metadata resolved.
+
+        Args:
+            model_cls: The nested model class to refresh.
+
+        Returns:
+            A new model class with refreshed fields, or the original if no changes.
+        """
+        has_changes = False
+        clean_fields: dict[str, Any] = {}
+
+        for name, field_info in model_cls.model_fields.items():
+            current_field_info = field_info
+            current_annotation = field_info.annotation
+
+            # Check if field has DynamicField metadata
+            if has_dynamic(field_info):
+                current_field_info = await cls._refresh_field_schema(name, field_info)
+                has_changes = True
+
+            # Recursively check nested models
+            nested_model = cls._get_base_model_type(current_annotation)
+            if nested_model is not None:
+                refreshed_nested = await cls._refresh_nested_model(nested_model)
+                if refreshed_nested is not nested_model:
+                    current_annotation = refreshed_nested
+                    current_field_info = copy.deepcopy(current_field_info)
+                    setattr(current_field_info, "annotation", current_annotation)
+                    has_changes = True
+
+            clean_fields[name] = (current_annotation, current_field_info)
+
+        if not has_changes:
+            return model_cls
+
+        # Create new model with refreshed fields
+        logger.debug("Creating refreshed nested model for '%s'", model_cls.__name__)
+        return create_model(
+            model_cls.__name__,
+            __base__=BaseModel,
+            __config__=ConfigDict(arbitrary_types_allowed=True),
+            **clean_fields,
+        )
+
+    @classmethod
+    async def _refresh_field_schema(cls, field_name: str, field_info: FieldInfo) -> FieldInfo:
+        """Refresh a field's json_schema_extra with fresh values from dynamic providers.
+
+        This method calls all dynamic providers registered for a field (via Annotated
+        metadata) and creates a new FieldInfo with the resolved values. The original
+        field_info is not modified.
+
+        Uses `resolve_safe()` for structured error handling, allowing partial success
+        when some fetchers fail. Successfully resolved values are still applied.
+
+        Args:
+            field_name: The name of the field being refreshed (used for logging).
+            field_info: The original FieldInfo object containing the dynamic providers.
+
+        Returns:
+            A new FieldInfo object with the same attributes as the original, but with
+            `json_schema_extra` containing resolved values and Dynamic metadata removed.
+
+        Note:
+            If all fetchers fail, the original field_info is returned unchanged.
+            If some fetchers fail, successfully resolved values are still applied.
+        """
+        fetchers = get_fetchers(field_info)
+
+        if not fetchers:
+            return field_info
+
+        fetcher_keys = list(fetchers.keys())
+        logger.debug(
+            "Refreshing dynamic schema for field '%s' with fetchers: %s",
+            field_name,
+            fetcher_keys,
+            extra={"field_name": field_name, "fetcher_keys": fetcher_keys},
+        )
+
+        # Resolve all fetchers with structured error handling
+        result = await resolve_safe(fetchers)
+
+        # Log any errors that occurred with full details
+        if result.errors:
+            for key, error in result.errors.items():
+                logger.warning(
+                    "Failed to resolve '%s' for field '%s': %s: %s",
+                    key,
+                    field_name,
+                    type(error).__name__,
+                    str(error) or "(no message)",
+                    extra={
+                        "field_name": field_name,
+                        "fetcher_key": key,
+                        "error_type": type(error).__name__,
+                        "error_message": str(error),
+                        "error_repr": repr(error),
+                    },
+                )
+
+        # If no values were resolved, return original field_info
+        if not result.values:
+            logger.warning(
+                "All fetchers failed for field '%s', keeping original",
+                field_name,
+            )
+            return field_info
+
+        # Build new json_schema_extra with resolved values merged
+        extra = getattr(field_info, "json_schema_extra", {}) or {}
+        new_extra = {**extra, **result.values}
+
+        # Create a deep copy of the FieldInfo to avoid shared mutable state
+        new_field_info = copy.deepcopy(field_info)
+        setattr(new_field_info, "json_schema_extra", new_extra)
+
+        # Remove Dynamic from metadata (it's been resolved)
+        new_metadata = [m for m in new_field_info.metadata if not isinstance(m, DynamicField)]
+        setattr(new_field_info, "metadata", new_metadata)
+
+        logger.debug(
+            "Refreshed '%s' with dynamic values: %s",
+            field_name,
+            list(result.values.keys()),
+        )
+
+        return new_field_info

digitalkin/models/services/__init__.py

@@ -1 +1,10 @@
 """This module contains the models for the services."""
+
+from digitalkin.models.services.storage import BaseMessage, BaseRole, ChatHistory, Role
+
+__all__ = [
+    "BaseMessage",
+    "BaseRole",
+    "ChatHistory",
+    "Role",
+]

digitalkin/models/services/cost.py

@@ -38,6 +38,7 @@ class CostConfig(BaseModel):
 class CostEvent(BaseModel):
     """Pydantic model that represents a cost event registered during service execution.
 
+    # DEPRECATED
     :param cost_name: Identifier for the cost configuration.
     :param cost_type: The type of cost.
     :param usage: The amount or units consumed.

digitalkin/models/services/storage.py

@@ -1,10 +1,44 @@
 """Storage model."""
 
-from pydantic import BaseModel
+from enum import Enum
+from typing import Any
 
+from pydantic import BaseModel, Field
 
-class StorageModel(BaseModel):
-    """Storage model."""
 
-    data: object
-    type: str
+class BaseRole(str, Enum):
+    """Officially supported Role Enum for chat messages."""
+
+    ASSISTANT = "assistant"
+    USER = "user"
+    SYSTEM = "system"
+
+
+Role = BaseRole | str
+
+
+class BaseMessage(BaseModel):
+    """Base Model representing a simple message in the chat history."""
+
+    role: Role = Field(..., description="Role of the message sender")
+    content: Any = Field(..., description="The content of the message | preferably a BaseModel.")
+
+
+class ChatHistory(BaseModel):
+    """Storage chat history model for the OpenAI Archetype module."""
+
+    messages: list[BaseMessage] = Field(..., description="List of messages in the chat history")
+
+
+class FileModel(BaseModel):
+    """File model."""
+
+    file_id: str = Field(..., description="ID of the file")
+    name: str = Field(..., description="Name of the file")
+    metadata: dict[str, Any] = Field(..., description="Metadata of the file")
+
+
+class FileHistory(BaseModel):
+    """File history model."""
+
+    files: list[FileModel] = Field(..., description="List of files")