Class OpenAIAgentsAdapter

OpenAI Agents SDK adapter

Hierarchy

FrameworkAdapter
- OpenAIAgentsAdapter

Index

Constructors

constructor

new OpenAIAgentsAdapter(
    agentId: string,
    options?: Partial<Omit<AdapterConfig, "agentId" | "framework">>,
    callbacks?: AdapterCallbacks,
): OpenAIAgentsAdapter
Parameters
- agentId: string
- Optionaloptions: Partial<Omit<AdapterConfig, "agentId" | "framework">>
- Optionalcallbacks: AdapterCallbacks
Returns OpenAIAgentsAdapter
Overrides FrameworkAdapter.constructor
- Defined in src/sdk/frameworkAdapters.ts:344

Properties

`Protected`callbacks

callbacks: AdapterCallbacks

`Protected`config

config: AdapterConfig

`Protected`session

session: AdapterSession

Methods

endSession

endSession(): AdapterSession
End the session

Returns AdapterSession
Inherited from FrameworkAdapter.endSession
- Defined in src/sdk/frameworkAdapters.ts:205

getEventsByType

getEventsByType(
    type:
        | "error"
        | "decision"
        | "llm_call"
        | "tool_call"
        | "agent_step"
        | "chain_start"
        | "chain_end",
): AdapterEvent[]
Get events by type
Parameters
- type:
      | "error"
      | "decision"
      | "llm_call"
      | "tool_call"
      | "agent_step"
      | "chain_start"
      | "chain_end"
Returns AdapterEvent[]
Inherited from FrameworkAdapter.getEventsByType
- Defined in src/sdk/frameworkAdapters.ts:219

getSession

getSession(): AdapterSession
Get the current session

Returns AdapterSession
Inherited from FrameworkAdapter.getSession
- Defined in src/sdk/frameworkAdapters.ts:211

getSummary

getSummary(): {
    actionLimitReached: boolean;
    agentId: string;
    budgetExceeded: boolean;
    durationMs: number;
    framework: FrameworkType;
    sessionId: string;
    totalActions: number;
    totalCostUsd: number;
    totalErrors: number;
    totalEvents: number;
    totalTokens: number;
}
Get session summary

Returns {
    actionLimitReached: boolean;
    agentId: string;
    budgetExceeded: boolean;
    durationMs: number;
    framework: FrameworkType;
    sessionId: string;
    totalActions: number;
    totalCostUsd: number;
    totalErrors: number;
    totalEvents: number;
    totalTokens: number;
}
Inherited from FrameworkAdapter.getSummary
- Defined in src/sdk/frameworkAdapters.ts:224

recordAgentStep

recordAgentStep(step: number, action: string, reasoning: string): AdapterEvent
Record an agent reasoning step
Parameters
- step: number
- action: string
- reasoning: string
Returns AdapterEvent
Inherited from FrameworkAdapter.recordAgentStep
- Defined in src/sdk/frameworkAdapters.ts:158

recordError

recordError(error: Error): AdapterEvent
Record an error
Parameters
- error: Error
Returns AdapterEvent
Inherited from FrameworkAdapter.recordError
- Defined in src/sdk/frameworkAdapters.ts:175

recordFunctionCall

recordFunctionCall(
    functionName: string,
    args: unknown,
    result: unknown,
    durationMs: number,
): AdapterEvent
Record a function/tool call from OpenAI agents
Parameters
- functionName: string
- args: unknown
- result: unknown
- durationMs: number
Returns AdapterEvent
- Defined in src/sdk/frameworkAdapters.ts:349

recordHandoff

recordHandoff(fromAgent: string, toAgent: string, reason: string): AdapterEvent
Record a handoff between agents
Parameters
- fromAgent: string
- toAgent: string
- reason: string
Returns AdapterEvent
- Defined in src/sdk/frameworkAdapters.ts:354

recordLLMCall

recordLLMCall(
    name: string,
    input: unknown,
    output: unknown,
    tokens: { completion: number; prompt: number },
    costUsd: number,
    durationMs: number,
): AdapterEvent
Record an LLM call
Parameters
- name: string
- input: unknown
- output: unknown
- tokens: { completion: number; prompt: number }
- costUsd: number
- durationMs: number
Returns AdapterEvent
Inherited from FrameworkAdapter.recordLLMCall
- Defined in src/sdk/frameworkAdapters.ts:110

recordToolCall

recordToolCall(
    name: string,
    input: unknown,
    output: unknown,
    durationMs: number,
): AdapterEvent
Record a tool call
Parameters
- name: string
- input: unknown
- output: unknown
- durationMs: number
Returns AdapterEvent
Inherited from FrameworkAdapter.recordToolCall
- Defined in src/sdk/frameworkAdapters.ts:136

shouldStop

shouldStop(): boolean
Check if the agent should stop (budget exceeded or action limit)

Returns boolean
Inherited from FrameworkAdapter.shouldStop
- Defined in src/sdk/frameworkAdapters.ts:214

Class OpenAIAgentsAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OpenAIAgentsAdapter

Properties

Protectedcallbacks

Protectedconfig

Protectedsession

Methods

endSession

Returns AdapterSession

getEventsByType

Parameters

Returns AdapterEvent[]

getSession

Returns AdapterSession

getSummary

Returns { actionLimitReached: boolean; agentId: string; budgetExceeded: boolean; durationMs: number; framework: FrameworkType; sessionId: string; totalActions: number; totalCostUsd: number; totalErrors: number; totalEvents: number; totalTokens: number;}

recordAgentStep

Parameters

Returns AdapterEvent

recordError

Parameters

Returns AdapterEvent

recordFunctionCall

Parameters

Returns AdapterEvent

recordHandoff

Parameters

Returns AdapterEvent

recordLLMCall

Parameters

Returns AdapterEvent

recordToolCall

Parameters

Returns AdapterEvent

shouldStop

Returns boolean

Settings

On This Page

`Protected`callbacks

`Protected`config

`Protected`session

Returns {
actionLimitReached: boolean;
agentId: string;
budgetExceeded: boolean;
durationMs: number;
framework: FrameworkType;
sessionId: string;
totalActions: number;
totalCostUsd: number;
totalErrors: number;
totalEvents: number;
totalTokens: number;
}