Events

A munkafolyamat-eseményrendszer megfigyelhetőséget biztosít a munkafolyamat-végrehajtásban. Az események a végrehajtás során kulcsfontosságú pontokon kerülnek kibocsátásra, és valós időben felhasználhatók streameléssel.

Beépített eseménytípusok

// Workflow lifecycle events
WorkflowStartedEvent     // Workflow execution begins
WorkflowOutputEvent      // Workflow outputs data
WorkflowErrorEvent       // Workflow encounters an error
WorkflowWarningEvent     // Workflow encountered a warning

// Executor events
ExecutorInvokedEvent     // Executor starts processing
ExecutorCompletedEvent   // Executor finishes processing
ExecutorFailedEvent      // Executor encounters an error
AgentResponseEvent       // An agent run produces output
AgentResponseUpdateEvent // An agent run produces a streaming update

// Superstep events
SuperStepStartedEvent    // Superstep begins
SuperStepCompletedEvent  // Superstep completes

// Request events
RequestInfoEvent         // A request is issued

Megjegyzés:

Ha az ügynökök jóváhagyáshoz szükséges eszközöket használnak, RequestInfoEvent általában egy ToolApprovalRequestContent adatcsomagot hordoz az emberi jóváhagyást igénylő eszközhívásokhoz. Az események kezelésével kapcsolatos részletekért tekintse meg a Human-in-the-Loop című témakört.

# All events use the unified WorkflowEvent class with a type discriminator:

# Workflow lifecycle events
WorkflowEvent.type == "started"             # Workflow execution begins
WorkflowEvent.type == "status"              # Workflow state changed (use .state)
WorkflowEvent.type == "output"              # Workflow produces a terminal (final) output
WorkflowEvent.type == "intermediate"        # Workflow produces an intermediate (observational) output
WorkflowEvent.type == "failed"              # Workflow terminated with error (use .details)
WorkflowEvent.type == "error"               # Non-fatal error from user code
WorkflowEvent.type == "warning"             # Workflow encountered a warning

# Executor events
WorkflowEvent.type == "executor_invoked"    # Executor starts processing
WorkflowEvent.type == "executor_completed"  # Executor finishes processing
WorkflowEvent.type == "executor_failed"     # Executor encounters an error
WorkflowEvent.type == "data"                # Deprecated alias for "intermediate"

# Superstep events
WorkflowEvent.type == "superstep_started"   # Superstep begins
WorkflowEvent.type == "superstep_completed" # Superstep completes

# Request events
WorkflowEvent.type == "request_info"        # A request is issued

Megjegyzés:

Ha az ügynökök jóváhagyáshoz szükséges eszközöket használnak, request_info az események általában hasznos adatokat Content hordoznak type == "function_approval_request" az emberi jóváhagyást igénylő eszközhívásokhoz. Az események kezelésével kapcsolatos részletekért tekintse meg a Human-in-the-Loop című témakört.

Megjegyzés:

"output" és "intermediate" a két kimeneti diszkriminatív. A terminálkimeneti forrásként kijelölt végrehajtó eseményeket bocsát ki "output" (amelyet a WorkflowRunResult.get_outputs()rendszer használ fel). Az köztes kimeneti forrásnak kijelölt elem "intermediate" eseményeket bocsát ki (amelyeket a WorkflowRunResult.get_intermediate_outputs() dolgoz fel). A "data" típus a "intermediate" elavult álneve, és egy későbbi kiadásban el lesz távolítva; új kódban inkább a "intermediate" szerinti szűrést használja.

Események felhasználása

using Microsoft.Agents.AI.Workflows;

await foreach (WorkflowEvent evt in run.WatchStreamAsync())
{
    switch (evt)
    {
        case ExecutorInvokedEvent invoke:
            Console.WriteLine($"Starting {invoke.ExecutorId}");
            break;

        case ExecutorCompletedEvent complete:
            Console.WriteLine($"Completed {complete.ExecutorId}: {complete.Data}");
            break;

        case WorkflowOutputEvent output:
            Console.WriteLine($"Workflow output: {output.Data}");
            return;

        case WorkflowErrorEvent error:
            Console.WriteLine($"Workflow error: {error.Exception}");
            return;
    }
}

from agent_framework import WorkflowEvent

async for event in workflow.run(input_message, stream=True):
    if event.type == "executor_invoked":
        print(f"Starting {event.executor_id}")
    elif event.type == "executor_completed":
        print(f"Completed {event.executor_id}: {event.data}")
    elif event.type == "intermediate":
        print(f"Intermediate output from {event.executor_id}: {event.data}")
    elif event.type == "output":
        print(f"Terminal output: {event.data}")
        return
    elif event.type == "error":
        print(f"Workflow error: {event.data}")
        return

Egyéni események

Az egyéni események lehetővé teszik, hogy a végrehajtók tartományspecifikus jeleket bocsátanak ki az alkalmazás igényeire szabott munkafolyamat-végrehajtás során. Néhány példa használati eset:

  • Előrehaladás nyomon követése – köztes lépések jelentése, hogy a hívók megjeleníthessenek állapotfrissítéseket.
  • Diagnosztikát bocsát ki – felületi figyelmeztetéseket, metrikákat vagy hibakeresési információkat a munkafolyamat kimenetének módosítása nélkül.
  • Továbbítási tartomány adatai – strukturált hasznos adatok leküldése (például adatbázisírás, eszközhívások) a figyelőknek valós időben.

Egyéni események definiálása

Egyéni esemény definiálása alosztályozással WorkflowEvent. Az alapkonstruktor elfogad egy opcionális object? data hasznos adatot, ami a Data tulajdonságon keresztül érhető el.

using Microsoft.Agents.AI.Workflows;

// Simple event with a string payload
internal sealed class ProgressEvent(string step) : WorkflowEvent(step) { }

// Event with a structured payload
internal sealed class MetricsEvent(MetricsData metrics) : WorkflowEvent(metrics) { }

A Pythonban hozzon létre egyéni eseményeket közvetlenül az WorkflowEvent osztály használatával egy egyéni típusú diszkriminatív sztringgel. A type paraméterek az data összes információt magukban hordozzák.

from agent_framework import WorkflowEvent

# Create a custom event with a custom type string and payload
event = WorkflowEvent(type="progress", data="Step 1 complete")

# Custom event with a structured payload
event = WorkflowEvent(type="metrics", data={"latency_ms": 42, "tokens": 128})

Megjegyzés:

Az eseménytípusok "started", "status"és "failed" a keretrendszer életciklus-értesítéseihez vannak fenntartva. Ha egy végrehajtó egy ilyen típust próbál kibocsátani, a rendszer figyelmen kívül hagyja az eseményt, és egy figyelmeztetést naplóz.

Egyéni esemény definiálásához hozzon létre egy olyan típust, amely implementálja a workflow.Event felületet. A Data metódus visszaadja az esemény adattartalmát.

type ProgressEvent struct {
    Step string
}

func (e ProgressEvent) Data() any {
    return e.Step
}

Egyéni események kibocsátása

Az egyéni események kibocsátása a végrehajtó üzenetkezelőjéből a AddEventAsync hívásával a IWorkflowContext-on történik.

using Microsoft.Agents.AI.Workflows;

internal sealed class ProgressEvent(string step) : WorkflowEvent(step) { }

internal sealed partial class CustomExecutor() : Executor("CustomExecutor")
{
    [MessageHandler]
    private async ValueTask HandleAsync(string message, IWorkflowContext context)
    {
        await context.AddEventAsync(new ProgressEvent("Validating input"));

        // Executor logic...

        await context.AddEventAsync(new ProgressEvent("Processing complete"));
    }
}

Egyéni eseményeket bocsát ki egy kezelőből azzal, hogy meghívja a add_event függvényt a WorkflowContext-on.

from agent_framework import (
    handler,
    Executor,
    WorkflowContext,
    WorkflowEvent,
)

class CustomExecutor(Executor):

    @handler
    async def handle(self, message: str, ctx: WorkflowContext[str]) -> None:
        await ctx.add_event(WorkflowEvent(type="progress", data="Validating input"))

        # Executor logic...

        await ctx.add_event(WorkflowEvent(type="progress", data="Processing complete"))

Egyéni eseményeket válthat ki egy végrehajtó kezelőből a AddEventworkflow.Context meghívásával:

customExecutor := workflow.NewExecutor("CustomExecutor", func(ctx *workflow.Context, message string) error {
    if err := ctx.AddEvent(ProgressEvent{Step: "Validating input"}); err != nil {
        return err
    }

    // Executor logic...

    return ctx.AddEvent(ProgressEvent{Step: "Processing complete"})
}).Bind()

Egyéni események fogyasztása

Mintaegyeztetés használata az egyéni eseménytípus szűréséhez az eseménystreamben:

await foreach (WorkflowEvent evt in run.WatchStreamAsync())
{
    switch (evt)
    {
        case ProgressEvent progress:
            Console.WriteLine($"Progress: {progress.Data}");
            break;

        case WorkflowOutputEvent output:
            Console.WriteLine($"Done: {output.Data}");
            return;
    }
}

Szűrés egyéni típusú diszkriminátor karakterláncra:

async for event in workflow.run(input_message, stream=True):
    if event.type == "progress":
        print(f"Progress: {event.data}")
    elif event.type == "output":
        print(f"Done: {event.data}")
        return

Típuskapcsolóval vagy típusmegadással szűrheti az egyéni eseménytípust az eseménystreamben:

for evt, err := range run.WatchStream(ctx) {
    if err != nil {
        return err
    }

    switch e := evt.(type) {
    case ProgressEvent:
        fmt.Printf("Progress: %v\n", e.Data())
    case workflow.OutputEvent:
        fmt.Printf("Done: %v\n", e.Output)
        return nil
    }
}

Events

A munkafolyamatok eseményeket bocsátanak ki a végrehajtás során. Az események a run objektumon keresztül nyomon követhetők.

Események megfigyelése

run, err := inproc.Default.Run(ctx, wf, input)
for evt := range run.NewEvents() {
    switch e := evt.(type) {
    case workflow.ExecutorCompletedEvent:
        fmt.Printf("Executor %s completed: %v\n", e.ExecutorID, e.Result)
    case workflow.OutputEvent:
        fmt.Printf("Output from %s: %v\n", e.ExecutorID, e.Output)
    }
}

Streamelési események

Streamelési munkafolyamatok esetén használja a következőt inproc.Default.RunStreamingWatchStream:

run, err := inproc.Default.RunStreaming(ctx, wf, input)
for evt, err := range run.WatchStream(ctx) {
    if err != nil {
        panic(err)
    }
    // process streaming events
}

Következő lépések

Munkafolyamat-szerkesztő és -végrehajtás

Kapcsolódó témakörök:

  • Last updated on