Agenti OpenAI ChatCompletion

Microsoft Agent Framework podporuje vytváření agentů, kteří používají službu OpenAI ChatCompletion .

Začínáme

Přidejte do projektu požadované balíčky NuGet.

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

Vytvoření agenta OpenAI ChatCompletion

Jako první krok musíte vytvořit klienta pro připojení ke službě OpenAI.

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

OpenAIClient client = new OpenAIClient("<your_api_key>");

OpenAI podporuje více služeb, které poskytují možnosti volání modelu. Vyberte službu ChatCompletion a vytvořte agenta založeného na ChatCompletion.

var chatCompletionClient = client.GetChatClient("gpt-4o-mini");

Nakonec vytvořte agenta AsAIAgent pomocí metody rozšíření v souboru ChatCompletionClient.

AIAgent agent = chatCompletionClient.AsAIAgent(
    instructions: "You are good at telling jokes.",
    name: "Joker");

// Invoke the agent and output the text result.
Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));

Použití agenta

Agent AIAgent je standardní a podporuje všechny standardní AIAgent operace.

Další informace o tom, jak spouštět agenty a pracovat s nimi, najdete v úvodních kurzech agenta.

Požadavky

Nainstalujte balíček Microsoft Agent Framework.

pip install agent-framework-core --pre

Konfigurace

Proměnné prostředí

Nastavte požadované proměnné prostředí pro ověřování OpenAI:

# Required for OpenAI API access
OPENAI_API_KEY="your-openai-api-key"
OPENAI_CHAT_MODEL_ID="gpt-4o-mini"  # or your preferred model

Případně můžete použít .env soubor v kořenovém adresáři projektu:

OPENAI_API_KEY=your-openai-api-key
OPENAI_CHAT_MODEL_ID=gpt-4o-mini

Začínáme

Import požadovaných tříd z rozhraní Agent Framework:

import asyncio
from agent_framework import ChatAgent
from agent_framework.openai import OpenAIChatClient

Vytvoření agenta OpenAI ChatCompletion

Základní vytvoření agenta

Nejjednodušší způsob, jak vytvořit agenta pro dokončování chatu:

async def basic_example():
    # Create an agent using OpenAI ChatCompletion
    agent = OpenAIChatClient().as_agent(
        name="HelpfulAssistant",
        instructions="You are a helpful assistant.",
    )

    result = await agent.run("Hello, how can you help me?")
    print(result.text)

Použití explicitní konfigurace

Explicitní konfiguraci můžete zadat místo toho, abyste se spoléhali na proměnné prostředí:

async def explicit_config_example():
    agent = OpenAIChatClient(
        ai_model_id="gpt-4o-mini",
        api_key="your-api-key-here",
    ).as_agent(
        instructions="You are a helpful assistant.",
    )

    result = await agent.run("What can you do?")
    print(result.text)

Funkce agenta

Funkční nástroje

Vybavení agenta vlastními funkcemi:

from typing import Annotated
from pydantic import Field

def get_weather(
    location: Annotated[str, Field(description="The location to get weather for")]
) -> str:
    """Get the weather for a given location."""
    # Your weather API implementation here
    return f"The weather in {location} is sunny with 25°C."

async def tools_example():
    agent = ChatAgent(
        chat_client=OpenAIChatClient(),
        instructions="You are a helpful weather assistant.",
        tools=get_weather,  # Add tools to the agent
    )

    result = await agent.run("What's the weather like in Tokyo?")
    print(result.text)

Vyhledávání na webu

Povolte možnosti vyhledávání na webu v reálném čase:

from agent_framework import HostedWebSearchTool

async def web_search_example():
    agent = OpenAIChatClient(model_id="gpt-4o-search-preview").as_agent(
        name="SearchBot",
        instructions="You are a helpful assistant that can search the web for current information.",
        tools=HostedWebSearchTool(),
    )

    result = await agent.run("What are the latest developments in artificial intelligence?")
    print(result.text)

Nástroje pro protokol MCP (Model Context Protocol)

Připojte se k místním serverům MCP pro rozšířené možnosti:

from agent_framework import MCPStreamableHTTPTool

async def local_mcp_example():
    agent = OpenAIChatClient().as_agent(
        name="DocsAgent",
        instructions="You are a helpful assistant that can help with Microsoft documentation.",
        tools=MCPStreamableHTTPTool(
            name="Microsoft Learn MCP",
            url="https://learn.microsoft.com/api/mcp",
        ),
    )

    result = await agent.run("How do I create an Azure storage account using az cli?")
    print(result.text)

Správa vláken

Udržujte kontext konverzace napříč několika interakcemi:

async def thread_example():
    agent = OpenAIChatClient().as_agent(
        name="Agent",
        instructions="You are a helpful assistant.",
    )

    # Create a persistent thread for conversation context
    thread = agent.get_new_thread()

    # First interaction
    first_query = "My name is Alice"
    print(f"User: {first_query}")
    first_result = await agent.run(first_query, thread=thread)
    print(f"Agent: {first_result.text}")

    # Second interaction - agent remembers the context
    second_query = "What's my name?"
    print(f"User: {second_query}")
    second_result = await agent.run(second_query, thread=thread)
    print(f"Agent: {second_result.text}")  # Should remember "Alice"

Streamovací odpovědi

Získejte odpovědi, protože se generují pro lepší uživatelské prostředí:

async def streaming_example():
    agent = OpenAIChatClient().as_agent(
        name="StoryTeller",
        instructions="You are a creative storyteller.",
    )

    print("Agent: ", end="", flush=True)
    async for chunk in agent.run_stream("Tell me a short story about AI."):
        if chunk.text:
            print(chunk.text, end="", flush=True)
    print()  # New line after streaming

Použití agenta

Agent je standardní BaseAgent a podporuje všechny standardní operace agentů.

Další informace o tom, jak spouštět agenty a pracovat s nimi, najdete v úvodních kurzech agenta.

Další kroky

Agenti odpovědí