跳转至

Agents module

set_default_openai_key 

set_default_openai_key(key: str, use_for_tracing: bool = True) -> None

设置用于 LLM 请求（以及可选的 tracing）的默认 OpenAI API 密钥。只有在未设置 OPENAI_API_KEY 环境变量时才需要调用此方法。

如果提供了该密钥，将会替代 OPENAI_API_KEY 环境变量。

参数

key: 要使用的 OpenAI 密钥。 use_for_tracing: 是否也使用此密钥上传 tracing 数据到 OpenAI。默认为 True。 如果为 False，则需要设置 OPENAI_API_KEY 环境变量，或调用 set_tracing_export_api_key() 并传入你想用于 tracing 的 API 密钥。

Source code in agents/__init__.py 
114
115
116
117
118
119
120
121
122
123
124
def set_default_openai_key(key: str, use_for_tracing: bool = True) -> None:
    """设置用于 LLM 请求（以及可选的 tracing）的默认 OpenAI API 密钥。只有在未设置 OPENAI_API_KEY 环境变量时才需要调用此方法。

    如果提供了该密钥，将会替代 OPENAI_API_KEY 环境变量。

    参数:
        key: 要使用的 OpenAI 密钥。
        use_for_tracing: 是否也使用此密钥上传 tracing 数据到 OpenAI。默认为 True。
            如果为 False，则需要设置 OPENAI_API_KEY 环境变量，或调用 set_tracing_export_api_key() 并传入你想用于 tracing 的 API 密钥。
    """
    _config.set_default_openai_key(key, use_for_tracing)

set_default_openai_client 

set_default_openai_client(client: AsyncOpenAI, use_for_tracing: bool = True) -> None

设置用于 LLM 请求和/或 tracing 的默认 OpenAI 客户端。如果提供了该客户端，将会替代默认的 OpenAI 客户端。

参数

client: 要使用的 OpenAI 客户端。 use_for_tracing: 是否使用该客户端的 API 密钥上传 tracing 数据。如果为 False， 则需要设置 OPENAI_API_KEY 环境变量，或调用 set_tracing_export_api_key() 并传入你想用于 tracing 的 API 密钥。

Source code in agents/__init__.py 
127
128
129
130
131
132
133
134
135
def set_default_openai_client(client: AsyncOpenAI, use_for_tracing: bool = True) -> None:
    """设置用于 LLM 请求和/或 tracing 的默认 OpenAI 客户端。如果提供了该客户端，将会替代默认的 OpenAI 客户端。

    参数:
        client: 要使用的 OpenAI 客户端。
        use_for_tracing: 是否使用该客户端的 API 密钥上传 tracing 数据。如果为 False，
            则需要设置 OPENAI_API_KEY 环境变量，或调用 set_tracing_export_api_key() 并传入你想用于 tracing 的 API 密钥。
    """
    _config.set_default_openai_client(client, use_for_tracing)

set_default_openai_api 

set_default_openai_api(api: Literal['chat_completions', 'responses']) -> None

设置用于 OpenAI LLM 请求的默认 API。默认情况下使用 responses API，你也可以设置为 chat completions API。

Source code in agents/__init__.py 
138
139
140
def set_default_openai_api(api: Literal["chat_completions", "responses"]) -> None:
    """设置用于 OpenAI LLM 请求的默认 API。默认情况下使用 responses API，你也可以设置为 chat completions API。"""
    _config.set_default_openai_api(api)

set_tracing_export_api_key 

set_tracing_export_api_key(api_key: str) -> None

Set the OpenAI API key for the backend exporter.

Source code in agents/tracing/__init__.py 
100
101
102
103
104
def set_tracing_export_api_key(api_key: str) -> None:
    """
    Set the OpenAI API key for the backend exporter.
    """
    default_exporter().set_api_key(api_key)

set_tracing_disabled 

set_tracing_disabled(disabled: bool) -> None

Set whether tracing is globally disabled.

Source code in agents/tracing/__init__.py 
93
94
95
96
97
def set_tracing_disabled(disabled: bool) -> None:
    """
    Set whether tracing is globally disabled.
    """
    GLOBAL_TRACE_PROVIDER.set_disabled(disabled)

set_trace_processors 

set_trace_processors(processors: list[TracingProcessor]) -> None

Set the list of trace processors. This will replace the current list of processors.

Source code in agents/tracing/__init__.py 
86
87
88
89
90
def set_trace_processors(processors: list[TracingProcessor]) -> None:
    """
    Set the list of trace processors. This will replace the current list of processors.
    """
    GLOBAL_TRACE_PROVIDER.set_processors(processors)

enable_verbose_stdout_logging 

enable_verbose_stdout_logging()

启用详细日志输出到标准输出（stdout）。这对于调试很有用。

Source code in agents/__init__.py 
143
144
145
146
147
def enable_verbose_stdout_logging():
    """启用详细日志输出到标准输出（stdout）。这对于调试很有用。"""
    logger = logging.getLogger("openai.agents")
    logger.setLevel(logging.DEBUG)
    logger.addHandler(logging.StreamHandler(sys.stdout))