Skip to Content
API ReferenceClassesClass: AgentRunner

Class: AgentRunner

Defined in: src/agent_runner/agent_runner.ts:31 

Constructors

Constructor

new AgentRunner(): AgentRunner

Returns

AgentRunner

Methods

_maxTurnsPauseMessage()

static _maxTurnsPauseMessage(maxTurns): string

Defined in: src/agent_runner/agent_runner.ts:370 

Builds the end-of-turn notice shown when a run hits the per-chat-turn step budget (OpenAiAgents.MaxTurnsExceededError). The session has already persisted the run’s items, so the next user message resumes mid-task (#201).

Parameters

maxTurns

number

Returns

string


runOneShotAsyncGenerator()

static runOneShotAsyncGenerator(roleAgentContext, userInput, __namedParameters?): AsyncGenerator<AgentRunnerStepResult, AgentRunnerFinalResult>

Defined in: src/agent_runner/agent_runner.ts:39 

Parameters

roleAgentContext

AgentRunnerContext

userInput

string | object[]

__namedParameters?
agentSession?

Session

commandDocs?

CommandDoc[]

mcpServers?

MCPServer[]

streamingEnabled?

boolean = false

Returns

AsyncGenerator<AgentRunnerStepResult, AgentRunnerFinalResult>

Last updated on