Partilhar via


Guia Quick-Start do Microsoft Agent Framework

Este guia ajudará você a começar a trabalhar rapidamente com um agente básico usando o Agent Framework e o Azure OpenAI.

Pré-requisitos

Antes de começar, certifique-se de ter o seguinte:

Observação

O Microsoft Agent Framework é suportado com todas as versões ativamente suportadas do .NET. Para os fins deste exemplo, recomendamos o SDK do .NET 8 ou uma versão posterior.

Observação

Esta demonstração usa credenciais da CLI do Azure para autenticação. Certifique-se de que tenha sessão iniciada com az login e acesso ao recurso OpenAI do Azure. Para obter mais informações, consulte a documentação da CLI do Azure. Também é possível substituir o AzureCliCredential por um ApiKeyCredential se tiver uma chave de API e não desejar usar a autenticação baseada em função, sendo que, nesse caso, az login não é necessário.

Criar um projeto

dotnet new console -o AgentFrameworkQuickStart
cd AgentFrameworkQuickStart

Instalar pacotes

Os pacotes serão publicados na Galeria NuGet | MicrosoftAgentFramework.

Primeiro, adicione os seguintes pacotes NuGet do Microsoft Agent Framework em seu aplicativo, usando os seguintes comandos:

dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
dotnet add package Microsoft.Agents.AI.OpenAI --prerelease

Executando um exemplo de agente básico

Este exemplo demonstra como criar e usar um agente de IA simples com o Azure OpenAI Chat Completion como back-end. Ele criará um agente básico usando AzureOpenAIClient com gpt-4o-mini e instruções personalizadas.

Código de Exemplo

Certifique-se de substituir https://your-resource.openai.azure.com/ pelo ponto final do seu recurso do Azure OpenAI.

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

AIAgent agent = new AzureOpenAIClient(
  new Uri("https://your-resource.openai.azure.com/"),
  new AzureCliCredential())
    .GetChatClient("gpt-4o-mini")
    .CreateAIAgent(instructions: "You are good at telling jokes.");

Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));

(Opcional) Instalar pacotes noturnos

Se você precisar obter um pacote contendo os aprimoramentos ou correções mais recentes, as compilações noturnas do Agent Framework estão disponíveis em https://github.com/orgs/microsoft/packages?repo_name=agent-framework.

Para baixar compilações noturnas, siga estas etapas:

  1. Você precisará de uma conta do GitHub para concluir essas etapas.

  2. Crie um token de acesso pessoal do GitHub com o read:packages escopo usando estas instruções.

  3. Se sua conta fizer parte da organização da Microsoft, você deverá autorizar a Microsoft organização como uma organização de logon único.

    1. Clique em "Configurar SSO" ao lado do Token de Acesso Pessoal que você acabou de criar e, em seguida, autorize Microsoft.
  4. Use o seguinte comando para adicionar a origem dos Pacotes do Microsoft GitHub à sua configuração do NuGet:

    dotnet nuget add source --username GITHUBUSERNAME --password GITHUBPERSONALACCESSTOKEN --store-password-in-clear-text --name GitHubMicrosoft "https://nuget.pkg.github.com/microsoft/index.json"
    
  5. Ou você pode criar manualmente um NuGet.Config arquivo.

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
      <packageSources>
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
        <add key="github" value="https://nuget.pkg.github.com/microsoft/index.json" />
      </packageSources>
    
      <packageSourceMapping>
        <packageSource key="nuget.org">
          <package pattern="*" />
        </packageSource>
        <packageSource key="github">
          <package pattern="*nightly"/>
          <package pattern="Microsoft.Agents.AI" />
        </packageSource>
      </packageSourceMapping>
    
      <packageSourceCredentials>
        <github>
            <add key="Username" value="<Your GitHub Id>" />
            <add key="ClearTextPassword" value="<Your Personal Access Token>" />
          </github>
      </packageSourceCredentials>
    </configuration>
    
    • Se você colocar esse arquivo na pasta do projeto, certifique-se de que o Git (ou qualquer controle de origem que você use) o ignore.
    • Para obter mais informações sobre onde armazenar esse arquivo, consulte nuget.config referência.
  6. Agora você pode adicionar pacotes da compilação noturna ao seu projeto.

    Por exemplo, use este comando dotnet add package Microsoft.Agents.AI --prerelease

  7. E a versão mais recente do pacote pode ser referenciada no projeto assim:

    <PackageReference Include="Microsoft.Agents.AI" Version="*-*" />

Para obter mais informações, consulte https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.

Pré-requisitos

Antes de começar, certifique-se de ter o seguinte:

pip install -U agent-framework --pre

Observação

Instalar agent-framework irá instalar agent-framework-core e todos os outros pacotes oficiais. Se quiseres instalar apenas o pacote Azure AI, podes executar: pip install agent-framework-azure-ai --pre Todos os pacotes oficiais, incluindo agent-framework-azure-ai o que dependem de agent-framework-core, por isso, na maioria dos casos, não precisas de especificar isso. A lista completa de pacotes oficiais pode ser encontrada no repositório GitHub do Agent Framework.

Observação

Este exemplo utiliza credenciais de CLI Azure para autenticação. Certifique-se de que tem sessão iniciada com az login e acesso ao projeto Azure AI. Para obter mais informações, consulte a documentação da CLI do Azure.

Executando um exemplo de agente básico

Este exemplo demonstra como criar e usar um agente de IA simples com a IA do Azure como back-end. Ele criará um agente básico usando ChatAgent com AzureAIAgentClient e instruções personalizadas.

Certifique-se de definir as seguintes variáveis de ambiente:

  • AZURE_AI_PROJECT_ENDPOINT: O seu endpoint do projeto de IA do Azure
  • AZURE_AI_MODEL_DEPLOYMENT_NAME: O nome da implementação do modelo

Código de Exemplo

import asyncio
from agent_framework.azure import AzureAIClient
from azure.identity.aio import AzureCliCredential

async def main():
    async with (
        AzureCliCredential() as credential,
        AzureAIClient(async_credential=credential).create_agent(
            instructions="You are good at telling jokes."
        ) as agent,
    ):
        result = await agent.run("Tell me a joke about a pirate.")
        print(result.text)

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

Mais exemplos

Para exemplos mais detalhados e cenários avançados, consulte os Exemplos de IA do Azure.

Próximos passos