Agentes 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

O Azure OpenAI usa agora os mesmos clientes Python OpenAI que o OpenAI direto. O padrão Azure preferido e mais claro é passar entradas explícitas de encaminhamento Azure, como credential ou azure_endpoint, e depois configurar api_version para o Azure assim que a seleção de encaminhamento estiver concluída. Caso OPENAI_API_KEY seja definido, os clientes genéricos permanecem no OpenAI, a menos que forneças esses dados de encaminhamento do Azure. Se só tiver AZURE_OPENAI_* definições, o mecanismo de substituição do ambiente Azure continua a funcionar. OpenAIChatClient prefere AZURE_OPENAI_CHAT_MODEL, OpenAIChatCompletionClient prefere AZURE_OPENAI_CHAT_COMPLETION_MODEL, e ambos voltam a 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 já tens uma URL completa do Azure OpenAI que termina em /openai/v1, passa-a como base_url em vez de azure_endpoint. Mantenha-se api_version alinhado com a superfície da API Azure OpenAI que está a usar. Se OPENAI_API_KEY também estiver definido no teu ambiente, estas entradas explícitas do Azure mantêm o cliente no Azure.

Azure embeddings com a mesma família de clientes

OpenAIEmbeddingClient Segue as mesmas regras de roteamento que os clientes de chat. Para as integrações do Azure, passe a implementação da integração como model e prefira utilizar 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 utiliza a API Responses — o cliente primário recomendado com suporte a ferramentas alojadas.

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 suportadas: Ferramentas funcionais, aprovação de ferramentas, interpretador de código, pesquisa de ficheiros, pesquisa web, MCP alojado, ferramentas locais de MCP.

Ferramentas Alojadas com Cliente de Respostas

O cliente Respostas fornece get_*_tool() métodos para cada tipo de ferramenta alojada:

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 utiliza a API Chat Completions — use-a quando precisar de ampla compatibilidade de modelos ou quando tiver uma integração Chat Completions existente.

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 suportadas: Ferramentas funcionais, pesquisa na web, ferramentas MCP locais.

Pesquisa na Web com Conclusã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)