Udostępnij przez

Tworzenie uporządkowanych danych wyjściowych z wykorzystaniem agentów

W tym kroku samouczka pokazano, jak utworzyć ustrukturyzowany wynik za pomocą agenta, w którym agent jest oparty na usłudze Ukończenia Czatu Azure OpenAI.

Ważne

Nie wszystkie typy agentów obsługują dane wyjściowe ze strukturą. W tym kroku używany jest komponent ChatClientAgent, który obsługuje strukturalne dane wyjściowe.

Wymagania wstępne

Aby uzyskać wymagania wstępne i zainstalować pakiety NuGet, zobacz krok Tworzenie i uruchamianie prostego agenta w tym samouczku.

Tworzenie agenta ze ustrukturyzowanymi danymi wyjściowymi

Element ChatClientAgent jest oparty na dowolnej IChatClient implementacji. Funkcja ChatClientAgent korzysta z obsługi danych wyjściowych ze strukturą udostępnianych przez bazowego klienta czatu.

Podczas tworzenia agenta możesz podać domyślne wystąpienie ChatOptions do użycia dla bazowego klienta czatu. To ChatOptions wystąpienie umożliwia wybranie preferowanego ChatResponseFormat.

Dostępne są różne opcje ResponseFormat :

W tym przykładzie tworzony jest agent tworzący ustrukturyzowane dane wyjściowe w postaci obiektu JSON zgodnego z określonym schematem.

Najprostszym sposobem utworzenia schematu jest zdefiniowanie typu reprezentującego strukturę danych wyjściowych z agenta, a następnie użycie AIJsonUtilities.CreateJsonSchema metody w celu utworzenia schematu na podstawie 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));

Następnie możesz utworzyć ChatOptions wystąpienie, które używa tego schematu dla formatu odpowiedzi.

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

Tego ChatOptions wystąpienia można używać do tworzenia 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 AzureCliCredential())
        .GetChatClient("gpt-4o-mini")
        .CreateAIAgent(new ChatClientAgentOptions()
        {
            Name = "HelpfulAssistant",
            Instructions = "You are a helpful assistant.",
            ChatOptions = chatOptions
        });

Teraz możesz po prostu uruchomić agenta z pewnymi tekstowymi informacjami, których agent może użyć do wypełnienia ustrukturyzowanych danych wyjściowych.

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

Następnie odpowiedź agenta może zostać zdeserializowana do klasy PersonInfo przy użyciu metody Deserialize<T> na obiekcie odpowiedzi.

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

Podczas strumieniowania odpowiedź agenta jest przesyłana w formie serii aktualizacji, a deserializację odpowiedzi można przeprowadzić dopiero po odebraniu wszystkich aktualizacji. Należy zebrać wszystkie aktualizacje w jedną odpowiedź przed deserializowaniem ich.

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

W tym kroku samouczka pokazano, jak utworzyć ustrukturyzowany wynik za pomocą agenta, w którym agent jest oparty na usłudze Ukończenia Czatu Azure OpenAI.

Ważne

Nie wszystkie typy agentów obsługują dane wyjściowe ze strukturą. Funkcja ChatAgent obsługuje dane wyjściowe ze strukturą, gdy są używane z zgodnymi klientami czatu.

Wymagania wstępne

Aby uzyskać informacje o wymaganiach wstępnych i instalowanych pakietach, zobacz krok Tworzenie i uruchamianie prostego agenta w tym samouczku.

Tworzenie agenta ze ustrukturyzowanymi danymi wyjściowymi

Element ChatAgent jest zbudowany na podstawie dowolnej implementacji klienta czatu, która obsługuje ustrukturyzowane dane wyjściowe. Parametr ChatAgent używa parametru response_format do określenia żądanego schematu wyjściowego.

Podczas tworzenia lub uruchamiania agenta można podać model Pydantic, który definiuje strukturę oczekiwanych danych wyjściowych.

Różne formaty odpowiedzi są obsługiwane na podstawie podstawowych możliwości klienta czatu.

W tym przykładzie tworzony jest agent, który generuje ustrukturyzowane dane wyjściowe w postaci obiektu JSON zgodnego ze schematem modelu Pydantic.

Najpierw zdefiniuj model Pydantic, który reprezentuje strukturę danych wyjściowych, które chcesz uzyskać od agenta:

from pydantic import BaseModel

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

Teraz możesz utworzyć agenta przy użyciu klienta czatu usługi 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()).create_agent(
    name="HelpfulAssistant",
    instructions="You are a helpful assistant that extracts person information from text."
)

Teraz możesz uruchomić agenta z pewnymi informacjami tekstowymi i określić ustrukturyzowany format danych wyjściowych przy użyciu parametru response_format :

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

Odpowiedź zgenerowana przez agenta będzie zawierać ustrukturyzowane dane wyjściowe we właściwości value, do których można uzyskać bezpośredni dostęp jako wystąpienie 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")

Podczas przesyłania strumieniowego odpowiedź agenta jest przesyłana strumieniowo jako seria aktualizacji. Aby uzyskać dane wyjściowe ze strukturą, należy zebrać wszystkie aktualizacje, a następnie uzyskać dostęp do końcowej wartości odpowiedzi:

from agent_framework import AgentRunResponse

# Get structured response from streaming agent using AgentRunResponse.from_agent_response_generator
# This method collects all streaming updates and combines them into a single AgentRunResponse
final_response = await AgentRunResponse.from_agent_response_generator(
    agent.run_stream(query, response_format=PersonInfo),
    output_format_type=PersonInfo,
)

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

Dalsze kroki

Używanie agenta jako narzędzia funkcji

  • Last updated on