Compartilhar via

Produzindo saída estruturada com agentes

Esta etapa do tutorial mostra como produzir uma saída estruturada com um agente, em que o agente é criado no serviço de Conclusão de Chat do Azure OpenAI.

Importante

Nem todos os tipos de agente dão suporte à saída estruturada. Esta etapa usa um ChatClientAgent, que dá suporte à saída estruturada.

Pré-requisitos

Para pré-requisitos e instalação de pacotes NuGet, consulte a etapa Criar e executar um agente simples neste tutorial.

Criar o agente com saída estruturada

O ChatClientAgent é criado com base em qualquer implementação de IChatClient. O ChatClientAgent usa o suporte para a saída estruturada fornecida pelo cliente de chat subjacente.

Ao criar o agente, você tem a opção de fornecer a instância padrão ChatOptions a ser usada para o cliente de chat subjacente. Essa ChatOptions instância permite que você escolha uma ChatResponseFormat preferida.

Várias opções ResponseFormat estão disponíveis.

  • Uma propriedade interna ChatResponseFormat.Text: a resposta será texto sem formatação.
  • Uma propriedade interna ChatResponseFormat.Json : a resposta será um objeto JSON sem nenhum esquema específico.
  • Uma instância personalizada ChatResponseFormatJson : a resposta será um objeto JSON que está em conformidade com um esquema específico.

Este exemplo cria um agente que produz uma saída estruturada na forma de um objeto JSON que está em conformidade com um esquema específico.

A maneira mais fácil de produzir o esquema é definir um tipo que representa a estrutura da saída desejada do agente e, em seguida, usar o AIJsonUtilities.CreateJsonSchema método para criar um esquema do tipo.

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

Em seguida, você pode criar uma ChatOptions instância que usa esse esquema para o formato de resposta.

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

Essa ChatOptions instância pode ser usada ao criar o agente.

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

Agora você pode apenas executar o agente com algumas informações textuais que o agente pode usar para preencher a saída estruturada.

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

Em seguida, a resposta do agente pode ser desserializada na PersonInfo classe usando o Deserialize<T> método no objeto de resposta.

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

Ao transmitir, a resposta do agente é transmitida como uma série de atualizações e você só pode desserializar a resposta depois que todas as atualizações forem recebidas. Você deve agrupar todas as atualizações em uma única resposta antes de desserializá-la.

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

Esta etapa do tutorial mostra como produzir uma saída estruturada com um agente, em que o agente é criado no serviço de Conclusão de Chat do Azure OpenAI.

Importante

Nem todos os tipos de agente dão suporte à saída estruturada. O ChatAgent suporta a saída estruturada quando usado com clientes de chat compatíveis.

Pré-requisitos

Para pré-requisitos e instalação de pacotes, consulte a etapa Criar e executar um agente simples neste tutorial.

Criar o agente com saída estruturada

Ele ChatAgent é construído sobre qualquer implementação de cliente de bate-papo que dê suporte à saída estruturada. O ChatAgent usa o response_format parâmetro para especificar o esquema de saída desejado.

Ao criar ou executar o agente, você pode fornecer um modelo Pydantic que define a estrutura da saída esperada.

Há suporte para vários formatos de resposta com base nos recursos subjacentes do cliente de chat.

Este exemplo cria um agente que produz uma saída estruturada na forma de um objeto JSON que está em conformidade com um esquema de modelo Pydantic.

Primeiro, defina um modelo Pydantic que represente a estrutura da saída desejada do agente:

from pydantic import BaseModel

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

Agora você pode criar um agente usando o cliente de chat do 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."
)

Agora você pode executar o agente com algumas informações textuais e especificar o formato de saída estruturado usando o response_format parâmetro:

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

A resposta do agente conterá a saída estruturada na propriedade value, que pode ser acessada diretamente como uma instância do modelo 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")

Ao transmitir, a resposta do agente é transmitida como uma série de atualizações. Para obter a saída estruturada, você deve coletar todas as atualizações e acessar o valor final da resposta:

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

Próximas etapas

Usando um agente como uma ferramenta de função

  • Last updated on