Megosztás:


A Microsoft Agent Framework munkafolyamatainak alapvető fogalmai – Végrehajtók

Ez a dokumentum részletesen bemutatja a Microsoft Agent Framework Munkafolyamat-rendszer Végrehajtók összetevőjét.

Áttekintés

A végrehajtók a munkafolyamat üzeneteinek feldolgozásának alapvető építőelemei. Ezek önálló feldolgozási egységek, amelyek gépelt üzeneteket fogadnak, műveleteket hajtanak végre, és kimeneti üzeneteket vagy eseményeket képesek létrehozni.

A végrehajtók az Executor<TInput, TOutput> alaposztálytól öröklődnek. Minden végrehajtó egyedi azonosítóval rendelkezik, és képes kezelni bizonyos üzenettípusokat.

Egyszerű végrehajtói struktúra

using Microsoft.Agents.AI.Workflows;
using Microsoft.Agents.AI.Workflows.Reflection;

internal sealed class UppercaseExecutor() : Executor<string, string>("UppercaseExecutor")
{
    public async ValueTask<string> HandleAsync(string message, IWorkflowContext context)
    {
        string result = message.ToUpperInvariant();
        return result; // Return value is automatically sent to connected executors
    }
}

Manuálisan is küldhet üzeneteket érték visszaadása nélkül:

internal sealed class UppercaseExecutor() : Executor<string>("UppercaseExecutor")
{
    public async ValueTask HandleAsync(string message, IWorkflowContext context)
    {
        string result = message.ToUpperInvariant();
        await context.SendMessageAsync(result); // Manually send messages to connected executors
    }
}

A metódus felülírásával ConfigureRoutes több bemeneti típus is kezelhető:

internal sealed class SampleExecutor() : Executor("SampleExecutor")
{
    protected override RouteBuilder ConfigureRoutes(RouteBuilder routeBuilder)
    {
        return routeBuilder
            .AddHandler<string>(this.HandleStringAsync)
            .AddHandler<int>(this.HandleIntAsync);
    }

    /// <summary>
    /// Converts input string to uppercase
    /// </summary>
    public async ValueTask<string> HandleStringAsync(string message, IWorkflowContext context)
    {
        string result = message.ToUpperInvariant();
        return result;
    }

    /// <summary>
    /// Doubles the input integer
    /// </summary>
    public async ValueTask<int> HandleIntAsync(int message, IWorkflowContext context)
    {
        int result = message * 2;
        return result;
    }
}

Egy függvényből is létrehozhat végrehajtót a bővítménymetódus BindExecutor használatával:

Func<string, string> uppercaseFunc = s => s.ToUpperInvariant();
var uppercase = uppercaseFunc.BindExecutor("UppercaseExecutor");

A végrehajtók az Executor alaposztálytól öröklődnek. Minden végrehajtó egyedi azonosítóval rendelkezik, és bizonyos @handler üzenettípusokat dekorátorral ellátott módszerekkel képes kezelni. A kezelőknek megfelelő széljegyzetekkel kell rendelkezniük a feldolgozható üzenetek típusának megadásához.

Egyszerű végrehajtói struktúra

from agent_framework import (
    Executor,
    WorkflowContext,
    handler,
)

class UpperCase(Executor):

    @handler
    async def to_upper_case(self, text: str, ctx: WorkflowContext[str]) -> None:
        """Convert the input to uppercase and forward it to the next node.

        Note: The WorkflowContext is parameterized with the type this handler will
        emit. Here WorkflowContext[str] means downstream nodes should expect str.
        """
        await ctx.send_message(text.upper())

A dekoratőrrel @executor végrehajtót hozhat létre egy függvényből:

from agent_framework import (
    WorkflowContext,
    executor,
)

@executor(id="upper_case_executor")
async def upper_case(text: str, ctx: WorkflowContext[str]) -> None:
    """Convert the input to uppercase and forward it to the next node.

    Note: The WorkflowContext is parameterized with the type this handler will
    emit. Here WorkflowContext[str] means downstream nodes should expect str.
    """
    await ctx.send_message(text.upper())

Több beviteli típus is kezelhető több kezelő definiálásával:

class SampleExecutor(Executor):

    @handler
    async def to_upper_case(self, text: str, ctx: WorkflowContext[str]) -> None:
        """Convert the input to uppercase and forward it to the next node.

        Note: The WorkflowContext is parameterized with the type this handler will
        emit. Here WorkflowContext[str] means downstream nodes should expect str.
        """
        await ctx.send_message(text.upper())

    @handler
    async def double_integer(self, number: int, ctx: WorkflowContext[int]) -> None:
        """Double the input integer and forward it to the next node.

        Note: The WorkflowContext is parameterized with the type this handler will
        emit. Here WorkflowContext[int] means downstream nodes should expect int.
        """
        await ctx.send_message(number * 2)

Az WorkflowContext objektum

Az WorkflowContext objektum metódusokat biztosít a kezelő számára a munkafolyamat végrehajtásához. A WorkflowContext paraméterezés a kezelő által kibocsátott üzenetek típusával és a kimenetek típusával van megadva.

A leggyakrabban használt módszer az send_message, amely lehetővé teszi, hogy a kezelő üzeneteket küldjön a csatlakoztatott végrehajtóknak.

from agent_framework import WorkflowContext

class SomeHandler(Executor):

    @handler
    async def some_handler(message: str, ctx: WorkflowContext[str]) -> None:
        await ctx.send_message("Hello, World!")

A kezelő a yield_output használatával kimeneteket állíthat elő, amelyeket a munkafolyamat részeként kimenetként értékelnek, és kimeneti eseményként visszaküldik vagy streamelik a hívónak.

from agent_framework import WorkflowContext

class SomeHandler(Executor):

    @handler
    async def some_handler(message: str, ctx: WorkflowContext[Never, str]) -> None:
        await ctx.yield_output("Hello, World!")

Ha egy kezelő nem küld üzeneteket, és nem ad kimenetet, nincs szükség típusparaméterre a következőhöz WorkflowContext:

from agent_framework import WorkflowContext

class SomeHandler(Executor):

    @handler
    async def some_handler(message: str, ctx: WorkflowContext) -> None:
        print("Doing some work...")

Következő lépés