API Reference openai_agents v#0.1.0

Modules

Defines the behavior for OpenAI agents.

OpenAI Agents is an Elixir library for building AI agents using OpenAI's Responses API.

Manages context state throughout agent execution.

Optional behavior for custom context implementations.

Event types emitted during streaming operations.

Emitted for function call argument chunks

Emitted when a response completes

Emitted when a response starts

Emitted when the stream ends

Emitted for text chunks

Emitted when a tool is called

Emitted for unrecognized event types

Emitted with token usage updates

Defines the behavior for guardrails that validate agent inputs and outputs.

Manages handoffs between agents.

Behavior for model adapters.

Adapter for the OpenAI Responses API.

Manages the execution of agents, handling the conversation loop, tool execution, handoffs, and streaming.

Handles streaming responses using GenStage for backpressure management.

Telemetry integration for OpenAI Agents.

Defines the behavior for tools that agents can use.

Executes tools in parallel or serially based on their type. Handles error recovery and telemetry.

Collects and manages trace data for agent runs.

Supervisor for tracing components.

Tracks token usage throughout agent execution.