Agentes do OpenAI

OPENAI_API_KEY="your-openai-api-key"
OPENAI_CHAT_MODEL="gpt-4o-mini"
# Optional shared fallback:
# OPENAI_MODEL="gpt-4o-mini"

OPENAI_API_KEY="your-openai-api-key"
OPENAI_CHAT_COMPLETION_MODEL="gpt-4o-mini"
# Optional shared fallback:
# OPENAI_MODEL="gpt-4o-mini"

Azure OpenAI com os mesmos clientes

Agora, o Azure OpenAI usa os mesmos clientes OpenAI Python que o OpenAI usa diretamente. O padrão preferencial e mais claro do Azure é passar entradas explícitas de roteamento do Azure, como credential ou azure_endpoint, em seguida, definir api_version para o Azure depois que o roteamento for selecionado. Se OPENAI_API_KEY estiver definido, os clientes genéricos permanecerão no OpenAI, a menos que você passe essas entradas de roteamento do Azure. Se você tiver apenas AZURE_OPENAI_* configurações, o fallback no ambiente do Azure ainda funcionará. OpenAIChatClient prefere AZURE_OPENAI_CHAT_MODEL, OpenAIChatCompletionClient prefere AZURE_OPENAI_CHAT_COMPLETION_MODEL, e ambos retornam para AZURE_OPENAI_MODEL.

AZURE_OPENAI_ENDPOINT="https://<resource>.openai.azure.com"
AZURE_OPENAI_CHAT_MODEL="gpt-4o-mini"
# Optional shared fallback:
# AZURE_OPENAI_MODEL="gpt-4o-mini"
AZURE_OPENAI_API_VERSION="your-api-version"

import asyncio
import os
from agent_framework.openai import OpenAIChatClient
from azure.identity import AzureCliCredential

async def main():
    agent = OpenAIChatClient(
        model=os.environ["AZURE_OPENAI_CHAT_MODEL"],
        azure_endpoint=os.environ["AZURE_OPENAI_ENDPOINT"],
        api_version=os.getenv("AZURE_OPENAI_API_VERSION"),
        credential=AzureCliCredential(),
    ).as_agent(
        name="AzureOpenAIResponsesAgent",
        instructions="You are a helpful assistant.",
    )

    result = await agent.run("Hello!")
    print(result)

asyncio.run(main())

Se você já tiver uma URL do Azure OpenAI completa que termina com /openai/v1, passe-a como base_url em vez de azure_endpoint. Mantenha-se api_version alinhado à superfície da API do Azure OpenAI que você está usando. Se OPENAI_API_KEY também estiver definido em seu ambiente, essas entradas explícitas do Azure manterão o cliente no Azure.

Inserções do Azure com a mesma família de clientes

OpenAIEmbeddingClient segue as mesmas regras de roteamento que os clientes de chat. Para inserções do Azure, passe a implantação de inserção como model e prefira entradas explícitas do Azure:

import os
from agent_framework.openai import OpenAIEmbeddingClient
from azure.identity import AzureCliCredential

client = OpenAIEmbeddingClient(
    model=os.environ["AZURE_OPENAI_EMBEDDING_MODEL"],
    azure_endpoint=os.environ["AZURE_OPENAI_ENDPOINT"],
    api_version=os.getenv("AZURE_OPENAI_API_VERSION"),
    credential=AzureCliCredential(),
)

Criar Agentes OpenAI

OpenAIChatClient usa a API Responses — o cliente principal recomendado com suporte a ferramentas hospedadas.

import asyncio
from agent_framework.openai import OpenAIChatClient

async def main():
    agent = OpenAIChatClient().as_agent(
        name="FullFeaturedAgent",
        instructions="You are a helpful assistant with access to many tools.",
    )
    result = await agent.run("Write and run a Python script that calculates fibonacci numbers.")
    print(result)

asyncio.run(main())

Ferramentas com suporte: Ferramentas de funções, aprovação da ferramenta, interpretador de código, pesquisa de arquivo, pesquisa na Web, MCP hospedado, ferramentas MCP locais.

Ferramentas Hospedadas com o Cliente de Respostas

O cliente Responses fornece get_*_tool() métodos para cada tipo de ferramenta hospedada.

async def hosted_tools_example():
    client = OpenAIChatClient()

    # Each tool is created via a client method
    code_interpreter = client.get_code_interpreter_tool()
    web_search = client.get_web_search_tool()
    file_search = client.get_file_search_tool(vector_store_ids=["vs_abc123"])
    mcp_tool = client.get_mcp_tool(
        name="GitHub",
        url="https://api.githubcopilot.com/mcp/",
        approval_mode="never_require",
    )

    agent = client.as_agent(
        name="PowerAgent",
        instructions="You have access to code execution, web search, files, and GitHub.",
        tools=[code_interpreter, web_search, file_search, mcp_tool],
    )
    result = await agent.run("Search the web for Python best practices, then write a summary.")
    print(result)

OpenAIChatCompletionClient usa a API Chat Completions — use-a quando precisar de ampla compatibilidade com modelos ou já tiver uma integração existente com a API Chat Completions.

import asyncio
from agent_framework.openai import OpenAIChatCompletionClient

async def main():
    agent = OpenAIChatCompletionClient().as_agent(
        name="HelpfulAssistant",
        instructions="You are a helpful assistant.",
    )
    result = await agent.run("Hello, how can you help me?")
    print(result)

asyncio.run(main())

Ferramentas com suporte: Ferramentas de funções, pesquisa na Web, ferramentas MCP locais.

Pesquisa na Web com finalização de chat

async def web_search_example():
    client = OpenAIChatCompletionClient()
    web_search = client.get_web_search_tool()

    agent = client.as_agent(
        name="SearchBot",
        instructions="You can search the web for current information.",
        tools=web_search,
    )
    result = await agent.run("What are the latest developments in AI?")
    print(result)