Guia de Quick-Start do Microsoft Agent Framework

Pré-requisitos

Antes de começar, verifique se você tem o seguinte:

• SDK do .NET 8.0 ou posterior
• Recurso do Azure OpenAI com um modelo implantado (por exemplo, gpt-4o-mini)
• CLI do Azure instalada e autenticada (az login)
• O usuário tem os papéis Cognitive Services OpenAI User ou Cognitive Services OpenAI Contributor para o recurso do Azure OpenAI.

Criar um projeto

dotnet new console -o AgentFrameworkQuickStart
cd AgentFrameworkQuickStart

Instalar pacotes

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

Primeiro, adicione os seguintes pacotes NuGet do Microsoft Agent Framework ao 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 backend. Ele criará um agente básico usando AzureOpenAIClient e gpt-4o-mini com instruções personalizadas.

Exemplo de código

Certifique-se de substituir https://your-resource.openai.azure.com/ pelo ponto de extremidade 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 que contenha os aprimoramentos ou correções mais recentes, os builds noturnos do Agent Framework estarão disponíveis em https://github.com/orgs/microsoft/packages?repo_name=agent-framework.

Para baixar as versões de desenvolvimento 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 no "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 do código-fonte usado) ignore-o.
   • Para obter mais informações sobre onde armazenar esse arquivo, consulte nuget.config referência.

6. Agora você pode adicionar pacotes do build noturno 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 da seguinte maneira:

   <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, verifique se você tem o seguinte:

• Python 3.10 ou posterior
• Um projeto de IA do Azure com um modelo implantado (por exemplo, gpt-4o-mini)
• CLI do Azure instalada e autenticada (az login)
• Instale o Pacote do Agent Framework:

pip install -U agent-framework --pre

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 o back-end. Ele criará um agente básico usando ChatAgent e AzureAIAgentClient com instruções personalizadas.

Defina as seguintes variáveis de ambiente:

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

Exemplo de código

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 obter exemplos mais detalhados e cenários avançados, consulte os exemplos de IA do Azure.