Megosztás:

Kérelmek és válaszok kezelése munkafolyamatokban

Ez az oktatóanyag bemutatja, hogyan kezelhetők a kérelmek és válaszok a munkafolyamatokban az Agent Framework-munkafolyamatok használatával. Megtudhatja, hogyan hozhat létre interaktív munkafolyamatokat, amelyek szüneteltethetik a végrehajtást külső forrásokból (például emberekből vagy más rendszerekből) érkező bemenetek lekéréséhez, majd a válasz megadása után folytathatók.

A tárgyalt fogalmak

A .NET-ben a human-in-the-loop munkafolyamatok és a külső kérések kezelése a végrehajtás szüneteltetésére és a felhasználói bemenetek gyűjtésére szolgálnak RequestPort . Ez a minta olyan interaktív munkafolyamatokat tesz lehetővé, ahol a rendszer a végrehajtás során külső forrásokból kérhet információkat.

Előfeltételek

NuGet-csomagok telepítése

Először telepítse a szükséges csomagokat a .NET-projekthez:

dotnet add package Microsoft.Agents.AI.Workflows --prerelease

Kulcsösszetevők

RequestPort és külső kérések

A RequestPort munkafolyamat és a külső bemeneti források közötti hídként működik. Amikor a munkafolyamatnak bemenetre van szüksége, létrehoz egy RequestInfoEvent olyan értéket, amelyet az alkalmazás kezel:

// Create a RequestPort for handling human input requests
RequestPort numberRequestPort = RequestPort.Create<NumberSignal, int>("GuessNumber");

Jeltípusok

Adjon meg jeltípusokat a különböző kéréstípusok kommunikálásához:

/// <summary>
/// Signals used for communication between guesses and the JudgeExecutor.
/// </summary>
internal enum NumberSignal
{
    Init,     // Initial guess request
    Above,    // Previous guess was too high
    Below,    // Previous guess was too low
}

Munkafolyamat-végrehajtó

Hozzon létre olyan végrehajtókat, amelyek feldolgozzák a felhasználói bemenetet, és visszajelzést adnak:

/// <summary>
/// Executor that judges the guess and provides feedback.
/// </summary>
internal sealed class JudgeExecutor : Executor<int>("Judge")
{
    private readonly int _targetNumber;
    private int _tries;

    public JudgeExecutor(int targetNumber) : this()
    {
        _targetNumber = targetNumber;
    }

    public override async ValueTask HandleAsync(int message, IWorkflowContext context, CancellationToken cancellationToken)
    {
        _tries++;
        if (message == _targetNumber)
        {
            await context.YieldOutputAsync($"{_targetNumber} found in {_tries} tries!", cancellationToken)
                         .ConfigureAwait(false);
        }
        else if (message < _targetNumber)
        {
            await context.SendMessageAsync(NumberSignal.Below, cancellationToken).ConfigureAwait(false);
        }
        else
        {
            await context.SendMessageAsync(NumberSignal.Above, cancellationToken).ConfigureAwait(false);
        }
    }
}

A munkafolyamat létrehozása

Csatlakoztassa a RequestPortot és a végrehajtót egy visszajelzési ciklusban:

internal static class WorkflowHelper
{
    internal static ValueTask<Workflow<NumberSignal>> GetWorkflowAsync()
    {
        // Create the executors
        RequestPort numberRequestPort = RequestPort.Create<NumberSignal, int>("GuessNumber");
        JudgeExecutor judgeExecutor = new(42);

        // Build the workflow by connecting executors in a loop
        return new WorkflowBuilder(numberRequestPort)
            .AddEdge(numberRequestPort, judgeExecutor)
            .AddEdge(judgeExecutor, numberRequestPort)
            .WithOutputFrom(judgeExecutor)
            .BuildAsync<NumberSignal>();
    }
}

Az interaktív munkafolyamat végrehajtása

Külső kérések kezelése a munkafolyamat végrehajtása során:

private static async Task Main()
{
    // Create the workflow
    var workflow = await WorkflowHelper.GetWorkflowAsync().ConfigureAwait(false);

    // Execute the workflow
    await using StreamingRun handle = await InProcessExecution.StreamAsync(workflow, NumberSignal.Init).ConfigureAwait(false);
    await foreach (WorkflowEvent evt in handle.WatchStreamAsync().ConfigureAwait(false))
    {
        switch (evt)
        {
            case RequestInfoEvent requestInputEvt:
                // Handle human input request from the workflow
                ExternalResponse response = HandleExternalRequest(requestInputEvt.Request);
                await handle.SendResponseAsync(response).ConfigureAwait(false);
                break;

            case WorkflowOutputEvent outputEvt:
                // The workflow has yielded output
                Console.WriteLine($"Workflow completed with result: {outputEvt.Data}");
                return;
        }
    }
}

Kérelemkezelés

Különböző típusú bemeneti kérések feldolgozása:

private static ExternalResponse HandleExternalRequest(ExternalRequest request)
{
    switch (request.DataAs<NumberSignal?>())
    {
        case NumberSignal.Init:
            int initialGuess = ReadIntegerFromConsole("Please provide your initial guess: ");
            return request.CreateResponse(initialGuess);
        case NumberSignal.Above:
            int lowerGuess = ReadIntegerFromConsole("You previously guessed too large. Please provide a new guess: ");
            return request.CreateResponse(lowerGuess);
        case NumberSignal.Below:
            int higherGuess = ReadIntegerFromConsole("You previously guessed too small. Please provide a new guess: ");
            return request.CreateResponse(higherGuess);
        default:
            throw new ArgumentException("Unexpected request type.");
    }
}

private static int ReadIntegerFromConsole(string prompt)
{
    while (true)
    {
        Console.Write(prompt);
        string? input = Console.ReadLine();
        if (int.TryParse(input, out int value))
        {
            return value;
        }
        Console.WriteLine("Invalid input. Please enter a valid integer.");
    }
}

Megvalósítási fogalmak

RequestInfoEvent folyamatlánc

  1. Munkafolyamat-végrehajtás: A munkafolyamat addig dolgozik, amíg nincs szükség külső bemenetre
  2. Kérés generálása: A RequestPort létrehoz egy RequestInfoEvent kérelmet a kérelem részleteivel
  3. Külső kezelés: Az alkalmazás elkapja az eseményt, és összegyűjti a felhasználói bemenetet
  4. Válasz beküldése: A munkafolyamat folytatásához küldjön vissza egy ExternalResponse visszaküldést
  5. Munkafolyamat újraindítása: A munkafolyamat a megadott bemenettel folytatja a feldolgozást

Munkafolyamat életciklusa

  • Streamelés végrehajtása: Események valós idejű monitorozására használható StreamAsync
  • Eseménykezelés: A bemeneti kérések és RequestInfoEvent a befejezés folyamata WorkflowOutputEvent
  • Válaszkoordináció: Válaszok egyeztetése a munkafolyamat válaszkezelési mechanizmusával a kérelmekre adott válaszokhoz

Megvalósítási folyamat

  1. Munkafolyamat inicializálása: A munkafolyamat a RequestPortba való küldéssel NumberSignal.Init kezdődik.

  2. Kérés létrehozása: A RequestPort létrehoz egy RequestInfoEvent kezdeti becslést a felhasználótól.

  3. Munkafolyamat szüneteltetése: A munkafolyamat szünetel, és megvárja a külső bemenetet, amíg az alkalmazás kezeli a kérést.

  4. Emberi válasz: A külső alkalmazás összegyűjti a felhasználói bemenetet, és visszaküldi ExternalResponse a munkafolyamatnak.

  5. Feldolgozás és visszajelzés: A JudgeExecutor találgatás feldolgozása, és vagy befejezi a munkafolyamatot, vagy új jelet küld (fent/lent) egy másik becslés kéréséhez.

  6. Ciklus folytatása: A folyamat addig ismétlődik, amíg a megfelelő szám nem lesz kitalálva.

Keretrendszer előnyei

  • Típusbiztonság: Erős gépelés gondoskodik a kérelem-válasz szerződések fenntartásáról
  • Eseményvezérelt: A gazdag eseményrendszer betekintést nyújt a munkafolyamat-végrehajtásba
  • Szüneteltethető végrehajtás: A munkafolyamatok határozatlan ideig szünetelhetnek, miközben külső bemenetre várnak
  • Állapotkezelés: A munkafolyamat állapota a szüneteltetési ciklusok között megmarad
  • Rugalmas integráció: A RequestPorts bármilyen külső bemeneti forrással (felhasználói felület, API, konzol stb.) integrálható.

Teljes minta

A teljes munka végrehajtásához tekintse meg a Human-in-the-Loop Basic mintát.

Ez a minta lehetővé teszi a kifinomult interaktív alkalmazások létrehozását, ahol a felhasználók az automatizált munkafolyamatok kulcsfontosságú döntési pontjain adhatnak bemenetet.

Mit fog felépíteni?

Létrehoz egy interaktív számtippelési játék munkafolyamatot, amely bemutatja a kérés-válasz mintákat:

  • AI-ügynök, amely intelligens találgatásokat tesz
  • Olyan végrehajtók, amelyek közvetlenül küldhetnek kéréseket az request_info API használatával
  • Turnuskezelő, amely koordinálja az ügynök és az emberi interakciók közötti kapcsolatot @response_handler.
  • Interaktív konzolbemenet/kimenet valós idejű visszajelzéshez

Előfeltételek

  • Python 3.10 vagy újabb
  • Az Azure OpenAI üzembe helyezése konfigurálva
  • Azure CLI-hitelesítés konfigurálva (az login)
  • A Python aszinkron programozásának alapszintű ismerete

Alapfogalmak

Kérelmek és válaszok képességei

A végrehajtók beépített kérés- és válaszképességekkel rendelkeznek, amelyek lehetővé teszik a cikluson belüli emberi interakciókat:

  • Hívás ctx.request_info(request_data=request_data, response_type=response_type) kérések küldéséhez
  • Válaszok kezelése a @response_handler dekorátor használatával
  • Egyéni kérés-/választípusok definiálása öröklési követelmények nélkül

Kérés-válasz folyamat

A végrehajtók közvetlenül küldhetnek kéréseket ctx.request_info() használatával, és kezelhetik a válaszokat a @response_handler dekoratőrrel.

  1. Végrehajtó hívások ctx.request_info(request_data=request_data, response_type=response_type)
  2. A munkafolyamat kibocsát egy RequestInfoEvent kérési adatot
  3. A külső rendszer (emberi, API stb.) feldolgozza a kérést
  4. A rendszer visszaküldi a választ a send_responses_streaming()
  5. A munkafolyamat folytatódik, és kézbesíti a választ a végrehajtó @response_handler metódusára

A környezet beállítása

Először telepítse a szükséges csomagokat:

pip install agent-framework-core --pre
pip install azure-identity

Kérelem- és válaszmodellek definiálása

Először határozza meg a kérés-válasz kommunikáció adatstruktúráinak meghatározását:

import asyncio
from dataclasses import dataclass
from pydantic import BaseModel

from agent_framework import (
    AgentExecutor,
    AgentExecutorRequest,
    AgentExecutorResponse,
    ChatMessage,
    Executor,
    RequestInfoEvent,
    Role,
    WorkflowBuilder,
    WorkflowContext,
    WorkflowOutputEvent,
    WorkflowRunState,
    WorkflowStatusEvent,
    handler,
    response_handler,
)
from agent_framework.azure import AzureOpenAIChatClient
from azure.identity import AzureCliCredential

@dataclass
class HumanFeedbackRequest:
    """Request message for human feedback in the guessing game."""
    prompt: str = ""
    guess: int | None = None

class GuessOutput(BaseModel):
    """Structured output from the AI agent with response_format enforcement."""
    guess: int

A HumanFeedbackRequest egyszerű adatosztály strukturált kérelemterhekhez.

  • Erős gépelés a kérelem hasznos adataihoz
  • Előre kompatibilis érvényesítés
  • Tegye egyértelművé a korreláció szemantikáját a válaszokkal
  • Környezetfüggő mezők (az előző becsléshez hasonlóan) a gazdag felhasználói felületi kérésekhez

A Turn Manager létrehozása

A turn manager koordinálja az AI-ügynök és az ember közötti folyamatot:

class TurnManager(Executor):
    """Coordinates turns between the AI agent and human player.

    Responsibilities:
    - Start the game by requesting the agent's first guess
    - Process agent responses and request human feedback
    - Handle human feedback and continue the game or finish
    """

    def __init__(self, id: str | None = None):
        super().__init__(id=id or "turn_manager")

    @handler
    async def start(self, _: str, ctx: WorkflowContext[AgentExecutorRequest]) -> None:
        """Start the game by asking the agent for an initial guess."""
        user = ChatMessage(Role.USER, text="Start by making your first guess.")
        await ctx.send_message(AgentExecutorRequest(messages=[user], should_respond=True))

    @handler
    async def on_agent_response(
        self,
        result: AgentExecutorResponse,
        ctx: WorkflowContext,
    ) -> None:
        """Handle the agent's guess and request human guidance."""
        # Parse structured model output (defensive default if agent didn't reply)
        text = result.agent_run_response.text or ""
        last_guess = GuessOutput.model_validate_json(text).guess if text else None

        # Craft a clear human prompt that defines higher/lower relative to agent's guess
        prompt = (
            f"The agent guessed: {last_guess if last_guess is not None else text}. "
            "Type one of: higher (your number is higher than this guess), "
            "lower (your number is lower than this guess), correct, or exit."
        )
        # Send a request using the request_info API
        await ctx.request_info(
            request_data=HumanFeedbackRequest(prompt=prompt, guess=last_guess),
            response_type=str
        )

    @response_handler
    async def on_human_feedback(
        self,
        original_request: HumanFeedbackRequest,
        feedback: str,
        ctx: WorkflowContext[AgentExecutorRequest, str],
    ) -> None:
        """Continue the game or finish based on human feedback."""
        reply = feedback.strip().lower()
        # Use the correlated request's guess to avoid extra state reads
        last_guess = original_request.guess

        if reply == "correct":
            await ctx.yield_output(f"Guessed correctly: {last_guess}")
            return

        # Provide feedback to the agent for the next guess
        user_msg = ChatMessage(
            Role.USER,
            text=f'Feedback: {reply}. Return ONLY a JSON object matching the schema {{"guess": <int 1..10>}}.',
        )
        await ctx.send_message(AgentExecutorRequest(messages=[user_msg], should_respond=True))

A munkafolyamat létrehozása

Hozza létre az összes összetevőt összekötő fő munkafolyamatot:

async def main() -> None:
    # Create the chat agent with structured output enforcement
    chat_client = AzureOpenAIChatClient(credential=AzureCliCredential())
    agent = chat_client.create_agent(
        instructions=(
            "You guess a number between 1 and 10. "
            "If the user says 'higher' or 'lower', adjust your next guess. "
            'You MUST return ONLY a JSON object exactly matching this schema: {"guess": <integer 1..10>}. '
            "No explanations or additional text."
        ),
        response_format=GuessOutput,
    )

    # Create workflow components
    turn_manager = TurnManager(id="turn_manager")
    agent_exec = AgentExecutor(agent=agent, id="agent")

    # Build the workflow graph
    workflow = (
        WorkflowBuilder()
        .set_start_executor(turn_manager)
        .add_edge(turn_manager, agent_exec)  # Ask agent to make/adjust a guess
        .add_edge(agent_exec, turn_manager)  # Agent's response goes back to coordinator
        .build()
    )

    # Execute the interactive workflow
    await run_interactive_workflow(workflow)

async def run_interactive_workflow(workflow):
    """Run the workflow with human-in-the-loop interaction."""
    pending_responses: dict[str, str] | None = None
    completed = False
    workflow_output: str | None = None

    print("🎯 Number Guessing Game")
    print("Think of a number between 1 and 10, and I'll try to guess it!")
    print("-" * 50)

    while not completed:
        # First iteration uses run_stream("start")
        # Subsequent iterations use send_responses_streaming with pending responses
        stream = (
            workflow.send_responses_streaming(pending_responses)
            if pending_responses
            else workflow.run_stream("start")
        )

        # Collect events for this turn
        events = [event async for event in stream]
        pending_responses = None

        # Process events to collect requests and detect completion
        requests: list[tuple[str, str]] = []  # (request_id, prompt)
        for event in events:
            if isinstance(event, RequestInfoEvent) and isinstance(event.data, HumanFeedbackRequest):
                # RequestInfoEvent for our HumanFeedbackRequest
                requests.append((event.request_id, event.data.prompt))
            elif isinstance(event, WorkflowOutputEvent):
                # Capture workflow output when yielded
                workflow_output = str(event.data)
                completed = True

        # Check workflow status
        pending_status = any(
            isinstance(e, WorkflowStatusEvent) and e.state == WorkflowRunState.IN_PROGRESS_PENDING_REQUESTS
            for e in events
        )
        idle_with_requests = any(
            isinstance(e, WorkflowStatusEvent) and e.state == WorkflowRunState.IDLE_WITH_PENDING_REQUESTS
            for e in events
        )

        if pending_status:
            print("🔄 State: IN_PROGRESS_PENDING_REQUESTS (requests outstanding)")
        if idle_with_requests:
            print("⏸️  State: IDLE_WITH_PENDING_REQUESTS (awaiting human input)")

        # Handle human requests if any
        if requests and not completed:
            responses: dict[str, str] = {}
            for req_id, prompt in requests:
                print(f"\n🤖 {prompt}")
                answer = input("👤 Enter higher/lower/correct/exit: ").lower()

                if answer == "exit":
                    print("👋 Exiting...")
                    return
                responses[req_id] = answer
            pending_responses = responses

    # Show final result
    print(f"\n🎉 {workflow_output}")

A példa futtatása

A teljes munka implementációját a Human-in-the-Loop kitaláló játék mintájában találja.

Hogyan működik?

  1. Munkafolyamat inicializálása: A munkafolyamat az TurnManager AI-ügynök kezdeti becslésének lekérésével kezdődik.

  2. Ügynök válasza: Az AI-ügynök találgatást végez, és strukturált JSON-t ad vissza, amely visszafolyik a TurnManager.

  3. Emberi kérés: A TurnManager feldolgozza az ügynök találgatását, és hívja ctx.request_info() egy HumanFeedbackRequest.

  4. Munkafolyamat-szüneteltetés: A munkafolyamat kibocsát egy RequestInfoEvent , és addig folytatódik, amíg nem lehet további műveleteket végrehajtani, majd megvárja az emberi bemenetet.

  5. Emberi válasz: A külső alkalmazás összegyűjti az emberi bemenetet, és visszaküldi a válaszokat a használatával send_responses_streaming().

  6. Folytatás és folytatás: A munkafolyamat folytatódik, a TurnManagermetódus feldolgozza @response_handler az emberi visszajelzést, és vagy befejezi a játékot, vagy egy másik kérést küld az ügynöknek.

Főbb előnyök

  • Strukturált kommunikáció: A típusbiztos kérés- és válaszmodellek megakadályozzák a futtatókörnyezeti hibákat
  • Korreláció: A kérelemazonosítók biztosítják, hogy a válaszok megfeleljenek a megfelelő kéréseknek
  • Szüneteltethető végrehajtás: A munkafolyamatok határozatlan ideig szünetelhetnek, miközben külső bemenetre várnak
  • Állapotmegőrzés: A munkafolyamat állapota a szüneteltetés és a folytatás közötti ciklusokban is megmarad
  • Eseményvezérelt: A gazdag eseményrendszer betekintést nyújt a munkafolyamat állapotába és az áttűnésekbe

Ez a minta lehetővé teszi kifinomult interaktív alkalmazások létrehozását, amelyekben az AI-ügynökök és az emberek zökkenőmentesen együttműködnek a strukturált munkafolyamatokon belül.

Következő lépések

Tudnivalók a munkafolyamatok ellenőrzéséről és folytatásáról

  • Last updated on