Sdílet prostřednictvím

Vytváření strukturovaného výstupu pomocí agentů

V tomto kurzu se dozvíte, jak vytvořit strukturovaný výstup pomocí agenta, kde je agent založený na službě Dokončování chatu Azure OpenAI.

Důležité

Ne všechny typy agentů podporují strukturovaný výstup. Tento krok používá funkci ChatClientAgent, která podporuje strukturovaný výstup.

Požadavky

Informace o požadavcích a instalaci balíčků NuGet naleznete v kroku Vytvoření a spuštění jednoduchého agenta v tomto kurzu.

Vytvoření agenta se strukturovaným výstupem

Je ChatClientAgent postaven na vrcholu jakékoli IChatClient implementace. Podkladový chatovací klient používá ChatClientAgent k podpoře strukturovaného výstupu.

Při vytváření agenta máte možnost zadat výchozí ChatOptions instanci, která se má použít pro podkladového chatovacího klienta. Tato ChatOptions instance umožňuje vybrat preferovaný ChatResponseFormat.

Různé možnosti ResponseFormat jsou k dispozici.

Tento příklad vytvoří agenta, který vytvoří strukturovaný výstup ve formě objektu JSON, který odpovídá určitému schématu.

Nejjednodušší způsob, jak vytvořit schéma, je definovat typ, který představuje strukturu požadovaného výstupu z agenta, a pak použít metodu AIJsonUtilities.CreateJsonSchema k vytvoření schématu z typu.

using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.Extensions.AI;

public class PersonInfo
{
    public string? Name { get; set; }
    public int? Age { get; set; }
    public string? Occupation { get; set; }
}

JsonElement schema = AIJsonUtilities.CreateJsonSchema(typeof(PersonInfo));

Pak můžete vytvořit ChatOptions instanci, která používá toto schéma pro formát odpovědi.

using Microsoft.Extensions.AI;

ChatOptions chatOptions = new()
{
    ResponseFormat = ChatResponseFormat.ForJsonSchema(
        schema: schema,
        schemaName: "PersonInfo",
        schemaDescription: "Information about a person including their name, age, and occupation")
};

Tuto ChatOptions instanci lze použít při vytváření agenta.

using System;
using Azure.AI.OpenAI;
using Azure.Identity;
using Microsoft.Agents.AI;
using OpenAI;

AIAgent agent = new AzureOpenAIClient(
    new Uri("https://<myresource>.openai.azure.com"),
    new DefaultAzureCredential())
        .GetChatClient("gpt-4o-mini")
        .AsAIAgent(new ChatClientAgentOptions()
        {
            Name = "HelpfulAssistant",
            Instructions = "You are a helpful assistant.",
            ChatOptions = chatOptions
        });

Výstraha

DefaultAzureCredential je vhodný pro vývoj, ale vyžaduje pečlivé zvážení v produkčním prostředí. V produkčním prostředí zvažte použití konkrétních přihlašovacích údajů (např ManagedIdentityCredential. ) k zabránění problémům s latencí, neúmyslnému testování přihlašovacích údajů a potenciálním bezpečnostním rizikům z náhradních mechanismů.

Teď můžete agenta spustit s některými textovými informacemi, které může agent použít k vyplnění strukturovaného výstupu.

var response = await agent.RunAsync("Please provide information about John Smith, who is a 35-year-old software engineer.");

Odpověď agenta je pak možné deserializovat do PersonInfo třídy pomocí Deserialize<T> metody na objekt odpovědi.

var personInfo = response.Deserialize<PersonInfo>(JsonSerializerOptions.Web);
Console.WriteLine($"Name: {personInfo.Name}, Age: {personInfo.Age}, Occupation: {personInfo.Occupation}");

Při streamování se odpověď agenta streamuje jako řada aktualizací a odpověď můžete deserializovat pouze po přijetí všech aktualizací. Před deserializací je nutné sestavit všechny aktualizace do jediné odpovědi.

var updates = agent.RunStreamingAsync("Please provide information about John Smith, who is a 35-year-old software engineer.");
personInfo = (await updates.ToAgentResponseAsync()).Deserialize<PersonInfo>(JsonSerializerOptions.Web);

Návod

Najdete kompletní spustitelné příklady v ukázkách .NET.

Příklad streamování

Návod

Najdete kompletní spustitelné příklady v ukázkách .NET.

V tomto kurzu se dozvíte, jak vytvořit strukturovaný výstup pomocí agenta, kde je agent založený na službě Dokončování chatu Azure OpenAI.

Důležité

Ne všechny typy agentů podporují strukturovaný výstup. Podporuje Agent strukturovaný výstup při použití s kompatibilními chatovacími klienty.

Požadavky

Informace o požadavcích a instalaci balíčků najdete v části Vytvoření a spuštění jednoduchého agenta v tomto kurzu.

Vytvoření agenta se strukturovaným výstupem

Je Agent postaven na jakékoli implementaci chatovacího klienta, která podporuje strukturovaný výstup. Agent Použije response_format parametr k určení požadovaného výstupního schématu.

Při vytváření nebo spuštění agenta můžete poskytnout Pydantický model, který definuje strukturu očekávaného výstupu.

Různé formáty odpovědí se podporují na základě možností podkladového chatovacího klienta.

Tento příklad vytvoří agenta, který vytvoří strukturovaný výstup ve formě objektu JSON, který odpovídá schématu Pydantického modelu.

Nejprve definujte Pydantický model, který představuje strukturu požadovaného výstupu z agenta:

from pydantic import BaseModel

class PersonInfo(BaseModel):
    """Information about a person."""
    name: str | None = None
    age: int | None = None
    occupation: str | None = None

Teď můžete vytvořit agenta pomocí chatovacího klienta Azure OpenAI:

from agent_framework.azure import AzureOpenAIChatClient
from azure.identity import AzureCliCredential

# Create the agent using Azure OpenAI Chat Client
agent = AzureOpenAIChatClient(credential=AzureCliCredential()).as_agent(
    name="HelpfulAssistant",
    instructions="You are a helpful assistant that extracts person information from text."
)

Teď můžete spustit agenta s některými textovými informacemi a zadat formát strukturovaného výstupu pomocí parametru response_format :

response = await agent.run(
    "Please provide information about John Smith, who is a 35-year-old software engineer.",
    response_format=PersonInfo
)

Odpověď agenta bude obsahovat strukturovaný výstup ve value vlastnosti, ke kterému je možné přistupovat přímo jako instance modelu Pydantic:

if response.value:
    person_info = response.value
    print(f"Name: {person_info.name}, Age: {person_info.age}, Occupation: {person_info.occupation}")
else:
    print("No structured data found in response")

Při streamování vrátí agent.run(..., stream=True) hodnotu ResponseStream. Integrovaný finalizátor streamu automaticky zpracovává analýzu strukturovaného výstupu, takže můžete iterovat pomocí aktualizací v reálném čase a pak volat get_final_response() pro získání zpracovaného výsledku.

# Stream updates in real time, then get the structured result
stream = agent.run(query, stream=True, options={"response_format": PersonInfo})
async for update in stream:
    print(update.text, end="", flush=True)

# get_final_response() returns the AgentResponse with the parsed value
final_response = await stream.get_final_response()

if final_response.value:
    person_info = final_response.value
    print(f"Name: {person_info.name}, Age: {person_info.age}, Occupation: {person_info.occupation}")

Pokud nepotřebujete zpracovávat jednotlivé aktualizace streamování, můžete iteraci úplně přeskočit – get_final_response() automaticky bude stream využívat:

stream = agent.run(query, stream=True, options={"response_format": PersonInfo})
final_response = await stream.get_final_response()

if final_response.value:
    person_info = final_response.value
    print(f"Name: {person_info.name}, Age: {person_info.age}, Occupation: {person_info.occupation}")

Kompletní příklad

# Copyright (c) Microsoft. All rights reserved.

import asyncio

from agent_framework.openai import OpenAIResponsesClient
from pydantic import BaseModel

"""
OpenAI Responses Client with Structured Output Example

This sample demonstrates using structured output capabilities with OpenAI Responses Client,
showing Pydantic model integration for type-safe response parsing and data extraction.
"""


class OutputStruct(BaseModel):
    """A structured output for testing purposes."""

    city: str
    description: str


async def non_streaming_example() -> None:
    print("=== Non-streaming example ===")

    agent = OpenAIResponsesClient().as_agent(
        name="CityAgent",
        instructions="You are a helpful agent that describes cities in a structured format.",
    )

    query = "Tell me about Paris, France"
    print(f"User: {query}")

    result = await agent.run(query, options={"response_format": OutputStruct})

    if structured_data := result.value:
        print("Structured Output Agent:")
        print(f"City: {structured_data.city}")
        print(f"Description: {structured_data.description}")
    else:
        print(f"Failed to parse response: {result.text}")


async def streaming_example() -> None:
    print("=== Streaming example ===")

    agent = OpenAIResponsesClient().as_agent(
        name="CityAgent",
        instructions="You are a helpful agent that describes cities in a structured format.",
    )

    query = "Tell me about Tokyo, Japan"
    print(f"User: {query}")

    # Stream updates in real time using ResponseStream
    stream = agent.run(query, stream=True, options={"response_format": OutputStruct})
    async for update in stream:
        if update.text:
            print(update.text, end="", flush=True)
    print()

    # get_final_response() returns the AgentResponse with structured output parsed
    result = await stream.get_final_response()

    if structured_data := result.value:
        print("Structured Output (from streaming with ResponseStream):")
        print(f"City: {structured_data.city}")
        print(f"Description: {structured_data.description}")
    else:
        print(f"Failed to parse response: {result.text}")


async def main() -> None:
    print("=== OpenAI Responses Agent with Structured Output ===")

    await non_streaming_example()
    await streaming_example()


if __name__ == "__main__":
    asyncio.run(main())

Další kroky

Odpovědi na pozadí

  • Last updated on