Создание структурированных выходных данных с помощью агентов

На этом шаге руководства показано, как создать структурированные выходные данные с агентом, где агент основан на службе завершения чата Azure OpenAI.

Это важно

Не все типы агентов поддерживают структурированные выходные данные. На этом шаге используется объект ChatClientAgent, который поддерживает структурированные выходные данные.

Предпосылки

Предварительные требования и установка пакетов NuGet см. в разделе "Создание и запуск простого агента " в этом руководстве.

Создание агента со структурированными выходными данными

Он ChatClientAgent построен на основе любой возможной IChatClient реализации. ChatClientAgent использует поддержку структурированного вывода, предоставляемую базовым клиентом чата.

При создании агента у вас есть возможность указать экземпляр по умолчанию ChatOptions, который будет использоваться для подлежащего клиента чата. Этот ChatOptions экземпляр позволяет выбрать предпочтительный ChatResponseFormatвариант.

Доступны различные варианты ResponseFormat :

• Встроенное ChatResponseFormat.Text свойство: ответ будет обычным текстом.
• Встроенное ChatResponseFormat.Json свойство: ответ будет объектом JSON без какой-либо конкретной схемы.
• Настраиваемый ChatResponseFormatJson экземпляр: ответ будет объектом JSON, соответствующим определенной схеме.

В этом примере создается агент, который создает структурированные выходные данные в виде объекта JSON, соответствующего определенной схеме.

Самый простой способ создать схему — определить тип, представляющий структуру выходных данных агента, а затем использовать AIJsonUtilities.CreateJsonSchema метод для создания схемы из типа.

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

Затем можно создать ChatOptions экземпляр, использующий эту схему для формата ответа.

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

Этот ChatOptions экземпляр можно использовать при создании агента.

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

Теперь можно просто запустить агент с некоторыми текстовыми сведениями, которые агент может использовать для заполнения структурированных выходных данных.

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

Затем ответ агента можно десериализировать в PersonInfo класс с помощью Deserialize<T> метода в объекте ответа.

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

При потоковой трансляции ответ агента передается в виде серии обновлений, и его можно десериализовать только после получения всех обновлений. Перед десериализацией необходимо собрать все обновления в один ответ.

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

На этом шаге руководства показано, как создать структурированные выходные данные с агентом, где агент основан на службе завершения чата Azure OpenAI.

Это важно

Не все типы агентов поддерживают структурированные выходные данные. Поддерживает вывод структурированных данных ChatAgent при использовании с совместимыми клиентами чата.

Предпосылки

Для ознакомления с предварительными требованиями и установкой пакетов см. шаг "Создание и запуск простого агента" в этом руководстве.

Создание агента со структурированными выходными данными

ChatAgent построен поверх любой реализации клиента чата, поддерживающей структурированный вывод. ChatAgent Использует response_format параметр для указания требуемой выходной схемы.

При создании или запуске агента можно указать модель Pydantic, которая определяет структуру ожидаемых выходных данных.

Поддерживаются различные форматы ответов на основе базовых возможностей клиента чата.

В этом примере создается агент, который создает структурированные выходные данные в виде объекта JSON, соответствующего схеме модели Pydantic.

Сначала определите модель Pydantic, представляющую структуру выходных данных, которые требуется от агента:

from pydantic import BaseModel

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

Теперь вы можете создать агент с помощью клиента Чата 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."
)

Теперь агент можно запустить с некоторыми текстовыми сведениями и указать структурированный выходной формат с помощью response_format параметра:

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

Ответ агента будет содержать структурированные выходные данные в свойстве value , доступ к которому можно получить непосредственно в качестве экземпляра модели 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")

При потоковой передаче ответ агента передается в виде ряда обновлений. Чтобы получить структурированные выходные данные, необходимо собрать все обновления, а затем получить окончательное значение ответа:

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

Дальнейшие шаги

Использование агента в качестве средства функции