AG-UI を使用したバックエンドツールのレンダリング

このチュートリアルでは、AG-UI エージェントに関数ツールを追加する方法について説明します。関数ツールは、データの取得、計算の実行、外部システムとの対話などの特定のタスクを実行するためにエージェントが呼び出すことができるカスタム C# メソッドです。 AG-UI では、これらのツールはバックエンドで実行され、その結果は自動的にクライアントにストリーミングされます。

[前提条件]

開始する前に、作業の開始に関するチュートリアルを完了し、次のことを行っていることを確認します。

.NET 8.0 以降
Microsoft.Agents.AI.Hosting.AGUI.AspNetCore パッケージがインストールされている
構成された Azure OpenAI サービス
AG-UI サーバーとクライアントのセットアップに関する基本的な理解

バックエンドツールレンダリングとは

バックエンドツールのレンダリングとは、次のことを意味します。

関数ツールがサーバーで定義されている
AI エージェントは、これらのツールを呼び出すタイミングを決定します
ツールはバックエンドで実行されます (サーバー側)
ツール呼び出しイベントと結果がリアルタイムでクライアントにストリーミングされる
クライアントは、ツールの実行の進行状況に関する更新プログラムを受け取ります

関数ツールを使用した AG-UI サーバーの作成

複雑なパラメーター型でツールを登録する方法を示す完全なサーバー実装を次に示します。

// Copyright (c) Microsoft. All rights reserved.

using System.ComponentModel;
using System.Text.Json.Serialization;
using Azure.AI.OpenAI;
using Azure.Identity;
using Microsoft.Agents.AI;
using Microsoft.Agents.AI.Hosting.AGUI.AspNetCore;
using Microsoft.Extensions.AI;
using Microsoft.Extensions.Options;
using OpenAI.Chat;

WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient().AddLogging();
builder.Services.ConfigureHttpJsonOptions(options =>
    options.SerializerOptions.TypeInfoResolverChain.Add(SampleJsonSerializerContext.Default));
builder.Services.AddAGUI();

WebApplication app = builder.Build();

string endpoint = builder.Configuration["AZURE_OPENAI_ENDPOINT"]
    ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
string deploymentName = builder.Configuration["AZURE_OPENAI_DEPLOYMENT_NAME"]
    ?? throw new InvalidOperationException("AZURE_OPENAI_DEPLOYMENT_NAME is not set.");

// Define request/response types for the tool
internal sealed class RestaurantSearchRequest
{
    public string Location { get; set; } = string.Empty;
    public string Cuisine { get; set; } = "any";
}

internal sealed class RestaurantSearchResponse
{
    public string Location { get; set; } = string.Empty;
    public string Cuisine { get; set; } = string.Empty;
    public RestaurantInfo[] Results { get; set; } = [];
}

internal sealed class RestaurantInfo
{
    public string Name { get; set; } = string.Empty;
    public string Cuisine { get; set; } = string.Empty;
    public double Rating { get; set; }
    public string Address { get; set; } = string.Empty;
}

// JSON serialization context for source generation
[JsonSerializable(typeof(RestaurantSearchRequest))]
[JsonSerializable(typeof(RestaurantSearchResponse))]
internal sealed partial class SampleJsonSerializerContext : JsonSerializerContext;

// Define the function tool
[Description("Search for restaurants in a location.")]
static RestaurantSearchResponse SearchRestaurants(
    [Description("The restaurant search request")] RestaurantSearchRequest request)
{
    // Simulated restaurant data
    string cuisine = request.Cuisine == "any" ? "Italian" : request.Cuisine;

    return new RestaurantSearchResponse
    {
        Location = request.Location,
        Cuisine = request.Cuisine,
        Results =
        [
            new RestaurantInfo
            {
                Name = "The Golden Fork",
                Cuisine = cuisine,
                Rating = 4.5,
                Address = $"123 Main St, {request.Location}"
            },
            new RestaurantInfo
            {
                Name = "Spice Haven",
                Cuisine = cuisine == "Italian" ? "Indian" : cuisine,
                Rating = 4.7,
                Address = $"456 Oak Ave, {request.Location}"
            },
            new RestaurantInfo
            {
                Name = "Green Leaf",
                Cuisine = "Vegetarian",
                Rating = 4.3,
                Address = $"789 Elm Rd, {request.Location}"
            }
        ]
    };
}

// Get JsonSerializerOptions from the configured HTTP JSON options
Microsoft.AspNetCore.Http.Json.JsonOptions jsonOptions = app.Services.GetRequiredService<IOptions<Microsoft.AspNetCore.Http.Json.JsonOptions>>().Value;

// Create tool with serializer options
AITool[] tools =
[
    AIFunctionFactory.Create(
        SearchRestaurants,
        serializerOptions: jsonOptions.SerializerOptions)
];

// Create the AI agent with tools
ChatClient chatClient = new AzureOpenAIClient(
        new Uri(endpoint),
        new DefaultAzureCredential())
    .GetChatClient(deploymentName);

ChatClientAgent agent = chatClient.AsIChatClient().CreateAIAgent(
    name: "AGUIAssistant",
    instructions: "You are a helpful assistant with access to restaurant information.",
    tools: tools);

// Map the AG-UI agent endpoint
app.MapAGUI("/", agent);

await app.RunAsync();

主要概念

サーバー側の実行: ツールはサーバープロセスで実行されます
自動ストリーミング: ツールの呼び出しと結果がリアルタイムでクライアントにストリーミングされる

Important

複雑なパラメーター型 (オブジェクト、配列など) を使用してツールを作成する場合は、serializerOptionsに AIFunctionFactory.Create() パラメーターを指定する必要があります。シリアライザーオプションは、アプリケーションの構成された JsonOptions から IOptions<Microsoft.AspNetCore.Http.Json.JsonOptions> 経由で取得し、アプリケーションの JSON シリアル化の残りの部分との一貫性を確保する必要があります。

サーバーの実行

環境変数を設定し、次のコマンドを実行します。

export AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/"
export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-4o-mini"
dotnet run --urls http://localhost:8888

クライアントでのツール呼び出しの監視

概要チュートリアルの基本クライアントには、エージェントの最終的なテキスト応答が表示されます。ただし、サーバーからストリーミングされるツールの呼び出しと結果を観察するために拡張できます。

ツール実行の詳細の表示

ツールの呼び出しと結果をリアルタイムで表示するには、クライアントのストリーミングループを拡張して、 FunctionCallContent と FunctionResultContentを処理します。

// Inside the streaming loop from getting-started.md
await foreach (AgentRunResponseUpdate update in agent.RunStreamingAsync(messages, thread))
{
    ChatResponseUpdate chatUpdate = update.AsChatResponseUpdate();

    // ... existing run started code ...

    // Display streaming content
    foreach (AIContent content in update.Contents)
    {
        switch (content)
        {
            case TextContent textContent:
                Console.ForegroundColor = ConsoleColor.Cyan;
                Console.Write(textContent.Text);
                Console.ResetColor();
                break;

            case FunctionCallContent functionCallContent:
                Console.ForegroundColor = ConsoleColor.Green;
                Console.WriteLine($"\n[Function Call - Name: {functionCallContent.Name}]");

                // Display individual parameters
                if (functionCallContent.Arguments != null)
                {
                    foreach (var kvp in functionCallContent.Arguments)
                    {
                        Console.WriteLine($"  Parameter: {kvp.Key} = {kvp.Value}");
                    }
                }
                Console.ResetColor();
                break;

            case FunctionResultContent functionResultContent:
                Console.ForegroundColor = ConsoleColor.Magenta;
                Console.WriteLine($"\n[Function Result - CallId: {functionResultContent.CallId}]");

                if (functionResultContent.Exception != null)
                {
                    Console.WriteLine($"  Exception: {functionResultContent.Exception}");
                }
                else
                {
                    Console.WriteLine($"  Result: {functionResultContent.Result}");
                }
                Console.ResetColor();
                break;

            case ErrorContent errorContent:
                Console.ForegroundColor = ConsoleColor.Red;
                Console.WriteLine($"\n[Error: {errorContent.Message}]");
                Console.ResetColor();
                break;
        }
    }
}

ツール呼び出しで予想される出力

エージェントがバックエンドツールを呼び出すと、次の情報が表示されます。

User (:q or quit to exit): What's the weather like in Amsterdam?

[Run Started - Thread: thread_abc123, Run: run_xyz789]

[Function Call - Name: SearchRestaurants]
  Parameter: Location = Amsterdam
  Parameter: Cuisine = any

[Function Result - CallId: call_def456]
  Result: {"Location":"Amsterdam","Cuisine":"any","Results":[...]}

The weather in Amsterdam is sunny with a temperature of 22°C. Here are some 
great restaurants in the area: The Golden Fork (Italian, 4.5 stars)...
[Run Finished - Thread: thread_abc123]

主要概念

FunctionCallContent: Name と Arguments (パラメーターキーと値のペア) で呼び出されるツールを表します。
FunctionResultContent: ツールの Result または Exceptionが含まれます。 CallId

次のステップ

関数ツールを追加できるようになったので、次のことができます。

フロントエンドツール: フロントエンドツールを追加します。

Dojo でテストする: AG-UI の Dojo アプリを使用してエージェントをテストする

その他のリソース

このチュートリアルでは、AG-UI エージェントに関数ツールを追加する方法について説明します。関数ツールは、データの取得、計算の実行、外部システムとの対話などの特定のタスクを実行するためにエージェントが呼び出すことができるカスタム Python 関数です。 AG-UI では、これらのツールはバックエンドで実行され、その結果は自動的にクライアントにストリーミングされます。

[前提条件]

開始する前に、作業の開始に関するチュートリアルを完了し、次のことを行っていることを確認します。

Python 3.10 以降
agent-framework-ag-ui インストールされました
構成された Azure OpenAI サービス
AG-UI サーバーとクライアントのセットアップに関する基本的な理解

注

これらのサンプルでは、認証に DefaultAzureCredential を使用します。 Azure で認証されていることを確認します (たとえば、 az login経由)。詳細については、 Azure ID のドキュメントを参照してください。

バックエンドツールレンダリングとは

バックエンドツールのレンダリングとは、次のことを意味します。

関数ツールがサーバーで定義されている
AI エージェントは、これらのツールを呼び出すタイミングを決定します
ツールはバックエンドで実行されます (サーバー側)
ツール呼び出しイベントと結果がリアルタイムでクライアントにストリーミングされる
クライアントは、ツールの実行の進行状況に関する更新プログラムを受け取ります

このアプローチでは、次の機能が提供されます。

セキュリティ: 機密性の高い操作はサーバー上に留まる
整合性: すべてのクライアントが同じツール実装を使用する
透過性: クライアントはツールの実行の進行状況を表示できます
柔軟性: クライアントコードを変更せずにツールを更新する

関数ツールの作成

基本関数ツール

@ai_functionデコレーターを使用して、任意の Python 関数をツールに変換できます。

from typing import Annotated
from pydantic import Field
from agent_framework import ai_function


@ai_function
def get_weather(
    location: Annotated[str, Field(description="The city")],
) -> str:
    """Get the current weather for a location."""
    # In a real application, you would call a weather API
    return f"The weather in {location} is sunny with a temperature of 22°C."

主要概念

@ai_function デコレーター: エージェントで使用できる関数をマークします
型注釈: パラメーターの型情報を指定する
Annotated と Field: エージェントがパラメーターを理解するのに役立つ説明を追加する
Docstring: 関数の動作について説明します (エージェントが関数を使用するタイミングを決定するのに役立ちます)
戻り値: エージェントに返された結果 (およびクライアントにストリーミング)

多機能ツール

エージェントにさらに多くの機能を提供する複数のツールを提供できます。

from typing import Any
from agent_framework import ai_function


@ai_function
def get_weather(
    location: Annotated[str, Field(description="The city.")],
) -> str:
    """Get the current weather for a location."""
    return f"The weather in {location} is sunny with a temperature of 22°C."


@ai_function
def get_forecast(
    location: Annotated[str, Field(description="The city.")],
    days: Annotated[int, Field(description="Number of days to forecast")] = 3,
) -> dict[str, Any]:
    """Get the weather forecast for a location."""
    return {
        "location": location,
        "days": days,
        "forecast": [
            {"day": 1, "weather": "Sunny", "high": 24, "low": 18},
            {"day": 2, "weather": "Partly cloudy", "high": 22, "low": 17},
            {"day": 3, "weather": "Rainy", "high": 19, "low": 15},
        ],
    }

関数ツールを使用した AG-UI サーバーの作成

関数ツールを使用した完全なサーバー実装を次に示します。

"""AG-UI server with backend tool rendering."""

import os
from typing import Annotated, Any

from agent_framework import ChatAgent, ai_function
from agent_framework.azure import AzureOpenAIChatClient
from agent_framework_ag_ui import add_agent_framework_fastapi_endpoint
from azure.identity import AzureCliCredential
from fastapi import FastAPI
from pydantic import Field


# Define function tools
@ai_function
def get_weather(
    location: Annotated[str, Field(description="The city")],
) -> str:
    """Get the current weather for a location."""
    # Simulated weather data
    return f"The weather in {location} is sunny with a temperature of 22°C."


@ai_function
def search_restaurants(
    location: Annotated[str, Field(description="The city to search in")],
    cuisine: Annotated[str, Field(description="Type of cuisine")] = "any",
) -> dict[str, Any]:
    """Search for restaurants in a location."""
    # Simulated restaurant data
    return {
        "location": location,
        "cuisine": cuisine,
        "results": [
            {"name": "The Golden Fork", "rating": 4.5, "price": "$$"},
            {"name": "Bella Italia", "rating": 4.2, "price": "$$$"},
            {"name": "Spice Garden", "rating": 4.7, "price": "$$"},
        ],
    }


# Read required configuration
endpoint = os.environ.get("AZURE_OPENAI_ENDPOINT")
deployment_name = os.environ.get("AZURE_OPENAI_DEPLOYMENT_NAME")

if not endpoint:
    raise ValueError("AZURE_OPENAI_ENDPOINT environment variable is required")
if not deployment_name:
    raise ValueError("AZURE_OPENAI_DEPLOYMENT_NAME environment variable is required")

chat_client = AzureOpenAIChatClient(
    credential=AzureCliCredential(),
    endpoint=endpoint,
    deployment_name=deployment_name,    
)

# Create agent with tools
agent = ChatAgent(
    name="TravelAssistant",
    instructions="You are a helpful travel assistant. Use the available tools to help users plan their trips.",
    chat_client=chat_client,
    tools=[get_weather, search_restaurants],
)

# Create FastAPI app
app = FastAPI(title="AG-UI Travel Assistant")
add_agent_framework_fastapi_endpoint(app, agent, "/")

if __name__ == "__main__":
    import uvicorn

    uvicorn.run(app, host="127.0.0.1", port=8888)

ツールイベントについて

エージェントがツールを呼び出すと、クライアントはいくつかのイベントを受け取ります。

ツール呼び出しイベント

# 1. TOOL_CALL_START - Tool execution begins
{
    "type": "TOOL_CALL_START",
    "toolCallId": "call_abc123",
    "toolCallName": "get_weather"
}

# 2. TOOL_CALL_ARGS - Tool arguments (may stream in chunks)
{
    "type": "TOOL_CALL_ARGS",
    "toolCallId": "call_abc123",
    "delta": "{\"location\": \"Paris, France\"}"
}

# 3. TOOL_CALL_END - Arguments complete
{
    "type": "TOOL_CALL_END",
    "toolCallId": "call_abc123"
}

# 4. TOOL_CALL_RESULT - Tool execution result
{
    "type": "TOOL_CALL_RESULT",
    "toolCallId": "call_abc123",
    "content": "The weather in Paris, France is sunny with a temperature of 22°C."
}

ツールイベント用の拡張クライアント

ツールの実行を表示する AGUIChatClient を使用した拡張クライアントを次に示します。

"""AG-UI client with tool event handling."""

import asyncio
import os

from agent_framework import ChatAgent, ToolCallContent, ToolResultContent
from agent_framework_ag_ui import AGUIChatClient


async def main():
    """Main client loop with tool event display."""
    server_url = os.environ.get("AGUI_SERVER_URL", "http://127.0.0.1:8888/")
    print(f"Connecting to AG-UI server at: {server_url}\n")

    # Create AG-UI chat client
    chat_client = AGUIChatClient(server_url=server_url)

    # Create agent with the chat client
    agent = ChatAgent(
        name="ClientAgent",
        chat_client=chat_client,
        instructions="You are a helpful assistant.",
    )

    # Get a thread for conversation continuity
    thread = agent.get_new_thread()

    try:
        while True:
            message = input("\nUser (:q or quit to exit): ")
            if not message.strip():
                continue

            if message.lower() in (":q", "quit"):
                break

            print("\nAssistant: ", end="", flush=True)
            async for update in agent.run_stream(message, thread=thread):
                # Display text content
                if update.text:
                    print(f"\033[96m{update.text}\033[0m", end="", flush=True)

                # Display tool calls and results
                for content in update.contents:
                    if isinstance(content, ToolCallContent):
                        print(f"\n\033[95m[Calling tool: {content.name}]\033[0m")
                    elif isinstance(content, ToolResultContent):
                        result_text = content.result if isinstance(content.result, str) else str(content.result)
                        print(f"\033[94m[Tool result: {result_text}]\033[0m")

            print("\n")

    except KeyboardInterrupt:
        print("\n\nExiting...")
    except Exception as e:
        print(f"\n\033[91mError: {e}\033[0m")


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

相互作用の例

強化されたサーバーとクライアントが動作している状態で:

User (:q or quit to exit): What's the weather like in Paris and suggest some Italian restaurants?

[Run Started]
[Tool Call: get_weather]
[Tool Result: The weather in Paris, France is sunny with a temperature of 22°C.]
[Tool Call: search_restaurants]
[Tool Result: {"location": "Paris", "cuisine": "Italian", "results": [...]}]
Based on the current weather in Paris (sunny, 22°C) and your interest in Italian cuisine,
I'd recommend visiting Bella Italia, which has a 4.2 rating. The weather is perfect for
outdoor dining!
[Run Finished]

ツール実装のベストプラクティス

エラー処理

ツールでエラーを適切に処理します。

@ai_function
def get_weather(
    location: Annotated[str, Field(description="The city.")],
) -> str:
    """Get the current weather for a location."""
    try:
        # Call weather API
        result = call_weather_api(location)
        return f"The weather in {location} is {result['condition']} with temperature {result['temp']}°C."
    except Exception as e:
        return f"Unable to retrieve weather for {location}. Error: {str(e)}"

豊富なリターン型

必要に応じて、構造化データを返します。

@ai_function
def analyze_sentiment(
    text: Annotated[str, Field(description="The text to analyze")],
) -> dict[str, Any]:
    """Analyze the sentiment of text."""
    # Perform sentiment analysis
    return {
        "text": text,
        "sentiment": "positive",
        "confidence": 0.87,
        "scores": {
            "positive": 0.87,
            "neutral": 0.10,
            "negative": 0.03,
        },
    }

説明ドキュメント

エージェントがツールを使用するタイミングを理解するのに役立つ明確な説明を提供します。

@ai_function
def book_flight(
    origin: Annotated[str, Field(description="Departure city and airport code, e.g., 'New York, JFK'")],
    destination: Annotated[str, Field(description="Arrival city and airport code, e.g., 'London, LHR'")],
    date: Annotated[str, Field(description="Departure date in YYYY-MM-DD format")],
    passengers: Annotated[int, Field(description="Number of passengers")] = 1,
) -> dict[str, Any]:
    """
    Book a flight for specified passengers from origin to destination.

    This tool should be used when the user wants to book or reserve airline tickets.
    Do not use this for searching flights - use search_flights instead.
    """
    # Implementation
    pass

クラスを使用したツールの編成

関連するツールの場合は、クラスで整理します。

from agent_framework import ai_function


class WeatherTools:
    """Collection of weather-related tools."""

    def __init__(self, api_key: str):
        self.api_key = api_key

    @ai_function
    def get_current_weather(
        self,
        location: Annotated[str, Field(description="The city.")],
    ) -> str:
        """Get current weather for a location."""
        # Use self.api_key to call API
        return f"Current weather in {location}: Sunny, 22°C"

    @ai_function
    def get_forecast(
        self,
        location: Annotated[str, Field(description="The city.")],
        days: Annotated[int, Field(description="Number of days")] = 3,
    ) -> dict[str, Any]:
        """Get weather forecast for a location."""
        # Use self.api_key to call API
        return {"location": location, "forecast": [...]}


# Create tools instance
weather_tools = WeatherTools(api_key="your-api-key")

# Create agent with class-based tools
agent = ChatAgent(
    name="WeatherAgent",
    instructions="You are a weather assistant.",
    chat_client=AzureOpenAIChatClient(...),
    tools=[
        weather_tools.get_current_weather,
        weather_tools.get_forecast,
    ],
)

次のステップ

バックエンドツールのレンダリングについて理解したら、次のことができます。

高度なツールの作成: Agent Framework を使用した関数ツールの作成の詳細

その他のリソース

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-11-11

次の方法で共有

AG-UI を使用したバックエンド ツールのレンダリング

[前提条件]

バックエンド ツールレンダリングとは

関数ツールを使用した AG-UI サーバーの作成

主要概念

サーバーの実行

クライアントでのツール呼び出しの監視

ツール実行の詳細の表示

ツール呼び出しで予想される出力

主要概念

次のステップ

その他のリソース

[前提条件]

バックエンド ツールレンダリングとは

関数ツールの作成

基本関数ツール

主要概念

多機能ツール

関数ツールを使用した AG-UI サーバーの作成

ツール イベントについて

ツール呼び出しイベント

ツール イベント用の拡張クライアント

相互作用の例

ツール実装のベスト プラクティス

エラー処理

豊富なリターン型

説明ドキュメント

クラスを使用したツールの編成

次のステップ

その他のリソース

フィードバック

その他のリソース

AG-UI を使用したバックエンドツールのレンダリング

バックエンドツールレンダリングとは

バックエンドツールレンダリングとは

ツールイベントについて

ツールイベント用の拡張クライアント

ツール実装のベストプラクティス