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