kernel_process_step_metadata.py

# Copyright (c) Microsoft. All rights reserved.

from dataclasses import dataclass

from semantic_kernel.utils.feature_stage_decorator import experimental


@experimental
@dataclass(frozen=True)
class KernelProcessStepMetadataAttribute:
    """Metadata describing the version of the Step's implementation for serialization and replay."""

    version: str = "v1"


@experimental
def kernel_process_step_metadata(version: str = "v1"):
    """Decorator to attach a version string representing the Step's implementation version.

    This version is serialized in `versionInfo` for each step, enabling replay
    and process recovery to instantiate the correct Step variant.

    The version string used in @kernel_process_step_metadata must uniquely identify the Step class'
    behavior and contract version. Different versions imply incompatible step behavior, state schema,
    or function/event definitions.

    Example usage:
        @kernel_process_step_metadata("CutFoodStep.V2")
        class CutFoodWithSharpeningStep(KernelProcessStep[MyState]):
            ...
    """

    def decorator(cls):
        setattr(cls, "_kernel_process_step_metadata", KernelProcessStepMetadataAttribute(version))
        return cls

    return decorator