SDK 配置

API 密钥与客户端

默认情况下，SDK 在首次导入时读取环境变量 OPENAI_API_KEY。如果无法设置该变量，可以手动调用 setDefaultOpenAIKey()。

import { setDefaultOpenAIKey } from '@openai/agents';

setDefaultOpenAIKey(process.env.OPENAI_API_KEY!); // sk-...

你也可以传入自定义的 OpenAI 客户端实例。否则，SDK 将使用默认密钥自动创建一个实例。

import { OpenAI } from 'openai';
import { setDefaultOpenAIClient } from '@openai/agents';

const customClient = new OpenAI({ baseURL: '...', apiKey: '...' });
setDefaultOpenAIClient(customClient);

最后，你可以在 Responses API 与 Chat Completions API 之间切换。

import { setOpenAIAPI } from '@openai/agents';

setOpenAIAPI('chat_completions');

追踪

追踪默认启用，并使用上述部分中的 OpenAI 密钥。

可以通过 setTracingExportApiKey() 设置单独的密钥：

import { setTracingExportApiKey } from '@openai/agents';

setTracingExportApiKey('sk-...');

也可以完全禁用追踪：

import { setTracingDisabled } from '@openai/agents';

setTracingDisabled(true);

若想进一步了解追踪功能，请查看追踪。

调试日志

SDK 使用 debug 包进行调试日志记录。将环境变量 DEBUG 设置为 openai-agents* 以查看详细日志。

export DEBUG=openai-agents*

你可以通过 @openai/agents 中的 getLogger(namespace) 为你的模块获取带命名空间的记录器。

import { getLogger } from '@openai/agents';

const logger = getLogger('my-app');
logger.debug('something happened');

日志中的敏感数据

某些日志可能包含用户数据。可通过设置以下环境变量禁用它们。

要禁用记录 LLM 的输入与输出：

export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1

要禁用记录工具的输入与输出：

export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1