Menggunakan perangkat fungsi dengan agen

Langkah tutorial ini menunjukkan kepada Anda cara menggunakan alat fungsi dengan agen, yang didasarkan pada layanan Penyelesaian Obrolan Azure OpenAI.

Penting

Tidak semua jenis agen mendukung alat fitur. Beberapa mungkin hanya mendukung alat bawaan kustom, tanpa mengizinkan pemanggil untuk menyediakan fungsi mereka sendiri. Langkah ini menggunakan ChatClientAgent, yang mendukung alat fungsi.

Prasyarat

Untuk prasyarat dan menginstal paket NuGet, lihat langkah Membuat dan menjalankan agen sederhana dalam tutorial ini.

Membuat agen dengan alat fungsi

Alat fungsi hanyalah kode kustom yang Anda inginkan agar agen dapat memanggil saat diperlukan. Anda dapat mengubah metode C# apa pun menjadi alat fungsi, dengan menggunakan AIFunctionFactory.Create metode untuk membuat AIFunction instans dari metode .

Jika Anda perlu memberikan deskripsi tambahan tentang fungsi atau parameternya ke agen, sehingga dapat lebih akurat memilih antara fungsi yang berbeda, Anda dapat menggunakan System.ComponentModel.DescriptionAttribute atribut pada metode dan parameternya.

Berikut adalah contoh perangkat fungsi sederhana yang mensimulasikan pengambilan cuaca untuk lokasi tertentu. Ini dihiasi dengan atribut deskripsi untuk memberikan deskripsi tambahan tentang dirinya sendiri dan parameter lokasinya kepada agen.

using System.ComponentModel;

[Description("Get the weather for a given location.")]
static string GetWeather([Description("The location to get the weather for.")] string location)
    => $"The weather in {location} is cloudy with a high of 15°C.";

Saat membuat agen, Anda sekarang dapat menyediakan alat kepada agen dengan meneruskan daftar alat ke metode AsAIAgent.

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

AIAgent agent = new AzureOpenAIClient(
    new Uri("https://<myresource>.openai.azure.com"),
    new DefaultAzureCredential())
     .GetChatClient("gpt-4o-mini")
     .AsAIAgent(instructions: "You are a helpful assistant", tools: [AIFunctionFactory.Create(GetWeather)]);

Peringatan

DefaultAzureCredential nyaman untuk pengembangan tetapi membutuhkan pertimbangan yang cermat dalam produksi. Dalam produksi, pertimbangkan untuk menggunakan kredensial tertentu (misalnya, ManagedIdentityCredential) untuk menghindari masalah latensi, pemeriksaan kredensial yang tidak diinginkan, dan potensi risiko keamanan dari mekanisme fallback.

Sekarang Anda hanya dapat menjalankan agen seperti biasa, dan agen akan dapat memanggil GetWeather alat fungsi ketika diperlukan.

Console.WriteLine(await agent.RunAsync("What is the weather like in Amsterdam?"));

Petunjuk / Saran

Lihat sampel .NET untuk contoh lengkap yang dapat dijalankan.

Penting

Prasyarat

Untuk prasyarat dan menginstal paket Python, lihat langkah Membuat dan menjalankan agen sederhana dalam tutorial ini.

Membuat agen dengan alat fungsi

Alat fungsi hanyalah kode kustom yang Anda inginkan agar agen dapat memanggil saat diperlukan. Anda dapat mengubah fungsi Python apa pun menjadi alat fungsi dengan meneruskannya ke parameter agen tools saat membuat agen.

Jika Anda perlu memberikan deskripsi tambahan tentang fungsi atau parameternya ke agen, sehingga dapat memilih lebih akurat antara fungsi yang berbeda, Anda dapat menggunakan anotasi jenis Python dengan Annotated dan Pydantic Field untuk memberikan deskripsi.

Berikut adalah contoh perangkat fungsi sederhana yang mensimulasikan pengambilan cuaca untuk lokasi tertentu. Ini menggunakan anotasi jenis untuk memberikan deskripsi tambahan tentang fungsi dan parameter lokasinya kepada agen.

from typing import Annotated
from pydantic import Field

def get_weather(
    location: Annotated[str, Field(description="The location to get the weather for.")],
) -> str:
    """Get the weather for a given location."""
    return f"The weather in {location} is cloudy with a high of 15°C."

Anda juga dapat menggunakan @tool dekorator untuk secara eksplisit menentukan nama dan deskripsi fungsi:

from typing import Annotated
from pydantic import Field
from agent_framework import tool

@tool(name="weather_tool", description="Retrieves weather information for any location")
def get_weather(
    location: Annotated[str, Field(description="The location to get the weather for.")],
) -> str:
    return f"The weather in {location} is cloudy with a high of 15°C."

Jika Anda tidak menentukan parameter name dan description di dekorasi @tool, kerangka kerja akan secara otomatis menggunakan nama fungsi dan docstring sebagai alternatif.

Menggunakan skema eksplisit dengan `@tool`

Ketika Anda memerlukan kontrol penuh atas skema yang terekspos ke model, teruskan schema parameter ke @tool. Anda dapat menyediakan model Pydantic atau kamus skema JSON mentah.

# Load environment variables from .env file
load_dotenv()


# Approach 1: Pydantic model as explicit schema
class WeatherInput(BaseModel):
    """Input schema for the weather tool."""

    location: Annotated[str, Field(description="The city name to get weather for")]
    unit: Annotated[str, Field(description="Temperature unit: celsius or fahrenheit")] = "celsius"


@tool(
    name="get_weather",
    description="Get the current weather for a given location.",
    schema=WeatherInput,
    approval_mode="never_require",
    """Get the current weather for a location."""
    return f"The weather in {location} is 22 degrees {unit}."


# Approach 2: JSON schema dictionary as explicit schema
get_current_time_schema = {
    "type": "object",
    "properties": {
        "timezone": {"type": "string", "description": "The timezone to get the current time for", "default": "UTC"},
    },
}


@tool(
    name="get_current_time",
    description="Get the current time in a given timezone.",

Meneruskan konteks runtime saja ke alat

Gunakan parameter fungsi normal untuk nilai yang harus disediakan model. Gunakan FunctionInvocationContext untuk nilai khusus runtime seperti function_invocation_kwargs atau sesi saat ini. Parameter konteks yang disuntikkan disembunyikan dari skema yang terekspos ke model.

import asyncio
from typing import Annotated

from agent_framework import FunctionInvocationContext, tool
from agent_framework.openai import OpenAIResponsesClient
from dotenv import load_dotenv
from pydantic import Field
# Define the function tool with explicit invocation context.
# The context parameter can also be declared as an untyped ``ctx`` parameter.
@tool(approval_mode="never_require")
def get_weather(
    location: Annotated[str, Field(description="The location to get the weather for.")],
    ctx: FunctionInvocationContext,
) -> str:
    """Get the weather for a given location."""
    # Extract the injected argument from the explicit context
    user_id = ctx.kwargs.get("user_id", "unknown")

    # Simulate using the user_id for logging or personalization
    print(f"Getting weather for user: {user_id}")

    return f"The weather in {location} is cloudy with a high of 15°C."


async def main() -> None:
    agent = OpenAIResponsesClient().as_agent(
        name="WeatherAgent",
        instructions="You are a helpful weather assistant.",
        tools=[get_weather],
    )

    # Pass the runtime context explicitly when running the agent.
    response = await agent.run(
        "What is the weather like in Amsterdam?",
        function_invocation_kwargs={"user_id": "user_123"},
    )

Untuk detail selengkapnya tentang ctx.kwargs, ctx.session, dan middleware fungsi, lihat Konteks Runtime.

Membuat alat khusus deklarasi

Jika alat diimplementasikan di luar kerangka kerja (misalnya, sisi klien dalam UI), Anda dapat mendeklarasikannya tanpa implementasi menggunakan FunctionTool(..., func=None). Model masih dapat beralasan tentang dan memanggil alat, dan aplikasi Anda dapat memberikan hasilnya nanti.


# Load environment variables from .env file
load_dotenv()

# A declaration-only tool: the schema is sent to the LLM, but the framework
# has no implementation to execute. The caller must supply the result.
get_user_location = FunctionTool(
    name="get_user_location",
    func=None,
    description="Get the user's current city. Only the client application can resolve this.",
    input_model={
        "type": "object",
        "properties": {
            "reason": {"type": "string", "description": "Why the location is needed"},

Saat membuat agen, Anda sekarang dapat menyediakan fungsi alat ke agen, dengan meneruskannya ke parameter tools.

import asyncio
from agent_framework.azure import AzureOpenAIChatClient
from azure.identity import AzureCliCredential

agent = AzureOpenAIChatClient(credential=AzureCliCredential()).as_agent(
    instructions="You are a helpful assistant",
    tools=get_weather
)

Sekarang Anda hanya dapat menjalankan agen seperti biasa, dan agen akan dapat memanggil get_weather alat fungsi ketika diperlukan.

async def main():
    result = await agent.run("What is the weather like in Amsterdam?")
    print(result.text)

asyncio.run(main())

Membuat kelas dengan beberapa alat fungsi

Saat beberapa alat berbagi dependensi atau status yang dapat diubah, membungkusnya dalam sebuah kelas dan berikan metode yang terikat ke agen. Gunakan atribut kelas untuk nilai yang tidak boleh disediakan model, seperti klien layanan, bendera fitur, atau status cache.

import asyncio
from typing import Annotated

from agent_framework import tool
from agent_framework.openai import OpenAIResponsesClient
from dotenv import load_dotenv
class MyFunctionClass:
    def __init__(self, safe: bool = False) -> None:
        """Simple class with two tools: divide and add.

        The safe parameter controls whether divide raises on division by zero or returns `infinity` for divide by zero.
        """
        self.safe = safe

    def divide(
        self,
        a: Annotated[int, "Numerator"],
        b: Annotated[int, "Denominator"],
    ) -> str:
        """Divide two numbers, safe to use also with 0 as denominator."""
        result = "∞" if b == 0 and self.safe else a / b
        return f"{a} / {b} = {result}"

    def add(
        self,
        x: Annotated[int, "First number"],
        y: Annotated[int, "Second number"],
    ) -> str:
        return f"{x} + {y} = {x + y}"


async def main():
    # Creating my function class with safe division enabled
    tools = MyFunctionClass(safe=True)
    # Applying the tool decorator to one of the methods of the class
    add_function = tool(description="Add two numbers.")(tools.add)

    agent = OpenAIResponsesClient().as_agent(
        name="ToolAgent",
        instructions="Use the provided tools.",
    )
    print("=" * 60)
    print("Step 1: Call divide(10, 0) - tool returns infinity")
    query = "Divide 10 by 0"
    response = await agent.run(
        query,
        tools=[add_function, tools.divide],
    )
    print(f"Response: {response.text}")
    print("=" * 60)
    print("Step 2: Call set safe to False and call again")
    # Disabling safe mode to allow exceptions
    tools.safe = False
    response = await agent.run(query, tools=[add_function, tools.divide])

Pola ini cocok untuk status operasional alat yang berumur panjang. Gunakan FunctionInvocationContext sebagai gantinya saat nilai berubah per pemanggilan.

Langkah selanjutnya

Menggunakan alat fungsi dengan persetujuan manusia dalam sistem

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2026-03-17

Bagikan melalui

Menggunakan perangkat fungsi dengan agen

Prasyarat

Membuat agen dengan alat fungsi

Prasyarat

Membuat agen dengan alat fungsi

Menggunakan skema eksplisit dengan @tool

Meneruskan konteks runtime saja ke alat

Membuat alat khusus deklarasi

Membuat kelas dengan beberapa alat fungsi

Langkah selanjutnya

Saran dan Komentar

Sumber Daya Tambahan:

Menggunakan skema eksplisit dengan `@tool`