Sdílet prostřednictvím

Zpracování požadavků a odpovědí v pracovních postupech

Tento kurz ukazuje, jak zpracovávat požadavky a odpovědi v pracovních postupech pomocí pracovních postupů rozhraní Agent Framework. Dozvíte se, jak vytvořit interaktivní pracovní postupy, které můžou pozastavit provádění a požadovat vstup z externích zdrojů (jako jsou lidé nebo jiné systémy), a potom pokračovat po poskytnutí odpovědi.

Pokryté koncepty

V .NET používají pracovní postupy human-in-the-loop RequestPort a externí zpracování požadavků k pozastavení provádění a shromažďování uživatelského vstupu. Tento model umožňuje interaktivní pracovní postupy, ve kterých může systém během provádění požadovat informace z externích zdrojů.

Požadavky

Instalace balíčků NuGet

Nejprve nainstalujte požadované balíčky pro váš projekt .NET:

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

Klíčové komponenty

RequestPort a externí požadavky

Funguje RequestPort jako most mezi pracovním postupem a externími vstupními zdroji. Když pracovní postup potřebuje vstup, vygeneruje RequestInfoEvent, kterou zpracovává vaše aplikace:

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

Typy signálů

Definujte typy signálů pro komunikaci různých typů požadavků:

/// <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
}

Exekutor pracovního postupu

Vytvořte exekutory, které zpracovávají uživatelský vstup a poskytují zpětnou vazbu:

/// <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);
        }
    }
}

Sestavení pracovního postupu

Připojte RequestPort a vykonavatele ve smyčce zpětné vazby.

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>();
    }
}

Spuštění interaktivního pracovního postupu

Zpracování externích požadavků během provádění pracovního postupu:

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;
        }
    }
}

Zpracování žádostí

Zpracování různých typů vstupních požadavků:

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.");
    }
}

Koncepty implementace

Průběh RequestInfoEvent

  1. Provádění pracovního postupu: Pracovní postup zpracovává, dokud nepotřebuje externí vstup.
  2. Generování požadavku: RequestPort vygeneruje RequestInfoEvent podrobnosti požadavku.
  3. Externí zpracování: Aplikace zachytí událost a shromažďuje vstup uživatele.
  4. Odeslání odpovědi: Odeslání odpovědi: Odeslání ExternalResponse zpět pro pokračování pracovního postupu
  5. Obnovení pracovního postupu: Pracovní postup pokračuje ve zpracování se zadaným vstupem.

Životní cyklus pracovního postupu

  • Sledování streamingu: Použijte StreamAsync k monitorování událostí v reálném čase.
  • Zpracování událostí: Zpracování RequestInfoEvent vstupních požadavků a WorkflowOutputEvent dokončení
  • Koordinace odpovědí: Shoda odpovědí na požadavky pomocí mechanismu zpracování odpovědí pracovního postupu

Tok implementace

  1. Inicializace pracovního postupu: Pracovní postup začíná odesláním NumberSignal.Init na RequestPort.

  2. Generování požadavku: RequestPort vygeneruje RequestInfoEvent požadavek na počáteční odhad od uživatele.

  3. Pozastavení pracovního postupu: Pracovní postup se pozastaví a čeká na externí vstup, zatímco aplikace zpracovává požadavek.

  4. Lidská odpověď: Externí aplikace shromažďuje vstup uživatele a odesílá ExternalResponse zpět do pracovního postupu.

  5. Zpracování a zpětná vazba: Zpracuje JudgeExecutor odhad a buď dokončí pracovní postup, nebo odešle nový signál (výše/níže) a požádá o další odhad.

  6. Pokračování smyčky: Proces se opakuje, dokud nebude uhodnuto správné číslo.

Výhody frameworku

  • Bezpečnost typů: Silné typování zajišťuje zachování kontraktů mezi žádostí a odpovědí
  • Řízený událostmi: Bohatý systém událostí poskytuje přehled o provádění pracovních postupů
  • Pozastavení provádění: Pracovní postupy se můžou pozastavit po neomezenou dobu při čekání na externí vstup.
  • Správa stavu: Stav pracovního postupu je zachován napříč cykly pozastavení a obnovení
  • Flexibilní integrace: RequestPorts se dá integrovat s jakýmkoli externím vstupním zdrojem (uživatelské rozhraní, rozhraní API, konzola atd.).

Kompletní ukázka

Kompletní pracovní implementaci najdete v základní ukázce human-in-the-loop.

Tento model umožňuje vytvářet sofistikované interaktivní aplikace, kde uživatelé můžou poskytovat vstup v klíčových rozhodovacích bodech v rámci automatizovaných pracovních postupů.

Co budete vytvářet

Vytvoříte interaktivní pracovní postup hádání čísel, který ukazuje vzory odpovědí na požadavek:

  • Agent umělé inteligence, který provádí inteligentní odhady
  • Exekutory, které můžou přímo odesílat požadavky pomocí request_info rozhraní API
  • Správce směny, který koordinuje mezi agentem a lidskou interakcí pomocí @response_handler
  • Vstup/výstup interaktivní konzoly pro zpětnou vazbu v reálném čase

Požadavky

  • Python 3.10 nebo novější
  • Nakonfigurované nasazení Azure OpenAI
  • Nakonfigurované ověřování Azure CLI (az login)
  • Základní znalost asynchronního programování v Pythonu

Klíčové koncepty

Možnosti požadavků a odpovědí

Spouštěče mají integrované možnosti požadavků a odpovědí, které umožňují interakce řízené lidmi.

  • Zavolejte ctx.request_info(request_data=request_data, response_type=response_type) k odesílání žádostí
  • Použijte dekorátor @response_handler k zpracování odpovědí
  • Definování vlastních typů požadavků a odpovědí bez požadavků na dědičnost

Proces Žádost-Odpověď

Vykonavatelé mohou odesílat žádosti přímo pomocí ctx.request_info() a zpracovávat odpovědi pomocí dekorátoru @response_handler.

  1. Volání exekutoru ctx.request_info(request_data=request_data, response_type=response_type)
  2. Pracovní postup vydá RequestInfoEvent s daty požadavku.
  3. Požadavek zpracovává externí systém (člověk, rozhraní API atd.).
  4. Odpověď se odešle zpět prostřednictvím send_responses_streaming()
  5. Pracovní postup obnoví a doručí odpověď na metodu exekutoru @response_handler .

Nastavení prostředí

Nejprve nainstalujte požadované balíčky:

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

Definování modelů požadavků a odpovědí

Začněte definováním datových struktur pro komunikaci s žádostí a odpovědí:

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

Jedná se HumanFeedbackRequest o jednoduchou třídu dat pro datové části strukturovaných požadavků:

  • Silné psaní datových částí požadavků
  • Ověřování kompatibilní s budoucími verzemi
  • Zřejmá sémantika korelace s reakcemi
  • Kontextová pole (podobně jako předchozí odhad) pro výzvy k bohatému uživatelskému rozhraní

Vytvoření Správce otáčení

Manažer střídání koordinuje komunikaci mezi agentem AI a člověkem.

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))

Sestavení pracovního postupu

Vytvořte hlavní pracovní postup, který spojuje všechny komponenty:

async def main() -> None:
    # Create the chat agent with structured output enforcement
    chat_client = AzureOpenAIChatClient(credential=AzureCliCredential())
    agent = chat_client.as_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}")

Spuštění příkladu

Kompletní pracovní implementaci najdete v ukázce hry „Human-in-the-Loop Guessing Game“.

Jak to funguje

  1. Inicializace pracovního postupu: Pracovní postup začíná TurnManager žádostí o počáteční odhad od agenta AI.

  2. Odpověď agenta: Agent AI provede odhad a vrátí strukturovaný JSON, který se vrátí zpět do TurnManager.

  3. Lidský požadavek: TurnManager zpracovává odhad agenta a volá ctx.request_info() s HumanFeedbackRequest.

  4. Pozastavení pracovního postupu: Pracovní postup vygeneruje RequestInfoEvent a pokračuje, dokud nebude možné provést žádné další akce, a pak počká na vstup člověka.

  5. Lidská odpověď: Externí aplikace shromažďuje lidské vstupy a odesílá odpovědi zpět pomocí send_responses_streaming().

  6. Obnovit a pokračovat: Pracovní postup pokračuje, metoda TurnManager@response_handler zpracovává lidskou zpětnou vazbu a buď ukončí hru, nebo odešle další požadavek agentovi.

Klíčové výhody

  • Strukturovaná komunikace: Modely požadavků a odpovědí bezpečných typů brání chybám za běhu
  • Korelace: ID požadavků zajišťují, že odpovědi odpovídají správným požadavkům.
  • Pozastavení provádění: Pracovní postupy se můžou pozastavit po neomezenou dobu při čekání na externí vstup.
  • Zachování stavu: Stav pracovního postupu se udržuje napříč cykly pozastavení a obnovení
  • Řízený událostmi: Bohatý systém událostí poskytuje přehled o stavu a přechodech pracovního postupu

Tento model umožňuje vytvářet sofistikované interaktivní aplikace, ve kterých agenti AI a lidé bezproblémově spolupracují v rámci strukturovaných pracovních postupů.

Další kroky

Informace o vytváření kontrolních bodů a obnovení pracovních postupů

  • Last updated on