共用方式為

Microsoft 代理程式架構 Quick-Start 指南

本指南可協助您使用 Agent Framework 和 Azure OpenAI 快速啟動並執行基本代理程式。

先決條件

在開始之前，請確保您具備以下條件：

備註

Microsoft Agent Framework 支援所有主動支援的 .NET 版本。 基於此範例的目的，建議使用 .NET 8 SDK 或更新版本。

備註

此示範會使用 Azure CLI 認證進行驗證。 請確定您已登入 az login 並有權存取 Azure OpenAI 資源。 如需詳細資訊，請參閱 Azure CLI 檔。 如果您有 API 金鑰且不想使用角色型驗證，也可以將 取代AzureCliCredentialApiKeyCredential為 （在此情況下az login不需要）。

建立專案

dotnet new console -o AgentFrameworkQuickStart
cd AgentFrameworkQuickStart

安裝套件

套件將會發佈至 NuGet 資源庫 |MicrosoftAgentFramework。

首先，使用下列命令，將下列 Microsoft Agent Framework NuGet 套件新增至您的應用程式：

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

執行基本代理程式範例

此範例示範如何建立和使用具有 Azure OpenAI 聊天完成作為後端的簡單 AI 代理程式。 它將利用AzureOpenAIClient和gpt-4o-mini以及自定義指令來創建一個基本代理。

範例程式碼

請務必將 https://your-resource.openai.azure.com/ 替換為 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."));

（可選）安裝 Nightly 套件

如果您需要取得包含最新增強功能或修正的套件，可以在https://github.com/orgs/microsoft/packages?repo_name=agent-framework取得 Agent Framework 的夜間構建。

若要下載夜間版本，請依照下列步驟操作：

  1. 您將需要一個 GitHub 帳戶才能完成這些步驟。

  2. 使用這些read:packages建立具有設定範圍的 GitHub 個人存取權杖。

  3. 如果您的帳戶是 Microsoft 組織的一部分，則您必須授權該 Microsoft 組織為單一登入組織。

    1. 按一下您剛建立的個人存取權杖旁邊的「設定 SSO」，然後授權 Microsoft。

  4. 使用下列命令將 Microsoft GitHub 套件來源新增至 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. 或者您可以手動建立檔案 NuGet.Config 。

    <?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>
    • 如果您將此檔案放在專案資料夾中，請確定 Git （或您使用的任何原始檔控制） 忽略它。
    • 如需儲存此檔案位置的詳細資訊，請參閱 nuget.config 參考。

  6. 您現在可以將夜間組建中的套件新增至您的專案。

    例如，請使用下列命令 dotnet add package Microsoft.Agents.AI --prerelease

  7. 而最新的套件發行版可以在專案中這樣引用：

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

如需詳細資訊，請參閱https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry。

先決條件

在開始之前，請確保您具備以下條件：

pip install -U agent-framework --pre

備註

安裝 agent-framework 時，會同時安裝 agent-framework-core 和所有其他官方套件。 如果你只想安裝 Azure AI 套件，可以執行： pip install agent-framework-azure-ai --pre 所有官方套件，包括 agent-framework-azure-ai ，都依賴於 agent-framework-core，所以大多數情況下你不需要特別指定。 完整的官方套件清單可在 Agent Framework 的 GitHub 倉庫中找到。

備註

此範例使用 Azure CLI 憑證進行認證。 請確定您已使用az login登入並有權存取 Azure AI 專案。 如需詳細資訊，請參閱 Azure CLI 檔。

執行基本代理程式範例

此範例示範如何建立和使用以 Azure AI 作為後端的簡單 AI 代理程式。 它將利用ChatAgent和AzureAIAgentClient以及自定義指令來創建一個基本代理。

請務必設定下列環境變數：

  • AZURE_AI_PROJECT_ENDPOINT：您的 Azure AI 專案端點
  • AZURE_AI_MODEL_DEPLOYMENT_NAME：模型部署的名稱

範例程式碼

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

更多範例

欲了解更多詳細範例與進階情境，請參閱 Azure AI 範例。

後續步驟

建立和執行代理程式

  • Last updated on