Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Agents module

set_default_openai_key

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

Set the default OpenAI API key to use for LLM requests (and optionally tracing()). This isonly necessary if the OPENAI_API_KEY environment variable is not already set.

If provided, this key will be used instead of the OPENAI_API_KEY environment variable.

Parameters:

NameTypeDescriptionDefault
keystr

The OpenAI key to use.

required
use_for_tracingbool

Whether to also use this key to send traces to OpenAI. Defaults to TrueIf False, you'll either need to set the OPENAI_API_KEY environment variable or callset_tracing_export_api_key() with the API key you want to use for tracing.

True
Source code insrc/agents/__init__.py
defset_default_openai_key(key:str,use_for_tracing:bool=True)->None:"""Set the default OpenAI API key to use for LLM requests (and optionally tracing()). This is    only necessary if the OPENAI_API_KEY environment variable is not already set.    If provided, this key will be used instead of the OPENAI_API_KEY environment variable.    Args:        key: The OpenAI key to use.        use_for_tracing: Whether to also use this key to send traces to OpenAI. Defaults to True            If False, you'll either need to set the OPENAI_API_KEY environment variable or call            set_tracing_export_api_key() with the API key you want to use for tracing.    """_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

Set the default OpenAI client to use for LLM requests and/or tracing. If provided, thisclient will be used instead of the default OpenAI client.

Parameters:

NameTypeDescriptionDefault
clientAsyncOpenAI

The OpenAI client to use.

required
use_for_tracingbool

Whether to use the API key from this client for uploading traces. If False,you'll either need to set the OPENAI_API_KEY environment variable or callset_tracing_export_api_key() with the API key you want to use for tracing.

True
Source code insrc/agents/__init__.py
defset_default_openai_client(client:AsyncOpenAI,use_for_tracing:bool=True)->None:"""Set the default OpenAI client to use for LLM requests and/or tracing. If provided, this    client will be used instead of the default OpenAI client.    Args:        client: The OpenAI client to use.        use_for_tracing: Whether to use the API key from this client for uploading traces. If False,            you'll either need to set the OPENAI_API_KEY environment variable or call            set_tracing_export_api_key() with the API key you want to use for tracing.    """_config.set_default_openai_client(client,use_for_tracing)

set_default_openai_api

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

Set the default API to use for OpenAI LLM requests. By default, we will use the responses APIbut you can set this to use the chat completions API instead.

Source code insrc/agents/__init__.py
defset_default_openai_api(api:Literal["chat_completions","responses"])->None:"""Set the default API to use for OpenAI LLM requests. By default, we will use the responses API    but you can set this to use the chat completions API instead.    """_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 insrc/agents/tracing/__init__.py
defset_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 insrc/agents/tracing/__init__.py
defset_tracing_disabled(disabled:bool)->None:"""    Set whether tracing is globally disabled.    """get_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 insrc/agents/tracing/__init__.py
defset_trace_processors(processors:list[TracingProcessor])->None:"""    Set the list of trace processors. This will replace the current list of processors.    """get_trace_provider().set_processors(processors)

enable_verbose_stdout_logging

enable_verbose_stdout_logging()

Enables verbose logging to stdout. This is useful for debugging.

Source code insrc/agents/__init__.py
defenable_verbose_stdout_logging():"""Enables verbose logging to stdout. This is useful for debugging."""logger=logging.getLogger("openai.agents")logger.setLevel(logging.DEBUG)logger.addHandler(logging.StreamHandler(sys.stdout))

[8]ページ先頭

©2009-2025 Movatter.jp