mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
Evan Mattson
d3404ccc28
### Motivation and Context Today in Python processes the `max_supersteps` config is hidden from the caller. The internal execute method defaults the value to 100, and this doesn't allow for developers to leverage custom values depending on their use cases. <!-- 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 Provide a way for callers to pass in `max_supersteps` via the process runtime `start` method. - Update README - Update unit tests accordingly. <!-- 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 - [X] I didn't break anyone 😄
53 lines
2.1 KiB
Python
53 lines
2.1 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
from enum import Enum
|
|
from typing import TYPE_CHECKING
|
|
|
|
from semantic_kernel.exceptions.process_exceptions import ProcessInvalidConfigurationException
|
|
from semantic_kernel.processes.dapr_runtime.dapr_kernel_process_context import DaprKernelProcessContext
|
|
from semantic_kernel.processes.kernel_process.kernel_process_event import KernelProcessEvent
|
|
from semantic_kernel.utils.feature_stage_decorator import experimental
|
|
|
|
if TYPE_CHECKING:
|
|
from semantic_kernel.processes.kernel_process.kernel_process import KernelProcess
|
|
|
|
|
|
@experimental
|
|
async def start(
|
|
process: "KernelProcess",
|
|
initial_event: KernelProcessEvent | str | Enum,
|
|
process_id: str | None = None,
|
|
max_supersteps: int | None = None,
|
|
**kwargs,
|
|
) -> DaprKernelProcessContext:
|
|
"""Start the kernel process.
|
|
|
|
Args:
|
|
process: The kernel process to start.
|
|
initial_event: The initial event to start the process with.
|
|
process_id: The ID of the process. If None, a new ID will be generated.
|
|
max_supersteps: The maximum number of supersteps. This is the total number of times process steps will run.
|
|
Defaults to None, and thus the process will run its steps 100 times.
|
|
**kwargs: Additional keyword arguments.
|
|
"""
|
|
if process is None:
|
|
raise ProcessInvalidConfigurationException("process cannot be None")
|
|
if process.state is None:
|
|
raise ProcessInvalidConfigurationException("process state cannot be empty")
|
|
if initial_event is None:
|
|
raise ProcessInvalidConfigurationException("initial_event cannot be None")
|
|
|
|
initial_event_str: str | KernelProcessEvent = (
|
|
initial_event.value if isinstance(initial_event, Enum) else initial_event
|
|
)
|
|
|
|
if isinstance(initial_event_str, str):
|
|
initial_event_str = KernelProcessEvent(id=initial_event_str, data=kwargs.get("data"))
|
|
|
|
if process_id is not None:
|
|
process.state.id = process_id
|
|
|
|
process_context = DaprKernelProcessContext(process=process, max_supersteps=max_supersteps)
|
|
await process_context.start_with_event(initial_event_str)
|
|
return process_context
|