mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 11:19:56 +00:00
Evan Mattson
30d2b0802a
### Motivation and Context
SK Python processes have been missing support to be able to serialize
and deserialize JSON state for a process and its steps. This PR brings
in the functionality to allow the developer to do so. The
`getting_started_with_processes` step03 has been update to reflect this
latest functionality. It is possible to dump a JSON state to a file, and
reload the state to continue running the process.
State metadata that handles the version for steps is managed via a
decorator:
```python
@kernel_process_step_metadata("CutFoodStep.V1")
class CutFoodStep(KernelProcessStep):
class Functions(Enum):
ChopFood = "ChopFood"
SliceFood = "SliceFood"
```
If no decorator/state is supplied the step will be built with a default
state version of "v1" which aligns with .Net.
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
1. Why is this change required?
2. What problem does it solve?
3. What scenario does it contribute to?
4. If it fixes an open issue, please link to the issue here.
-->
### Description
Support state and versioning management for Python processes.
- Update samples to reflect changes.
- Closes #9584
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
69 lines
2.6 KiB
Python
69 lines
2.6 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from semantic_kernel.processes.kernel_process.kernel_process_step_metadata import KernelProcessStepMetadataAttribute
|
|
from semantic_kernel.processes.kernel_process.kernel_process_step_state_metadata import (
|
|
KernelProcessStateMetadata,
|
|
KernelProcessStepStateMetadata,
|
|
)
|
|
from semantic_kernel.processes.process_types import get_generic_state_type
|
|
from semantic_kernel.utils.feature_stage_decorator import experimental
|
|
|
|
if TYPE_CHECKING:
|
|
from semantic_kernel.processes.kernel_process import KernelProcess
|
|
from semantic_kernel.processes.kernel_process.kernel_process_step_info import KernelProcessStepInfo
|
|
|
|
|
|
@experimental
|
|
def extract_process_step_metadata_from_type(step_cls: type) -> KernelProcessStepMetadataAttribute:
|
|
"""Extracts the process step metadata from the type."""
|
|
return getattr(step_cls, "_kernel_process_step_metadata", KernelProcessStepMetadataAttribute("v1"))
|
|
|
|
|
|
@experimental
|
|
def kernel_process_to_process_state_metadata(kernel_process: "KernelProcess") -> KernelProcessStateMetadata:
|
|
"""Converts a kernel process to process state metadata."""
|
|
KernelProcessStateMetadata.model_rebuild()
|
|
|
|
metadata: KernelProcessStateMetadata[Any] = KernelProcessStateMetadata(
|
|
name=kernel_process.state.name,
|
|
id=kernel_process.state.id,
|
|
version_info=kernel_process.state.version,
|
|
steps_state={},
|
|
)
|
|
|
|
for step in kernel_process.steps:
|
|
metadata.steps_state[step.state.name] = to_process_state_metadata(step)
|
|
|
|
return metadata
|
|
|
|
|
|
@experimental
|
|
def to_process_state_metadata(step_info: "KernelProcessStepInfo") -> KernelProcessStepStateMetadata:
|
|
"""Converts a step info object to process state metadata."""
|
|
from semantic_kernel.processes.kernel_process import KernelProcess
|
|
|
|
if isinstance(step_info, KernelProcess):
|
|
return kernel_process_to_process_state_metadata(step_info)
|
|
|
|
return step_info_to_process_state_metadata(step_info)
|
|
|
|
|
|
@experimental
|
|
def step_info_to_process_state_metadata(step_info: "KernelProcessStepInfo") -> KernelProcessStepStateMetadata:
|
|
"""Converts a step info object to process state metadata."""
|
|
metadata: KernelProcessStepStateMetadata[Any] = KernelProcessStepStateMetadata(
|
|
name=step_info.state.name,
|
|
id=step_info.state.id,
|
|
version_info=step_info.state.version,
|
|
)
|
|
|
|
generic_state_type = get_generic_state_type(step_info.inner_step_type)
|
|
if generic_state_type:
|
|
inner_state = getattr(step_info.state, "state", None)
|
|
if inner_state is not None:
|
|
metadata.state = inner_state
|
|
|
|
return metadata
|