Obsługa żądań i odpowiedzi w przepływach pracy

Na platformie .NET przepływy pracy typu human-in-the-loop wykorzystują RequestPort oraz zewnętrzną obsługę żądań, aby wstrzymać wykonywanie i zbierać dane użytkownika. Ten wzorzec umożliwia interaktywne przepływy pracy, w których system może żądać informacji ze źródeł zewnętrznych podczas wykonywania.

Wymagania wstępne

• .NET SDK w wersji 8.0 lub nowszej.
• Skonfigurowany punkt końcowy usługi Azure OpenAI i wdrożenie.
• Zainstalowany i uwierzytelniony interfejs wiersza polecenia platformy Azure(na potrzeby uwierzytelniania poświadczeń platformy Azure).
• Podstawowa wiedza na temat języka C# i programowania asynchronicznego.
• Nowa aplikacja konsolowa.

Instalowanie pakietów NuGet

Najpierw zainstaluj wymagane pakiety dla projektu .NET:

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

Kluczowe składniki

RequestPort i żądania zewnętrzne

Element RequestPort działa jako most między przepływem pracy a zewnętrznymi źródłami wejściowymi. Gdy przepływ pracy wymaga danych wejściowych, generuje on RequestInfoEvent obsługiwany przez aplikację.

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

Typy sygnałów

Zdefiniuj typy sygnałów, aby komunikować się z różnymi typami żądań:

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

Funkcja wykonawcza przepływu pracy

Tworzenie funkcji wykonawczych, które przetwarzają dane wejściowe użytkownika i przekazują opinię:

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

Tworzenie przepływu pracy

Połącz RequestPort i wykonawcę w sprzężeniu zwrotnym.

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

Wykonywanie interaktywnego przepływu pracy

Obsługa żądań zewnętrznych podczas wykonywania przepływu pracy:

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

Obsługa żądań

Przetwarzanie różnych typów żądań wejściowych:

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

Pojęcia dotyczące implementacji

Przebieg zdarzenia RequestInfoEvent

1. Wykonywanie przepływu pracy: przepływ pracy jest realizowany, dopóki nie jest wymagana interwencja zewnętrzna
2. Generowanie żądania: element RequestPort generuje element RequestInfoEvent ze szczegółami żądania
3. Obsługa zewnętrzna: Aplikacja przechwytuje zdarzenie i zbiera dane wejściowe użytkownika
4. Przesyłanie odpowiedzi: Wyślij odpowiedź z powrotem ExternalResponse, aby kontynuować przepływ pracy
5. Wznowienie przepływu pracy: przepływ pracy kontynuuje przetwarzanie z podanymi danymi wejściowymi

Cykl życia przepływu pracy

• Wykonywanie przesyłania strumieniowego: służy StreamAsync do monitorowania zdarzeń w czasie rzeczywistym
• Obsługa zdarzeń: przetwarzanie RequestInfoEvent żądań wejściowych i WorkflowOutputEvent ich ukończenie
• Koordynacja odpowiedzi: Dopasowywanie odpowiedzi do żądań przy użyciu mechanizmu obsługi odpowiedzi w przepływie pracy

Przepływ implementacji

1. Inicjowanie przepływu pracy: przepływ pracy rozpoczyna się od wysłania elementu NumberSignal.Init do obiektu RequestPort.

2. Generowanie żądania: element RequestPort generuje RequestInfoEvent żądanie początkowego odgadnięcia od użytkownika.

3. Wstrzymanie przepływu pracy: przepływ pracy wstrzymuje się i czeka na zewnętrzne dane wejściowe, gdy aplikacja obsługuje żądanie.

4. Ludzka odpowiedź: aplikacja zewnętrzna zbiera dane wejściowe użytkownika i wysyła dane ExternalResponse z powrotem do przepływu pracy.

5. Przetwarzanie i opinie: JudgeExecutor przetwarza domysł i kończy przepływ pracy lub wysyła nowy sygnał (Powyżej/Poniżej), aby zażądać kolejnego odgadnięcia.

6. Kontynuacja pętli: proces powtarza się do momentu odgadnięcia poprawnej liczby.

Korzyści ze struktury

• Bezpieczeństwo typów: Ścisłe typowanie zapewnia zgodność kontraktów żądań i odpowiedzi
• Sterowane zdarzeniami: rozbudowany system zdarzeń zapewnia wgląd w wykonywanie przepływu pracy
• Wstrzymywane Wykonywanie: przepływy pracy mogą wstrzymywać się na czas nieokreślony podczas oczekiwania na zewnętrzne dane wejściowe
• Zarządzanie stanem: stan przepływu pracy jest zachowywany w cyklach wstrzymywania wznawiania
• Elastyczna integracja: usługa RequestPorts może być zintegrowana z dowolnym zewnętrznym źródłem danych wejściowych (interfejs użytkownika, interfejs API, konsola itp.)

Kompletny przykład

Aby uzyskać pełną implementację roboczą, zobacz przykład Human-in-the-Loop Basic.

Ten wzorzec umożliwia tworzenie zaawansowanych aplikacji interaktywnych, w których użytkownicy mogą udostępniać dane wejściowe w kluczowych punktach decyzyjnych w zautomatyzowanych przepływach pracy.

Co będziesz budować

Utworzysz interaktywny przepływ pracy gry w zgadywanie liczb, który demonstruje wzorce żądań i odpowiedzi.

• Agent sztucznej inteligencji, który dokonuje inteligentnych przypuszczeń
• Wykonawcy, którzy mogą bezpośrednio wysyłać żądania przy użyciu interfejsu request_info API
• Menedżer kolejności, który koordynuje interakcje między agentem a ludźmi przy użyciu @response_handler
• Interaktywna obsługa wejścia/wyjścia konsoli z natychmiastową informacją zwrotną

Wymagania wstępne

• Środowisko Python w wersji 3.10 lub nowszej
• Skonfigurowane wdrożenie usługi Azure OpenAI
• Skonfigurowano uwierzytelnianie w Azure CLI (az login)
• Podstawowa wiedza na temat programowania asynchronicznego języka Python

Kluczowe pojęcia

Możliwości żądań i odpowiedzi

Instancje wykonawcze mają wbudowane możliwości żądań i odpowiedzi, które umożliwiają integrację człowieka w procesie decyzyjnym.

• Wywołaj ctx.request_info(request_data=request_data, response_type=response_type) aby wysyłać żądania
• Użyj dekoratora @response_handler do obsługi odpowiedzi
• Definiowanie niestandardowych typów żądań/odpowiedzi bez wymagań dotyczących dziedziczenia

przepływ żądanie-odpowiedź

Wykonawcy mogą wysyłać żądania bezpośrednio przy użyciu ctx.request_info(), a odpowiedzi obsługiwać przy użyciu dekoratora @response_handler.

1. Wywołanie wykonawcy ctx.request_info(request_data=request_data, response_type=response_type)
2. Przepływ pracy emituje element RequestInfoEvent z danymi żądania
3. System zewnętrzny (człowiek, interfejs API itp.) przetwarza żądanie
4. Odpowiedź jest wysyłana z powrotem za pośrednictwem send_responses_streaming()
5. Proces pracy wznawia działanie i dostarcza odpowiedź do metody wykonawcy @response_handler

Konfigurowanie środowiska

Najpierw zainstaluj wymagane pakiety:

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

Definiowanie modeli żądań i odpowiedzi

Zacznij od zdefiniowania struktur danych na potrzeby komunikacji żądań-odpowiedzi:

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

Jest HumanFeedbackRequest to prosta klasa danych dla ładunków żądań strukturalnych:

• Silne typowanie ładunków żądań
• Walidacja zgodna z przyszłymi wersjami
• Wyczyść semantykę korelacji z odpowiedziami
• Pola kontekstowe (takie jak poprzednie odgadnięcie) dla zaawansowanych monitów interfejsu użytkownika

Tworzenie Menedżera włączania

Menedżer tur koordynuje wymianę między agentem sztucznej inteligencji a człowiekiem.

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

Tworzenie przepływu pracy

Utwórz główny przepływ pracy, który łączy wszystkie składniki:

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

Uruchamianie przykładu

Aby uzyskać kompletną działającą implementację, zobacz przykład Human-in-the-Loop Guessing Game.

Jak to działa

1. Inicjowanie przepływu pracy: przepływ pracy rozpoczyna się od TurnManager żądania początkowego odgadnięcia od agenta sztucznej inteligencji.

2. Odpowiedź agenta: agent sztucznej inteligencji odgadnie i zwraca ustrukturyzowany kod JSON, który przepływa z powrotem do elementu TurnManager.

3. Żądanie człowieka: TurnManager przetwarza zgadywanie agenta i wywołuje ctx.request_info() za pomocą HumanFeedbackRequest.

4. Wstrzymanie przepływu pracy: przepływ pracy emituje RequestInfoEvent i kontynuuje działanie do momentu, gdy nie można wykonać żadnych dalszych akcji, po czym oczekuje na input od człowieka.

5. Ludzka odpowiedź: aplikacja zewnętrzna zbiera dane wejściowe człowieka i wysyła odpowiedzi z powrotem przy użyciu polecenia send_responses_streaming().

6. Wznów i kontynuuj: przepływ pracy wznawia się, metoda TurnManager obiektu @response_handler przetwarza opinie człowieka i kończy grę lub wysyła kolejne żądanie do agenta.

Najważniejsze korzyści

• Komunikacja ustrukturyzowana: Modele żądań i odpowiedzi bezpiecznych typów uniemożliwiają błędy środowiska uruchomieniowego
• Korelacja: Identyfikatory żądań zapewniają dopasowanie odpowiedzi do poprawnych żądań
• Wstrzymywane Wykonywanie: przepływy pracy mogą wstrzymywać się na czas nieokreślony podczas oczekiwania na zewnętrzne dane wejściowe
• Zachowywanie stanu: stan przepływu pracy jest utrzymywany w cyklach wstrzymywania wznawiania
• Sterowane zdarzeniami: rozbudowany system zdarzeń zapewnia wgląd w stan i przejścia przepływu pracy

Ten wzorzec umożliwia tworzenie zaawansowanych aplikacji interaktywnych, w których agenci sztucznej inteligencji i ludzie bezproblemowo współpracują w ustrukturyzowanych przepływach pracy.