openai-agents 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

agents/__init__.py

@@ -0,0 +1,223 @@
+import logging
+import sys
+from typing import Literal
+
+from openai import AsyncOpenAI
+
+from . import _config
+from .agent import Agent
+from .agent_output import AgentOutputSchema
+from .computer import AsyncComputer, Button, Computer, Environment
+from .exceptions import (
+    AgentsException,
+    InputGuardrailTripwireTriggered,
+    MaxTurnsExceeded,
+    ModelBehaviorError,
+    OutputGuardrailTripwireTriggered,
+    UserError,
+)
+from .guardrail import (
+    GuardrailFunctionOutput,
+    InputGuardrail,
+    InputGuardrailResult,
+    OutputGuardrail,
+    OutputGuardrailResult,
+    input_guardrail,
+    output_guardrail,
+)
+from .handoffs import Handoff, HandoffInputData, HandoffInputFilter, handoff
+from .items import (
+    HandoffCallItem,
+    HandoffOutputItem,
+    ItemHelpers,
+    MessageOutputItem,
+    ModelResponse,
+    ReasoningItem,
+    RunItem,
+    ToolCallItem,
+    ToolCallOutputItem,
+    TResponseInputItem,
+)
+from .lifecycle import AgentHooks, RunHooks
+from .model_settings import ModelSettings
+from .models.interface import Model, ModelProvider, ModelTracing
+from .models.openai_chatcompletions import OpenAIChatCompletionsModel
+from .models.openai_provider import OpenAIProvider
+from .models.openai_responses import OpenAIResponsesModel
+from .result import RunResult, RunResultStreaming
+from .run import RunConfig, Runner
+from .run_context import RunContextWrapper, TContext
+from .stream_events import (
+    AgentUpdatedStreamEvent,
+    RawResponsesStreamEvent,
+    RunItemStreamEvent,
+    StreamEvent,
+)
+from .tool import (
+    ComputerTool,
+    FileSearchTool,
+    FunctionTool,
+    Tool,
+    WebSearchTool,
+    default_tool_error_function,
+    function_tool,
+)
+from .tracing import (
+    AgentSpanData,
+    CustomSpanData,
+    FunctionSpanData,
+    GenerationSpanData,
+    GuardrailSpanData,
+    HandoffSpanData,
+    Span,
+    SpanData,
+    SpanError,
+    Trace,
+    add_trace_processor,
+    agent_span,
+    custom_span,
+    function_span,
+    gen_span_id,
+    gen_trace_id,
+    generation_span,
+    get_current_span,
+    get_current_trace,
+    guardrail_span,
+    handoff_span,
+    set_trace_processors,
+    set_tracing_disabled,
+    set_tracing_export_api_key,
+    trace,
+)
+from .usage import Usage
+
+
+def set_default_openai_key(key: str) -> None:
+    """Set the default OpenAI API key to use for LLM requests and 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.
+    """
+    _config.set_default_openai_key(key)
+
+
+def 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, 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)
+
+
+def 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 API
+    but you can set this to use the chat completions API instead.
+    """
+    _config.set_default_openai_api(api)
+
+
+def enable_verbose_stdout_logging():
+    """Enables verbose logging to stdout. This is useful for debugging."""
+    for name in ["openai.agents", "openai.agents.tracing"]:
+        logger = logging.getLogger(name)
+        logger.setLevel(logging.DEBUG)
+        logger.addHandler(logging.StreamHandler(sys.stdout))
+
+
+__all__ = [
+    "Agent",
+    "Runner",
+    "Model",
+    "ModelProvider",
+    "ModelTracing",
+    "ModelSettings",
+    "OpenAIChatCompletionsModel",
+    "OpenAIProvider",
+    "OpenAIResponsesModel",
+    "AgentOutputSchema",
+    "Computer",
+    "AsyncComputer",
+    "Environment",
+    "Button",
+    "AgentsException",
+    "InputGuardrailTripwireTriggered",
+    "OutputGuardrailTripwireTriggered",
+    "MaxTurnsExceeded",
+    "ModelBehaviorError",
+    "UserError",
+    "InputGuardrail",
+    "InputGuardrailResult",
+    "OutputGuardrail",
+    "OutputGuardrailResult",
+    "GuardrailFunctionOutput",
+    "input_guardrail",
+    "output_guardrail",
+    "handoff",
+    "Handoff",
+    "HandoffInputData",
+    "HandoffInputFilter",
+    "TResponseInputItem",
+    "MessageOutputItem",
+    "ModelResponse",
+    "RunItem",
+    "HandoffCallItem",
+    "HandoffOutputItem",
+    "ToolCallItem",
+    "ToolCallOutputItem",
+    "ReasoningItem",
+    "ModelResponse",
+    "ItemHelpers",
+    "RunHooks",
+    "AgentHooks",
+    "RunContextWrapper",
+    "TContext",
+    "RunResult",
+    "RunResultStreaming",
+    "RunConfig",
+    "RawResponsesStreamEvent",
+    "RunItemStreamEvent",
+    "AgentUpdatedStreamEvent",
+    "StreamEvent",
+    "FunctionTool",
+    "ComputerTool",
+    "FileSearchTool",
+    "Tool",
+    "WebSearchTool",
+    "function_tool",
+    "Usage",
+    "add_trace_processor",
+    "agent_span",
+    "custom_span",
+    "function_span",
+    "generation_span",
+    "get_current_span",
+    "get_current_trace",
+    "guardrail_span",
+    "handoff_span",
+    "set_trace_processors",
+    "set_tracing_disabled",
+    "trace",
+    "Trace",
+    "SpanError",
+    "Span",
+    "SpanData",
+    "AgentSpanData",
+    "CustomSpanData",
+    "FunctionSpanData",
+    "GenerationSpanData",
+    "GuardrailSpanData",
+    "HandoffSpanData",
+    "set_default_openai_key",
+    "set_default_openai_client",
+    "set_default_openai_api",
+    "set_tracing_export_api_key",
+    "enable_verbose_stdout_logging",
+    "gen_trace_id",
+    "gen_span_id",
+    "default_tool_error_function",
+]

agents/_config.py

@@ -0,0 +1,23 @@
+from openai import AsyncOpenAI
+from typing_extensions import Literal
+
+from .models import _openai_shared
+from .tracing import set_tracing_export_api_key
+
+
+def set_default_openai_key(key: str) -> None:
+    set_tracing_export_api_key(key)
+    _openai_shared.set_default_openai_key(key)
+
+
+def set_default_openai_client(client: AsyncOpenAI, use_for_tracing: bool) -> None:
+    if use_for_tracing:
+        set_tracing_export_api_key(client.api_key)
+    _openai_shared.set_default_openai_client(client)
+
+
+def set_default_openai_api(api: Literal["chat_completions", "responses"]) -> None:
+    if api == "chat_completions":
+        _openai_shared.set_use_responses_by_default(False)
+    else:
+        _openai_shared.set_use_responses_by_default(True)

agents/_debug.py

@@ -0,0 +1,17 @@
+import os
+
+
+def _debug_flag_enabled(flag: str) -> bool:
+    flag_value = os.getenv(flag)
+    return flag_value is not None and (flag_value == "1" or flag_value.lower() == "true")
+
+
+DONT_LOG_MODEL_DATA = _debug_flag_enabled("OPENAI_AGENTS_DONT_LOG_MODEL_DATA")
+"""By default we don't log LLM inputs/outputs, to prevent exposing sensitive information. Set this
+flag to enable logging them.
+"""
+
+DONT_LOG_TOOL_DATA = _debug_flag_enabled("OPENAI_AGENTS_DONT_LOG_TOOL_DATA")
+"""By default we don't log tool call inputs/outputs, to prevent exposing sensitive information. Set
+this flag to enable logging them.
+"""