Share via


KernelProcessStepContext Class

The context of a step in a kernel process.

Note: This class is marked as 'experimental' and may change in the future.

Initialize the step context.

Constructor

KernelProcessStepContext(channel: KernelProcessMessageChannel)

Parameters

Name Description
channel
Required

Methods

emit_event

Emit an event from the current step.

It is possible to either specify a KernelProcessEvent object or the ID of the event along with the data and optional visibility keyword arguments.

emit_event

Emit an event from the current step.

It is possible to either specify a KernelProcessEvent object or the ID of the event along with the data and optional visibility keyword arguments.

async emit_event(process_event: KernelProcessEvent | str | Enum | None, **kwargs) -> None

Parameters

Name Description
process_event
Required
<xref:<xref:semantic_kernel.processes.kernel_process.kernel_process_step_context.KernelProcessEvent | str>>

The event to emit.

**kwargs
Required

Additional keyword arguments to pass to the event.

Attributes

is_experimental

is_experimental = True

stage_status

stage_status = 'experimental'

step_message_channel

step_message_channel: KernelProcessMessageChannel